mirror of
https://github.com/YunoHost/moulinette.git
synced 2024-09-03 20:06:31 +02:00
679 lines
21 KiB
Python
679 lines
21 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
""" License
|
|
|
|
Copyright (C) 2013 YunoHost
|
|
|
|
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
|
|
|
|
"""
|
|
|
|
""" yunohost_app.py
|
|
|
|
Manage apps
|
|
"""
|
|
import os
|
|
import sys
|
|
import json
|
|
import shutil
|
|
import stat
|
|
import yaml
|
|
import time
|
|
from yunohost import YunoHostError, YunoHostLDAP, win_msg, random_password, lvl, is_true, lemon_configuration
|
|
from yunohost_domain import domain_list, domain_add
|
|
from yunohost_user import user_info
|
|
|
|
repo_path = '/var/cache/yunohost/repo'
|
|
apps_path = '/usr/share/yunohost/apps'
|
|
apps_setting_path= '/etc/yunohost/apps/'
|
|
a2_settings_path = '/etc/yunohost/apache/domains'
|
|
a2_template_path = '/etc/yunohost/apache/templates'
|
|
install_tmp = '/tmp/yunohost/install'
|
|
app_tmp_folder = install_tmp + '/from_file'
|
|
lemon_tmp_conf = '/tmp/tmplemonconf'
|
|
|
|
def app_listlists():
|
|
"""
|
|
List fetched lists
|
|
|
|
|
|
"""
|
|
list_list = []
|
|
try:
|
|
for filename in os.listdir(repo_path):
|
|
if '.json' in filename:
|
|
list_list.append(filename[:len(filename)-5])
|
|
except OSError:
|
|
raise YunoHostError(1, _("No list found"))
|
|
|
|
return { 'Lists' : list_list }
|
|
|
|
|
|
def app_fetchlist(url=None, name=None):
|
|
"""
|
|
Fetch application list from app server
|
|
|
|
Keyword argument:
|
|
url -- URL of remote JSON list (default http://app.yunohost.org/list.json)
|
|
name -- Name of the list (default yunohost)
|
|
|
|
"""
|
|
# Create app path if not exists
|
|
try: os.listdir(repo_path)
|
|
except OSError: os.makedirs(repo_path)
|
|
|
|
if not url:
|
|
url = 'http://app.yunohost.org/list.json'
|
|
name = 'yunohost'
|
|
else:
|
|
if not name: raise YunoHostError(22, _("You must indicate a name for your custom list"))
|
|
|
|
if os.system('wget "'+ url +'" -O "'+ repo_path +'/'+ name +'.json"') != 0:
|
|
raise YunoHostError(1, _("List server connection failed"))
|
|
|
|
win_msg(_("List successfully fetched"))
|
|
|
|
|
|
def app_removelist(name):
|
|
"""
|
|
Remove list from the repositories
|
|
|
|
Keyword argument:
|
|
name -- Name of the list to remove
|
|
|
|
"""
|
|
try:
|
|
os.remove(repo_path +'/'+ name + '.json')
|
|
except OSError:
|
|
raise YunoHostError(22, _("Unknown list"))
|
|
|
|
win_msg(_("List successfully removed"))
|
|
|
|
|
|
def app_list(offset=None, limit=None, filter=None, raw=False):
|
|
"""
|
|
List apps
|
|
|
|
Keyword argument:
|
|
limit -- Maximum number of app fetched
|
|
offset -- Starting number for app fetching
|
|
filter -- Name filter of app_id or app_name
|
|
raw -- Return the full app_dict
|
|
|
|
"""
|
|
# TODO: List installed applications
|
|
|
|
if offset: offset = int(offset)
|
|
else: offset = 0
|
|
if limit: limit = int(limit)
|
|
else: limit = 1000
|
|
|
|
applists = os.listdir(repo_path)
|
|
app_dict = {}
|
|
if raw:
|
|
list_dict = {}
|
|
else:
|
|
list_dict=[]
|
|
|
|
if not applists: app_fetchlist()
|
|
|
|
for applist in applists:
|
|
if '.json' in applist:
|
|
with open(repo_path +'/'+ applist) as json_list:
|
|
app_dict.update(json.loads(str(json_list.read())))
|
|
|
|
if len(app_dict) > (0 + offset) and limit > 0:
|
|
sorted_app_dict = {}
|
|
for sorted_keys in sorted(app_dict.keys())[offset:]:
|
|
sorted_app_dict[sorted_keys] = app_dict[sorted_keys]
|
|
|
|
i = 0
|
|
for app_id, app_info in sorted_app_dict.items():
|
|
if i < limit:
|
|
if (filter and ((filter in app_id) or (filter in app_info['manifest']['name']))) or not filter:
|
|
installed = _is_installed(app_id)
|
|
|
|
if raw:
|
|
app_info['installed'] = installed
|
|
list_dict[app_id] = app_info
|
|
else:
|
|
list_dict.append({
|
|
'ID': app_id,
|
|
'Name': app_info['manifest']['name'],
|
|
'Description': app_info['manifest']['description'],
|
|
'Installed': installed
|
|
})
|
|
i += 1
|
|
else:
|
|
break
|
|
if not raw:
|
|
list_dict = { 'Apps': list_dict }
|
|
return list_dict
|
|
|
|
|
|
def app_info(app, raw=False):
|
|
"""
|
|
Get app informations
|
|
|
|
Keyword argument:
|
|
app -- App ID
|
|
raw -- Return the full app_dict
|
|
|
|
"""
|
|
try:
|
|
app_info = app_list(filter=app, limit=1, raw=True)[app]
|
|
except YunoHostError:
|
|
app_info = {}
|
|
|
|
if raw:
|
|
return app_info
|
|
else:
|
|
return [
|
|
('Name', app_info['manifest']['name']),
|
|
('Version', app_info['manifest']['version']),
|
|
('Description', app_info['manifest']['description']),
|
|
#TODO: Add more infos
|
|
]
|
|
|
|
|
|
def app_map(app=None, raw=False):
|
|
"""
|
|
List apps by domain
|
|
|
|
Keyword argument:
|
|
app -- Specific app to map
|
|
raw -- Return complete dict
|
|
|
|
"""
|
|
|
|
result = {}
|
|
|
|
for app_id in os.listdir(apps_setting_path):
|
|
if app and (app != app_id):
|
|
continue
|
|
|
|
with open(apps_setting_path + app_id +'/settings.yml') as f:
|
|
app_settings = yaml.load(f)
|
|
|
|
if 'domain' not in app_settings:
|
|
continue
|
|
|
|
if raw:
|
|
if app_settings['domain'] not in result:
|
|
result[app_settings['domain']] = {}
|
|
result[app_settings['domain']][app_settings['path']] = {
|
|
'label': app_settings['label'],
|
|
'id': app_settings['id'],
|
|
'instance': app_settings['instance']
|
|
}
|
|
else:
|
|
result['https://'+app_settings['domain']+app_settings['path']] = app_settings['label']
|
|
|
|
return result
|
|
|
|
|
|
def app_upgrade(app, url=None, file=None):
|
|
"""
|
|
Upgrade app
|
|
|
|
Keyword argument:
|
|
url -- Git url to fetch for upgrade
|
|
app -- App(s) to upgrade (default all)
|
|
file -- Folder or tarball for upgrade
|
|
|
|
"""
|
|
with YunoHostLDAP() as yldap:
|
|
try:
|
|
app_list()
|
|
except YunoHostError:
|
|
raise YunoHostError(1, _("No app to upgrade"))
|
|
|
|
upgraded_apps = []
|
|
|
|
# If no app is specified, upgrade all apps
|
|
if not app:
|
|
app = os.listdir(apps_setting_path)
|
|
|
|
for app_id in app:
|
|
installed = _is_installed(app_id)
|
|
if not installed:
|
|
raise YunoHostError(1, app_id + _(" is not installed"))
|
|
|
|
if app_id in upgraded_apps:
|
|
raise YunoHostError(1, _("Conflict, multiple upgrades of the same app: ")+ app_id +' (instance n°'+ number +')')
|
|
|
|
#TODO: fix that (and check for instance number)
|
|
current_app_dict = app_info(app_id, instance=number, raw=True)
|
|
new_app_dict = app_info(app_id, raw=True)
|
|
|
|
if file:
|
|
manifest = _extract_app_from_file(file)
|
|
elif url:
|
|
manifest = _fetch_app_from_git(url)
|
|
elif (new_app_dict['lastUpdate'] > current_app_dict['lastUpdate']) or ('update_time' not in current_app_dict['settings'] and (new_app_dict['lastUpdate'] > current_app_dict['settings']['install_time'])) or ('update_time' in current_app_dict['settings'] and (new_app_dict['lastUpdate'] > current_app_dict['settings']['update_time'])):
|
|
manifest = _fetch_app_from_git(app_id)
|
|
else:
|
|
continue
|
|
|
|
|
|
#########################################
|
|
# Execute App upgrade script #
|
|
#########################################
|
|
|
|
_exec_app_script(step='upgrade', path=app_tmp_folder +'/scripts', var_dict={}, parameters=manifest['parameters'])
|
|
|
|
|
|
#########################################
|
|
# Write App settings #
|
|
#########################################
|
|
|
|
app_setting_path = apps_setting_path +'/'+ app_id
|
|
|
|
current_app_dict['settings']['update_time'] = int(time.time())
|
|
|
|
with open(app_setting_path +'/settings.yml', 'w') as f:
|
|
yaml.safe_dump(current_app_dict['settings'], f, default_flow_style=False)
|
|
win_msg(_("App setting file updated"))
|
|
|
|
os.system('mv "'+ app_tmp_folder +'/*" '+ app_setting_path)
|
|
|
|
#########################################
|
|
# So much win #
|
|
#########################################
|
|
|
|
upgraded_apps.append(unique_app_id)
|
|
win_msg(app_id + _(" upgraded successfully"))
|
|
|
|
if not upgraded_apps:
|
|
raise YunoHostError(1, _("No app to upgrade"))
|
|
|
|
win_msg(_("Upgrade complete"))
|
|
|
|
|
|
def app_install(app, label=None):
|
|
"""
|
|
Install apps
|
|
|
|
Keyword argument:
|
|
app -- App ID to install
|
|
label
|
|
|
|
"""
|
|
#TODO: Create tool for lemon
|
|
#TODO: Create tool for apache (check path availability & stuff)
|
|
#TODO: Create tool for MySQL DB ?
|
|
|
|
with YunoHostLDAP() as yldap:
|
|
|
|
|
|
##########################################
|
|
# Fetch or extract sources #
|
|
##########################################
|
|
|
|
try: os.listdir(install_tmp)
|
|
except OSError: os.makedirs(install_tmp)
|
|
|
|
if app in app_list(raw=True) or ('@' in app) or ('http://' in app) or ('https://' in app):
|
|
manifest = _fetch_app_from_git(app)
|
|
else:
|
|
manifest = _extract_app_from_file(app)
|
|
|
|
|
|
#########################################
|
|
# Define App ID & path #
|
|
#########################################
|
|
|
|
if not lvl(manifest, 'id') or '__' in manifest['uid']:
|
|
raise YunoHostError(22, _("App id is invalid"))
|
|
|
|
instance_number = _installed_instance_number(manifest['yunohost']['id'], last=True) + 1
|
|
if instance_number > 1:
|
|
if not lvl(manifest, 'multi_instance') or not is_true(manifest['multi_instance']):
|
|
raise YunoHostError(1, _("App is already installed"))
|
|
|
|
|
|
unique_app_id = manifest['id'] +'__'+ str(instance_number)
|
|
app_final_path = apps_path +'/'+ unique_app_id
|
|
script_var_dict = {
|
|
'SCRIPT_DIR': app_tmp_folder,
|
|
'APP_DIR': app_final_path,
|
|
'APP_ID': unique_app_id
|
|
}
|
|
|
|
|
|
#########################################
|
|
# Execute App install script #
|
|
#########################################
|
|
|
|
_exec_app_script(step='install', path=app_tmp_folder +'/scripts', var_dict=script_var_dict, parameters=manifest['parameters'])
|
|
|
|
|
|
#########################################
|
|
# Write App settings #
|
|
#########################################
|
|
|
|
app_setting_path = apps_setting_path +'/'+ unique_app_id
|
|
|
|
# TMP: Remove old settings
|
|
if os.path.exists(app_setting_path): shutil.rmtree(app_setting_path)
|
|
os.makedirs(app_setting_path)
|
|
|
|
yaml_dict = {
|
|
'id': manifest['yunohost']['uid'],
|
|
'instance' : instance_number,
|
|
'install_time': int(time.time())
|
|
}
|
|
|
|
if label: yaml_dict['label'] = label
|
|
else: yaml_dict['label'] = manifest['name']
|
|
|
|
with open(app_setting_path +'/settings.yml', 'w') as f:
|
|
yaml.safe_dump(yaml_dict, f, default_flow_style=False)
|
|
win_msg(_("App setting file created"))
|
|
|
|
os.system('mv "'+ app_final_path +'/manifest.json" "'+ app_final_path +'/scripts" '+ app_setting_path)
|
|
|
|
|
|
#########################################
|
|
# So much win #
|
|
#########################################
|
|
|
|
win_msg(_("Installation complete"))
|
|
|
|
|
|
def app_remove(app, instance=[]):
|
|
"""
|
|
Remove app
|
|
|
|
Keyword argument:
|
|
app -- App(s) to delete
|
|
instance -- App instance number to delete
|
|
|
|
"""
|
|
lemon_conf_lines = {}
|
|
|
|
if not instance:
|
|
instance = _installed_instance_number(app)
|
|
|
|
for number in instance:
|
|
number = str(number)
|
|
unique_app_id = app +'__'+ number
|
|
app_final_path = apps_path +'/'+ unique_app_id
|
|
app_dict = app_info(app, instance=number, raw=True)
|
|
app_settings = app_dict['settings']
|
|
manifest = app_dict['manifest']
|
|
|
|
script_var_dict = {
|
|
'APP_DIR': apps_path +'/'+ unique_app_id,
|
|
'APP_ID': unique_app_id
|
|
}
|
|
|
|
_exec_app_script(step='remove', path=app_tmp_folder +'/scripts', var_dict=script_var_dict, parameters=manifest['parameters'])
|
|
|
|
win_msg(_("App removed: ")+ unique_app_id)
|
|
|
|
|
|
def app_addaccess(apps, users):
|
|
"""
|
|
Grant access right to users (everyone by default)
|
|
|
|
Keyword argument:
|
|
users
|
|
apps
|
|
|
|
"""
|
|
#TODO: fix that
|
|
if not isinstance(users, list): users = [users]
|
|
if not isinstance(apps, list): apps = [apps]
|
|
|
|
installed_apps = os.listdir(apps_setting_path)
|
|
|
|
lemon_conf_lines = {}
|
|
|
|
for installed_app in installed_apps:
|
|
for app in apps:
|
|
if '__' not in app:
|
|
app = app + '__1'
|
|
|
|
if app == installed_app:
|
|
with open(apps_setting_path + installed_app +'/settings.yml') as f:
|
|
app_settings = yaml.load(f)
|
|
|
|
if app_settings['mode'] == 'private':
|
|
if 'allowed_users' in app_settings:
|
|
new_users = app_settings['allowed_users']
|
|
else:
|
|
new_users = ''
|
|
|
|
for allowed_user in users:
|
|
if allowed_user not in new_users.split(' '):
|
|
try:
|
|
user_info(allowed_user)
|
|
except YunoHostError:
|
|
continue
|
|
new_users = new_users +' '+ allowed_user
|
|
|
|
app_settings['allowed_users'] = new_users.strip()
|
|
with open(apps_setting_path + installed_app +'/settings.yml', 'w') as f:
|
|
yaml.safe_dump(app_settings, f, default_flow_style=False)
|
|
win_msg(_("App setting file updated"))
|
|
|
|
lemon_conf_lines[('locationRules', app_settings['domain'], '(?#'+ installed_app +'Z)^'+ app_settings['path'] )] = 'grep( /^$uid$/, qw('+ new_users.strip() +'))'
|
|
|
|
lemon_configuration(lemon_conf_lines)
|
|
|
|
|
|
def app_removeaccess(apps, users):
|
|
"""
|
|
Revoke access right to users (everyone by default)
|
|
|
|
Keyword argument:
|
|
users
|
|
apps
|
|
|
|
"""
|
|
#TODO: fix that
|
|
if not isinstance(users, list): users = [users]
|
|
if not isinstance(apps, list): apps = [apps]
|
|
|
|
installed_apps = os.listdir(apps_setting_path)
|
|
|
|
lemon_conf_lines = {}
|
|
|
|
for installed_app in installed_apps:
|
|
for app in apps:
|
|
new_users = ''
|
|
if '__' not in app:
|
|
app = app + '__1'
|
|
|
|
if app == installed_app:
|
|
with open(apps_setting_path + installed_app +'/settings.yml') as f:
|
|
app_settings = yaml.load(f)
|
|
|
|
if app_settings['mode'] == 'private':
|
|
if 'allowed_users' in app_settings:
|
|
for allowed_user in app_settings['allowed_users'].split(' '):
|
|
if allowed_user not in users:
|
|
new_users = new_users +' '+ allowed_user
|
|
|
|
app_settings['allowed_users'] = new_users.strip()
|
|
with open(apps_setting_path + installed_app +'/settings.yml', 'w') as f:
|
|
yaml.safe_dump(app_settings, f, default_flow_style=False)
|
|
win_msg(_("App setting file updated"))
|
|
|
|
lemon_conf_lines[('locationRules', app_settings['domain'], '(?#'+ installed_app +'Z)^'+ app_settings['path'] )] = 'grep( /^$uid$/, qw('+ new_users.strip() +'))'
|
|
|
|
lemon_configuration(lemon_conf_lines)
|
|
|
|
|
|
def _extract_app_from_file(path):
|
|
"""
|
|
Unzip or untar application tarball in app_tmp_folder, or copy it from a directory
|
|
|
|
Keyword arguments:
|
|
path -- Path of the tarball or directory
|
|
|
|
Returns:
|
|
Dict manifest
|
|
|
|
"""
|
|
if os.path.exists(app_tmp_folder): shutil.rmtree(app_tmp_folder)
|
|
os.makedirs(app_tmp_folder)
|
|
|
|
if ".zip" in path:
|
|
extract_result = os.system('cd '+ os.getcwd() +' && unzip '+ path +' -d '+ app_tmp_folder)
|
|
elif ".tar" in path:
|
|
extract_result = os.system('cd '+ os.getcwd() +' && tar -xf '+ path +' -C '+ app_tmp_folder)
|
|
elif (path[:1] == '/' and os.path.exists(path)) or (os.system('cd '+ os.getcwd() +'/'+ path) == 0):
|
|
shutil.rmtree(app_tmp_folder)
|
|
if path[len(path)-1:] != '/':
|
|
path = path + '/'
|
|
extract_result = os.system('cd '+ os.getcwd() +' && cp -a "'+ path +'" '+ app_tmp_folder)
|
|
else:
|
|
extract_result = 1
|
|
|
|
if extract_result != 0:
|
|
raise YunoHostError(22, _("Invalid install file"))
|
|
|
|
try:
|
|
with open(app_tmp_folder + '/manifest.json') as json_manifest:
|
|
manifest = json.loads(str(json_manifest.read()))
|
|
manifest['lastUpdate'] = int(time.time())
|
|
except IOError:
|
|
raise YunoHostError(1, _("Invalid App file"))
|
|
|
|
win_msg(_("Sources extracted"))
|
|
|
|
return manifest
|
|
|
|
|
|
def _fetch_app_from_git(app):
|
|
"""
|
|
Unzip or untar application tarball in app_tmp_folder
|
|
|
|
Keyword arguments:
|
|
app -- App_id or git repo URL
|
|
|
|
Returns:
|
|
Dict manifest
|
|
|
|
"""
|
|
global app_tmp_folder
|
|
|
|
if ('@' in app) or ('http://' in app) or ('https://' in app):
|
|
git_result = os.system('git clone '+ app +' '+ app_tmp_folder)
|
|
git_result_2 = 0
|
|
try:
|
|
with open(app_tmp_folder + '/manifest.json') as json_manifest:
|
|
manifest = json.loads(str(json_manifest.read()))
|
|
manifest['lastUpdate'] = int(time.time())
|
|
except IOError:
|
|
raise YunoHostError(1, _("Invalid App manifest"))
|
|
|
|
else:
|
|
app_tmp_folder = install_tmp +'/'+ app
|
|
if os.path.exists(app_tmp_folder): shutil.rmtree(app_tmp_folder)
|
|
|
|
app_dict = app_list(raw=True)
|
|
|
|
if app in app_dict:
|
|
app_info = app_dict[app]
|
|
app_info['manifest']['lastUpdate'] = app_info['lastUpdate']
|
|
manifest = app_info['manifest']
|
|
else:
|
|
raise YunoHostError(22, _("App doesn't exists"))
|
|
|
|
git_result = os.system('git clone '+ app_info['git']['url'] +' -b '+ app_info['git']['branch'] +' '+ app_tmp_folder)
|
|
git_result_2 = os.system('cd '+ app_tmp_folder +' && git reset --hard '+ str(app_info['git']['revision']))
|
|
|
|
if not git_result == git_result_2 == 0:
|
|
raise YunoHostError(22, _("Sources fetching failed"))
|
|
|
|
win_msg(_("Repository fetched"))
|
|
|
|
return manifest
|
|
|
|
|
|
def _exec_app_script(step, path, var_dict, parameters):
|
|
"""
|
|
Execute step user script
|
|
|
|
Keyword arguments:
|
|
step -- Name of the script to call regarding the current step (e.g. install|upgrade|remove|etc.)
|
|
path -- Absolute path of the script's directory
|
|
var_dict -- Dictionnary of environnement variable to pass to the script
|
|
parameters -- Parameters to pass to the script
|
|
|
|
"""
|
|
scripts = [ step, step +'.sh', step +'.py' ]
|
|
|
|
for script in scripts:
|
|
script_path = path +'/'+ script
|
|
if os.path.exists(script_path):
|
|
st = os.stat(script_path)
|
|
os.chmod(script_path, st.st_mode | stat.S_IEXEC)
|
|
|
|
user = 'yunohost'
|
|
os.system('chown -R '+ user +': '+ app_tmp_folder)
|
|
|
|
env_vars = ''
|
|
for key, value in var_dict.items():
|
|
env_vars = env_vars + key + "='"+ value +"' "
|
|
|
|
command = 'su - '+ user +' -c "'+ env_vars +' sh '+ path +'/'+ script +'"'
|
|
if os.system(command) == 0:
|
|
win_msg(_("Script executed: ") + script)
|
|
else:
|
|
raise YunoHostError(1, _("Script execution failed: ") + script)
|
|
|
|
break
|
|
|
|
|
|
def _installed_instance_number(app, last=False):
|
|
"""
|
|
Check if application is installed and return instance number
|
|
|
|
Keyword arguments:
|
|
app -- id of App to check
|
|
last -- Return only last instance number
|
|
|
|
Returns:
|
|
Number of last installed instance | List or instances
|
|
|
|
"""
|
|
if last:
|
|
number = 0
|
|
try:
|
|
installed_apps = os.listdir(apps_setting_path)
|
|
except OSError:
|
|
os.makedirs(apps_setting_path)
|
|
return 0
|
|
|
|
for installed_app in installed_apps:
|
|
if '__' in installed_app:
|
|
if app == installed_app[:installed_app.index('__')]:
|
|
if int(installed_app[installed_app.index('__') + 2:]) > number:
|
|
number = int(installed_app[installed_app.index('__') + 2:])
|
|
|
|
return number
|
|
|
|
else:
|
|
instance_number_list = []
|
|
instances_dict = app_map(app=app, raw=True)
|
|
for key, domain in instances_dict.items():
|
|
for key, path in domain.items():
|
|
instance_number_list.append(path['instance'])
|
|
|
|
return sorted(instance_number_list)
|
|
|