]> code.delx.au - refind/blob - refind/config.c
delx.au / code / refind / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Added "windows_recovery" option to "showtools" token and
[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 replace or be added to a
328 // comma-delimited list. Passes each token through the CleanUpPathNameSlashes() function
329 // to ensure consistency in subsequent comparisons of filenames. If the first
330 // non-keyword token is "+", the list is added to the existing target string; otherwise,
331 // the tokens replace the current string.
332 static VOID HandleStrings(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
333 UINTN i;
334 BOOLEAN AddMode = FALSE;
335
336 if ((TokenCount > 2) && (StriCmp(TokenList[1], L"+") == 0)) {
337 AddMode = TRUE;
338 }
339
340 if ((*Target != NULL) && !AddMode) {
341 FreePool(*Target);
342 *Target = NULL;
343 } // if
344 for (i = 1; i < TokenCount; i++) {
345 if ((i != 1) || !AddMode) {
346 CleanUpPathNameSlashes(TokenList[i]);
347 MergeStrings(Target, TokenList[i], L',');
348 } // if
349 } // for
350 } // static VOID HandleStrings()
351
352 // Convert TimeString (in "HH:MM" format) to a pure-minute format. Values should be
353 // in the range from 0 (for 00:00, or midnight) to 1439 (for 23:59; aka LAST_MINUTE).
354 // Any value outside that range denotes an error in the specification. Note that if
355 // the input is a number that includes no colon, this function will return the original
356 // number in UINTN form.
357 static UINTN HandleTime(IN CHAR16 *TimeString) {
358 UINTN Hour = 0, Minute = 0, TimeLength, i = 0;
359
360 TimeLength = StrLen(TimeString);
361 while (i < TimeLength) {
362 if (TimeString[i] == L':') {
363 Hour = Minute;
364 Minute = 0;
365 } // if
366 if ((TimeString[i] >= L'0') && (TimeString[i] <= '9')) {
367 Minute *= 10;
368 Minute += (TimeString[i] - L'0');
369 } // if
370 i++;
371 } // while
372 return (Hour * 60 + Minute);
373 } // BOOLEAN HandleTime()
374
375 // Sets the default boot loader IF the current time is within the bounds
376 // defined by the third and fourth tokens in the TokenList.
377 static VOID SetDefaultByTime(IN CHAR16 **TokenList, OUT CHAR16 **Default) {
378 EFI_STATUS Status;
379 EFI_TIME CurrentTime;
380 UINTN StartTime = LAST_MINUTE + 1, EndTime = LAST_MINUTE + 1, Now;
381 BOOLEAN SetIt = FALSE;
382
383 StartTime = HandleTime(TokenList[2]);
384 EndTime = HandleTime(TokenList[3]);
385
386 if ((StartTime <= LAST_MINUTE) && (EndTime <= LAST_MINUTE)) {
387 Status = refit_call2_wrapper(GetTime, &CurrentTime, NULL);
388 if (Status != EFI_SUCCESS)
389 return;
390 Now = CurrentTime.Hour * 60 + CurrentTime.Minute;
391
392 if (Now > LAST_MINUTE) { // Shouldn't happen; just being paranoid
393 Print(L"Warning: Impossible system time: %d:%d\n", CurrentTime.Hour, CurrentTime.Minute);
394 return;
395 } // if impossible time
396
397 if (StartTime < EndTime) { // Time range does NOT cross midnight
398 if ((Now >= StartTime) && (Now <= EndTime))
399 SetIt = TRUE;
400 } else { // Time range DOES cross midnight
401 if ((Now >= StartTime) && (Now <= EndTime))
402 SetIt = TRUE;
403 } // if/else time range crosses midnight
404
405 if (SetIt) {
406 MyFreePool(*Default);
407 *Default = StrDuplicate(TokenList[1]);
408 } // if (SetIt)
409 } // if ((StartTime <= LAST_MINUTE) && (EndTime <= LAST_MINUTE))
410 } // VOID SetDefaultByTime()
411
412 // read config file
413 VOID ReadConfig(CHAR16 *FileName)
414 {
415 EFI_STATUS Status;
416 REFIT_FILE File;
417 CHAR16 **TokenList;
418 CHAR16 *FlagName;
419 CHAR16 *TempStr = NULL;
420 UINTN TokenCount, i;
421
422 // Set a few defaults only if we're loading the default file.
423 if (StriCmp(FileName, GlobalConfig.ConfigFilename) == 0) {
424 MyFreePool(GlobalConfig.AlsoScan);
425 GlobalConfig.AlsoScan = StrDuplicate(ALSO_SCAN_DIRS);
426 MyFreePool(GlobalConfig.DontScanDirs);
427 if (SelfVolume) {
428 if (SelfVolume->VolName) {
429 TempStr = SelfVolume->VolName ? StrDuplicate(SelfVolume->VolName) : NULL;
430 } else {
431 TempStr = AllocateZeroPool(256 * sizeof(CHAR16));
432 if (TempStr != NULL)
433 SPrint(TempStr, 255, L"fs%d", SelfVolume->VolNumber);
434 } // if/else
435 }
436 MergeStrings(&TempStr, SelfDirPath, L':');
437 MergeStrings(&TempStr, MEMTEST_LOCATIONS, L',');
438 GlobalConfig.DontScanDirs = TempStr;
439 MyFreePool(GlobalConfig.DontScanFiles);
440 GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
441 MergeStrings(&(GlobalConfig.DontScanFiles), MOK_NAMES, L',');
442 MyFreePool(GlobalConfig.DontScanVolumes);
443 GlobalConfig.DontScanVolumes = StrDuplicate(DONT_SCAN_VOLUMES);
444 GlobalConfig.WindowsRecoveryFiles = StrDuplicate(WINDOWS_RECOVERY_FILES);
445 } // if
446
447 if (!FileExists(SelfDir, FileName)) {
448 Print(L"Configuration file '%s' missing!\n", FileName);
449 return;
450 }
451
452 Status = ReadFile(SelfDir, FileName, &File, &i);
453 if (EFI_ERROR(Status))
454 return;
455
456 for (;;) {
457 TokenCount = ReadTokenLine(&File, &TokenList);
458 if (TokenCount == 0)
459 break;
460
461 if (StriCmp(TokenList[0], L"timeout") == 0) {
462 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
463
464 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
465 for (i = 1; i < TokenCount; i++) {
466 FlagName = TokenList[i];
467 if (StriCmp(FlagName, L"banner") == 0) {
468 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
469 } else if (StriCmp(FlagName, L"label") == 0) {
470 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
471 } else if (StriCmp(FlagName, L"singleuser") == 0) {
472 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
473 } else if (StriCmp(FlagName, L"hwtest") == 0) {
474 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
475 } else if (StriCmp(FlagName, L"arrows") == 0) {
476 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
477 } else if (StriCmp(FlagName, L"hints") == 0) {
478 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HINTS;
479 } else if (StriCmp(FlagName, L"editor") == 0) {
480 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_EDITOR;
481 } else if (StriCmp(FlagName, L"safemode") == 0) {
482 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SAFEMODE;
483 } else if (StriCmp(FlagName, L"all") == 0) {
484 GlobalConfig.HideUIFlags = HIDEUI_FLAG_ALL;
485 } else {
486 Print(L" unknown hideui flag: '%s'\n", FlagName);
487 }
488 }
489
490 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
491 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
492
493 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
494 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
495 if (i < TokenCount)
496 GlobalConfig.ScanFor[i] = TokenList[i][0];
497 else
498 GlobalConfig.ScanFor[i] = ' ';
499 }
500
501 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
502 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
503
504 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
505 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
506
507 } else if ((StriCmp(TokenList[0], L"don't_scan_volumes") == 0) || (StriCmp(TokenList[0], L"dont_scan_volumes") == 0)) {
508 // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
509 MyFreePool(GlobalConfig.DontScanVolumes);
510 GlobalConfig.DontScanVolumes = NULL;
511 for (i = 1; i < TokenCount; i++) {
512 MergeStrings(&GlobalConfig.DontScanVolumes, TokenList[i], L',');
513 }
514
515 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
516 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
517
518 } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
519 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
520
521 } else if (StriCmp(TokenList[0], L"windows_recovery_files") == 0) {
522 HandleStrings(TokenList, TokenCount, &(GlobalConfig.WindowsRecoveryFiles));
523
524 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
525 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
526
527 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
528 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
529 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
530 FlagName = TokenList[i];
531 if (StriCmp(FlagName, L"shell") == 0) {
532 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
533 } else if (StriCmp(FlagName, L"gptsync") == 0) {
534 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
535 } else if (StriCmp(FlagName, L"about") == 0) {
536 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
537 } else if (StriCmp(FlagName, L"exit") == 0) {
538 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
539 } else if (StriCmp(FlagName, L"reboot") == 0) {
540 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
541 } else if (StriCmp(FlagName, L"shutdown") == 0) {
542 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
543 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
544 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
545 } else if (StriCmp(FlagName, L"windows_recovery") == 0) {
546 GlobalConfig.ShowTools[i - 1] = TAG_WINDOWS_RECOVERY;
547 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
548 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
549 } else if (StriCmp(FlagName, L"firmware") == 0) {
550 GlobalConfig.ShowTools[i - 1] = TAG_FIRMWARE;
551 } else if ((StriCmp(FlagName, L"memtest86") == 0) || (StriCmp(FlagName, L"memtest") == 0)) {
552 GlobalConfig.ShowTools[i - 1] = TAG_MEMTEST;
553 } else {
554 Print(L" unknown showtools flag: '%s'\n", FlagName);
555 }
556 } // showtools options
557
558 } else if (StriCmp(TokenList[0], L"banner") == 0) {
559 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
560
561 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
562 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
563
564 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
565 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
566
567 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
568 if (TokenCount == 4) {
569 SetDefaultByTime(TokenList, &(GlobalConfig.DefaultSelection));
570 } else {
571 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
572 }
573
574 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
575 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
576 GlobalConfig.TextOnly = FALSE;
577 } else {
578 GlobalConfig.TextOnly = TRUE;
579 }
580
581 } else if (StriCmp(TokenList[0], L"textmode") == 0) {
582 HandleInt(TokenList, TokenCount, &(GlobalConfig.RequestedTextMode));
583
584 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && ((TokenCount == 2) || (TokenCount == 3))) {
585 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
586 if (TokenCount == 3)
587 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
588 else
589 GlobalConfig.RequestedScreenHeight = 0;
590
591 } else if (StriCmp(TokenList[0], L"screensaver") == 0) {
592 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScreensaverTime));
593
594 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
595 if ((TokenCount == 2) || ((TokenCount > 2) && (StriCmp(TokenList[1], L"+") != 0)))
596 GlobalConfig.GraphicsFor = 0;
597 for (i = 1; i < TokenCount; i++) {
598 if (StriCmp(TokenList[i], L"osx") == 0) {
599 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
600 } else if (StriCmp(TokenList[i], L"linux") == 0) {
601 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
602 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
603 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
604 } else if (StriCmp(TokenList[i], L"grub") == 0) {
605 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
606 } else if (StriCmp(TokenList[i], L"windows") == 0) {
607 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
608 }
609 } // for (graphics_on tokens)
610
611 } else if ((StriCmp(TokenList[0], L"font") == 0) && (TokenCount == 2)) {
612 egLoadFont(TokenList[1]);
613
614 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
615 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
616 GlobalConfig.ScanAllLinux = FALSE;
617 } else {
618 GlobalConfig.ScanAllLinux = TRUE;
619 }
620
621 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
622 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
623
624 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) &&
625 (StriCmp(FileName, GlobalConfig.ConfigFilename) == 0)) {
626 if (StriCmp(TokenList[1], FileName) != 0) {
627 ReadConfig(TokenList[1]);
628 }
629
630 }
631
632 FreeTokenLine(&TokenList, &TokenCount);
633 }
634 MyFreePool(File.Buffer);
635 } /* VOID ReadConfig() */
636
637 // Finds a volume with the specified Identifier (a volume label or a number
638 // followed by a colon, for the moment). If found, sets *Volume to point to
639 // that volume. If not, leaves it unchanged.
640 // Returns TRUE if a match was found, FALSE if not.
641 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
642 UINTN i = 0, CountedVolumes = 0;
643 INTN Number = -1;
644 BOOLEAN Found = FALSE;
645
646 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
647 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
648 Number = (INTN) Atoi(Identifier);
649 }
650 while ((i < VolumesCount) && (!Found)) {
651 if (Number >= 0) { // User specified a volume by number
652 if (Volumes[i]->IsReadable) {
653 if (CountedVolumes == Number) {
654 *Volume = Volumes[i];
655 Found = TRUE;
656 }
657 CountedVolumes++;
658 } // if
659 } else { // User specified a volume by label
660 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
661 *Volume = Volumes[i];
662 Found = TRUE;
663 } // if
664 } // if/else
665 i++;
666 } // while()
667 return (Found);
668 } // static VOID FindVolume()
669
670 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
671 REFIT_MENU_SCREEN *SubScreen;
672 LOADER_ENTRY *SubEntry;
673 UINTN TokenCount;
674 CHAR16 **TokenList;
675
676 SubScreen = InitializeSubScreen(Entry);
677
678 // Set defaults for the new entry; will be modified based on lines read from the config. file....
679 SubEntry = InitializeLoaderEntry(Entry);
680
681 if ((SubEntry == NULL) || (SubScreen == NULL))
682 return;
683 SubEntry->me.Title = StrDuplicate(Title);
684
685 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
686
687 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
688 MyFreePool(SubEntry->LoaderPath);
689 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
690 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
691
692 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
693 if (FindVolume(&Volume, TokenList[1])) {
694 MyFreePool(SubEntry->me.Title);
695 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
696 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
697 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
698 SubEntry->VolName = Volume->VolName;
699 } // if match found
700
701 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
702 MyFreePool(SubEntry->InitrdPath);
703 SubEntry->InitrdPath = NULL;
704 if (TokenCount > 1) {
705 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
706 }
707
708 } else if (StriCmp(TokenList[0], L"options") == 0) {
709 MyFreePool(SubEntry->LoadOptions);
710 SubEntry->LoadOptions = NULL;
711 if (TokenCount > 1) {
712 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
713 } // if/else
714
715 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
716 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
717
718 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
719 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
720
721 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
722 SubEntry->Enabled = FALSE;
723 } // ief/elseif
724
725 FreeTokenLine(&TokenList, &TokenCount);
726 } // while()
727
728 if (SubEntry->InitrdPath != NULL) {
729 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
730 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
731 MyFreePool(SubEntry->InitrdPath);
732 SubEntry->InitrdPath = NULL;
733 } // if
734 if (SubEntry->Enabled == TRUE) {
735 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
736 }
737 Entry->me.SubScreen = SubScreen;
738 } // VOID AddSubmenu()
739
740 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
741 // that entry. The calling function is then responsible for adding the entry to the
742 // list of entries.
743 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
744 CHAR16 **TokenList;
745 UINTN TokenCount;
746 LOADER_ENTRY *Entry;
747 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
748 REFIT_VOLUME *CurrentVolume = Volume;
749
750 // prepare the menu entry
751 Entry = InitializeLoaderEntry(NULL);
752 if (Entry == NULL)
753 return NULL;
754
755 Entry->Title = StrDuplicate(Title);
756 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
757 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
758 Entry->me.Row = 0;
759 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
760 Entry->VolName = CurrentVolume->VolName;
761
762 // Parse the config file to add options for a single stanza, terminating when the token
763 // is "}" or when the end of file is reached.
764 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
765 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
766 Entry->LoaderPath = StrDuplicate(TokenList[1]);
767 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
768 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
769 MyFreePool(Entry->LoadOptions);
770 Entry->LoadOptions = NULL; // Discard default options, if any
771 DefaultsSet = TRUE;
772
773 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
774 if (FindVolume(&CurrentVolume, TokenList[1])) {
775 MyFreePool(Entry->me.Title);
776 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
777 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
778 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
779 Entry->VolName = CurrentVolume->VolName;
780 } // if match found
781
782 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
783 MyFreePool(Entry->me.Image);
784 Entry->me.Image = egLoadIcon(CurrentVolume->RootDir, TokenList[1], 128);
785 if (Entry->me.Image == NULL) {
786 Entry->me.Image = DummyImage(128);
787 }
788
789 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
790 MyFreePool(Entry->InitrdPath);
791 Entry->InitrdPath = StrDuplicate(TokenList[1]);
792
793 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
794 MyFreePool(Entry->LoadOptions);
795 Entry->LoadOptions = StrDuplicate(TokenList[1]);
796
797 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
798 if (TokenCount > 1) {
799 Entry->OSType = TokenList[1][0];
800 }
801
802 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
803 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
804
805 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
806 Entry->Enabled = FALSE;
807
808 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
809 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
810 AddedSubmenu = TRUE;
811
812 } // set options to pass to the loader program
813 FreeTokenLine(&TokenList, &TokenCount);
814 } // while()
815
816 if (AddedSubmenu)
817 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
818
819 if (Entry->InitrdPath) {
820 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
821 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
822 MyFreePool(Entry->InitrdPath);
823 Entry->InitrdPath = NULL;
824 } // if
825
826 if (!DefaultsSet)
827 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no "loader" line; use bogus one
828
829 return(Entry);
830 } // static VOID AddStanzaEntries()
831
832 // Read the user-configured menu entries from refind.conf and add or delete
833 // entries based on the contents of that file....
834 VOID ScanUserConfigured(CHAR16 *FileName)
835 {
836 EFI_STATUS Status;
837 REFIT_FILE File;
838 REFIT_VOLUME *Volume;
839 CHAR16 **TokenList;
840 CHAR16 *Title = NULL;
841 UINTN TokenCount, size;
842 LOADER_ENTRY *Entry;
843
844 if (FileExists(SelfDir, FileName)) {
845 Status = ReadFile(SelfDir, FileName, &File, &size);
846 if (EFI_ERROR(Status))
847 return;
848
849 Volume = SelfVolume;
850
851 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
852 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
853 Title = StrDuplicate(TokenList[1]);
854 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
855 if (Entry->Enabled) {
856 if (Entry->me.SubScreen == NULL)
857 GenerateSubScreen(Entry, Volume);
858 AddPreparedLoaderEntry(Entry);
859 } else {
860 MyFreePool(Entry);
861 } // if/else
862 MyFreePool(Title);
863
864 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) &&
865 (StriCmp(FileName, GlobalConfig.ConfigFilename) == 0)) {
866 if (StriCmp(TokenList[1], FileName) != 0) {
867 ScanUserConfigured(TokenList[1]);
868 }
869
870 } // if/else if...
871 FreeTokenLine(&TokenList, &TokenCount);
872 } // while()
873 } // if()
874 } // VOID ScanUserConfigured()
875
876 // Create an options file based on /etc/fstab. The resulting file has two options
877 // lines, one of which boots the system with "ro root={rootfs}" and the other of
878 // which boots the system with "ro root={rootfs} single", where "{rootfs}" is the
879 // filesystem identifier associated with the "/" line in /etc/fstab.
880 static REFIT_FILE * GenerateOptionsFromEtcFstab(REFIT_VOLUME *Volume) {
881 UINTN TokenCount, i;
882 REFIT_FILE *Options = NULL, *Fstab = NULL;
883 EFI_STATUS Status;
884 CHAR16 **TokenList, *Line, Root[100];
885
886 if (FileExists(Volume->RootDir, L"\\etc\\fstab")) {
887 Options = AllocateZeroPool(sizeof(REFIT_FILE));
888 Fstab = AllocateZeroPool(sizeof(REFIT_FILE));
889 Status = ReadFile(Volume->RootDir, L"\\etc\\fstab", Fstab, &i);
890 if (CheckError(Status, L"while reading /etc/fstab")) {
891 if (Options != NULL)
892 FreePool(Options);
893 if (Fstab != NULL)
894 FreePool(Fstab);
895 Options = NULL;
896 Fstab = NULL;
897 } else { // File read; locate root fs and create entries
898 Options->Encoding = ENCODING_UTF16_LE;
899 while ((TokenCount = ReadTokenLine(Fstab, &TokenList)) > 0) {
900 if (TokenCount > 2) {
901 Root[0] = '\0';
902 if (StriCmp(TokenList[1], L"\\") == 0) {
903 SPrint(Root, 99, L"%s", TokenList[0]);
904 } else if (StriCmp(TokenList[2], L"\\") == 0) {
905 SPrint(Root, 99, L"%s=%s", TokenList[0], TokenList[1]);
906 } // if/elseif/elseif
907 if (Root[0] != L'\0') {
908 for (i = 0; i < StrLen(Root); i++)
909 if (Root[i] == '\\')
910 Root[i] = '/';
911 Line = PoolPrint(L"\"Boot with normal options\" \"ro root=%s\"\n", Root);
912 MergeStrings((CHAR16 **) &(Options->Buffer), Line, 0);
913 MyFreePool(Line);
914 Line = PoolPrint(L"\"Boot into single-user mode\" \"ro root=%s single\"\n", Root);
915 MergeStrings((CHAR16**) &(Options->Buffer), Line, 0);
916 Options->BufferSize = StrLen((CHAR16*) Options->Buffer) * sizeof(CHAR16);
917 } // if
918 } // if
919 FreeTokenLine(&TokenList, &TokenCount);
920 } // while
921
922 Options->Current8Ptr = (CHAR8 *)Options->Buffer;
923 Options->End8Ptr = Options->Current8Ptr + Options->BufferSize;
924 Options->Current16Ptr = (CHAR16 *)Options->Buffer;
925 Options->End16Ptr = Options->Current16Ptr + (Options->BufferSize >> 1);
926
927 MyFreePool(Fstab->Buffer);
928 MyFreePool(Fstab);
929 } // if/else file read error
930 } // if /etc/fstab exists
931 return Options;
932 } // GenerateOptionsFromEtcFstab()
933
934
935 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
936 // and Volume variables identify the location of the options file, but not its name --
937 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
938 // file in the target directory, and this function finds the file with a name in the
939 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
940 // directory and loads it. This function tries multiple files because I originally
941 // used the filename linux.conf, but close on the heels of that decision, the Linux
942 // kernel developers decided to use that name for a similar purpose, but with a
943 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
944 // but I want a migration period in which both names are used.
945 // If a rEFInd options file can't be found, try to generate minimal options from
946 // /etc/fstab on the same volume as the kernel. This typically works only if the
947 // kernel is being read from the Linux root filesystem.
948 //
949 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
950 // it wasn't found.
951 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
952 CHAR16 *OptionsFilename, *FullFilename;
953 BOOLEAN GoOn = TRUE, FileFound = FALSE;
954 UINTN i = 0, size;
955 REFIT_FILE *File = NULL;
956 EFI_STATUS Status;
957
958 do {
959 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
960 FullFilename = FindPath(LoaderPath);
961 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
962 MergeStrings(&FullFilename, OptionsFilename, '\\');
963 if (FileExists(Volume->RootDir, FullFilename)) {
964 File = AllocateZeroPool(sizeof(REFIT_FILE));
965 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
966 if (CheckError(Status, L"while loading the Linux options file")) {
967 if (File != NULL)
968 FreePool(File);
969 File = NULL;
970 } else {
971 GoOn = FALSE;
972 FileFound = TRUE;
973 } // if/else error
974 } // if file exists
975 } else { // a filename string is NULL
976 GoOn = FALSE;
977 } // if/else
978 if (!FileFound)
979 File = GenerateOptionsFromEtcFstab(Volume);
980 MyFreePool(OptionsFilename);
981 MyFreePool(FullFilename);
982 OptionsFilename = FullFilename = NULL;
983 } while (GoOn);
984 return (File);
985 } // static REFIT_FILE * ReadLinuxOptionsFile()
986
987 // Retrieve a single line of options from a Linux kernel options file
988 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
989 UINTN TokenCount;
990 CHAR16 *Options = NULL;
991 CHAR16 **TokenList;
992 REFIT_FILE *File;
993
994 File = ReadLinuxOptionsFile(LoaderPath, Volume);
995 if (File != NULL) {
996 TokenCount = ReadTokenLine(File, &TokenList);
997 if (TokenCount > 1)
998 Options = StrDuplicate(TokenList[1]);
999 FreeTokenLine(&TokenList, &TokenCount);
1000 FreePool(File);
1001 } // if
1002 return Options;
1003 } // static CHAR16 * GetOptionsFile()
1004