mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-04-08 09:41:35 +00:00
114 lines
3.5 KiB
Python
114 lines
3.5 KiB
Python
#!/usr/bin/python2
|
|
# -*- mode: python -*-
|
|
#
|
|
# This file is part of Plinth.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
"""
|
|
Utilities for configuring PageKite.
|
|
"""
|
|
# TODO:
|
|
# Once python-augeas is available for python3 import the following things
|
|
# from plinth.modules.pagekite.util (instead of having a copy in here):
|
|
#
|
|
# SERVICE_PARAMS, convert_service_to_string
|
|
#
|
|
# until then, this file is python2 and python3 compatible for the unittests
|
|
|
|
import os
|
|
import json
|
|
|
|
CONF_PATH = '/files/etc/pagekite.d'
|
|
|
|
# parameters that get stored in configuration service_on entries
|
|
SERVICE_PARAMS = ['protocol', 'kitename', 'backend_host', 'backend_port',
|
|
'secret']
|
|
|
|
|
|
def convert_service_to_string(service):
|
|
""" Convert service dict into a ":"-separated parameter string
|
|
|
|
>>> convert_service_to_string({'kitename': '@kitename', \
|
|
'backend_host': 'localhost', 'secret': '@kitesecret', \
|
|
'protocol': 'https/443', 'backend_port': '443'})
|
|
'https/443:@kitename:localhost:443:@kitesecret'
|
|
"""
|
|
try:
|
|
service_string = ":".join([service[param] for param in SERVICE_PARAMS])
|
|
except KeyError:
|
|
raise ValueError("Could not parse params: %s " % service)
|
|
return service_string
|
|
|
|
|
|
def load_service(json_service):
|
|
""" create a service out of json command-line argument
|
|
|
|
1) parse json
|
|
2) only use the parameters that we need (SERVICE_PARAMS)
|
|
3) convert unicode to strings
|
|
"""
|
|
service = json.loads(json_service)
|
|
return dict((str(key), str(service[key])) for key in SERVICE_PARAMS)
|
|
|
|
|
|
def get_augeas_servicefile_path(protocol):
|
|
"""Get the augeas path where a service for a protocol should be stored
|
|
|
|
TODO: Once we use python3 switch from doctests to unittests
|
|
|
|
>>> get_augeas_servicefile_path('http')
|
|
'/files/etc/pagekite.d/80_http.rc/service_on'
|
|
|
|
>>> get_augeas_servicefile_path('https')
|
|
'/files/etc/pagekite.d/443_https.rc/service_on'
|
|
|
|
>>> get_augeas_servicefile_path('http/80')
|
|
'/files/etc/pagekite.d/80_http.rc/service_on'
|
|
|
|
>>> get_augeas_servicefile_path('http/8080')
|
|
'/files/etc/pagekite.d/8080_http.rc/service_on'
|
|
|
|
>>> get_augeas_servicefile_path('raw/22')
|
|
'/files/etc/pagekite.d/22_raw.rc/service_on'
|
|
|
|
>>> get_augeas_servicefile_path('xmpp')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValueError: Unsupported protocol: xmpp
|
|
|
|
"""
|
|
if not protocol.startswith(("http", "https", "raw")):
|
|
raise ValueError('Unsupported protocol: %s' % protocol)
|
|
|
|
try:
|
|
_protocol, port = protocol.split('/')
|
|
except ValueError:
|
|
if protocol == 'http':
|
|
relpath = '80_http.rc'
|
|
elif protocol == 'https':
|
|
relpath = '443_https.rc'
|
|
else:
|
|
raise ValueError('Unsupported protocol: %s' % protocol)
|
|
else:
|
|
relpath = '%s_%s.rc' % (port, _protocol)
|
|
|
|
return os.path.join(CONF_PATH, relpath, 'service_on')
|
|
|
|
|
|
if __name__ == "__main__":
|
|
import doctest
|
|
doctest.testmod()
|