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


99b9f7a8f88c655881c46b33f354d9530791a6d1
[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 CHAR16 *SelfPath = NULL;
345 UINTN TokenCount, i;
346
347 // Set a few defaults only if we're loading the default file.
348 if (StriCmp(FileName, CONFIG_FILE_NAME) == 0) {
349 MyFreePool(GlobalConfig.AlsoScan);
350 GlobalConfig.AlsoScan = StrDuplicate(ALSO_SCAN_DIRS);
351 MyFreePool(GlobalConfig.DontScanDirs);
352 if (SelfVolume->VolName) {
353 SelfPath = StrDuplicate(SelfVolume->VolName);
354 } else {
355 SelfPath = AllocateZeroPool(256 * sizeof(CHAR16));
356 SPrint(SelfPath, 255, L"fs%d", SelfVolume->VolNumber);
357 } // if/else
358 MergeStrings(&SelfPath, SelfDirPath, L':');
359 GlobalConfig.DontScanDirs = SelfPath;
360 MyFreePool(GlobalConfig.DontScanFiles);
361 GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
362 }
363
364 if (!FileExists(SelfDir, FileName)) {
365 Print(L"Configuration file '%s' missing!\n", FileName);
366 return;
367 }
368
369 Status = ReadFile(SelfDir, FileName, &File, &i);
370 if (EFI_ERROR(Status))
371 return;
372
373 for (;;) {
374 TokenCount = ReadTokenLine(&File, &TokenList);
375 if (TokenCount == 0)
376 break;
377
378 if (StriCmp(TokenList[0], L"timeout") == 0) {
379 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
380
381 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
382 for (i = 1; i < TokenCount; i++) {
383 FlagName = TokenList[i];
384 if (StriCmp(FlagName, L"banner") == 0) {
385 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
386 } else if (StriCmp(FlagName, L"label") == 0) {
387 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
388 } else if (StriCmp(FlagName, L"singleuser") == 0) {
389 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
390 } else if (StriCmp(FlagName, L"hwtest") == 0) {
391 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
392 } else if (StriCmp(FlagName, L"arrows") == 0) {
393 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
394 } else if (StriCmp(FlagName, L"hints") == 0) {
395 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HINTS;
396 } else if (StriCmp(FlagName, L"editor") == 0) {
397 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_EDITOR;
398 } else if (StriCmp(FlagName, L"all") == 0) {
399 GlobalConfig.HideUIFlags = HIDEUI_FLAG_ALL;
400 } else {
401 Print(L" unknown hideui flag: '%s'\n", FlagName);
402 }
403 }
404
405 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
406 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
407
408 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
409 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
410 if (i < TokenCount)
411 GlobalConfig.ScanFor[i] = TokenList[i][0];
412 else
413 GlobalConfig.ScanFor[i] = ' ';
414 }
415
416 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
417 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
418
419 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
420 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
421
422 } else if ((StriCmp(TokenList[0], L"don't_scan_volumes") == 0) || (StriCmp(TokenList[0], L"dont_scan_volumes") == 0)) {
423 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
424 // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
425 MyFreePool(GlobalConfig.DontScanVolumes);
426 GlobalConfig.DontScanVolumes = NULL;
427 for (i = 1; i < TokenCount; i++) {
428 MergeStrings(&GlobalConfig.DontScanVolumes, TokenList[i], L',');
429 }
430
431 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
432 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
433
434 } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
435 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
436
437 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
438 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
439
440 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
441 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
442 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
443 FlagName = TokenList[i];
444 if (StriCmp(FlagName, L"shell") == 0) {
445 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
446 } else if (StriCmp(FlagName, L"gptsync") == 0) {
447 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
448 } else if (StriCmp(FlagName, L"about") == 0) {
449 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
450 } else if (StriCmp(FlagName, L"exit") == 0) {
451 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
452 } else if (StriCmp(FlagName, L"reboot") == 0) {
453 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
454 } else if (StriCmp(FlagName, L"shutdown") == 0) {
455 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
456 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
457 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
458 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
459 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
460 } else {
461 Print(L" unknown showtools flag: '%s'\n", FlagName);
462 }
463 } // showtools options
464
465 } else if (StriCmp(TokenList[0], L"banner") == 0) {
466 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
467
468 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
469 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
470
471 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
472 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
473
474 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
475 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
476
477 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
478 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
479 GlobalConfig.TextOnly = FALSE;
480 } else {
481 GlobalConfig.TextOnly = TRUE;
482 }
483
484 } else if (StriCmp(TokenList[0], L"textmode") == 0) {
485 HandleInt(TokenList, TokenCount, &(GlobalConfig.RequestedTextMode));
486
487 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && ((TokenCount == 2) || (TokenCount == 3))) {
488 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
489 if (TokenCount == 3)
490 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
491 else
492 GlobalConfig.RequestedScreenHeight = 0;
493
494 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
495 GlobalConfig.GraphicsFor = 0;
496 for (i = 1; i < TokenCount; i++) {
497 if (StriCmp(TokenList[i], L"osx") == 0) {
498 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
499 } else if (StriCmp(TokenList[i], L"linux") == 0) {
500 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
501 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
502 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
503 } else if (StriCmp(TokenList[i], L"grub") == 0) {
504 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
505 } else if (StriCmp(TokenList[i], L"windows") == 0) {
506 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
507 }
508 } // for (graphics_on tokens)
509
510 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
511 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
512 GlobalConfig.ScanAllLinux = FALSE;
513 } else {
514 GlobalConfig.ScanAllLinux = TRUE;
515 }
516
517 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
518 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
519
520 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
521 if (StriCmp(TokenList[1], FileName) != 0) {
522 ReadConfig(TokenList[1]);
523 }
524
525 }
526
527 FreeTokenLine(&TokenList, &TokenCount);
528 }
529 MyFreePool(File.Buffer);
530 } /* VOID ReadConfig() */
531
532 // Finds a volume with the specified Identifier (a volume label or a number
533 // followed by a colon, for the moment). If found, sets *Volume to point to
534 // that volume. If not, leaves it unchanged.
535 // Returns TRUE if a match was found, FALSE if not.
536 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
537 UINTN i = 0, CountedVolumes = 0;
538 INTN Number = -1;
539 BOOLEAN Found = FALSE;
540
541 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
542 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
543 Number = (INTN) Atoi(Identifier);
544 }
545 while ((i < VolumesCount) && (!Found)) {
546 if (Number >= 0) { // User specified a volume by number
547 if (Volumes[i]->IsReadable) {
548 if (CountedVolumes == Number) {
549 *Volume = Volumes[i];
550 Found = TRUE;
551 }
552 CountedVolumes++;
553 } // if
554 } else { // User specified a volume by label
555 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
556 *Volume = Volumes[i];
557 Found = TRUE;
558 } // if
559 } // if/else
560 i++;
561 } // while()
562 return (Found);
563 } // static VOID FindVolume()
564
565 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
566 REFIT_MENU_SCREEN *SubScreen;
567 LOADER_ENTRY *SubEntry;
568 UINTN TokenCount;
569 CHAR16 **TokenList;
570
571 SubScreen = InitializeSubScreen(Entry);
572
573 // Set defaults for the new entry; will be modified based on lines read from the config. file....
574 SubEntry = InitializeLoaderEntry(Entry);
575
576 if ((SubEntry == NULL) || (SubScreen == NULL))
577 return;
578 SubEntry->me.Title = StrDuplicate(Title);
579
580 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
581
582 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
583 MyFreePool(SubEntry->LoaderPath);
584 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
585 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
586
587 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
588 if (FindVolume(&Volume, TokenList[1])) {
589 MyFreePool(SubEntry->me.Title);
590 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
591 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
592 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
593 SubEntry->VolName = Volume->VolName;
594 } // if match found
595
596 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
597 MyFreePool(SubEntry->InitrdPath);
598 SubEntry->InitrdPath = NULL;
599 if (TokenCount > 1) {
600 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
601 }
602
603 } else if (StriCmp(TokenList[0], L"options") == 0) {
604 MyFreePool(SubEntry->LoadOptions);
605 SubEntry->LoadOptions = NULL;
606 if (TokenCount > 1) {
607 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
608 } // if/else
609
610 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
611 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
612
613 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
614 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
615
616 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
617 SubEntry->Enabled = FALSE;
618 } // ief/elseif
619
620 FreeTokenLine(&TokenList, &TokenCount);
621 } // while()
622
623 if (SubEntry->InitrdPath != NULL) {
624 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
625 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
626 MyFreePool(SubEntry->InitrdPath);
627 SubEntry->InitrdPath = NULL;
628 } // if
629 if (SubEntry->Enabled == TRUE) {
630 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
631 }
632 Entry->me.SubScreen = SubScreen;
633 } // VOID AddSubmenu()
634
635 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
636 // that entry. The calling function is then responsible for adding the entry to the
637 // list of entries.
638 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
639 CHAR16 **TokenList;
640 UINTN TokenCount;
641 LOADER_ENTRY *Entry;
642 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
643 REFIT_VOLUME *CurrentVolume = Volume;
644
645 // prepare the menu entry
646 Entry = InitializeLoaderEntry(NULL);
647 if (Entry == NULL)
648 return NULL;
649
650 Entry->Title = StrDuplicate(Title);
651 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
652 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
653 Entry->me.Row = 0;
654 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
655 Entry->VolName = CurrentVolume->VolName;
656
657 // Parse the config file to add options for a single stanza, terminating when the token
658 // is "}" or when the end of file is reached.
659 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
660 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
661 Entry->LoaderPath = StrDuplicate(TokenList[1]);
662 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
663 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
664 MyFreePool(Entry->LoadOptions);
665 Entry->LoadOptions = NULL; // Discard default options, if any
666 DefaultsSet = TRUE;
667
668 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
669 if (FindVolume(&CurrentVolume, TokenList[1])) {
670 MyFreePool(Entry->me.Title);
671 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
672 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
673 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
674 Entry->VolName = CurrentVolume->VolName;
675 } // if match found
676
677 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
678 MyFreePool(Entry->me.Image);
679 Entry->me.Image = LoadIcns(CurrentVolume->RootDir, TokenList[1], 128);
680 if (Entry->me.Image == NULL) {
681 Entry->me.Image = DummyImage(128);
682 }
683
684 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
685 MyFreePool(Entry->InitrdPath);
686 Entry->InitrdPath = StrDuplicate(TokenList[1]);
687
688 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
689 MyFreePool(Entry->LoadOptions);
690 Entry->LoadOptions = StrDuplicate(TokenList[1]);
691
692 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
693 if (TokenCount > 1) {
694 Entry->OSType = TokenList[1][0];
695 }
696
697 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
698 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
699
700 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
701 Entry->Enabled = FALSE;
702
703 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
704 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
705 AddedSubmenu = TRUE;
706
707 } // set options to pass to the loader program
708 FreeTokenLine(&TokenList, &TokenCount);
709 } // while()
710
711 if (AddedSubmenu)
712 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
713
714 if (Entry->InitrdPath) {
715 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
716 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
717 MyFreePool(Entry->InitrdPath);
718 Entry->InitrdPath = NULL;
719 } // if
720
721 if (!DefaultsSet)
722 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no entry; use bogus one
723
724 return(Entry);
725 } // static VOID AddStanzaEntries()
726
727 // Read the user-configured menu entries from refind.conf and add or delete
728 // entries based on the contents of that file....
729 VOID ScanUserConfigured(VOID)
730 {
731 EFI_STATUS Status;
732 REFIT_FILE File;
733 REFIT_VOLUME *Volume;
734 CHAR16 **TokenList;
735 CHAR16 *Title = NULL;
736 UINTN TokenCount, size;
737 LOADER_ENTRY *Entry;
738
739 if (FileExists(SelfDir, CONFIG_FILE_NAME)) {
740 Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File, &size);
741 if (EFI_ERROR(Status))
742 return;
743
744 Volume = SelfVolume;
745
746 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
747 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
748 Title = StrDuplicate(TokenList[1]);
749 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
750 if (Entry->Enabled) {
751 if (Entry->me.SubScreen == NULL)
752 GenerateSubScreen(Entry, Volume);
753 AddPreparedLoaderEntry(Entry);
754 } else {
755 MyFreePool(Entry);
756 } // if/else
757 MyFreePool(Title);
758 } // if
759 FreeTokenLine(&TokenList, &TokenCount);
760 } // while()
761 } // if()
762 } // VOID ScanUserConfigured()
763
764 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
765 // and Volume variables identify the location of the options file, but not its name --
766 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
767 // file in the target directory, and this function finds the file with a name in the
768 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
769 // directory and loads it. This function tries multiple files because I originally
770 // used the filename linux.conf, but close on the heels of that decision, the Linux
771 // kernel developers decided to use that name for a similar purpose, but with a
772 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
773 // but I want a migration period in which both names are used.
774 //
775 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
776 // it wasn't found.
777 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
778 CHAR16 *OptionsFilename, *FullFilename;
779 BOOLEAN GoOn = TRUE;
780 UINTN i = 0, size;
781 REFIT_FILE *File = NULL;
782 EFI_STATUS Status;
783
784 do {
785 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
786 FullFilename = FindPath(LoaderPath);
787 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
788 MergeStrings(&FullFilename, OptionsFilename, '\\');
789 if (FileExists(Volume->RootDir, FullFilename)) {
790 File = AllocateZeroPool(sizeof(REFIT_FILE));
791 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
792 GoOn = FALSE;
793 if (CheckError(Status, L"while loading the Linux options file")) {
794 if (File != NULL)
795 FreePool(File);
796 File = NULL;
797 GoOn = TRUE;
798 } // if error
799 } // if file exists
800 } else { // a filename string is NULL
801 GoOn = FALSE;
802 } // if/else
803 MyFreePool(OptionsFilename);
804 MyFreePool(FullFilename);
805 OptionsFilename = FullFilename = NULL;
806 } while (GoOn);
807 return (File);
808 } // static REFIT_FILE * ReadLinuxOptionsFile()
809
810 // Retrieve a single line of options from a Linux kernel options file
811 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
812 UINTN TokenCount;
813 CHAR16 *Options = NULL;
814 CHAR16 **TokenList;
815 REFIT_FILE *File;
816
817 File = ReadLinuxOptionsFile(LoaderPath, Volume);
818 if (File != NULL) {
819 TokenCount = ReadTokenLine(File, &TokenList);
820 if (TokenCount > 1)
821 Options = StrDuplicate(TokenList[1]);
822 FreeTokenLine(&TokenList, &TokenCount);
823 FreePool(File);
824 } // if
825 return Options;
826 } // static CHAR16 * GetOptionsFile()
827