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