]> code.delx.au - refind/blob - refind/config.c
delx.au / code / refind / blob


d52ca9f800ca39d84ee038b8cb908dfc29daff63
[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, *Temp;
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 if (*p == '|') {
255 Temp = StrDuplicate(&p[1]);
256 StrCpy(p, Temp);
257 }
258 p++;
259 } // if
260 if (*p == '"')
261 IsQuoted = !IsQuoted;
262 if (*p == 0 || *p == '#')
263 LineFinished = TRUE;
264 *p++ = 0;
265
266 AddListElement((VOID ***)TokenList, &TokenCount, (VOID *)StrDuplicate(Token));
267 }
268
269 FreePool(Line);
270 }
271 return (TokenCount);
272 } /* ReadTokenLine() */
273
274 VOID FreeTokenLine(IN OUT CHAR16 ***TokenList, IN OUT UINTN *TokenCount)
275 {
276 // TODO: also free the items
277 FreeList((VOID ***)TokenList, TokenCount);
278 }
279
280 // handle a parameter with a single integer argument
281 static VOID HandleInt(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT UINTN *Value)
282 {
283 if (TokenCount == 2)
284 *Value = Atoi(TokenList[1]);
285 }
286
287 // handle a parameter with a single string argument
288 static VOID HandleString(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
289 if (TokenCount == 2) {
290 MyFreePool(*Target);
291 *Target = StrDuplicate(TokenList[1]);
292 } // if
293 } // static VOID HandleString()
294
295 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
296 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
297 // consistency in subsequent comparisons of filenames.
298 static VOID HandleStrings(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
299 UINTN i;
300
301 if (*Target != NULL) {
302 FreePool(*Target);
303 *Target = NULL;
304 } // if
305 for (i = 1; i < TokenCount; i++) {
306 CleanUpPathNameSlashes(TokenList[i]);
307 MergeStrings(Target, TokenList[i], L',');
308 }
309 } // static VOID HandleStrings()
310
311 // read config file
312 VOID ReadConfig(VOID)
313 {
314 EFI_STATUS Status;
315 REFIT_FILE File;
316 CHAR16 **TokenList;
317 CHAR16 *FlagName;
318 UINTN TokenCount, i;
319
320 if (!FileExists(SelfDir, CONFIG_FILE_NAME)) {
321 Print(L"Configuration file missing!\n");
322 return;
323 }
324
325 Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File, &i);
326 if (EFI_ERROR(Status))
327 return;
328
329 MyFreePool(GlobalConfig.DontScanDirs);
330 GlobalConfig.DontScanDirs = StrDuplicate(SelfDirPath);
331 MyFreePool(GlobalConfig.DontScanFiles);
332 GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
333
334 for (;;) {
335 TokenCount = ReadTokenLine(&File, &TokenList);
336 if (TokenCount == 0)
337 break;
338
339 if (StriCmp(TokenList[0], L"timeout") == 0) {
340 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
341
342 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
343 for (i = 1; i < TokenCount; i++) {
344 FlagName = TokenList[i];
345 if (StriCmp(FlagName, L"banner") == 0) {
346 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
347 } else if (StriCmp(FlagName, L"label") == 0) {
348 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
349 } else if (StriCmp(FlagName, L"singleuser") == 0) {
350 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
351 } else if (StriCmp(FlagName, L"hwtest") == 0) {
352 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
353 } else if (StriCmp(FlagName, L"arrows") == 0) {
354 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
355 } else if (StriCmp(FlagName, L"all") == 0) {
356 GlobalConfig.HideUIFlags = HIDEUI_ALL;
357 } else {
358 Print(L" unknown hideui flag: '%s'\n", FlagName);
359 }
360 }
361
362 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
363 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
364
365 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
366 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
367 if (i < TokenCount)
368 GlobalConfig.ScanFor[i] = TokenList[i][0];
369 else
370 GlobalConfig.ScanFor[i] = ' ';
371 }
372
373 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
374 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
375
376 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
377 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
378
379 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
380 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
381
382 } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
383 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
384
385 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
386 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
387
388 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
389 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
390 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
391 FlagName = TokenList[i];
392 if (StriCmp(FlagName, L"shell") == 0) {
393 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
394 } else if (StriCmp(FlagName, L"gptsync") == 0) {
395 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
396 } else if (StriCmp(FlagName, L"about") == 0) {
397 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
398 } else if (StriCmp(FlagName, L"exit") == 0) {
399 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
400 } else if (StriCmp(FlagName, L"reboot") == 0) {
401 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
402 } else if (StriCmp(FlagName, L"shutdown") == 0) {
403 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
404 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
405 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
406 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
407 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
408 } else {
409 Print(L" unknown showtools flag: '%s'\n", FlagName);
410 }
411 } // showtools options
412
413 } else if (StriCmp(TokenList[0], L"banner") == 0) {
414 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
415
416 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
417 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
418
419 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
420 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
421
422 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
423 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
424
425 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
426 GlobalConfig.TextOnly = TRUE;
427
428 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && (TokenCount == 3)) {
429 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
430 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
431
432 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
433 GlobalConfig.GraphicsFor = 0;
434 for (i = 1; i < TokenCount; i++) {
435 if (StriCmp(TokenList[i], L"osx") == 0) {
436 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
437 } else if (StriCmp(TokenList[i], L"linux") == 0) {
438 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
439 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
440 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
441 } else if (StriCmp(TokenList[i], L"grub") == 0) {
442 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
443 } else if (StriCmp(TokenList[i], L"windows") == 0) {
444 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
445 }
446 } // for (graphics_on tokens)
447
448 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
449 GlobalConfig.ScanAllLinux = TRUE;
450
451 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
452 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
453
454 }
455
456 FreeTokenLine(&TokenList, &TokenCount);
457 }
458 MyFreePool(File.Buffer);
459 } /* VOID ReadConfig() */
460
461 // Finds a volume with the specified Identifier (a volume label or a number
462 // followed by a colon, for the moment). If found, sets *Volume to point to
463 // that volume. If not, leaves it unchanged.
464 // Returns TRUE if a match was found, FALSE if not.
465 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
466 UINTN i = 0, CountedVolumes = 0;
467 INTN Number = -1;
468 BOOLEAN Found = FALSE;
469
470 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
471 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
472 Number = (INTN) Atoi(Identifier);
473 }
474 while ((i < VolumesCount) && (!Found)) {
475 if (Number >= 0) { // User specified a volume by number
476 if (Volumes[i]->IsReadable) {
477 if (CountedVolumes == Number) {
478 *Volume = Volumes[i];
479 Found = TRUE;
480 }
481 CountedVolumes++;
482 } // if
483 } else { // User specified a volume by label
484 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
485 *Volume = Volumes[i];
486 Found = TRUE;
487 } // if
488 } // if/else
489 i++;
490 } // while()
491 return (Found);
492 } // static VOID FindVolume()
493
494 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
495 REFIT_MENU_SCREEN *SubScreen;
496 LOADER_ENTRY *SubEntry;
497 UINTN TokenCount;
498 CHAR16 **TokenList;
499
500 SubScreen = InitializeSubScreen(Entry);
501
502 // Set defaults for the new entry; will be modified based on lines read from the config. file....
503 SubEntry = InitializeLoaderEntry(Entry);
504
505 if ((SubEntry == NULL) || (SubScreen == NULL))
506 return;
507 SubEntry->me.Title = StrDuplicate(Title);
508
509 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
510
511 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
512 MyFreePool(SubEntry->LoaderPath);
513 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
514 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
515
516 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
517 if (FindVolume(&Volume, TokenList[1])) {
518 MyFreePool(SubEntry->me.Title);
519 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
520 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
521 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
522 SubEntry->VolName = Volume->VolName;
523 } // if match found
524
525 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
526 MyFreePool(SubEntry->InitrdPath);
527 SubEntry->InitrdPath = NULL;
528 if (TokenCount > 1) {
529 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
530 }
531
532 } else if (StriCmp(TokenList[0], L"options") == 0) {
533 MyFreePool(SubEntry->LoadOptions);
534 SubEntry->LoadOptions = NULL;
535 if (TokenCount > 1) {
536 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
537 } // if/else
538
539 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
540 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
541
542 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
543 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
544
545 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
546 SubEntry->Enabled = FALSE;
547 } // ief/elseif
548
549 FreeTokenLine(&TokenList, &TokenCount);
550 } // while()
551
552 if (SubEntry->InitrdPath != NULL) {
553 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
554 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
555 MyFreePool(SubEntry->InitrdPath);
556 SubEntry->InitrdPath = NULL;
557 } // if
558 if (SubEntry->Enabled == TRUE) {
559 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
560 }
561 Entry->me.SubScreen = SubScreen;
562 } // VOID AddSubmenu()
563
564 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
565 // that entry. The calling function is then responsible for adding the entry to the
566 // list of entries.
567 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
568 CHAR16 **TokenList;
569 UINTN TokenCount;
570 LOADER_ENTRY *Entry;
571 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
572 REFIT_VOLUME *CurrentVolume = Volume;
573
574 // prepare the menu entry
575 Entry = InitializeLoaderEntry(NULL);
576 if (Entry == NULL)
577 return NULL;
578
579 Entry->Title = StrDuplicate(Title);
580 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
581 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
582 Entry->me.Row = 0;
583 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
584 Entry->VolName = CurrentVolume->VolName;
585
586 // Parse the config file to add options for a single stanza, terminating when the token
587 // is "}" or when the end of file is reached.
588 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
589 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
590 Entry->LoaderPath = StrDuplicate(TokenList[1]);
591 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
592 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
593 MyFreePool(Entry->LoadOptions);
594 Entry->LoadOptions = NULL; // Discard default options, if any
595 DefaultsSet = TRUE;
596
597 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
598 if (FindVolume(&CurrentVolume, TokenList[1])) {
599 MyFreePool(Entry->me.Title);
600 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
601 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
602 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
603 Entry->VolName = CurrentVolume->VolName;
604 } // if match found
605
606 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
607 MyFreePool(Entry->me.Image);
608 Entry->me.Image = LoadIcns(CurrentVolume->RootDir, TokenList[1], 128);
609 if (Entry->me.Image == NULL) {
610 Entry->me.Image = DummyImage(128);
611 }
612
613 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
614 MyFreePool(Entry->InitrdPath);
615 Entry->InitrdPath = StrDuplicate(TokenList[1]);
616
617 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
618 MyFreePool(Entry->LoadOptions);
619 Entry->LoadOptions = StrDuplicate(TokenList[1]);
620
621 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
622 if (TokenCount > 1) {
623 Entry->OSType = TokenList[1][0];
624 }
625
626 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
627 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
628
629 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
630 Entry->Enabled = FALSE;
631
632 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
633 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
634 AddedSubmenu = TRUE;
635
636 } // set options to pass to the loader program
637 FreeTokenLine(&TokenList, &TokenCount);
638 } // while()
639
640 if (AddedSubmenu)
641 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
642
643 if (Entry->InitrdPath) {
644 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
645 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
646 MyFreePool(Entry->InitrdPath);
647 Entry->InitrdPath = NULL;
648 } // if
649
650 if (!DefaultsSet)
651 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no entry; use bogus one
652
653 return(Entry);
654 } // static VOID AddStanzaEntries()
655
656 // Read the user-configured menu entries from refind.conf and add or delete
657 // entries based on the contents of that file....
658 VOID ScanUserConfigured(VOID)
659 {
660 EFI_STATUS Status;
661 REFIT_FILE File;
662 REFIT_VOLUME *Volume;
663 CHAR16 **TokenList;
664 CHAR16 *Title = NULL;
665 UINTN TokenCount, size;
666 LOADER_ENTRY *Entry;
667 // REFIT_MENU_SCREEN *SubScreen;
668
669 if (FileExists(SelfDir, CONFIG_FILE_NAME)) {
670 Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File, &size);
671 if (EFI_ERROR(Status))
672 return;
673
674 Volume = SelfVolume;
675
676 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
677 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
678 Title = StrDuplicate(TokenList[1]);
679 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
680 if (Entry->Enabled) {
681 if (Entry->me.SubScreen == NULL)
682 GenerateSubScreen(Entry, Volume);
683 AddPreparedLoaderEntry(Entry);
684 } else {
685 MyFreePool(Entry);
686 } // if/else
687 MyFreePool(Title);
688 } // if
689 FreeTokenLine(&TokenList, &TokenCount);
690 } // while()
691 } // if()
692 } // VOID ScanUserConfigured()
693
694 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
695 // and Volume variables identify the location of the options file, but not its name --
696 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
697 // file in the target directory, and this function finds the file with a name in the
698 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
699 // directory and loads it. This function tries multiple files because I originally
700 // used the filename linux.conf, but close on the heels of that decision, the Linux
701 // kernel developers decided to use that name for a similar purpose, but with a
702 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
703 // but I want a migration period in which both names are used.
704 //
705 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
706 // it wasn't found.
707 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
708 CHAR16 *OptionsFilename, *FullFilename;
709 BOOLEAN GoOn = TRUE;
710 UINTN i = 0, size;
711 REFIT_FILE *File = NULL;
712 EFI_STATUS Status;
713
714 do {
715 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
716 FullFilename = FindPath(LoaderPath);
717 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
718 MergeStrings(&FullFilename, OptionsFilename, '\\');
719 if (FileExists(Volume->RootDir, FullFilename)) {
720 File = AllocateZeroPool(sizeof(REFIT_FILE));
721 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
722 GoOn = FALSE;
723 if (CheckError(Status, L"while loading the Linux options file")) {
724 if (File != NULL)
725 FreePool(File);
726 File = NULL;
727 GoOn = TRUE;
728 } // if error
729 } // if file exists
730 } else { // a filename string is NULL
731 GoOn = FALSE;
732 } // if/else
733 MyFreePool(OptionsFilename);
734 MyFreePool(FullFilename);
735 OptionsFilename = FullFilename = NULL;
736 } while (GoOn);
737 return (File);
738 } // static REFIT_FILE * ReadLinuxOptionsFile()
739
740 // Retrieve a single line of options from a Linux kernel options file
741 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
742 UINTN TokenCount;
743 CHAR16 *Options = NULL;
744 CHAR16 **TokenList;
745 REFIT_FILE *File;
746
747 File = ReadLinuxOptionsFile(LoaderPath, Volume);
748 if (File != NULL) {
749 TokenCount = ReadTokenLine(File, &TokenList);
750 if (TokenCount > 1)
751 Options = StrDuplicate(TokenList[1]);
752 FreeTokenLine(&TokenList, &TokenCount);
753 FreePool(File);
754 } // if
755 return Options;
756 } // static CHAR16 * GetOptionsFile()
757