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


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