def setErrorValue(index, value):
index -= 1
errors = xbmcaddon.Addon(getID()).getSetting("ip_service_errors")
if errors == "": errors = LIST_DEFAULT
list = errors.split(",")
i = 0
output = ""
while i < (len(list)):
if i > 0: output = output + ","
if i == index: output = output + str(value)
else: output = output + str(list[i])
i += 1
xbmcaddon.Addon(getID()).setSetting("ip_service_errors", output)
def setErrorValue(index, value):
index -= 1
errors = xbmcaddon.Addon(getID()).getSetting("ip_service_errors")
if errors == "": errors = LIST_DEFAULT
list = errors.split(",")
i = 0
output = ""
while i < (len(list)):
if i > 0: output = output + ","
if i == index: output = output + str(value)
else: output = output + str(list[i])
i += 1
xbmcaddon.Addon(getID()).setSetting("ip_service_errors", output)
def getOpenVPNPath():
# Return the path to openvpn
p = getPlatform()
if p == platforms.RPI:
return getAddonPath(False, "network.openvpn/bin/openvpn")
if p == platforms.LINUX:
if xbmcaddon.Addon(getID()).getSetting("openvpn_no_path") == "true": return "openvpn"
return xbmcaddon.Addon(getID()).getSetting("openvpn_path") + "openvpn"
if p == platforms.WINDOWS:
# No path specified as install will update command path
return "openvpn"
# **** ADD MORE PLATFORMS HERE ****
return
def copySystemdFiles():
# Delete any existing openvpn.service and copy openvpn service file to config directory
service_source = getAddonPath(True, "openvpn.service")
service_dest = getSystemdPath("system.d/openvpn.service")
debugTrace("Copying openvpn.service " + service_source + " to " +
service_dest)
if not fakeSystemd():
if xbmcvfs.exists(service_dest): xbmcvfs.delete(service_dest)
xbmcvfs.copy(service_source, service_dest)
if not xbmcvfs.exists(service_dest):
raise IOError('Failed to copy service ' + service_source + " to " +
service_dest)
# Delete any existing openvpn.config and copy first VPN to openvpn.config
config_source = sudo_setting = xbmcaddon.Addon(
getID()).getSetting("1_vpn_validated")
if service_source == "":
errorTrace("platform.py", "Nothing has been validated")
config_dest = getSystemdPath("openvpn.config")
debugTrace("Copying openvpn.config " + config_source + " to " +
config_dest)
if not fakeSystemd():
if xbmcvfs.exists(config_dest): xbmcvfs.delete(config_dest)
xbmcvfs.copy(config_source, config_dest)
if not xbmcvfs.exists(config_dest):
raise IOError('Failed to copy service ovpn ' + config_source +
" to " + config_dest)
def popupSysBox():
if not getID() == "":
addon = xbmcaddon.Addon(getID())
dialog_text_l = ""
dialog_text_r = ""
data_left = getSystemData(addon, True, True, False, False)
data_right = getSystemData(addon, False, False, False, True)
for line in data_left:
if line.startswith("[B]") and not dialog_text_l == "": dialog_text_l = dialog_text_l + "\n"
dialog_text_l = dialog_text_l + line + "\n"
for line in data_right:
if line.startswith("[B]") and not dialog_text_r == "": dialog_text_r = dialog_text_r + "\n"
dialog_text_r = dialog_text_r + line + "\n"
showInfoBox("System Information", dialog_text_l, dialog_text_r)
else:
errorTrace("sysbox.py", "VPN service is not ready")
def getAddonPath(this_addon, path):
# Return the URL of the addon directory, plus any addition path/file name.
if this_addon:
return xbmc.translatePath("special://home/addons/" + getID() + "/" +
path)
else:
return xbmc.translatePath("special://home/addons/" + path)
def useSudo():
sudo_setting = xbmcaddon.Addon(getID()).getSetting("openvpn_sudo")
if sudo_setting == "Always": return True
if sudo_setting == "Never": return False
if getPlatform() == platforms.LINUX:
# For non-LE/OE Linux (based on the path name...) we don't need to use sudo
if not getAddonPath(True, "").startswith("/storage/.kodi/"): return True
return False
def getWorkingValue(index):
index -= 1
values = xbmcaddon.Addon(getID()).getSetting("ip_service_values")
if not values == "":
list = values.split(",")
if not index > len(list):
return int(list[index])
return 0
def getErrorValue(index):
index -= 1
errors = xbmcaddon.Addon(getID()).getSetting("ip_service_errors")
if not errors == "":
list = errors.split(",")
if not index > len(list):
return int(list[index])
return 0
def getWorkingValue(index):
index -= 1
values = xbmcaddon.Addon(getID()).getSetting("ip_service_values")
if not values == "":
list = values.split(",")
if not index > len(list):
return int(list[index])
return 0
def useSudo():
sudo_setting = xbmcaddon.Addon(getID()).getSetting("openvpn_sudo")
if sudo_setting == "Always": return True
if sudo_setting == "Never": return False
if getPlatform() == platforms.LINUX:
# For non-LE/OE Linux (based on the path name...) we don't need to use sudo
if not getAddonPath(True, "").startswith("/storage/.kodi/"): return True
return False
def getErrorValue(index):
index -= 1
errors = xbmcaddon.Addon(getID()).getSetting("ip_service_errors")
if not errors == "":
list = errors.split(",")
if not index > len(list):
return int(list[index])
return 0
def popupSysBox():
if not getID() == "":
addon = xbmcaddon.Addon(getID())
dialog_text_l = ""
dialog_text_r = ""
data_left = getSystemData(addon, True, True, False, False)
data_right = getSystemData(addon, False, False, False, True)
for line in data_left:
if line.startswith("[B]") and not dialog_text_l == "":
dialog_text_l = dialog_text_l + "\n"
dialog_text_l = dialog_text_l + line + "\n"
for line in data_right:
if line.startswith("[B]") and not dialog_text_r == "":
dialog_text_r = dialog_text_r + "\n"
dialog_text_r = dialog_text_r + line + "\n"
showInfoBox("System Information", dialog_text_l, dialog_text_r)
else:
errorTrace("sysbox.py", "VPN service is not ready")
def showInfoBox(caption, text_l, text_r):
path = xbmcaddon.Addon(getID()).getAddonInfo("path")
win = InfoBox("infotextbox.xml",
path,
caption=caption,
text_left=text_l,
text_right=text_r)
win.doModal()
del win
def getOpenVPNPath():
# Return the path to openvpn
p = getPlatform()
if p == platforms.RPI:
return getAddonPath(False, "network.openvpn/bin/openvpn")
if p == platforms.LINUX or p == platforms.WINDOWS:
addon = xbmcaddon.Addon(getID())
if addon.getSetting("openvpn_no_path") == "true" or addon.getSetting("openvpn_path") == "": return "openvpn"
return '"' + addon.getSetting("openvpn_path") + "openvpn" + '"'
# **** ADD MORE PLATFORMS HERE ****
return
def getOpenVPNPath():
# Return the path to openvpn
p = getPlatform()
if p == platforms.RPI:
return getAddonPath(False, "network.openvpn/bin/openvpn")
if p == platforms.LINUX or p == platforms.WINDOWS:
addon = xbmcaddon.Addon(getID())
if addon.getSetting("openvpn_no_path") == "true" or addon.getSetting(
"openvpn_path") == "":
return "openvpn"
return '"' + addon.getSetting("openvpn_path") + "openvpn" + '"'
# **** ADD MORE PLATFORMS HERE ****
return
def getTestFilePath():
# Return the full filename for the VPN log file
# It's platform dependent, but can be forced to the Kodi log location
use_kodi_dir = xbmcaddon.Addon(getID()).getSetting("openvpn_log_location")
p = getPlatform()
if p == platforms.WINDOWS or use_kodi_dir == "true":
# Putting this with the other logs on Windows
return xbmc.translatePath("special://logpath/command_test.txt")
if p == platforms.LINUX or p == platforms.RPI:
# This should be a RAM drive so doesn't wear the media
return "/run/command_text.txt"
# **** ADD MORE PLATFORMS HERE ****
return ""
def getTestFilePath():
# Return the full filename for the VPN log file
# It's platform dependent, but can be forced to the Kodi log location
use_kodi_dir = xbmcaddon.Addon(getID()).getSetting("openvpn_log_location")
p = getPlatform()
if p == platforms.WINDOWS or use_kodi_dir == "true" :
# Putting this with the other logs on Windows
return xbmc.translatePath("special://logpath/command_test.txt")
if p == platforms.LINUX or p == platforms.RPI:
# This should be a RAM drive so doesn't wear the media
return "/run/command_text.txt"
# **** ADD MORE PLATFORMS HERE ****
return ""
def isVPNTaskRunning():
# Return True if the VPN task is still running, or the VPN connection is still active
# Return False if the VPN task is no longer running and the connection is not active
if fakeConnection(): return True
p = getPlatform()
if p == platforms.LINUX or p == platforms.RPI:
try:
command = getPidofPath() + " openvpn"
if useSudo(): command = "sudo " + command
debugTrace("(Linux) Checking VPN task with " + command)
pid = os.system(command)
# This horrible call returns 0 if it finds a process, it's not returning the PID number
if xbmcaddon.Addon(getID()).getSetting("alt_pid_check") == "true":
if pid > 0: return True
else:
if pid == 0: return True
debugTrace("(Linux) Didn't find a running process")
return False
except Exception as e:
errorTrace("platform.py", "VPN task list failed")
errorTrace("platform.py", str(e))
return False
if p == platforms.WINDOWS:
try:
command = 'tasklist /FI "IMAGENAME eq OPENVPN.EXE"'
debugTrace("(Windows) Checking VPN task with " + command)
args = shlex.split(command)
out = subprocess.check_output(args,
creationflags=subprocess.SW_HIDE,
shell=True).strip()
if "openvpn.exe" in out:
return True
else:
debugTrace("(Windows) Didn't find a running process")
return False
except Exception as e:
errorTrace("platform.py", "VPN task list failed")
errorTrace("platform.py", str(e))
return False
# **** ADD MORE PLATFORMS HERE ****
return False
def getOpenVPNPath():
# Call the platform VPN to start the VPN
#if fakeConnection():
# p = platforms.LINUX
#else:
p = getPlatform()
if p == platforms.RPI:
return getAddonPath(False, "network.openvpn/bin/openvpn")
if p == platforms.LINUX:
if xbmcaddon.Addon(getID()).getSetting("openvpn_no_path") == "true":
return "openvpn"
return "/usr/sbin/openvpn"
if p == platforms.WINDOWS:
# No path specified as install will update command path
return "openvpn"
# **** ADD MORE PLATFORMS HERE ****
return
def copySystemdFiles():
# Delete any existing openvpn.service and copy openvpn service file to config directory
service_source = getAddonPath(True, "openvpn.service")
service_dest = getSystemdPath("system.d/openvpn.service")
debugTrace("Copying openvpn.service " + service_source + " to " + service_dest)
if not fakeSystemd():
if xbmcvfs.exists(service_dest): xbmcvfs.delete(service_dest)
xbmcvfs.copy(service_source, service_dest)
if not xbmcvfs.exists(service_dest): raise IOError('Failed to copy service ' + service_source + " to " + service_dest)
# Delete any existing openvpn.config and copy first VPN to openvpn.config
config_source = sudo_setting = xbmcaddon.Addon(getID()).getSetting("1_vpn_validated")
if service_source == "": errorTrace("platform.py", "Nothing has been validated")
config_dest = getSystemdPath("openvpn.config")
debugTrace("Copying openvpn.config " + config_source + " to " + config_dest)
if not fakeSystemd():
if xbmcvfs.exists(config_dest): xbmcvfs.delete(config_dest)
xbmcvfs.copy(config_source, config_dest)
if not xbmcvfs.exists(config_dest): raise IOError('Failed to copy service ovpn ' + config_source + " to " + config_dest)
def isVPNTaskRunning():
# Return True if the VPN task is still running, or the VPN connection is still active
# Return False if the VPN task is no longer running and the connection is not active
if fakeConnection(): return True
p = getPlatform()
if p == platforms.LINUX or p == platforms.RPI:
try:
command = getPidofPath() + " openvpn"
if useSudo() : command = "sudo " + command
debugTrace("(Linux) Checking VPN task with " + command)
pid = os.system(command)
# This horrible call returns 0 if it finds a process, it's not returning the PID number
if xbmcaddon.Addon(getID()).getSetting("alt_pid_check") == "true":
if pid > 0 : return True
else:
if pid == 0 : return True
debugTrace("(Linux) Didn't find a running process")
return False
except Exception as e:
errorTrace("platform.py", "VPN task list failed")
errorTrace("platform.py", str(e))
return False
if p == platforms.WINDOWS:
try:
command = 'tasklist /FI "IMAGENAME eq OPENVPN.EXE"'
debugTrace("(Windows) Checking VPN task with " + command)
args = shlex.split(command)
out = subprocess.check_output(args, creationflags=subprocess.SW_HIDE, shell=True).strip()
if "openvpn.exe" in out:
return True
else:
debugTrace("(Windows) Didn't find a running process")
return False
except Exception as e:
errorTrace("platform.py", "VPN task list failed")
errorTrace("platform.py", str(e))
return False
# **** ADD MORE PLATFORMS HERE ****
return False
def getAutoSource():
# If the VPN has changed, then reset all the numbers
addon = xbmcaddon.Addon(getID())
last_vpn = addon.getSetting("ip_service_last_vpn")
current_vpn = addon.getSetting("vpn_provider_validated")
if (not last_vpn == current_vpn):
addon.setSetting("ip_service_last_vpn", current_vpn)
resetIPServices()
# Get the last source we tried to use from the home window or use the first if this is first time through
source = xbmcgui.Window(10000).getProperty("VPN_Manager_Last_IP_Service")
if source == "":
# Record that we're using the first one
xbmcgui.Window(10000).setProperty("VPN_Manager_Last_IP_Service", ip_sources[1])
return ip_sources[1]
else:
index = ip_sources.index(source)
if index > 1:
if getWorkingValue(index) >= getErrorValue(index - 1):
setWorkingValue(index, 0)
index = index - 1
return ip_sources[index]
def getAutoSource():
# If the VPN has changed, then reset all the numbers
addon = xbmcaddon.Addon(getID())
last_vpn = addon.getSetting("ip_service_last_vpn")
current_vpn = addon.getSetting("vpn_provider_validated")
if (not last_vpn == current_vpn):
addon.setSetting("ip_service_last_vpn", current_vpn)
resetIPServices()
# Get the last source we tried to use from the home window or use the first if this is first time through
source = xbmcgui.Window(10000).getProperty("VPN_Manager_Last_IP_Service")
if source == "":
# Record that we're using the first one
xbmcgui.Window(10000).setProperty("VPN_Manager_Last_IP_Service", ip_sources[1])
return ip_sources[1]
else:
index = ip_sources.index(source)
if index > 1:
if getWorkingValue(index) >= getErrorValue(index - 1):
setWorkingValue(index, 0)
index = index - 1
return ip_sources[index]
def resetIPServices():
addon = xbmcaddon.Addon(getID())
addon.setSetting("ip_service_errors", LIST_DEFAULT)
addon.setSetting("ip_service_values", LIST_DEFAULT)
xbmcgui.Window(10000).setProperty("VPN_Manager_Last_IP_Service", ip_sources[1])
def useBigHammer():
hammer = xbmcaddon.Addon(getID()).getSetting("openvpn_killall")
if hammer == "true":
return True
else:
return False
def useBigHammer():
hammer = xbmcaddon.Addon(getID()).getSetting("openvpn_killall")
if hammer == "true":
return True
else:
return False
def getKillallPath():
# return the path to killall
p = getPlatform()
if p == platforms.LINUX or platforms.RPI:
return xbmcaddon.Addon(getID()).getSetting("killall_path") + "killall"
return
def getUserDataPath(path):
return xbmc.translatePath("special://userdata/addon_data/" + getID() + "/" + path)
def getPidofPath():
# return the path to pidof
p = getPlatform()
if p == platforms.LINUX or platforms.RPI:
return xbmcaddon.Addon(getID()).getSetting("pidof_path") + "pidof"
return
def getAddonPath(this_addon, path):
# Return the URL of the addon directory, plus any addition path/file name.
if this_addon:
return xbmc.translatePath("special://home/addons/" + getID() + "/" + path)
else:
return xbmc.translatePath("special://home/addons/" + path)
def importWizard():
addon = xbmcaddon.Addon(getID())
addon_name = getName()
errorMessage = ""
success = False
cancel = False
xbmcgui.Dialog().ok(
addon_name,
"The User Defined import wizard helps you set up an unsupported VPN provider. It may not work without additional user intervention. You should review the import log and subsequent VPN logs to debug any problems."
)
# Warn the user that files will be deleted and kittens will be harmed
if xbmcgui.Dialog().yesno(
addon_name,
"Any existing User Defined settings and files will be deleted. Do you want to continue?",
"", ""):
removeGeneratedFiles()
success = clearUserData()
addon.setSetting("vpn_provider", "User Defined")
if not success:
errorMessage = "Could not clear the UserDefined directory. Check the log."
else:
success = False
errorMessage = "Import wizard has not been run, no settings or files have been changed."
# Get the list of files to be used
if success:
if xbmcgui.Dialog().yesno(
addon_name,
"Select ALL files needed to connect to the VPN provider, including .ovpn, .key and .crt files. Select a directory (sub directories are ignored) or select multiple files within a directory?.",
"", "", "Directory", "Files"):
directory_input = False
files = xbmcgui.Dialog().browse(1, "Select all VPN provider files",
"files", "", False, False, "",
True)
else:
directory_input = True
dname = xbmcgui.Dialog().browse(
0, "Select a directory containing VPN provider files", "files",
"", False, False, "", False)
debugTrace("Import from directory " + dname)
dirs, files = xbmcvfs.listdir(dname)
# Separate the selected files into ovpn files and other files
ovpn_files = []
other_files = []
for name in files:
if directory_input:
name = dname + name
debugTrace("Found file " + name)
if name.endswith(".ovpn"):
ovpn_files.append(name)
else:
other_files.append(name)
if len(ovpn_files) == 0:
success = False
errorMessage = "No .ovpn files found. You must provide at least one .ovpn file."
# Copy and modify the ovpn files
if success:
# Create some logs to write out later
summary = []
detail = []
summary.append("Importing selected files to User Defined directory, " +
getUserDataPath("UserDefined/") + "\n")
summary.append("at " + time.strftime('%Y-%m-%d %H:%M:%S') + "\n")
detail.append("\n=== Import details ===\n\n")
update = False
rename = False
if xbmcgui.Dialog().yesno(
addon_name,
"Update the .ovpn files to best guess values and determine the best User Defined provider settings (recommended)?",
"", ""):
update = True
detail.append("Updating the .ovpn files to best guess settings\n")
if xbmcgui.Dialog().yesno(
addon_name,
"Rename the .ovpn files to indicate either a UDP or TCP connection type to allow filtering of connections?",
"", ""):
rename = True
detail.append("Files will be renamed to indicate UDP or TCP\n")
# Display dialog to show progress of copying files
dialog_step = 100 / (len(ovpn_files) + len(other_files))
progress = xbmcgui.DialogProgress()
progress_title = "Copying User Defined files."
progress.create(addon_name, progress_title)
prog_step = 0
xbmc.sleep(500)
try:
dest_path = getUserDataPath("UserDefined/")
debugTrace("Checking directory path exists before copying " +
dest_path)
if not os.path.exists(dest_path):
infoTrace("userdefined.py", "Creating " + dest_path)
os.makedirs(os.path.dirname(dest_path))
xbmc.sleep(500)
# Loop around waiting for the directory to be created. After 10 seconds we'll carry
# on and let he open file calls fail and throw an exception
t = 0
while not os.path.exists(os.path.dirname(dest_path)):
if t == 9:
errorTrace(
"userdefined.py",
"Waited 10 seconds to create directory but it never appeared"
)
break
xbmc.sleep(1000)
t += 1
other_files_count = []
for fname in other_files:
path, dest_name = os.path.split(fname)
dest_name = getUserDataPath("UserDefined/" + dest_name)
# Report file being copied, then do it
progress_message = "Copying " + fname
progress.update(prog_step, progress_title, progress_message)
xbmc.sleep(100)
prog_step += dialog_step
infoTrace("userdefined.py",
"Copying " + fname + " to " + dest_name)
detail.append("Copying " + fname + " to " + dest_name + "\n")
xbmcvfs.copy(fname, dest_name)
if not xbmcvfs.exists(dest_name):
raise IOError('Failed to copy user def file ' + fname +
" to " + dest_name)
other_files_count.append(0)
if progress.iscanceled():
cancel = True
break
auth_count = 0
auth_found = 0
cert_count = 0
cert_found = 0
multiple_certs = False
last_cert_found = ""
ecert_count = 0
key_count = 0
key_found = 0
key_pass_found = 0
key_pass_count = 0
multiple_keys = False
last_key_found = ""
ekey_count = 0
if not cancel:
metadata = getGitMetaData("UserDefined")
mods = []
if not metadata == None:
for line in metadata:
line = line.strip(' \t\n\r')
mods.append(line)
for oname in ovpn_files:
path, dest_name = os.path.split(oname)
dest_name = getUserDataPath("UserDefined/" + dest_name)
# Update dialog to saywhat's happening
if update:
progress_message = "Copying and updating " + oname
else:
progress_message = "Copying " + oname
progress.update(prog_step, progress_title,
progress_message)
xbmc.sleep(100)
prog_step += dialog_step
# Copy the ovpn file
infoTrace("userdefined.py",
"Copying " + oname + " to " + dest_name)
detail.append("Copying " + oname + " to " + dest_name +
"\n")
xbmcvfs.copy(oname, dest_name)
if not xbmcvfs.exists(dest_name):
raise IOError('Failed to copy user def ovpn ' + oname +
" to " + dest_name)
if update:
# Read the copied file in and then overwrite it with any updates needed
# Was doing a read from source and write here but this failed on Linux over an smb mount (file not found)
auth = False
keypass = False
infoTrace("userdefined.py", "Updating " + dest_name)
detail.append("Updating " + dest_name + "\n")
source_file = open(dest_name, 'r')
source = source_file.readlines()
source_file.close()
dest_file = open(dest_name, 'w')
proto = "UDP"
flags = [False, False, False, False, False]
for line in source:
line = line.strip(' \t\n\r')
old_line = line
i = 0
# Look for each non ovpn file uploaded and update it to make sure the path is good
for fname in other_files:
path, name = os.path.split(fname)
if not line.startswith("#"):
params = line.split()
if len(params) == 2:
# Remove the separator in order to get any fully qualified filename as space delimited
params[1].replace(getSeparator(), " ")
# Add in a leading space for unqualified filenames
params[1] = " " + params[1]
if params[1].endswith(" " + name):
old_line = line
line = params[
0] + " " + "#PATH" + getSeparatorOutput(
) + name
detail.append(" Found " + name +
", old line was : " +
old_line + "\n")
detail.append(" New line is " +
line + "\n")
other_files_count[i] += 1
if line.startswith(
"auth-user-pass"):
auth_found += 1
auth = True
if line.startswith("cert "):
cert_found += 1
if line.startswith("key "):
key_found += 1
if line.startswith("askpass "):
key_pass_found += 1
keypass = True
i += 1
# Do some tag counting to determine authentication methods to use
if not line.startswith("#"):
for mod in mods:
flag, verb, parms = mod.split(",")
if flag == "1" and line.startswith(
verb) and parms in line:
flags[0] = True
if flag == "3" and line.startswith(verb):
flags[2] = True
if flag == "4" and line.startswith(verb):
line = verb + " " + parms
if flag == "5" and not flags[
4] and verb in line:
detail.append(" WARNING, " + parms +
"\n")
flags[4] = True
if line.startswith("auth-user-pass"):
auth_count += 1
if not auth:
line = "auth-user-pass #PATH" + getSeparatorOutput(
) + "pass.txt"
if line.startswith("cert "):
cert_count += 1
if not last_cert_found == old_line:
if not last_cert_found == "":
multiple_certs = True
last_cert_found = old_line
if line.startswith("key "):
key_count += 1
if not last_key_found == old_line:
if not last_key_found == "":
multiple_keys = True
last_key_found = old_line
if line.startswith("askpass"):
key_pass_count += 1
if not keypass:
line = "askpass #PATH" + getSeparatorOutput(
) + "key.txt"
if line.startswith("proto "):
if "tcp" in (line.lower()): proto = "TCP"
if line.startswith("<cert>"):
ecert_count += 1
if line.startswith("<key>"):
ekey_count += 1
if not flags[2]: dest_file.write(line + "\n")
flags[2] = False
for mod in mods:
flag, verb, parms = mod.split(",")
if flag == "2":
dest_file.write(verb + "\n")
dest_file.close()
flags[4] = False
if flags[0]:
if xbmcvfs.exists(dest_name):
xbmcvfs.delete(dest_name)
detail.append(
" wARNING, couldn't import file as it contains errors or is unsupported\n"
)
elif rename:
proto = " (" + proto + ").ovpn"
new_name = dest_name.replace(".ovpn", proto)
if not xbmcvfs.exists(new_name):
xbmcvfs.rename(dest_name, new_name)
detail.append(" Renamed to " + new_name +
"\n")
else:
detail.append(
" WARNING, couldn't rename file to " +
new_name +
" as a file with that name already exists\n"
)
if progress.iscanceled():
cancel = True
break
except Exception as e:
errorTrace("userdefined.py", "Failed to copy (or update) file")
errorTrace("userdefined.py", str(e))
success = False
errorMessage = "Failed to copy (or update) selected files. Check the log."
progress_message = "Outputting results of import wizard"
progress.update(100, progress_title, progress_message)
xbmc.sleep(500)
# General import results
summary.append("\n=== Summary of import ===\n\n")
if cancel:
summary.append("Import was cancelled\n")
else:
summary.append("Imported " + str(len(ovpn_files)) +
" .ovpn files and " + str(len(other_files)) +
" other files.\n")
summary.append(
"\nYou should understand any WARNINGs below, and validate that the .ovpn files imported have been updated correctly.\n\n"
)
summary.append(
"If the VPN connection fails view the VPN log to determine why, using Google to understand the errors if necessary.\n"
)
summary.append(
"You can fix problems either by editing your local files and re-importing, or by editing the contents of the User Defined directory.\n\n"
)
if update:
# Report on how user names and passwords will be handled
if auth_count > 0:
if auth_found > 0:
# Not using a password as resolved by file
addon.setSetting("user_def_credentials", "false")
summary.append(
"The auth-user-pass tag was found " +
str(auth_count) +
" times, but was resolved using a supplied file so user name and password don't need to be entered.\n"
)
if not auth_found == auth_count:
summary.append(
" WARNING : The auth-user-pass tag was found "
+ str(auth_count) +
" times, but only resolved using a supplied file "
+ str(auth_found) +
" times. Some connections may not work.\n")
else:
# Using a password as auth-user-pass tag was found
addon.setSetting("user_def_credentials", "true")
summary.append(
"The auth-user-pass tag was found " +
str(auth_count) +
" times so assuming user name and password authentication is used.\n"
)
if auth_count < len(ovpn_files):
summary.append(
" WARNING : The auth-user-pass tag was only found in "
+ str(auth_count) + " .ovpn files, out of " +
str(len(ovpn_files)) +
". Some connections may not work.\n")
else:
# Not using a password as no auth-user-pass tag was found
addon.setSetting("user_def_credentials", "false")
summary.append(
"No auth-user-pass tag was found, so assuming user name and password is not needed.\n"
)
# Report on how keys and certs will be handled
if (cert_count > 0 or key_count > 0):
summary.append("The key tag was found " + str(key_count) +
" times, and the cert tag was found " +
str(cert_count) + " times.\n")
if cert_found > 0 or key_found > 0:
# Key and cert resolved by file so not asking user for them
addon.setSetting("user_def_keys", "None")
summary.append(
"The key and certificate don't need to be requested as the key tags were resolved using a supplied file "
+ str(key_found) +
" times, and the cert tags were resolved using a supplied file "
+ str(cert_found) + " times.\n")
if (not cert_found == cert_count) or (not key_found
== key_count):
summary.append(
" WARNING : The key or cert tags were not resolved by a supplied file for all occurrences. Some connections may not work.\n"
)
else:
if multiple_certs or multiple_keys:
# Key and cert tags found with different file names, but no files supplied. Assume multiple files, user supplied
addon.setSetting("user_def_keys", "Multiple")
summary.append(
"Found key and cert tags with multiple filenames, but no key or certificate files were supplied. These will be requested during connection.\n"
)
else:
# Key and cert tags found with same file names, but no files supplied. Assume single file, user supplied
addon.setSetting("user_def_keys", "Single")
summary.append(
"Found key and cert tags all with the same filename, but no key or certificate files were supplied. These will be requested during connection.\n"
)
if cert_count < len(ovpn_files) or key_count < len(
ovpn_files):
summary.append(
" WARNING : The key tag was found " +
str(key_count) +
" times, and the cert tag was found " +
str(cert_count) +
" times. Expected to find one of each in all " +
str(len(ovpn_files)) +
" .ovpn files. Some connections may not work.\n")
else:
# Embedded key and certs found, so not asking user for them
addon.setSetting("user_def_keys", "None")
if (ekey_count > 0 or ecert_count > 0):
if ekey_count == ecert_count and key_count == len(
ovpn_files):
summary.append(
"Using embedded user keys and certificates so keys and certs don't need to be entered.\n"
)
else:
summary.append(
" WARNING : Using embedded user keys and certificates, but found "
+ str(ekey_count) + " keys and " +
str(ecert_count) + " certificates in " +
str(len(ovpn_files)) +
" .ovpn files. There should be one of each in all .ovpn files otherwise some connections may not work.\n"
)
else:
summary.append(
"No user key or cert tags were found so assuming this type of authentication is not used.\n"
)
# Report on how key passwords will be handled
if key_pass_count > 0:
if key_pass_found > 0:
# Not using a password as resolved by file
addon.setSetting("user_def_key_password", "false")
summary.append(
"The askpass tag was found " + str(auth_count) +
" times, but was resolved using a supplied file so the key password doesn't need to be entered.\n"
)
if not key_pass_found == key_pass_count:
summary.append(
" WARNING : The askpass tag was found " +
str(key_pass_count) +
" times, but only resolved using a supplied file "
+ str(key_pass_found) +
" times. Some connections may not work.\n")
else:
# Using a password as auth-user-pass tag was found
addon.setSetting("user_def_key_password", "true")
summary.append(
"The askpass tag was found " +
str(key_pass_count) +
" times so assuming key password authentication is used.\n"
)
if key_pass_count < len(ovpn_files):
summary.append(
" WARNING : The askpass tag was only found in " +
str(key_pass_count) + " .ovpn files, out of " +
str(len(ovpn_files)) +
". Some connections may not work, or you may be asked to enter a password when it's not necessary.\n"
)
else:
# Not using a password as no askpass tag was found
addon.setSetting("user_def_key_password", "false")
summary.append(
"No askpass tag was found, so assuming key password is not needed.\n"
)
# Report how many times each of the non .ovpn files were used
i = 0
for oname in other_files:
summary.append("File " + oname +
" was found and used in .ovpn files " +
str(other_files_count[i]) + " times.\n")
if not other_files_count[i] == len(ovpn_files):
if other_files_count[i] == 0:
summary.append(
" WARNING : " + oname +
" was not used to update any .ovpn files and could be unused.\n"
)
else:
summary.append(
" WARNING : The number of updates for " +
oname +
" was different to the number of .ovpn files, "
+ str(len(ovpn_files)) +
", which could be a problem.\n")
i += 1
else:
summary.append(
"None of the files were updated during import.\n")
# Open a log file so all changes can be recorded without fouling up the kodi log
log_name = getImportLogPath()
if xbmcvfs.exists(log_name): xbmcvfs.delete(log_name)
log_file = open(log_name, 'w')
for line in summary:
log_file.write(line)
for line in detail:
log_file.write(line)
log_file.close()
progress.close()
xbmc.sleep(100)
if success:
if xbmcgui.Dialog().yesno(
addon_name,
"Import wizard finished. You should view the import log to review any issues, enter your user ID and password (if necessary) and then try and validate a VPN connection.",
"", "", "OK", "Import Log"):
popupImportLog()
else:
xbmcgui.Dialog().ok(addon_name, errorMessage)
return success
def showLogBox(caption, text):
path = xbmcaddon.Addon(getID()).getAddonInfo("path")
win = LogBox("logtextbox.xml", path, caption=caption, text=text)
win.doModal()
del win
def showLogBox(caption, text):
path = xbmcaddon.Addon(getID()).getAddonInfo("path")
win = LogBox("logtextbox.xml", path, caption=caption, text=text)
win.doModal()
del win
def getKillallPath():
# return the path to killall
p = getPlatform()
if p == platforms.LINUX or platforms.RPI:
return xbmcaddon.Addon(getID()).getSetting("killall_path") + "killall"
return
def resetIPServices():
addon = xbmcaddon.Addon(getID())
addon.setSetting("ip_service_errors", LIST_DEFAULT)
addon.setSetting("ip_service_values", LIST_DEFAULT)
xbmcgui.Window(10000).setProperty("VPN_Manager_Last_IP_Service", ip_sources[1])
def importWizard():
addon = xbmcaddon.Addon(getID())
addon_name = getName()
errorMessage = ""
success = False
cancel = False
xbmcgui.Dialog().ok(addon_name, "The User Defined import wizard helps you set up an unsupported VPN provider. It may not work without additional user intervention. You should review the import log and subsequent VPN logs to debug any problems.")
# Warn the user that files will be deleted and kittens will be harmed
if xbmcgui.Dialog().yesno(addon_name, "Any existing User Defined settings and files will be deleted. Do you want to continue?"):
removeGeneratedFiles()
success = clearUserData()
addon.setSetting("vpn_provider", "User Defined")
if not success: errorMessage = "Could not clear the UserDefined directory. Check the log."
else:
success = False
errorMessage = "Import wizard has not been run, no settings or files have been changed."
# Get the list of files to be used
if success:
if xbmcgui.Dialog().yesno(addon_name, "Select ALL files needed to connect to the VPN provider, including .ovpn, .key and .crt files. Select a directory (sub directories are ignored) or select multiple files within a directory?.", nolabel="Directory", yeslabel="Files"):
directory_input = False
files = xbmcgui.Dialog().browse(1, "Select all VPN provider files", "files", "", False, False, "", True)
else:
directory_input = True
dname = xbmcgui.Dialog().browse(0, "Select a directory containing VPN provider files", "files", "", False, False, "", False)
debugTrace("Import from directory " + dname)
dirs, files = xbmcvfs.listdir(dname)
# Separate the selected files into ovpn files and other files
ovpn_files = []
other_files = []
for name in files:
if directory_input:
name = dname + name
debugTrace("Found file " + name)
if name.endswith(".ovpn"):
ovpn_files.append(name)
else:
other_files.append(name)
if len(ovpn_files) == 0:
success = False
errorMessage = "No .ovpn files found. You must provide at least one .ovpn file."
# Copy and modify the ovpn files
if success:
# Create some logs to write out later
summary = []
detail = []
summary.append("Importing selected files to User Defined directory, " + getUserDataPath("UserDefined/") + "\n")
summary.append("at " + time.strftime('%Y-%m-%d %H:%M:%S') + "\n")
detail.append("\n=== Import details ===\n\n")
update = False
rename = False
if not xbmcgui.Dialog().yesno(addon_name, "Update the .ovpn files to best guess values and determine the best User Defined provider settings [I](recommended)[/I]?", nolabel="Yes", yeslabel="No"):
update = True
detail.append("Updating the .ovpn files to best guess settings\n")
if not xbmcgui.Dialog().yesno(addon_name, "Rename the .ovpn files to indicate either a UDP or TCP connection type to allow filtering of connections [I](recommended)[/I]?", nolabel="Yes", yeslabel="No"):
rename = True
detail.append("Files will be renamed to indicate UDP or TCP\n")
# Display dialog to show progress of copying files
dialog_step = 100/(len(ovpn_files) + len(other_files))
progress = xbmcgui.DialogProgress()
progress_title = "Copying User Defined files."
progress.create(addon_name,progress_title)
prog_step = 0
xbmc.sleep(500)
try:
dest_path = getUserDataPath("UserDefined/")
debugTrace("Checking directory path exists before copying " + dest_path)
if not os.path.exists(dest_path):
infoTrace("userdefined.py", "Creating " + dest_path)
os.makedirs(os.path.dirname(dest_path))
xbmc.sleep(500)
# Loop around waiting for the directory to be created. After 10 seconds we'll carry
# on and let he open file calls fail and throw an exception
t = 0
while not os.path.exists(os.path.dirname(dest_path)):
if t == 9:
errorTrace("userdefined.py", "Waited 10 seconds to create directory but it never appeared")
break
xbmc.sleep(1000)
t += 1
other_files_count = []
for fname in other_files:
path, dest_name = os.path.split(fname)
dest_name = getUserDataPath("UserDefined/" + dest_name)
# Report file being copied, then do it
progress_message = "Copying " + fname
progress.update(prog_step, progress_title, progress_message)
xbmc.sleep(100)
prog_step += dialog_step
infoTrace("userdefined.py", "Copying " + fname + " to " + dest_name)
detail.append("Copying " + fname + " to " + dest_name + "\n")
xbmcvfs.copy(fname, dest_name)
if not xbmcvfs.exists(dest_name): raise IOError('Failed to copy user def file ' + fname + " to " + dest_name)
other_files_count.append(0)
if progress.iscanceled():
cancel = True
break
auth_count = 0
auth_found = 0
cert_count = 0
cert_found = 0
multiple_certs = False
last_cert_found = ""
ecert_count = 0
key_count = 0
key_found = 0
key_pass_found = 0
key_pass_count = 0
multiple_keys = False
last_key_found = ""
ekey_count = 0
if not cancel:
metadata = getGitMetaData("UserDefined")
mods = []
if not metadata == None:
for line in metadata:
line = line.strip(' \t\n\r')
mods.append(line)
for oname in ovpn_files:
path, dest_name = os.path.split(oname)
dest_name = getUserDataPath("UserDefined/" + dest_name)
# Update dialog to saywhat's happening
if update:
progress_message = "Copying and updating " + oname
else:
progress_message = "Copying " + oname
progress.update(prog_step, progress_title, progress_message)
xbmc.sleep(100)
prog_step += dialog_step
# Copy the ovpn file
infoTrace("userdefined.py", "Copying " + oname + " to " + dest_name)
detail.append("Copying " + oname + " to " + dest_name + "\n")
xbmcvfs.copy(oname, dest_name)
if not xbmcvfs.exists(dest_name): raise IOError('Failed to copy user def ovpn ' + oname + " to " + dest_name)
if update:
# Read the copied file in and then overwrite it with any updates needed
# Was doing a read from source and write here but this failed on Linux over an smb mount (file not found)
auth = False
keypass = False
infoTrace("userdefined.py", "Updating " + dest_name)
detail.append("Updating " + dest_name + "\n")
source_file = open(dest_name, 'r')
source = source_file.readlines()
source_file.close()
dest_file = open(dest_name, 'w')
proto = "UDP"
flags = [False, False, False, False, False]
for line in source:
line = line.strip(' \t\n\r')
old_line = line
i = 0
# Look for each non ovpn file uploaded and update it to make sure the path is good
for fname in other_files:
path, name = os.path.split(fname)
if not line.startswith("#"):
params = line.split()
if len(params) > 2:
# Remove the separator in order to get any fully qualified filename as space delimited
params[1].replace(getSeparator(), " ")
# Add in a leading space for unqualified filenames
params[1] = " " + params[1]
if params[1].endswith(" " + name):
old_line = line
line = params[0] + " " + "#PATH" + getSeparatorOutput() + name
# Add any trailing parameters back in
if len(params) > 2:
for i in range(2, len(params)):
line = line + " " + params[i]
detail.append(" Found " + name + ", old line was : " + old_line + "\n")
detail.append(" New line is " + line + "\n")
other_files_count[i] += 1
if line.startswith("auth-user-pass"):
auth_found += 1
auth = True
if line.startswith("cert "):
cert_found += 1
if line.startswith("key "):
key_found += 1
if line.startswith("askpass "):
key_pass_found += 1
keypass = True
i += 1
# Do some tag counting to determine authentication methods to use
if not line.startswith("#"):
for mod in mods:
flag, verb, parms = mod.split(",")
if flag == "1" and line.startswith(verb) and parms in line: flags[0] = True
if flag == "3" and line.startswith(verb): flags[2] = True
if flag == "4" and line.startswith(verb): line = verb + " " + parms
if flag == "5" and not flags[4] and verb in line:
detail.append(" WARNING, " + parms + "\n")
flags[4] = True
if line.startswith("auth-user-pass"):
auth_count += 1
if not auth: line = "auth-user-pass #PATH" + getSeparatorOutput() + "pass.txt"
if line.startswith("cert "):
cert_count += 1
if not last_cert_found == old_line:
if not last_cert_found == "":
multiple_certs = True
last_cert_found = old_line
if line.startswith("key "):
key_count += 1
if not last_key_found == old_line:
if not last_key_found == "":
multiple_keys = True
last_key_found = old_line
if line.startswith("askpass"):
key_pass_count += 1
if not keypass: line = "askpass #PATH" + getSeparatorOutput() + "key.txt"
if line.startswith("proto "):
if "tcp" in (line.lower()): proto = "TCP"
if line.startswith("<cert>"):
ecert_count += 1
if line.startswith("<key>"):
ekey_count += 1
if not flags[2]: dest_file.write(line+"\n")
flags[2] = False
for mod in mods:
flag, verb, parms = mod.split(",")
if flag == "2":
dest_file.write(verb+"\n")
dest_file.close()
flags[4] = False
if flags[0]:
if xbmcvfs.exists(dest_name):
xbmcvfs.delete(dest_name)
detail.append(" wARNING, couldn't import file as it contains errors or is unsupported\n")
elif rename:
proto = " (" + proto + ").ovpn"
new_name = dest_name.replace(".ovpn", proto)
if not xbmcvfs.exists(new_name):
xbmcvfs.rename(dest_name, new_name)
detail.append(" Renamed to " + new_name + "\n")
else:
detail.append(" WARNING, couldn't rename file to " + new_name + " as a file with that name already exists\n")
if progress.iscanceled():
cancel = True
break
except Exception as e:
errorTrace("userdefined.py", "Failed to copy (or update) file")
errorTrace("userdefined.py", str(e))
success = False
errorMessage = "Failed to copy (or update) selected files. Check the log."
progress_message = "Outputting results of import wizard"
progress.update(100, progress_title, progress_message)
xbmc.sleep(500)
# General import results
summary.append("\n=== Summary of import ===\n\n")
if cancel:
summary.append("Import was cancelled\n")
else:
summary.append("Imported " + str(len(ovpn_files)) + " .ovpn files and " + str(len(other_files)) + " other files.\n")
summary.append("\nYou should understand any WARNINGs below, and validate that the .ovpn files imported have been updated correctly.\n\n")
summary.append("If the VPN connection fails view the VPN log to determine why, using Google to understand the errors if necessary.\n")
summary.append("You can fix problems either by editing your local files and re-importing, or by editing the contents of the User Defined directory.\n\n")
if update:
# Report on how user names and passwords will be handled
if auth_count > 0:
if auth_found > 0:
# Not using a password as resolved by file
addon.setSetting("user_def_credentials", "false")
summary.append("The auth-user-pass tag was found " + str(auth_count) + " times, but was resolved using a supplied file so user name and password don't need to be entered.\n")
if not auth_found == auth_count:
summary.append(" WARNING : The auth-user-pass tag was found " + str(auth_count) + " times, but only resolved using a supplied file " + str(auth_found) + " times. Some connections may not work.\n")
else:
# Using a password as auth-user-pass tag was found
addon.setSetting("user_def_credentials", "true")
summary.append("The auth-user-pass tag was found " + str(auth_count) + " times so assuming user name and password authentication is used.\n")
if auth_count < len(ovpn_files):
summary.append(" WARNING : The auth-user-pass tag was only found in " + str(auth_count) + " .ovpn files, out of " + str(len(ovpn_files)) + ". Some connections may not work.\n")
else:
# Not using a password as no auth-user-pass tag was found
addon.setSetting("user_def_credentials", "false")
summary.append("No auth-user-pass tag was found, so assuming user name and password is not needed.\n")
# Report on how keys and certs will be handled
if (cert_count > 0 or key_count > 0):
summary.append("The key tag was found " + str(key_count) + " times, and the cert tag was found " + str(cert_count) + " times.\n")
if cert_found > 0 or key_found > 0:
# Key and cert resolved by file so not asking user for them
addon.setSetting("user_def_keys", "None")
summary.append("The key and certificate don't need to be requested as the key tags were resolved using a supplied file " + str(key_found) + " times, and the cert tags were resolved using a supplied file " + str(cert_found) + " times.\n")
if (not cert_found == cert_count) or (not key_found == key_count):
summary.append(" WARNING : The key or cert tags were not resolved by a supplied file for all occurrences. Some connections may not work.\n")
else:
if multiple_certs or multiple_keys:
# Key and cert tags found with different file names, but no files supplied. Assume multiple files, user supplied
addon.setSetting("user_def_keys", "Multiple")
summary.append("Found key and cert tags with multiple filenames, but no key or certificate files were supplied. These will be requested during connection.\n")
else:
# Key and cert tags found with same file names, but no files supplied. Assume single file, user supplied
addon.setSetting("user_def_keys", "Single")
summary.append("Found key and cert tags all with the same filename, but no key or certificate files were supplied. These will be requested during connection.\n")
if cert_count < len(ovpn_files) or key_count < len(ovpn_files):
summary.append(" WARNING : The key tag was found " + str(key_count) + " times, and the cert tag was found " + str(cert_count) + " times. Expected to find one of each in all " + str(len(ovpn_files)) + " .ovpn files. Some connections may not work.\n")
else:
# Embedded key and certs found, so not asking user for them
addon.setSetting("user_def_keys", "None")
if (ekey_count > 0 or ecert_count > 0):
if ekey_count == ecert_count and key_count == len(ovpn_files):
summary.append("Using embedded user keys and certificates so keys and certs don't need to be entered.\n")
else:
summary.append(" WARNING : Using embedded user keys and certificates, but found " + str(ekey_count) + " keys and " + str(ecert_count) + " certificates in " + str(len(ovpn_files)) + " .ovpn files. There should be one of each in all .ovpn files otherwise some connections may not work.\n")
else:
summary.append("No user key or cert tags were found so assuming this type of authentication is not used.\n")
# Report on how key passwords will be handled
if key_pass_count > 0:
if key_pass_found > 0:
# Not using a password as resolved by file
addon.setSetting("user_def_key_password", "false")
summary.append("The askpass tag was found " + str(auth_count) + " times, but was resolved using a supplied file so the key password doesn't need to be entered.\n")
if not key_pass_found == key_pass_count:
summary.append(" WARNING : The askpass tag was found " + str(key_pass_count) + " times, but only resolved using a supplied file " + str(key_pass_found) + " times. Some connections may not work.\n")
else:
# Using a password as auth-user-pass tag was found
addon.setSetting("user_def_key_password", "true")
summary.append("The askpass tag was found " + str(key_pass_count) + " times so assuming key password authentication is used.\n")
if key_pass_count < len(ovpn_files):
summary.append(" WARNING : The askpass tag was only found in " + str(key_pass_count) + " .ovpn files, out of " + str(len(ovpn_files)) + ". Some connections may not work, or you may be asked to enter a password when it's not necessary.\n")
else:
# Not using a password as no askpass tag was found
addon.setSetting("user_def_key_password", "false")
summary.append("No askpass tag was found, so assuming key password is not needed.\n")
# Report how many times each of the non .ovpn files were used
i = 0
for oname in other_files:
summary.append("File " + oname + " was found and used in .ovpn files " + str(other_files_count[i]) + " times.\n")
if not other_files_count[i] == len(ovpn_files):
if other_files_count[i] == 0:
summary.append(" WARNING : " + oname + " was not used to update any .ovpn files and could be unused.\n")
else:
summary.append(" WARNING : The number of updates for " + oname + " was different to the number of .ovpn files, " + str(len(ovpn_files)) + ", which could be a problem.\n")
i += 1
else:
summary.append("None of the files were updated during import.\n")
# Open a log file so all changes can be recorded without fouling up the kodi log
log_name = getImportLogPath()
if xbmcvfs.exists(log_name): xbmcvfs.delete(log_name)
log_file = open(log_name, 'w')
for line in summary:
log_file.write(line)
for line in detail:
log_file.write(line)
log_file.close()
progress.close()
xbmc.sleep(100)
if success:
if xbmcgui.Dialog().yesno(addon_name, "Import wizard finished. You should view the import log to review any issues, enter your user ID and password (if necessary) and then try and validate a VPN connection.", nolabel="OK", yeslabel="Import Log"):
popupImportLog()
else:
xbmcgui.Dialog().ok(addon_name, errorMessage)
return success
def getPidofPath():
# return the path to pidof
p = getPlatform()
if p == platforms.LINUX or platforms.RPI:
return xbmcaddon.Addon(getID()).getSetting("pidof_path") + "pidof"
return
def getUserDataPath(path):
return xbmc.translatePath("special://userdata/addon_data/" + getID() +
"/" + path)
def showInfoBox(caption, text_l, text_r):
path = xbmcaddon.Addon(getID()).getAddonInfo("path")
win = InfoBox("infotextbox.xml", path, caption=caption, text_left=text_l, text_right=text_r)
win.doModal()
del win