]> code.delx.au - refind/blob - refind/config.c
delx.au / code / refind / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Support for multiple default_selection options, to set a series of
[refind] / refind / config.c
1 /*
2 * refind/config.c
3 * Configuration file functions
4 *
5 * Copyright (c) 2006 Christoph Pfisterer
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the
18 * distribution.
19 *
20 * * Neither the name of Christoph Pfisterer nor the names of the
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37 /*
38 * Modifications copyright (c) 2012-2013 Roderick W. Smith
39 *
40 * Modifications distributed under the terms of the GNU General Public
41 * License (GPL) version 3 (GPLv3), a copy of which must be distributed
42 * with this source code or binaries made from it.
43 *
44 */
45
46 #include "global.h"
47 #include "lib.h"
48 #include "icns.h"
49 #include "menu.h"
50 #include "config.h"
51 #include "screen.h"
52 #include "../include/refit_call_wrapper.h"
53
54 // constants
55
56 #define LINUX_OPTIONS_FILENAMES L"refind_linux.conf,refind-linux.conf"
57 #define MAXCONFIGFILESIZE (128*1024)
58
59 #define ENCODING_ISO8859_1 (0)
60 #define ENCODING_UTF8 (1)
61 #define ENCODING_UTF16_LE (2)
62
63 #define GetTime ST->RuntimeServices->GetTime
64 #define LAST_MINUTE 1439 /* Last minute of a day */
65
66 static REFIT_MENU_ENTRY MenuEntryReturn = { L"Return to Main Menu", TAG_RETURN, 0, 0, 0, NULL, NULL, NULL };
67
68 //
69 // read a file into a buffer
70 //
71
72 EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, IN CHAR16 *FileName, IN OUT REFIT_FILE *File, OUT UINTN *size)
73 {
74 EFI_STATUS Status;
75 EFI_FILE_HANDLE FileHandle;
76 EFI_FILE_INFO *FileInfo;
77 UINT64 ReadSize;
78 CHAR16 Message[256];
79
80 File->Buffer = NULL;
81 File->BufferSize = 0;
82
83 // read the file, allocating a buffer on the way
84 Status = refit_call5_wrapper(BaseDir->Open, BaseDir, &FileHandle, FileName, EFI_FILE_MODE_READ, 0);
85 SPrint(Message, 255, L"while loading the file '%s'", FileName);
86 if (CheckError(Status, Message))
87 return Status;
88
89 FileInfo = LibFileInfo(FileHandle);
90 if (FileInfo == NULL) {
91 // TODO: print and register the error
92 refit_call1_wrapper(FileHandle->Close, FileHandle);
93 return EFI_LOAD_ERROR;
94 }
95 ReadSize = FileInfo->FileSize;
96 FreePool(FileInfo);
97
98 File->BufferSize = (UINTN)ReadSize;
99 File->Buffer = AllocatePool(File->BufferSize);
100 if (File->Buffer == NULL) {
101 size = 0;
102 return EFI_OUT_OF_RESOURCES;
103 } else {
104 *size = File->BufferSize;
105 } // if/else
106 Status = refit_call3_wrapper(FileHandle->Read, FileHandle, &File->BufferSize, File->Buffer);
107 if (CheckError(Status, Message)) {
108 MyFreePool(File->Buffer);
109 File->Buffer = NULL;
110 refit_call1_wrapper(FileHandle->Close, FileHandle);
111 return Status;
112 }
113 Status = refit_call1_wrapper(FileHandle->Close, FileHandle);
114
115 // setup for reading
116 File->Current8Ptr = (CHAR8 *)File->Buffer;
117 File->End8Ptr = File->Current8Ptr + File->BufferSize;
118 File->Current16Ptr = (CHAR16 *)File->Buffer;
119 File->End16Ptr = File->Current16Ptr + (File->BufferSize >> 1);
120
121 // detect encoding
122 File->Encoding = ENCODING_ISO8859_1; // default: 1:1 translation of CHAR8 to CHAR16
123 if (File->BufferSize >= 4) {
124 if (File->Buffer[0] == 0xFF && File->Buffer[1] == 0xFE) {
125 // BOM in UTF-16 little endian (or UTF-32 little endian)
126 File->Encoding = ENCODING_UTF16_LE; // use CHAR16 as is
127 File->Current16Ptr++;
128 } else if (File->Buffer[0] == 0xEF && File->Buffer[1] == 0xBB && File->Buffer[2] == 0xBF) {
129 // BOM in UTF-8
130 File->Encoding = ENCODING_UTF8; // translate from UTF-8 to UTF-16
131 File->Current8Ptr += 3;
132 } else if (File->Buffer[1] == 0 && File->Buffer[3] == 0) {
133 File->Encoding = ENCODING_UTF16_LE; // use CHAR16 as is
134 }
135 // TODO: detect other encodings as they are implemented
136 }
137
138 return EFI_SUCCESS;
139 }
140
141 //
142 // get a single line of text from a file
143 //
144
145 static CHAR16 *ReadLine(REFIT_FILE *File)
146 {
147 CHAR16 *Line, *q;
148 UINTN LineLength;
149
150 if (File->Buffer == NULL)
151 return NULL;
152
153 if (File->Encoding == ENCODING_ISO8859_1 || File->Encoding == ENCODING_UTF8) {
154
155 CHAR8 *p, *LineStart, *LineEnd;
156
157 p = File->Current8Ptr;
158 if (p >= File->End8Ptr)
159 return NULL;
160
161 LineStart = p;
162 for (; p < File->End8Ptr; p++)
163 if (*p == 13 || *p == 10)
164 break;
165 LineEnd = p;
166 for (; p < File->End8Ptr; p++)
167 if (*p != 13 && *p != 10)
168 break;
169 File->Current8Ptr = p;
170
171 LineLength = (UINTN)(LineEnd - LineStart) + 1;
172 Line = AllocatePool(LineLength * sizeof(CHAR16));
173 if (Line == NULL)
174 return NULL;
175
176 q = Line;
177 if (File->Encoding == ENCODING_ISO8859_1) {
178 for (p = LineStart; p < LineEnd; )
179 *q++ = *p++;
180 } else if (File->Encoding == ENCODING_UTF8) {
181 // TODO: actually handle UTF-8
182 for (p = LineStart; p < LineEnd; )
183 *q++ = *p++;
184 }
185 *q = 0;
186
187 } else if (File->Encoding == ENCODING_UTF16_LE) {
188
189 CHAR16 *p, *LineStart, *LineEnd;
190
191 p = File->Current16Ptr;
192 if (p >= File->End16Ptr)
193 return NULL;
194
195 LineStart = p;
196 for (; p < File->End16Ptr; p++)
197 if (*p == 13 || *p == 10)
198 break;
199 LineEnd = p;
200 for (; p < File->End16Ptr; p++)
201 if (*p != 13 && *p != 10)
202 break;
203 File->Current16Ptr = p;
204
205 LineLength = (UINTN)(LineEnd - LineStart) + 1;
206 Line = AllocatePool(LineLength * sizeof(CHAR16));
207 if (Line == NULL)
208 return NULL;
209
210 for (p = LineStart, q = Line; p < LineEnd; )
211 *q++ = *p++;
212 *q = 0;
213
214 } else
215 return NULL; // unsupported encoding
216
217 return Line;
218 }
219
220 // Returns FALSE if *p points to the end of a token, TRUE otherwise.
221 // Also modifies *p **IF** the first and second characters are both
222 // quotes ('"'); it deletes one of them.
223 static BOOLEAN KeepReading(IN OUT CHAR16 *p, IN OUT BOOLEAN *IsQuoted) {
224 BOOLEAN MoreToRead = FALSE;
225 CHAR16 *Temp = NULL;
226
227 if ((p == NULL) || (IsQuoted == NULL))
228 return FALSE;
229
230 if (*p == L'\0')
231 return FALSE;
232
233 if ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || *IsQuoted) {
234 MoreToRead = TRUE;
235 }
236 if (*p == L'"') {
237 if (p[1] == L'"') {
238 Temp = StrDuplicate(&p[1]);
239 if (Temp != NULL) {
240 StrCpy(p, Temp);
241 FreePool(Temp);
242 }
243 MoreToRead = TRUE;
244 } else {
245 *IsQuoted = !(*IsQuoted);
246 MoreToRead = FALSE;
247 } // if/else second character is a quote
248 } // if first character is a quote
249
250 return MoreToRead;
251 } // BOOLEAN KeepReading()
252
253 //
254 // get a line of tokens from a file
255 //
256 UINTN ReadTokenLine(IN REFIT_FILE *File, OUT CHAR16 ***TokenList)
257 {
258 BOOLEAN LineFinished, IsQuoted = FALSE;
259 CHAR16 *Line, *Token, *p;
260 UINTN TokenCount = 0;
261
262 *TokenList = NULL;
263
264 while (TokenCount == 0) {
265 Line = ReadLine(File);
266 if (Line == NULL)
267 return(0);
268
269 p = Line;
270 LineFinished = FALSE;
271 while (!LineFinished) {
272 // skip whitespace & find start of token
273 while ((*p == ' ' || *p == '\t' || *p == '=' || *p == ',') && !IsQuoted)
274 p++;
275 if (*p == 0 || *p == '#')
276 break;
277
278 if (*p == '"') {
279 IsQuoted = !IsQuoted;
280 p++;
281 } // if
282 Token = p;
283
284 // find end of token
285 while (KeepReading(p, &IsQuoted)) {
286 if ((*p == L'/') && !IsQuoted) // Switch Unix-style to DOS-style directory separators
287 *p = L'\\';
288 p++;
289 } // while
290 if (*p == L'\0' || *p == L'#')
291 LineFinished = TRUE;
292 *p++ = 0;
293
294 AddListElement((VOID ***)TokenList, &TokenCount, (VOID *)StrDuplicate(Token));
295 }
296
297 FreePool(Line);
298 }
299 return (TokenCount);
300 } /* ReadTokenLine() */
301
302 VOID FreeTokenLine(IN OUT CHAR16 ***TokenList, IN OUT UINTN *TokenCount)
303 {
304 // TODO: also free the items
305 FreeList((VOID ***)TokenList, TokenCount);
306 }
307
308 // handle a parameter with a single integer argument
309 static VOID HandleInt(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT UINTN *Value)
310 {
311 if (TokenCount == 2) {
312 if (StriCmp(TokenList[1], L"-1") == 0)
313 *Value = -1;
314 else
315 *Value = Atoi(TokenList[1]);
316 }
317 }
318
319 // handle a parameter with a single string argument
320 static VOID HandleString(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
321 if (TokenCount == 2) {
322 MyFreePool(*Target);
323 *Target = StrDuplicate(TokenList[1]);
324 } // if
325 } // static VOID HandleString()
326
327 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
328 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
329 // consistency in subsequent comparisons of filenames.
330 static VOID HandleStrings(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
331 UINTN i;
332
333 if (*Target != NULL) {
334 FreePool(*Target);
335 *Target = NULL;
336 } // if
337 for (i = 1; i < TokenCount; i++) {
338 CleanUpPathNameSlashes(TokenList[i]);
339 MergeStrings(Target, TokenList[i], L',');
340 }
341 } // static VOID HandleStrings()
342
343 // Convert TimeString (in "HH:MM" format) to a pure-minute format. Values should be
344 // in the range from 0 (for 00:00, or midnight) to 1439 (for 23:59; aka LAST_MINUTE).
345 // Any value outside that range denotes an error in the specification.
346 // static UINTN HandleTime(IN CHAR16 *TimeString) {
347 // BOOLEAN Found = FALSE;
348 // UINTN ColonPosition = 0, Hour = 0, Minute = 0, TimeLength;
349 //
350 // Print(L"Entering HandleTime('%s')\n", TimeString);
351 // TimeLength = StrLen(TimeString);
352 // for (ColonPosition = 0; (ColonPosition < TimeLength) && !Found; ColonPosition++) {
353 // Print(L"ColonPosition = %d\n", ColonPosition);
354 // if (TimeString[ColonPosition] == ':')
355 // Found = TRUE;
356 // } // for
357 //
358 // if ((ColonPosition == 0) || (ColonPosition > StrLen(TimeString)))
359 // return (LAST_MINUTE + 1);
360 //
361 // Hour = Atoi(TimeString);
362 // Minute = Atoi(&TimeString[ColonPosition + 1]);
363 // Print(L"Hour = %d, Minute = %d\n", Hour, Minute);
364 // return (Hour * 60 + Minute);
365 // } // BOOLEAN HandleTime()
366
367 static UINTN HandleTime(IN CHAR16 *TimeString) {
368 UINTN Hour = 0, Minute = 0, TimeLength, i = 0;
369 BOOLEAN FoundColon = FALSE;
370
371 TimeLength = StrLen(TimeString);
372 while (i < TimeLength) {
373 if (TimeString[i] == L':') {
374 FoundColon = TRUE;
375 Hour = Minute;
376 Minute = 0;
377 } // if
378 if ((TimeString[i] >= L'0') && (TimeString[i] <= '9')) {
379 Minute *= 10;
380 Minute += (TimeString[i] - L'0');
381 } // if
382 i++;
383 } // while
384 return (FoundColon ? Hour * 60 + Minute : LAST_MINUTE + 1);
385 } // BOOLEAN HandleTime()
386
387 // Sets the default boot loader IF the current time is within the bounds
388 // defined by the third and fourth tokens in the TokenList.
389 static VOID SetDefaultByTime(IN CHAR16 **TokenList, OUT CHAR16 **Default) {
390 EFI_STATUS Status;
391 EFI_TIME CurrentTime;
392 UINTN StartTime = LAST_MINUTE + 1, EndTime = LAST_MINUTE + 1, Now;
393 BOOLEAN SetIt = FALSE;
394
395 StartTime = HandleTime(TokenList[2]);
396 EndTime = HandleTime(TokenList[3]);
397
398 if ((StartTime <= LAST_MINUTE) && (EndTime <= LAST_MINUTE)) {
399 Status = refit_call2_wrapper(GetTime, &CurrentTime, NULL);
400 if (Status != EFI_SUCCESS)
401 return;
402 Now = CurrentTime.Hour * 60 + CurrentTime.Minute;
403
404 if (Now > LAST_MINUTE) { // Shouldn't happen; just being paranoid
405 Print(L"Warning: Impossible system time: %d:%d\n", CurrentTime.Hour, CurrentTime.Minute);
406 return;
407 } // if impossible time
408
409 if (StartTime < EndTime) { // Time range does NOT cross midnight
410 if ((Now >= StartTime) && (Now <= EndTime))
411 SetIt = TRUE;
412 } else { // Time range DOES cross midnight
413 if ((Now >= StartTime) && (Now <= EndTime))
414 SetIt = TRUE;
415 } // if/else time range crosses midnight
416
417 if (SetIt) {
418 MyFreePool(*Default);
419 *Default = StrDuplicate(TokenList[1]);
420 } // if (SetIt)
421 } // if ((StartTime <= LAST_MINUTE) && (EndTime <= LAST_MINUTE))
422 } // VOID SetDefaultByTime()
423
424 // read config file
425 VOID ReadConfig(CHAR16 *FileName)
426 {
427 EFI_STATUS Status;
428 REFIT_FILE File;
429 CHAR16 **TokenList;
430 CHAR16 *FlagName;
431 CHAR16 *TempStr = NULL;
432 UINTN TokenCount, i;
433
434 // Set a few defaults only if we're loading the default file.
435 if (StriCmp(FileName, CONFIG_FILE_NAME) == 0) {
436 MyFreePool(GlobalConfig.AlsoScan);
437 GlobalConfig.AlsoScan = StrDuplicate(ALSO_SCAN_DIRS);
438 MyFreePool(GlobalConfig.DontScanDirs);
439 if (SelfVolume) {
440 if (SelfVolume->VolName) {
441 TempStr = SelfVolume->VolName ? StrDuplicate(SelfVolume->VolName) : NULL;
442 } else {
443 TempStr = AllocateZeroPool(256 * sizeof(CHAR16));
444 if (TempStr != NULL)
445 SPrint(TempStr, 255, L"fs%d", SelfVolume->VolNumber);
446 } // if/else
447 }
448 MergeStrings(&TempStr, SelfDirPath, L':');
449 MergeStrings(&TempStr, MEMTEST_LOCATIONS, L',');
450 GlobalConfig.DontScanDirs = TempStr;
451 MyFreePool(GlobalConfig.DontScanFiles);
452 GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
453 MergeStrings(&(GlobalConfig.DontScanFiles), MOK_NAMES, L',');
454 MyFreePool(GlobalConfig.DontScanVolumes);
455 GlobalConfig.DontScanVolumes = StrDuplicate(DONT_SCAN_VOLUMES);
456 } // if
457
458 if (!FileExists(SelfDir, FileName)) {
459 Print(L"Configuration file '%s' missing!\n", FileName);
460 return;
461 }
462
463 Status = ReadFile(SelfDir, FileName, &File, &i);
464 if (EFI_ERROR(Status))
465 return;
466
467 for (;;) {
468 TokenCount = ReadTokenLine(&File, &TokenList);
469 if (TokenCount == 0)
470 break;
471
472 if (StriCmp(TokenList[0], L"timeout") == 0) {
473 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
474
475 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
476 for (i = 1; i < TokenCount; i++) {
477 FlagName = TokenList[i];
478 if (StriCmp(FlagName, L"banner") == 0) {
479 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
480 } else if (StriCmp(FlagName, L"label") == 0) {
481 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
482 } else if (StriCmp(FlagName, L"singleuser") == 0) {
483 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
484 } else if (StriCmp(FlagName, L"hwtest") == 0) {
485 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
486 } else if (StriCmp(FlagName, L"arrows") == 0) {
487 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
488 } else if (StriCmp(FlagName, L"hints") == 0) {
489 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HINTS;
490 } else if (StriCmp(FlagName, L"editor") == 0) {
491 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_EDITOR;
492 } else if (StriCmp(FlagName, L"safemode") == 0) {
493 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SAFEMODE;
494 } else if (StriCmp(FlagName, L"all") == 0) {
495 GlobalConfig.HideUIFlags = HIDEUI_FLAG_ALL;
496 } else {
497 Print(L" unknown hideui flag: '%s'\n", FlagName);
498 }
499 }
500
501 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
502 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
503
504 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
505 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
506 if (i < TokenCount)
507 GlobalConfig.ScanFor[i] = TokenList[i][0];
508 else
509 GlobalConfig.ScanFor[i] = ' ';
510 }
511
512 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
513 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
514
515 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
516 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
517
518 } else if ((StriCmp(TokenList[0], L"don't_scan_volumes") == 0) || (StriCmp(TokenList[0], L"dont_scan_volumes") == 0)) {
519 // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
520 MyFreePool(GlobalConfig.DontScanVolumes);
521 GlobalConfig.DontScanVolumes = NULL;
522 for (i = 1; i < TokenCount; i++) {
523 MergeStrings(&GlobalConfig.DontScanVolumes, TokenList[i], L',');
524 }
525
526 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
527 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
528
529 } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
530 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
531
532 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
533 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
534
535 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
536 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
537 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
538 FlagName = TokenList[i];
539 if (StriCmp(FlagName, L"shell") == 0) {
540 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
541 } else if (StriCmp(FlagName, L"gptsync") == 0) {
542 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
543 } else if (StriCmp(FlagName, L"about") == 0) {
544 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
545 } else if (StriCmp(FlagName, L"exit") == 0) {
546 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
547 } else if (StriCmp(FlagName, L"reboot") == 0) {
548 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
549 } else if (StriCmp(FlagName, L"shutdown") == 0) {
550 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
551 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
552 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
553 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
554 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
555 } else if (StriCmp(FlagName, L"firmware") == 0) {
556 GlobalConfig.ShowTools[i - 1] = TAG_FIRMWARE;
557 } else if ((StriCmp(FlagName, L"memtest86") == 0) || (StriCmp(FlagName, L"memtest") == 0)) {
558 GlobalConfig.ShowTools[i - 1] = TAG_MEMTEST;
559 } else {
560 Print(L" unknown showtools flag: '%s'\n", FlagName);
561 }
562 } // showtools options
563
564 } else if (StriCmp(TokenList[0], L"banner") == 0) {
565 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
566
567 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
568 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
569
570 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
571 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
572
573 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
574 if (TokenCount == 4) {
575 SetDefaultByTime(TokenList, &(GlobalConfig.DefaultSelection));
576 } else {
577 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
578 }
579
580 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
581 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
582 GlobalConfig.TextOnly = FALSE;
583 } else {
584 GlobalConfig.TextOnly = TRUE;
585 }
586
587 } else if (StriCmp(TokenList[0], L"textmode") == 0) {
588 HandleInt(TokenList, TokenCount, &(GlobalConfig.RequestedTextMode));
589
590 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && ((TokenCount == 2) || (TokenCount == 3))) {
591 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
592 if (TokenCount == 3)
593 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
594 else
595 GlobalConfig.RequestedScreenHeight = 0;
596
597 } else if (StriCmp(TokenList[0], L"screensaver") == 0) {
598 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScreensaverTime));
599
600 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
601 GlobalConfig.GraphicsFor = 0;
602 for (i = 1; i < TokenCount; i++) {
603 if (StriCmp(TokenList[i], L"osx") == 0) {
604 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
605 } else if (StriCmp(TokenList[i], L"linux") == 0) {
606 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
607 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
608 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
609 } else if (StriCmp(TokenList[i], L"grub") == 0) {
610 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
611 } else if (StriCmp(TokenList[i], L"windows") == 0) {
612 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
613 }
614 } // for (graphics_on tokens)
615
616 } else if ((StriCmp(TokenList[0], L"font") == 0) && (TokenCount == 2)) {
617 egLoadFont(TokenList[1]);
618
619 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
620 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
621 GlobalConfig.ScanAllLinux = FALSE;
622 } else {
623 GlobalConfig.ScanAllLinux = TRUE;
624 }
625
626 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
627 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
628
629 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
630 if (StriCmp(TokenList[1], FileName) != 0) {
631 ReadConfig(TokenList[1]);
632 }
633
634 }
635
636 FreeTokenLine(&TokenList, &TokenCount);
637 }
638 MyFreePool(File.Buffer);
639 } /* VOID ReadConfig() */
640
641 // Finds a volume with the specified Identifier (a volume label or a number
642 // followed by a colon, for the moment). If found, sets *Volume to point to
643 // that volume. If not, leaves it unchanged.
644 // Returns TRUE if a match was found, FALSE if not.
645 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
646 UINTN i = 0, CountedVolumes = 0;
647 INTN Number = -1;
648 BOOLEAN Found = FALSE;
649
650 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
651 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
652 Number = (INTN) Atoi(Identifier);
653 }
654 while ((i < VolumesCount) && (!Found)) {
655 if (Number >= 0) { // User specified a volume by number
656 if (Volumes[i]->IsReadable) {
657 if (CountedVolumes == Number) {
658 *Volume = Volumes[i];
659 Found = TRUE;
660 }
661 CountedVolumes++;
662 } // if
663 } else { // User specified a volume by label
664 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
665 *Volume = Volumes[i];
666 Found = TRUE;
667 } // if
668 } // if/else
669 i++;
670 } // while()
671 return (Found);
672 } // static VOID FindVolume()
673
674 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
675 REFIT_MENU_SCREEN *SubScreen;
676 LOADER_ENTRY *SubEntry;
677 UINTN TokenCount;
678 CHAR16 **TokenList;
679
680 SubScreen = InitializeSubScreen(Entry);
681
682 // Set defaults for the new entry; will be modified based on lines read from the config. file....
683 SubEntry = InitializeLoaderEntry(Entry);
684
685 if ((SubEntry == NULL) || (SubScreen == NULL))
686 return;
687 SubEntry->me.Title = StrDuplicate(Title);
688
689 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
690
691 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
692 MyFreePool(SubEntry->LoaderPath);
693 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
694 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
695
696 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
697 if (FindVolume(&Volume, TokenList[1])) {
698 MyFreePool(SubEntry->me.Title);
699 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
700 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
701 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
702 SubEntry->VolName = Volume->VolName;
703 } // if match found
704
705 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
706 MyFreePool(SubEntry->InitrdPath);
707 SubEntry->InitrdPath = NULL;
708 if (TokenCount > 1) {
709 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
710 }
711
712 } else if (StriCmp(TokenList[0], L"options") == 0) {
713 MyFreePool(SubEntry->LoadOptions);
714 SubEntry->LoadOptions = NULL;
715 if (TokenCount > 1) {
716 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
717 } // if/else
718
719 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
720 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
721
722 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
723 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
724
725 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
726 SubEntry->Enabled = FALSE;
727 } // ief/elseif
728
729 FreeTokenLine(&TokenList, &TokenCount);
730 } // while()
731
732 if (SubEntry->InitrdPath != NULL) {
733 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
734 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
735 MyFreePool(SubEntry->InitrdPath);
736 SubEntry->InitrdPath = NULL;
737 } // if
738 if (SubEntry->Enabled == TRUE) {
739 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
740 }
741 Entry->me.SubScreen = SubScreen;
742 } // VOID AddSubmenu()
743
744 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
745 // that entry. The calling function is then responsible for adding the entry to the
746 // list of entries.
747 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
748 CHAR16 **TokenList;
749 UINTN TokenCount;
750 LOADER_ENTRY *Entry;
751 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
752 REFIT_VOLUME *CurrentVolume = Volume;
753
754 // prepare the menu entry
755 Entry = InitializeLoaderEntry(NULL);
756 if (Entry == NULL)
757 return NULL;
758
759 Entry->Title = StrDuplicate(Title);
760 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
761 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
762 Entry->me.Row = 0;
763 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
764 Entry->VolName = CurrentVolume->VolName;
765
766 // Parse the config file to add options for a single stanza, terminating when the token
767 // is "}" or when the end of file is reached.
768 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
769 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
770 Entry->LoaderPath = StrDuplicate(TokenList[1]);
771 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
772 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
773 MyFreePool(Entry->LoadOptions);
774 Entry->LoadOptions = NULL; // Discard default options, if any
775 DefaultsSet = TRUE;
776
777 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
778 if (FindVolume(&CurrentVolume, TokenList[1])) {
779 MyFreePool(Entry->me.Title);
780 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
781 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
782 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
783 Entry->VolName = CurrentVolume->VolName;
784 } // if match found
785
786 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
787 MyFreePool(Entry->me.Image);
788 Entry->me.Image = egLoadIcon(CurrentVolume->RootDir, TokenList[1], 128);
789 if (Entry->me.Image == NULL) {
790 Entry->me.Image = DummyImage(128);
791 }
792
793 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
794 MyFreePool(Entry->InitrdPath);
795 Entry->InitrdPath = StrDuplicate(TokenList[1]);
796
797 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
798 MyFreePool(Entry->LoadOptions);
799 Entry->LoadOptions = StrDuplicate(TokenList[1]);
800
801 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
802 if (TokenCount > 1) {
803 Entry->OSType = TokenList[1][0];
804 }
805
806 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
807 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
808
809 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
810 Entry->Enabled = FALSE;
811
812 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
813 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
814 AddedSubmenu = TRUE;
815
816 } // set options to pass to the loader program
817 FreeTokenLine(&TokenList, &TokenCount);
818 } // while()
819
820 if (AddedSubmenu)
821 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
822
823 if (Entry->InitrdPath) {
824 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
825 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
826 MyFreePool(Entry->InitrdPath);
827 Entry->InitrdPath = NULL;
828 } // if
829
830 if (!DefaultsSet)
831 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no "loader" line; use bogus one
832
833 return(Entry);
834 } // static VOID AddStanzaEntries()
835
836 // Read the user-configured menu entries from refind.conf and add or delete
837 // entries based on the contents of that file....
838 VOID ScanUserConfigured(CHAR16 *FileName)
839 {
840 EFI_STATUS Status;
841 REFIT_FILE File;
842 REFIT_VOLUME *Volume;
843 CHAR16 **TokenList;
844 CHAR16 *Title = NULL;
845 UINTN TokenCount, size;
846 LOADER_ENTRY *Entry;
847
848 if (FileExists(SelfDir, FileName)) {
849 Status = ReadFile(SelfDir, FileName, &File, &size);
850 if (EFI_ERROR(Status))
851 return;
852
853 Volume = SelfVolume;
854
855 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
856 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
857 Title = StrDuplicate(TokenList[1]);
858 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
859 if (Entry->Enabled) {
860 if (Entry->me.SubScreen == NULL)
861 GenerateSubScreen(Entry, Volume);
862 AddPreparedLoaderEntry(Entry);
863 } else {
864 MyFreePool(Entry);
865 } // if/else
866 MyFreePool(Title);
867
868 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
869 if (StriCmp(TokenList[1], FileName) != 0) {
870 ScanUserConfigured(TokenList[1]);
871 }
872
873 } // if/else if...
874 FreeTokenLine(&TokenList, &TokenCount);
875 } // while()
876 } // if()
877 } // VOID ScanUserConfigured()
878
879 // Create an options file based on /etc/fstab. The resulting file has two options
880 // lines, one of which boots the system with "ro root={rootfs}" and the other of
881 // which boots the system with "ro root={rootfs} single", where "{rootfs}" is the
882 // filesystem identifier associated with the "/" line in /etc/fstab.
883 static REFIT_FILE * GenerateOptionsFromEtcFstab(REFIT_VOLUME *Volume) {
884 UINTN TokenCount, i;
885 REFIT_FILE *Options = NULL, *Fstab = NULL;
886 EFI_STATUS Status;
887 CHAR16 **TokenList, *Line, Root[100];
888
889 if (FileExists(Volume->RootDir, L"\\etc\\fstab")) {
890 Options = AllocateZeroPool(sizeof(REFIT_FILE));
891 Fstab = AllocateZeroPool(sizeof(REFIT_FILE));
892 Status = ReadFile(Volume->RootDir, L"\\etc\\fstab", Fstab, &i);
893 if (CheckError(Status, L"while reading /etc/fstab")) {
894 if (Options != NULL)
895 FreePool(Options);
896 if (Fstab != NULL)
897 FreePool(Fstab);
898 Options = NULL;
899 Fstab = NULL;
900 } else { // File read; locate root fs and create entries
901 Options->Encoding = ENCODING_UTF16_LE;
902 while ((TokenCount = ReadTokenLine(Fstab, &TokenList)) > 0) {
903 if (TokenCount > 2) {
904 Root[0] = '\0';
905 if (StriCmp(TokenList[1], L"\\") == 0) {
906 SPrint(Root, 99, L"%s", TokenList[0]);
907 } else if (StriCmp(TokenList[2], L"\\") == 0) {
908 SPrint(Root, 99, L"%s=%s", TokenList[0], TokenList[1]);
909 } // if/elseif/elseif
910 if (Root[0] != L'\0') {
911 for (i = 0; i < StrLen(Root); i++)
912 if (Root[i] == '\\')
913 Root[i] = '/';
914 Line = PoolPrint(L"\"Boot with normal options\" \"ro root=%s\"\n", Root);
915 MergeStrings((CHAR16 **) &(Options->Buffer), Line, 0);
916 MyFreePool(Line);
917 Line = PoolPrint(L"\"Boot into single-user mode\" \"ro root=%s single\"\n", Root);
918 MergeStrings((CHAR16**) &(Options->Buffer), Line, 0);
919 Options->BufferSize = StrLen((CHAR16*) Options->Buffer) * sizeof(CHAR16);
920 } // if
921 } // if
922 FreeTokenLine(&TokenList, &TokenCount);
923 } // while
924
925 Options->Current8Ptr = (CHAR8 *)Options->Buffer;
926 Options->End8Ptr = Options->Current8Ptr + Options->BufferSize;
927 Options->Current16Ptr = (CHAR16 *)Options->Buffer;
928 Options->End16Ptr = Options->Current16Ptr + (Options->BufferSize >> 1);
929
930 MyFreePool(Fstab->Buffer);
931 MyFreePool(Fstab);
932 } // if/else file read error
933 } // if /etc/fstab exists
934 return Options;
935 } // GenerateOptionsFromEtcFstab()
936
937
938 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
939 // and Volume variables identify the location of the options file, but not its name --
940 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
941 // file in the target directory, and this function finds the file with a name in the
942 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
943 // directory and loads it. This function tries multiple files because I originally
944 // used the filename linux.conf, but close on the heels of that decision, the Linux
945 // kernel developers decided to use that name for a similar purpose, but with a
946 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
947 // but I want a migration period in which both names are used.
948 // If a rEFInd options file can't be found, try to generate minimal options from
949 // /etc/fstab on the same volume as the kernel. This typically works only if the
950 // kernel is being read from the Linux root filesystem.
951 //
952 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
953 // it wasn't found.
954 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
955 CHAR16 *OptionsFilename, *FullFilename;
956 BOOLEAN GoOn = TRUE, FileFound = FALSE;
957 UINTN i = 0, size;
958 REFIT_FILE *File = NULL;
959 EFI_STATUS Status;
960
961 do {
962 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
963 FullFilename = FindPath(LoaderPath);
964 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
965 MergeStrings(&FullFilename, OptionsFilename, '\\');
966 if (FileExists(Volume->RootDir, FullFilename)) {
967 File = AllocateZeroPool(sizeof(REFIT_FILE));
968 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
969 if (CheckError(Status, L"while loading the Linux options file")) {
970 if (File != NULL)
971 FreePool(File);
972 File = NULL;
973 } else {
974 GoOn = FALSE;
975 FileFound = TRUE;
976 } // if/else error
977 } // if file exists
978 } else { // a filename string is NULL
979 GoOn = FALSE;
980 } // if/else
981 if (!FileFound)
982 File = GenerateOptionsFromEtcFstab(Volume);
983 MyFreePool(OptionsFilename);
984 MyFreePool(FullFilename);
985 OptionsFilename = FullFilename = NULL;
986 } while (GoOn);
987 return (File);
988 } // static REFIT_FILE * ReadLinuxOptionsFile()
989
990 // Retrieve a single line of options from a Linux kernel options file
991 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
992 UINTN TokenCount;
993 CHAR16 *Options = NULL;
994 CHAR16 **TokenList;
995 REFIT_FILE *File;
996
997 File = ReadLinuxOptionsFile(LoaderPath, Volume);
998 if (File != NULL) {
999 TokenCount = ReadTokenLine(File, &TokenList);
1000 if (TokenCount > 1)
1001 Options = StrDuplicate(TokenList[1]);
1002 FreeTokenLine(&TokenList, &TokenCount);
1003 FreePool(File);
1004 } // if
1005 return Options;
1006 } // static CHAR16 * GetOptionsFile()
1007