Mercurial > libervia-web
annotate libervia/server/tasks/task.py @ 1260:6161076193e0
tasks: dir event filter:
if a Task instance implements `onDirEvent`, it will be called instead of `start`, this way
the task can filter the events or modify the workflow.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 03 May 2020 21:07:22 +0200 |
| parents | 079e8eb6e327 |
| children | a46d0e0f383b |
| rev | line source |
|---|---|
| 1239 | 1 #!/usr/bin/env python3 |
| 2 | |
| 1146 | 3 # Libervia: a Salut à Toi frontend |
| 1237 | 4 # Copyright (C) 2011-2020 Jérôme Poisson <goffi@goffi.org> |
| 1146 | 5 |
| 6 # This program is free software: you can redistribute it and/or modify | |
| 7 # it under the terms of the GNU Affero General Public License as published by | |
| 8 # the Free Software Foundation, either version 3 of the License, or | |
| 9 # (at your option) any later version. | |
| 10 | |
| 11 # This program is distributed in the hope that it will be useful, | |
| 12 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 14 # GNU Affero General Public License for more details. | |
| 15 | |
| 16 # You should have received a copy of the GNU Affero General Public License | |
| 17 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 18 from twisted.python.procutils import which | |
| 1245 | 19 from sat.core.log import getLogger |
| 20 from sat.tools.common import async_process | |
| 1146 | 21 from sat.core import exceptions |
| 22 from sat.core.i18n import _ | |
| 1245 | 23 from typing import Optional |
| 1146 | 24 |
| 25 log = getLogger(__name__) | |
| 26 | |
| 27 | |
| 1245 | 28 class Task: |
| 1146 | 29 """Handle tasks of a Libervia site""" |
| 1245 | 30 # can be "stop" or "continue" |
| 31 ON_ERROR: str = "stop" | |
| 32 LOG_OUTPUT: bool = True | |
| 33 # list of directories to check for restarting this task | |
| 1260 | 34 # Task.onDirEvent will be called if it exists, otherwise |
| 35 # the task will be run and Task.start will be called | |
| 1245 | 36 WATCH_DIRS: Optional[list] = None |
| 1146 | 37 |
| 1245 | 38 def __init__(self, manager): |
| 39 self.manager = manager | |
| 40 | |
| 41 @property | |
| 42 def host(self): | |
| 43 return self.manager.host | |
| 44 | |
| 45 @property | |
| 46 def resource(self): | |
| 47 return self.manager.resource | |
| 1146 | 48 |
| 49 @property | |
| 50 def site_path(self): | |
| 1245 | 51 return self.manager.site_path |
| 1146 | 52 |
| 53 @property | |
| 54 def build_path(self): | |
| 55 """path where generated files will be build for this site""" | |
| 1245 | 56 return self.manager.build_path |
| 1146 | 57 |
| 58 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
|
59 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
|
60 value_type=value_type) |
| 1146 | 61 |
| 62 @property | |
| 63 def site_name(self): | |
| 64 return self.resource.site_name | |
| 65 | |
| 66 def findCommand(self, name, *args): | |
| 67 """Find full path of a shell command | |
| 68 | |
| 69 @param name(unicode): name of the command to find | |
| 70 @param *args(unicode): extra names the command may have | |
| 71 @return (unicode): full path of the command | |
| 72 @raise exceptions.NotFound: can't find this command | |
| 73 """ | |
| 74 names = (name,) + args | |
| 75 for n in names: | |
| 76 try: | |
| 1216 | 77 cmd_path = which(n)[0] |
| 1146 | 78 except IndexError: |
| 79 pass | |
|
1189
170802865156
server (tasks): fixed findCommand when first name can't be found
Goffi <goffi@goffi.org>
parents:
1166
diff
changeset
|
80 else: |
|
170802865156
server (tasks): fixed findCommand when first name can't be found
Goffi <goffi@goffi.org>
parents:
1166
diff
changeset
|
81 return cmd_path |
| 1146 | 82 raise exceptions.NotFound(_( |
| 1216 | 83 "Can't find {name} command, did you install it?").format(name=name)) |
| 1146 | 84 |
| 85 def runCommand(self, command, *args, **kwargs): | |
| 1245 | 86 kwargs['verbose'] = self.LOG_OUTPUT |
| 1146 | 87 return async_process.CommandProtocol.run(command, *args, **kwargs) |