# Auto Patching's main purpose is to try and tell the user they're missing root patches # New users may not realize OS updates remove our patches, so we try and run when nessasary # Conditions for running: # - Verify running GUI (TUI users can write their own scripts) # - Verify the Snapshot Seal is intact (if not, assume user is running patches) # - Verify this model needs patching (if not, assume user upgraded hardware and OCLP was not removed) # - Verify there are no updates for OCLP (ensure we have the latest patch sets) # If all these tests pass, start Root Patcher # Copyright (C) 2022, Mykola Grymalyuk from pathlib import Path import plistlib import subprocess import webbrowser import logging from resources import utilities, updates, global_settings, network_handler, constants from resources.sys_patch import sys_patch_detect from resources.gui import gui_main class AutomaticSysPatch: def __init__(self, global_constants: constants.Constants): self.constants: constants.Constants = global_constants def start_auto_patch(self): logging.info("- Starting Automatic Patching") if self.constants.wxpython_variant is False: logging.info("- Auto Patch option is not supported on TUI, please use GUI") return if utilities.check_seal() is True: logging.info("- Detected Snapshot seal intact, detecting patches") patches = sys_patch_detect.detect_root_patch(self.constants.computer.real_model, self.constants).detect_patch_set() if not any(not patch.startswith("Settings") and not patch.startswith("Validation") and patches[patch] is True for patch in patches): patches = [] if patches: logging.info("- Detected applicable patches, determining whether possible to patch") if patches["Validation: Patching Possible"] is False: logging.info("- Cannot run patching") return logging.info("- Determined patching is possible, checking for OCLP updates") patch_string = "" for patch in patches: if patches[patch] is True and not patch.startswith("Settings") and not patch.startswith("Validation"): patch_string += f"- {patch}\n" # Check for updates dict = updates.check_binary_updates(self.constants).check_binary_updates() if not dict: logging.info("- No new binaries found on Github, proceeding with patching") if self.constants.launcher_script is None: args_string = f"'{self.constants.launcher_binary}' --gui_patch" else: args_string = f"{self.constants.launcher_binary} {self.constants.launcher_script} --gui_patch" warning_str = "" if network_handler.NetworkUtilities("https://api.github.com/repos/dortania/OpenCore-Legacy-Patcher/releases/latest").verify_network_connection() is False: warning_str = f"""\n\nWARNING: We're unable to verify whether there are any new releases of OpenCore Legacy Patcher on Github. Be aware that you may be using an outdated version for this OS. If you're unsure, verify on Github that OpenCore Legacy Patcher {self.constants.patcher_version} is the latest official release""" args = [ "osascript", "-e", f"""display dialog "OpenCore Legacy Patcher has detected you're running without Root Patches, and would like to install them.\n\nmacOS wipes all root patches during OS installs and updates, so they need to be reinstalled.\n\nFollowing Patches have been detected for your system: \n{patch_string}\nWould you like to apply these patches?{warning_str}" """ f'with icon POSIX file "{self.constants.app_icon_path}"', ] output = subprocess.run( args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT ) if output.returncode == 0: args = [ "osascript", "-e", f'''do shell script "{args_string}"''' f' with prompt "OpenCore Legacy Patcher would like to patch your root volume"' " with administrator privileges" " without altering line endings" ] subprocess.run( args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT ) return else: for key in dict: version = dict[key]["Version"] github_link = dict[key]["Github Link"] logging.info(f"- Found new version: {version}") # launch osascript to ask user if they want to apply the update # if yes, open the link in the default browser # we never want to run the root patcher if there are updates available args = [ "osascript", "-e", f"""display dialog "OpenCore Legacy Patcher has detected you're running without Root Patches, and would like to install them.\n\nHowever we've detected a new version of OCLP on Github. Would you like to view this?\n\nCurrent Version: {self.constants.patcher_version}\nLatest Version: {version}\n\nNote: After downloading the latest OCLP version, open the app and run the 'Post Install Root Patcher' from the main menu." """ f'with icon POSIX file "{self.constants.app_icon_path}"', ] output = subprocess.run( args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT ) if output.returncode == 0: webbrowser.open(github_link) return else: logging.info("- No patches detected") else: logging.info("- Detected Snapshot seal not intact, skipping") if self.determine_if_versions_match() is False: self.determine_if_boot_matches() def determine_if_versions_match(self): logging.info("- Checking booted vs installed OCLP Build") if self.constants.computer.oclp_version is None: logging.info("- Booted version not found") return False if self.constants.computer.oclp_version == self.constants.patcher_version: logging.info("- Versions match") return False # Check if installed version is newer than booted version if updates.check_binary_updates(self.constants).check_if_build_newer( self.constants.computer.oclp_version.split("."), self.constants.patcher_version.split(".") ) is True: logging.info("- Installed version is newer than booted version") return False args = [ "osascript", "-e", f"""display dialog "OpenCore Legacy Patcher has detected that you are booting an outdated OpenCore build\n- Booted: {self.constants.computer.oclp_version}\n- Installed: {self.constants.patcher_version}\n\nWould you like to update the OpenCore bootloader?" """ f'with icon POSIX file "{self.constants.app_icon_path}"', ] output = subprocess.run( args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT ) if output.returncode == 0: logging.info("- Launching GUI's Build/Install menu") self.constants.start_build_install = True gui_main.wx_python_gui(self.constants).main_menu(None) return True def determine_if_boot_matches(self): # Goal of this function is to determine whether the user # is using a USB drive to Boot OpenCore but macOS does not # reside on the same drive as the USB. # If we determine them to be mismatched, notify the user # and ask if they want to install to install to disk logging.info("- Determining if macOS drive matches boot drive") should_notify = global_settings.global_settings().read_property("AutoPatch_Notify_Mismatched_Disks") if should_notify is False: logging.info("- Skipping due to user preference") return if self.constants.host_is_hackintosh is True: logging.info("- Skipping due to hackintosh") return if not self.constants.booted_oc_disk: logging.info("- Failed to find disk OpenCore launched from") return root_disk = self.constants.booted_oc_disk.strip("disk") root_disk = "disk" + root_disk.split("s")[0] logging.info(f" - Boot Drive: {self.constants.booted_oc_disk} ({root_disk})") macOS_disk = utilities.get_disk_path() logging.info(f" - macOS Drive: {macOS_disk}") physical_stores = utilities.find_apfs_physical_volume(macOS_disk) logging.info(f" - APFS Physical Stores: {physical_stores}") disk_match = False for disk in physical_stores: if root_disk in disk: logging.info(f"- Boot drive matches macOS drive ({disk})") disk_match = True break if disk_match is True: return # Check if OpenCore is on a USB drive logging.info("- Boot Drive does not match macOS drive, checking if OpenCore is on a USB drive") disk_info = plistlib.loads(subprocess.run(["diskutil", "info", "-plist", root_disk], stdout=subprocess.PIPE).stdout) try: if disk_info["Ejectable"] is False: logging.info("- Boot Disk is not removable, skipping prompt") return logging.info("- Boot Disk is ejectable, prompting user to install to internal") args = [ "osascript", "-e", f"""display dialog "OpenCore Legacy Patcher has detected that you are booting OpenCore from an USB or External drive.\n\nIf you would like to boot your Mac normally without a USB drive plugged in, you can install OpenCore to the internal hard drive.\n\nWould you like to launch OpenCore Legacy Patcher and install to disk?" """ f'with icon POSIX file "{self.constants.app_icon_path}"', ] output = subprocess.run( args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT ) if output.returncode == 0: logging.info("- Launching GUI's Build/Install menu") self.constants.start_build_install = True gui_main.wx_python_gui(self.constants).main_menu(None) except KeyError: logging.info("- Unable to determine if boot disk is removable, skipping prompt") def install_auto_patcher_launch_agent(self): # Installs the following: # - OpenCore-Patcher.app in /Library/Application Support/Dortania/ # - com.dortania.opencore-legacy-patcher.auto-patch.plist in /Library/LaunchAgents/ if self.constants.launcher_script is not None: logging.info("- Skipping Auto Patcher Launch Agent, not supported when running from source") return if self.constants.launcher_binary.startswith("/Library/Application Support/Dortania/"): logging.info("- Skipping Auto Patcher Launch Agent, already installed") return # Verify our binary isn't located in '/Library/Application Support/Dortania/' # As we'd simply be duplicating ourselves logging.info("- Installing Auto Patcher Launch Agent") if not Path("Library/Application Support/Dortania").exists(): logging.info("- Creating /Library/Application Support/Dortania/") utilities.process_status(utilities.elevated(["mkdir", "-p", "/Library/Application Support/Dortania"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) logging.info("- Copying OpenCore Patcher to /Library/Application Support/Dortania/") if Path("/Library/Application Support/Dortania/OpenCore-Patcher.app").exists(): logging.info("- Deleting existing OpenCore-Patcher") utilities.process_status(utilities.elevated(["rm", "-R", "/Library/Application Support/Dortania/OpenCore-Patcher.app"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) # Strip everything after OpenCore-Patcher.app path = str(self.constants.launcher_binary).split("/Contents/MacOS/OpenCore-Patcher")[0] logging.info(f"- Copying {path} to /Library/Application Support/Dortania/") utilities.process_status(utilities.elevated(["ditto", path, "/Library/Application Support/Dortania/OpenCore-Patcher.app"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) if not Path("/Library/Application Support/Dortania/OpenCore-Patcher.app").exists(): # Sometimes the binary the user launches may have a suffix (ie. OpenCore-Patcher 3.app) # We'll want to rename it to OpenCore-Patcher.app path = path.split("/")[-1] logging.info(f"- Renaming {path} to OpenCore-Patcher.app") utilities.process_status(utilities.elevated(["mv", f"/Library/Application Support/Dortania/{path}", "/Library/Application Support/Dortania/OpenCore-Patcher.app"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) subprocess.run(["xattr", "-cr", "/Library/Application Support/Dortania/OpenCore-Patcher.app"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) # Copy over our launch agent logging.info("- Copying auto-patch.plist Launch Agent to /Library/LaunchAgents/") if Path("/Library/LaunchAgents/com.dortania.opencore-legacy-patcher.auto-patch.plist").exists(): logging.info("- Deleting existing auto-patch.plist") utilities.process_status(utilities.elevated(["rm", "/Library/LaunchAgents/com.dortania.opencore-legacy-patcher.auto-patch.plist"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) if not Path("/Library/LaunchAgents/").exists(): logging.info("- Creating /Library/LaunchAgents/") utilities.process_status(utilities.elevated(["mkdir", "-p", "/Library/LaunchAgents/"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) utilities.process_status(utilities.elevated(["cp", self.constants.auto_patch_launch_agent_path, "/Library/LaunchAgents/"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) # Set the permissions on the com.dortania.opencore-legacy-patcher.auto-patch.plist logging.info("- Setting permissions on auto-patch.plist") utilities.process_status(utilities.elevated(["chmod", "644", "/Library/LaunchAgents/com.dortania.opencore-legacy-patcher.auto-patch.plist"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) utilities.process_status(utilities.elevated(["chown", "root:wheel", "/Library/LaunchAgents/com.dortania.opencore-legacy-patcher.auto-patch.plist"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)) # Making app alias # Simply an easy way for users to notice the app # If there's already an alias or exiting app, skip if not Path("/Applications/OpenCore-Patcher.app").exists(): logging.info("- Making app alias") utilities.process_status(utilities.elevated(["ln", "-s", "/Library/Application Support/Dortania/OpenCore-Patcher.app", "/Applications/OpenCore-Patcher.app"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT))