removed ngrok.exe required

now using pyngrok library, instead of opening ngrok using subprocess

• updated build.py to remove including ngrok.exe

• removed web_addrr:false fom createDefaultConfig as its needed for pyngrok to work.

• set loggers for flask & ngrok  to error to aviod spamming console

Author: gitagogaming

.gitignore

@@ -1,4 +1,6 @@
 /venv
 *.yaml
 *.pyc
-*.tp
+*.tp
+*.zip
+/dist

ngrok.exe

@@ -12,9 +12,22 @@
 from TPPEntry import TP_PLUGIN_SETTINGS, PLUGIN_ID, TP_PLUGIN_INFO, __version__
 from createDefaultConfig import create_default_yaml_file
 from updateConfig import update_config_file
+import os
+import signal
+
+
+## figure out how to set a static location for pyngrok to download the ngrok.exe file rather than it doing it every time?
+## need to find a way to kill the ngrok process when the plugin is closed rather than the os.kill.. it should be related to the pyinstaller process but 
+## seems as if its not since its downloaded after the fact..
 
 app = Flask(__name__)
 ngrok_running = False
+
+g_log = Logger(name = PLUGIN_ID)
+## setting logging for flask to only log errors
+logging.getLogger('werkzeug').setLevel(logging.ERROR)   
+logging.getLogger("pyngrok.process.ngrok").setLevel(logging.ERROR)   
+
 try:
     TPClient = TP.Client(
         pluginId = PLUGIN_ID,             # required ID of this plugin
@@ -27,12 +40,6 @@
 except Exception as e:
     sys.exit(f"Could not create TP Client, exiting. Error was:\n{repr(e)}")
 
-g_log = Logger(name = PLUGIN_ID)
-
-
-## setting logging for flask to only log errors
-log = logging.getLogger('werkzeug')
-log.setLevel(logging.ERROR)      
 
 
 @app.route('/', methods=['POST'])
@@ -239,14 +246,23 @@ def onSettingUpdate(data):
 def onAction(data: dict):
     g_log.debug(f"Action: {data}")
 
-
+def start_flask():
+    app.run(debug=False)
+    
+from pyngrok import ngrok, conf
+from pyngrok.conf import PyngrokConfig
+http_tunnel = None
 def start_ngrok():
-    global ngrok_running
+    global ngrok_running, http_tunnel
     ## Starting up Ngrok server
     if TP_PLUGIN_SETTINGS['Ngrok Server Address']['value'] != "" and TP_PLUGIN_SETTINGS['Ngrok Port']['value'] != "":
         try:
-            ngrok_command = "ngrok start --config=ngrok.yaml --all"
-            subprocess.Popen(ngrok_command, shell=True)
+            # ngrok_command = "ngrok start --config=ngrok.yaml --all"
+            # subprocess.Popen(ngrok_command, shell=True)
+            ngrok_config = PyngrokConfig()
+            ngrok_config.config_path = "ngrok.yaml" 
+            http_tunnel = ngrok.connect(name='TP_NGROK', pyngrok_config=ngrok_config)
+            
             ngrok_running = True
         except Exception as e:
             g_log.error(f"Error starting ngrok server: {e}")
@@ -273,12 +289,15 @@ def shutdownNgrok():
     global ngrok_running
     try:
         g_log.info("Shutting down ngrok...")
+        ngrok.disconnect(http_tunnel.public_url)
+        
+        ## ngrok is spawning outside of our pyinstaller sometimes and we need to assure its dead for next reload
         subprocess.run(["taskkill", "/F", "/IM", "ngrok.exe"], check=True)
         g_log.info("ngrok terminated.")
         ngrok_running = False
-
-    except subprocess.CalledProcessError as e:
-        g_log.error(f"Failed to terminate ngrok: {e}")
+    except Exception as e:
+        g_log.error(f"Error shutting down ngrok: {e}")
+        return False
 
 
 
@@ -288,6 +307,9 @@ def onShutdown(data:dict):
     g_log.info('Received shutdown event from TP Client.')
     shutdownNgrok()
 
+    ## Requesting a shutdown for the Flask server
+    os.kill(os.getpid(), signal.SIGTERM) 
+    
 
 
 ## main
@@ -362,3 +384,6 @@ def main():
 
 if __name__ == "__main__":
     sys.exit(main())
+    
+    
+    

requirements.txt

@@ -1,9 +1,7 @@
 
 from TouchPortalAPI import tppbuild
 from TPPEntry import PLUGIN_NAME, PLUGIN_FOLDER, PLUGIN_ICON, __version__
-import os
 
-script_dir = os.path.dirname(os.path.realpath(__file__))
 
 
 PLUGIN_MAIN = f"{PLUGIN_NAME}.py"
@@ -34,10 +32,8 @@
 
 
 ADDITIONAL_FILES = [
-    os.path.normpath(os.path.join(script_dir, "start.sh")),
-    os.path.normpath(os.path.join(script_dir, "../ngrok.exe"))
-]
-
+    "start.sh"
+    ]
 
 if PLUGIN_ICON != "":
     ADDITIONAL_FILES.append(PLUGIN_ICON)
@@ -50,8 +46,6 @@
     #  "--noconsole"
 ]
 
-
-
 # validateBuild()
 
 if __name__ == "__main__":

src/Kofi.py

@@ -13,7 +13,7 @@ def create_default_yaml_file(file_path):
             }
         },
         'version': 2,
-        'web_addr': False
+        # 'web_addr': False
     }
     # Check if the file already exists
     if not os.path.exists(file_path):