forked from SmartTeleMax/iktomi-cms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
stream.py
449 lines (352 loc) · 14.1 KB
/
stream.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# -*- coding: utf-8 -*-
import logging, warnings
from webob.exc import HTTPForbidden
from webob.multidict import MultiDict
from jinja2 import Markup
from iktomi.utils import cached_property
from collections import OrderedDict
from iktomi.utils.storage import VersionedStorage
from iktomi import web
from iktomi.web.url_converters import Converter, default_converters
from iktomi.cms.forms import Form
from iktomi.cms.item_lock import ItemLock
from iktomi.utils.deprecation import deprecated
from . import stream_handlers as handlers
from .flashmessages import flash
logger = logging.getLogger(__name__)
_none_converter_factory_cache = {}
def none_converter_factory(cls):
if cls in _none_converter_factory_cache:
return _none_converter_factory_cache[cls]
class NoneConverter(cls):
regex = Converter.regex
def to_python(self, value, **kwargs):
if value == '+':
return None
return super(NoneConverter, self).to_python(value, **kwargs)
def to_url(self, value):
if value is None:
return '+'
return super(NoneConverter, self).to_url(value)
_none_converter_factory_cache[cls] = NoneConverter
return NoneConverter
def I18nLabel(string, lang):
return Markup(u'<span class="lang-%s">%s</span>' % (lang, string))
def ListFields(*args):
fields = []
for field in args:
if not isinstance(field, ListField):
field = ListField(*field)
fields.append(field)
if not fields or fields[0].name != 'id':
fields.insert(0, ListField('id', 'ID', classname='width-0'))
fields.insert(1, ItemLockListField())
return OrderedDict(fields)
class ListField(object):
template = 'list_field.html'
# Use classname and define width in css files
_obsolete = frozenset(['width'])
def __init__(self, name, title, image=False,
transform=lambda f: u'—' if f is None else f,
static=False, link_to_item=True, classname='',
template=None, **kwargs):
if self._obsolete & set(kwargs):
raise TypeError('Obsolete parameters are used: {}'.format(
list(self._obsolete & set(kwargs))))
self.name = name
self.title = title
self.image = image
self.static = static
self.transform = transform
self.link_to_item = link_to_item
self.classname = classname
self.template = template or self.template
def __iter__(self):
yield self.name
yield self
def __call__(self, env, item, url, loop):
field_val = self.get_value(env, item, url, loop)
if self.transform is not None:
return self.transform(field_val)
return field_val
def get_value(self, env, item, url, loop):
return getattr(item, self.name)
class ItemLockListField(ListField):
template = 'list_field_item_lock.html'
def __init__(self, name='locked', title='', **kwargs):
kwargs.setdefault('link_to_item', False)
kwargs.setdefault('transform', lambda x: x)
kwargs.setdefault('classname', 'width-0')
ListField.__init__(self, name, title, **kwargs)
def get_value(self, env, item, url, loop):
lock = env.item_lock.check(item)
if lock is not None:
return dict(lock,
guid=env.item_lock.item_global_id(item),
user=env.db.query(env.auth_model)\
.get(lock['user_id']))
class FilterForm(Form):
fields = []
def filter_by_scalar(self, query, field, value):
return query.filter(getattr(self.model, field.name)==value)
def filter_by_true(self, query, field, value):
if value:
return self.filter_by_scalar(query, field, value)
return query
def filter_by_list(self, query, field, values):
prop = getattr(self.model, field.name)
for value in values:
query = query.filter(prop.contains(value))
return query
def filter_by_default(self, query, field, value):
if field.multiple:
return self.filter_by_list(query, field, value)
else:
return self.filter_by_scalar(query, field, value)
def filter(self, query):
'''Modifies query'''
# XXX will not work with FieldBlocks!
for field in self.fields:
filter_value = self.python_data[field.name]
if filter_value or filter_value == 0:
method = getattr(self, 'filter_by__%s' % field.name,
getattr(field, 'filter_query',
self.filter_by_default))
query = method(query, field, filter_value)
return query
def defaults(self):
return {}
def get_data(self, compact=True):
data = MultiDict(self.raw_data) # XXX
if compact:
compact_data = MultiDict()
for key, value in data.iteritems():
if value:
compact_data.add(key, value)
data = compact_data
return data
def __nonzero__(self):
# We don't want to display form when there is no fields
return bool(self.fields)
class Stream(object):
id_converter_name = 'int'
actions = []
core_actions = [handlers.StreamListHandler(),
handlers.EditItemHandler(),
handlers.DeleteItemHandler(),
handlers.GetReferrersHandler(),
]
buttons = ['save', 'save_and_continue', 'save_and_add_another', 'delete']
lock_back_title = None
lock_back_help = None
def __init__(self, module_name, config):
self.config = config
self.module_name = module_name
self.actions = [x.bind(self) for x in self.core_actions + self.actions]
self.core_actions = []
@cached_property
def id_converter(self):
return default_converters.get(self.id_converter_name)
@cached_property
def id_none_converter(self):
return none_converter_factory(self.id_converter)
@property
def prefix_handler(self):
""" Handler match stream path, setup stream namespace and env"""
@web.request_filter
def set_stream_handler(env, data, nxt):
env.stream = self
return nxt(env, data)
part = self.module_name.rsplit('.', 1)[-1]
return web.prefix('/' +part, name=part) | \
set_stream_handler
@property
def app_handler(self):
""" Handler add stream action's app handlers """
apps = [action.app for action in self.actions]
return web.cases(*apps)
def get_handler(self):
""" Get web handler for routing.
"""
return self.prefix_handler | self.app_handler
def url_for(self, env, name=None, **kwargs):
name = name and '%s.%s' % (self.module_name, name) or self.module_name
return env.url_for(name, **kwargs)
def get_edit_url(self, env, item):
'''
Checks if item belongs to the stream, and if it's true,
returns an url to item edit page
'''
# be careful, this method is redefined for publish streams
if isinstance(item, self.get_model(env)):
#cls, id = identity_key(instance=item)
item_ = self.item_query(env).filter_by(id=item.id).scalar()
if item_ is not None:
return self.url_for(env, 'item', item=item.id)
@cached_property
def autosave(self):
return getattr(self.config, 'autosave', True)
@cached_property
@deprecated("use `stream.edit_log_action is not None` instead")
def edit_log(self):
return any(x for x in self.actions if x.action=='edit_log')
@cached_property
def referrers(self):
return any(x for x in self.actions if x.action=='referrers')
@cached_property
def app_namespace(self):
if '.' in self.module_name:
return self.module_name.rsplit('.', 1)[0]
return ''
@cached_property
def perms(self):
p = getattr(self.config, 'permissions', {})
p.setdefault('wheel', 'rwxcdp')
return p
@cached_property
def edit_action(self):
for action in self.actions:
if action.action=='item':
return action
@cached_property
def list_edit_action(self):
for action in self.actions:
if hasattr(action, 'ListItemForm'):
return action
@cached_property
def preview_action(self):
for action in self.actions:
if action.action=='preview':
return action
@cached_property
def edit_log_action(self):
for action in self.actions:
if action.action=='edit_log':
return action
def create_log_entry(self, env, item, type_):
EditLog = getattr(env, 'edit_log_model', None)
log_enabled = EditLog is not None and \
self.edit_log_action is not None
if log_enabled:
return EditLog(stream_name=self.uid(env),
type=type_,
object_id=item.id,
global_id=ItemLock.item_global_id(item),
users=[env.user])
@cached_property
def ListItemForm(self):
if self.list_edit_action:
return self.list_edit_action.ListItemForm
@cached_property
def stream_template_name(self):
if hasattr(self.config, 'stream_template'):
return self.config.stream_template
if hasattr(self.config, 'template'):
warnings.warn("Stream.config.template is deprecated",
category=DeprecationWarning)
return self.config.template
return 'stream'
@cached_property
def row_template_name(self):
return getattr(self.config, 'row_template', 'stream_row')
@cached_property
def item_template_name(self):
return getattr(self.config, 'item_template', 'item')
@cached_property
def template_data(self):
return getattr(self.config, 'template_data', {})
@cached_property
def live_search(self):
return getattr(self.config, 'live_search', False)
@cached_property
def list_fields(self):
return getattr(self.config, 'list_fields', {})
@cached_property
def title(self):
return getattr(self.config, 'title', self.module_name)
def uid(self, env, version=None):
return self.module_name
def get_filter_form(self, env):
cls = getattr(self.config, 'FilterForm', FilterForm)
form = cls(env)
form.model = self.get_model(env)
return form
def process_item_template_data(self, env, template_data):
'''Preprocessor for template variables.
Can be overriden by descedant classes.'''
return template_data
def process_list_template_data(self, env, template_data):
'''Preprocessor for template variables.
Can be overriden by descedant classes.'''
return template_data
def lock_back_url(self, env, item, filter_form):
return self.url_for(env).qs_set(filter_form.get_data())
def order(self, query):
return query
def get_permissions(self, env):
perms = set()
for role in env.user.roles:
# XXX how does it work for wheel?
perms |= set(self.perms.get(role, ''))
return perms
def has_permission(self, env, permission):
return permission in self.get_permissions(env)
def insure_has_permission(self, env, permission):
if not self.has_permission(env, permission):
raise HTTPForbidden
#def stream_endpoint(self, env):
# return self.module_name
#def stream_url(self, request):
# return request.url_for(self.stream_endpoint(request))
def get_model(self, env):
return self.config.Model
def __repr__(self):
return '<%s.%s: %s>' % (self.__class__.__module__, self.__class__.__name__, self.module_name)
def item_query(self, env):
return env.db.query(self.get_model(env))
# ========= Item actions ====
def commit_item_transaction(self, env, item, silent=False):
'''commits request.db and flashes success message'''
env.db.commit()
if not silent:
flash(env, u'Объект (%s) сохранен' % (item,), 'success')
def rollback_due_lock_lost(self, env, item, silent=False):
'''rollbacks request.db and flashes failure message'''
env.db.rollback()
if not silent:
flash(env, u'Объект (%s) не был сохранен из-за '
u'перехваченной блокировки' % (item,),
'failure')
def rollback_due_form_errors(self, env, item, silent=False):
env.db.rollback()
if not silent:
flash(env, u'Объект (%s) не был сохранен из-за ошибок' % (item,),
'failure')
def decode_stream_uid(stream_name):
if ':' in stream_name:
name = stream_name.split(':', 1)[0]
params = dict([x.split('=', 1) for x in
stream_name.split(':')[1:]
if '=' in x])
return name, params
return stream_name, {}
def expand_stream(env, obj):
stream_name, params = decode_stream_uid(obj.stream_name)
stream_env = VersionedStorage()
stream_env._storage._parent_storage = env
if 'lang' in params:
stream_env.models = getattr(env.models, params['lang'])
stream_env.lang = params['lang']
if stream_name not in env.streams:
# Deleted or renamed stream
raise NotImplementedError
stream = env.streams[stream_name]
item = stream.item_query(stream_env)\
.filter_by(id=obj.object_id).first()
if item is not None:
stream_title = stream.title
if 'lang' in params:
stream_title = I18nLabel(stream_title, params['lang'])
url = stream.url_for(stream_env, 'item',
item=obj.object_id, **params)
return (url, stream_title, stream, obj, item)