Introduce connect/disconnect API script

Author: Zomboided

addon.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <addon id="service.vpn.manager"
        name="VPN Manager for OpenVPN"
-       version="2.0.3"
+       version="2.1.0"
        provider-name="Zomboided">
   <requires>
     <import addon="xbmc.python" version="2.7.0"/>

api.py

@@ -0,0 +1,60 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+#    Copyright (C) 2016 Zomboided
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+#    This module allows some limited interaction with the service via
+#    a set of commands
+
+import xbmcaddon
+import xbmcvfs
+import string
+from libs.common import setAPICommand, clearAPICommand, getAPICommand
+from libs.utility import debugTrace, errorTrace, infoTrace, newPrint
+
+addon = xbmcaddon.Addon("service.vpn.manager")
+addon_name = addon.getAddonInfo("name")
+
+# Get the first argument which will indicate the connection that's being dealt with
+command = sys.argv[1]
+lcommand = command.lower()
+
+debugTrace("Entered api.py with parameter " + command)
+
+if lcommand == "disconnect": 
+    setAPICommand("Disconnect")
+elif lcommand.startswith("connect"): 
+    connection = command[8:].strip(' \t\n\r')
+    if connection.isdigit():
+        c = int(connection)
+        # Adjust the 11 below to change conn_max
+        if c > 0 and c < 11:
+            connection = addon.getSetting(str(c) + "_vpn_validated")
+            if not connection == "":
+                setAPICommand(connection)
+            else:
+                errorTrace("api.py", "Connection requested, " + str(c) + " has not been validated")
+        else:
+            errorTrace("api.py", "Invalid connection, " + str(c) + " requested")
+    else:
+        if xbmcvfs.exists(connection):
+            setAPICommand(connection)
+        else:
+            errorTrace("api.py", "Requested connection, " + connection + " does not exist")
+else:
+    errorTrace("api.py", "Unrecognised command: " + command)
+    
+debugTrace("-- Exit api.py --")

libs/common.py

@@ -556,6 +556,18 @@ def clearVPNCycle():
     setVPNCycle("")
 
 
+def getAPICommand():
+    return xbmcgui.Window(10000).getProperty("VPN_Manager_API_Command")
+
+    
+def setAPICommand(profile):
+    xbmcgui.Window(10000).setProperty("VPN_Manager_API_Command", profile)
+
+    
+def clearAPICommand():
+    setAPICommand("")
+    
+    
 def isVPNMonitorRunning():
     if xbmcgui.Window(10000).getProperty("VPN_Manager_Monitor_State") == "Started":
         return True

libs/common.pyo

@@ -145,5 +145,7 @@
         <setting label=""      type="text" id="last_boot_reason" enable="false" visible="false" default="unscheduled"/>
         <setting label=""      type="bool" id="show_preboot_connect" enable="false" visible="false" default="false"/>
         <setting label=""      type="text" id="platform" enable="false" visible="false" default="0"/>
+        <setting label="Disconnect" type="action" enable="false" visible="false" action="RunScript(special://home/addons/service.vpn.manager/api.py, Disconnect)"/>
+        <setting label="Connect" type="action" enable="false" visible="false" action="RunScript(special://home/addons/service.vpn.manager/api.py, Connect 1)"/>
     </category>
 </settings>

resources/settings.xml

@@ -33,6 +33,7 @@
 from libs.common import getVPNLastConnectedProfile, setVPNLastConnectedProfile, getVPNLastConnectedProfileFriendly, setVPNLastConnectedProfileFriendly
 from libs.common import getVPNCycle, clearVPNCycle, writeCredentials, getCredentialsPath, getFriendlyProfileName, isVPNMonitorRunning, setVPNMonitorState
 from libs.common import getConnectionErrorCount, setConnectionErrorCount, getAddonPath, isVPNConnected, resetVPNConfig, forceCycleLock, freeCycleLock
+from libs.common import getAPICommand, clearAPICommand
 from libs.platform import getPlatform, connection_status, getAddonPath, writeVPNLog, supportSystemd, addSystemd, removeSystemd, copySystemdFiles, isVPNTaskRunning
 from libs.utility import debugTrace, errorTrace, infoTrace, ifDebug, newPrint
 from libs.vpnproviders import removeGeneratedFiles, cleanPassFiles, fixOVPNFiles, getVPNLocation, usesPassAuth, clearKeysAndCerts
@@ -245,7 +246,9 @@ def onSettingsChanged( self ):
     last_file_check_time = 0
 
     last_cycle = ""
-    delay = 5
+    delay_min = 2
+    delay_max = 2
+    delay = delay_max
     connection_errors = 0
     stop = False
 
@@ -268,15 +271,15 @@ def onSettingsChanged( self ):
                 ackStop()                
                 stop = True
                 accepting_changes = False
-                delay = 2
+                delay = delay_min
                 clearVPNCycle()
             elif startRequested():
                 debugTrace("Service received a start request")
 				# When we're told we can start again, acknowledge that and reset the delay back up.
                 ackStart()                
                 stop = False
                 accepting_changes = True
-                delay = 5					
+                delay = delay_max				
         else:	
 			# See if there's been an update	requested from the main add-on
             if updateServiceRequested():
@@ -612,6 +615,18 @@ def onSettingsChanged( self ):
 
                 freeCycleLock()
 
+            # Connect or disconnect in response to an API call
+            api_command = getAPICommand()
+            if vpn_setup and not api_command == "":
+                infoTrace("service.py", "API command found, " + api_command)
+                setVPNRequestedProfile(api_command)
+                if api_command == "Disconnect":
+                    setVPNRequestedProfileFriendly("Disconnect")
+                else:
+                    setVPNRequestedProfileFriendly(getFriendlyProfileName(api_command))
+                clearAPICommand()
+                reconnect_vpn = True
+                
 			# Somewhere above we've requested we mess with the connection...
             if vpn_setup and reconnect_vpn:
                 addon = xbmcaddon.Addon()