author | Sylvain Thénault <sylvain.thenault@logilab.fr> |
Mon, 21 Dec 2009 20:04:33 +0100 | |
changeset 4162 | d2663bcf5306 |
parent 4135 | cb0d0bf255f7 |
child 4181 | c79135c217df |
permissions | -rw-r--r-- |
369
c8a6edc224bb
new rsetxml view, reusing most code from csvexport view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
180
diff
changeset
|
1 |
# -*- coding: utf-8 -*- |
0 | 2 |
"""common configuration utilities for cubicweb |
3 |
||
4 |
:organization: Logilab |
|
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1948
diff
changeset
|
5 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2. |
0 | 6 |
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr |
1493 | 7 |
|
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
8 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
9 |
If cubicweb is a mercurial checkout (eg `CWDEV` is true), located in |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
10 |
`CW_SOFTWARE_ROOT`: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
11 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
12 |
* main cubes directory is `<CW_SOFTWARE_ROOT>/../cubes`. You can specify |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
13 |
another one with `CW_INSTANCES_DIR` environment variable or simply add some |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
14 |
other directories by using `CW_CUBES_PATH`. |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
15 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
16 |
* cubicweb migration files are by default searched in |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
17 |
`<CW_SOFTWARE_ROOT>/misc/migration` instead of |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
18 |
`/usr/share/cubicweb/migration/`(unless another emplacement is specified |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
19 |
using `CW_MIGRATION_DIR`. |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
20 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
21 |
* Cubicweb will start in 'user' mode (see below) |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
22 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
23 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
24 |
On startup, Cubicweb is using a specific *mode*. A mode corresponds to some |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
25 |
default setting for various resource directories. There are currently 2 main |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
26 |
modes : 'system', for system wide installation, and 'user', fur user local |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
27 |
installation (e.g. no root privileges). |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
28 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
29 |
'user' mode is activated automatically when cubicweb is a mercurial checkout |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
30 |
(e.g. has a .hg directory). You can also force mode by using the `CW_MODE` |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
31 |
environment variable, to: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
32 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
33 |
* use system wide installation but user specific instances and all, without root |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
34 |
privileges on the system (`export CW_MODE=user`) |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
35 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
36 |
* use local checkout of cubicweb on system wide instances (requires root |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
37 |
privileges on the system (`export CW_MODE=system`) |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
38 |
|
3639 | 39 |
Here is the default resource directories settings according to mode: |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
40 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
41 |
* 'system': :: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
42 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
43 |
CW_INSTANCES_DIR = /etc/cubicweb.d/ |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
44 |
CW_INSTANCES_DATA_DIR = /var/lib/cubicweb/instances/ |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
45 |
CW_RUNTIME_DIR = /var/run/cubicweb/ |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
46 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
47 |
* 'user': :: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
48 |
|
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
49 |
CW_INSTANCES_DIR = ~/etc/cubicweb.d/ |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
50 |
CW_INSTANCES_DATA_DIR = ~/etc/cubicweb.d/ |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
51 |
CW_RUNTIME_DIR = /tmp |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
52 |
|
3639 | 53 |
|
54 |
.. envvar:: CW_MODE |
|
55 |
Resource mode: user or system |
|
56 |
||
1493 | 57 |
.. envvar:: CW_CUBES_PATH |
3639 | 58 |
Augments the default search path for cubes |
59 |
||
60 |
.. envvar:: CW_INSTANCES_DIR |
|
61 |
Directory where cubicweb instances will be found |
|
1493 | 62 |
|
3639 | 63 |
.. envvar:: CW_INSTANCES_DATA_DIR |
64 |
Directory where cubicweb instances data will be written |
|
65 |
||
66 |
.. envvar:: CW_RUNTIME_DIR |
|
67 |
Directory where pid files will be written |
|
68 |
||
69 |
.. envvar:: CW_MIGRATION_DIR |
|
70 |
Directory where cubicweb migration files will be found |
|
71 |
||
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1681
diff
changeset
|
72 |
|
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1948
diff
changeset
|
73 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
0 | 74 |
""" |
75 |
__docformat__ = "restructuredtext en" |
|
1948 | 76 |
_ = unicode |
0 | 77 |
|
78 |
import sys |
|
79 |
import os |
|
80 |
import logging |
|
4135
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
81 |
import tempfile |
2221
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
82 |
from smtplib import SMTP |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
83 |
from threading import Lock |
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
84 |
from os.path import exists, join, expanduser, abspath, normpath, basename, isdir |
4135
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
85 |
from warnings import warn |
0 | 86 |
|
87 |
from logilab.common.decorators import cached |
|
2613
5e19c2bb370e
R [all] logilab.common 0.44 provides only deprecated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2476
diff
changeset
|
88 |
from logilab.common.deprecation import deprecated |
180
8bcebdb5f55d
code moved to logilab.common.logging_ext
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
140
diff
changeset
|
89 |
from logilab.common.logging_ext import set_log_methods, init_log |
0 | 90 |
from logilab.common.configuration import (Configuration, Method, |
91 |
ConfigurationMixIn, merge_options) |
|
92 |
||
93 |
from cubicweb import CW_SOFTWARE_ROOT, CW_MIGRATION_MAP, ConfigurationError |
|
1132 | 94 |
from cubicweb.toolsutils import env_path, create_dir |
0 | 95 |
|
96 |
CONFIGURATIONS = [] |
|
97 |
||
2221
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
98 |
SMTP_LOCK = Lock() |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
99 |
|
0 | 100 |
|
101 |
class metaconfiguration(type): |
|
102 |
"""metaclass to automaticaly register configuration""" |
|
103 |
def __new__(mcs, name, bases, classdict): |
|
104 |
cls = super(metaconfiguration, mcs).__new__(mcs, name, bases, classdict) |
|
105 |
if classdict.get('name'): |
|
106 |
CONFIGURATIONS.append(cls) |
|
107 |
return cls |
|
108 |
||
109 |
def configuration_cls(name): |
|
110 |
"""return the configuration class registered with the given name""" |
|
111 |
try: |
|
112 |
return [c for c in CONFIGURATIONS if c.name == name][0] |
|
113 |
except IndexError: |
|
114 |
raise ConfigurationError('no such config %r (check it exists with "cubicweb-ctl list")' % name) |
|
115 |
||
116 |
def possible_configurations(directory): |
|
117 |
"""return a list of installed configurations in a directory |
|
118 |
according to *-ctl files |
|
119 |
""" |
|
120 |
return [name for name in ('repository', 'twisted', 'all-in-one') |
|
121 |
if exists(join(directory, '%s.conf' % name))] |
|
122 |
||
123 |
def guess_configuration(directory): |
|
124 |
"""try to guess the configuration to use for a directory. If multiple |
|
125 |
configurations are found, ConfigurationError is raised |
|
126 |
""" |
|
127 |
modes = possible_configurations(directory) |
|
128 |
if len(modes) != 1: |
|
129 |
raise ConfigurationError('unable to guess configuration from %r %s' |
|
130 |
% (directory, modes)) |
|
131 |
return modes[0] |
|
132 |
||
133 |
||
134 |
# persistent options definition |
|
135 |
PERSISTENT_OPTIONS = ( |
|
136 |
('encoding', |
|
137 |
{'type' : 'string', |
|
138 |
'default': 'UTF-8', |
|
139 |
'help': _('user interface encoding'), |
|
140 |
'group': 'ui', 'sitewide': True, |
|
1446 | 141 |
}), |
0 | 142 |
('language', |
143 |
{'type' : 'string', |
|
144 |
'default': 'en', |
|
145 |
'vocabulary': Method('available_languages'), |
|
146 |
'help': _('language of the user interface'), |
|
1446 | 147 |
'group': 'ui', |
0 | 148 |
}), |
149 |
('date-format', |
|
150 |
{'type' : 'string', |
|
151 |
'default': '%Y/%m/%d', |
|
152 |
'help': _('how to format date in the ui ("man strftime" for format description)'), |
|
1446 | 153 |
'group': 'ui', |
0 | 154 |
}), |
155 |
('datetime-format', |
|
156 |
{'type' : 'string', |
|
157 |
'default': '%Y/%m/%d %H:%M', |
|
158 |
'help': _('how to format date and time in the ui ("man strftime" for format description)'), |
|
1446 | 159 |
'group': 'ui', |
0 | 160 |
}), |
161 |
('time-format', |
|
162 |
{'type' : 'string', |
|
163 |
'default': '%H:%M', |
|
164 |
'help': _('how to format time in the ui ("man strftime" for format description)'), |
|
1446 | 165 |
'group': 'ui', |
0 | 166 |
}), |
167 |
('float-format', |
|
168 |
{'type' : 'string', |
|
169 |
'default': '%.3f', |
|
170 |
'help': _('how to format float numbers in the ui'), |
|
1446 | 171 |
'group': 'ui', |
0 | 172 |
}), |
173 |
('default-text-format', |
|
174 |
{'type' : 'choice', |
|
175 |
'choices': ('text/plain', 'text/rest', 'text/html'), |
|
176 |
'default': 'text/html', # use fckeditor in the web ui |
|
177 |
'help': _('default text format for rich text fields.'), |
|
1446 | 178 |
'group': 'ui', |
0 | 179 |
}), |
180 |
('short-line-size', |
|
181 |
{'type' : 'int', |
|
182 |
'default': 40, |
|
183 |
'help': _('maximum number of characters in short description'), |
|
184 |
'group': 'navigation', |
|
185 |
}), |
|
186 |
) |
|
187 |
||
188 |
def register_persistent_options(options): |
|
189 |
global PERSISTENT_OPTIONS |
|
190 |
PERSISTENT_OPTIONS = merge_options(PERSISTENT_OPTIONS + options) |
|
1446 | 191 |
|
0 | 192 |
CFGTYPE2ETYPE_MAP = { |
193 |
'string': 'String', |
|
194 |
'choice': 'String', |
|
195 |
'yn': 'Boolean', |
|
196 |
'int': 'Int', |
|
197 |
'float' : 'Float', |
|
198 |
} |
|
1446 | 199 |
|
3059
1be8bf42bc5d
consider CW_MODE='system', the opposite of 'user' (eg use 'installed' mode while using the forest)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2762
diff
changeset
|
200 |
_forced_mode = os.environ.get('CW_MODE') |
1be8bf42bc5d
consider CW_MODE='system', the opposite of 'user' (eg use 'installed' mode while using the forest)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2762
diff
changeset
|
201 |
assert _forced_mode in (None, 'system', 'user') |
1be8bf42bc5d
consider CW_MODE='system', the opposite of 'user' (eg use 'installed' mode while using the forest)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2762
diff
changeset
|
202 |
|
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
203 |
CWDEV = exists(join(CW_SOFTWARE_ROOT, '.hg')) |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
204 |
|
0 | 205 |
class CubicWebNoAppConfiguration(ConfigurationMixIn): |
206 |
"""base class for cubicweb configuration without a specific instance directory |
|
207 |
""" |
|
208 |
__metaclass__ = metaconfiguration |
|
209 |
# to set in concrete configuration |
|
210 |
name = None |
|
211 |
# log messages format (see logging module documentation for available keys) |
|
212 |
log_format = '%(asctime)s - (%(name)s) %(levelname)s: %(message)s' |
|
2657
de974465d381
[appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2654
diff
changeset
|
213 |
# nor remove appobjects based on unused interface |
0 | 214 |
cleanup_interface_sobjects = True |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
215 |
# debug mode |
3641
cf30e4498674
fix debug attribute conflict on configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3640
diff
changeset
|
216 |
debugmode = False |
0 | 217 |
|
218 |
if os.environ.get('APYCOT_ROOT'): |
|
219 |
mode = 'test' |
|
3915
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
220 |
if CWDEV: |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
221 |
CUBES_DIR = '%(APYCOT_ROOT)s/local/share/cubicweb/cubes/' % os.environ |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
222 |
# create __init__ file |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
223 |
file(join(CUBES_DIR, '__init__.py'), 'w').close() |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
224 |
else: |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
225 |
CUBES_DIR = '/usr/share/cubicweb/cubes/' |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
226 |
elif (CWDEV and _forced_mode != 'system'): |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
227 |
mode = 'user' |
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
228 |
CUBES_DIR = abspath(normpath(join(CW_SOFTWARE_ROOT, '../cubes'))) |
0 | 229 |
else: |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
230 |
if _forced_mode == 'user': |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
231 |
mode = 'user' |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
232 |
else: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
233 |
mode = 'system' |
0 | 234 |
CUBES_DIR = '/usr/share/cubicweb/cubes/' |
235 |
||
1046
52ee022d87e3
simplify registry options to disable some appobjects to use a single option
sylvain.thenault@logilab.fr
parents:
819
diff
changeset
|
236 |
options = ( |
0 | 237 |
('log-threshold', |
238 |
{'type' : 'string', # XXX use a dedicated type? |
|
239 |
'default': 'ERROR', |
|
240 |
'help': 'server\'s log level', |
|
241 |
'group': 'main', 'inputlevel': 1, |
|
242 |
}), |
|
3539
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
243 |
# pyro options |
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
244 |
('pyro-instance-id', |
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
245 |
{'type' : 'string', |
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
246 |
'default': Method('default_instance_id'), |
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
247 |
'help': 'identifier of the CubicWeb instance in the Pyro name server', |
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
248 |
'group': 'pyro', 'inputlevel': 1, |
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
249 |
}), |
0 | 250 |
('pyro-ns-host', |
251 |
{'type' : 'string', |
|
378
c0cd7398edff
revert local debug checkin
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
369
diff
changeset
|
252 |
'default': '', |
0 | 253 |
'help': 'Pyro name server\'s host. If not set, will be detected by a \ |
2665
0c6281487f90
[pyro] use lgc.pyro_ext, simplify pyro related options
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2657
diff
changeset
|
254 |
broadcast query. It may contains port information using <host>:<port> notation.', |
3539
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
255 |
'group': 'pyro', 'inputlevel': 1, |
0 | 256 |
}), |
257 |
('pyro-ns-group', |
|
258 |
{'type' : 'string', |
|
259 |
'default': 'cubicweb', |
|
260 |
'help': 'Pyro name server\'s group where the repository will be \ |
|
261 |
registered.', |
|
3539
f3b14d052798
[pyro] merge pyro-id / pyro-instance-id options, put all pyro options in the same section of the configuration file
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3275
diff
changeset
|
262 |
'group': 'pyro', 'inputlevel': 1, |
0 | 263 |
}), |
264 |
# common configuration options which are potentially required as soon as |
|
265 |
# you're using "base" application objects (ie to really server/web |
|
266 |
# specific) |
|
267 |
('base-url', |
|
268 |
{'type' : 'string', |
|
269 |
'default': None, |
|
270 |
'help': 'web server root url', |
|
271 |
'group': 'main', 'inputlevel': 1, |
|
272 |
}), |
|
2267
e1d2df3f1091
move login by email functionnality on the repository side to avoid buggy call to internal_session from the web interface side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2221
diff
changeset
|
273 |
('allow-email-login', |
e1d2df3f1091
move login by email functionnality on the repository side to avoid buggy call to internal_session from the web interface side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2221
diff
changeset
|
274 |
{'type' : 'yn', |
e1d2df3f1091
move login by email functionnality on the repository side to avoid buggy call to internal_session from the web interface side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2221
diff
changeset
|
275 |
'default': False, |
e1d2df3f1091
move login by email functionnality on the repository side to avoid buggy call to internal_session from the web interface side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2221
diff
changeset
|
276 |
'help': 'allow users to login with their primary email if set', |
e1d2df3f1091
move login by email functionnality on the repository side to avoid buggy call to internal_session from the web interface side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2221
diff
changeset
|
277 |
'group': 'main', 'inputlevel': 2, |
e1d2df3f1091
move login by email functionnality on the repository side to avoid buggy call to internal_session from the web interface side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2221
diff
changeset
|
278 |
}), |
1520
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
279 |
('use-request-subdomain', |
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
280 |
{'type' : 'yn', |
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
281 |
'default': None, |
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
282 |
'help': ('if set, base-url subdomain is replaced by the request\'s ' |
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
283 |
'host, to help managing sites with several subdomains in a ' |
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
284 |
'single cubicweb instance'), |
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
285 |
'group': 'main', 'inputlevel': 1, |
b097057e629d
provide an option to substitute the base-url (left-most part) subdomain by the one of the current http query to easy multiple subdomains website management
Florent <florent@secondweb.fr>
parents:
1446
diff
changeset
|
286 |
}), |
0 | 287 |
('mangle-emails', |
288 |
{'type' : 'yn', |
|
289 |
'default': False, |
|
290 |
'help': "don't display actual email addresses but mangle them if \ |
|
291 |
this option is set to yes", |
|
292 |
'group': 'email', 'inputlevel': 2, |
|
293 |
}), |
|
1046
52ee022d87e3
simplify registry options to disable some appobjects to use a single option
sylvain.thenault@logilab.fr
parents:
819
diff
changeset
|
294 |
('disable-appobjects', |
52ee022d87e3
simplify registry options to disable some appobjects to use a single option
sylvain.thenault@logilab.fr
parents:
819
diff
changeset
|
295 |
{'type' : 'csv', 'default': (), |
52ee022d87e3
simplify registry options to disable some appobjects to use a single option
sylvain.thenault@logilab.fr
parents:
819
diff
changeset
|
296 |
'help': 'comma separated list of identifiers of application objects (<registry>.<oid>) to disable', |
52ee022d87e3
simplify registry options to disable some appobjects to use a single option
sylvain.thenault@logilab.fr
parents:
819
diff
changeset
|
297 |
'group': 'appobjects', 'inputlevel': 2, |
52ee022d87e3
simplify registry options to disable some appobjects to use a single option
sylvain.thenault@logilab.fr
parents:
819
diff
changeset
|
298 |
}), |
0 | 299 |
) |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
300 |
# static and class methods used to get instance independant resources ## |
1446 | 301 |
|
0 | 302 |
@staticmethod |
303 |
def cubicweb_version(): |
|
304 |
"""return installed cubicweb version""" |
|
305 |
from logilab.common.changelog import Version |
|
306 |
from cubicweb import __pkginfo__ |
|
307 |
version = __pkginfo__.numversion |
|
308 |
assert len(version) == 3, version |
|
309 |
return Version(version) |
|
1446 | 310 |
|
0 | 311 |
@staticmethod |
312 |
def persistent_options_configuration(): |
|
313 |
return Configuration(options=PERSISTENT_OPTIONS) |
|
314 |
||
315 |
@classmethod |
|
316 |
def shared_dir(cls): |
|
317 |
"""return the shared data directory (i.e. directory where standard |
|
318 |
library views and data may be found) |
|
319 |
""" |
|
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
320 |
if CWDEV: |
0 | 321 |
return join(CW_SOFTWARE_ROOT, 'web') |
1039 | 322 |
return cls.cube_dir('shared') |
1446 | 323 |
|
0 | 324 |
@classmethod |
325 |
def i18n_lib_dir(cls): |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
326 |
"""return instance's i18n directory""" |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
327 |
if CWDEV: |
0 | 328 |
return join(CW_SOFTWARE_ROOT, 'i18n') |
329 |
return join(cls.shared_dir(), 'i18n') |
|
330 |
||
331 |
@classmethod |
|
332 |
def available_cubes(cls): |
|
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
333 |
cubes = set() |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
334 |
for directory in cls.cubes_search_path(): |
4001
bc31ede2085d
dont crash if directory doesn't exist
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3915
diff
changeset
|
335 |
if not os.path.exists(directory): |
bc31ede2085d
dont crash if directory doesn't exist
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3915
diff
changeset
|
336 |
self.error('unexistant directory in cubes search path: %s' |
bc31ede2085d
dont crash if directory doesn't exist
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3915
diff
changeset
|
337 |
% directory) |
bc31ede2085d
dont crash if directory doesn't exist
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3915
diff
changeset
|
338 |
continue |
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
339 |
for cube in os.listdir(directory): |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
340 |
if isdir(join(directory, cube)) and not cube == 'shared': |
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
341 |
cubes.add(cube) |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
342 |
return sorted(cubes) |
1446 | 343 |
|
0 | 344 |
@classmethod |
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
345 |
def cubes_search_path(cls): |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
346 |
"""return the path of directories where cubes should be searched""" |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
347 |
path = [] |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
348 |
try: |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
349 |
for directory in os.environ['CW_CUBES_PATH'].split(os.pathsep): |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
350 |
directory = abspath(normpath(directory)) |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
351 |
if exists(directory) and not directory in path: |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
352 |
path.append(directory) |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
353 |
except KeyError: |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
354 |
pass |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
355 |
if not cls.CUBES_DIR in path: |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
356 |
path.append(cls.CUBES_DIR) |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
357 |
return path |
1446 | 358 |
|
0 | 359 |
@classmethod |
360 |
def cube_dir(cls, cube): |
|
361 |
"""return the cube directory for the given cube id, |
|
362 |
raise ConfigurationError if it doesn't exists |
|
363 |
""" |
|
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
364 |
for directory in cls.cubes_search_path(): |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
365 |
cubedir = join(directory, cube) |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
366 |
if exists(cubedir): |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
367 |
return cubedir |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
368 |
raise ConfigurationError('no cube %s in %s' % (cube, cls.cubes_search_path())) |
0 | 369 |
|
370 |
@classmethod |
|
371 |
def cube_migration_scripts_dir(cls, cube): |
|
372 |
"""cube migration scripts directory""" |
|
373 |
return join(cls.cube_dir(cube), 'migration') |
|
1446 | 374 |
|
0 | 375 |
@classmethod |
376 |
def cube_pkginfo(cls, cube): |
|
377 |
"""return the information module for the given cube""" |
|
378 |
cube = CW_MIGRATION_MAP.get(cube, cube) |
|
379 |
try: |
|
380 |
return getattr(__import__('cubes.%s.__pkginfo__' % cube), cube).__pkginfo__ |
|
140
478bdd15bc0e
more error resilient
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
0
diff
changeset
|
381 |
except Exception, ex: |
0 | 382 |
raise ConfigurationError('unable to find packaging information for ' |
140
478bdd15bc0e
more error resilient
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
0
diff
changeset
|
383 |
'cube %s (%s: %s)' % (cube, ex.__class__.__name__, ex)) |
0 | 384 |
|
385 |
@classmethod |
|
386 |
def cube_version(cls, cube): |
|
1446 | 387 |
"""return the version of the cube located in the given directory |
0 | 388 |
""" |
389 |
from logilab.common.changelog import Version |
|
390 |
version = cls.cube_pkginfo(cube).numversion |
|
391 |
assert len(version) == 3, version |
|
392 |
return Version(version) |
|
393 |
||
394 |
@classmethod |
|
395 |
def cube_dependencies(cls, cube): |
|
396 |
"""return cubicweb cubes used by the given cube""" |
|
397 |
return getattr(cls.cube_pkginfo(cube), '__use__', ()) |
|
398 |
||
399 |
@classmethod |
|
400 |
def cube_recommends(cls, cube): |
|
401 |
"""return cubicweb cubes recommended by the given cube""" |
|
402 |
return getattr(cls.cube_pkginfo(cube), '__recommend__', ()) |
|
403 |
||
404 |
@classmethod |
|
2762
b1bb33b37992
[config] new with_recommends option to expand_cubes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2665
diff
changeset
|
405 |
def expand_cubes(cls, cubes, with_recommends=False): |
0 | 406 |
"""expand the given list of top level cubes used by adding recursivly |
407 |
each cube dependencies |
|
408 |
""" |
|
409 |
cubes = list(cubes) |
|
410 |
todo = cubes[:] |
|
411 |
while todo: |
|
412 |
cube = todo.pop(0) |
|
413 |
for depcube in cls.cube_dependencies(cube): |
|
414 |
if depcube not in cubes: |
|
415 |
depcube = CW_MIGRATION_MAP.get(depcube, depcube) |
|
416 |
cubes.append(depcube) |
|
417 |
todo.append(depcube) |
|
2762
b1bb33b37992
[config] new with_recommends option to expand_cubes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2665
diff
changeset
|
418 |
if with_recommends: |
b1bb33b37992
[config] new with_recommends option to expand_cubes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2665
diff
changeset
|
419 |
for depcube in cls.cube_recommends(cube): |
b1bb33b37992
[config] new with_recommends option to expand_cubes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2665
diff
changeset
|
420 |
if depcube not in cubes: |
b1bb33b37992
[config] new with_recommends option to expand_cubes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2665
diff
changeset
|
421 |
depcube = CW_MIGRATION_MAP.get(depcube, depcube) |
b1bb33b37992
[config] new with_recommends option to expand_cubes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2665
diff
changeset
|
422 |
cubes.append(depcube) |
b1bb33b37992
[config] new with_recommends option to expand_cubes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2665
diff
changeset
|
423 |
todo.append(depcube) |
0 | 424 |
return cubes |
425 |
||
426 |
@classmethod |
|
427 |
def reorder_cubes(cls, cubes): |
|
428 |
"""reorder cubes from the top level cubes to inner dependencies |
|
429 |
cubes |
|
430 |
""" |
|
431 |
from logilab.common.graph import get_cycles |
|
432 |
graph = {} |
|
433 |
for cube in cubes: |
|
434 |
cube = CW_MIGRATION_MAP.get(cube, cube) |
|
435 |
deps = cls.cube_dependencies(cube) + \ |
|
436 |
cls.cube_recommends(cube) |
|
437 |
graph[cube] = set(dep for dep in deps if dep in cubes) |
|
438 |
cycles = get_cycles(graph) |
|
439 |
if cycles: |
|
440 |
cycles = '\n'.join(' -> '.join(cycle) for cycle in cycles) |
|
441 |
raise ConfigurationError('cycles in cubes dependencies: %s' |
|
442 |
% cycles) |
|
443 |
cubes = [] |
|
444 |
while graph: |
|
445 |
# sorted to get predictable results |
|
446 |
for cube, deps in sorted(graph.items()): |
|
447 |
if not deps: |
|
448 |
cubes.append(cube) |
|
449 |
del graph[cube] |
|
450 |
for deps in graph.itervalues(): |
|
451 |
try: |
|
452 |
deps.remove(cube) |
|
453 |
except KeyError: |
|
454 |
continue |
|
455 |
return tuple(reversed(cubes)) |
|
1446 | 456 |
|
0 | 457 |
@classmethod |
458 |
def cls_adjust_sys_path(cls): |
|
459 |
"""update python path if necessary""" |
|
1023
278f997aa257
fix sys.path adjustment
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1015
diff
changeset
|
460 |
cubes_parent_dir = normpath(join(cls.CUBES_DIR, '..')) |
278f997aa257
fix sys.path adjustment
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1015
diff
changeset
|
461 |
if not cubes_parent_dir in sys.path: |
278f997aa257
fix sys.path adjustment
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1015
diff
changeset
|
462 |
sys.path.insert(0, cubes_parent_dir) |
0 | 463 |
try: |
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
464 |
import cubes |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
465 |
cubes.__path__ = cls.cubes_search_path() |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
466 |
except ImportError: |
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
467 |
return # cubes dir doesn't exists |
0 | 468 |
|
469 |
@classmethod |
|
470 |
def load_cwctl_plugins(cls): |
|
471 |
from logilab.common.modutils import load_module_from_file |
|
472 |
cls.cls_adjust_sys_path() |
|
473 |
for ctlfile in ('web/webctl.py', 'etwist/twctl.py', |
|
474 |
'server/serverctl.py', 'hercule.py', |
|
475 |
'devtools/devctl.py', 'goa/goactl.py'): |
|
476 |
if exists(join(CW_SOFTWARE_ROOT, ctlfile)): |
|
3269
02a918f108a7
prevent some command providers to stop using cubicweb-ctl (current case : goactl when vobject is not there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3118
diff
changeset
|
477 |
try: |
02a918f108a7
prevent some command providers to stop using cubicweb-ctl (current case : goactl when vobject is not there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3118
diff
changeset
|
478 |
load_module_from_file(join(CW_SOFTWARE_ROOT, ctlfile)) |
02a918f108a7
prevent some command providers to stop using cubicweb-ctl (current case : goactl when vobject is not there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3118
diff
changeset
|
479 |
except ImportError, err: |
3270
ae43a0ddc1d9
warning -> critical, also allow goa to work without vobject
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3269
diff
changeset
|
480 |
cls.critical('could not import the command provider %s (cause : %s)' % |
3269
02a918f108a7
prevent some command providers to stop using cubicweb-ctl (current case : goactl when vobject is not there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3118
diff
changeset
|
481 |
(ctlfile, err)) |
0 | 482 |
cls.info('loaded cubicweb-ctl plugin %s', ctlfile) |
483 |
for cube in cls.available_cubes(): |
|
4135
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
484 |
oldpluginfile = join(cls.cube_dir(cube), 'ecplugin.py') |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
485 |
pluginfile = join(cls.cube_dir(cube), 'ccplugin.py') |
1015
b5fdad9208f8
search for cubes in a list of directories
sylvain.thenault@logilab.fr
parents:
436
diff
changeset
|
486 |
initfile = join(cls.cube_dir(cube), '__init__.py') |
0 | 487 |
if exists(pluginfile): |
488 |
try: |
|
4135
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
489 |
__import__('cubes.%s.ccplugin' % cube) |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
490 |
cls.info('loaded cubicweb-ctl plugin from %s', cube) |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
491 |
except: |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
492 |
cls.exception('while loading plugin %s', pluginfile) |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
493 |
elif exists(oldpluginfile): |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
494 |
warn('[3.6] %s: ecplugin module should be renamed to ccplugin' % cube, |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
495 |
DeprecationWarning) |
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
496 |
try: |
0 | 497 |
__import__('cubes.%s.ecplugin' % cube) |
498 |
cls.info('loaded cubicweb-ctl plugin from %s', cube) |
|
499 |
except: |
|
4135
cb0d0bf255f7
look for cubicweb-ctl plugins in the ccplugin.py file, keeping bw compat on ecplugin.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
500 |
cls.exception('while loading plugin %s', oldpluginfile) |
0 | 501 |
elif exists(initfile): |
502 |
try: |
|
503 |
__import__('cubes.%s' % cube) |
|
504 |
except: |
|
505 |
cls.exception('while loading cube %s', cube) |
|
506 |
else: |
|
1446 | 507 |
cls.warning('no __init__ file in cube %s', cube) |
0 | 508 |
|
509 |
@classmethod |
|
510 |
def init_available_cubes(cls): |
|
511 |
"""cubes may register some sources (svnfile for instance) in their |
|
512 |
__init__ file, so they should be loaded early in the startup process |
|
513 |
""" |
|
514 |
for cube in cls.available_cubes(): |
|
515 |
try: |
|
516 |
__import__('cubes.%s' % cube) |
|
517 |
except Exception, ex: |
|
518 |
cls.warning("can't init cube %s: %s", cube, ex) |
|
1446 | 519 |
|
2657
de974465d381
[appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2654
diff
changeset
|
520 |
cubicweb_appobject_path = set(['entities']) |
de974465d381
[appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2654
diff
changeset
|
521 |
cube_appobject_path = set(['entities']) |
0 | 522 |
|
523 |
@classmethod |
|
524 |
def build_vregistry_path(cls, templpath, evobjpath=None, tvobjpath=None): |
|
525 |
"""given a list of directories, return a list of sub files and |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
526 |
directories that should be loaded by the instance objects registry. |
0 | 527 |
|
528 |
:param evobjpath: |
|
529 |
optional list of sub-directories (or files without the .py ext) of |
|
530 |
the cubicweb library that should be tested and added to the output list |
|
2657
de974465d381
[appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2654
diff
changeset
|
531 |
if they exists. If not give, default to `cubicweb_appobject_path` class |
0 | 532 |
attribute. |
533 |
:param tvobjpath: |
|
534 |
optional list of sub-directories (or files without the .py ext) of |
|
535 |
directories given in `templpath` that should be tested and added to |
|
536 |
the output list if they exists. If not give, default to |
|
2657
de974465d381
[appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2654
diff
changeset
|
537 |
`cube_appobject_path` class attribute. |
0 | 538 |
""" |
539 |
vregpath = cls.build_vregistry_cubicweb_path(evobjpath) |
|
540 |
vregpath += cls.build_vregistry_cube_path(templpath, tvobjpath) |
|
541 |
return vregpath |
|
542 |
||
543 |
@classmethod |
|
544 |
def build_vregistry_cubicweb_path(cls, evobjpath=None): |
|
545 |
vregpath = [] |
|
546 |
if evobjpath is None: |
|
2657
de974465d381
[appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2654
diff
changeset
|
547 |
evobjpath = cls.cubicweb_appobject_path |
0 | 548 |
for subdir in evobjpath: |
549 |
path = join(CW_SOFTWARE_ROOT, subdir) |
|
550 |
if exists(path): |
|
551 |
vregpath.append(path) |
|
552 |
return vregpath |
|
553 |
||
554 |
@classmethod |
|
555 |
def build_vregistry_cube_path(cls, templpath, tvobjpath=None): |
|
556 |
vregpath = [] |
|
557 |
if tvobjpath is None: |
|
2657
de974465d381
[appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2654
diff
changeset
|
558 |
tvobjpath = cls.cube_appobject_path |
0 | 559 |
for directory in templpath: |
560 |
for subdir in tvobjpath: |
|
561 |
path = join(directory, subdir) |
|
562 |
if exists(path): |
|
563 |
vregpath.append(path) |
|
564 |
elif exists(path + '.py'): |
|
565 |
vregpath.append(path + '.py') |
|
566 |
return vregpath |
|
1446 | 567 |
|
0 | 568 |
def __init__(self): |
4023
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
569 |
register_stored_procedures() |
0 | 570 |
ConfigurationMixIn.__init__(self) |
571 |
self.adjust_sys_path() |
|
572 |
self.load_defaults() |
|
1446 | 573 |
self.translations = {} |
0 | 574 |
|
575 |
def adjust_sys_path(self): |
|
576 |
self.cls_adjust_sys_path() |
|
1446 | 577 |
|
578 |
def init_log(self, logthreshold=None, debug=False, |
|
0 | 579 |
logfile=None, syslog=False): |
580 |
"""init the log service""" |
|
180
8bcebdb5f55d
code moved to logilab.common.logging_ext
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
140
diff
changeset
|
581 |
if logthreshold is None: |
0 | 582 |
if debug: |
180
8bcebdb5f55d
code moved to logilab.common.logging_ext
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
140
diff
changeset
|
583 |
logthreshold = 'DEBUG' |
0 | 584 |
else: |
180
8bcebdb5f55d
code moved to logilab.common.logging_ext
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
140
diff
changeset
|
585 |
logthreshold = self['log-threshold'] |
3641
cf30e4498674
fix debug attribute conflict on configuration
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3640
diff
changeset
|
586 |
self.debugmode = debug |
180
8bcebdb5f55d
code moved to logilab.common.logging_ext
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
140
diff
changeset
|
587 |
init_log(debug, syslog, logthreshold, logfile, self.log_format) |
0 | 588 |
# configure simpleTal logger |
589 |
logging.getLogger('simpleTAL').setLevel(logging.ERROR) |
|
590 |
||
591 |
def vregistry_path(self): |
|
592 |
"""return a list of files or directories where the registry will look |
|
593 |
for application objects. By default return nothing in NoApp config. |
|
594 |
""" |
|
595 |
return [] |
|
1446 | 596 |
|
0 | 597 |
def eproperty_definitions(self): |
598 |
cfg = self.persistent_options_configuration() |
|
599 |
for section, options in cfg.options_by_section(): |
|
600 |
section = section.lower() |
|
601 |
for optname, optdict, value in options: |
|
602 |
key = '%s.%s' % (section, optname) |
|
603 |
type, vocab = self.map_option(optdict) |
|
604 |
default = cfg.option_default(optname, optdict) |
|
605 |
pdef = {'type': type, 'vocabulary': vocab, 'default': default, |
|
606 |
'help': optdict['help'], |
|
607 |
'sitewide': optdict.get('sitewide', False)} |
|
608 |
yield key, pdef |
|
1446 | 609 |
|
0 | 610 |
def map_option(self, optdict): |
611 |
try: |
|
612 |
vocab = optdict['choices'] |
|
613 |
except KeyError: |
|
614 |
vocab = optdict.get('vocabulary') |
|
615 |
if isinstance(vocab, Method): |
|
616 |
vocab = getattr(self, vocab.method, ()) |
|
617 |
return CFGTYPE2ETYPE_MAP[optdict['type']], vocab |
|
618 |
||
3564
b03cc2416cd5
[config] dumb implementation of default_instance_id on no app config since it's referenced
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3539
diff
changeset
|
619 |
def default_instance_id(self): |
b03cc2416cd5
[config] dumb implementation of default_instance_id on no app config since it's referenced
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3539
diff
changeset
|
620 |
"""return the instance identifier, useful for option which need this |
b03cc2416cd5
[config] dumb implementation of default_instance_id on no app config since it's referenced
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3539
diff
changeset
|
621 |
as default value |
b03cc2416cd5
[config] dumb implementation of default_instance_id on no app config since it's referenced
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3539
diff
changeset
|
622 |
""" |
b03cc2416cd5
[config] dumb implementation of default_instance_id on no app config since it's referenced
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3539
diff
changeset
|
623 |
return None |
1446 | 624 |
|
0 | 625 |
class CubicWebConfiguration(CubicWebNoAppConfiguration): |
626 |
"""base class for cubicweb server and web configurations""" |
|
1446 | 627 |
|
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
628 |
INSTANCES_DATA_DIR = None |
0 | 629 |
if CubicWebNoAppConfiguration.mode == 'test': |
630 |
root = os.environ['APYCOT_ROOT'] |
|
631 |
REGISTRY_DIR = '%s/etc/cubicweb.d/' % root |
|
3115
29262ba01464
minimal steps to have cw running on windows
Aurélien Campéas
parents:
3059
diff
changeset
|
632 |
RUNTIME_DIR = tempfile.gettempdir() |
3915
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
633 |
if CWDEV: |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
634 |
MIGRATION_DIR = '%s/local/share/cubicweb/migration/' % root |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
635 |
else: |
2d23304289a6
allow to test cubes within apycot using cubicweb from the debian package
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3641
diff
changeset
|
636 |
MIGRATION_DIR = '/usr/share/cubicweb/migration/' |
0 | 637 |
if not exists(REGISTRY_DIR): |
638 |
os.makedirs(REGISTRY_DIR) |
|
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
639 |
else: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
640 |
if CubicWebNoAppConfiguration.mode == 'user': |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
641 |
REGISTRY_DIR = expanduser('~/etc/cubicweb.d/') |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
642 |
RUNTIME_DIR = tempfile.gettempdir() |
3640 | 643 |
INSTANCES_DATA_DIR = REGISTRY_DIR |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
644 |
else: #mode = 'system' |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
645 |
REGISTRY_DIR = '/etc/cubicweb.d/' |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
646 |
RUNTIME_DIR = '/var/run/cubicweb/' |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
647 |
INSTANCES_DATA_DIR = '/var/lib/cubicweb/instances/' |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
648 |
if CWDEV: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
649 |
MIGRATION_DIR = join(CW_SOFTWARE_ROOT, 'misc', 'migration') |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
650 |
else: |
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
651 |
MIGRATION_DIR = '/usr/share/cubicweb/migration/' |
0 | 652 |
|
653 |
# for some commands (creation...) we don't want to initialize gettext |
|
654 |
set_language = True |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
655 |
# set this to true to avoid false error message while creating an instance |
0 | 656 |
creating = False |
2473
490f88fb99b6
new distinguish repairing/creating from regular start.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2449
diff
changeset
|
657 |
# set this to true to allow somethings which would'nt be possible |
490f88fb99b6
new distinguish repairing/creating from regular start.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2449
diff
changeset
|
658 |
repairing = False |
1446 | 659 |
|
0 | 660 |
options = CubicWebNoAppConfiguration.options + ( |
661 |
('log-file', |
|
662 |
{'type' : 'string', |
|
663 |
'default': Method('default_log_file'), |
|
664 |
'help': 'file where output logs should be written', |
|
665 |
'group': 'main', 'inputlevel': 2, |
|
666 |
}), |
|
667 |
# email configuration |
|
668 |
('smtp-host', |
|
669 |
{'type' : 'string', |
|
670 |
'default': 'mail', |
|
671 |
'help': 'hostname of the SMTP mail server', |
|
672 |
'group': 'email', 'inputlevel': 1, |
|
673 |
}), |
|
674 |
('smtp-port', |
|
675 |
{'type' : 'int', |
|
676 |
'default': 25, |
|
677 |
'help': 'listening port of the SMTP mail server', |
|
678 |
'group': 'email', 'inputlevel': 1, |
|
679 |
}), |
|
680 |
('sender-name', |
|
681 |
{'type' : 'string', |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
682 |
'default': Method('default_instance_id'), |
0 | 683 |
'help': 'name used as HELO name for outgoing emails from the \ |
684 |
repository.', |
|
685 |
'group': 'email', 'inputlevel': 2, |
|
686 |
}), |
|
687 |
('sender-addr', |
|
688 |
{'type' : 'string', |
|
2351
dddee537e4d5
don't use internal address
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2267
diff
changeset
|
689 |
'default': 'cubicweb@mydomain.com', |
0 | 690 |
'help': 'email address used as HELO address for outgoing emails from \ |
691 |
the repository', |
|
692 |
'group': 'email', 'inputlevel': 1, |
|
693 |
}), |
|
694 |
) |
|
695 |
||
696 |
@classmethod |
|
697 |
def runtime_dir(cls): |
|
698 |
"""run time directory for pid file...""" |
|
2445
6f065b366d14
rename environment variables
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2351
diff
changeset
|
699 |
return env_path('CW_RUNTIME_DIR', cls.RUNTIME_DIR, 'run time') |
1446 | 700 |
|
0 | 701 |
@classmethod |
702 |
def registry_dir(cls): |
|
703 |
"""return the control directory""" |
|
2445
6f065b366d14
rename environment variables
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2351
diff
changeset
|
704 |
return env_path('CW_INSTANCES_DIR', cls.REGISTRY_DIR, 'registry') |
0 | 705 |
|
706 |
@classmethod |
|
707 |
def instance_data_dir(cls): |
|
708 |
"""return the instance data directory""" |
|
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
709 |
return env_path('CW_INSTANCES_DATA_DIR', cls.INSTANCES_DATA_DIR, |
0 | 710 |
'additional data') |
1446 | 711 |
|
0 | 712 |
@classmethod |
713 |
def migration_scripts_dir(cls): |
|
714 |
"""cubicweb migration scripts directory""" |
|
2445
6f065b366d14
rename environment variables
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2351
diff
changeset
|
715 |
return env_path('CW_MIGRATION_DIR', cls.MIGRATION_DIR, 'migration') |
0 | 716 |
|
717 |
@classmethod |
|
718 |
def config_for(cls, appid, config=None): |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
719 |
"""return a configuration instance for the given instance identifier |
0 | 720 |
""" |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
721 |
config = config or guess_configuration(cls.instance_home(appid)) |
0 | 722 |
configcls = configuration_cls(config) |
723 |
return configcls(appid) |
|
1446 | 724 |
|
0 | 725 |
@classmethod |
726 |
def possible_configurations(cls, appid): |
|
727 |
"""return the name of possible configurations for the given |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
728 |
instance id |
0 | 729 |
""" |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
730 |
home = cls.instance_home(appid) |
0 | 731 |
return possible_configurations(home) |
1446 | 732 |
|
0 | 733 |
@classmethod |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
734 |
def instance_home(cls, appid): |
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
735 |
"""return the home directory of the instance with the given |
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
736 |
instance id |
0 | 737 |
""" |
738 |
home = join(cls.registry_dir(), appid) |
|
739 |
if not exists(home): |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
740 |
raise ConfigurationError('no such instance %s (check it exists with "cubicweb-ctl list")' % appid) |
0 | 741 |
return home |
742 |
||
743 |
MODES = ('common', 'repository', 'Any', 'web') |
|
744 |
MCOMPAT = {'all-in-one': MODES, |
|
745 |
'repository': ('common', 'repository', 'Any'), |
|
746 |
'twisted' : ('common', 'web'),} |
|
747 |
@classmethod |
|
748 |
def accept_mode(cls, mode): |
|
749 |
#assert mode in cls.MODES, mode |
|
750 |
return mode in cls.MCOMPAT[cls.name] |
|
1446 | 751 |
|
0 | 752 |
# default configuration methods ########################################### |
1446 | 753 |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
754 |
def default_instance_id(self): |
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
755 |
"""return the instance identifier, useful for option which need this |
0 | 756 |
as default value |
757 |
""" |
|
758 |
return self.appid |
|
759 |
||
760 |
def default_log_file(self): |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
761 |
"""return default path to the log file of the instance'server""" |
3638
648d6dbec630
system/user modes + CWDEV instead of installed/dev mixed modes. Fix behaviour when setting CW_MODE explicitly
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3564
diff
changeset
|
762 |
if self.mode == 'user': |
3115
29262ba01464
minimal steps to have cw running on windows
Aurélien Campéas
parents:
3059
diff
changeset
|
763 |
basepath = join(tempfile.gettempdir(), '%s-%s' % (basename(self.appid), self.name)) |
0 | 764 |
path = basepath + '.log' |
765 |
i = 1 |
|
766 |
while exists(path) and i < 100: # arbitrary limit to avoid infinite loop |
|
767 |
try: |
|
768 |
file(path, 'a') |
|
769 |
break |
|
770 |
except IOError: |
|
771 |
path = '%s-%s.log' % (basepath, i) |
|
772 |
i += 1 |
|
773 |
return path |
|
774 |
return '/var/log/cubicweb/%s-%s.log' % (self.appid, self.name) |
|
1446 | 775 |
|
0 | 776 |
def default_pid_file(self): |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
777 |
"""return default path to the pid file of the instance'server""" |
0 | 778 |
return join(self.runtime_dir(), '%s-%s.pid' % (self.appid, self.name)) |
1446 | 779 |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
780 |
# instance methods used to get instance specific resources ############# |
1446 | 781 |
|
0 | 782 |
def __init__(self, appid): |
783 |
self.appid = appid |
|
784 |
CubicWebNoAppConfiguration.__init__(self) |
|
785 |
self._cubes = None |
|
786 |
self._site_loaded = set() |
|
787 |
self.load_file_configuration(self.main_config_file()) |
|
788 |
||
789 |
def adjust_sys_path(self): |
|
790 |
CubicWebNoAppConfiguration.adjust_sys_path(self) |
|
791 |
# adding apphome to python path is not usually necessary in production |
|
792 |
# environments, but necessary for tests |
|
793 |
if self.apphome and not self.apphome in sys.path: |
|
794 |
sys.path.insert(0, self.apphome) |
|
795 |
||
796 |
@property |
|
797 |
def apphome(self): |
|
798 |
return join(self.registry_dir(), self.appid) |
|
1446 | 799 |
|
0 | 800 |
@property |
801 |
def appdatahome(self): |
|
802 |
return join(self.instance_data_dir(), self.appid) |
|
1446 | 803 |
|
0 | 804 |
def init_cubes(self, cubes): |
1681
1586c0ed9a92
nicer assertion message
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents:
1521
diff
changeset
|
805 |
assert self._cubes is None, self._cubes |
0 | 806 |
self._cubes = self.reorder_cubes(cubes) |
807 |
# load cubes'__init__.py file first |
|
808 |
for cube in cubes: |
|
809 |
__import__('cubes.%s' % cube) |
|
810 |
self.load_site_cubicweb() |
|
811 |
# reload config file in cases options are defined in cubes __init__ |
|
812 |
# or site_cubicweb files |
|
813 |
self.load_file_configuration(self.main_config_file()) |
|
814 |
# configuration initialization hook |
|
815 |
self.load_configuration() |
|
1446 | 816 |
|
0 | 817 |
def cubes(self): |
818 |
"""return the list of cubes used by this instance |
|
819 |
||
820 |
result is ordered from the top level cubes to inner dependencies |
|
821 |
cubes |
|
822 |
""" |
|
823 |
assert self._cubes is not None |
|
824 |
return self._cubes |
|
1446 | 825 |
|
0 | 826 |
def cubes_path(self): |
827 |
"""return the list of path to cubes used by this instance, from outer |
|
828 |
most to inner most cubes |
|
829 |
""" |
|
830 |
return [self.cube_dir(p) for p in self.cubes()] |
|
831 |
||
832 |
def add_cubes(self, cubes): |
|
833 |
"""add given cubes to the list of used cubes""" |
|
834 |
if not isinstance(cubes, list): |
|
835 |
cubes = list(cubes) |
|
836 |
self._cubes = self.reorder_cubes(list(self._cubes) + cubes) |
|
1446 | 837 |
|
0 | 838 |
def main_config_file(self): |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
839 |
"""return instance's control configuration file""" |
0 | 840 |
return join(self.apphome, '%s.conf' % self.name) |
1446 | 841 |
|
0 | 842 |
def save(self): |
843 |
"""write down current configuration""" |
|
844 |
self.generate_config(open(self.main_config_file(), 'w')) |
|
845 |
||
846 |
@cached |
|
847 |
def instance_md5_version(self): |
|
848 |
import md5 |
|
849 |
infos = [] |
|
850 |
for pkg in self.cubes(): |
|
851 |
version = self.cube_version(pkg) |
|
852 |
infos.append('%s-%s' % (pkg, version)) |
|
853 |
return md5.new(';'.join(infos)).hexdigest() |
|
1446 | 854 |
|
0 | 855 |
def load_site_cubicweb(self): |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
856 |
"""load instance's specific site_cubicweb file""" |
0 | 857 |
for path in reversed([self.apphome] + self.cubes_path()): |
858 |
sitefile = join(path, 'site_cubicweb.py') |
|
859 |
if exists(sitefile) and not sitefile in self._site_loaded: |
|
860 |
self._load_site_cubicweb(sitefile) |
|
861 |
self._site_loaded.add(sitefile) |
|
862 |
else: |
|
863 |
sitefile = join(path, 'site_erudi.py') |
|
864 |
if exists(sitefile) and not sitefile in self._site_loaded: |
|
865 |
self._load_site_cubicweb(sitefile) |
|
866 |
self._site_loaded.add(sitefile) |
|
867 |
self.warning('site_erudi.py is deprecated, should be renamed to site_cubicweb.py') |
|
1446 | 868 |
|
0 | 869 |
def _load_site_cubicweb(self, sitefile): |
2220
64aace08ae2f
add __file__ to context before loading site_cubicweb.py
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
870 |
context = {'__file__': sitefile} |
0 | 871 |
execfile(sitefile, context, context) |
872 |
self.info('%s loaded', sitefile) |
|
873 |
# cube specific options |
|
874 |
if context.get('options'): |
|
875 |
self.register_options(context['options']) |
|
876 |
self.load_defaults() |
|
1446 | 877 |
|
0 | 878 |
def load_configuration(self): |
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
879 |
"""load instance's configuration files""" |
0 | 880 |
super(CubicWebConfiguration, self).load_configuration() |
881 |
if self.apphome and self.set_language: |
|
882 |
# init gettext |
|
883 |
self._set_language() |
|
1446 | 884 |
|
0 | 885 |
def init_log(self, logthreshold=None, debug=False, force=False): |
886 |
"""init the log service""" |
|
887 |
if not force and hasattr(self, '_logging_initialized'): |
|
888 |
return |
|
889 |
self._logging_initialized = True |
|
890 |
CubicWebNoAppConfiguration.init_log(self, logthreshold, debug, |
|
2654
6512522860aa
[twisted] don't use twistd anymore, all-in-one.py file is needed anymore
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2613
diff
changeset
|
891 |
logfile=self.get('log-file')) |
0 | 892 |
# read a config file if it exists |
893 |
logconfig = join(self.apphome, 'logging.conf') |
|
894 |
if exists(logconfig): |
|
895 |
logging.fileConfig(logconfig) |
|
896 |
||
897 |
def available_languages(self, *args): |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
898 |
"""return available translation for an instance, by looking for |
0 | 899 |
compiled catalog |
900 |
||
901 |
take *args to be usable as a vocabulary method |
|
902 |
""" |
|
903 |
from glob import glob |
|
904 |
yield 'en' # ensure 'en' is yielded even if no .mo found |
|
905 |
for path in glob(join(self.apphome, 'i18n', |
|
3118 | 906 |
'*', 'LC_MESSAGES')): |
907 |
lang = path.split(os.sep)[-2] |
|
0 | 908 |
if lang != 'en': |
909 |
yield lang |
|
1446 | 910 |
|
0 | 911 |
def _set_language(self): |
912 |
"""set language for gettext""" |
|
913 |
from gettext import translation |
|
914 |
path = join(self.apphome, 'i18n') |
|
915 |
for language in self.available_languages(): |
|
916 |
self.info("loading language %s", language) |
|
917 |
try: |
|
918 |
tr = translation('cubicweb', path, languages=[language]) |
|
3275
5247789df541
[gettext] provide GNU contexts to avoid translations ambiguities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3270
diff
changeset
|
919 |
self.translations[language] = (tr.ugettext, tr.upgettext) |
0 | 920 |
except (ImportError, AttributeError, IOError): |
921 |
self.exception('localisation support error for language %s', |
|
1446 | 922 |
language) |
923 |
||
0 | 924 |
def vregistry_path(self): |
925 |
"""return a list of files or directories where the registry will look |
|
926 |
for application objects |
|
927 |
""" |
|
928 |
templpath = list(reversed(self.cubes_path())) |
|
929 |
if self.apphome: # may be unset in tests |
|
930 |
templpath.append(self.apphome) |
|
931 |
return self.build_vregistry_path(templpath) |
|
932 |
||
933 |
def set_sources_mode(self, sources): |
|
934 |
if not 'all' in sources: |
|
935 |
print 'warning: ignoring specified sources, requires a repository '\ |
|
936 |
'configuration' |
|
1446 | 937 |
|
0 | 938 |
def migration_handler(self): |
939 |
"""return a migration handler instance""" |
|
4021
280c910c8710
move i18n / migration modules from cw.common to cw
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4001
diff
changeset
|
940 |
from cubicweb.migration import MigrationHelper |
0 | 941 |
return MigrationHelper(self, verbosity=self.verbosity) |
942 |
||
943 |
def i18ncompile(self, langs=None): |
|
4021
280c910c8710
move i18n / migration modules from cw.common to cw
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4001
diff
changeset
|
944 |
from cubicweb import i18n |
0 | 945 |
if langs is None: |
946 |
langs = self.available_languages() |
|
947 |
i18ndir = join(self.apphome, 'i18n') |
|
948 |
if not exists(i18ndir): |
|
949 |
create_dir(i18ndir) |
|
950 |
sourcedirs = [join(path, 'i18n') for path in self.cubes_path()] |
|
951 |
sourcedirs.append(self.i18n_lib_dir()) |
|
952 |
return i18n.compile_i18n_catalogs(sourcedirs, i18ndir, langs) |
|
953 |
||
2221
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
954 |
def sendmails(self, msgs): |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
955 |
"""msgs: list of 2-uple (message object, recipients)""" |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
956 |
server, port = self['smtp-host'], self['smtp-port'] |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
957 |
SMTP_LOCK.acquire() |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
958 |
try: |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
959 |
try: |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
960 |
smtp = SMTP(server, port) |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
961 |
except Exception, ex: |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
962 |
self.exception("can't connect to smtp server %s:%s (%s)", |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
963 |
server, port, ex) |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
964 |
return |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
965 |
heloaddr = '%s <%s>' % (self['sender-name'], self['sender-addr']) |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
966 |
for msg, recipients in msgs: |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
967 |
try: |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
968 |
smtp.sendmail(heloaddr, recipients, msg.as_string()) |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
969 |
except Exception, ex: |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
970 |
self.exception("error sending mail to %s (%s)", |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
971 |
recipients, ex) |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
972 |
smtp.close() |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
973 |
finally: |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
974 |
SMTP_LOCK.release() |
d9b85a7b0bdd
create sendmails method on cwconfig, use it in SendMailOp
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2220
diff
changeset
|
975 |
|
180
8bcebdb5f55d
code moved to logilab.common.logging_ext
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
140
diff
changeset
|
976 |
set_log_methods(CubicWebConfiguration, logging.getLogger('cubicweb.configuration')) |
1446 | 977 |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
978 |
# alias to get a configuration instance from an instance id |
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2473
diff
changeset
|
979 |
instance_configuration = CubicWebConfiguration.config_for |
2613
5e19c2bb370e
R [all] logilab.common 0.44 provides only deprecated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2476
diff
changeset
|
980 |
application_configuration = deprecated('use instance_configuration')(instance_configuration) |
4023
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
981 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
982 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
983 |
_EXT_REGISTERED = False |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
984 |
def register_stored_procedures(): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
985 |
from logilab.common.adbh import FunctionDescr |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
986 |
from rql.utils import register_function, iter_funcnode_variables |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
987 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
988 |
global _EXT_REGISTERED |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
989 |
if _EXT_REGISTERED: |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
990 |
return |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
991 |
_EXT_REGISTERED = True |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
992 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
993 |
class COMMA_JOIN(FunctionDescr): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
994 |
supported_backends = ('postgres', 'sqlite',) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
995 |
rtype = 'String' |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
996 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
997 |
@classmethod |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
998 |
def st_description(cls, funcnode, mainindex, tr): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
999 |
return ', '.join(sorted(term.get_description(mainindex, tr) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1000 |
for term in iter_funcnode_variables(funcnode))) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1001 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1002 |
register_function(COMMA_JOIN) # XXX do not expose? |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1003 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1004 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1005 |
class CONCAT_STRINGS(COMMA_JOIN): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1006 |
aggregat = True |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1007 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1008 |
register_function(CONCAT_STRINGS) # XXX bw compat |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1009 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1010 |
class GROUP_CONCAT(CONCAT_STRINGS): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1011 |
supported_backends = ('mysql', 'postgres', 'sqlite',) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1012 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1013 |
register_function(GROUP_CONCAT) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1014 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1015 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1016 |
class LIMIT_SIZE(FunctionDescr): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1017 |
supported_backends = ('postgres', 'sqlite',) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1018 |
rtype = 'String' |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1019 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1020 |
@classmethod |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1021 |
def st_description(cls, funcnode, mainindex, tr): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1022 |
return funcnode.children[0].get_description(mainindex, tr) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1023 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1024 |
register_function(LIMIT_SIZE) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1025 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1026 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1027 |
class TEXT_LIMIT_SIZE(LIMIT_SIZE): |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1028 |
supported_backends = ('mysql', 'postgres', 'sqlite',) |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1029 |
|
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4021
diff
changeset
|
1030 |
register_function(TEXT_LIMIT_SIZE) |