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