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