Mercurial > libervia-web
annotate libervia/server/tasks.py @ 1154:a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 22 Feb 2019 18:42:47 +0100 |
| parents | 02afab1b15c5 |
| children | 813d54af8c0c |
| rev | line source |
|---|---|
| 1146 | 1 #!/usr/bin/python |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # Libervia: a Salut à Toi frontend | |
| 5 # Copyright (C) 2011-2019 Jérôme Poisson <goffi@goffi.org> | |
| 6 | |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 import os | |
| 20 import os.path | |
| 21 from twisted.internet import defer | |
| 22 from twisted.python.procutils import which | |
| 23 from sat.core import exceptions | |
| 24 from sat.core.i18n import _ | |
| 25 from libervia.server.constants import Const as C | |
| 26 from collections import OrderedDict | |
| 27 from sat.core.log import getLogger | |
| 28 from sat.tools.common import async_process | |
| 29 | |
| 30 log = getLogger(__name__) | |
| 31 | |
| 32 | |
| 33 class TasksManager(object): | |
| 34 """Handle tasks of a Libervia site""" | |
| 35 FILE_EXTS = {u'py'} | |
| 36 | |
| 37 def __init__(self, host, site_resource): | |
| 38 """ | |
| 39 @param site_resource(LiberviaRootResource): root resource of the site to manage | |
| 40 """ | |
| 41 self.host = host | |
| 42 self.resource = site_resource | |
| 43 self.tasks_dir = os.path.join(self.resource.site_path, C.TASKS_DIR) | |
| 44 self.tasks = OrderedDict() | |
| 45 self.parseTasks() | |
| 46 self._build_path = None | |
| 47 self._current_task = None | |
| 48 | |
| 49 @property | |
| 50 def site_path(self): | |
| 51 return self.resource.site_path | |
| 52 | |
| 53 @property | |
| 54 def build_path(self): | |
| 55 """path where generated files will be build for this site""" | |
| 56 if self._build_path is None: | |
| 57 self._build_path = self.host.getBuildPath(self.site_name) | |
| 58 return self._build_path | |
| 59 | |
| 60 def getConfig(self, key, default=None, value_type=None): | |
|
1147
02afab1b15c5
server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager
Goffi <goffi@goffi.org>
parents:
1146
diff
changeset
|
61 return self.host.getConfig(self.resource, key=key, default=default, |
|
02afab1b15c5
server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager
Goffi <goffi@goffi.org>
parents:
1146
diff
changeset
|
62 value_type=value_type) |
| 1146 | 63 |
| 64 @property | |
| 65 def site_name(self): | |
| 66 return self.resource.site_name | |
| 67 | |
| 68 @property | |
| 69 def task_data(self): | |
| 70 return self.tasks[self._current_task][u'data'] | |
| 71 | |
| 72 def validateData(self, data): | |
| 73 """Check values in data""" | |
| 74 | |
| 75 for var, default, allowed in ((u"ON_ERROR", u"stop", (u"continue", u"stop")), | |
| 76 (u"LOG_OUTPUT", True, bool)): | |
| 77 value = data.setdefault(var, default) | |
| 78 if isinstance(allowed, type): | |
| 79 if not isinstance(value, allowed): | |
| 80 raise ValueError( | |
| 81 _(u"Unexpected value for {var}, {allowed} is expected.") | |
| 82 .format(var = var, allowed = allowed)) | |
| 83 else: | |
| 84 if not value in allowed: | |
| 85 raise ValueError(_(u"Unexpected value for {var}: {value}").format( | |
| 86 var = var, value = value)) | |
| 87 | |
| 88 for var, default, allowed in [[u"ON_ERROR", u"stop", (u"continue", u"stop")]]: | |
| 89 value = data.setdefault(var, default) | |
| 90 if not value in allowed: | |
| 91 raise ValueError(_(u"Unexpected value for {var}: {value}").format( | |
| 92 var = var, value = value)) | |
| 93 | |
| 94 def parseTasks(self): | |
| 95 if not os.path.isdir(self.tasks_dir): | |
| 96 log.debug(_(u"{name} has no task to launch.").format( | |
| 97 name = self.resource.site_name or u"default site")) | |
| 98 return | |
| 99 filenames = os.listdir(self.tasks_dir) | |
| 100 filenames.sort() | |
| 101 for filename in filenames: | |
| 102 filepath = os.path.join(self.tasks_dir, filename) | |
| 103 if not filename.startswith(u'task_') or not os.path.isfile(filepath): | |
| 104 continue | |
| 105 task_name, ext = os.path.splitext(filename) | |
| 106 task_name = task_name[5:].lower().strip() | |
| 107 if not task_name: | |
| 108 continue | |
| 109 if ext[1:] not in self.FILE_EXTS: | |
| 110 continue | |
| 111 if task_name in self.tasks: | |
| 112 raise exceptions.ConflictError( | |
| 113 u"A task with the name [{name}] already exists".format( | |
| 114 name=task_name)) | |
| 115 task_data = {u"__name__": "{site_name}.task.{name}".format( | |
| 116 site_name=self.site_name, name=task_name)} | |
| 117 self.tasks[task_name] = { | |
| 118 u'path': filepath, | |
| 119 u'data': task_data, | |
| 120 } | |
| 121 execfile(filepath, task_data) | |
|
1154
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
122 # we launch prepare, which is a method used to prepare |
|
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
123 # data at runtime (e.g. set WATCH_DIRS using config) |
|
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
124 try: |
|
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
125 prepare = task_data['prepare'] |
|
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
126 except KeyError: |
|
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
127 pass |
|
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
128 else: |
|
a1625e68b726
server (tasks): task can now use a "prepare" method to prepare data before running (e.g. WATCH_DIRS)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
129 prepare(self) |
| 1146 | 130 self.validateData(task_data) |
| 131 | |
| 132 @defer.inlineCallbacks | |
| 133 def runTasks(self): | |
| 134 """Run all the tasks found""" | |
| 135 old_path = os.getcwd() | |
| 136 for task_name, task_value in self.tasks.iteritems(): | |
| 137 self._current_task = task_name | |
| 138 log.info(_(u'== running task "{task_name}" for {site_name} =='.format( | |
| 139 task_name=task_name, site_name=self.site_name))) | |
| 140 data = task_value[u'data'] | |
| 141 os.chdir(self.site_path) | |
| 142 try: | |
| 143 yield data['start'](self) | |
| 144 except Exception as e: | |
| 145 on_error = data[u'ON_ERROR'] | |
| 146 if on_error == u'stop': | |
| 147 raise e | |
| 148 elif on_error == u'continue': | |
| 149 log.warning(_(u'Task "{task_name}" failed for {site_name}: {reason}') | |
| 150 .format(task_name = task_name, site_name = self.site_name, reason = e)) | |
| 151 else: | |
| 152 raise exceptions.InternalError(u"we should never reach this point") | |
| 153 self._current_task = None | |
| 154 os.chdir(old_path) | |
| 155 | |
| 156 def findCommand(self, name, *args): | |
| 157 """Find full path of a shell command | |
| 158 | |
| 159 @param name(unicode): name of the command to find | |
| 160 @param *args(unicode): extra names the command may have | |
| 161 @return (unicode): full path of the command | |
| 162 @raise exceptions.NotFound: can't find this command | |
| 163 """ | |
| 164 names = (name,) + args | |
| 165 for n in names: | |
| 166 try: | |
| 167 cmd_path = which(n)[0].encode('utf-8') | |
| 168 except IndexError: | |
| 169 pass | |
| 170 return cmd_path | |
| 171 raise exceptions.NotFound(_( | |
| 172 u"Can't find {name} command, did you install it?").format(name=name)) | |
| 173 | |
| 174 def runCommand(self, command, *args, **kwargs): | |
| 175 kwargs['verbose'] = self.task_data[u"LOG_OUTPUT"] | |
| 176 return async_process.CommandProtocol.run(command, *args, **kwargs) |