]> code.delx.au - refind/blob - refind/config.c
delx.au / code / refind / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Refinements, mostly to shim/MOK support.
[refind] / refind / config.c
1 /*
2 * refit/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 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 CONFIG_FILE_NAME L"refind.conf"
57 #define LINUX_OPTIONS_FILENAMES L"refind_linux.conf,refind-linux.conf"
58 #define MAXCONFIGFILESIZE (128*1024)
59
60 #define ENCODING_ISO8859_1 (0)
61 #define ENCODING_UTF8 (1)
62 #define ENCODING_UTF16_LE (2)
63
64 static REFIT_MENU_ENTRY MenuEntryReturn = { L"Return to Main Menu", TAG_RETURN, 0, 0, 0, NULL, NULL, NULL };
65
66 //
67 // read a file into a buffer
68 //
69
70 EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, IN CHAR16 *FileName, IN OUT REFIT_FILE *File, OUT UINTN *size)
71 {
72 EFI_STATUS Status;
73 EFI_FILE_HANDLE FileHandle;
74 EFI_FILE_INFO *FileInfo;
75 UINT64 ReadSize;
76 CHAR16 Message[256];
77
78 File->Buffer = NULL;
79 File->BufferSize = 0;
80
81 // read the file, allocating a buffer on the way
82 Status = refit_call5_wrapper(BaseDir->Open, BaseDir, &FileHandle, FileName, EFI_FILE_MODE_READ, 0);
83 SPrint(Message, 255, L"while loading the file '%s'", FileName);
84 if (CheckError(Status, Message))
85 return Status;
86
87 FileInfo = LibFileInfo(FileHandle);
88 if (FileInfo == NULL) {
89 // TODO: print and register the error
90 refit_call1_wrapper(FileHandle->Close, FileHandle);
91 return EFI_LOAD_ERROR;
92 }
93 ReadSize = FileInfo->FileSize;
94 FreePool(FileInfo);
95
96 File->BufferSize = (UINTN)ReadSize;
97 File->Buffer = AllocatePool(File->BufferSize);
98 if (File->Buffer == NULL) {
99 size = 0;
100 return EFI_OUT_OF_RESOURCES;
101 } else {
102 *size = File->BufferSize;
103 } // if/else
104 Status = refit_call3_wrapper(FileHandle->Read, FileHandle, &File->BufferSize, File->Buffer);
105 if (CheckError(Status, Message)) {
106 MyFreePool(File->Buffer);
107 File->Buffer = NULL;
108 refit_call1_wrapper(FileHandle->Close, FileHandle);
109 return Status;
110 }
111 Status = refit_call1_wrapper(FileHandle->Close, FileHandle);
112
113 // setup for reading
114 File->Current8Ptr = (CHAR8 *)File->Buffer;
115 File->End8Ptr = File->Current8Ptr + File->BufferSize;
116 File->Current16Ptr = (CHAR16 *)File->Buffer;
117 File->End16Ptr = File->Current16Ptr + (File->BufferSize >> 1);
118
119 // detect encoding
120 File->Encoding = ENCODING_ISO8859_1; // default: 1:1 translation of CHAR8 to CHAR16
121 if (File->BufferSize >= 4) {
122 if (File->Buffer[0] == 0xFF && File->Buffer[1] == 0xFE) {
123 // BOM in UTF-16 little endian (or UTF-32 little endian)
124 File->Encoding = ENCODING_UTF16_LE; // use CHAR16 as is
125 File->Current16Ptr++;
126 } else if (File->Buffer[0] == 0xEF && File->Buffer[1] == 0xBB && File->Buffer[2] == 0xBF) {
127 // BOM in UTF-8
128 File->Encoding = ENCODING_UTF8; // translate from UTF-8 to UTF-16
129 File->Current8Ptr += 3;
130 } else if (File->Buffer[1] == 0 && File->Buffer[3] == 0) {
131 File->Encoding = ENCODING_UTF16_LE; // use CHAR16 as is
132 }
133 // TODO: detect other encodings as they are implemented
134 }
135
136 return EFI_SUCCESS;
137 }
138
139 //
140 // get a single line of text from a file
141 //
142
143 static CHAR16 *ReadLine(REFIT_FILE *File)
144 {
145 CHAR16 *Line, *q;
146 UINTN LineLength;
147
148 if (File->Buffer == NULL)
149 return NULL;
150
151 if (File->Encoding == ENCODING_ISO8859_1 || File->Encoding == ENCODING_UTF8) {
152
153 CHAR8 *p, *LineStart, *LineEnd;
154
155 p = File->Current8Ptr;
156 if (p >= File->End8Ptr)
157 return NULL;
158
159 LineStart = p;
160 for (; p < File->End8Ptr; p++)
161 if (*p == 13 || *p == 10)
162 break;
163 LineEnd = p;
164 for (; p < File->End8Ptr; p++)
165 if (*p != 13 && *p != 10)
166 break;
167 File->Current8Ptr = p;
168
169 LineLength = (UINTN)(LineEnd - LineStart) + 1;
170 Line = AllocatePool(LineLength * sizeof(CHAR16));
171 if (Line == NULL)
172 return NULL;
173
174 q = Line;
175 if (File->Encoding == ENCODING_ISO8859_1) {
176 for (p = LineStart; p < LineEnd; )
177 *q++ = *p++;
178 } else if (File->Encoding == ENCODING_UTF8) {
179 // TODO: actually handle UTF-8
180 for (p = LineStart; p < LineEnd; )
181 *q++ = *p++;
182 }
183 *q = 0;
184
185 } else if (File->Encoding == ENCODING_UTF16_LE) {
186
187 CHAR16 *p, *LineStart, *LineEnd;
188
189 p = File->Current16Ptr;
190 if (p >= File->End16Ptr)
191 return NULL;
192
193 LineStart = p;
194 for (; p < File->End16Ptr; p++)
195 if (*p == 13 || *p == 10)
196 break;
197 LineEnd = p;
198 for (; p < File->End16Ptr; p++)
199 if (*p != 13 && *p != 10)
200 break;
201 File->Current16Ptr = p;
202
203 LineLength = (UINTN)(LineEnd - LineStart) + 1;
204 Line = AllocatePool(LineLength * sizeof(CHAR16));
205 if (Line == NULL)
206 return NULL;
207
208 for (p = LineStart, q = Line; p < LineEnd; )
209 *q++ = *p++;
210 *q = 0;
211
212 } else
213 return NULL; // unsupported encoding
214
215 return Line;
216 }
217
218 //
219 // get a line of tokens from a file
220 //
221
222 UINTN ReadTokenLine(IN REFIT_FILE *File, OUT CHAR16 ***TokenList)
223 {
224 BOOLEAN LineFinished, IsQuoted = FALSE;
225 CHAR16 *Line, *Token, *p;
226 UINTN TokenCount = 0;
227
228 *TokenList = NULL;
229
230 while (TokenCount == 0) {
231 Line = ReadLine(File);
232 if (Line == NULL)
233 return(0);
234
235 p = Line;
236 LineFinished = FALSE;
237 while (!LineFinished) {
238 // skip whitespace
239 while ((*p == ' ' || *p == '\t' || *p == '=' || *p == ',') && !IsQuoted)
240 p++;
241 if (*p == 0 || *p == '#')
242 break;
243
244 if (*p == '"') {
245 IsQuoted = !IsQuoted;
246 p++;
247 } // if
248 Token = p;
249
250 // find end of token
251 while (*p && *p != '"' && ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || IsQuoted)) {
252 if ((*p == '/') && !IsQuoted) // Switch Unix-style to DOS-style directory separators
253 *p = '\\';
254 p++;
255 } // if
256 if (*p == '"')
257 IsQuoted = !IsQuoted;
258 if (*p == 0 || *p == '#')
259 LineFinished = TRUE;
260 *p++ = 0;
261
262 AddListElement((VOID ***)TokenList, &TokenCount, (VOID *)StrDuplicate(Token));
263 }
264
265 FreePool(Line);
266 }
267 return (TokenCount);
268 } /* ReadTokenLine() */
269
270 VOID FreeTokenLine(IN OUT CHAR16 ***TokenList, IN OUT UINTN *TokenCount)
271 {
272 // TODO: also free the items
273 FreeList((VOID ***)TokenList, TokenCount);
274 }
275
276 // handle a parameter with a single integer argument
277 static VOID HandleInt(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT UINTN *Value)
278 {
279 if (TokenCount == 2)
280 *Value = Atoi(TokenList[1]);
281 }
282
283 // handle a parameter with a single string argument
284 static VOID HandleString(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
285 if (TokenCount == 2) {
286 MyFreePool(*Target);
287 *Target = StrDuplicate(TokenList[1]);
288 } // if
289 } // static VOID HandleString()
290
291 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
292 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
293 // consistency in subsequent comparisons of filenames.
294 static VOID HandleStrings(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
295 UINTN i;
296
297 if (*Target != NULL) {
298 FreePool(*Target);
299 *Target = NULL;
300 } // if
301 for (i = 1; i < TokenCount; i++) {
302 CleanUpPathNameSlashes(TokenList[i]);
303 MergeStrings(Target, TokenList[i], L',');
304 }
305 } // static VOID HandleStrings()
306
307 // read config file
308 VOID ReadConfig(VOID)
309 {
310 EFI_STATUS Status;
311 REFIT_FILE File;
312 CHAR16 **TokenList;
313 CHAR16 *FlagName;
314 UINTN TokenCount, i;
315
316 if (!FileExists(SelfDir, CONFIG_FILE_NAME)) {
317 Print(L"Configuration file missing!\n");
318 return;
319 }
320
321 Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File, &i);
322 if (EFI_ERROR(Status))
323 return;
324
325 MyFreePool(GlobalConfig.DontScanDirs);
326 GlobalConfig.DontScanDirs = StrDuplicate(SelfDirPath);
327 MyFreePool(GlobalConfig.DontScanFiles);
328 GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
329
330 for (;;) {
331 TokenCount = ReadTokenLine(&File, &TokenList);
332 if (TokenCount == 0)
333 break;
334
335 if (StriCmp(TokenList[0], L"timeout") == 0) {
336 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
337
338 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
339 for (i = 1; i < TokenCount; i++) {
340 FlagName = TokenList[i];
341 if (StriCmp(FlagName, L"banner") == 0) {
342 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
343 } else if (StriCmp(FlagName, L"label") == 0) {
344 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
345 } else if (StriCmp(FlagName, L"singleuser") == 0) {
346 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
347 } else if (StriCmp(FlagName, L"hwtest") == 0) {
348 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
349 } else if (StriCmp(FlagName, L"arrows") == 0) {
350 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
351 } else if (StriCmp(FlagName, L"all") == 0) {
352 GlobalConfig.HideUIFlags = HIDEUI_ALL;
353 } else {
354 Print(L" unknown hideui flag: '%s'\n", FlagName);
355 }
356 }
357
358 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
359 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
360
361 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
362 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
363 if (i < TokenCount)
364 GlobalConfig.ScanFor[i] = TokenList[i][0];
365 else
366 GlobalConfig.ScanFor[i] = ' ';
367 }
368
369 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
370 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
371
372 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
373 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
374
375 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
376 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
377
378 } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
379 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
380
381 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
382 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
383
384 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
385 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
386 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
387 FlagName = TokenList[i];
388 if (StriCmp(FlagName, L"shell") == 0) {
389 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
390 } else if (StriCmp(FlagName, L"gptsync") == 0) {
391 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
392 } else if (StriCmp(FlagName, L"about") == 0) {
393 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
394 } else if (StriCmp(FlagName, L"exit") == 0) {
395 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
396 } else if (StriCmp(FlagName, L"reboot") == 0) {
397 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
398 } else if (StriCmp(FlagName, L"shutdown") == 0) {
399 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
400 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
401 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
402 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
403 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
404 } else {
405 Print(L" unknown showtools flag: '%s'\n", FlagName);
406 }
407 } // showtools options
408
409 } else if (StriCmp(TokenList[0], L"banner") == 0) {
410 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
411
412 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
413 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
414
415 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
416 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
417
418 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
419 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
420
421 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
422 GlobalConfig.TextOnly = TRUE;
423
424 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && (TokenCount == 3)) {
425 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
426 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
427
428 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
429 GlobalConfig.GraphicsFor = 0;
430 for (i = 1; i < TokenCount; i++) {
431 if (StriCmp(TokenList[i], L"osx") == 0) {
432 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
433 } else if (StriCmp(TokenList[i], L"linux") == 0) {
434 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
435 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
436 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
437 } else if (StriCmp(TokenList[i], L"grub") == 0) {
438 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
439 } else if (StriCmp(TokenList[i], L"windows") == 0) {
440 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
441 }
442 } // for (graphics_on tokens)
443
444 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
445 GlobalConfig.ScanAllLinux = TRUE;
446
447 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
448 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
449
450 }
451
452 FreeTokenLine(&TokenList, &TokenCount);
453 }
454 MyFreePool(File.Buffer);
455 } /* VOID ReadConfig() */
456
457 // Finds a volume with the specified Identifier (a volume label or a number
458 // followed by a colon, for the moment). If found, sets *Volume to point to
459 // that volume. If not, leaves it unchanged.
460 // Returns TRUE if a match was found, FALSE if not.
461 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
462 UINTN i = 0, CountedVolumes = 0;
463 INTN Number = -1;
464 BOOLEAN Found = FALSE;
465
466 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
467 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
468 Number = (INTN) Atoi(Identifier);
469 }
470 while ((i < VolumesCount) && (!Found)) {
471 if (Number >= 0) { // User specified a volume by number
472 if (Volumes[i]->IsReadable) {
473 if (CountedVolumes == Number) {
474 *Volume = Volumes[i];
475 Found = TRUE;
476 }
477 CountedVolumes++;
478 } // if
479 } else { // User specified a volume by label
480 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
481 *Volume = Volumes[i];
482 Found = TRUE;
483 } // if
484 } // if/else
485 i++;
486 } // while()
487 return (Found);
488 } // static VOID FindVolume()
489
490 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
491 REFIT_MENU_SCREEN *SubScreen;
492 LOADER_ENTRY *SubEntry;
493 UINTN TokenCount;
494 CHAR16 **TokenList;
495
496 SubScreen = InitializeSubScreen(Entry);
497
498 // Set defaults for the new entry; will be modified based on lines read from the config. file....
499 SubEntry = InitializeLoaderEntry(Entry);
500
501 if ((SubEntry == NULL) || (SubScreen == NULL))
502 return;
503 SubEntry->me.Title = StrDuplicate(Title);
504
505 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
506
507 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
508 MyFreePool(SubEntry->LoaderPath);
509 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
510 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
511
512 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
513 if (FindVolume(&Volume, TokenList[1])) {
514 MyFreePool(SubEntry->me.Title);
515 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
516 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
517 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
518 SubEntry->VolName = Volume->VolName;
519 } // if match found
520
521 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
522 MyFreePool(SubEntry->InitrdPath);
523 SubEntry->InitrdPath = NULL;
524 if (TokenCount > 1) {
525 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
526 }
527
528 } else if (StriCmp(TokenList[0], L"options") == 0) {
529 MyFreePool(SubEntry->LoadOptions);
530 SubEntry->LoadOptions = NULL;
531 if (TokenCount > 1) {
532 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
533 } // if/else
534
535 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
536 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
537
538 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
539 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
540
541 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
542 SubEntry->Enabled = FALSE;
543 } // ief/elseif
544
545 FreeTokenLine(&TokenList, &TokenCount);
546 } // while()
547
548 if (SubEntry->InitrdPath != NULL) {
549 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
550 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
551 MyFreePool(SubEntry->InitrdPath);
552 SubEntry->InitrdPath = NULL;
553 } // if
554 if (SubEntry->Enabled == TRUE) {
555 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
556 }
557 Entry->me.SubScreen = SubScreen;
558 } // VOID AddSubmenu()
559
560 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
561 // that entry. The calling function is then responsible for adding the entry to the
562 // list of entries.
563 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
564 CHAR16 **TokenList;
565 UINTN TokenCount;
566 LOADER_ENTRY *Entry;
567 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
568 REFIT_VOLUME *CurrentVolume = Volume;
569
570 // prepare the menu entry
571 Entry = InitializeLoaderEntry(NULL);
572 if (Entry == NULL)
573 return NULL;
574
575 Entry->Title = StrDuplicate(Title);
576 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
577 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
578 Entry->me.Row = 0;
579 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
580 Entry->VolName = CurrentVolume->VolName;
581
582 // Parse the config file to add options for a single stanza, terminating when the token
583 // is "}" or when the end of file is reached.
584 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
585 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
586 Entry->LoaderPath = StrDuplicate(TokenList[1]);
587 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
588 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
589 MyFreePool(Entry->LoadOptions);
590 Entry->LoadOptions = NULL; // Discard default options, if any
591 DefaultsSet = TRUE;
592
593 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
594 if (FindVolume(&CurrentVolume, TokenList[1])) {
595 MyFreePool(Entry->me.Title);
596 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
597 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
598 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
599 Entry->VolName = CurrentVolume->VolName;
600 } // if match found
601
602 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
603 MyFreePool(Entry->me.Image);
604 Entry->me.Image = LoadIcns(CurrentVolume->RootDir, TokenList[1], 128);
605 if (Entry->me.Image == NULL) {
606 Entry->me.Image = DummyImage(128);
607 }
608
609 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
610 MyFreePool(Entry->InitrdPath);
611 Entry->InitrdPath = StrDuplicate(TokenList[1]);
612
613 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
614 MyFreePool(Entry->LoadOptions);
615 Entry->LoadOptions = StrDuplicate(TokenList[1]);
616
617 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
618 if (TokenCount > 1) {
619 Entry->OSType = TokenList[1][0];
620 }
621
622 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
623 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
624
625 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
626 Entry->Enabled = FALSE;
627
628 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
629 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
630 AddedSubmenu = TRUE;
631
632 } // set options to pass to the loader program
633 FreeTokenLine(&TokenList, &TokenCount);
634 } // while()
635
636 if (AddedSubmenu)
637 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
638
639 if (Entry->InitrdPath) {
640 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
641 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
642 MyFreePool(Entry->InitrdPath);
643 Entry->InitrdPath = NULL;
644 } // if
645
646 if (!DefaultsSet)
647 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no entry; use bogus one
648
649 return(Entry);
650 } // static VOID AddStanzaEntries()
651
652 // Read the user-configured menu entries from refind.conf and add or delete
653 // entries based on the contents of that file....
654 VOID ScanUserConfigured(VOID)
655 {
656 EFI_STATUS Status;
657 REFIT_FILE File;
658 REFIT_VOLUME *Volume;
659 CHAR16 **TokenList;
660 CHAR16 *Title = NULL;
661 UINTN TokenCount, size;
662 LOADER_ENTRY *Entry;
663 // REFIT_MENU_SCREEN *SubScreen;
664
665 if (FileExists(SelfDir, CONFIG_FILE_NAME)) {
666 Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File, &size);
667 if (EFI_ERROR(Status))
668 return;
669
670 Volume = SelfVolume;
671
672 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
673 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
674 Title = StrDuplicate(TokenList[1]);
675 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
676 if (Entry->Enabled) {
677 if (Entry->me.SubScreen == NULL)
678 GenerateSubScreen(Entry, Volume);
679 AddPreparedLoaderEntry(Entry);
680 } else {
681 MyFreePool(Entry);
682 } // if/else
683 MyFreePool(Title);
684 } // if
685 FreeTokenLine(&TokenList, &TokenCount);
686 } // while()
687 } // if()
688 } // VOID ScanUserConfigured()
689
690 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
691 // and Volume variables identify the location of the options file, but not its name --
692 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
693 // file in the target directory, and this function finds the file with a name in the
694 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
695 // directory and loads it. This function tries multiple files because I originally
696 // used the filename linux.conf, but close on the heels of that decision, the Linux
697 // kernel developers decided to use that name for a similar purpose, but with a
698 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
699 // but I want a migration period in which both names are used.
700 //
701 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
702 // it wasn't found.
703 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
704 CHAR16 *OptionsFilename, *FullFilename;
705 BOOLEAN GoOn = TRUE;
706 UINTN i = 0, size;
707 REFIT_FILE *File = NULL;
708 EFI_STATUS Status;
709
710 do {
711 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
712 FullFilename = FindPath(LoaderPath);
713 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
714 MergeStrings(&FullFilename, OptionsFilename, '\\');
715 if (FileExists(Volume->RootDir, FullFilename)) {
716 File = AllocateZeroPool(sizeof(REFIT_FILE));
717 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
718 GoOn = FALSE;
719 if (CheckError(Status, L"while loading the Linux options file")) {
720 if (File != NULL)
721 FreePool(File);
722 File = NULL;
723 GoOn = TRUE;
724 } // if error
725 } // if file exists
726 } else { // a filename string is NULL
727 GoOn = FALSE;
728 } // if/else
729 MyFreePool(OptionsFilename);
730 MyFreePool(FullFilename);
731 OptionsFilename = FullFilename = NULL;
732 } while (GoOn);
733 return (File);
734 } // static REFIT_FILE * ReadLinuxOptionsFile()
735
736 // Retrieve a single line of options from a Linux kernel options file
737 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
738 UINTN TokenCount;
739 CHAR16 *Options = NULL;
740 CHAR16 **TokenList;
741 REFIT_FILE *File;
742
743 File = ReadLinuxOptionsFile(LoaderPath, Volume);
744 if (File != NULL) {
745 TokenCount = ReadTokenLine(File, &TokenList);
746 if (TokenCount > 1)
747 Options = StrDuplicate(TokenList[1]);
748 FreeTokenLine(&TokenList, &TokenCount);
749 FreePool(File);
750 } // if
751 return Options;
752 } // static CHAR16 * GetOptionsFile()
753