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


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