##// END OF EJS Templates
scheduler: added DB models and db parsers for the RhodeCode scheduler....
marcink -
r2406:db81d430 default
parent child Browse files
Show More
@@ -0,0 +1,60 b''
1 # -*- coding: utf-8 -*-
2
3 # Copyright (C) 2010-2017 RhodeCode GmbH
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License, version 3
7 # (only), as published by the Free Software Foundation.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #
17 # This program is dual-licensed. If you wish to learn more about the
18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 import logging
21 import importlib
22
23 from celery.beat import (
24 PersistentScheduler, ScheduleEntry as CeleryScheduleEntry)
25
26 log = logging.getLogger(__name__)
27
28
29 class FileScheduleEntry(CeleryScheduleEntry):
30 def __init__(self, name=None, task=None, last_run_at=None,
31 total_run_count=None, schedule=None, args=(), kwargs=None,
32 options=None, relative=False, app=None, **_kwargs):
33 kwargs = kwargs or {}
34 options = options or {}
35
36 # because our custom loader passes in some variables that the original
37 # function doesn't expect, we have this thin wrapper
38
39 super(FileScheduleEntry, self).__init__(
40 name=name, task=task, last_run_at=last_run_at,
41 total_run_count=total_run_count, schedule=schedule, args=args,
42 kwargs=kwargs, options=options, relative=relative, app=app)
43
44
45 class FileScheduler(PersistentScheduler):
46 """CE base scheduler"""
47 Entry = FileScheduleEntry
48
49 def setup_schedule(self):
50 log.info("setup_schedule called")
51 super(FileScheduler, self).setup_schedule()
52
53
54 try:
55 # try if we have EE scheduler available
56 module = importlib.import_module('rc_ee.lib.celerylib.scheduler')
57 RcScheduler = module.RcScheduler
58 except ImportError:
59 # fallback to CE scheduler
60 RcScheduler = FileScheduler
This diff has been collapsed as it changes many lines, (4366 lines changed) Show them Hide them
@@ -0,0 +1,4366 b''
1 # -*- coding: utf-8 -*-
2
3 # Copyright (C) 2010-2017 RhodeCode GmbH
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License, version 3
7 # (only), as published by the Free Software Foundation.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #
17 # This program is dual-licensed. If you wish to learn more about the
18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20
21 """
22 Database Models for RhodeCode Enterprise
23 """
24
25 import re
26 import os
27 import time
28 import hashlib
29 import logging
30 import datetime
31 import warnings
32 import ipaddress
33 import functools
34 import traceback
35 import collections
36
37 from sqlalchemy import (
38 or_, and_, not_, func, TypeDecorator, event,
39 Index, Sequence, UniqueConstraint, ForeignKey, CheckConstraint, Column,
40 Boolean, String, Unicode, UnicodeText, DateTime, Integer, LargeBinary,
41 Text, Float, PickleType)
42 from sqlalchemy.sql.expression import true, false
43 from sqlalchemy.sql.functions import coalesce, count # noqa
44 from sqlalchemy.orm import (
45 relationship, joinedload, class_mapper, validates, aliased)
46 from sqlalchemy.ext.declarative import declared_attr
47 from sqlalchemy.ext.hybrid import hybrid_property
48 from sqlalchemy.exc import IntegrityError # noqa
49 from sqlalchemy.dialects.mysql import LONGTEXT
50 from beaker.cache import cache_region
51 from zope.cachedescriptors.property import Lazy as LazyProperty
52
53 from pyramid.threadlocal import get_current_request
54
55 from rhodecode.translation import _
56 from rhodecode.lib.vcs import get_vcs_instance
57 from rhodecode.lib.vcs.backends.base import EmptyCommit, Reference
58 from rhodecode.lib.utils2 import (
59 str2bool, safe_str, get_commit_safe, safe_unicode, md5_safe,
60 time_to_datetime, aslist, Optional, safe_int, get_clone_url, AttributeDict,
61 glob2re, StrictAttributeDict, cleaned_uri)
62 from rhodecode.lib.jsonalchemy import MutationObj, MutationList, JsonType, \
63 JsonRaw
64 from rhodecode.lib.ext_json import json
65 from rhodecode.lib.caching_query import FromCache
66 from rhodecode.lib.encrypt import AESCipher
67
68 from rhodecode.model.meta import Base, Session
69
70 URL_SEP = '/'
71 log = logging.getLogger(__name__)
72
73 # =============================================================================
74 # BASE CLASSES
75 # =============================================================================
76
77 # this is propagated from .ini file rhodecode.encrypted_values.secret or
78 # beaker.session.secret if first is not set.
79 # and initialized at environment.py
80 ENCRYPTION_KEY = None
81
82 # used to sort permissions by types, '#' used here is not allowed to be in
83 # usernames, and it's very early in sorted string.printable table.
84 PERMISSION_TYPE_SORT = {
85 'admin': '####',
86 'write': '###',
87 'read': '##',
88 'none': '#',
89 }
90
91
92 def display_user_sort(obj):
93 """
94 Sort function used to sort permissions in .permissions() function of
95 Repository, RepoGroup, UserGroup. Also it put the default user in front
96 of all other resources
97 """
98
99 if obj.username == User.DEFAULT_USER:
100 return '#####'
101 prefix = PERMISSION_TYPE_SORT.get(obj.permission.split('.')[-1], '')
102 return prefix + obj.username
103
104
105 def display_user_group_sort(obj):
106 """
107 Sort function used to sort permissions in .permissions() function of
108 Repository, RepoGroup, UserGroup. Also it put the default user in front
109 of all other resources
110 """
111
112 prefix = PERMISSION_TYPE_SORT.get(obj.permission.split('.')[-1], '')
113 return prefix + obj.users_group_name
114
115
116 def _hash_key(k):
117 return md5_safe(k)
118
119
120 def in_filter_generator(qry, items, limit=500):
121 """
122 Splits IN() into multiple with OR
123 e.g.::
124 cnt = Repository.query().filter(
125 or_(
126 *in_filter_generator(Repository.repo_id, range(100000))
127 )).count()
128 """
129 if not items:
130 # empty list will cause empty query which might cause security issues
131 # this can lead to hidden unpleasant results
132 items = [-1]
133
134 parts = []
135 for chunk in xrange(0, len(items), limit):
136 parts.append(
137 qry.in_(items[chunk: chunk + limit])
138 )
139
140 return parts
141
142
143 class EncryptedTextValue(TypeDecorator):
144 """
145 Special column for encrypted long text data, use like::
146
147 value = Column("encrypted_value", EncryptedValue(), nullable=False)
148
149 This column is intelligent so if value is in unencrypted form it return
150 unencrypted form, but on save it always encrypts
151 """
152 impl = Text
153
154 def process_bind_param(self, value, dialect):
155 if not value:
156 return value
157 if value.startswith('enc$aes$') or value.startswith('enc$aes_hmac$'):
158 # protect against double encrypting if someone manually starts
159 # doing
160 raise ValueError('value needs to be in unencrypted format, ie. '
161 'not starting with enc$aes')
162 return 'enc$aes_hmac$%s' % AESCipher(
163 ENCRYPTION_KEY, hmac=True).encrypt(value)
164
165 def process_result_value(self, value, dialect):
166 import rhodecode
167
168 if not value:
169 return value
170
171 parts = value.split('$', 3)
172 if not len(parts) == 3:
173 # probably not encrypted values
174 return value
175 else:
176 if parts[0] != 'enc':
177 # parts ok but without our header ?
178 return value
179 enc_strict_mode = str2bool(rhodecode.CONFIG.get(
180 'rhodecode.encrypted_values.strict') or True)
181 # at that stage we know it's our encryption
182 if parts[1] == 'aes':
183 decrypted_data = AESCipher(ENCRYPTION_KEY).decrypt(parts[2])
184 elif parts[1] == 'aes_hmac':
185 decrypted_data = AESCipher(
186 ENCRYPTION_KEY, hmac=True,
187 strict_verification=enc_strict_mode).decrypt(parts[2])
188 else:
189 raise ValueError(
190 'Encryption type part is wrong, must be `aes` '
191 'or `aes_hmac`, got `%s` instead' % (parts[1]))
192 return decrypted_data
193
194
195 class BaseModel(object):
196 """
197 Base Model for all classes
198 """
199
200 @classmethod
201 def _get_keys(cls):
202 """return column names for this model """
203 return class_mapper(cls).c.keys()
204
205 def get_dict(self):
206 """
207 return dict with keys and values corresponding
208 to this model data """
209
210 d = {}
211 for k in self._get_keys():
212 d[k] = getattr(self, k)
213
214 # also use __json__() if present to get additional fields
215 _json_attr = getattr(self, '__json__', None)
216 if _json_attr:
217 # update with attributes from __json__
218 if callable(_json_attr):
219 _json_attr = _json_attr()
220 for k, val in _json_attr.iteritems():
221 d[k] = val
222 return d
223
224 def get_appstruct(self):
225 """return list with keys and values tuples corresponding
226 to this model data """
227
228 lst = []
229 for k in self._get_keys():
230 lst.append((k, getattr(self, k),))
231 return lst
232
233 def populate_obj(self, populate_dict):
234 """populate model with data from given populate_dict"""
235
236 for k in self._get_keys():
237 if k in populate_dict:
238 setattr(self, k, populate_dict[k])
239
240 @classmethod
241 def query(cls):
242 return Session().query(cls)
243
244 @classmethod
245 def get(cls, id_):
246 if id_:
247 return cls.query().get(id_)
248
249 @classmethod
250 def get_or_404(cls, id_):
251 from pyramid.httpexceptions import HTTPNotFound
252
253 try:
254 id_ = int(id_)
255 except (TypeError, ValueError):
256 raise HTTPNotFound()
257
258 res = cls.query().get(id_)
259 if not res:
260 raise HTTPNotFound()
261 return res
262
263 @classmethod
264 def getAll(cls):
265 # deprecated and left for backward compatibility
266 return cls.get_all()
267
268 @classmethod
269 def get_all(cls):
270 return cls.query().all()
271
272 @classmethod
273 def delete(cls, id_):
274 obj = cls.query().get(id_)
275 Session().delete(obj)
276
277 @classmethod
278 def identity_cache(cls, session, attr_name, value):
279 exist_in_session = []
280 for (item_cls, pkey), instance in session.identity_map.items():
281 if cls == item_cls and getattr(instance, attr_name) == value:
282 exist_in_session.append(instance)
283 if exist_in_session:
284 if len(exist_in_session) == 1:
285 return exist_in_session[0]
286 log.exception(
287 'multiple objects with attr %s and '
288 'value %s found with same name: %r',
289 attr_name, value, exist_in_session)
290
291 def __repr__(self):
292 if hasattr(self, '__unicode__'):
293 # python repr needs to return str
294 try:
295 return safe_str(self.__unicode__())
296 except UnicodeDecodeError:
297 pass
298 return '<DB:%s>' % (self.__class__.__name__)
299
300
301 class RhodeCodeSetting(Base, BaseModel):
302 __tablename__ = 'rhodecode_settings'
303 __table_args__ = (
304 UniqueConstraint('app_settings_name'),
305 {'extend_existing': True, 'mysql_engine': 'InnoDB',
306 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
307 )
308
309 SETTINGS_TYPES = {
310 'str': safe_str,
311 'int': safe_int,
312 'unicode': safe_unicode,
313 'bool': str2bool,
314 'list': functools.partial(aslist, sep=',')
315 }
316 DEFAULT_UPDATE_URL = 'https://rhodecode.com/api/v1/info/versions'
317 GLOBAL_CONF_KEY = 'app_settings'
318
319 app_settings_id = Column("app_settings_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
320 app_settings_name = Column("app_settings_name", String(255), nullable=True, unique=None, default=None)
321 _app_settings_value = Column("app_settings_value", String(4096), nullable=True, unique=None, default=None)
322 _app_settings_type = Column("app_settings_type", String(255), nullable=True, unique=None, default=None)
323
324 def __init__(self, key='', val='', type='unicode'):
325 self.app_settings_name = key
326 self.app_settings_type = type
327 self.app_settings_value = val
328
329 @validates('_app_settings_value')
330 def validate_settings_value(self, key, val):
331 assert type(val) == unicode
332 return val
333
334 @hybrid_property
335 def app_settings_value(self):
336 v = self._app_settings_value
337 _type = self.app_settings_type
338 if _type:
339 _type = self.app_settings_type.split('.')[0]
340 # decode the encrypted value
341 if 'encrypted' in self.app_settings_type:
342 cipher = EncryptedTextValue()
343 v = safe_unicode(cipher.process_result_value(v, None))
344
345 converter = self.SETTINGS_TYPES.get(_type) or \
346 self.SETTINGS_TYPES['unicode']
347 return converter(v)
348
349 @app_settings_value.setter
350 def app_settings_value(self, val):
351 """
352 Setter that will always make sure we use unicode in app_settings_value
353
354 :param val:
355 """
356 val = safe_unicode(val)
357 # encode the encrypted value
358 if 'encrypted' in self.app_settings_type:
359 cipher = EncryptedTextValue()
360 val = safe_unicode(cipher.process_bind_param(val, None))
361 self._app_settings_value = val
362
363 @hybrid_property
364 def app_settings_type(self):
365 return self._app_settings_type
366
367 @app_settings_type.setter
368 def app_settings_type(self, val):
369 if val.split('.')[0] not in self.SETTINGS_TYPES:
370 raise Exception('type must be one of %s got %s'
371 % (self.SETTINGS_TYPES.keys(), val))
372 self._app_settings_type = val
373
374 def __unicode__(self):
375 return u"<%s('%s:%s[%s]')>" % (
376 self.__class__.__name__,
377 self.app_settings_name, self.app_settings_value,
378 self.app_settings_type
379 )
380
381
382 class RhodeCodeUi(Base, BaseModel):
383 __tablename__ = 'rhodecode_ui'
384 __table_args__ = (
385 UniqueConstraint('ui_key'),
386 {'extend_existing': True, 'mysql_engine': 'InnoDB',
387 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
388 )
389
390 HOOK_REPO_SIZE = 'changegroup.repo_size'
391 # HG
392 HOOK_PRE_PULL = 'preoutgoing.pre_pull'
393 HOOK_PULL = 'outgoing.pull_logger'
394 HOOK_PRE_PUSH = 'prechangegroup.pre_push'
395 HOOK_PRETX_PUSH = 'pretxnchangegroup.pre_push'
396 HOOK_PUSH = 'changegroup.push_logger'
397 HOOK_PUSH_KEY = 'pushkey.key_push'
398
399 # TODO: johbo: Unify way how hooks are configured for git and hg,
400 # git part is currently hardcoded.
401
402 # SVN PATTERNS
403 SVN_BRANCH_ID = 'vcs_svn_branch'
404 SVN_TAG_ID = 'vcs_svn_tag'
405
406 ui_id = Column(
407 "ui_id", Integer(), nullable=False, unique=True, default=None,
408 primary_key=True)
409 ui_section = Column(
410 "ui_section", String(255), nullable=True, unique=None, default=None)
411 ui_key = Column(
412 "ui_key", String(255), nullable=True, unique=None, default=None)
413 ui_value = Column(
414 "ui_value", String(255), nullable=True, unique=None, default=None)
415 ui_active = Column(
416 "ui_active", Boolean(), nullable=True, unique=None, default=True)
417
418 def __repr__(self):
419 return '<%s[%s]%s=>%s]>' % (self.__class__.__name__, self.ui_section,
420 self.ui_key, self.ui_value)
421
422
423 class RepoRhodeCodeSetting(Base, BaseModel):
424 __tablename__ = 'repo_rhodecode_settings'
425 __table_args__ = (
426 UniqueConstraint(
427 'app_settings_name', 'repository_id',
428 name='uq_repo_rhodecode_setting_name_repo_id'),
429 {'extend_existing': True, 'mysql_engine': 'InnoDB',
430 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
431 )
432
433 repository_id = Column(
434 "repository_id", Integer(), ForeignKey('repositories.repo_id'),
435 nullable=False)
436 app_settings_id = Column(
437 "app_settings_id", Integer(), nullable=False, unique=True,
438 default=None, primary_key=True)
439 app_settings_name = Column(
440 "app_settings_name", String(255), nullable=True, unique=None,
441 default=None)
442 _app_settings_value = Column(
443 "app_settings_value", String(4096), nullable=True, unique=None,
444 default=None)
445 _app_settings_type = Column(
446 "app_settings_type", String(255), nullable=True, unique=None,
447 default=None)
448
449 repository = relationship('Repository')
450
451 def __init__(self, repository_id, key='', val='', type='unicode'):
452 self.repository_id = repository_id
453 self.app_settings_name = key
454 self.app_settings_type = type
455 self.app_settings_value = val
456
457 @validates('_app_settings_value')
458 def validate_settings_value(self, key, val):
459 assert type(val) == unicode
460 return val
461
462 @hybrid_property
463 def app_settings_value(self):
464 v = self._app_settings_value
465 type_ = self.app_settings_type
466 SETTINGS_TYPES = RhodeCodeSetting.SETTINGS_TYPES
467 converter = SETTINGS_TYPES.get(type_) or SETTINGS_TYPES['unicode']
468 return converter(v)
469
470 @app_settings_value.setter
471 def app_settings_value(self, val):
472 """
473 Setter that will always make sure we use unicode in app_settings_value
474
475 :param val:
476 """
477 self._app_settings_value = safe_unicode(val)
478
479 @hybrid_property
480 def app_settings_type(self):
481 return self._app_settings_type
482
483 @app_settings_type.setter
484 def app_settings_type(self, val):
485 SETTINGS_TYPES = RhodeCodeSetting.SETTINGS_TYPES
486 if val not in SETTINGS_TYPES:
487 raise Exception('type must be one of %s got %s'
488 % (SETTINGS_TYPES.keys(), val))
489 self._app_settings_type = val
490
491 def __unicode__(self):
492 return u"<%s('%s:%s:%s[%s]')>" % (
493 self.__class__.__name__, self.repository.repo_name,
494 self.app_settings_name, self.app_settings_value,
495 self.app_settings_type
496 )
497
498
499 class RepoRhodeCodeUi(Base, BaseModel):
500 __tablename__ = 'repo_rhodecode_ui'
501 __table_args__ = (
502 UniqueConstraint(
503 'repository_id', 'ui_section', 'ui_key',
504 name='uq_repo_rhodecode_ui_repository_id_section_key'),
505 {'extend_existing': True, 'mysql_engine': 'InnoDB',
506 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
507 )
508
509 repository_id = Column(
510 "repository_id", Integer(), ForeignKey('repositories.repo_id'),
511 nullable=False)
512 ui_id = Column(
513 "ui_id", Integer(), nullable=False, unique=True, default=None,
514 primary_key=True)
515 ui_section = Column(
516 "ui_section", String(255), nullable=True, unique=None, default=None)
517 ui_key = Column(
518 "ui_key", String(255), nullable=True, unique=None, default=None)
519 ui_value = Column(
520 "ui_value", String(255), nullable=True, unique=None, default=None)
521 ui_active = Column(
522 "ui_active", Boolean(), nullable=True, unique=None, default=True)
523
524 repository = relationship('Repository')
525
526 def __repr__(self):
527 return '<%s[%s:%s]%s=>%s]>' % (
528 self.__class__.__name__, self.repository.repo_name,
529 self.ui_section, self.ui_key, self.ui_value)
530
531
532 class User(Base, BaseModel):
533 __tablename__ = 'users'
534 __table_args__ = (
535 UniqueConstraint('username'), UniqueConstraint('email'),
536 Index('u_username_idx', 'username'),
537 Index('u_email_idx', 'email'),
538 {'extend_existing': True, 'mysql_engine': 'InnoDB',
539 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
540 )
541 DEFAULT_USER = 'default'
542 DEFAULT_USER_EMAIL = 'anonymous@rhodecode.org'
543 DEFAULT_GRAVATAR_URL = 'https://secure.gravatar.com/avatar/{md5email}?d=identicon&s={size}'
544
545 user_id = Column("user_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
546 username = Column("username", String(255), nullable=True, unique=None, default=None)
547 password = Column("password", String(255), nullable=True, unique=None, default=None)
548 active = Column("active", Boolean(), nullable=True, unique=None, default=True)
549 admin = Column("admin", Boolean(), nullable=True, unique=None, default=False)
550 name = Column("firstname", String(255), nullable=True, unique=None, default=None)
551 lastname = Column("lastname", String(255), nullable=True, unique=None, default=None)
552 _email = Column("email", String(255), nullable=True, unique=None, default=None)
553 last_login = Column("last_login", DateTime(timezone=False), nullable=True, unique=None, default=None)
554 last_activity = Column('last_activity', DateTime(timezone=False), nullable=True, unique=None, default=None)
555
556 extern_type = Column("extern_type", String(255), nullable=True, unique=None, default=None)
557 extern_name = Column("extern_name", String(255), nullable=True, unique=None, default=None)
558 _api_key = Column("api_key", String(255), nullable=True, unique=None, default=None)
559 inherit_default_permissions = Column("inherit_default_permissions", Boolean(), nullable=False, unique=None, default=True)
560 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
561 _user_data = Column("user_data", LargeBinary(), nullable=True) # JSON data
562
563 user_log = relationship('UserLog')
564 user_perms = relationship('UserToPerm', primaryjoin="User.user_id==UserToPerm.user_id", cascade='all')
565
566 repositories = relationship('Repository')
567 repository_groups = relationship('RepoGroup')
568 user_groups = relationship('UserGroup')
569
570 user_followers = relationship('UserFollowing', primaryjoin='UserFollowing.follows_user_id==User.user_id', cascade='all')
571 followings = relationship('UserFollowing', primaryjoin='UserFollowing.user_id==User.user_id', cascade='all')
572
573 repo_to_perm = relationship('UserRepoToPerm', primaryjoin='UserRepoToPerm.user_id==User.user_id', cascade='all')
574 repo_group_to_perm = relationship('UserRepoGroupToPerm', primaryjoin='UserRepoGroupToPerm.user_id==User.user_id', cascade='all')
575 user_group_to_perm = relationship('UserUserGroupToPerm', primaryjoin='UserUserGroupToPerm.user_id==User.user_id', cascade='all')
576
577 group_member = relationship('UserGroupMember', cascade='all')
578
579 notifications = relationship('UserNotification', cascade='all')
580 # notifications assigned to this user
581 user_created_notifications = relationship('Notification', cascade='all')
582 # comments created by this user
583 user_comments = relationship('ChangesetComment', cascade='all')
584 # user profile extra info
585 user_emails = relationship('UserEmailMap', cascade='all')
586 user_ip_map = relationship('UserIpMap', cascade='all')
587 user_auth_tokens = relationship('UserApiKeys', cascade='all')
588 user_ssh_keys = relationship('UserSshKeys', cascade='all')
589
590 # gists
591 user_gists = relationship('Gist', cascade='all')
592 # user pull requests
593 user_pull_requests = relationship('PullRequest', cascade='all')
594 # external identities
595 extenal_identities = relationship(
596 'ExternalIdentity',
597 primaryjoin="User.user_id==ExternalIdentity.local_user_id",
598 cascade='all')
599 # review rules
600 user_review_rules = relationship('RepoReviewRuleUser', cascade='all')
601
602 def __unicode__(self):
603 return u"<%s('id:%s:%s')>" % (self.__class__.__name__,
604 self.user_id, self.username)
605
606 @hybrid_property
607 def email(self):
608 return self._email
609
610 @email.setter
611 def email(self, val):
612 self._email = val.lower() if val else None
613
614 @hybrid_property
615 def first_name(self):
616 from rhodecode.lib import helpers as h
617 if self.name:
618 return h.escape(self.name)
619 return self.name
620
621 @hybrid_property
622 def last_name(self):
623 from rhodecode.lib import helpers as h
624 if self.lastname:
625 return h.escape(self.lastname)
626 return self.lastname
627
628 @hybrid_property
629 def api_key(self):
630 """
631 Fetch if exist an auth-token with role ALL connected to this user
632 """
633 user_auth_token = UserApiKeys.query()\
634 .filter(UserApiKeys.user_id == self.user_id)\
635 .filter(or_(UserApiKeys.expires == -1,
636 UserApiKeys.expires >= time.time()))\
637 .filter(UserApiKeys.role == UserApiKeys.ROLE_ALL).first()
638 if user_auth_token:
639 user_auth_token = user_auth_token.api_key
640
641 return user_auth_token
642
643 @api_key.setter
644 def api_key(self, val):
645 # don't allow to set API key this is deprecated for now
646 self._api_key = None
647
648 @property
649 def reviewer_pull_requests(self):
650 return PullRequestReviewers.query() \
651 .options(joinedload(PullRequestReviewers.pull_request)) \
652 .filter(PullRequestReviewers.user_id == self.user_id) \
653 .all()
654
655 @property
656 def firstname(self):
657 # alias for future
658 return self.name
659
660 @property
661 def emails(self):
662 other = UserEmailMap.query()\
663 .filter(UserEmailMap.user == self) \
664 .order_by(UserEmailMap.email_id.asc()) \
665 .all()
666 return [self.email] + [x.email for x in other]
667
668 @property
669 def auth_tokens(self):
670 auth_tokens = self.get_auth_tokens()
671 return [x.api_key for x in auth_tokens]
672
673 def get_auth_tokens(self):
674 return UserApiKeys.query()\
675 .filter(UserApiKeys.user == self)\
676 .order_by(UserApiKeys.user_api_key_id.asc())\
677 .all()
678
679 @property
680 def feed_token(self):
681 return self.get_feed_token()
682
683 def get_feed_token(self):
684 feed_tokens = UserApiKeys.query()\
685 .filter(UserApiKeys.user == self)\
686 .filter(UserApiKeys.role == UserApiKeys.ROLE_FEED)\
687 .all()
688 if feed_tokens:
689 return feed_tokens[0].api_key
690 return 'NO_FEED_TOKEN_AVAILABLE'
691
692 @classmethod
693 def get(cls, user_id, cache=False):
694 if not user_id:
695 return
696
697 user = cls.query()
698 if cache:
699 user = user.options(
700 FromCache("sql_cache_short", "get_users_%s" % user_id))
701 return user.get(user_id)
702
703 @classmethod
704 def extra_valid_auth_tokens(cls, user, role=None):
705 tokens = UserApiKeys.query().filter(UserApiKeys.user == user)\
706 .filter(or_(UserApiKeys.expires == -1,
707 UserApiKeys.expires >= time.time()))
708 if role:
709 tokens = tokens.filter(or_(UserApiKeys.role == role,
710 UserApiKeys.role == UserApiKeys.ROLE_ALL))
711 return tokens.all()
712
713 def authenticate_by_token(self, auth_token, roles=None, scope_repo_id=None):
714 from rhodecode.lib import auth
715
716 log.debug('Trying to authenticate user: %s via auth-token, '
717 'and roles: %s', self, roles)
718
719 if not auth_token:
720 return False
721
722 crypto_backend = auth.crypto_backend()
723
724 roles = (roles or []) + [UserApiKeys.ROLE_ALL]
725 tokens_q = UserApiKeys.query()\
726 .filter(UserApiKeys.user_id == self.user_id)\
727 .filter(or_(UserApiKeys.expires == -1,
728 UserApiKeys.expires >= time.time()))
729
730 tokens_q = tokens_q.filter(UserApiKeys.role.in_(roles))
731
732 plain_tokens = []
733 hash_tokens = []
734
735 for token in tokens_q.all():
736 # verify scope first
737 if token.repo_id:
738 # token has a scope, we need to verify it
739 if scope_repo_id != token.repo_id:
740 log.debug(
741 'Scope mismatch: token has a set repo scope: %s, '
742 'and calling scope is:%s, skipping further checks',
743 token.repo, scope_repo_id)
744 # token has a scope, and it doesn't match, skip token
745 continue
746
747 if token.api_key.startswith(crypto_backend.ENC_PREF):
748 hash_tokens.append(token.api_key)
749 else:
750 plain_tokens.append(token.api_key)
751
752 is_plain_match = auth_token in plain_tokens
753 if is_plain_match:
754 return True
755
756 for hashed in hash_tokens:
757 # TODO(marcink): this is expensive to calculate, but most secure
758 match = crypto_backend.hash_check(auth_token, hashed)
759 if match:
760 return True
761
762 return False
763
764 @property
765 def ip_addresses(self):
766 ret = UserIpMap.query().filter(UserIpMap.user == self).all()
767 return [x.ip_addr for x in ret]
768
769 @property
770 def username_and_name(self):
771 return '%s (%s %s)' % (self.username, self.first_name, self.last_name)
772
773 @property
774 def username_or_name_or_email(self):
775 full_name = self.full_name if self.full_name is not ' ' else None
776 return self.username or full_name or self.email
777
778 @property
779 def full_name(self):
780 return '%s %s' % (self.first_name, self.last_name)
781
782 @property
783 def full_name_or_username(self):
784 return ('%s %s' % (self.first_name, self.last_name)
785 if (self.first_name and self.last_name) else self.username)
786
787 @property
788 def full_contact(self):
789 return '%s %s <%s>' % (self.first_name, self.last_name, self.email)
790
791 @property
792 def short_contact(self):
793 return '%s %s' % (self.first_name, self.last_name)
794
795 @property
796 def is_admin(self):
797 return self.admin
798
799 def AuthUser(self, **kwargs):
800 """
801 Returns instance of AuthUser for this user
802 """
803 from rhodecode.lib.auth import AuthUser
804 return AuthUser(user_id=self.user_id, username=self.username, **kwargs)
805
806 @hybrid_property
807 def user_data(self):
808 if not self._user_data:
809 return {}
810
811 try:
812 return json.loads(self._user_data)
813 except TypeError:
814 return {}
815
816 @user_data.setter
817 def user_data(self, val):
818 if not isinstance(val, dict):
819 raise Exception('user_data must be dict, got %s' % type(val))
820 try:
821 self._user_data = json.dumps(val)
822 except Exception:
823 log.error(traceback.format_exc())
824
825 @classmethod
826 def get_by_username(cls, username, case_insensitive=False,
827 cache=False, identity_cache=False):
828 session = Session()
829
830 if case_insensitive:
831 q = cls.query().filter(
832 func.lower(cls.username) == func.lower(username))
833 else:
834 q = cls.query().filter(cls.username == username)
835
836 if cache:
837 if identity_cache:
838 val = cls.identity_cache(session, 'username', username)
839 if val:
840 return val
841 else:
842 cache_key = "get_user_by_name_%s" % _hash_key(username)
843 q = q.options(
844 FromCache("sql_cache_short", cache_key))
845
846 return q.scalar()
847
848 @classmethod
849 def get_by_auth_token(cls, auth_token, cache=False):
850 q = UserApiKeys.query()\
851 .filter(UserApiKeys.api_key == auth_token)\
852 .filter(or_(UserApiKeys.expires == -1,
853 UserApiKeys.expires >= time.time()))
854 if cache:
855 q = q.options(
856 FromCache("sql_cache_short", "get_auth_token_%s" % auth_token))
857
858 match = q.first()
859 if match:
860 return match.user
861
862 @classmethod
863 def get_by_email(cls, email, case_insensitive=False, cache=False):
864
865 if case_insensitive:
866 q = cls.query().filter(func.lower(cls.email) == func.lower(email))
867
868 else:
869 q = cls.query().filter(cls.email == email)
870
871 email_key = _hash_key(email)
872 if cache:
873 q = q.options(
874 FromCache("sql_cache_short", "get_email_key_%s" % email_key))
875
876 ret = q.scalar()
877 if ret is None:
878 q = UserEmailMap.query()
879 # try fetching in alternate email map
880 if case_insensitive:
881 q = q.filter(func.lower(UserEmailMap.email) == func.lower(email))
882 else:
883 q = q.filter(UserEmailMap.email == email)
884 q = q.options(joinedload(UserEmailMap.user))
885 if cache:
886 q = q.options(
887 FromCache("sql_cache_short", "get_email_map_key_%s" % email_key))
888 ret = getattr(q.scalar(), 'user', None)
889
890 return ret
891
892 @classmethod
893 def get_from_cs_author(cls, author):
894 """
895 Tries to get User objects out of commit author string
896
897 :param author:
898 """
899 from rhodecode.lib.helpers import email, author_name
900 # Valid email in the attribute passed, see if they're in the system
901 _email = email(author)
902 if _email:
903 user = cls.get_by_email(_email, case_insensitive=True)
904 if user:
905 return user
906 # Maybe we can match by username?
907 _author = author_name(author)
908 user = cls.get_by_username(_author, case_insensitive=True)
909 if user:
910 return user
911
912 def update_userdata(self, **kwargs):
913 usr = self
914 old = usr.user_data
915 old.update(**kwargs)
916 usr.user_data = old
917 Session().add(usr)
918 log.debug('updated userdata with ', kwargs)
919
920 def update_lastlogin(self):
921 """Update user lastlogin"""
922 self.last_login = datetime.datetime.now()
923 Session().add(self)
924 log.debug('updated user %s lastlogin', self.username)
925
926 def update_lastactivity(self):
927 """Update user lastactivity"""
928 self.last_activity = datetime.datetime.now()
929 Session().add(self)
930 log.debug('updated user `%s` last activity', self.username)
931
932 def update_password(self, new_password):
933 from rhodecode.lib.auth import get_crypt_password
934
935 self.password = get_crypt_password(new_password)
936 Session().add(self)
937
938 @classmethod
939 def get_first_super_admin(cls):
940 user = User.query().filter(User.admin == true()).first()
941 if user is None:
942 raise Exception('FATAL: Missing administrative account!')
943 return user
944
945 @classmethod
946 def get_all_super_admins(cls):
947 """
948 Returns all admin accounts sorted by username
949 """
950 return User.query().filter(User.admin == true())\
951 .order_by(User.username.asc()).all()
952
953 @classmethod
954 def get_default_user(cls, cache=False, refresh=False):
955 user = User.get_by_username(User.DEFAULT_USER, cache=cache)
956 if user is None:
957 raise Exception('FATAL: Missing default account!')
958 if refresh:
959 # The default user might be based on outdated state which
960 # has been loaded from the cache.
961 # A call to refresh() ensures that the
962 # latest state from the database is used.
963 Session().refresh(user)
964 return user
965
966 def _get_default_perms(self, user, suffix=''):
967 from rhodecode.model.permission import PermissionModel
968 return PermissionModel().get_default_perms(user.user_perms, suffix)
969
970 def get_default_perms(self, suffix=''):
971 return self._get_default_perms(self, suffix)
972
973 def get_api_data(self, include_secrets=False, details='full'):
974 """
975 Common function for generating user related data for API
976
977 :param include_secrets: By default secrets in the API data will be replaced
978 by a placeholder value to prevent exposing this data by accident. In case
979 this data shall be exposed, set this flag to ``True``.
980
981 :param details: details can be 'basic|full' basic gives only a subset of
982 the available user information that includes user_id, name and emails.
983 """
984 user = self
985 user_data = self.user_data
986 data = {
987 'user_id': user.user_id,
988 'username': user.username,
989 'firstname': user.name,
990 'lastname': user.lastname,
991 'email': user.email,
992 'emails': user.emails,
993 }
994 if details == 'basic':
995 return data
996
997 auth_token_length = 40
998 auth_token_replacement = '*' * auth_token_length
999
1000 extras = {
1001 'auth_tokens': [auth_token_replacement],
1002 'active': user.active,
1003 'admin': user.admin,
1004 'extern_type': user.extern_type,
1005 'extern_name': user.extern_name,
1006 'last_login': user.last_login,
1007 'last_activity': user.last_activity,
1008 'ip_addresses': user.ip_addresses,
1009 'language': user_data.get('language')
1010 }
1011 data.update(extras)
1012
1013 if include_secrets:
1014 data['auth_tokens'] = user.auth_tokens
1015 return data
1016
1017 def __json__(self):
1018 data = {
1019 'full_name': self.full_name,
1020 'full_name_or_username': self.full_name_or_username,
1021 'short_contact': self.short_contact,
1022 'full_contact': self.full_contact,
1023 }
1024 data.update(self.get_api_data())
1025 return data
1026
1027
1028 class UserApiKeys(Base, BaseModel):
1029 __tablename__ = 'user_api_keys'
1030 __table_args__ = (
1031 Index('uak_api_key_idx', 'api_key', unique=True),
1032 Index('uak_api_key_expires_idx', 'api_key', 'expires'),
1033 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1034 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
1035 )
1036 __mapper_args__ = {}
1037
1038 # ApiKey role
1039 ROLE_ALL = 'token_role_all'
1040 ROLE_HTTP = 'token_role_http'
1041 ROLE_VCS = 'token_role_vcs'
1042 ROLE_API = 'token_role_api'
1043 ROLE_FEED = 'token_role_feed'
1044 ROLE_PASSWORD_RESET = 'token_password_reset'
1045
1046 ROLES = [ROLE_ALL, ROLE_HTTP, ROLE_VCS, ROLE_API, ROLE_FEED]
1047
1048 user_api_key_id = Column("user_api_key_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1049 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1050 api_key = Column("api_key", String(255), nullable=False, unique=True)
1051 description = Column('description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
1052 expires = Column('expires', Float(53), nullable=False)
1053 role = Column('role', String(255), nullable=True)
1054 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1055
1056 # scope columns
1057 repo_id = Column(
1058 'repo_id', Integer(), ForeignKey('repositories.repo_id'),
1059 nullable=True, unique=None, default=None)
1060 repo = relationship('Repository', lazy='joined')
1061
1062 repo_group_id = Column(
1063 'repo_group_id', Integer(), ForeignKey('groups.group_id'),
1064 nullable=True, unique=None, default=None)
1065 repo_group = relationship('RepoGroup', lazy='joined')
1066
1067 user = relationship('User', lazy='joined')
1068
1069 def __unicode__(self):
1070 return u"<%s('%s')>" % (self.__class__.__name__, self.role)
1071
1072 def __json__(self):
1073 data = {
1074 'auth_token': self.api_key,
1075 'role': self.role,
1076 'scope': self.scope_humanized,
1077 'expired': self.expired
1078 }
1079 return data
1080
1081 def get_api_data(self, include_secrets=False):
1082 data = self.__json__()
1083 if include_secrets:
1084 return data
1085 else:
1086 data['auth_token'] = self.token_obfuscated
1087 return data
1088
1089 @hybrid_property
1090 def description_safe(self):
1091 from rhodecode.lib import helpers as h
1092 return h.escape(self.description)
1093
1094 @property
1095 def expired(self):
1096 if self.expires == -1:
1097 return False
1098 return time.time() > self.expires
1099
1100 @classmethod
1101 def _get_role_name(cls, role):
1102 return {
1103 cls.ROLE_ALL: _('all'),
1104 cls.ROLE_HTTP: _('http/web interface'),
1105 cls.ROLE_VCS: _('vcs (git/hg/svn protocol)'),
1106 cls.ROLE_API: _('api calls'),
1107 cls.ROLE_FEED: _('feed access'),
1108 }.get(role, role)
1109
1110 @property
1111 def role_humanized(self):
1112 return self._get_role_name(self.role)
1113
1114 def _get_scope(self):
1115 if self.repo:
1116 return repr(self.repo)
1117 if self.repo_group:
1118 return repr(self.repo_group) + ' (recursive)'
1119 return 'global'
1120
1121 @property
1122 def scope_humanized(self):
1123 return self._get_scope()
1124
1125 @property
1126 def token_obfuscated(self):
1127 if self.api_key:
1128 return self.api_key[:4] + "****"
1129
1130
1131 class UserEmailMap(Base, BaseModel):
1132 __tablename__ = 'user_email_map'
1133 __table_args__ = (
1134 Index('uem_email_idx', 'email'),
1135 UniqueConstraint('email'),
1136 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1137 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
1138 )
1139 __mapper_args__ = {}
1140
1141 email_id = Column("email_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1142 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1143 _email = Column("email", String(255), nullable=True, unique=False, default=None)
1144 user = relationship('User', lazy='joined')
1145
1146 @validates('_email')
1147 def validate_email(self, key, email):
1148 # check if this email is not main one
1149 main_email = Session().query(User).filter(User.email == email).scalar()
1150 if main_email is not None:
1151 raise AttributeError('email %s is present is user table' % email)
1152 return email
1153
1154 @hybrid_property
1155 def email(self):
1156 return self._email
1157
1158 @email.setter
1159 def email(self, val):
1160 self._email = val.lower() if val else None
1161
1162
1163 class UserIpMap(Base, BaseModel):
1164 __tablename__ = 'user_ip_map'
1165 __table_args__ = (
1166 UniqueConstraint('user_id', 'ip_addr'),
1167 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1168 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
1169 )
1170 __mapper_args__ = {}
1171
1172 ip_id = Column("ip_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1173 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1174 ip_addr = Column("ip_addr", String(255), nullable=True, unique=False, default=None)
1175 active = Column("active", Boolean(), nullable=True, unique=None, default=True)
1176 description = Column("description", String(10000), nullable=True, unique=None, default=None)
1177 user = relationship('User', lazy='joined')
1178
1179 @hybrid_property
1180 def description_safe(self):
1181 from rhodecode.lib import helpers as h
1182 return h.escape(self.description)
1183
1184 @classmethod
1185 def _get_ip_range(cls, ip_addr):
1186 net = ipaddress.ip_network(safe_unicode(ip_addr), strict=False)
1187 return [str(net.network_address), str(net.broadcast_address)]
1188
1189 def __json__(self):
1190 return {
1191 'ip_addr': self.ip_addr,
1192 'ip_range': self._get_ip_range(self.ip_addr),
1193 }
1194
1195 def __unicode__(self):
1196 return u"<%s('user_id:%s=>%s')>" % (self.__class__.__name__,
1197 self.user_id, self.ip_addr)
1198
1199
1200 class UserSshKeys(Base, BaseModel):
1201 __tablename__ = 'user_ssh_keys'
1202 __table_args__ = (
1203 Index('usk_ssh_key_fingerprint_idx', 'ssh_key_fingerprint'),
1204
1205 UniqueConstraint('ssh_key_fingerprint'),
1206
1207 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1208 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
1209 )
1210 __mapper_args__ = {}
1211
1212 ssh_key_id = Column('ssh_key_id', Integer(), nullable=False, unique=True, default=None, primary_key=True)
1213 ssh_key_data = Column('ssh_key_data', String(10240), nullable=False, unique=None, default=None)
1214 ssh_key_fingerprint = Column('ssh_key_fingerprint', String(255), nullable=False, unique=None, default=None)
1215
1216 description = Column('description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
1217
1218 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1219 accessed_on = Column('accessed_on', DateTime(timezone=False), nullable=True, default=None)
1220 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1221
1222 user = relationship('User', lazy='joined')
1223
1224 def __json__(self):
1225 data = {
1226 'ssh_fingerprint': self.ssh_key_fingerprint,
1227 'description': self.description,
1228 'created_on': self.created_on
1229 }
1230 return data
1231
1232 def get_api_data(self):
1233 data = self.__json__()
1234 return data
1235
1236
1237 class UserLog(Base, BaseModel):
1238 __tablename__ = 'user_logs'
1239 __table_args__ = (
1240 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1241 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1242 )
1243 VERSION_1 = 'v1'
1244 VERSION_2 = 'v2'
1245 VERSIONS = [VERSION_1, VERSION_2]
1246
1247 user_log_id = Column("user_log_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1248 user_id = Column("user_id", Integer(), ForeignKey('users.user_id',ondelete='SET NULL'), nullable=True, unique=None, default=None)
1249 username = Column("username", String(255), nullable=True, unique=None, default=None)
1250 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id', ondelete='SET NULL'), nullable=True, unique=None, default=None)
1251 repository_name = Column("repository_name", String(255), nullable=True, unique=None, default=None)
1252 user_ip = Column("user_ip", String(255), nullable=True, unique=None, default=None)
1253 action = Column("action", Text().with_variant(Text(1200000), 'mysql'), nullable=True, unique=None, default=None)
1254 action_date = Column("action_date", DateTime(timezone=False), nullable=True, unique=None, default=None)
1255
1256 version = Column("version", String(255), nullable=True, default=VERSION_1)
1257 user_data = Column('user_data_json', MutationObj.as_mutable(JsonType(dialect_map=dict(mysql=LONGTEXT()))))
1258 action_data = Column('action_data_json', MutationObj.as_mutable(JsonType(dialect_map=dict(mysql=LONGTEXT()))))
1259
1260 def __unicode__(self):
1261 return u"<%s('id:%s:%s')>" % (
1262 self.__class__.__name__, self.repository_name, self.action)
1263
1264 def __json__(self):
1265 return {
1266 'user_id': self.user_id,
1267 'username': self.username,
1268 'repository_id': self.repository_id,
1269 'repository_name': self.repository_name,
1270 'user_ip': self.user_ip,
1271 'action_date': self.action_date,
1272 'action': self.action,
1273 }
1274
1275 @hybrid_property
1276 def entry_id(self):
1277 return self.user_log_id
1278
1279 @property
1280 def action_as_day(self):
1281 return datetime.date(*self.action_date.timetuple()[:3])
1282
1283 user = relationship('User')
1284 repository = relationship('Repository', cascade='')
1285
1286
1287 class UserGroup(Base, BaseModel):
1288 __tablename__ = 'users_groups'
1289 __table_args__ = (
1290 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1291 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1292 )
1293
1294 users_group_id = Column("users_group_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1295 users_group_name = Column("users_group_name", String(255), nullable=False, unique=True, default=None)
1296 user_group_description = Column("user_group_description", String(10000), nullable=True, unique=None, default=None)
1297 users_group_active = Column("users_group_active", Boolean(), nullable=True, unique=None, default=None)
1298 inherit_default_permissions = Column("users_group_inherit_default_permissions", Boolean(), nullable=False, unique=None, default=True)
1299 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=False, default=None)
1300 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1301 _group_data = Column("group_data", LargeBinary(), nullable=True) # JSON data
1302
1303 members = relationship('UserGroupMember', cascade="all, delete, delete-orphan", lazy="joined")
1304 users_group_to_perm = relationship('UserGroupToPerm', cascade='all')
1305 users_group_repo_to_perm = relationship('UserGroupRepoToPerm', cascade='all')
1306 users_group_repo_group_to_perm = relationship('UserGroupRepoGroupToPerm', cascade='all')
1307 user_user_group_to_perm = relationship('UserUserGroupToPerm', cascade='all')
1308 user_group_user_group_to_perm = relationship('UserGroupUserGroupToPerm ', primaryjoin="UserGroupUserGroupToPerm.target_user_group_id==UserGroup.users_group_id", cascade='all')
1309
1310 user_group_review_rules = relationship('RepoReviewRuleUserGroup', cascade='all')
1311 user = relationship('User', primaryjoin="User.user_id==UserGroup.user_id")
1312
1313 @classmethod
1314 def _load_group_data(cls, column):
1315 if not column:
1316 return {}
1317
1318 try:
1319 return json.loads(column) or {}
1320 except TypeError:
1321 return {}
1322
1323 @hybrid_property
1324 def description_safe(self):
1325 from rhodecode.lib import helpers as h
1326 return h.escape(self.description)
1327
1328 @hybrid_property
1329 def group_data(self):
1330 return self._load_group_data(self._group_data)
1331
1332 @group_data.expression
1333 def group_data(self, **kwargs):
1334 return self._group_data
1335
1336 @group_data.setter
1337 def group_data(self, val):
1338 try:
1339 self._group_data = json.dumps(val)
1340 except Exception:
1341 log.error(traceback.format_exc())
1342
1343 def __unicode__(self):
1344 return u"<%s('id:%s:%s')>" % (self.__class__.__name__,
1345 self.users_group_id,
1346 self.users_group_name)
1347
1348 @classmethod
1349 def get_by_group_name(cls, group_name, cache=False,
1350 case_insensitive=False):
1351 if case_insensitive:
1352 q = cls.query().filter(func.lower(cls.users_group_name) ==
1353 func.lower(group_name))
1354
1355 else:
1356 q = cls.query().filter(cls.users_group_name == group_name)
1357 if cache:
1358 q = q.options(
1359 FromCache("sql_cache_short", "get_group_%s" % _hash_key(group_name)))
1360 return q.scalar()
1361
1362 @classmethod
1363 def get(cls, user_group_id, cache=False):
1364 if not user_group_id:
1365 return
1366
1367 user_group = cls.query()
1368 if cache:
1369 user_group = user_group.options(
1370 FromCache("sql_cache_short", "get_users_group_%s" % user_group_id))
1371 return user_group.get(user_group_id)
1372
1373 def permissions(self, with_admins=True, with_owner=True):
1374 q = UserUserGroupToPerm.query().filter(UserUserGroupToPerm.user_group == self)
1375 q = q.options(joinedload(UserUserGroupToPerm.user_group),
1376 joinedload(UserUserGroupToPerm.user),
1377 joinedload(UserUserGroupToPerm.permission),)
1378
1379 # get owners and admins and permissions. We do a trick of re-writing
1380 # objects from sqlalchemy to named-tuples due to sqlalchemy session
1381 # has a global reference and changing one object propagates to all
1382 # others. This means if admin is also an owner admin_row that change
1383 # would propagate to both objects
1384 perm_rows = []
1385 for _usr in q.all():
1386 usr = AttributeDict(_usr.user.get_dict())
1387 usr.permission = _usr.permission.permission_name
1388 perm_rows.append(usr)
1389
1390 # filter the perm rows by 'default' first and then sort them by
1391 # admin,write,read,none permissions sorted again alphabetically in
1392 # each group
1393 perm_rows = sorted(perm_rows, key=display_user_sort)
1394
1395 _admin_perm = 'usergroup.admin'
1396 owner_row = []
1397 if with_owner:
1398 usr = AttributeDict(self.user.get_dict())
1399 usr.owner_row = True
1400 usr.permission = _admin_perm
1401 owner_row.append(usr)
1402
1403 super_admin_rows = []
1404 if with_admins:
1405 for usr in User.get_all_super_admins():
1406 # if this admin is also owner, don't double the record
1407 if usr.user_id == owner_row[0].user_id:
1408 owner_row[0].admin_row = True
1409 else:
1410 usr = AttributeDict(usr.get_dict())
1411 usr.admin_row = True
1412 usr.permission = _admin_perm
1413 super_admin_rows.append(usr)
1414
1415 return super_admin_rows + owner_row + perm_rows
1416
1417 def permission_user_groups(self):
1418 q = UserGroupUserGroupToPerm.query().filter(UserGroupUserGroupToPerm.target_user_group == self)
1419 q = q.options(joinedload(UserGroupUserGroupToPerm.user_group),
1420 joinedload(UserGroupUserGroupToPerm.target_user_group),
1421 joinedload(UserGroupUserGroupToPerm.permission),)
1422
1423 perm_rows = []
1424 for _user_group in q.all():
1425 usr = AttributeDict(_user_group.user_group.get_dict())
1426 usr.permission = _user_group.permission.permission_name
1427 perm_rows.append(usr)
1428
1429 perm_rows = sorted(perm_rows, key=display_user_group_sort)
1430 return perm_rows
1431
1432 def _get_default_perms(self, user_group, suffix=''):
1433 from rhodecode.model.permission import PermissionModel
1434 return PermissionModel().get_default_perms(user_group.users_group_to_perm, suffix)
1435
1436 def get_default_perms(self, suffix=''):
1437 return self._get_default_perms(self, suffix)
1438
1439 def get_api_data(self, with_group_members=True, include_secrets=False):
1440 """
1441 :param include_secrets: See :meth:`User.get_api_data`, this parameter is
1442 basically forwarded.
1443
1444 """
1445 user_group = self
1446 data = {
1447 'users_group_id': user_group.users_group_id,
1448 'group_name': user_group.users_group_name,
1449 'group_description': user_group.user_group_description,
1450 'active': user_group.users_group_active,
1451 'owner': user_group.user.username,
1452 'owner_email': user_group.user.email,
1453 }
1454
1455 if with_group_members:
1456 users = []
1457 for user in user_group.members:
1458 user = user.user
1459 users.append(user.get_api_data(include_secrets=include_secrets))
1460 data['users'] = users
1461
1462 return data
1463
1464
1465 class UserGroupMember(Base, BaseModel):
1466 __tablename__ = 'users_groups_members'
1467 __table_args__ = (
1468 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1469 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1470 )
1471
1472 users_group_member_id = Column("users_group_member_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1473 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
1474 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
1475
1476 user = relationship('User', lazy='joined')
1477 users_group = relationship('UserGroup')
1478
1479 def __init__(self, gr_id='', u_id=''):
1480 self.users_group_id = gr_id
1481 self.user_id = u_id
1482
1483
1484 class RepositoryField(Base, BaseModel):
1485 __tablename__ = 'repositories_fields'
1486 __table_args__ = (
1487 UniqueConstraint('repository_id', 'field_key'), # no-multi field
1488 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1489 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1490 )
1491 PREFIX = 'ex_' # prefix used in form to not conflict with already existing fields
1492
1493 repo_field_id = Column("repo_field_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1494 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
1495 field_key = Column("field_key", String(250))
1496 field_label = Column("field_label", String(1024), nullable=False)
1497 field_value = Column("field_value", String(10000), nullable=False)
1498 field_desc = Column("field_desc", String(1024), nullable=False)
1499 field_type = Column("field_type", String(255), nullable=False, unique=None)
1500 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1501
1502 repository = relationship('Repository')
1503
1504 @property
1505 def field_key_prefixed(self):
1506 return 'ex_%s' % self.field_key
1507
1508 @classmethod
1509 def un_prefix_key(cls, key):
1510 if key.startswith(cls.PREFIX):
1511 return key[len(cls.PREFIX):]
1512 return key
1513
1514 @classmethod
1515 def get_by_key_name(cls, key, repo):
1516 row = cls.query()\
1517 .filter(cls.repository == repo)\
1518 .filter(cls.field_key == key).scalar()
1519 return row
1520
1521
1522 class Repository(Base, BaseModel):
1523 __tablename__ = 'repositories'
1524 __table_args__ = (
1525 Index('r_repo_name_idx', 'repo_name', mysql_length=255),
1526 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1527 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1528 )
1529 DEFAULT_CLONE_URI = '{scheme}://{user}@{netloc}/{repo}'
1530 DEFAULT_CLONE_URI_ID = '{scheme}://{user}@{netloc}/_{repoid}'
1531
1532 STATE_CREATED = 'repo_state_created'
1533 STATE_PENDING = 'repo_state_pending'
1534 STATE_ERROR = 'repo_state_error'
1535
1536 LOCK_AUTOMATIC = 'lock_auto'
1537 LOCK_API = 'lock_api'
1538 LOCK_WEB = 'lock_web'
1539 LOCK_PULL = 'lock_pull'
1540
1541 NAME_SEP = URL_SEP
1542
1543 repo_id = Column(
1544 "repo_id", Integer(), nullable=False, unique=True, default=None,
1545 primary_key=True)
1546 _repo_name = Column(
1547 "repo_name", Text(), nullable=False, default=None)
1548 _repo_name_hash = Column(
1549 "repo_name_hash", String(255), nullable=False, unique=True)
1550 repo_state = Column("repo_state", String(255), nullable=True)
1551
1552 clone_uri = Column(
1553 "clone_uri", EncryptedTextValue(), nullable=True, unique=False,
1554 default=None)
1555 repo_type = Column(
1556 "repo_type", String(255), nullable=False, unique=False, default=None)
1557 user_id = Column(
1558 "user_id", Integer(), ForeignKey('users.user_id'), nullable=False,
1559 unique=False, default=None)
1560 private = Column(
1561 "private", Boolean(), nullable=True, unique=None, default=None)
1562 enable_statistics = Column(
1563 "statistics", Boolean(), nullable=True, unique=None, default=True)
1564 enable_downloads = Column(
1565 "downloads", Boolean(), nullable=True, unique=None, default=True)
1566 description = Column(
1567 "description", String(10000), nullable=True, unique=None, default=None)
1568 created_on = Column(
1569 'created_on', DateTime(timezone=False), nullable=True, unique=None,
1570 default=datetime.datetime.now)
1571 updated_on = Column(
1572 'updated_on', DateTime(timezone=False), nullable=True, unique=None,
1573 default=datetime.datetime.now)
1574 _landing_revision = Column(
1575 "landing_revision", String(255), nullable=False, unique=False,
1576 default=None)
1577 enable_locking = Column(
1578 "enable_locking", Boolean(), nullable=False, unique=None,
1579 default=False)
1580 _locked = Column(
1581 "locked", String(255), nullable=True, unique=False, default=None)
1582 _changeset_cache = Column(
1583 "changeset_cache", LargeBinary(), nullable=True) # JSON data
1584
1585 fork_id = Column(
1586 "fork_id", Integer(), ForeignKey('repositories.repo_id'),
1587 nullable=True, unique=False, default=None)
1588 group_id = Column(
1589 "group_id", Integer(), ForeignKey('groups.group_id'), nullable=True,
1590 unique=False, default=None)
1591
1592 user = relationship('User', lazy='joined')
1593 fork = relationship('Repository', remote_side=repo_id, lazy='joined')
1594 group = relationship('RepoGroup', lazy='joined')
1595 repo_to_perm = relationship(
1596 'UserRepoToPerm', cascade='all',
1597 order_by='UserRepoToPerm.repo_to_perm_id')
1598 users_group_to_perm = relationship('UserGroupRepoToPerm', cascade='all')
1599 stats = relationship('Statistics', cascade='all', uselist=False)
1600
1601 followers = relationship(
1602 'UserFollowing',
1603 primaryjoin='UserFollowing.follows_repo_id==Repository.repo_id',
1604 cascade='all')
1605 extra_fields = relationship(
1606 'RepositoryField', cascade="all, delete, delete-orphan")
1607 logs = relationship('UserLog')
1608 comments = relationship(
1609 'ChangesetComment', cascade="all, delete, delete-orphan")
1610 pull_requests_source = relationship(
1611 'PullRequest',
1612 primaryjoin='PullRequest.source_repo_id==Repository.repo_id',
1613 cascade="all, delete, delete-orphan")
1614 pull_requests_target = relationship(
1615 'PullRequest',
1616 primaryjoin='PullRequest.target_repo_id==Repository.repo_id',
1617 cascade="all, delete, delete-orphan")
1618 ui = relationship('RepoRhodeCodeUi', cascade="all")
1619 settings = relationship('RepoRhodeCodeSetting', cascade="all")
1620 integrations = relationship('Integration',
1621 cascade="all, delete, delete-orphan")
1622
1623 def __unicode__(self):
1624 return u"<%s('%s:%s')>" % (self.__class__.__name__, self.repo_id,
1625 safe_unicode(self.repo_name))
1626
1627 @hybrid_property
1628 def description_safe(self):
1629 from rhodecode.lib import helpers as h
1630 return h.escape(self.description)
1631
1632 @hybrid_property
1633 def landing_rev(self):
1634 # always should return [rev_type, rev]
1635 if self._landing_revision:
1636 _rev_info = self._landing_revision.split(':')
1637 if len(_rev_info) < 2:
1638 _rev_info.insert(0, 'rev')
1639 return [_rev_info[0], _rev_info[1]]
1640 return [None, None]
1641
1642 @landing_rev.setter
1643 def landing_rev(self, val):
1644 if ':' not in val:
1645 raise ValueError('value must be delimited with `:` and consist '
1646 'of <rev_type>:<rev>, got %s instead' % val)
1647 self._landing_revision = val
1648
1649 @hybrid_property
1650 def locked(self):
1651 if self._locked:
1652 user_id, timelocked, reason = self._locked.split(':')
1653 lock_values = int(user_id), timelocked, reason
1654 else:
1655 lock_values = [None, None, None]
1656 return lock_values
1657
1658 @locked.setter
1659 def locked(self, val):
1660 if val and isinstance(val, (list, tuple)):
1661 self._locked = ':'.join(map(str, val))
1662 else:
1663 self._locked = None
1664
1665 @hybrid_property
1666 def changeset_cache(self):
1667 from rhodecode.lib.vcs.backends.base import EmptyCommit
1668 dummy = EmptyCommit().__json__()
1669 if not self._changeset_cache:
1670 return dummy
1671 try:
1672 return json.loads(self._changeset_cache)
1673 except TypeError:
1674 return dummy
1675 except Exception:
1676 log.error(traceback.format_exc())
1677 return dummy
1678
1679 @changeset_cache.setter
1680 def changeset_cache(self, val):
1681 try:
1682 self._changeset_cache = json.dumps(val)
1683 except Exception:
1684 log.error(traceback.format_exc())
1685
1686 @hybrid_property
1687 def repo_name(self):
1688 return self._repo_name
1689
1690 @repo_name.setter
1691 def repo_name(self, value):
1692 self._repo_name = value
1693 self._repo_name_hash = hashlib.sha1(safe_str(value)).hexdigest()
1694
1695 @classmethod
1696 def normalize_repo_name(cls, repo_name):
1697 """
1698 Normalizes os specific repo_name to the format internally stored inside
1699 database using URL_SEP
1700
1701 :param cls:
1702 :param repo_name:
1703 """
1704 return cls.NAME_SEP.join(repo_name.split(os.sep))
1705
1706 @classmethod
1707 def get_by_repo_name(cls, repo_name, cache=False, identity_cache=False):
1708 session = Session()
1709 q = session.query(cls).filter(cls.repo_name == repo_name)
1710
1711 if cache:
1712 if identity_cache:
1713 val = cls.identity_cache(session, 'repo_name', repo_name)
1714 if val:
1715 return val
1716 else:
1717 cache_key = "get_repo_by_name_%s" % _hash_key(repo_name)
1718 q = q.options(
1719 FromCache("sql_cache_short", cache_key))
1720
1721 return q.scalar()
1722
1723 @classmethod
1724 def get_by_full_path(cls, repo_full_path):
1725 repo_name = repo_full_path.split(cls.base_path(), 1)[-1]
1726 repo_name = cls.normalize_repo_name(repo_name)
1727 return cls.get_by_repo_name(repo_name.strip(URL_SEP))
1728
1729 @classmethod
1730 def get_repo_forks(cls, repo_id):
1731 return cls.query().filter(Repository.fork_id == repo_id)
1732
1733 @classmethod
1734 def base_path(cls):
1735 """
1736 Returns base path when all repos are stored
1737
1738 :param cls:
1739 """
1740 q = Session().query(RhodeCodeUi)\
1741 .filter(RhodeCodeUi.ui_key == cls.NAME_SEP)
1742 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
1743 return q.one().ui_value
1744
1745 @classmethod
1746 def is_valid(cls, repo_name):
1747 """
1748 returns True if given repo name is a valid filesystem repository
1749
1750 :param cls:
1751 :param repo_name:
1752 """
1753 from rhodecode.lib.utils import is_valid_repo
1754
1755 return is_valid_repo(repo_name, cls.base_path())
1756
1757 @classmethod
1758 def get_all_repos(cls, user_id=Optional(None), group_id=Optional(None),
1759 case_insensitive=True):
1760 q = Repository.query()
1761
1762 if not isinstance(user_id, Optional):
1763 q = q.filter(Repository.user_id == user_id)
1764
1765 if not isinstance(group_id, Optional):
1766 q = q.filter(Repository.group_id == group_id)
1767
1768 if case_insensitive:
1769 q = q.order_by(func.lower(Repository.repo_name))
1770 else:
1771 q = q.order_by(Repository.repo_name)
1772 return q.all()
1773
1774 @property
1775 def forks(self):
1776 """
1777 Return forks of this repo
1778 """
1779 return Repository.get_repo_forks(self.repo_id)
1780
1781 @property
1782 def parent(self):
1783 """
1784 Returns fork parent
1785 """
1786 return self.fork
1787
1788 @property
1789 def just_name(self):
1790 return self.repo_name.split(self.NAME_SEP)[-1]
1791
1792 @property
1793 def groups_with_parents(self):
1794 groups = []
1795 if self.group is None:
1796 return groups
1797
1798 cur_gr = self.group
1799 groups.insert(0, cur_gr)
1800 while 1:
1801 gr = getattr(cur_gr, 'parent_group', None)
1802 cur_gr = cur_gr.parent_group
1803 if gr is None:
1804 break
1805 groups.insert(0, gr)
1806
1807 return groups
1808
1809 @property
1810 def groups_and_repo(self):
1811 return self.groups_with_parents, self
1812
1813 @LazyProperty
1814 def repo_path(self):
1815 """
1816 Returns base full path for that repository means where it actually
1817 exists on a filesystem
1818 """
1819 q = Session().query(RhodeCodeUi).filter(
1820 RhodeCodeUi.ui_key == self.NAME_SEP)
1821 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
1822 return q.one().ui_value
1823
1824 @property
1825 def repo_full_path(self):
1826 p = [self.repo_path]
1827 # we need to split the name by / since this is how we store the
1828 # names in the database, but that eventually needs to be converted
1829 # into a valid system path
1830 p += self.repo_name.split(self.NAME_SEP)
1831 return os.path.join(*map(safe_unicode, p))
1832
1833 @property
1834 def cache_keys(self):
1835 """
1836 Returns associated cache keys for that repo
1837 """
1838 return CacheKey.query()\
1839 .filter(CacheKey.cache_args == self.repo_name)\
1840 .order_by(CacheKey.cache_key)\
1841 .all()
1842
1843 def get_new_name(self, repo_name):
1844 """
1845 returns new full repository name based on assigned group and new new
1846
1847 :param group_name:
1848 """
1849 path_prefix = self.group.full_path_splitted if self.group else []
1850 return self.NAME_SEP.join(path_prefix + [repo_name])
1851
1852 @property
1853 def _config(self):
1854 """
1855 Returns db based config object.
1856 """
1857 from rhodecode.lib.utils import make_db_config
1858 return make_db_config(clear_session=False, repo=self)
1859
1860 def permissions(self, with_admins=True, with_owner=True):
1861 q = UserRepoToPerm.query().filter(UserRepoToPerm.repository == self)
1862 q = q.options(joinedload(UserRepoToPerm.repository),
1863 joinedload(UserRepoToPerm.user),
1864 joinedload(UserRepoToPerm.permission),)
1865
1866 # get owners and admins and permissions. We do a trick of re-writing
1867 # objects from sqlalchemy to named-tuples due to sqlalchemy session
1868 # has a global reference and changing one object propagates to all
1869 # others. This means if admin is also an owner admin_row that change
1870 # would propagate to both objects
1871 perm_rows = []
1872 for _usr in q.all():
1873 usr = AttributeDict(_usr.user.get_dict())
1874 usr.permission = _usr.permission.permission_name
1875 perm_rows.append(usr)
1876
1877 # filter the perm rows by 'default' first and then sort them by
1878 # admin,write,read,none permissions sorted again alphabetically in
1879 # each group
1880 perm_rows = sorted(perm_rows, key=display_user_sort)
1881
1882 _admin_perm = 'repository.admin'
1883 owner_row = []
1884 if with_owner:
1885 usr = AttributeDict(self.user.get_dict())
1886 usr.owner_row = True
1887 usr.permission = _admin_perm
1888 owner_row.append(usr)
1889
1890 super_admin_rows = []
1891 if with_admins:
1892 for usr in User.get_all_super_admins():
1893 # if this admin is also owner, don't double the record
1894 if usr.user_id == owner_row[0].user_id:
1895 owner_row[0].admin_row = True
1896 else:
1897 usr = AttributeDict(usr.get_dict())
1898 usr.admin_row = True
1899 usr.permission = _admin_perm
1900 super_admin_rows.append(usr)
1901
1902 return super_admin_rows + owner_row + perm_rows
1903
1904 def permission_user_groups(self):
1905 q = UserGroupRepoToPerm.query().filter(
1906 UserGroupRepoToPerm.repository == self)
1907 q = q.options(joinedload(UserGroupRepoToPerm.repository),
1908 joinedload(UserGroupRepoToPerm.users_group),
1909 joinedload(UserGroupRepoToPerm.permission),)
1910
1911 perm_rows = []
1912 for _user_group in q.all():
1913 usr = AttributeDict(_user_group.users_group.get_dict())
1914 usr.permission = _user_group.permission.permission_name
1915 perm_rows.append(usr)
1916
1917 perm_rows = sorted(perm_rows, key=display_user_group_sort)
1918 return perm_rows
1919
1920 def get_api_data(self, include_secrets=False):
1921 """
1922 Common function for generating repo api data
1923
1924 :param include_secrets: See :meth:`User.get_api_data`.
1925
1926 """
1927 # TODO: mikhail: Here there is an anti-pattern, we probably need to
1928 # move this methods on models level.
1929 from rhodecode.model.settings import SettingsModel
1930 from rhodecode.model.repo import RepoModel
1931
1932 repo = self
1933 _user_id, _time, _reason = self.locked
1934
1935 data = {
1936 'repo_id': repo.repo_id,
1937 'repo_name': repo.repo_name,
1938 'repo_type': repo.repo_type,
1939 'clone_uri': repo.clone_uri or '',
1940 'url': RepoModel().get_url(self),
1941 'private': repo.private,
1942 'created_on': repo.created_on,
1943 'description': repo.description_safe,
1944 'landing_rev': repo.landing_rev,
1945 'owner': repo.user.username,
1946 'fork_of': repo.fork.repo_name if repo.fork else None,
1947 'fork_of_id': repo.fork.repo_id if repo.fork else None,
1948 'enable_statistics': repo.enable_statistics,
1949 'enable_locking': repo.enable_locking,
1950 'enable_downloads': repo.enable_downloads,
1951 'last_changeset': repo.changeset_cache,
1952 'locked_by': User.get(_user_id).get_api_data(
1953 include_secrets=include_secrets) if _user_id else None,
1954 'locked_date': time_to_datetime(_time) if _time else None,
1955 'lock_reason': _reason if _reason else None,
1956 }
1957
1958 # TODO: mikhail: should be per-repo settings here
1959 rc_config = SettingsModel().get_all_settings()
1960 repository_fields = str2bool(
1961 rc_config.get('rhodecode_repository_fields'))
1962 if repository_fields:
1963 for f in self.extra_fields:
1964 data[f.field_key_prefixed] = f.field_value
1965
1966 return data
1967
1968 @classmethod
1969 def lock(cls, repo, user_id, lock_time=None, lock_reason=None):
1970 if not lock_time:
1971 lock_time = time.time()
1972 if not lock_reason:
1973 lock_reason = cls.LOCK_AUTOMATIC
1974 repo.locked = [user_id, lock_time, lock_reason]
1975 Session().add(repo)
1976 Session().commit()
1977
1978 @classmethod
1979 def unlock(cls, repo):
1980 repo.locked = None
1981 Session().add(repo)
1982 Session().commit()
1983
1984 @classmethod
1985 def getlock(cls, repo):
1986 return repo.locked
1987
1988 def is_user_lock(self, user_id):
1989 if self.lock[0]:
1990 lock_user_id = safe_int(self.lock[0])
1991 user_id = safe_int(user_id)
1992 # both are ints, and they are equal
1993 return all([lock_user_id, user_id]) and lock_user_id == user_id
1994
1995 return False
1996
1997 def get_locking_state(self, action, user_id, only_when_enabled=True):
1998 """
1999 Checks locking on this repository, if locking is enabled and lock is
2000 present returns a tuple of make_lock, locked, locked_by.
2001 make_lock can have 3 states None (do nothing) True, make lock
2002 False release lock, This value is later propagated to hooks, which
2003 do the locking. Think about this as signals passed to hooks what to do.
2004
2005 """
2006 # TODO: johbo: This is part of the business logic and should be moved
2007 # into the RepositoryModel.
2008
2009 if action not in ('push', 'pull'):
2010 raise ValueError("Invalid action value: %s" % repr(action))
2011
2012 # defines if locked error should be thrown to user
2013 currently_locked = False
2014 # defines if new lock should be made, tri-state
2015 make_lock = None
2016 repo = self
2017 user = User.get(user_id)
2018
2019 lock_info = repo.locked
2020
2021 if repo and (repo.enable_locking or not only_when_enabled):
2022 if action == 'push':
2023 # check if it's already locked !, if it is compare users
2024 locked_by_user_id = lock_info[0]
2025 if user.user_id == locked_by_user_id:
2026 log.debug(
2027 'Got `push` action from user %s, now unlocking', user)
2028 # unlock if we have push from user who locked
2029 make_lock = False
2030 else:
2031 # we're not the same user who locked, ban with
2032 # code defined in settings (default is 423 HTTP Locked) !
2033 log.debug('Repo %s is currently locked by %s', repo, user)
2034 currently_locked = True
2035 elif action == 'pull':
2036 # [0] user [1] date
2037 if lock_info[0] and lock_info[1]:
2038 log.debug('Repo %s is currently locked by %s', repo, user)
2039 currently_locked = True
2040 else:
2041 log.debug('Setting lock on repo %s by %s', repo, user)
2042 make_lock = True
2043
2044 else:
2045 log.debug('Repository %s do not have locking enabled', repo)
2046
2047 log.debug('FINAL locking values make_lock:%s,locked:%s,locked_by:%s',
2048 make_lock, currently_locked, lock_info)
2049
2050 from rhodecode.lib.auth import HasRepoPermissionAny
2051 perm_check = HasRepoPermissionAny('repository.write', 'repository.admin')
2052 if make_lock and not perm_check(repo_name=repo.repo_name, user=user):
2053 # if we don't have at least write permission we cannot make a lock
2054 log.debug('lock state reset back to FALSE due to lack '
2055 'of at least read permission')
2056 make_lock = False
2057
2058 return make_lock, currently_locked, lock_info
2059
2060 @property
2061 def last_db_change(self):
2062 return self.updated_on
2063
2064 @property
2065 def clone_uri_hidden(self):
2066 clone_uri = self.clone_uri
2067 if clone_uri:
2068 import urlobject
2069 url_obj = urlobject.URLObject(cleaned_uri(clone_uri))
2070 if url_obj.password:
2071 clone_uri = url_obj.with_password('*****')
2072 return clone_uri
2073
2074 def clone_url(self, **override):
2075 from rhodecode.model.settings import SettingsModel
2076
2077 uri_tmpl = None
2078 if 'with_id' in override:
2079 uri_tmpl = self.DEFAULT_CLONE_URI_ID
2080 del override['with_id']
2081
2082 if 'uri_tmpl' in override:
2083 uri_tmpl = override['uri_tmpl']
2084 del override['uri_tmpl']
2085
2086 # we didn't override our tmpl from **overrides
2087 if not uri_tmpl:
2088 rc_config = SettingsModel().get_all_settings(cache=True)
2089 uri_tmpl = rc_config.get(
2090 'rhodecode_clone_uri_tmpl') or self.DEFAULT_CLONE_URI
2091
2092 request = get_current_request()
2093 return get_clone_url(request=request,
2094 uri_tmpl=uri_tmpl,
2095 repo_name=self.repo_name,
2096 repo_id=self.repo_id, **override)
2097
2098 def set_state(self, state):
2099 self.repo_state = state
2100 Session().add(self)
2101 #==========================================================================
2102 # SCM PROPERTIES
2103 #==========================================================================
2104
2105 def get_commit(self, commit_id=None, commit_idx=None, pre_load=None):
2106 return get_commit_safe(
2107 self.scm_instance(), commit_id, commit_idx, pre_load=pre_load)
2108
2109 def get_changeset(self, rev=None, pre_load=None):
2110 warnings.warn("Use get_commit", DeprecationWarning)
2111 commit_id = None
2112 commit_idx = None
2113 if isinstance(rev, basestring):
2114 commit_id = rev
2115 else:
2116 commit_idx = rev
2117 return self.get_commit(commit_id=commit_id, commit_idx=commit_idx,
2118 pre_load=pre_load)
2119
2120 def get_landing_commit(self):
2121 """
2122 Returns landing commit, or if that doesn't exist returns the tip
2123 """
2124 _rev_type, _rev = self.landing_rev
2125 commit = self.get_commit(_rev)
2126 if isinstance(commit, EmptyCommit):
2127 return self.get_commit()
2128 return commit
2129
2130 def update_commit_cache(self, cs_cache=None, config=None):
2131 """
2132 Update cache of last changeset for repository, keys should be::
2133
2134 short_id
2135 raw_id
2136 revision
2137 parents
2138 message
2139 date
2140 author
2141
2142 :param cs_cache:
2143 """
2144 from rhodecode.lib.vcs.backends.base import BaseChangeset
2145 if cs_cache is None:
2146 # use no-cache version here
2147 scm_repo = self.scm_instance(cache=False, config=config)
2148 if scm_repo:
2149 cs_cache = scm_repo.get_commit(
2150 pre_load=["author", "date", "message", "parents"])
2151 else:
2152 cs_cache = EmptyCommit()
2153
2154 if isinstance(cs_cache, BaseChangeset):
2155 cs_cache = cs_cache.__json__()
2156
2157 def is_outdated(new_cs_cache):
2158 if (new_cs_cache['raw_id'] != self.changeset_cache['raw_id'] or
2159 new_cs_cache['revision'] != self.changeset_cache['revision']):
2160 return True
2161 return False
2162
2163 # check if we have maybe already latest cached revision
2164 if is_outdated(cs_cache) or not self.changeset_cache:
2165 _default = datetime.datetime.fromtimestamp(0)
2166 last_change = cs_cache.get('date') or _default
2167 log.debug('updated repo %s with new cs cache %s',
2168 self.repo_name, cs_cache)
2169 self.updated_on = last_change
2170 self.changeset_cache = cs_cache
2171 Session().add(self)
2172 Session().commit()
2173 else:
2174 log.debug('Skipping update_commit_cache for repo:`%s` '
2175 'commit already with latest changes', self.repo_name)
2176
2177 @property
2178 def tip(self):
2179 return self.get_commit('tip')
2180
2181 @property
2182 def author(self):
2183 return self.tip.author
2184
2185 @property
2186 def last_change(self):
2187 return self.scm_instance().last_change
2188
2189 def get_comments(self, revisions=None):
2190 """
2191 Returns comments for this repository grouped by revisions
2192
2193 :param revisions: filter query by revisions only
2194 """
2195 cmts = ChangesetComment.query()\
2196 .filter(ChangesetComment.repo == self)
2197 if revisions:
2198 cmts = cmts.filter(ChangesetComment.revision.in_(revisions))
2199 grouped = collections.defaultdict(list)
2200 for cmt in cmts.all():
2201 grouped[cmt.revision].append(cmt)
2202 return grouped
2203
2204 def statuses(self, revisions=None):
2205 """
2206 Returns statuses for this repository
2207
2208 :param revisions: list of revisions to get statuses for
2209 """
2210 statuses = ChangesetStatus.query()\
2211 .filter(ChangesetStatus.repo == self)\
2212 .filter(ChangesetStatus.version == 0)
2213
2214 if revisions:
2215 # Try doing the filtering in chunks to avoid hitting limits
2216 size = 500
2217 status_results = []
2218 for chunk in xrange(0, len(revisions), size):
2219 status_results += statuses.filter(
2220 ChangesetStatus.revision.in_(
2221 revisions[chunk: chunk+size])
2222 ).all()
2223 else:
2224 status_results = statuses.all()
2225
2226 grouped = {}
2227
2228 # maybe we have open new pullrequest without a status?
2229 stat = ChangesetStatus.STATUS_UNDER_REVIEW
2230 status_lbl = ChangesetStatus.get_status_lbl(stat)
2231 for pr in PullRequest.query().filter(PullRequest.source_repo == self).all():
2232 for rev in pr.revisions:
2233 pr_id = pr.pull_request_id
2234 pr_repo = pr.target_repo.repo_name
2235 grouped[rev] = [stat, status_lbl, pr_id, pr_repo]
2236
2237 for stat in status_results:
2238 pr_id = pr_repo = None
2239 if stat.pull_request:
2240 pr_id = stat.pull_request.pull_request_id
2241 pr_repo = stat.pull_request.target_repo.repo_name
2242 grouped[stat.revision] = [str(stat.status), stat.status_lbl,
2243 pr_id, pr_repo]
2244 return grouped
2245
2246 # ==========================================================================
2247 # SCM CACHE INSTANCE
2248 # ==========================================================================
2249
2250 def scm_instance(self, **kwargs):
2251 import rhodecode
2252
2253 # Passing a config will not hit the cache currently only used
2254 # for repo2dbmapper
2255 config = kwargs.pop('config', None)
2256 cache = kwargs.pop('cache', None)
2257 full_cache = str2bool(rhodecode.CONFIG.get('vcs_full_cache'))
2258 # if cache is NOT defined use default global, else we have a full
2259 # control over cache behaviour
2260 if cache is None and full_cache and not config:
2261 return self._get_instance_cached()
2262 return self._get_instance(cache=bool(cache), config=config)
2263
2264 def _get_instance_cached(self):
2265 @cache_region('long_term')
2266 def _get_repo(cache_key):
2267 return self._get_instance()
2268
2269 invalidator_context = CacheKey.repo_context_cache(
2270 _get_repo, self.repo_name, None, thread_scoped=True)
2271
2272 with invalidator_context as context:
2273 context.invalidate()
2274 repo = context.compute()
2275
2276 return repo
2277
2278 def _get_instance(self, cache=True, config=None):
2279 config = config or self._config
2280 custom_wire = {
2281 'cache': cache # controls the vcs.remote cache
2282 }
2283 repo = get_vcs_instance(
2284 repo_path=safe_str(self.repo_full_path),
2285 config=config,
2286 with_wire=custom_wire,
2287 create=False,
2288 _vcs_alias=self.repo_type)
2289
2290 return repo
2291
2292 def __json__(self):
2293 return {'landing_rev': self.landing_rev}
2294
2295 def get_dict(self):
2296
2297 # Since we transformed `repo_name` to a hybrid property, we need to
2298 # keep compatibility with the code which uses `repo_name` field.
2299
2300 result = super(Repository, self).get_dict()
2301 result['repo_name'] = result.pop('_repo_name', None)
2302 return result
2303
2304
2305 class RepoGroup(Base, BaseModel):
2306 __tablename__ = 'groups'
2307 __table_args__ = (
2308 UniqueConstraint('group_name', 'group_parent_id'),
2309 CheckConstraint('group_id != group_parent_id'),
2310 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2311 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
2312 )
2313 __mapper_args__ = {'order_by': 'group_name'}
2314
2315 CHOICES_SEPARATOR = '/' # used to generate select2 choices for nested groups
2316
2317 group_id = Column("group_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2318 group_name = Column("group_name", String(255), nullable=False, unique=True, default=None)
2319 group_parent_id = Column("group_parent_id", Integer(), ForeignKey('groups.group_id'), nullable=True, unique=None, default=None)
2320 group_description = Column("group_description", String(10000), nullable=True, unique=None, default=None)
2321 enable_locking = Column("enable_locking", Boolean(), nullable=False, unique=None, default=False)
2322 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=False, default=None)
2323 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
2324 updated_on = Column('updated_on', DateTime(timezone=False), nullable=True, unique=None, default=datetime.datetime.now)
2325 personal = Column('personal', Boolean(), nullable=True, unique=None, default=None)
2326
2327 repo_group_to_perm = relationship('UserRepoGroupToPerm', cascade='all', order_by='UserRepoGroupToPerm.group_to_perm_id')
2328 users_group_to_perm = relationship('UserGroupRepoGroupToPerm', cascade='all')
2329 parent_group = relationship('RepoGroup', remote_side=group_id)
2330 user = relationship('User')
2331 integrations = relationship('Integration',
2332 cascade="all, delete, delete-orphan")
2333
2334 def __init__(self, group_name='', parent_group=None):
2335 self.group_name = group_name
2336 self.parent_group = parent_group
2337
2338 def __unicode__(self):
2339 return u"<%s('id:%s:%s')>" % (
2340 self.__class__.__name__, self.group_id, self.group_name)
2341
2342 @hybrid_property
2343 def description_safe(self):
2344 from rhodecode.lib import helpers as h
2345 return h.escape(self.group_description)
2346
2347 @classmethod
2348 def _generate_choice(cls, repo_group):
2349 from webhelpers.html import literal as _literal
2350 _name = lambda k: _literal(cls.CHOICES_SEPARATOR.join(k))
2351 return repo_group.group_id, _name(repo_group.full_path_splitted)
2352
2353 @classmethod
2354 def groups_choices(cls, groups=None, show_empty_group=True):
2355 if not groups:
2356 groups = cls.query().all()
2357
2358 repo_groups = []
2359 if show_empty_group:
2360 repo_groups = [(-1, u'-- %s --' % _('No parent'))]
2361
2362 repo_groups.extend([cls._generate_choice(x) for x in groups])
2363
2364 repo_groups = sorted(
2365 repo_groups, key=lambda t: t[1].split(cls.CHOICES_SEPARATOR)[0])
2366 return repo_groups
2367
2368 @classmethod
2369 def url_sep(cls):
2370 return URL_SEP
2371
2372 @classmethod
2373 def get_by_group_name(cls, group_name, cache=False, case_insensitive=False):
2374 if case_insensitive:
2375 gr = cls.query().filter(func.lower(cls.group_name)
2376 == func.lower(group_name))
2377 else:
2378 gr = cls.query().filter(cls.group_name == group_name)
2379 if cache:
2380 name_key = _hash_key(group_name)
2381 gr = gr.options(
2382 FromCache("sql_cache_short", "get_group_%s" % name_key))
2383 return gr.scalar()
2384
2385 @classmethod
2386 def get_user_personal_repo_group(cls, user_id):
2387 user = User.get(user_id)
2388 if user.username == User.DEFAULT_USER:
2389 return None
2390
2391 return cls.query()\
2392 .filter(cls.personal == true()) \
2393 .filter(cls.user == user).scalar()
2394
2395 @classmethod
2396 def get_all_repo_groups(cls, user_id=Optional(None), group_id=Optional(None),
2397 case_insensitive=True):
2398 q = RepoGroup.query()
2399
2400 if not isinstance(user_id, Optional):
2401 q = q.filter(RepoGroup.user_id == user_id)
2402
2403 if not isinstance(group_id, Optional):
2404 q = q.filter(RepoGroup.group_parent_id == group_id)
2405
2406 if case_insensitive:
2407 q = q.order_by(func.lower(RepoGroup.group_name))
2408 else:
2409 q = q.order_by(RepoGroup.group_name)
2410 return q.all()
2411
2412 @property
2413 def parents(self):
2414 parents_recursion_limit = 10
2415 groups = []
2416 if self.parent_group is None:
2417 return groups
2418 cur_gr = self.parent_group
2419 groups.insert(0, cur_gr)
2420 cnt = 0
2421 while 1:
2422 cnt += 1
2423 gr = getattr(cur_gr, 'parent_group', None)
2424 cur_gr = cur_gr.parent_group
2425 if gr is None:
2426 break
2427 if cnt == parents_recursion_limit:
2428 # this will prevent accidental infinit loops
2429 log.error(('more than %s parents found for group %s, stopping '
2430 'recursive parent fetching' % (parents_recursion_limit, self)))
2431 break
2432
2433 groups.insert(0, gr)
2434 return groups
2435
2436 @property
2437 def last_db_change(self):
2438 return self.updated_on
2439
2440 @property
2441 def children(self):
2442 return RepoGroup.query().filter(RepoGroup.parent_group == self)
2443
2444 @property
2445 def name(self):
2446 return self.group_name.split(RepoGroup.url_sep())[-1]
2447
2448 @property
2449 def full_path(self):
2450 return self.group_name
2451
2452 @property
2453 def full_path_splitted(self):
2454 return self.group_name.split(RepoGroup.url_sep())
2455
2456 @property
2457 def repositories(self):
2458 return Repository.query()\
2459 .filter(Repository.group == self)\
2460 .order_by(Repository.repo_name)
2461
2462 @property
2463 def repositories_recursive_count(self):
2464 cnt = self.repositories.count()
2465
2466 def children_count(group):
2467 cnt = 0
2468 for child in group.children:
2469 cnt += child.repositories.count()
2470 cnt += children_count(child)
2471 return cnt
2472
2473 return cnt + children_count(self)
2474
2475 def _recursive_objects(self, include_repos=True):
2476 all_ = []
2477
2478 def _get_members(root_gr):
2479 if include_repos:
2480 for r in root_gr.repositories:
2481 all_.append(r)
2482 childs = root_gr.children.all()
2483 if childs:
2484 for gr in childs:
2485 all_.append(gr)
2486 _get_members(gr)
2487
2488 _get_members(self)
2489 return [self] + all_
2490
2491 def recursive_groups_and_repos(self):
2492 """
2493 Recursive return all groups, with repositories in those groups
2494 """
2495 return self._recursive_objects()
2496
2497 def recursive_groups(self):
2498 """
2499 Returns all children groups for this group including children of children
2500 """
2501 return self._recursive_objects(include_repos=False)
2502
2503 def get_new_name(self, group_name):
2504 """
2505 returns new full group name based on parent and new name
2506
2507 :param group_name:
2508 """
2509 path_prefix = (self.parent_group.full_path_splitted if
2510 self.parent_group else [])
2511 return RepoGroup.url_sep().join(path_prefix + [group_name])
2512
2513 def permissions(self, with_admins=True, with_owner=True):
2514 q = UserRepoGroupToPerm.query().filter(UserRepoGroupToPerm.group == self)
2515 q = q.options(joinedload(UserRepoGroupToPerm.group),
2516 joinedload(UserRepoGroupToPerm.user),
2517 joinedload(UserRepoGroupToPerm.permission),)
2518
2519 # get owners and admins and permissions. We do a trick of re-writing
2520 # objects from sqlalchemy to named-tuples due to sqlalchemy session
2521 # has a global reference and changing one object propagates to all
2522 # others. This means if admin is also an owner admin_row that change
2523 # would propagate to both objects
2524 perm_rows = []
2525 for _usr in q.all():
2526 usr = AttributeDict(_usr.user.get_dict())
2527 usr.permission = _usr.permission.permission_name
2528 perm_rows.append(usr)
2529
2530 # filter the perm rows by 'default' first and then sort them by
2531 # admin,write,read,none permissions sorted again alphabetically in
2532 # each group
2533 perm_rows = sorted(perm_rows, key=display_user_sort)
2534
2535 _admin_perm = 'group.admin'
2536 owner_row = []
2537 if with_owner:
2538 usr = AttributeDict(self.user.get_dict())
2539 usr.owner_row = True
2540 usr.permission = _admin_perm
2541 owner_row.append(usr)
2542
2543 super_admin_rows = []
2544 if with_admins:
2545 for usr in User.get_all_super_admins():
2546 # if this admin is also owner, don't double the record
2547 if usr.user_id == owner_row[0].user_id:
2548 owner_row[0].admin_row = True
2549 else:
2550 usr = AttributeDict(usr.get_dict())
2551 usr.admin_row = True
2552 usr.permission = _admin_perm
2553 super_admin_rows.append(usr)
2554
2555 return super_admin_rows + owner_row + perm_rows
2556
2557 def permission_user_groups(self):
2558 q = UserGroupRepoGroupToPerm.query().filter(UserGroupRepoGroupToPerm.group == self)
2559 q = q.options(joinedload(UserGroupRepoGroupToPerm.group),
2560 joinedload(UserGroupRepoGroupToPerm.users_group),
2561 joinedload(UserGroupRepoGroupToPerm.permission),)
2562
2563 perm_rows = []
2564 for _user_group in q.all():
2565 usr = AttributeDict(_user_group.users_group.get_dict())
2566 usr.permission = _user_group.permission.permission_name
2567 perm_rows.append(usr)
2568
2569 perm_rows = sorted(perm_rows, key=display_user_group_sort)
2570 return perm_rows
2571
2572 def get_api_data(self):
2573 """
2574 Common function for generating api data
2575
2576 """
2577 group = self
2578 data = {
2579 'group_id': group.group_id,
2580 'group_name': group.group_name,
2581 'group_description': group.description_safe,
2582 'parent_group': group.parent_group.group_name if group.parent_group else None,
2583 'repositories': [x.repo_name for x in group.repositories],
2584 'owner': group.user.username,
2585 }
2586 return data
2587
2588
2589 class Permission(Base, BaseModel):
2590 __tablename__ = 'permissions'
2591 __table_args__ = (
2592 Index('p_perm_name_idx', 'permission_name'),
2593 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2594 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
2595 )
2596 PERMS = [
2597 ('hg.admin', _('RhodeCode Super Administrator')),
2598
2599 ('repository.none', _('Repository no access')),
2600 ('repository.read', _('Repository read access')),
2601 ('repository.write', _('Repository write access')),
2602 ('repository.admin', _('Repository admin access')),
2603
2604 ('group.none', _('Repository group no access')),
2605 ('group.read', _('Repository group read access')),
2606 ('group.write', _('Repository group write access')),
2607 ('group.admin', _('Repository group admin access')),
2608
2609 ('usergroup.none', _('User group no access')),
2610 ('usergroup.read', _('User group read access')),
2611 ('usergroup.write', _('User group write access')),
2612 ('usergroup.admin', _('User group admin access')),
2613
2614 ('hg.repogroup.create.false', _('Repository Group creation disabled')),
2615 ('hg.repogroup.create.true', _('Repository Group creation enabled')),
2616
2617 ('hg.usergroup.create.false', _('User Group creation disabled')),
2618 ('hg.usergroup.create.true', _('User Group creation enabled')),
2619
2620 ('hg.create.none', _('Repository creation disabled')),
2621 ('hg.create.repository', _('Repository creation enabled')),
2622 ('hg.create.write_on_repogroup.true', _('Repository creation enabled with write permission to a repository group')),
2623 ('hg.create.write_on_repogroup.false', _('Repository creation disabled with write permission to a repository group')),
2624
2625 ('hg.fork.none', _('Repository forking disabled')),
2626 ('hg.fork.repository', _('Repository forking enabled')),
2627
2628 ('hg.register.none', _('Registration disabled')),
2629 ('hg.register.manual_activate', _('User Registration with manual account activation')),
2630 ('hg.register.auto_activate', _('User Registration with automatic account activation')),
2631
2632 ('hg.password_reset.enabled', _('Password reset enabled')),
2633 ('hg.password_reset.hidden', _('Password reset hidden')),
2634 ('hg.password_reset.disabled', _('Password reset disabled')),
2635
2636 ('hg.extern_activate.manual', _('Manual activation of external account')),
2637 ('hg.extern_activate.auto', _('Automatic activation of external account')),
2638
2639 ('hg.inherit_default_perms.false', _('Inherit object permissions from default user disabled')),
2640 ('hg.inherit_default_perms.true', _('Inherit object permissions from default user enabled')),
2641 ]
2642
2643 # definition of system default permissions for DEFAULT user
2644 DEFAULT_USER_PERMISSIONS = [
2645 'repository.read',
2646 'group.read',
2647 'usergroup.read',
2648 'hg.create.repository',
2649 'hg.repogroup.create.false',
2650 'hg.usergroup.create.false',
2651 'hg.create.write_on_repogroup.true',
2652 'hg.fork.repository',
2653 'hg.register.manual_activate',
2654 'hg.password_reset.enabled',
2655 'hg.extern_activate.auto',
2656 'hg.inherit_default_perms.true',
2657 ]
2658
2659 # defines which permissions are more important higher the more important
2660 # Weight defines which permissions are more important.
2661 # The higher number the more important.
2662 PERM_WEIGHTS = {
2663 'repository.none': 0,
2664 'repository.read': 1,
2665 'repository.write': 3,
2666 'repository.admin': 4,
2667
2668 'group.none': 0,
2669 'group.read': 1,
2670 'group.write': 3,
2671 'group.admin': 4,
2672
2673 'usergroup.none': 0,
2674 'usergroup.read': 1,
2675 'usergroup.write': 3,
2676 'usergroup.admin': 4,
2677
2678 'hg.repogroup.create.false': 0,
2679 'hg.repogroup.create.true': 1,
2680
2681 'hg.usergroup.create.false': 0,
2682 'hg.usergroup.create.true': 1,
2683
2684 'hg.fork.none': 0,
2685 'hg.fork.repository': 1,
2686 'hg.create.none': 0,
2687 'hg.create.repository': 1
2688 }
2689
2690 permission_id = Column("permission_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2691 permission_name = Column("permission_name", String(255), nullable=True, unique=None, default=None)
2692 permission_longname = Column("permission_longname", String(255), nullable=True, unique=None, default=None)
2693
2694 def __unicode__(self):
2695 return u"<%s('%s:%s')>" % (
2696 self.__class__.__name__, self.permission_id, self.permission_name
2697 )
2698
2699 @classmethod
2700 def get_by_key(cls, key):
2701 return cls.query().filter(cls.permission_name == key).scalar()
2702
2703 @classmethod
2704 def get_default_repo_perms(cls, user_id, repo_id=None):
2705 q = Session().query(UserRepoToPerm, Repository, Permission)\
2706 .join((Permission, UserRepoToPerm.permission_id == Permission.permission_id))\
2707 .join((Repository, UserRepoToPerm.repository_id == Repository.repo_id))\
2708 .filter(UserRepoToPerm.user_id == user_id)
2709 if repo_id:
2710 q = q.filter(UserRepoToPerm.repository_id == repo_id)
2711 return q.all()
2712
2713 @classmethod
2714 def get_default_repo_perms_from_user_group(cls, user_id, repo_id=None):
2715 q = Session().query(UserGroupRepoToPerm, Repository, Permission)\
2716 .join(
2717 Permission,
2718 UserGroupRepoToPerm.permission_id == Permission.permission_id)\
2719 .join(
2720 Repository,
2721 UserGroupRepoToPerm.repository_id == Repository.repo_id)\
2722 .join(
2723 UserGroup,
2724 UserGroupRepoToPerm.users_group_id ==
2725 UserGroup.users_group_id)\
2726 .join(
2727 UserGroupMember,
2728 UserGroupRepoToPerm.users_group_id ==
2729 UserGroupMember.users_group_id)\
2730 .filter(
2731 UserGroupMember.user_id == user_id,
2732 UserGroup.users_group_active == true())
2733 if repo_id:
2734 q = q.filter(UserGroupRepoToPerm.repository_id == repo_id)
2735 return q.all()
2736
2737 @classmethod
2738 def get_default_group_perms(cls, user_id, repo_group_id=None):
2739 q = Session().query(UserRepoGroupToPerm, RepoGroup, Permission)\
2740 .join((Permission, UserRepoGroupToPerm.permission_id == Permission.permission_id))\
2741 .join((RepoGroup, UserRepoGroupToPerm.group_id == RepoGroup.group_id))\
2742 .filter(UserRepoGroupToPerm.user_id == user_id)
2743 if repo_group_id:
2744 q = q.filter(UserRepoGroupToPerm.group_id == repo_group_id)
2745 return q.all()
2746
2747 @classmethod
2748 def get_default_group_perms_from_user_group(
2749 cls, user_id, repo_group_id=None):
2750 q = Session().query(UserGroupRepoGroupToPerm, RepoGroup, Permission)\
2751 .join(
2752 Permission,
2753 UserGroupRepoGroupToPerm.permission_id ==
2754 Permission.permission_id)\
2755 .join(
2756 RepoGroup,
2757 UserGroupRepoGroupToPerm.group_id == RepoGroup.group_id)\
2758 .join(
2759 UserGroup,
2760 UserGroupRepoGroupToPerm.users_group_id ==
2761 UserGroup.users_group_id)\
2762 .join(
2763 UserGroupMember,
2764 UserGroupRepoGroupToPerm.users_group_id ==
2765 UserGroupMember.users_group_id)\
2766 .filter(
2767 UserGroupMember.user_id == user_id,
2768 UserGroup.users_group_active == true())
2769 if repo_group_id:
2770 q = q.filter(UserGroupRepoGroupToPerm.group_id == repo_group_id)
2771 return q.all()
2772
2773 @classmethod
2774 def get_default_user_group_perms(cls, user_id, user_group_id=None):
2775 q = Session().query(UserUserGroupToPerm, UserGroup, Permission)\
2776 .join((Permission, UserUserGroupToPerm.permission_id == Permission.permission_id))\
2777 .join((UserGroup, UserUserGroupToPerm.user_group_id == UserGroup.users_group_id))\
2778 .filter(UserUserGroupToPerm.user_id == user_id)
2779 if user_group_id:
2780 q = q.filter(UserUserGroupToPerm.user_group_id == user_group_id)
2781 return q.all()
2782
2783 @classmethod
2784 def get_default_user_group_perms_from_user_group(
2785 cls, user_id, user_group_id=None):
2786 TargetUserGroup = aliased(UserGroup, name='target_user_group')
2787 q = Session().query(UserGroupUserGroupToPerm, UserGroup, Permission)\
2788 .join(
2789 Permission,
2790 UserGroupUserGroupToPerm.permission_id ==
2791 Permission.permission_id)\
2792 .join(
2793 TargetUserGroup,
2794 UserGroupUserGroupToPerm.target_user_group_id ==
2795 TargetUserGroup.users_group_id)\
2796 .join(
2797 UserGroup,
2798 UserGroupUserGroupToPerm.user_group_id ==
2799 UserGroup.users_group_id)\
2800 .join(
2801 UserGroupMember,
2802 UserGroupUserGroupToPerm.user_group_id ==
2803 UserGroupMember.users_group_id)\
2804 .filter(
2805 UserGroupMember.user_id == user_id,
2806 UserGroup.users_group_active == true())
2807 if user_group_id:
2808 q = q.filter(
2809 UserGroupUserGroupToPerm.user_group_id == user_group_id)
2810
2811 return q.all()
2812
2813
2814 class UserRepoToPerm(Base, BaseModel):
2815 __tablename__ = 'repo_to_perm'
2816 __table_args__ = (
2817 UniqueConstraint('user_id', 'repository_id', 'permission_id'),
2818 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2819 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2820 )
2821 repo_to_perm_id = Column("repo_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2822 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2823 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2824 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
2825
2826 user = relationship('User')
2827 repository = relationship('Repository')
2828 permission = relationship('Permission')
2829
2830 @classmethod
2831 def create(cls, user, repository, permission):
2832 n = cls()
2833 n.user = user
2834 n.repository = repository
2835 n.permission = permission
2836 Session().add(n)
2837 return n
2838
2839 def __unicode__(self):
2840 return u'<%s => %s >' % (self.user, self.repository)
2841
2842
2843 class UserUserGroupToPerm(Base, BaseModel):
2844 __tablename__ = 'user_user_group_to_perm'
2845 __table_args__ = (
2846 UniqueConstraint('user_id', 'user_group_id', 'permission_id'),
2847 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2848 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2849 )
2850 user_user_group_to_perm_id = Column("user_user_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2851 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2852 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2853 user_group_id = Column("user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2854
2855 user = relationship('User')
2856 user_group = relationship('UserGroup')
2857 permission = relationship('Permission')
2858
2859 @classmethod
2860 def create(cls, user, user_group, permission):
2861 n = cls()
2862 n.user = user
2863 n.user_group = user_group
2864 n.permission = permission
2865 Session().add(n)
2866 return n
2867
2868 def __unicode__(self):
2869 return u'<%s => %s >' % (self.user, self.user_group)
2870
2871
2872 class UserToPerm(Base, BaseModel):
2873 __tablename__ = 'user_to_perm'
2874 __table_args__ = (
2875 UniqueConstraint('user_id', 'permission_id'),
2876 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2877 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2878 )
2879 user_to_perm_id = Column("user_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2880 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2881 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2882
2883 user = relationship('User')
2884 permission = relationship('Permission', lazy='joined')
2885
2886 def __unicode__(self):
2887 return u'<%s => %s >' % (self.user, self.permission)
2888
2889
2890 class UserGroupRepoToPerm(Base, BaseModel):
2891 __tablename__ = 'users_group_repo_to_perm'
2892 __table_args__ = (
2893 UniqueConstraint('repository_id', 'users_group_id', 'permission_id'),
2894 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2895 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2896 )
2897 users_group_to_perm_id = Column("users_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2898 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2899 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2900 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
2901
2902 users_group = relationship('UserGroup')
2903 permission = relationship('Permission')
2904 repository = relationship('Repository')
2905
2906 @classmethod
2907 def create(cls, users_group, repository, permission):
2908 n = cls()
2909 n.users_group = users_group
2910 n.repository = repository
2911 n.permission = permission
2912 Session().add(n)
2913 return n
2914
2915 def __unicode__(self):
2916 return u'<UserGroupRepoToPerm:%s => %s >' % (self.users_group, self.repository)
2917
2918
2919 class UserGroupUserGroupToPerm(Base, BaseModel):
2920 __tablename__ = 'user_group_user_group_to_perm'
2921 __table_args__ = (
2922 UniqueConstraint('target_user_group_id', 'user_group_id', 'permission_id'),
2923 CheckConstraint('target_user_group_id != user_group_id'),
2924 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2925 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2926 )
2927 user_group_user_group_to_perm_id = Column("user_group_user_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2928 target_user_group_id = Column("target_user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2929 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2930 user_group_id = Column("user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2931
2932 target_user_group = relationship('UserGroup', primaryjoin='UserGroupUserGroupToPerm.target_user_group_id==UserGroup.users_group_id')
2933 user_group = relationship('UserGroup', primaryjoin='UserGroupUserGroupToPerm.user_group_id==UserGroup.users_group_id')
2934 permission = relationship('Permission')
2935
2936 @classmethod
2937 def create(cls, target_user_group, user_group, permission):
2938 n = cls()
2939 n.target_user_group = target_user_group
2940 n.user_group = user_group
2941 n.permission = permission
2942 Session().add(n)
2943 return n
2944
2945 def __unicode__(self):
2946 return u'<UserGroupUserGroup:%s => %s >' % (self.target_user_group, self.user_group)
2947
2948
2949 class UserGroupToPerm(Base, BaseModel):
2950 __tablename__ = 'users_group_to_perm'
2951 __table_args__ = (
2952 UniqueConstraint('users_group_id', 'permission_id',),
2953 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2954 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2955 )
2956 users_group_to_perm_id = Column("users_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2957 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2958 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2959
2960 users_group = relationship('UserGroup')
2961 permission = relationship('Permission')
2962
2963
2964 class UserRepoGroupToPerm(Base, BaseModel):
2965 __tablename__ = 'user_repo_group_to_perm'
2966 __table_args__ = (
2967 UniqueConstraint('user_id', 'group_id', 'permission_id'),
2968 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2969 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2970 )
2971
2972 group_to_perm_id = Column("group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2973 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2974 group_id = Column("group_id", Integer(), ForeignKey('groups.group_id'), nullable=False, unique=None, default=None)
2975 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2976
2977 user = relationship('User')
2978 group = relationship('RepoGroup')
2979 permission = relationship('Permission')
2980
2981 @classmethod
2982 def create(cls, user, repository_group, permission):
2983 n = cls()
2984 n.user = user
2985 n.group = repository_group
2986 n.permission = permission
2987 Session().add(n)
2988 return n
2989
2990
2991 class UserGroupRepoGroupToPerm(Base, BaseModel):
2992 __tablename__ = 'users_group_repo_group_to_perm'
2993 __table_args__ = (
2994 UniqueConstraint('users_group_id', 'group_id'),
2995 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2996 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2997 )
2998
2999 users_group_repo_group_to_perm_id = Column("users_group_repo_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3000 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
3001 group_id = Column("group_id", Integer(), ForeignKey('groups.group_id'), nullable=False, unique=None, default=None)
3002 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
3003
3004 users_group = relationship('UserGroup')
3005 permission = relationship('Permission')
3006 group = relationship('RepoGroup')
3007
3008 @classmethod
3009 def create(cls, user_group, repository_group, permission):
3010 n = cls()
3011 n.users_group = user_group
3012 n.group = repository_group
3013 n.permission = permission
3014 Session().add(n)
3015 return n
3016
3017 def __unicode__(self):
3018 return u'<UserGroupRepoGroupToPerm:%s => %s >' % (self.users_group, self.group)
3019
3020
3021 class Statistics(Base, BaseModel):
3022 __tablename__ = 'statistics'
3023 __table_args__ = (
3024 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3025 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3026 )
3027 stat_id = Column("stat_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3028 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=True, default=None)
3029 stat_on_revision = Column("stat_on_revision", Integer(), nullable=False)
3030 commit_activity = Column("commit_activity", LargeBinary(1000000), nullable=False)#JSON data
3031 commit_activity_combined = Column("commit_activity_combined", LargeBinary(), nullable=False)#JSON data
3032 languages = Column("languages", LargeBinary(1000000), nullable=False)#JSON data
3033
3034 repository = relationship('Repository', single_parent=True)
3035
3036
3037 class UserFollowing(Base, BaseModel):
3038 __tablename__ = 'user_followings'
3039 __table_args__ = (
3040 UniqueConstraint('user_id', 'follows_repository_id'),
3041 UniqueConstraint('user_id', 'follows_user_id'),
3042 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3043 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3044 )
3045
3046 user_following_id = Column("user_following_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3047 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
3048 follows_repo_id = Column("follows_repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=True, unique=None, default=None)
3049 follows_user_id = Column("follows_user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
3050 follows_from = Column('follows_from', DateTime(timezone=False), nullable=True, unique=None, default=datetime.datetime.now)
3051
3052 user = relationship('User', primaryjoin='User.user_id==UserFollowing.user_id')
3053
3054 follows_user = relationship('User', primaryjoin='User.user_id==UserFollowing.follows_user_id')
3055 follows_repository = relationship('Repository', order_by='Repository.repo_name')
3056
3057 @classmethod
3058 def get_repo_followers(cls, repo_id):
3059 return cls.query().filter(cls.follows_repo_id == repo_id)
3060
3061
3062 class CacheKey(Base, BaseModel):
3063 __tablename__ = 'cache_invalidation'
3064 __table_args__ = (
3065 UniqueConstraint('cache_key'),
3066 Index('key_idx', 'cache_key'),
3067 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3068 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3069 )
3070 CACHE_TYPE_ATOM = 'ATOM'
3071 CACHE_TYPE_RSS = 'RSS'
3072 CACHE_TYPE_README = 'README'
3073
3074 cache_id = Column("cache_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3075 cache_key = Column("cache_key", String(255), nullable=True, unique=None, default=None)
3076 cache_args = Column("cache_args", String(255), nullable=True, unique=None, default=None)
3077 cache_active = Column("cache_active", Boolean(), nullable=True, unique=None, default=False)
3078
3079 def __init__(self, cache_key, cache_args=''):
3080 self.cache_key = cache_key
3081 self.cache_args = cache_args
3082 self.cache_active = False
3083
3084 def __unicode__(self):
3085 return u"<%s('%s:%s[%s]')>" % (
3086 self.__class__.__name__,
3087 self.cache_id, self.cache_key, self.cache_active)
3088
3089 def _cache_key_partition(self):
3090 prefix, repo_name, suffix = self.cache_key.partition(self.cache_args)
3091 return prefix, repo_name, suffix
3092
3093 def get_prefix(self):
3094 """
3095 Try to extract prefix from existing cache key. The key could consist
3096 of prefix, repo_name, suffix
3097 """
3098 # this returns prefix, repo_name, suffix
3099 return self._cache_key_partition()[0]
3100
3101 def get_suffix(self):
3102 """
3103 get suffix that might have been used in _get_cache_key to
3104 generate self.cache_key. Only used for informational purposes
3105 in repo_edit.mako.
3106 """
3107 # prefix, repo_name, suffix
3108 return self._cache_key_partition()[2]
3109
3110 @classmethod
3111 def delete_all_cache(cls):
3112 """
3113 Delete all cache keys from database.
3114 Should only be run when all instances are down and all entries
3115 thus stale.
3116 """
3117 cls.query().delete()
3118 Session().commit()
3119
3120 @classmethod
3121 def get_cache_key(cls, repo_name, cache_type):
3122 """
3123
3124 Generate a cache key for this process of RhodeCode instance.
3125 Prefix most likely will be process id or maybe explicitly set
3126 instance_id from .ini file.
3127 """
3128 import rhodecode
3129 prefix = safe_unicode(rhodecode.CONFIG.get('instance_id') or '')
3130
3131 repo_as_unicode = safe_unicode(repo_name)
3132 key = u'{}_{}'.format(repo_as_unicode, cache_type) \
3133 if cache_type else repo_as_unicode
3134
3135 return u'{}{}'.format(prefix, key)
3136
3137 @classmethod
3138 def set_invalidate(cls, repo_name, delete=False):
3139 """
3140 Mark all caches of a repo as invalid in the database.
3141 """
3142
3143 try:
3144 qry = Session().query(cls).filter(cls.cache_args == repo_name)
3145 if delete:
3146 log.debug('cache objects deleted for repo %s',
3147 safe_str(repo_name))
3148 qry.delete()
3149 else:
3150 log.debug('cache objects marked as invalid for repo %s',
3151 safe_str(repo_name))
3152 qry.update({"cache_active": False})
3153
3154 Session().commit()
3155 except Exception:
3156 log.exception(
3157 'Cache key invalidation failed for repository %s',
3158 safe_str(repo_name))
3159 Session().rollback()
3160
3161 @classmethod
3162 def get_active_cache(cls, cache_key):
3163 inv_obj = cls.query().filter(cls.cache_key == cache_key).scalar()
3164 if inv_obj:
3165 return inv_obj
3166 return None
3167
3168 @classmethod
3169 def repo_context_cache(cls, compute_func, repo_name, cache_type,
3170 thread_scoped=False):
3171 """
3172 @cache_region('long_term')
3173 def _heavy_calculation(cache_key):
3174 return 'result'
3175
3176 cache_context = CacheKey.repo_context_cache(
3177 _heavy_calculation, repo_name, cache_type)
3178
3179 with cache_context as context:
3180 context.invalidate()
3181 computed = context.compute()
3182
3183 assert computed == 'result'
3184 """
3185 from rhodecode.lib import caches
3186 return caches.InvalidationContext(
3187 compute_func, repo_name, cache_type, thread_scoped=thread_scoped)
3188
3189
3190 class ChangesetComment(Base, BaseModel):
3191 __tablename__ = 'changeset_comments'
3192 __table_args__ = (
3193 Index('cc_revision_idx', 'revision'),
3194 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3195 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3196 )
3197
3198 COMMENT_OUTDATED = u'comment_outdated'
3199 COMMENT_TYPE_NOTE = u'note'
3200 COMMENT_TYPE_TODO = u'todo'
3201 COMMENT_TYPES = [COMMENT_TYPE_NOTE, COMMENT_TYPE_TODO]
3202
3203 comment_id = Column('comment_id', Integer(), nullable=False, primary_key=True)
3204 repo_id = Column('repo_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False)
3205 revision = Column('revision', String(40), nullable=True)
3206 pull_request_id = Column("pull_request_id", Integer(), ForeignKey('pull_requests.pull_request_id'), nullable=True)
3207 pull_request_version_id = Column("pull_request_version_id", Integer(), ForeignKey('pull_request_versions.pull_request_version_id'), nullable=True)
3208 line_no = Column('line_no', Unicode(10), nullable=True)
3209 hl_lines = Column('hl_lines', Unicode(512), nullable=True)
3210 f_path = Column('f_path', Unicode(1000), nullable=True)
3211 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=False)
3212 text = Column('text', UnicodeText().with_variant(UnicodeText(25000), 'mysql'), nullable=False)
3213 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3214 modified_at = Column('modified_at', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3215 renderer = Column('renderer', Unicode(64), nullable=True)
3216 display_state = Column('display_state', Unicode(128), nullable=True)
3217
3218 comment_type = Column('comment_type', Unicode(128), nullable=True, default=COMMENT_TYPE_NOTE)
3219 resolved_comment_id = Column('resolved_comment_id', Integer(), ForeignKey('changeset_comments.comment_id'), nullable=True)
3220 resolved_comment = relationship('ChangesetComment', remote_side=comment_id, backref='resolved_by')
3221 author = relationship('User', lazy='joined')
3222 repo = relationship('Repository')
3223 status_change = relationship('ChangesetStatus', cascade="all, delete, delete-orphan", lazy='joined')
3224 pull_request = relationship('PullRequest', lazy='joined')
3225 pull_request_version = relationship('PullRequestVersion')
3226
3227 @classmethod
3228 def get_users(cls, revision=None, pull_request_id=None):
3229 """
3230 Returns user associated with this ChangesetComment. ie those
3231 who actually commented
3232
3233 :param cls:
3234 :param revision:
3235 """
3236 q = Session().query(User)\
3237 .join(ChangesetComment.author)
3238 if revision:
3239 q = q.filter(cls.revision == revision)
3240 elif pull_request_id:
3241 q = q.filter(cls.pull_request_id == pull_request_id)
3242 return q.all()
3243
3244 @classmethod
3245 def get_index_from_version(cls, pr_version, versions):
3246 num_versions = [x.pull_request_version_id for x in versions]
3247 try:
3248 return num_versions.index(pr_version) +1
3249 except (IndexError, ValueError):
3250 return
3251
3252 @property
3253 def outdated(self):
3254 return self.display_state == self.COMMENT_OUTDATED
3255
3256 def outdated_at_version(self, version):
3257 """
3258 Checks if comment is outdated for given pull request version
3259 """
3260 return self.outdated and self.pull_request_version_id != version
3261
3262 def older_than_version(self, version):
3263 """
3264 Checks if comment is made from previous version than given
3265 """
3266 if version is None:
3267 return self.pull_request_version_id is not None
3268
3269 return self.pull_request_version_id < version
3270
3271 @property
3272 def resolved(self):
3273 return self.resolved_by[0] if self.resolved_by else None
3274
3275 @property
3276 def is_todo(self):
3277 return self.comment_type == self.COMMENT_TYPE_TODO
3278
3279 @property
3280 def is_inline(self):
3281 return self.line_no and self.f_path
3282
3283 def get_index_version(self, versions):
3284 return self.get_index_from_version(
3285 self.pull_request_version_id, versions)
3286
3287 def __repr__(self):
3288 if self.comment_id:
3289 return '<DB:Comment #%s>' % self.comment_id
3290 else:
3291 return '<DB:Comment at %#x>' % id(self)
3292
3293 def get_api_data(self):
3294 comment = self
3295 data = {
3296 'comment_id': comment.comment_id,
3297 'comment_type': comment.comment_type,
3298 'comment_text': comment.text,
3299 'comment_status': comment.status_change,
3300 'comment_f_path': comment.f_path,
3301 'comment_lineno': comment.line_no,
3302 'comment_author': comment.author,
3303 'comment_created_on': comment.created_on
3304 }
3305 return data
3306
3307 def __json__(self):
3308 data = dict()
3309 data.update(self.get_api_data())
3310 return data
3311
3312
3313 class ChangesetStatus(Base, BaseModel):
3314 __tablename__ = 'changeset_statuses'
3315 __table_args__ = (
3316 Index('cs_revision_idx', 'revision'),
3317 Index('cs_version_idx', 'version'),
3318 UniqueConstraint('repo_id', 'revision', 'version'),
3319 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3320 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3321 )
3322 STATUS_NOT_REVIEWED = DEFAULT = 'not_reviewed'
3323 STATUS_APPROVED = 'approved'
3324 STATUS_REJECTED = 'rejected'
3325 STATUS_UNDER_REVIEW = 'under_review'
3326
3327 STATUSES = [
3328 (STATUS_NOT_REVIEWED, _("Not Reviewed")), # (no icon) and default
3329 (STATUS_APPROVED, _("Approved")),
3330 (STATUS_REJECTED, _("Rejected")),
3331 (STATUS_UNDER_REVIEW, _("Under Review")),
3332 ]
3333
3334 changeset_status_id = Column('changeset_status_id', Integer(), nullable=False, primary_key=True)
3335 repo_id = Column('repo_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False)
3336 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None)
3337 revision = Column('revision', String(40), nullable=False)
3338 status = Column('status', String(128), nullable=False, default=DEFAULT)
3339 changeset_comment_id = Column('changeset_comment_id', Integer(), ForeignKey('changeset_comments.comment_id'))
3340 modified_at = Column('modified_at', DateTime(), nullable=False, default=datetime.datetime.now)
3341 version = Column('version', Integer(), nullable=False, default=0)
3342 pull_request_id = Column("pull_request_id", Integer(), ForeignKey('pull_requests.pull_request_id'), nullable=True)
3343
3344 author = relationship('User', lazy='joined')
3345 repo = relationship('Repository')
3346 comment = relationship('ChangesetComment', lazy='joined')
3347 pull_request = relationship('PullRequest', lazy='joined')
3348
3349 def __unicode__(self):
3350 return u"<%s('%s[v%s]:%s')>" % (
3351 self.__class__.__name__,
3352 self.status, self.version, self.author
3353 )
3354
3355 @classmethod
3356 def get_status_lbl(cls, value):
3357 return dict(cls.STATUSES).get(value)
3358
3359 @property
3360 def status_lbl(self):
3361 return ChangesetStatus.get_status_lbl(self.status)
3362
3363 def get_api_data(self):
3364 status = self
3365 data = {
3366 'status_id': status.changeset_status_id,
3367 'status': status.status,
3368 }
3369 return data
3370
3371 def __json__(self):
3372 data = dict()
3373 data.update(self.get_api_data())
3374 return data
3375
3376
3377 class _PullRequestBase(BaseModel):
3378 """
3379 Common attributes of pull request and version entries.
3380 """
3381
3382 # .status values
3383 STATUS_NEW = u'new'
3384 STATUS_OPEN = u'open'
3385 STATUS_CLOSED = u'closed'
3386
3387 title = Column('title', Unicode(255), nullable=True)
3388 description = Column(
3389 'description', UnicodeText().with_variant(UnicodeText(10240), 'mysql'),
3390 nullable=True)
3391 # new/open/closed status of pull request (not approve/reject/etc)
3392 status = Column('status', Unicode(255), nullable=False, default=STATUS_NEW)
3393 created_on = Column(
3394 'created_on', DateTime(timezone=False), nullable=False,
3395 default=datetime.datetime.now)
3396 updated_on = Column(
3397 'updated_on', DateTime(timezone=False), nullable=False,
3398 default=datetime.datetime.now)
3399
3400 @declared_attr
3401 def user_id(cls):
3402 return Column(
3403 "user_id", Integer(), ForeignKey('users.user_id'), nullable=False,
3404 unique=None)
3405
3406 # 500 revisions max
3407 _revisions = Column(
3408 'revisions', UnicodeText().with_variant(UnicodeText(20500), 'mysql'))
3409
3410 @declared_attr
3411 def source_repo_id(cls):
3412 # TODO: dan: rename column to source_repo_id
3413 return Column(
3414 'org_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3415 nullable=False)
3416
3417 source_ref = Column('org_ref', Unicode(255), nullable=False)
3418
3419 @declared_attr
3420 def target_repo_id(cls):
3421 # TODO: dan: rename column to target_repo_id
3422 return Column(
3423 'other_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3424 nullable=False)
3425
3426 target_ref = Column('other_ref', Unicode(255), nullable=False)
3427 _shadow_merge_ref = Column('shadow_merge_ref', Unicode(255), nullable=True)
3428
3429 # TODO: dan: rename column to last_merge_source_rev
3430 _last_merge_source_rev = Column(
3431 'last_merge_org_rev', String(40), nullable=True)
3432 # TODO: dan: rename column to last_merge_target_rev
3433 _last_merge_target_rev = Column(
3434 'last_merge_other_rev', String(40), nullable=True)
3435 _last_merge_status = Column('merge_status', Integer(), nullable=True)
3436 merge_rev = Column('merge_rev', String(40), nullable=True)
3437
3438 reviewer_data = Column(
3439 'reviewer_data_json', MutationObj.as_mutable(
3440 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
3441
3442 @property
3443 def reviewer_data_json(self):
3444 return json.dumps(self.reviewer_data)
3445
3446 @hybrid_property
3447 def description_safe(self):
3448 from rhodecode.lib import helpers as h
3449 return h.escape(self.description)
3450
3451 @hybrid_property
3452 def revisions(self):
3453 return self._revisions.split(':') if self._revisions else []
3454
3455 @revisions.setter
3456 def revisions(self, val):
3457 self._revisions = ':'.join(val)
3458
3459 @hybrid_property
3460 def last_merge_status(self):
3461 return safe_int(self._last_merge_status)
3462
3463 @last_merge_status.setter
3464 def last_merge_status(self, val):
3465 self._last_merge_status = val
3466
3467 @declared_attr
3468 def author(cls):
3469 return relationship('User', lazy='joined')
3470
3471 @declared_attr
3472 def source_repo(cls):
3473 return relationship(
3474 'Repository',
3475 primaryjoin='%s.source_repo_id==Repository.repo_id' % cls.__name__)
3476
3477 @property
3478 def source_ref_parts(self):
3479 return self.unicode_to_reference(self.source_ref)
3480
3481 @declared_attr
3482 def target_repo(cls):
3483 return relationship(
3484 'Repository',
3485 primaryjoin='%s.target_repo_id==Repository.repo_id' % cls.__name__)
3486
3487 @property
3488 def target_ref_parts(self):
3489 return self.unicode_to_reference(self.target_ref)
3490
3491 @property
3492 def shadow_merge_ref(self):
3493 return self.unicode_to_reference(self._shadow_merge_ref)
3494
3495 @shadow_merge_ref.setter
3496 def shadow_merge_ref(self, ref):
3497 self._shadow_merge_ref = self.reference_to_unicode(ref)
3498
3499 def unicode_to_reference(self, raw):
3500 """
3501 Convert a unicode (or string) to a reference object.
3502 If unicode evaluates to False it returns None.
3503 """
3504 if raw:
3505 refs = raw.split(':')
3506 return Reference(*refs)
3507 else:
3508 return None
3509
3510 def reference_to_unicode(self, ref):
3511 """
3512 Convert a reference object to unicode.
3513 If reference is None it returns None.
3514 """
3515 if ref:
3516 return u':'.join(ref)
3517 else:
3518 return None
3519
3520 def get_api_data(self, with_merge_state=True):
3521 from rhodecode.model.pull_request import PullRequestModel
3522
3523 pull_request = self
3524 if with_merge_state:
3525 merge_status = PullRequestModel().merge_status(pull_request)
3526 merge_state = {
3527 'status': merge_status[0],
3528 'message': safe_unicode(merge_status[1]),
3529 }
3530 else:
3531 merge_state = {'status': 'not_available',
3532 'message': 'not_available'}
3533
3534 merge_data = {
3535 'clone_url': PullRequestModel().get_shadow_clone_url(pull_request),
3536 'reference': (
3537 pull_request.shadow_merge_ref._asdict()
3538 if pull_request.shadow_merge_ref else None),
3539 }
3540
3541 data = {
3542 'pull_request_id': pull_request.pull_request_id,
3543 'url': PullRequestModel().get_url(pull_request),
3544 'title': pull_request.title,
3545 'description': pull_request.description,
3546 'status': pull_request.status,
3547 'created_on': pull_request.created_on,
3548 'updated_on': pull_request.updated_on,
3549 'commit_ids': pull_request.revisions,
3550 'review_status': pull_request.calculated_review_status(),
3551 'mergeable': merge_state,
3552 'source': {
3553 'clone_url': pull_request.source_repo.clone_url(),
3554 'repository': pull_request.source_repo.repo_name,
3555 'reference': {
3556 'name': pull_request.source_ref_parts.name,
3557 'type': pull_request.source_ref_parts.type,
3558 'commit_id': pull_request.source_ref_parts.commit_id,
3559 },
3560 },
3561 'target': {
3562 'clone_url': pull_request.target_repo.clone_url(),
3563 'repository': pull_request.target_repo.repo_name,
3564 'reference': {
3565 'name': pull_request.target_ref_parts.name,
3566 'type': pull_request.target_ref_parts.type,
3567 'commit_id': pull_request.target_ref_parts.commit_id,
3568 },
3569 },
3570 'merge': merge_data,
3571 'author': pull_request.author.get_api_data(include_secrets=False,
3572 details='basic'),
3573 'reviewers': [
3574 {
3575 'user': reviewer.get_api_data(include_secrets=False,
3576 details='basic'),
3577 'reasons': reasons,
3578 'review_status': st[0][1].status if st else 'not_reviewed',
3579 }
3580 for reviewer, reasons, mandatory, st in
3581 pull_request.reviewers_statuses()
3582 ]
3583 }
3584
3585 return data
3586
3587
3588 class PullRequest(Base, _PullRequestBase):
3589 __tablename__ = 'pull_requests'
3590 __table_args__ = (
3591 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3592 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3593 )
3594
3595 pull_request_id = Column(
3596 'pull_request_id', Integer(), nullable=False, primary_key=True)
3597
3598 def __repr__(self):
3599 if self.pull_request_id:
3600 return '<DB:PullRequest #%s>' % self.pull_request_id
3601 else:
3602 return '<DB:PullRequest at %#x>' % id(self)
3603
3604 reviewers = relationship('PullRequestReviewers',
3605 cascade="all, delete, delete-orphan")
3606 statuses = relationship('ChangesetStatus',
3607 cascade="all, delete, delete-orphan")
3608 comments = relationship('ChangesetComment',
3609 cascade="all, delete, delete-orphan")
3610 versions = relationship('PullRequestVersion',
3611 cascade="all, delete, delete-orphan",
3612 lazy='dynamic')
3613
3614 @classmethod
3615 def get_pr_display_object(cls, pull_request_obj, org_pull_request_obj,
3616 internal_methods=None):
3617
3618 class PullRequestDisplay(object):
3619 """
3620 Special object wrapper for showing PullRequest data via Versions
3621 It mimics PR object as close as possible. This is read only object
3622 just for display
3623 """
3624
3625 def __init__(self, attrs, internal=None):
3626 self.attrs = attrs
3627 # internal have priority over the given ones via attrs
3628 self.internal = internal or ['versions']
3629
3630 def __getattr__(self, item):
3631 if item in self.internal:
3632 return getattr(self, item)
3633 try:
3634 return self.attrs[item]
3635 except KeyError:
3636 raise AttributeError(
3637 '%s object has no attribute %s' % (self, item))
3638
3639 def __repr__(self):
3640 return '<DB:PullRequestDisplay #%s>' % self.attrs.get('pull_request_id')
3641
3642 def versions(self):
3643 return pull_request_obj.versions.order_by(
3644 PullRequestVersion.pull_request_version_id).all()
3645
3646 def is_closed(self):
3647 return pull_request_obj.is_closed()
3648
3649 @property
3650 def pull_request_version_id(self):
3651 return getattr(pull_request_obj, 'pull_request_version_id', None)
3652
3653 attrs = StrictAttributeDict(pull_request_obj.get_api_data())
3654
3655 attrs.author = StrictAttributeDict(
3656 pull_request_obj.author.get_api_data())
3657 if pull_request_obj.target_repo:
3658 attrs.target_repo = StrictAttributeDict(
3659 pull_request_obj.target_repo.get_api_data())
3660 attrs.target_repo.clone_url = pull_request_obj.target_repo.clone_url
3661
3662 if pull_request_obj.source_repo:
3663 attrs.source_repo = StrictAttributeDict(
3664 pull_request_obj.source_repo.get_api_data())
3665 attrs.source_repo.clone_url = pull_request_obj.source_repo.clone_url
3666
3667 attrs.source_ref_parts = pull_request_obj.source_ref_parts
3668 attrs.target_ref_parts = pull_request_obj.target_ref_parts
3669 attrs.revisions = pull_request_obj.revisions
3670
3671 attrs.shadow_merge_ref = org_pull_request_obj.shadow_merge_ref
3672 attrs.reviewer_data = org_pull_request_obj.reviewer_data
3673 attrs.reviewer_data_json = org_pull_request_obj.reviewer_data_json
3674
3675 return PullRequestDisplay(attrs, internal=internal_methods)
3676
3677 def is_closed(self):
3678 return self.status == self.STATUS_CLOSED
3679
3680 def __json__(self):
3681 return {
3682 'revisions': self.revisions,
3683 }
3684
3685 def calculated_review_status(self):
3686 from rhodecode.model.changeset_status import ChangesetStatusModel
3687 return ChangesetStatusModel().calculated_review_status(self)
3688
3689 def reviewers_statuses(self):
3690 from rhodecode.model.changeset_status import ChangesetStatusModel
3691 return ChangesetStatusModel().reviewers_statuses(self)
3692
3693 @property
3694 def workspace_id(self):
3695 from rhodecode.model.pull_request import PullRequestModel
3696 return PullRequestModel()._workspace_id(self)
3697
3698 def get_shadow_repo(self):
3699 workspace_id = self.workspace_id
3700 vcs_obj = self.target_repo.scm_instance()
3701 shadow_repository_path = vcs_obj._get_shadow_repository_path(
3702 workspace_id)
3703 return vcs_obj._get_shadow_instance(shadow_repository_path)
3704
3705
3706 class PullRequestVersion(Base, _PullRequestBase):
3707 __tablename__ = 'pull_request_versions'
3708 __table_args__ = (
3709 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3710 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3711 )
3712
3713 pull_request_version_id = Column(
3714 'pull_request_version_id', Integer(), nullable=False, primary_key=True)
3715 pull_request_id = Column(
3716 'pull_request_id', Integer(),
3717 ForeignKey('pull_requests.pull_request_id'), nullable=False)
3718 pull_request = relationship('PullRequest')
3719
3720 def __repr__(self):
3721 if self.pull_request_version_id:
3722 return '<DB:PullRequestVersion #%s>' % self.pull_request_version_id
3723 else:
3724 return '<DB:PullRequestVersion at %#x>' % id(self)
3725
3726 @property
3727 def reviewers(self):
3728 return self.pull_request.reviewers
3729
3730 @property
3731 def versions(self):
3732 return self.pull_request.versions
3733
3734 def is_closed(self):
3735 # calculate from original
3736 return self.pull_request.status == self.STATUS_CLOSED
3737
3738 def calculated_review_status(self):
3739 return self.pull_request.calculated_review_status()
3740
3741 def reviewers_statuses(self):
3742 return self.pull_request.reviewers_statuses()
3743
3744
3745 class PullRequestReviewers(Base, BaseModel):
3746 __tablename__ = 'pull_request_reviewers'
3747 __table_args__ = (
3748 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3749 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3750 )
3751
3752 @hybrid_property
3753 def reasons(self):
3754 if not self._reasons:
3755 return []
3756 return self._reasons
3757
3758 @reasons.setter
3759 def reasons(self, val):
3760 val = val or []
3761 if any(not isinstance(x, basestring) for x in val):
3762 raise Exception('invalid reasons type, must be list of strings')
3763 self._reasons = val
3764
3765 pull_requests_reviewers_id = Column(
3766 'pull_requests_reviewers_id', Integer(), nullable=False,
3767 primary_key=True)
3768 pull_request_id = Column(
3769 "pull_request_id", Integer(),
3770 ForeignKey('pull_requests.pull_request_id'), nullable=False)
3771 user_id = Column(
3772 "user_id", Integer(), ForeignKey('users.user_id'), nullable=True)
3773 _reasons = Column(
3774 'reason', MutationList.as_mutable(
3775 JsonType('list', dialect_map=dict(mysql=UnicodeText(16384)))))
3776 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
3777 user = relationship('User')
3778 pull_request = relationship('PullRequest')
3779
3780
3781 class Notification(Base, BaseModel):
3782 __tablename__ = 'notifications'
3783 __table_args__ = (
3784 Index('notification_type_idx', 'type'),
3785 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3786 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3787 )
3788
3789 TYPE_CHANGESET_COMMENT = u'cs_comment'
3790 TYPE_MESSAGE = u'message'
3791 TYPE_MENTION = u'mention'
3792 TYPE_REGISTRATION = u'registration'
3793 TYPE_PULL_REQUEST = u'pull_request'
3794 TYPE_PULL_REQUEST_COMMENT = u'pull_request_comment'
3795
3796 notification_id = Column('notification_id', Integer(), nullable=False, primary_key=True)
3797 subject = Column('subject', Unicode(512), nullable=True)
3798 body = Column('body', UnicodeText().with_variant(UnicodeText(50000), 'mysql'), nullable=True)
3799 created_by = Column("created_by", Integer(), ForeignKey('users.user_id'), nullable=True)
3800 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3801 type_ = Column('type', Unicode(255))
3802
3803 created_by_user = relationship('User')
3804 notifications_to_users = relationship('UserNotification', lazy='joined',
3805 cascade="all, delete, delete-orphan")
3806
3807 @property
3808 def recipients(self):
3809 return [x.user for x in UserNotification.query()\
3810 .filter(UserNotification.notification == self)\
3811 .order_by(UserNotification.user_id.asc()).all()]
3812
3813 @classmethod
3814 def create(cls, created_by, subject, body, recipients, type_=None):
3815 if type_ is None:
3816 type_ = Notification.TYPE_MESSAGE
3817
3818 notification = cls()
3819 notification.created_by_user = created_by
3820 notification.subject = subject
3821 notification.body = body
3822 notification.type_ = type_
3823 notification.created_on = datetime.datetime.now()
3824
3825 for u in recipients:
3826 assoc = UserNotification()
3827 assoc.notification = notification
3828
3829 # if created_by is inside recipients mark his notification
3830 # as read
3831 if u.user_id == created_by.user_id:
3832 assoc.read = True
3833
3834 u.notifications.append(assoc)
3835 Session().add(notification)
3836
3837 return notification
3838
3839
3840 class UserNotification(Base, BaseModel):
3841 __tablename__ = 'user_to_notification'
3842 __table_args__ = (
3843 UniqueConstraint('user_id', 'notification_id'),
3844 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3845 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3846 )
3847 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), primary_key=True)
3848 notification_id = Column("notification_id", Integer(), ForeignKey('notifications.notification_id'), primary_key=True)
3849 read = Column('read', Boolean, default=False)
3850 sent_on = Column('sent_on', DateTime(timezone=False), nullable=True, unique=None)
3851
3852 user = relationship('User', lazy="joined")
3853 notification = relationship('Notification', lazy="joined",
3854 order_by=lambda: Notification.created_on.desc(),)
3855
3856 def mark_as_read(self):
3857 self.read = True
3858 Session().add(self)
3859
3860
3861 class Gist(Base, BaseModel):
3862 __tablename__ = 'gists'
3863 __table_args__ = (
3864 Index('g_gist_access_id_idx', 'gist_access_id'),
3865 Index('g_created_on_idx', 'created_on'),
3866 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3867 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3868 )
3869 GIST_PUBLIC = u'public'
3870 GIST_PRIVATE = u'private'
3871 DEFAULT_FILENAME = u'gistfile1.txt'
3872
3873 ACL_LEVEL_PUBLIC = u'acl_public'
3874 ACL_LEVEL_PRIVATE = u'acl_private'
3875
3876 gist_id = Column('gist_id', Integer(), primary_key=True)
3877 gist_access_id = Column('gist_access_id', Unicode(250))
3878 gist_description = Column('gist_description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
3879 gist_owner = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=True)
3880 gist_expires = Column('gist_expires', Float(53), nullable=False)
3881 gist_type = Column('gist_type', Unicode(128), nullable=False)
3882 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3883 modified_at = Column('modified_at', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3884 acl_level = Column('acl_level', Unicode(128), nullable=True)
3885
3886 owner = relationship('User')
3887
3888 def __repr__(self):
3889 return '<Gist:[%s]%s>' % (self.gist_type, self.gist_access_id)
3890
3891 @hybrid_property
3892 def description_safe(self):
3893 from rhodecode.lib import helpers as h
3894 return h.escape(self.gist_description)
3895
3896 @classmethod
3897 def get_or_404(cls, id_):
3898 from pyramid.httpexceptions import HTTPNotFound
3899
3900 res = cls.query().filter(cls.gist_access_id == id_).scalar()
3901 if not res:
3902 raise HTTPNotFound()
3903 return res
3904
3905 @classmethod
3906 def get_by_access_id(cls, gist_access_id):
3907 return cls.query().filter(cls.gist_access_id == gist_access_id).scalar()
3908
3909 def gist_url(self):
3910 from rhodecode.model.gist import GistModel
3911 return GistModel().get_url(self)
3912
3913 @classmethod
3914 def base_path(cls):
3915 """
3916 Returns base path when all gists are stored
3917
3918 :param cls:
3919 """
3920 from rhodecode.model.gist import GIST_STORE_LOC
3921 q = Session().query(RhodeCodeUi)\
3922 .filter(RhodeCodeUi.ui_key == URL_SEP)
3923 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
3924 return os.path.join(q.one().ui_value, GIST_STORE_LOC)
3925
3926 def get_api_data(self):
3927 """
3928 Common function for generating gist related data for API
3929 """
3930 gist = self
3931 data = {
3932 'gist_id': gist.gist_id,
3933 'type': gist.gist_type,
3934 'access_id': gist.gist_access_id,
3935 'description': gist.gist_description,
3936 'url': gist.gist_url(),
3937 'expires': gist.gist_expires,
3938 'created_on': gist.created_on,
3939 'modified_at': gist.modified_at,
3940 'content': None,
3941 'acl_level': gist.acl_level,
3942 }
3943 return data
3944
3945 def __json__(self):
3946 data = dict(
3947 )
3948 data.update(self.get_api_data())
3949 return data
3950 # SCM functions
3951
3952 def scm_instance(self, **kwargs):
3953 full_repo_path = os.path.join(self.base_path(), self.gist_access_id)
3954 return get_vcs_instance(
3955 repo_path=safe_str(full_repo_path), create=False)
3956
3957
3958 class ExternalIdentity(Base, BaseModel):
3959 __tablename__ = 'external_identities'
3960 __table_args__ = (
3961 Index('local_user_id_idx', 'local_user_id'),
3962 Index('external_id_idx', 'external_id'),
3963 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3964 'mysql_charset': 'utf8'})
3965
3966 external_id = Column('external_id', Unicode(255), default=u'',
3967 primary_key=True)
3968 external_username = Column('external_username', Unicode(1024), default=u'')
3969 local_user_id = Column('local_user_id', Integer(),
3970 ForeignKey('users.user_id'), primary_key=True)
3971 provider_name = Column('provider_name', Unicode(255), default=u'',
3972 primary_key=True)
3973 access_token = Column('access_token', String(1024), default=u'')
3974 alt_token = Column('alt_token', String(1024), default=u'')
3975 token_secret = Column('token_secret', String(1024), default=u'')
3976
3977 @classmethod
3978 def by_external_id_and_provider(cls, external_id, provider_name,
3979 local_user_id=None):
3980 """
3981 Returns ExternalIdentity instance based on search params
3982
3983 :param external_id:
3984 :param provider_name:
3985 :return: ExternalIdentity
3986 """
3987 query = cls.query()
3988 query = query.filter(cls.external_id == external_id)
3989 query = query.filter(cls.provider_name == provider_name)
3990 if local_user_id:
3991 query = query.filter(cls.local_user_id == local_user_id)
3992 return query.first()
3993
3994 @classmethod
3995 def user_by_external_id_and_provider(cls, external_id, provider_name):
3996 """
3997 Returns User instance based on search params
3998
3999 :param external_id:
4000 :param provider_name:
4001 :return: User
4002 """
4003 query = User.query()
4004 query = query.filter(cls.external_id == external_id)
4005 query = query.filter(cls.provider_name == provider_name)
4006 query = query.filter(User.user_id == cls.local_user_id)
4007 return query.first()
4008
4009 @classmethod
4010 def by_local_user_id(cls, local_user_id):
4011 """
4012 Returns all tokens for user
4013
4014 :param local_user_id:
4015 :return: ExternalIdentity
4016 """
4017 query = cls.query()
4018 query = query.filter(cls.local_user_id == local_user_id)
4019 return query
4020
4021
4022 class Integration(Base, BaseModel):
4023 __tablename__ = 'integrations'
4024 __table_args__ = (
4025 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4026 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
4027 )
4028
4029 integration_id = Column('integration_id', Integer(), primary_key=True)
4030 integration_type = Column('integration_type', String(255))
4031 enabled = Column('enabled', Boolean(), nullable=False)
4032 name = Column('name', String(255), nullable=False)
4033 child_repos_only = Column('child_repos_only', Boolean(), nullable=False,
4034 default=False)
4035
4036 settings = Column(
4037 'settings_json', MutationObj.as_mutable(
4038 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
4039 repo_id = Column(
4040 'repo_id', Integer(), ForeignKey('repositories.repo_id'),
4041 nullable=True, unique=None, default=None)
4042 repo = relationship('Repository', lazy='joined')
4043
4044 repo_group_id = Column(
4045 'repo_group_id', Integer(), ForeignKey('groups.group_id'),
4046 nullable=True, unique=None, default=None)
4047 repo_group = relationship('RepoGroup', lazy='joined')
4048
4049 @property
4050 def scope(self):
4051 if self.repo:
4052 return repr(self.repo)
4053 if self.repo_group:
4054 if self.child_repos_only:
4055 return repr(self.repo_group) + ' (child repos only)'
4056 else:
4057 return repr(self.repo_group) + ' (recursive)'
4058 if self.child_repos_only:
4059 return 'root_repos'
4060 return 'global'
4061
4062 def __repr__(self):
4063 return '<Integration(%r, %r)>' % (self.integration_type, self.scope)
4064
4065
4066 class RepoReviewRuleUser(Base, BaseModel):
4067 __tablename__ = 'repo_review_rules_users'
4068 __table_args__ = (
4069 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4070 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
4071 )
4072 repo_review_rule_user_id = Column('repo_review_rule_user_id', Integer(), primary_key=True)
4073 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
4074 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False)
4075 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
4076 user = relationship('User')
4077
4078 def rule_data(self):
4079 return {
4080 'mandatory': self.mandatory
4081 }
4082
4083
4084 class RepoReviewRuleUserGroup(Base, BaseModel):
4085 __tablename__ = 'repo_review_rules_users_groups'
4086 __table_args__ = (
4087 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4088 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
4089 )
4090 repo_review_rule_users_group_id = Column('repo_review_rule_users_group_id', Integer(), primary_key=True)
4091 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
4092 users_group_id = Column("users_group_id", Integer(),ForeignKey('users_groups.users_group_id'), nullable=False)
4093 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
4094 users_group = relationship('UserGroup')
4095
4096 def rule_data(self):
4097 return {
4098 'mandatory': self.mandatory
4099 }
4100
4101
4102 class RepoReviewRule(Base, BaseModel):
4103 __tablename__ = 'repo_review_rules'
4104 __table_args__ = (
4105 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4106 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
4107 )
4108
4109 repo_review_rule_id = Column(
4110 'repo_review_rule_id', Integer(), primary_key=True)
4111 repo_id = Column(
4112 "repo_id", Integer(), ForeignKey('repositories.repo_id'))
4113 repo = relationship('Repository', backref='review_rules')
4114
4115 _branch_pattern = Column("branch_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4116 _file_pattern = Column("file_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4117
4118 use_authors_for_review = Column("use_authors_for_review", Boolean(), nullable=False, default=False)
4119 forbid_author_to_review = Column("forbid_author_to_review", Boolean(), nullable=False, default=False)
4120 forbid_commit_author_to_review = Column("forbid_commit_author_to_review", Boolean(), nullable=False, default=False)
4121 forbid_adding_reviewers = Column("forbid_adding_reviewers", Boolean(), nullable=False, default=False)
4122
4123 rule_users = relationship('RepoReviewRuleUser')
4124 rule_user_groups = relationship('RepoReviewRuleUserGroup')
4125
4126 @hybrid_property
4127 def branch_pattern(self):
4128 return self._branch_pattern or '*'
4129
4130 def _validate_glob(self, value):
4131 re.compile('^' + glob2re(value) + '$')
4132
4133 @branch_pattern.setter
4134 def branch_pattern(self, value):
4135 self._validate_glob(value)
4136 self._branch_pattern = value or '*'
4137
4138 @hybrid_property
4139 def file_pattern(self):
4140 return self._file_pattern or '*'
4141
4142 @file_pattern.setter
4143 def file_pattern(self, value):
4144 self._validate_glob(value)
4145 self._file_pattern = value or '*'
4146
4147 def matches(self, branch, files_changed):
4148 """
4149 Check if this review rule matches a branch/files in a pull request
4150
4151 :param branch: branch name for the commit
4152 :param files_changed: list of file paths changed in the pull request
4153 """
4154
4155 branch = branch or ''
4156 files_changed = files_changed or []
4157
4158 branch_matches = True
4159 if branch:
4160 branch_regex = re.compile('^' + glob2re(self.branch_pattern) + '$')
4161 branch_matches = bool(branch_regex.search(branch))
4162
4163 files_matches = True
4164 if self.file_pattern != '*':
4165 files_matches = False
4166 file_regex = re.compile(glob2re(self.file_pattern))
4167 for filename in files_changed:
4168 if file_regex.search(filename):
4169 files_matches = True
4170 break
4171
4172 return branch_matches and files_matches
4173
4174 @property
4175 def review_users(self):
4176 """ Returns the users which this rule applies to """
4177
4178 users = collections.OrderedDict()
4179
4180 for rule_user in self.rule_users:
4181 if rule_user.user.active:
4182 if rule_user.user not in users:
4183 users[rule_user.user.username] = {
4184 'user': rule_user.user,
4185 'source': 'user',
4186 'source_data': {},
4187 'data': rule_user.rule_data()
4188 }
4189
4190 for rule_user_group in self.rule_user_groups:
4191 source_data = {
4192 'name': rule_user_group.users_group.users_group_name,
4193 'members': len(rule_user_group.users_group.members)
4194 }
4195 for member in rule_user_group.users_group.members:
4196 if member.user.active:
4197 users[member.user.username] = {
4198 'user': member.user,
4199 'source': 'user_group',
4200 'source_data': source_data,
4201 'data': rule_user_group.rule_data()
4202 }
4203
4204 return users
4205
4206 def __repr__(self):
4207 return '<RepoReviewerRule(id=%r, repo=%r)>' % (
4208 self.repo_review_rule_id, self.repo)
4209
4210
4211 class ScheduleEntry(Base, BaseModel):
4212 __tablename__ = 'schedule_entries'
4213 __table_args__ = (
4214 UniqueConstraint('schedule_name', name='s_schedule_name_idx'),
4215 UniqueConstraint('task_uid', name='s_task_uid_idx'),
4216 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4217 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
4218 )
4219 schedule_types = ['crontab', 'timedelta', 'integer']
4220 schedule_entry_id = Column('schedule_entry_id', Integer(), primary_key=True)
4221
4222 schedule_name = Column("schedule_name", String(255), nullable=False, unique=None, default=None)
4223 schedule_description = Column("schedule_description", String(10000), nullable=True, unique=None, default=None)
4224 schedule_enabled = Column("schedule_enabled", Boolean(), nullable=False, unique=None, default=True)
4225
4226 _schedule_type = Column("schedule_type", String(255), nullable=False, unique=None, default=None)
4227 schedule_definition = Column('schedule_definition_json', MutationObj.as_mutable(JsonType(default=lambda: "", dialect_map=dict(mysql=LONGTEXT()))))
4228
4229 schedule_last_run = Column('schedule_last_run', DateTime(timezone=False), nullable=True, unique=None, default=None)
4230 schedule_total_run_count = Column('schedule_total_run_count', Integer(), nullable=True, unique=None, default=0)
4231
4232 # task
4233 task_uid = Column("task_uid", String(255), nullable=False, unique=None, default=None)
4234 task_dot_notation = Column("task_dot_notation", String(4096), nullable=False, unique=None, default=None)
4235 task_args = Column('task_args_json', MutationObj.as_mutable(JsonType(default=list, dialect_map=dict(mysql=LONGTEXT()))))
4236 task_kwargs = Column('task_kwargs_json', MutationObj.as_mutable(JsonType(default=dict, dialect_map=dict(mysql=LONGTEXT()))))
4237
4238 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4239 updated_on = Column('updated_on', DateTime(timezone=False), nullable=True, unique=None, default=None)
4240
4241 @hybrid_property
4242 def schedule_type(self):
4243 return self._schedule_type
4244
4245 @schedule_type.setter
4246 def schedule_type(self, val):
4247 if val not in self.schedule_types:
4248 raise ValueError('Value must be on of `{}` and got `{}`'.format(
4249 val, self.schedule_type))
4250
4251 self._schedule_type = val
4252
4253 @classmethod
4254 def get_uid(cls, obj):
4255 args = obj.task_args
4256 kwargs = obj.task_kwargs
4257 if isinstance(args, JsonRaw):
4258 try:
4259 args = json.loads(args)
4260 except ValueError:
4261 args = tuple()
4262
4263 if isinstance(kwargs, JsonRaw):
4264 try:
4265 kwargs = json.loads(kwargs)
4266 except ValueError:
4267 kwargs = dict()
4268
4269 dot_notation = obj.task_dot_notation
4270 val = '.'.join(map(safe_str, [
4271 sorted(dot_notation), args, sorted(kwargs.items())]))
4272 return hashlib.sha1(val).hexdigest()
4273
4274 @classmethod
4275 def get_by_schedule_name(cls, schedule_name):
4276 return cls.query().filter(cls.schedule_name == schedule_name).scalar()
4277
4278 @classmethod
4279 def get_by_schedule_id(cls, schedule_id):
4280 return cls.query().filter(cls.schedule_entry_id == schedule_id).scalar()
4281
4282 @property
4283 def task(self):
4284 return self.task_dot_notation
4285
4286 @property
4287 def schedule(self):
4288 from rhodecode.lib.celerylib.utils import raw_2_schedule
4289 schedule = raw_2_schedule(self.schedule_definition, self.schedule_type)
4290 return schedule
4291
4292 @property
4293 def args(self):
4294 try:
4295 return list(self.task_args or [])
4296 except ValueError:
4297 return list()
4298
4299 @property
4300 def kwargs(self):
4301 try:
4302 return dict(self.task_kwargs or {})
4303 except ValueError:
4304 return dict()
4305
4306 def _as_raw(self, val):
4307 if hasattr(val, 'de_coerce'):
4308 val = val.de_coerce()
4309 if val:
4310 val = json.dumps(val)
4311
4312 return val
4313
4314 @property
4315 def schedule_definition_raw(self):
4316 return self._as_raw(self.schedule_definition)
4317
4318 @property
4319 def args_raw(self):
4320 return self._as_raw(self.task_args)
4321
4322 @property
4323 def kwargs_raw(self):
4324 return self._as_raw(self.task_kwargs)
4325
4326 def __repr__(self):
4327 return '<DB:ScheduleEntry({}:{})>'.format(
4328 self.schedule_entry_id, self.schedule_name)
4329
4330
4331 @event.listens_for(ScheduleEntry, 'before_update')
4332 def update_task_uid(mapper, connection, target):
4333 target.task_uid = ScheduleEntry.get_uid(target)
4334
4335
4336 @event.listens_for(ScheduleEntry, 'before_insert')
4337 def set_task_uid(mapper, connection, target):
4338 target.task_uid = ScheduleEntry.get_uid(target)
4339
4340
4341 class DbMigrateVersion(Base, BaseModel):
4342 __tablename__ = 'db_migrate_version'
4343 __table_args__ = (
4344 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4345 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
4346 )
4347 repository_id = Column('repository_id', String(250), primary_key=True)
4348 repository_path = Column('repository_path', Text)
4349 version = Column('version', Integer)
4350
4351
4352 class DbSession(Base, BaseModel):
4353 __tablename__ = 'db_session'
4354 __table_args__ = (
4355 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4356 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
4357 )
4358
4359 def __repr__(self):
4360 return '<DB:DbSession({})>'.format(self.id)
4361
4362 id = Column('id', Integer())
4363 namespace = Column('namespace', String(255), primary_key=True)
4364 accessed = Column('accessed', DateTime, nullable=False)
4365 created = Column('created', DateTime, nullable=False)
4366 data = Column('data', PickleType, nullable=False)
@@ -0,0 +1,32 b''
1 import logging
2
3 from sqlalchemy import *
4
5 from rhodecode.model import meta
6 from rhodecode.lib.dbmigrate.versions import _reset_base, notify
7
8 log = logging.getLogger(__name__)
9
10
11 def upgrade(migrate_engine):
12 """
13 Upgrade operations go here.
14 Don't create your own engine; bind migrate_engine to your metadata
15 """
16 _reset_base(migrate_engine)
17 from rhodecode.lib.dbmigrate.schema import db_4_11_0_0
18 db_4_11_0_0.ScheduleEntry().__table__.create()
19
20 # issue fixups
21 fixups(db_4_11_0_0, meta.Session)
22
23
24 def downgrade(migrate_engine):
25 meta = MetaData()
26 meta.bind = migrate_engine
27
28
29 def fixups(models, _SESSION):
30 pass
31
32
@@ -51,7 +51,7 b' PYRAMID_SETTINGS = {}'
51 51 EXTENSIONS = {}
52 52
53 53 __version__ = ('.'.join((str(each) for each in VERSION[:3])))
54 __dbversion__ = 81 # defines current db version for migrations
54 __dbversion__ = 82 # defines current db version for migrations
55 55 __platform__ = platform.system()
56 56 __license__ = 'AGPLv3, and Commercial License'
57 57 __author__ = 'RhodeCode GmbH'
@@ -20,7 +20,11 b''
20 20 """
21 21 Celery loader, run with::
22 22
23 celery worker --beat --app rhodecode.lib.celerylib.loader --loglevel DEBUG --ini=._dev/dev.ini
23 celery worker \
24 --beat \
25 --app rhodecode.lib.celerylib.loader \
26 --scheduler rhodecode.lib.celerylib.scheduler.RcScheduler \
27 --loglevel DEBUG --ini=._dev/dev.ini
24 28 """
25 29 import os
26 30 import logging
@@ -83,6 +87,10 b' base_celery_config = {'
83 87 'task_serializer': 'json_ext',
84 88 'result_serializer': 'json_ext',
85 89 'worker_hijack_root_logger': False,
90 'database_table_names': {
91 'task': 'beat_taskmeta',
92 'group': 'beat_groupmeta',
93 }
86 94 }
87 95 # init main celery app
88 96 celery_app = Celery()
@@ -24,6 +24,7 b' by celery daemon'
24 24 """
25 25
26 26 import os
27 import time
27 28
28 29 import rhodecode
29 30 from rhodecode.lib import audit_logger
@@ -268,8 +269,17 b' def create_repo_fork(form_data, cur_user'
268 269 def sync_repo(*args, **kwargs):
269 270 from rhodecode.model.scm import ScmModel
270 271 log = get_logger(sync_repo)
271
272 log.info('Pulling from %s', kwargs['repo_name'])
273 ScmModel().pull_changes(kwargs['repo_name'], kwargs['username'])
272 repo_name = kwargs['repo_name']
273 log.info('Pulling from %s', repo_name)
274 dbrepo = Repository.get_by_repo_name(repo_name)
275 if dbrepo and dbrepo.clone_uri:
276 ScmModel().pull_changes(kwargs['repo_name'], kwargs['username'])
277 else:
278 log.debug('Repo `%s` not found or without a clone_url', repo_name)
274 279
275 280
281 @async_task(ignore_result=False)
282 def beat_check(*args, **kwargs):
283 log = get_logger(beat_check)
284 log.info('Got args: %r and kwargs %r', args, kwargs)
285 return time.time()
@@ -64,34 +64,44 b' def safe_json(get, section, key):'
64 64 return json_value
65 65
66 66
67 def get_beat_config(parser, section):
68 SCHEDULE_TYPE_MAP = {
67 def raw_2_schedule(schedule_value, schedule_type):
68 schedule_type_map = {
69 69 'crontab': crontab,
70 70 'timedelta': timedelta,
71 71 'integer': int
72 72 }
73 scheduler_cls = schedule_type_map.get(schedule_type)
74
75 if scheduler_cls is None:
76 raise ValueError(
77 'schedule type %s in section is invalid' % (
78 schedule_type,
79 )
80 )
81 try:
82 schedule = scheduler_cls(schedule_value)
83 except TypeError:
84 log.exception('Failed to compose a schedule from value: %r', schedule_value)
85 schedule = None
86 return schedule
87
88
89 def get_beat_config(parser, section):
90
73 91 get = partial(parser.get, section)
74 92 has_option = partial(parser.has_option, section)
75 93
76 94 schedule_type = get('type')
77 95 schedule_value = safe_json(get, section, 'schedule')
78 96
79 scheduler_cls = SCHEDULE_TYPE_MAP.get(schedule_type)
80
81 if scheduler_cls is None:
82 raise ValueError(
83 'schedule type %s in section %s is invalid' % (
84 schedule_type,
85 section
86 )
87 )
88
89 schedule = scheduler_cls(schedule_value)
90
91 97 config = {
98 'schedule_type': schedule_type,
99 'schedule_value': schedule_value,
92 100 'task': get('task'),
93 'schedule': schedule,
94 101 }
102 schedule = raw_2_schedule(schedule_value, schedule_type)
103 if schedule:
104 config['schedule'] = schedule
95 105
96 106 if has_option('args'):
97 107 config['args'] = safe_json(get, section, 'args')
@@ -99,6 +109,9 b' def get_beat_config(parser, section):'
99 109 if has_option('kwargs'):
100 110 config['kwargs'] = safe_json(get, section, 'kwargs')
101 111
112 if has_option('force_update'):
113 config['force_update'] = get('force_update')
114
102 115 return config
103 116
104 117
@@ -36,7 +36,7 b' import collections'
36 36
37 37 from sqlalchemy import (
38 38 or_, and_, not_, func, TypeDecorator, event,
39 Index, UniqueConstraint, ForeignKey, CheckConstraint, Column,
39 Index, Sequence, UniqueConstraint, ForeignKey, CheckConstraint, Column,
40 40 Boolean, String, Unicode, UnicodeText, DateTime, Integer, LargeBinary,
41 41 Text, Float, PickleType)
42 42 from sqlalchemy.sql.expression import true, false
@@ -225,10 +225,10 b' class BaseModel(object):'
225 225 """return list with keys and values tuples corresponding
226 226 to this model data """
227 227
228 l = []
228 lst = []
229 229 for k in self._get_keys():
230 l.append((k, getattr(self, k),))
231 return l
230 lst.append((k, getattr(self, k),))
231 return lst
232 232
233 233 def populate_obj(self, populate_dict):
234 234 """populate model with data from given populate_dict"""
@@ -4208,6 +4208,136 b' class RepoReviewRule(Base, BaseModel):'
4208 4208 self.repo_review_rule_id, self.repo)
4209 4209
4210 4210
4211 class ScheduleEntry(Base, BaseModel):
4212 __tablename__ = 'schedule_entries'
4213 __table_args__ = (
4214 UniqueConstraint('schedule_name', name='s_schedule_name_idx'),
4215 UniqueConstraint('task_uid', name='s_task_uid_idx'),
4216 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4217 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
4218 )
4219 schedule_types = ['crontab', 'timedelta', 'integer']
4220 schedule_entry_id = Column('schedule_entry_id', Integer(), primary_key=True)
4221
4222 schedule_name = Column("schedule_name", String(255), nullable=False, unique=None, default=None)
4223 schedule_description = Column("schedule_description", String(10000), nullable=True, unique=None, default=None)
4224 schedule_enabled = Column("schedule_enabled", Boolean(), nullable=False, unique=None, default=True)
4225
4226 _schedule_type = Column("schedule_type", String(255), nullable=False, unique=None, default=None)
4227 schedule_definition = Column('schedule_definition_json', MutationObj.as_mutable(JsonType(default=lambda: "", dialect_map=dict(mysql=LONGTEXT()))))
4228
4229 schedule_last_run = Column('schedule_last_run', DateTime(timezone=False), nullable=True, unique=None, default=None)
4230 schedule_total_run_count = Column('schedule_total_run_count', Integer(), nullable=True, unique=None, default=0)
4231
4232 # task
4233 task_uid = Column("task_uid", String(255), nullable=False, unique=None, default=None)
4234 task_dot_notation = Column("task_dot_notation", String(4096), nullable=False, unique=None, default=None)
4235 task_args = Column('task_args_json', MutationObj.as_mutable(JsonType(default=list, dialect_map=dict(mysql=LONGTEXT()))))
4236 task_kwargs = Column('task_kwargs_json', MutationObj.as_mutable(JsonType(default=dict, dialect_map=dict(mysql=LONGTEXT()))))
4237
4238 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4239 updated_on = Column('updated_on', DateTime(timezone=False), nullable=True, unique=None, default=None)
4240
4241 @hybrid_property
4242 def schedule_type(self):
4243 return self._schedule_type
4244
4245 @schedule_type.setter
4246 def schedule_type(self, val):
4247 if val not in self.schedule_types:
4248 raise ValueError('Value must be on of `{}` and got `{}`'.format(
4249 val, self.schedule_type))
4250
4251 self._schedule_type = val
4252
4253 @classmethod
4254 def get_uid(cls, obj):
4255 args = obj.task_args
4256 kwargs = obj.task_kwargs
4257 if isinstance(args, JsonRaw):
4258 try:
4259 args = json.loads(args)
4260 except ValueError:
4261 args = tuple()
4262
4263 if isinstance(kwargs, JsonRaw):
4264 try:
4265 kwargs = json.loads(kwargs)
4266 except ValueError:
4267 kwargs = dict()
4268
4269 dot_notation = obj.task_dot_notation
4270 val = '.'.join(map(safe_str, [
4271 sorted(dot_notation), args, sorted(kwargs.items())]))
4272 return hashlib.sha1(val).hexdigest()
4273
4274 @classmethod
4275 def get_by_schedule_name(cls, schedule_name):
4276 return cls.query().filter(cls.schedule_name == schedule_name).scalar()
4277
4278 @classmethod
4279 def get_by_schedule_id(cls, schedule_id):
4280 return cls.query().filter(cls.schedule_entry_id == schedule_id).scalar()
4281
4282 @property
4283 def task(self):
4284 return self.task_dot_notation
4285
4286 @property
4287 def schedule(self):
4288 from rhodecode.lib.celerylib.utils import raw_2_schedule
4289 schedule = raw_2_schedule(self.schedule_definition, self.schedule_type)
4290 return schedule
4291
4292 @property
4293 def args(self):
4294 try:
4295 return list(self.task_args or [])
4296 except ValueError:
4297 return list()
4298
4299 @property
4300 def kwargs(self):
4301 try:
4302 return dict(self.task_kwargs or {})
4303 except ValueError:
4304 return dict()
4305
4306 def _as_raw(self, val):
4307 if hasattr(val, 'de_coerce'):
4308 val = val.de_coerce()
4309 if val:
4310 val = json.dumps(val)
4311
4312 return val
4313
4314 @property
4315 def schedule_definition_raw(self):
4316 return self._as_raw(self.schedule_definition)
4317
4318 @property
4319 def args_raw(self):
4320 return self._as_raw(self.task_args)
4321
4322 @property
4323 def kwargs_raw(self):
4324 return self._as_raw(self.task_kwargs)
4325
4326 def __repr__(self):
4327 return '<DB:ScheduleEntry({}:{})>'.format(
4328 self.schedule_entry_id, self.schedule_name)
4329
4330
4331 @event.listens_for(ScheduleEntry, 'before_update')
4332 def update_task_uid(mapper, connection, target):
4333 target.task_uid = ScheduleEntry.get_uid(target)
4334
4335
4336 @event.listens_for(ScheduleEntry, 'before_insert')
4337 def set_task_uid(mapper, connection, target):
4338 target.task_uid = ScheduleEntry.get_uid(target)
4339
4340
4211 4341 class DbMigrateVersion(Base, BaseModel):
4212 4342 __tablename__ = 'db_migrate_version'
4213 4343 __table_args__ = (
@@ -5,6 +5,7 b''
5 5 placeholder placeholder|field.widget.placeholder|field.placeholder|'';
6 6 mask_placeholder mask_placeholder|field.widget.mask_placeholder;
7 7 style style|field.widget.style;
8 help_block help_block|field.widget.help_block|'';
8 9 "
9 10 tal:omit-tag="">
10 11 <input type="text" name="${name}" value="${cstruct}"
@@ -12,6 +13,8 b''
12 13 style style"
13 14 placeholder="${placeholder}"
14 15 id="${oid}"/>
16
17 <p tal:condition="help_block" class="help-block">${help_block}</p>
15 18 <script tal:condition="mask" type="text/javascript">
16 19 deform.addCallback(
17 20 '${oid}',
General Comments 0
You need to be logged in to leave comments. Login now