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