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