plugin updateCheck added

added an update check upon plugin boot.  If an update is found the user is prompted to download & install automatically or open website and download and install manually

Author: gitagogaming

src/Kofi.py

@@ -15,9 +15,10 @@
 import TouchPortalAPI as TP
 from TouchPortalAPI.logger import Logger
 
-from TPPEntry import TP_PLUGIN_SETTINGS, PLUGIN_ID, TP_PLUGIN_INFO, __version__
+from TPPEntry import TP_PLUGIN_SETTINGS, PLUGIN_ID, TP_PLUGIN_INFO, PLUGIN_NAME, PLUGIN_RELEASE_INFO, __version__
 from createDefaultConfig import create_default_yaml_file
 from updateConfig import update_config_file
+from update_check import plugin_update_check, download_update
 
 
 ## • figure out how to set a static location for pyngrok to download the ngrok.exe file rather than it doing it every time?
@@ -250,11 +251,31 @@ def handleSettings(settings, on_connect=False):
         TP_PLUGIN_SETTINGS['Kofi Verification Token']['value'] = value
 
 
+
+
+
 @TPClient.on(TP.TYPES.onNotificationOptionClicked)
 def onNoticationClicked(data):
     if data['optionId'] == f"{PLUGIN_ID}.settings.error.options":
         url = "https://dashboard.ngrok.com/signup"
         webbrowser.open(url, new=0, autoraise=True)
+        
+    elif data['optionId'] == f"{PLUGIN_ID}.update.download":
+        if PLUGIN_RELEASE_INFO['downloadURL']:
+            download_URL = PLUGIN_RELEASE_INFO['downloadURL']
+            g_log.info("Downloading the update...")
+            tpp_file = download_update(download_URL)
+            if tpp_file:
+                os.startfile(tpp_file)
+        else:
+            g_log.error("Error downloading the update, download URL not found.", download_URL)
+            
+    elif data['optionId'] == f"{PLUGIN_ID}.update.manual":
+        if PLUGIN_RELEASE_INFO['htmlURL']:
+            webbrowser.open(PLUGIN_RELEASE_INFO['htmlURL'], new=0, autoraise=True)
+        else:
+            g_log.error("Error opening the download page, URL not found.", PLUGIN_RELEASE_INFO['htmlURL'])
+
 
 
 #--- On Startup ---#
@@ -264,6 +285,31 @@ def onConnect(data):
     g_log.debug(f"Connection: {data}")
     if settings := data.get('settings'):
         handleSettings(settings, True)
+        
+    try:
+        global PLUGIN_RELEASE_INFO
+        PLUGIN_RELEASE_INFO = plugin_update_check(str(data['pluginVersion']))
+        
+        if PLUGIN_RELEASE_INFO['patchnotes']:
+            patchNotes = f"A new version of {PLUGIN_NAME} is available and ready to Download.\nThis may include Bug Fixes and or New Features\n\nPatch Notes\n{PLUGIN_RELEASE_INFO['patchnotes']}"
+        elif PLUGIN_RELEASE_INFO['patchnotes'] == "":
+            patchNotes = f"A new version of {PLUGIN_NAME} is available and ready to Download.\nThis may include Bug Fixes and or New Features"
+        if PLUGIN_RELEASE_INFO['version']:
+            TPClient.showNotification(
+                notificationId= f"{PLUGIN_ID}.TP.Plugins.Update_Check",
+                title=f"{PLUGIN_NAME} {PLUGIN_RELEASE_INFO['version']} is available",
+                msg=patchNotes,
+                options= [
+                {
+                "id":f"{PLUGIN_ID}.update.download",
+                "title":"(Auto) Download & Update!"
+                },
+                {
+                "id":f"{PLUGIN_ID}.update.manual",
+                "title":"(Manual) Open Plugin Download Page"
+                }])
+    except Exception as e:
+        print("Error Checking for Updates", e)
 
     create_default_yaml_file('ngrok.yaml')
     time.sleep(1)

src/TPPEntry.py

@@ -1,10 +1,12 @@
-PLUGIN_ID = "gitago.kofi"
+PLUGIN_ID = "gitago.kofi"  
 PLUGIN_NAME = "Kofi"
 PLUGIN_ICON = "Kofi_Logo_26px.png"
 PLUGIN_FOLDER = "Kofi"
 __version__ = 101
 
-
+GITHUB_USER_NAME = "GitagoGaming"
+GITHUB_PLUGIN_NAME = "Kofi-TouchPortal-Plugin"
+PLUGIN_RELEASE_INFO = {} # This will be updated by the update_check.py script
 
 TP_PLUGIN_INFO = {
     "sdk": 6,

src/update_check.py

@@ -0,0 +1,73 @@
+#update check
+import os
+import base64
+import requests
+from tempfile import gettempdir
+
+from TPPEntry import GITHUB_USER_NAME, GITHUB_PLUGIN_NAME    
+
+
+def get_release_info(owner, repo):
+    url = f'https://api.github.com/repos/{owner}/{repo}/releases'
+    if (response := requests.get(url)) and response.ok:
+        if (releases := response.json()):
+            for release in releases:
+                if not release.get('prerelease'):
+                    assets = release.get('assets', [])
+                    if assets:
+                        download_url = assets[0].get('browser_download_url', "")
+                        release_version = release.get('tag_name', "")
+                        html_url = release.get('html_url', "")
+                        return release_version, download_url, html_url
+            raise ValueError(f'No suitable non-prerelease found in repository: {url}')
+        else:
+            raise ValueError(f'Failed to decode JSON response from: {url}')
+    else:
+        raise ValueError(f'Invalid repository URL or response: {url}')
+
+
+def plugin_update_check(plugin_version:str):
+    """ Checks Github for the latest version of the plugin
+    - Returns patchnotes on notification if there is a new version 
+    """
+    
+    try:
+        github_version, downloadURL, htmlURL = get_release_info(GITHUB_USER_NAME, GITHUB_PLUGIN_NAME)
+        github_version =  github_version.replace('v','').replace(".","")
+      
+        if github_version.replace('v','').replace(".","") > plugin_version:
+            ### Pulling Patch Notes for Notification
+
+            try:
+                r = requests.get(f"https://api.github.com/repos/{GITHUB_USER_NAME}/{GITHUB_PLUGIN_NAME}/contents/recent_patchnotes.txt") 
+                if r.status_code == 404:
+                    print("No Patch Notes Found")
+                    message = ""
+                else:
+                    base64_bytes = r.json()['content'].encode('ascii')
+                    message_bytes = base64.b64decode(base64_bytes)
+                    message = message_bytes.decode('ascii')
+            except Exception as e:
+                message = None
+                print("Error Plugin Update Check: ", e)
+            return {"version":github_version, "patchnotes":message, "downloadURL": downloadURL, "htmlURL": htmlURL}
+        else:
+            return False, False
+        
+    except Exception as e:
+        print("Something went wrong checking update", e)
+        
+        
+
+def download_update(download_url):
+    # Extract the file name from the URL
+    file_name = download_url.split('/')[-1]
+    # Construct the full path in the temp directory
+    temp_file_path = os.path.join(gettempdir(), file_name)
+    
+    response = requests.get(download_url)
+    if response.status_code == 200:
+        with open(temp_file_path, 'wb') as file:
+            file.write(response.content)
+            return temp_file_path
+    return None