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