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