CloverBootloader/rEFIt_UEFI/entry_scan/tool.cpp
2023-11-06 21:53:57 +01:00

321 lines
12 KiB
C++
Executable File

/*
* refit/scan/tool.c
*
* Copyright (c) 2006-2010 Christoph Pfisterer
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Christoph Pfisterer nor the names of the
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <Platform.h> // Only use angled for Platform, else, xcode project won't compile
#include "entry_scan.h"
#include "../refit/menu.h"
#include "../refit/screen.h"
#include "../libeg/XImage.h"
#include "../refit/lib.h"
#include "../gui/REFIT_MENU_SCREEN.h"
#include "../gui/REFIT_MAINMENU_SCREEN.h"
#include "../Settings/Self.h"
#include "../Platform/Volumes.h"
#include "../libeg/XTheme.h"
#include "../include/OSFlags.h"
//
// Clover File location to boot from on removable media devices
//
#define CLOVER_MEDIA_FILE_NAME_IA32 L"CLOVERIA32.EFI"_XSW
#define CLOVER_MEDIA_FILE_NAME_IA64 L"CLOVERIA64.EFI"_XSW
#define CLOVER_MEDIA_FILE_NAME_X64 L"CLOVERX64.EFI"_XSW
#define CLOVER_MEDIA_FILE_NAME_ARM L"CLOVERARM.EFI"_XSW
#if defined (MDE_CPU_IA32)
#define CLOVER_MEDIA_FILE_NAME CLOVER_MEDIA_FILE_NAME_IA32
#elif defined (MDE_CPU_IPF)
#define CLOVER_MEDIA_FILE_NAME CLOVER_MEDIA_FILE_NAME_IA64
#elif defined (MDE_CPU_X64)
#define CLOVER_MEDIA_FILE_NAME CLOVER_MEDIA_FILE_NAME_X64
#elif defined (MDE_CPU_EBC)
#elif defined (MDE_CPU_ARM)
#define CLOVER_MEDIA_FILE_NAME CLOVER_MEDIA_FILE_NAME_ARM
//#else
//#error Unknown Processor Type
#endif
#ifndef DEBUG_ALL
#define DEBUG_SCAN_TOOL 1
#else
#define DEBUG_SCAN_TOOL DEBUG_ALL
#endif
#if DEBUG_SCAN_TOOL == 0
#define DBG(...)
#else
#define DBG(...) DebugLog(DEBUG_SCAN_TOOL, __VA_ARGS__)
#endif
STATIC XBool AddToolEntry(IN CONST XStringW& LoaderPath, IN CONST CHAR16 *FullTitle, IN CONST CHAR16 *LoaderTitle,
IN REFIT_VOLUME *Volume, const XIcon& Image,
IN char32_t ShortcutLetter, IN CONST XString8Array& Options)
{
REFIT_MENU_ENTRY_LOADER_TOOL *Entry;
// Check the loader exists
if ((LoaderPath.isEmpty()) || (Volume == NULL) || (Volume->RootDir == NULL) ||
!FileExists(Volume->RootDir, LoaderPath)) {
return false;
}
// Allocate the entry
Entry = new REFIT_MENU_ENTRY_LOADER_TOOL;
if (FullTitle) {
Entry->Title.takeValueFrom(FullTitle);
} else {
Entry->Title.SWPrintf("Start %ls", LoaderTitle);
}
// Entry->Tag = TAG_TOOL;
Entry->Row = 1;
Entry->ShortcutLetter = ShortcutLetter;
Entry->Image = Image;
// Entry->ImageHover = ImageHover;
Entry->LoaderPath = LoaderPath;
Entry->DevicePath = FileDevicePath(Volume->DeviceHandle, Entry->LoaderPath);
Entry->DevicePathString = FileDevicePathToXStringW(Entry->DevicePath);
Entry->LoadOptions = Options;
//actions
Entry->AtClick = ActionSelect;
Entry->AtDoubleClick = ActionEnter;
Entry->AtRightClick = ActionHelp;
DBG("found tool %ls\n", LoaderPath.s());
MainMenu.AddMenuEntry(Entry, true);
return true;
}
STATIC void AddCloverEntry(IN CONST XStringW& LoaderPath, IN CONST CHAR16 *LoaderTitle, IN REFIT_VOLUME *Volume)
{
REFIT_MENU_ENTRY_CLOVER *Entry;
REFIT_MENU_ENTRY_CLOVER *SubEntry;
REFIT_MENU_SCREEN *SubScreen;
// EFI_STATUS Status;
// prepare the menu entry
Entry = new REFIT_MENU_ENTRY_CLOVER;
Entry->Title.takeValueFrom(LoaderTitle);
// Entry->Tag = TAG_CLOVER;
Entry->Row = 1;
Entry->ShortcutLetter = 'C';
Entry->Image = ThemeX->GetIcon(BUILTIN_ICON_FUNC_CLOVER);
Entry->Volume = Volume;
Entry->LoaderPath = LoaderPath;
Entry->VolName = Volume->VolName;
Entry->DevicePath = FileDevicePath(Volume->DeviceHandle, Entry->LoaderPath);
Entry->DevicePathString = FileDevicePathToXStringW(Entry->DevicePath);
Entry->Flags = 0;
Entry->LoadOptions.setEmpty();
// Entry->LoaderType = OSTYPE_OTHER;
//actions
Entry->AtClick = ActionEnter;
Entry->AtDoubleClick = ActionDetails;
Entry->AtRightClick = ActionDetails;
// create the submenu
SubScreen = new REFIT_MENU_SCREEN;
SubScreen->Title.takeValueFrom(LoaderTitle);
SubScreen->TitleImage = Entry->Image;
SubScreen->ID = SCREEN_BOOT;
SubScreen->GetAnime();
SubScreen->AddMenuInfoLine_f("%ls", FileDevicePathToXStringW(Volume->DevicePath).wc_str());
if (gEmuVariableControl != NULL) {
gEmuVariableControl->UninstallEmulation(gEmuVariableControl);
}
//always add and always remove menu entries
SubEntry = Entry->getPartiallyDuplicatedEntry();
if (SubEntry) {
SubEntry->Title.SWPrintf("Add Clover boot options for all entries");
SubEntry->LoadOptions.setEmpty();
SubEntry->LoadOptions.Add(L"BO-ADD");
SubEntry->AtDoubleClick = ActionEnter;
SubScreen->AddMenuEntry(SubEntry, true);
}
SubEntry = Entry->getPartiallyDuplicatedEntry();
if (SubEntry) {
SubEntry->Title.SWPrintf("Remove all Clover boot options");
SubEntry->LoadOptions.setEmpty();
SubEntry->LoadOptions.Add(L"BO-REMOVE");
SubScreen->AddMenuEntry(SubEntry, true);
}
SubEntry = Entry->getPartiallyDuplicatedEntry();
if (SubEntry) {
SubEntry->Title.SWPrintf("Print all UEFI boot options to log");
SubEntry->LoadOptions.setEmpty();
SubEntry->LoadOptions.Add(L"BO-PRINT");
SubScreen->AddMenuEntry(SubEntry, true);
}
SubScreen->AddMenuEntry(&MenuEntryReturn, false);
Entry->SubScreen = SubScreen;
MainMenu.AddMenuEntry(Entry, true);
}
void ScanTool(void)
{
EFI_STATUS Status;
UINTN VolumeIndex;
REFIT_VOLUME *Volume;
void *Interface;
if (ThemeX->HideUIFlags & HIDEUI_FLAG_TOOLS)
return;
// DBG("Scanning for tools...\n");
if (!(ThemeX->HideUIFlags & HIDEUI_FLAG_SHELL)) {
if (!AddToolEntry(SWPrintf("%ls\\tools\\Shell64U.efi", self.getCloverDirFullPath().wc_str()), NULL, L"UEFI Shell 64", SelfVolume, ThemeX->GetIcon(BUILTIN_ICON_TOOL_SHELL), 'S', NullXString8Array)) {
AddToolEntry(SWPrintf("%ls\\tools\\Shell64.efi", self.getCloverDirFullPath().wc_str()), NULL, L"EFI Shell 64", SelfVolume, ThemeX->GetIcon(BUILTIN_ICON_TOOL_SHELL), 'S', NullXString8Array);
}
}
// if (!gFirmwareClover) { //Slice: I wish to extend functionality on emulated nvram
for (VolumeIndex = 0; VolumeIndex < Volumes.size(); VolumeIndex++) {
Volume = &Volumes[VolumeIndex];
if (!Volume->RootDir || !Volume->DeviceHandle) {
continue;
}
Status = gBS->HandleProtocol (Volume->DeviceHandle, &gEfiPartTypeSystemPartGuid, &Interface);
if (Status == EFI_SUCCESS) {
DBG("Checking EFI partition Volume %llu for Clover\n", VolumeIndex);
// OSX adds label "EFI" to EFI volumes and some UEFIs see that
// as a file. This file then blocks access to the /EFI directory.
// We will delete /EFI file here and leave only /EFI directory.
if (DeleteFile(Volume->RootDir, L"EFI")) {
DBG(" Deleted /EFI label\n");
}
if (FileExists(&self.getCloverDir(), CLOVER_MEDIA_FILE_NAME)) {
DBG(" Found Clover\n");
// Volume->BootType = BOOTING_BY_EFI;
AddCloverEntry(SWPrintf("%ls\\%ls", self.getCloverDirFullPath().wc_str(), CLOVER_MEDIA_FILE_NAME.wc_str()), L"Clover Boot Options", Volume);
break;
}
}
}
// }
}
// Add custom tool entries
void AddCustomTool(void)
{
UINTN VolumeIndex;
REFIT_VOLUME *Volume;
XIcon Image;
// DBG("Custom tool start\n");
DbgHeader("AddCustomTool");
// Traverse the custom entries
for (size_t i = 0 ; i < GlobalConfig.CustomToolsEntries.size(); ++i) {
CUSTOM_TOOL_ENTRY& Custom = GlobalConfig.CustomToolsEntries[i];
if (OSFLAG_ISSET(Custom.getFlags(), OSFLAG_DISABLED)) {
DBG("Custom tool %zu skipped because it is disabled.\n", i);
continue;
}
// if (!gSettings.ShowHiddenEntries && OSFLAG_ISSET(Custom.Flags, OSFLAG_HIDDEN)) {
// DBG("Custom tool %llu skipped because it is hidden.\n", i);
// continue;
// }
if (Custom.settings.Volume.notEmpty()) {
DBG("Custom tool %zu matching \"%ls\" ...\n", i, Custom.settings.Volume.wc_str());
}
for (VolumeIndex = 0; VolumeIndex < Volumes.size(); ++VolumeIndex) {
Volume = &Volumes[VolumeIndex];
DBG(" Checking volume \"%ls\" (%ls) ... ", Volume->VolName.wc_str(), Volume->DevicePathString.wc_str());
// Skip Whole Disc Boot
if (Volume->RootDir == NULL) {
DBG("skipped because volume is not readable\n");
continue;
}
// skip volume if its kind is configured as disabled
if (((1ull<<Volume->DiskKind) & GlobalConfig.DisableFlags) != 0)
{
DBG("skipped because media is disabled\n");
continue;
}
if (Custom.settings.VolumeType != 0) {
if (((1ull<<Volume->DiskKind) & Custom.settings.VolumeType) == 0) {
DBG("skipped because media is ignored\n");
continue;
}
}
if (Volume->Hidden) {
DBG("skipped because volume is hidden\n");
continue;
}
// Check for exact volume matches
if (Custom.settings.Volume.notEmpty()) {
if ((StrStr(Volume->DevicePathString.wc_str(), Custom.settings.Volume.wc_str()) == NULL) &&
((Volume->VolName.isEmpty()) || (StrStr(Volume->VolName.wc_str(), Custom.settings.Volume.wc_str()) == NULL))) {
DBG("skipped\n");
continue;
}
}
// Check the tool exists on the volume
if (!FileExists(Volume->RootDir, Custom.settings.Path)) {
DBG("skipped because path '%ls' does not exist\n", Custom.settings.Path.wc_str());
continue;
}
// Change to custom image if needed
Image = Custom.Image;
if (Image.isEmpty() && Custom.settings.ImagePath.notEmpty()) {
Image.LoadXImage(&ThemeX->getThemeDir(), Custom.settings.ImagePath);
}
DBG("match!\n");
if (Image.isEmpty()) {
AddToolEntry(Custom.settings.Path, Custom.settings.FullTitle.wc_str(), Custom.settings.Title.wc_str(), Volume, ThemeX->GetIcon(BUILTIN_ICON_TOOL_SHELL), Custom.settings.Hotkey, Custom.getLoadOptions());
} else {
// Create a legacy entry for this volume
AddToolEntry(Custom.settings.Path, Custom.settings.FullTitle.wc_str(), Custom.settings.Title.wc_str(), Volume, Image, Custom.settings.Hotkey, Custom.getLoadOptions());
}
// break; // break scan volumes, continue scan entries -- why?
}
}
// DBG("Custom tool end\n");
}