##// END OF EJS Templates
ui: introduce user-bookmarks for creation of quick shortcuts
dan -
r3424:c7ed0ba5 default
parent child Browse files
Show More
This diff has been collapsed as it changes many lines, (4858 lines changed) Show them Hide them
@@ -0,0 +1,4858 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
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, basestring):
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 }
3502 return data
3503
3504 def __json__(self):
3505 data = dict()
3506 data.update(self.get_api_data())
3507 return data
3508
3509
3510 class ChangesetStatus(Base, BaseModel):
3511 __tablename__ = 'changeset_statuses'
3512 __table_args__ = (
3513 Index('cs_revision_idx', 'revision'),
3514 Index('cs_version_idx', 'version'),
3515 UniqueConstraint('repo_id', 'revision', 'version'),
3516 base_table_args
3517 )
3518
3519 STATUS_NOT_REVIEWED = DEFAULT = 'not_reviewed'
3520 STATUS_APPROVED = 'approved'
3521 STATUS_REJECTED = 'rejected'
3522 STATUS_UNDER_REVIEW = 'under_review'
3523
3524 STATUSES = [
3525 (STATUS_NOT_REVIEWED, _("Not Reviewed")), # (no icon) and default
3526 (STATUS_APPROVED, _("Approved")),
3527 (STATUS_REJECTED, _("Rejected")),
3528 (STATUS_UNDER_REVIEW, _("Under Review")),
3529 ]
3530
3531 changeset_status_id = Column('changeset_status_id', Integer(), nullable=False, primary_key=True)
3532 repo_id = Column('repo_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False)
3533 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None)
3534 revision = Column('revision', String(40), nullable=False)
3535 status = Column('status', String(128), nullable=False, default=DEFAULT)
3536 changeset_comment_id = Column('changeset_comment_id', Integer(), ForeignKey('changeset_comments.comment_id'))
3537 modified_at = Column('modified_at', DateTime(), nullable=False, default=datetime.datetime.now)
3538 version = Column('version', Integer(), nullable=False, default=0)
3539 pull_request_id = Column("pull_request_id", Integer(), ForeignKey('pull_requests.pull_request_id'), nullable=True)
3540
3541 author = relationship('User', lazy='joined')
3542 repo = relationship('Repository')
3543 comment = relationship('ChangesetComment', lazy='joined')
3544 pull_request = relationship('PullRequest', lazy='joined')
3545
3546 def __unicode__(self):
3547 return u"<%s('%s[v%s]:%s')>" % (
3548 self.__class__.__name__,
3549 self.status, self.version, self.author
3550 )
3551
3552 @classmethod
3553 def get_status_lbl(cls, value):
3554 return dict(cls.STATUSES).get(value)
3555
3556 @property
3557 def status_lbl(self):
3558 return ChangesetStatus.get_status_lbl(self.status)
3559
3560 def get_api_data(self):
3561 status = self
3562 data = {
3563 'status_id': status.changeset_status_id,
3564 'status': status.status,
3565 }
3566 return data
3567
3568 def __json__(self):
3569 data = dict()
3570 data.update(self.get_api_data())
3571 return data
3572
3573
3574 class _SetState(object):
3575 """
3576 Context processor allowing changing state for sensitive operation such as
3577 pull request update or merge
3578 """
3579
3580 def __init__(self, pull_request, pr_state, back_state=None):
3581 self._pr = pull_request
3582 self._org_state = back_state or pull_request.pull_request_state
3583 self._pr_state = pr_state
3584
3585 def __enter__(self):
3586 log.debug('StateLock: entering set state context, setting state to: `%s`',
3587 self._pr_state)
3588 self._pr.pull_request_state = self._pr_state
3589 Session().add(self._pr)
3590 Session().commit()
3591
3592 def __exit__(self, exc_type, exc_val, exc_tb):
3593 log.debug('StateLock: exiting set state context, setting state to: `%s`',
3594 self._org_state)
3595 self._pr.pull_request_state = self._org_state
3596 Session().add(self._pr)
3597 Session().commit()
3598
3599
3600 class _PullRequestBase(BaseModel):
3601 """
3602 Common attributes of pull request and version entries.
3603 """
3604
3605 # .status values
3606 STATUS_NEW = u'new'
3607 STATUS_OPEN = u'open'
3608 STATUS_CLOSED = u'closed'
3609
3610 # available states
3611 STATE_CREATING = u'creating'
3612 STATE_UPDATING = u'updating'
3613 STATE_MERGING = u'merging'
3614 STATE_CREATED = u'created'
3615
3616 title = Column('title', Unicode(255), nullable=True)
3617 description = Column(
3618 'description', UnicodeText().with_variant(UnicodeText(10240), 'mysql'),
3619 nullable=True)
3620 description_renderer = Column('description_renderer', Unicode(64), nullable=True)
3621
3622 # new/open/closed status of pull request (not approve/reject/etc)
3623 status = Column('status', Unicode(255), nullable=False, default=STATUS_NEW)
3624 created_on = Column(
3625 'created_on', DateTime(timezone=False), nullable=False,
3626 default=datetime.datetime.now)
3627 updated_on = Column(
3628 'updated_on', DateTime(timezone=False), nullable=False,
3629 default=datetime.datetime.now)
3630
3631 pull_request_state = Column("pull_request_state", String(255), nullable=True)
3632
3633 @declared_attr
3634 def user_id(cls):
3635 return Column(
3636 "user_id", Integer(), ForeignKey('users.user_id'), nullable=False,
3637 unique=None)
3638
3639 # 500 revisions max
3640 _revisions = Column(
3641 'revisions', UnicodeText().with_variant(UnicodeText(20500), 'mysql'))
3642
3643 @declared_attr
3644 def source_repo_id(cls):
3645 # TODO: dan: rename column to source_repo_id
3646 return Column(
3647 'org_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3648 nullable=False)
3649
3650 _source_ref = Column('org_ref', Unicode(255), nullable=False)
3651
3652 @hybrid_property
3653 def source_ref(self):
3654 return self._source_ref
3655
3656 @source_ref.setter
3657 def source_ref(self, val):
3658 parts = (val or '').split(':')
3659 if len(parts) != 3:
3660 raise ValueError(
3661 'Invalid reference format given: {}, expected X:Y:Z'.format(val))
3662 self._source_ref = safe_unicode(val)
3663
3664 _target_ref = Column('other_ref', Unicode(255), nullable=False)
3665
3666 @hybrid_property
3667 def target_ref(self):
3668 return self._target_ref
3669
3670 @target_ref.setter
3671 def target_ref(self, val):
3672 parts = (val or '').split(':')
3673 if len(parts) != 3:
3674 raise ValueError(
3675 'Invalid reference format given: {}, expected X:Y:Z'.format(val))
3676 self._target_ref = safe_unicode(val)
3677
3678 @declared_attr
3679 def target_repo_id(cls):
3680 # TODO: dan: rename column to target_repo_id
3681 return Column(
3682 'other_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3683 nullable=False)
3684
3685 _shadow_merge_ref = Column('shadow_merge_ref', Unicode(255), nullable=True)
3686
3687 # TODO: dan: rename column to last_merge_source_rev
3688 _last_merge_source_rev = Column(
3689 'last_merge_org_rev', String(40), nullable=True)
3690 # TODO: dan: rename column to last_merge_target_rev
3691 _last_merge_target_rev = Column(
3692 'last_merge_other_rev', String(40), nullable=True)
3693 _last_merge_status = Column('merge_status', Integer(), nullable=True)
3694 merge_rev = Column('merge_rev', String(40), nullable=True)
3695
3696 reviewer_data = Column(
3697 'reviewer_data_json', MutationObj.as_mutable(
3698 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
3699
3700 @property
3701 def reviewer_data_json(self):
3702 return json.dumps(self.reviewer_data)
3703
3704 @hybrid_property
3705 def description_safe(self):
3706 from rhodecode.lib import helpers as h
3707 return h.escape(self.description)
3708
3709 @hybrid_property
3710 def revisions(self):
3711 return self._revisions.split(':') if self._revisions else []
3712
3713 @revisions.setter
3714 def revisions(self, val):
3715 self._revisions = ':'.join(val)
3716
3717 @hybrid_property
3718 def last_merge_status(self):
3719 return safe_int(self._last_merge_status)
3720
3721 @last_merge_status.setter
3722 def last_merge_status(self, val):
3723 self._last_merge_status = val
3724
3725 @declared_attr
3726 def author(cls):
3727 return relationship('User', lazy='joined')
3728
3729 @declared_attr
3730 def source_repo(cls):
3731 return relationship(
3732 'Repository',
3733 primaryjoin='%s.source_repo_id==Repository.repo_id' % cls.__name__)
3734
3735 @property
3736 def source_ref_parts(self):
3737 return self.unicode_to_reference(self.source_ref)
3738
3739 @declared_attr
3740 def target_repo(cls):
3741 return relationship(
3742 'Repository',
3743 primaryjoin='%s.target_repo_id==Repository.repo_id' % cls.__name__)
3744
3745 @property
3746 def target_ref_parts(self):
3747 return self.unicode_to_reference(self.target_ref)
3748
3749 @property
3750 def shadow_merge_ref(self):
3751 return self.unicode_to_reference(self._shadow_merge_ref)
3752
3753 @shadow_merge_ref.setter
3754 def shadow_merge_ref(self, ref):
3755 self._shadow_merge_ref = self.reference_to_unicode(ref)
3756
3757 @staticmethod
3758 def unicode_to_reference(raw):
3759 """
3760 Convert a unicode (or string) to a reference object.
3761 If unicode evaluates to False it returns None.
3762 """
3763 if raw:
3764 refs = raw.split(':')
3765 return Reference(*refs)
3766 else:
3767 return None
3768
3769 @staticmethod
3770 def reference_to_unicode(ref):
3771 """
3772 Convert a reference object to unicode.
3773 If reference is None it returns None.
3774 """
3775 if ref:
3776 return u':'.join(ref)
3777 else:
3778 return None
3779
3780 def get_api_data(self, with_merge_state=True):
3781 from rhodecode.model.pull_request import PullRequestModel
3782
3783 pull_request = self
3784 if with_merge_state:
3785 merge_status = PullRequestModel().merge_status(pull_request)
3786 merge_state = {
3787 'status': merge_status[0],
3788 'message': safe_unicode(merge_status[1]),
3789 }
3790 else:
3791 merge_state = {'status': 'not_available',
3792 'message': 'not_available'}
3793
3794 merge_data = {
3795 'clone_url': PullRequestModel().get_shadow_clone_url(pull_request),
3796 'reference': (
3797 pull_request.shadow_merge_ref._asdict()
3798 if pull_request.shadow_merge_ref else None),
3799 }
3800
3801 data = {
3802 'pull_request_id': pull_request.pull_request_id,
3803 'url': PullRequestModel().get_url(pull_request),
3804 'title': pull_request.title,
3805 'description': pull_request.description,
3806 'status': pull_request.status,
3807 'state': pull_request.pull_request_state,
3808 'created_on': pull_request.created_on,
3809 'updated_on': pull_request.updated_on,
3810 'commit_ids': pull_request.revisions,
3811 'review_status': pull_request.calculated_review_status(),
3812 'mergeable': merge_state,
3813 'source': {
3814 'clone_url': pull_request.source_repo.clone_url(),
3815 'repository': pull_request.source_repo.repo_name,
3816 'reference': {
3817 'name': pull_request.source_ref_parts.name,
3818 'type': pull_request.source_ref_parts.type,
3819 'commit_id': pull_request.source_ref_parts.commit_id,
3820 },
3821 },
3822 'target': {
3823 'clone_url': pull_request.target_repo.clone_url(),
3824 'repository': pull_request.target_repo.repo_name,
3825 'reference': {
3826 'name': pull_request.target_ref_parts.name,
3827 'type': pull_request.target_ref_parts.type,
3828 'commit_id': pull_request.target_ref_parts.commit_id,
3829 },
3830 },
3831 'merge': merge_data,
3832 'author': pull_request.author.get_api_data(include_secrets=False,
3833 details='basic'),
3834 'reviewers': [
3835 {
3836 'user': reviewer.get_api_data(include_secrets=False,
3837 details='basic'),
3838 'reasons': reasons,
3839 'review_status': st[0][1].status if st else 'not_reviewed',
3840 }
3841 for obj, reviewer, reasons, mandatory, st in
3842 pull_request.reviewers_statuses()
3843 ]
3844 }
3845
3846 return data
3847
3848 def set_state(self, pull_request_state, final_state=None):
3849 """
3850 # goes from initial state to updating to initial state.
3851 # initial state can be changed by specifying back_state=
3852 with pull_request_obj.set_state(PullRequest.STATE_UPDATING):
3853 pull_request.merge()
3854
3855 :param pull_request_state:
3856 :param final_state:
3857
3858 """
3859
3860 return _SetState(self, pull_request_state, back_state=final_state)
3861
3862
3863 class PullRequest(Base, _PullRequestBase):
3864 __tablename__ = 'pull_requests'
3865 __table_args__ = (
3866 base_table_args,
3867 )
3868
3869 pull_request_id = Column(
3870 'pull_request_id', Integer(), nullable=False, primary_key=True)
3871
3872 def __repr__(self):
3873 if self.pull_request_id:
3874 return '<DB:PullRequest #%s>' % self.pull_request_id
3875 else:
3876 return '<DB:PullRequest at %#x>' % id(self)
3877
3878 reviewers = relationship('PullRequestReviewers',
3879 cascade="all, delete, delete-orphan")
3880 statuses = relationship('ChangesetStatus',
3881 cascade="all, delete, delete-orphan")
3882 comments = relationship('ChangesetComment',
3883 cascade="all, delete, delete-orphan")
3884 versions = relationship('PullRequestVersion',
3885 cascade="all, delete, delete-orphan",
3886 lazy='dynamic')
3887
3888 @classmethod
3889 def get_pr_display_object(cls, pull_request_obj, org_pull_request_obj,
3890 internal_methods=None):
3891
3892 class PullRequestDisplay(object):
3893 """
3894 Special object wrapper for showing PullRequest data via Versions
3895 It mimics PR object as close as possible. This is read only object
3896 just for display
3897 """
3898
3899 def __init__(self, attrs, internal=None):
3900 self.attrs = attrs
3901 # internal have priority over the given ones via attrs
3902 self.internal = internal or ['versions']
3903
3904 def __getattr__(self, item):
3905 if item in self.internal:
3906 return getattr(self, item)
3907 try:
3908 return self.attrs[item]
3909 except KeyError:
3910 raise AttributeError(
3911 '%s object has no attribute %s' % (self, item))
3912
3913 def __repr__(self):
3914 return '<DB:PullRequestDisplay #%s>' % self.attrs.get('pull_request_id')
3915
3916 def versions(self):
3917 return pull_request_obj.versions.order_by(
3918 PullRequestVersion.pull_request_version_id).all()
3919
3920 def is_closed(self):
3921 return pull_request_obj.is_closed()
3922
3923 @property
3924 def pull_request_version_id(self):
3925 return getattr(pull_request_obj, 'pull_request_version_id', None)
3926
3927 attrs = StrictAttributeDict(pull_request_obj.get_api_data())
3928
3929 attrs.author = StrictAttributeDict(
3930 pull_request_obj.author.get_api_data())
3931 if pull_request_obj.target_repo:
3932 attrs.target_repo = StrictAttributeDict(
3933 pull_request_obj.target_repo.get_api_data())
3934 attrs.target_repo.clone_url = pull_request_obj.target_repo.clone_url
3935
3936 if pull_request_obj.source_repo:
3937 attrs.source_repo = StrictAttributeDict(
3938 pull_request_obj.source_repo.get_api_data())
3939 attrs.source_repo.clone_url = pull_request_obj.source_repo.clone_url
3940
3941 attrs.source_ref_parts = pull_request_obj.source_ref_parts
3942 attrs.target_ref_parts = pull_request_obj.target_ref_parts
3943 attrs.revisions = pull_request_obj.revisions
3944
3945 attrs.shadow_merge_ref = org_pull_request_obj.shadow_merge_ref
3946 attrs.reviewer_data = org_pull_request_obj.reviewer_data
3947 attrs.reviewer_data_json = org_pull_request_obj.reviewer_data_json
3948
3949 return PullRequestDisplay(attrs, internal=internal_methods)
3950
3951 def is_closed(self):
3952 return self.status == self.STATUS_CLOSED
3953
3954 def __json__(self):
3955 return {
3956 'revisions': self.revisions,
3957 }
3958
3959 def calculated_review_status(self):
3960 from rhodecode.model.changeset_status import ChangesetStatusModel
3961 return ChangesetStatusModel().calculated_review_status(self)
3962
3963 def reviewers_statuses(self):
3964 from rhodecode.model.changeset_status import ChangesetStatusModel
3965 return ChangesetStatusModel().reviewers_statuses(self)
3966
3967 @property
3968 def workspace_id(self):
3969 from rhodecode.model.pull_request import PullRequestModel
3970 return PullRequestModel()._workspace_id(self)
3971
3972 def get_shadow_repo(self):
3973 workspace_id = self.workspace_id
3974 vcs_obj = self.target_repo.scm_instance()
3975 shadow_repository_path = vcs_obj._get_shadow_repository_path(
3976 self.target_repo.repo_id, workspace_id)
3977 if os.path.isdir(shadow_repository_path):
3978 return vcs_obj._get_shadow_instance(shadow_repository_path)
3979
3980
3981 class PullRequestVersion(Base, _PullRequestBase):
3982 __tablename__ = 'pull_request_versions'
3983 __table_args__ = (
3984 base_table_args,
3985 )
3986
3987 pull_request_version_id = Column(
3988 'pull_request_version_id', Integer(), nullable=False, primary_key=True)
3989 pull_request_id = Column(
3990 'pull_request_id', Integer(),
3991 ForeignKey('pull_requests.pull_request_id'), nullable=False)
3992 pull_request = relationship('PullRequest')
3993
3994 def __repr__(self):
3995 if self.pull_request_version_id:
3996 return '<DB:PullRequestVersion #%s>' % self.pull_request_version_id
3997 else:
3998 return '<DB:PullRequestVersion at %#x>' % id(self)
3999
4000 @property
4001 def reviewers(self):
4002 return self.pull_request.reviewers
4003
4004 @property
4005 def versions(self):
4006 return self.pull_request.versions
4007
4008 def is_closed(self):
4009 # calculate from original
4010 return self.pull_request.status == self.STATUS_CLOSED
4011
4012 def calculated_review_status(self):
4013 return self.pull_request.calculated_review_status()
4014
4015 def reviewers_statuses(self):
4016 return self.pull_request.reviewers_statuses()
4017
4018
4019 class PullRequestReviewers(Base, BaseModel):
4020 __tablename__ = 'pull_request_reviewers'
4021 __table_args__ = (
4022 base_table_args,
4023 )
4024
4025 @hybrid_property
4026 def reasons(self):
4027 if not self._reasons:
4028 return []
4029 return self._reasons
4030
4031 @reasons.setter
4032 def reasons(self, val):
4033 val = val or []
4034 if any(not isinstance(x, basestring) for x in val):
4035 raise Exception('invalid reasons type, must be list of strings')
4036 self._reasons = val
4037
4038 pull_requests_reviewers_id = Column(
4039 'pull_requests_reviewers_id', Integer(), nullable=False,
4040 primary_key=True)
4041 pull_request_id = Column(
4042 "pull_request_id", Integer(),
4043 ForeignKey('pull_requests.pull_request_id'), nullable=False)
4044 user_id = Column(
4045 "user_id", Integer(), ForeignKey('users.user_id'), nullable=True)
4046 _reasons = Column(
4047 'reason', MutationList.as_mutable(
4048 JsonType('list', dialect_map=dict(mysql=UnicodeText(16384)))))
4049
4050 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
4051 user = relationship('User')
4052 pull_request = relationship('PullRequest')
4053
4054 rule_data = Column(
4055 'rule_data_json',
4056 JsonType(dialect_map=dict(mysql=UnicodeText(16384))))
4057
4058 def rule_user_group_data(self):
4059 """
4060 Returns the voting user group rule data for this reviewer
4061 """
4062
4063 if self.rule_data and 'vote_rule' in self.rule_data:
4064 user_group_data = {}
4065 if 'rule_user_group_entry_id' in self.rule_data:
4066 # means a group with voting rules !
4067 user_group_data['id'] = self.rule_data['rule_user_group_entry_id']
4068 user_group_data['name'] = self.rule_data['rule_name']
4069 user_group_data['vote_rule'] = self.rule_data['vote_rule']
4070
4071 return user_group_data
4072
4073 def __unicode__(self):
4074 return u"<%s('id:%s')>" % (self.__class__.__name__,
4075 self.pull_requests_reviewers_id)
4076
4077
4078 class Notification(Base, BaseModel):
4079 __tablename__ = 'notifications'
4080 __table_args__ = (
4081 Index('notification_type_idx', 'type'),
4082 base_table_args,
4083 )
4084
4085 TYPE_CHANGESET_COMMENT = u'cs_comment'
4086 TYPE_MESSAGE = u'message'
4087 TYPE_MENTION = u'mention'
4088 TYPE_REGISTRATION = u'registration'
4089 TYPE_PULL_REQUEST = u'pull_request'
4090 TYPE_PULL_REQUEST_COMMENT = u'pull_request_comment'
4091
4092 notification_id = Column('notification_id', Integer(), nullable=False, primary_key=True)
4093 subject = Column('subject', Unicode(512), nullable=True)
4094 body = Column('body', UnicodeText().with_variant(UnicodeText(50000), 'mysql'), nullable=True)
4095 created_by = Column("created_by", Integer(), ForeignKey('users.user_id'), nullable=True)
4096 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4097 type_ = Column('type', Unicode(255))
4098
4099 created_by_user = relationship('User')
4100 notifications_to_users = relationship('UserNotification', lazy='joined',
4101 cascade="all, delete, delete-orphan")
4102
4103 @property
4104 def recipients(self):
4105 return [x.user for x in UserNotification.query()\
4106 .filter(UserNotification.notification == self)\
4107 .order_by(UserNotification.user_id.asc()).all()]
4108
4109 @classmethod
4110 def create(cls, created_by, subject, body, recipients, type_=None):
4111 if type_ is None:
4112 type_ = Notification.TYPE_MESSAGE
4113
4114 notification = cls()
4115 notification.created_by_user = created_by
4116 notification.subject = subject
4117 notification.body = body
4118 notification.type_ = type_
4119 notification.created_on = datetime.datetime.now()
4120
4121 # For each recipient link the created notification to his account
4122 for u in recipients:
4123 assoc = UserNotification()
4124 assoc.user_id = u.user_id
4125 assoc.notification = notification
4126
4127 # if created_by is inside recipients mark his notification
4128 # as read
4129 if u.user_id == created_by.user_id:
4130 assoc.read = True
4131 Session().add(assoc)
4132
4133 Session().add(notification)
4134
4135 return notification
4136
4137
4138 class UserNotification(Base, BaseModel):
4139 __tablename__ = 'user_to_notification'
4140 __table_args__ = (
4141 UniqueConstraint('user_id', 'notification_id'),
4142 base_table_args
4143 )
4144
4145 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), primary_key=True)
4146 notification_id = Column("notification_id", Integer(), ForeignKey('notifications.notification_id'), primary_key=True)
4147 read = Column('read', Boolean, default=False)
4148 sent_on = Column('sent_on', DateTime(timezone=False), nullable=True, unique=None)
4149
4150 user = relationship('User', lazy="joined")
4151 notification = relationship('Notification', lazy="joined",
4152 order_by=lambda: Notification.created_on.desc(),)
4153
4154 def mark_as_read(self):
4155 self.read = True
4156 Session().add(self)
4157
4158
4159 class Gist(Base, BaseModel):
4160 __tablename__ = 'gists'
4161 __table_args__ = (
4162 Index('g_gist_access_id_idx', 'gist_access_id'),
4163 Index('g_created_on_idx', 'created_on'),
4164 base_table_args
4165 )
4166
4167 GIST_PUBLIC = u'public'
4168 GIST_PRIVATE = u'private'
4169 DEFAULT_FILENAME = u'gistfile1.txt'
4170
4171 ACL_LEVEL_PUBLIC = u'acl_public'
4172 ACL_LEVEL_PRIVATE = u'acl_private'
4173
4174 gist_id = Column('gist_id', Integer(), primary_key=True)
4175 gist_access_id = Column('gist_access_id', Unicode(250))
4176 gist_description = Column('gist_description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
4177 gist_owner = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=True)
4178 gist_expires = Column('gist_expires', Float(53), nullable=False)
4179 gist_type = Column('gist_type', Unicode(128), nullable=False)
4180 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4181 modified_at = Column('modified_at', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4182 acl_level = Column('acl_level', Unicode(128), nullable=True)
4183
4184 owner = relationship('User')
4185
4186 def __repr__(self):
4187 return '<Gist:[%s]%s>' % (self.gist_type, self.gist_access_id)
4188
4189 @hybrid_property
4190 def description_safe(self):
4191 from rhodecode.lib import helpers as h
4192 return h.escape(self.gist_description)
4193
4194 @classmethod
4195 def get_or_404(cls, id_):
4196 from pyramid.httpexceptions import HTTPNotFound
4197
4198 res = cls.query().filter(cls.gist_access_id == id_).scalar()
4199 if not res:
4200 raise HTTPNotFound()
4201 return res
4202
4203 @classmethod
4204 def get_by_access_id(cls, gist_access_id):
4205 return cls.query().filter(cls.gist_access_id == gist_access_id).scalar()
4206
4207 def gist_url(self):
4208 from rhodecode.model.gist import GistModel
4209 return GistModel().get_url(self)
4210
4211 @classmethod
4212 def base_path(cls):
4213 """
4214 Returns base path when all gists are stored
4215
4216 :param cls:
4217 """
4218 from rhodecode.model.gist import GIST_STORE_LOC
4219 q = Session().query(RhodeCodeUi)\
4220 .filter(RhodeCodeUi.ui_key == URL_SEP)
4221 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
4222 return os.path.join(q.one().ui_value, GIST_STORE_LOC)
4223
4224 def get_api_data(self):
4225 """
4226 Common function for generating gist related data for API
4227 """
4228 gist = self
4229 data = {
4230 'gist_id': gist.gist_id,
4231 'type': gist.gist_type,
4232 'access_id': gist.gist_access_id,
4233 'description': gist.gist_description,
4234 'url': gist.gist_url(),
4235 'expires': gist.gist_expires,
4236 'created_on': gist.created_on,
4237 'modified_at': gist.modified_at,
4238 'content': None,
4239 'acl_level': gist.acl_level,
4240 }
4241 return data
4242
4243 def __json__(self):
4244 data = dict(
4245 )
4246 data.update(self.get_api_data())
4247 return data
4248 # SCM functions
4249
4250 def scm_instance(self, **kwargs):
4251 full_repo_path = os.path.join(self.base_path(), self.gist_access_id)
4252 return get_vcs_instance(
4253 repo_path=safe_str(full_repo_path), create=False)
4254
4255
4256 class ExternalIdentity(Base, BaseModel):
4257 __tablename__ = 'external_identities'
4258 __table_args__ = (
4259 Index('local_user_id_idx', 'local_user_id'),
4260 Index('external_id_idx', 'external_id'),
4261 base_table_args
4262 )
4263
4264 external_id = Column('external_id', Unicode(255), default=u'', primary_key=True)
4265 external_username = Column('external_username', Unicode(1024), default=u'')
4266 local_user_id = Column('local_user_id', Integer(), ForeignKey('users.user_id'), primary_key=True)
4267 provider_name = Column('provider_name', Unicode(255), default=u'', primary_key=True)
4268 access_token = Column('access_token', String(1024), default=u'')
4269 alt_token = Column('alt_token', String(1024), default=u'')
4270 token_secret = Column('token_secret', String(1024), default=u'')
4271
4272 @classmethod
4273 def by_external_id_and_provider(cls, external_id, provider_name, local_user_id=None):
4274 """
4275 Returns ExternalIdentity instance based on search params
4276
4277 :param external_id:
4278 :param provider_name:
4279 :return: ExternalIdentity
4280 """
4281 query = cls.query()
4282 query = query.filter(cls.external_id == external_id)
4283 query = query.filter(cls.provider_name == provider_name)
4284 if local_user_id:
4285 query = query.filter(cls.local_user_id == local_user_id)
4286 return query.first()
4287
4288 @classmethod
4289 def user_by_external_id_and_provider(cls, external_id, provider_name):
4290 """
4291 Returns User instance based on search params
4292
4293 :param external_id:
4294 :param provider_name:
4295 :return: User
4296 """
4297 query = User.query()
4298 query = query.filter(cls.external_id == external_id)
4299 query = query.filter(cls.provider_name == provider_name)
4300 query = query.filter(User.user_id == cls.local_user_id)
4301 return query.first()
4302
4303 @classmethod
4304 def by_local_user_id(cls, local_user_id):
4305 """
4306 Returns all tokens for user
4307
4308 :param local_user_id:
4309 :return: ExternalIdentity
4310 """
4311 query = cls.query()
4312 query = query.filter(cls.local_user_id == local_user_id)
4313 return query
4314
4315 @classmethod
4316 def load_provider_plugin(cls, plugin_id):
4317 from rhodecode.authentication.base import loadplugin
4318 _plugin_id = 'egg:rhodecode-enterprise-ee#{}'.format(plugin_id)
4319 auth_plugin = loadplugin(_plugin_id)
4320 return auth_plugin
4321
4322
4323 class Integration(Base, BaseModel):
4324 __tablename__ = 'integrations'
4325 __table_args__ = (
4326 base_table_args
4327 )
4328
4329 integration_id = Column('integration_id', Integer(), primary_key=True)
4330 integration_type = Column('integration_type', String(255))
4331 enabled = Column('enabled', Boolean(), nullable=False)
4332 name = Column('name', String(255), nullable=False)
4333 child_repos_only = Column('child_repos_only', Boolean(), nullable=False,
4334 default=False)
4335
4336 settings = Column(
4337 'settings_json', MutationObj.as_mutable(
4338 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
4339 repo_id = Column(
4340 'repo_id', Integer(), ForeignKey('repositories.repo_id'),
4341 nullable=True, unique=None, default=None)
4342 repo = relationship('Repository', lazy='joined')
4343
4344 repo_group_id = Column(
4345 'repo_group_id', Integer(), ForeignKey('groups.group_id'),
4346 nullable=True, unique=None, default=None)
4347 repo_group = relationship('RepoGroup', lazy='joined')
4348
4349 @property
4350 def scope(self):
4351 if self.repo:
4352 return repr(self.repo)
4353 if self.repo_group:
4354 if self.child_repos_only:
4355 return repr(self.repo_group) + ' (child repos only)'
4356 else:
4357 return repr(self.repo_group) + ' (recursive)'
4358 if self.child_repos_only:
4359 return 'root_repos'
4360 return 'global'
4361
4362 def __repr__(self):
4363 return '<Integration(%r, %r)>' % (self.integration_type, self.scope)
4364
4365
4366 class RepoReviewRuleUser(Base, BaseModel):
4367 __tablename__ = 'repo_review_rules_users'
4368 __table_args__ = (
4369 base_table_args
4370 )
4371
4372 repo_review_rule_user_id = Column('repo_review_rule_user_id', Integer(), primary_key=True)
4373 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
4374 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False)
4375 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
4376 user = relationship('User')
4377
4378 def rule_data(self):
4379 return {
4380 'mandatory': self.mandatory
4381 }
4382
4383
4384 class RepoReviewRuleUserGroup(Base, BaseModel):
4385 __tablename__ = 'repo_review_rules_users_groups'
4386 __table_args__ = (
4387 base_table_args
4388 )
4389
4390 VOTE_RULE_ALL = -1
4391
4392 repo_review_rule_users_group_id = Column('repo_review_rule_users_group_id', Integer(), primary_key=True)
4393 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
4394 users_group_id = Column("users_group_id", Integer(),ForeignKey('users_groups.users_group_id'), nullable=False)
4395 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
4396 vote_rule = Column("vote_rule", Integer(), nullable=True, default=VOTE_RULE_ALL)
4397 users_group = relationship('UserGroup')
4398
4399 def rule_data(self):
4400 return {
4401 'mandatory': self.mandatory,
4402 'vote_rule': self.vote_rule
4403 }
4404
4405 @property
4406 def vote_rule_label(self):
4407 if not self.vote_rule or self.vote_rule == self.VOTE_RULE_ALL:
4408 return 'all must vote'
4409 else:
4410 return 'min. vote {}'.format(self.vote_rule)
4411
4412
4413 class RepoReviewRule(Base, BaseModel):
4414 __tablename__ = 'repo_review_rules'
4415 __table_args__ = (
4416 base_table_args
4417 )
4418
4419 repo_review_rule_id = Column(
4420 'repo_review_rule_id', Integer(), primary_key=True)
4421 repo_id = Column(
4422 "repo_id", Integer(), ForeignKey('repositories.repo_id'))
4423 repo = relationship('Repository', backref='review_rules')
4424
4425 review_rule_name = Column('review_rule_name', String(255))
4426 _branch_pattern = Column("branch_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4427 _target_branch_pattern = Column("target_branch_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4428 _file_pattern = Column("file_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4429
4430 use_authors_for_review = Column("use_authors_for_review", Boolean(), nullable=False, default=False)
4431 forbid_author_to_review = Column("forbid_author_to_review", Boolean(), nullable=False, default=False)
4432 forbid_commit_author_to_review = Column("forbid_commit_author_to_review", Boolean(), nullable=False, default=False)
4433 forbid_adding_reviewers = Column("forbid_adding_reviewers", Boolean(), nullable=False, default=False)
4434
4435 rule_users = relationship('RepoReviewRuleUser')
4436 rule_user_groups = relationship('RepoReviewRuleUserGroup')
4437
4438 def _validate_pattern(self, value):
4439 re.compile('^' + glob2re(value) + '$')
4440
4441 @hybrid_property
4442 def source_branch_pattern(self):
4443 return self._branch_pattern or '*'
4444
4445 @source_branch_pattern.setter
4446 def source_branch_pattern(self, value):
4447 self._validate_pattern(value)
4448 self._branch_pattern = value or '*'
4449
4450 @hybrid_property
4451 def target_branch_pattern(self):
4452 return self._target_branch_pattern or '*'
4453
4454 @target_branch_pattern.setter
4455 def target_branch_pattern(self, value):
4456 self._validate_pattern(value)
4457 self._target_branch_pattern = value or '*'
4458
4459 @hybrid_property
4460 def file_pattern(self):
4461 return self._file_pattern or '*'
4462
4463 @file_pattern.setter
4464 def file_pattern(self, value):
4465 self._validate_pattern(value)
4466 self._file_pattern = value or '*'
4467
4468 def matches(self, source_branch, target_branch, files_changed):
4469 """
4470 Check if this review rule matches a branch/files in a pull request
4471
4472 :param source_branch: source branch name for the commit
4473 :param target_branch: target branch name for the commit
4474 :param files_changed: list of file paths changed in the pull request
4475 """
4476
4477 source_branch = source_branch or ''
4478 target_branch = target_branch or ''
4479 files_changed = files_changed or []
4480
4481 branch_matches = True
4482 if source_branch or target_branch:
4483 if self.source_branch_pattern == '*':
4484 source_branch_match = True
4485 else:
4486 if self.source_branch_pattern.startswith('re:'):
4487 source_pattern = self.source_branch_pattern[3:]
4488 else:
4489 source_pattern = '^' + glob2re(self.source_branch_pattern) + '$'
4490 source_branch_regex = re.compile(source_pattern)
4491 source_branch_match = bool(source_branch_regex.search(source_branch))
4492 if self.target_branch_pattern == '*':
4493 target_branch_match = True
4494 else:
4495 if self.target_branch_pattern.startswith('re:'):
4496 target_pattern = self.target_branch_pattern[3:]
4497 else:
4498 target_pattern = '^' + glob2re(self.target_branch_pattern) + '$'
4499 target_branch_regex = re.compile(target_pattern)
4500 target_branch_match = bool(target_branch_regex.search(target_branch))
4501
4502 branch_matches = source_branch_match and target_branch_match
4503
4504 files_matches = True
4505 if self.file_pattern != '*':
4506 files_matches = False
4507 if self.file_pattern.startswith('re:'):
4508 file_pattern = self.file_pattern[3:]
4509 else:
4510 file_pattern = glob2re(self.file_pattern)
4511 file_regex = re.compile(file_pattern)
4512 for filename in files_changed:
4513 if file_regex.search(filename):
4514 files_matches = True
4515 break
4516
4517 return branch_matches and files_matches
4518
4519 @property
4520 def review_users(self):
4521 """ Returns the users which this rule applies to """
4522
4523 users = collections.OrderedDict()
4524
4525 for rule_user in self.rule_users:
4526 if rule_user.user.active:
4527 if rule_user.user not in users:
4528 users[rule_user.user.username] = {
4529 'user': rule_user.user,
4530 'source': 'user',
4531 'source_data': {},
4532 'data': rule_user.rule_data()
4533 }
4534
4535 for rule_user_group in self.rule_user_groups:
4536 source_data = {
4537 'user_group_id': rule_user_group.users_group.users_group_id,
4538 'name': rule_user_group.users_group.users_group_name,
4539 'members': len(rule_user_group.users_group.members)
4540 }
4541 for member in rule_user_group.users_group.members:
4542 if member.user.active:
4543 key = member.user.username
4544 if key in users:
4545 # skip this member as we have him already
4546 # this prevents from override the "first" matched
4547 # users with duplicates in multiple groups
4548 continue
4549
4550 users[key] = {
4551 'user': member.user,
4552 'source': 'user_group',
4553 'source_data': source_data,
4554 'data': rule_user_group.rule_data()
4555 }
4556
4557 return users
4558
4559 def user_group_vote_rule(self, user_id):
4560
4561 rules = []
4562 if not self.rule_user_groups:
4563 return rules
4564
4565 for user_group in self.rule_user_groups:
4566 user_group_members = [x.user_id for x in user_group.users_group.members]
4567 if user_id in user_group_members:
4568 rules.append(user_group)
4569 return rules
4570
4571 def __repr__(self):
4572 return '<RepoReviewerRule(id=%r, repo=%r)>' % (
4573 self.repo_review_rule_id, self.repo)
4574
4575
4576 class ScheduleEntry(Base, BaseModel):
4577 __tablename__ = 'schedule_entries'
4578 __table_args__ = (
4579 UniqueConstraint('schedule_name', name='s_schedule_name_idx'),
4580 UniqueConstraint('task_uid', name='s_task_uid_idx'),
4581 base_table_args,
4582 )
4583
4584 schedule_types = ['crontab', 'timedelta', 'integer']
4585 schedule_entry_id = Column('schedule_entry_id', Integer(), primary_key=True)
4586
4587 schedule_name = Column("schedule_name", String(255), nullable=False, unique=None, default=None)
4588 schedule_description = Column("schedule_description", String(10000), nullable=True, unique=None, default=None)
4589 schedule_enabled = Column("schedule_enabled", Boolean(), nullable=False, unique=None, default=True)
4590
4591 _schedule_type = Column("schedule_type", String(255), nullable=False, unique=None, default=None)
4592 schedule_definition = Column('schedule_definition_json', MutationObj.as_mutable(JsonType(default=lambda: "", dialect_map=dict(mysql=LONGTEXT()))))
4593
4594 schedule_last_run = Column('schedule_last_run', DateTime(timezone=False), nullable=True, unique=None, default=None)
4595 schedule_total_run_count = Column('schedule_total_run_count', Integer(), nullable=True, unique=None, default=0)
4596
4597 # task
4598 task_uid = Column("task_uid", String(255), nullable=False, unique=None, default=None)
4599 task_dot_notation = Column("task_dot_notation", String(4096), nullable=False, unique=None, default=None)
4600 task_args = Column('task_args_json', MutationObj.as_mutable(JsonType(default=list, dialect_map=dict(mysql=LONGTEXT()))))
4601 task_kwargs = Column('task_kwargs_json', MutationObj.as_mutable(JsonType(default=dict, dialect_map=dict(mysql=LONGTEXT()))))
4602
4603 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4604 updated_on = Column('updated_on', DateTime(timezone=False), nullable=True, unique=None, default=None)
4605
4606 @hybrid_property
4607 def schedule_type(self):
4608 return self._schedule_type
4609
4610 @schedule_type.setter
4611 def schedule_type(self, val):
4612 if val not in self.schedule_types:
4613 raise ValueError('Value must be on of `{}` and got `{}`'.format(
4614 val, self.schedule_type))
4615
4616 self._schedule_type = val
4617
4618 @classmethod
4619 def get_uid(cls, obj):
4620 args = obj.task_args
4621 kwargs = obj.task_kwargs
4622 if isinstance(args, JsonRaw):
4623 try:
4624 args = json.loads(args)
4625 except ValueError:
4626 args = tuple()
4627
4628 if isinstance(kwargs, JsonRaw):
4629 try:
4630 kwargs = json.loads(kwargs)
4631 except ValueError:
4632 kwargs = dict()
4633
4634 dot_notation = obj.task_dot_notation
4635 val = '.'.join(map(safe_str, [
4636 sorted(dot_notation), args, sorted(kwargs.items())]))
4637 return hashlib.sha1(val).hexdigest()
4638
4639 @classmethod
4640 def get_by_schedule_name(cls, schedule_name):
4641 return cls.query().filter(cls.schedule_name == schedule_name).scalar()
4642
4643 @classmethod
4644 def get_by_schedule_id(cls, schedule_id):
4645 return cls.query().filter(cls.schedule_entry_id == schedule_id).scalar()
4646
4647 @property
4648 def task(self):
4649 return self.task_dot_notation
4650
4651 @property
4652 def schedule(self):
4653 from rhodecode.lib.celerylib.utils import raw_2_schedule
4654 schedule = raw_2_schedule(self.schedule_definition, self.schedule_type)
4655 return schedule
4656
4657 @property
4658 def args(self):
4659 try:
4660 return list(self.task_args or [])
4661 except ValueError:
4662 return list()
4663
4664 @property
4665 def kwargs(self):
4666 try:
4667 return dict(self.task_kwargs or {})
4668 except ValueError:
4669 return dict()
4670
4671 def _as_raw(self, val):
4672 if hasattr(val, 'de_coerce'):
4673 val = val.de_coerce()
4674 if val:
4675 val = json.dumps(val)
4676
4677 return val
4678
4679 @property
4680 def schedule_definition_raw(self):
4681 return self._as_raw(self.schedule_definition)
4682
4683 @property
4684 def args_raw(self):
4685 return self._as_raw(self.task_args)
4686
4687 @property
4688 def kwargs_raw(self):
4689 return self._as_raw(self.task_kwargs)
4690
4691 def __repr__(self):
4692 return '<DB:ScheduleEntry({}:{})>'.format(
4693 self.schedule_entry_id, self.schedule_name)
4694
4695
4696 @event.listens_for(ScheduleEntry, 'before_update')
4697 def update_task_uid(mapper, connection, target):
4698 target.task_uid = ScheduleEntry.get_uid(target)
4699
4700
4701 @event.listens_for(ScheduleEntry, 'before_insert')
4702 def set_task_uid(mapper, connection, target):
4703 target.task_uid = ScheduleEntry.get_uid(target)
4704
4705
4706 class _BaseBranchPerms(BaseModel):
4707 @classmethod
4708 def compute_hash(cls, value):
4709 return sha1_safe(value)
4710
4711 @hybrid_property
4712 def branch_pattern(self):
4713 return self._branch_pattern or '*'
4714
4715 @hybrid_property
4716 def branch_hash(self):
4717 return self._branch_hash
4718
4719 def _validate_glob(self, value):
4720 re.compile('^' + glob2re(value) + '$')
4721
4722 @branch_pattern.setter
4723 def branch_pattern(self, value):
4724 self._validate_glob(value)
4725 self._branch_pattern = value or '*'
4726 # set the Hash when setting the branch pattern
4727 self._branch_hash = self.compute_hash(self._branch_pattern)
4728
4729 def matches(self, branch):
4730 """
4731 Check if this the branch matches entry
4732
4733 :param branch: branch name for the commit
4734 """
4735
4736 branch = branch or ''
4737
4738 branch_matches = True
4739 if branch:
4740 branch_regex = re.compile('^' + glob2re(self.branch_pattern) + '$')
4741 branch_matches = bool(branch_regex.search(branch))
4742
4743 return branch_matches
4744
4745
4746 class UserToRepoBranchPermission(Base, _BaseBranchPerms):
4747 __tablename__ = 'user_to_repo_branch_permissions'
4748 __table_args__ = (
4749 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4750 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
4751 )
4752
4753 branch_rule_id = Column('branch_rule_id', Integer(), primary_key=True)
4754
4755 repository_id = Column('repository_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
4756 repo = relationship('Repository', backref='user_branch_perms')
4757
4758 permission_id = Column('permission_id', Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
4759 permission = relationship('Permission')
4760
4761 rule_to_perm_id = Column('rule_to_perm_id', Integer(), ForeignKey('repo_to_perm.repo_to_perm_id'), nullable=False, unique=None, default=None)
4762 user_repo_to_perm = relationship('UserRepoToPerm')
4763
4764 rule_order = Column('rule_order', Integer(), nullable=False)
4765 _branch_pattern = Column('branch_pattern', UnicodeText().with_variant(UnicodeText(2048), 'mysql'), default=u'*') # glob
4766 _branch_hash = Column('branch_hash', UnicodeText().with_variant(UnicodeText(2048), 'mysql'))
4767
4768 def __unicode__(self):
4769 return u'<UserBranchPermission(%s => %r)>' % (
4770 self.user_repo_to_perm, self.branch_pattern)
4771
4772
4773 class UserGroupToRepoBranchPermission(Base, _BaseBranchPerms):
4774 __tablename__ = 'user_group_to_repo_branch_permissions'
4775 __table_args__ = (
4776 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4777 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
4778 )
4779
4780 branch_rule_id = Column('branch_rule_id', Integer(), primary_key=True)
4781
4782 repository_id = Column('repository_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
4783 repo = relationship('Repository', backref='user_group_branch_perms')
4784
4785 permission_id = Column('permission_id', Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
4786 permission = relationship('Permission')
4787
4788 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)
4789 user_group_repo_to_perm = relationship('UserGroupRepoToPerm')
4790
4791 rule_order = Column('rule_order', Integer(), nullable=False)
4792 _branch_pattern = Column('branch_pattern', UnicodeText().with_variant(UnicodeText(2048), 'mysql'), default=u'*') # glob
4793 _branch_hash = Column('branch_hash', UnicodeText().with_variant(UnicodeText(2048), 'mysql'))
4794
4795 def __unicode__(self):
4796 return u'<UserBranchPermission(%s => %r)>' % (
4797 self.user_group_repo_to_perm, self.branch_pattern)
4798
4799
4800 class UserBookmark(Base, BaseModel):
4801 __tablename__ = 'user_bookmarks'
4802 __table_args__ = (
4803 UniqueConstraint('user_id', 'bookmark_repo_id'),
4804 UniqueConstraint('user_id', 'bookmark_repo_group_id'),
4805 UniqueConstraint('user_id', 'bookmark_position'),
4806 base_table_args
4807 )
4808
4809 user_bookmark_id = Column("user_bookmark_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
4810 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
4811 position = Column("bookmark_position", Integer(), nullable=False)
4812 title = Column("bookmark_title", String(255), nullable=True, unique=None, default=None)
4813 redirect_url = Column("bookmark_redirect_url", String(10240), nullable=True, unique=None, default=None)
4814 created_on = Column("created_on", DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4815
4816 bookmark_repo_id = Column("bookmark_repo_id", Integer(), ForeignKey("repositories.repo_id"), nullable=True, unique=None, default=None)
4817 bookmark_repo_group_id = Column("bookmark_repo_group_id", Integer(), ForeignKey("groups.group_id"), nullable=True, unique=None, default=None)
4818
4819 user = relationship("User")
4820
4821 repository = relationship("Repository")
4822 repository_group = relationship("RepoGroup")
4823
4824
4825 class DbMigrateVersion(Base, BaseModel):
4826 __tablename__ = 'db_migrate_version'
4827 __table_args__ = (
4828 base_table_args,
4829 )
4830
4831 repository_id = Column('repository_id', String(250), primary_key=True)
4832 repository_path = Column('repository_path', Text)
4833 version = Column('version', Integer)
4834
4835 @classmethod
4836 def set_version(cls, version):
4837 """
4838 Helper for forcing a different version, usually for debugging purposes via ishell.
4839 """
4840 ver = DbMigrateVersion.query().first()
4841 ver.version = version
4842 Session().commit()
4843
4844
4845 class DbSession(Base, BaseModel):
4846 __tablename__ = 'db_session'
4847 __table_args__ = (
4848 base_table_args,
4849 )
4850
4851 def __repr__(self):
4852 return '<DB:DbSession({})>'.format(self.id)
4853
4854 id = Column('id', Integer())
4855 namespace = Column('namespace', String(255), primary_key=True)
4856 accessed = Column('accessed', DateTime, nullable=False)
4857 created = Column('created', DateTime, nullable=False)
4858 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_1 as db
18
19 db.UserBookmark.__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
@@ -0,0 +1,222 b''
1 <%namespace name="dt" file="/data_table/_dt_elements.mako"/>
2
3 <%def name="form_item(count, position=None, title=None, redirect_url=None, repo=None, repo_group=None)">
4 <tr>
5 <td class="td-align-top" >
6 <div class="label">
7 <label for="position">${_('Position')}:</label>
8 </div>
9 <div class="input">
10 <input type="text" name="position" value="${position or count}" style="width: 40px"/>
11 </div>
12 </td>
13
14 <td>
15 <div class="label">
16 <label for="title">${_('Bookmark title (max 30 characters, optional)')}:</label>
17 </div>
18 <div class="input">
19 <input type="text" name="title" value="${title}" style="width: 300px" maxlength="30"/>
20
21 <div class="field pull-right">
22 <div>
23 <label class="btn-link btn-danger">${_('Clear')}:</label>
24 ${h.checkbox('remove', value=True)}
25 </div>
26 </div>
27 </div>
28
29 <div class="label">
30 <label for="redirect_url">${_('Redirect URL')}:</label>
31 </div>
32 <div class="input">
33 <input type="text" name="redirect_url" value="${redirect_url}" style="width: 600px"/>
34 </div>
35
36
37 <div class="select">
38 % if repo:
39 <div class="label">
40 <label for="redirect_url">${_('Repository template')}:</label>
41 </div>
42 ${dt.repo_name(name=repo.repo_name, rtype=repo.repo_type,rstate=None,private=None,archived=False,fork_of=False)}
43 ${h.hidden('bookmark_repo', repo.repo_id)}
44 % elif repo_group:
45 <div class="label">
46 <label for="redirect_url">${_('Repository group template')}:</label>
47 </div>
48 ${dt.repo_group_name(repo_group.group_name)}
49 ${h.hidden('bookmark_repo_group', repo_group.group_id)}
50 % else:
51 <div class="label">
52 <label for="redirect_url">${_('Template Repository or Repository group')}:</label>
53 </div>
54 ${h.hidden('bookmark_repo', class_='bookmark_repo')}
55 <span style="padding-right:15px">OR</span>
56 ${h.hidden('bookmark_repo_group', class_='bookmark_repo_group')}
57 % endif
58 </div>
59
60 <p class="help-block help-block-inline" >
61 % if repo:
62 ${_('Available as ${repo_url} e.g. Redirect url: ${repo_url}/changelog')}
63 % elif repo_group:
64 ${_('Available as ${repo_group_url} e.g. Redirect url: ${repo_group_url}')}
65 % else:
66 ${_('Available as full url variables in redirect url. i.e: ${repo_url}, ${repo_group_url}.')}
67 % endif
68 </p>
69 </td>
70
71 </tr>
72 </%def>
73
74 <div class="panel panel-default">
75 <div class="panel-heading">
76 <h3 class="panel-title">${_('Your Bookmarks')}</h3>
77 </div>
78
79 <div class="panel-body">
80 <p>
81 ${_('Store upto 10 bookmark links to favorite repositories, external issue tracker or CI server. ')}
82 <br/>
83 ${_('Bookmarks are accessible from your username dropdown or by keyboard shortcut `g 0-9`')}
84 </p>
85
86 ${h.secure_form(h.route_path('my_account_bookmarks_update'), request=request)}
87 <div class="form-vertical">
88 <table class="rctable">
89 ## generate always 10 entries
90 <input type="hidden" name="__start__" value="bookmarks:sequence"/>
91 % for cnt, item in enumerate((c.bookmark_items + [None for i in range(10)])[:10]):
92 <input type="hidden" name="__start__" value="bookmark:mapping"/>
93 % if item is None:
94 ## empty placehodlder
95 ${form_item(cnt)}
96 % else:
97 ## actual entry
98 ${form_item(cnt, position=item.position, title=item.title, redirect_url=item.redirect_url, repo=item.repository, repo_group=item.repository_group)}
99 % endif
100 <input type="hidden" name="__end__" value="bookmark:mapping"/>
101 % endfor
102 <input type="hidden" name="__end__" value="bookmarks:sequence"/>
103 </table>
104 <div class="buttons">
105 ${h.submit('save',_('Save'),class_="btn")}
106 </div>
107 </div>
108 ${h.end_form()}
109 </div>
110 </div>
111
112 <script>
113 $(document).ready(function(){
114
115
116 var repoFilter = function (data) {
117 var results = [];
118
119 if (!data.results[0]) {
120 return data
121 }
122
123 $.each(data.results[0].children, function () {
124 // replace name to ID for submision
125 this.id = this.repo_id;
126 results.push(this);
127 });
128
129 data.results[0].children = results;
130 return data;
131 };
132
133
134 $(".bookmark_repo").select2({
135 cachedDataSource: {},
136 minimumInputLength: 2,
137 placeholder: "${_('repository')}",
138 dropdownAutoWidth: true,
139 containerCssClass: "drop-menu",
140 dropdownCssClass: "drop-menu-dropdown",
141 formatResult: formatRepoResult,
142 query: $.debounce(250, function (query) {
143 self = this;
144 var cacheKey = query.term;
145 var cachedData = self.cachedDataSource[cacheKey];
146
147 if (cachedData) {
148 query.callback({results: cachedData.results});
149 } else {
150 $.ajax({
151 url: pyroutes.url('repo_list_data'),
152 data: {'query': query.term},
153 dataType: 'json',
154 type: 'GET',
155 success: function (data) {
156 data = repoFilter(data);
157 self.cachedDataSource[cacheKey] = data;
158 query.callback({results: data.results});
159 },
160 error: function (data, textStatus, errorThrown) {
161 alert("Error while fetching entries.\nError code {0} ({1}).".format(data.status, data.statusText));
162 }
163 })
164 }
165 }),
166 });
167
168 var repoGroupFilter = function (data) {
169 var results = [];
170
171 if (!data.results[0]) {
172 return data
173 }
174
175 $.each(data.results[0].children, function () {
176 // replace name to ID for submision
177 this.id = this.repo_group_id;
178 results.push(this);
179 });
180
181 data.results[0].children = results;
182 return data;
183 };
184
185 $(".bookmark_repo_group").select2({
186 cachedDataSource: {},
187 minimumInputLength: 2,
188 placeholder: "${_('repository group')}",
189 dropdownAutoWidth: true,
190 containerCssClass: "drop-menu",
191 dropdownCssClass: "drop-menu-dropdown",
192 formatResult: formatRepoGroupResult,
193 query: $.debounce(250, function (query) {
194 self = this;
195 var cacheKey = query.term;
196 var cachedData = self.cachedDataSource[cacheKey];
197
198 if (cachedData) {
199 query.callback({results: cachedData.results});
200 } else {
201 $.ajax({
202 url: pyroutes.url('repo_group_list_data'),
203 data: {'query': query.term},
204 dataType: 'json',
205 type: 'GET',
206 success: function (data) {
207 data = repoGroupFilter(data);
208 self.cachedDataSource[cacheKey] = data;
209 query.callback({results: data.results});
210 },
211 error: function (data, textStatus, errorThrown) {
212 alert("Error while fetching entries.\nError code {0} ({1}).".format(data.status, data.statusText));
213 }
214 })
215 }
216 })
217 });
218
219
220 });
221
222 </script>
@@ -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__ = 93 # defines current db version for migrations
48 __dbversion__ = 94 # defines current db version for migrations
49 49 __platform__ = platform.system()
50 50 __license__ = 'AGPLv3, and Commercial License'
51 51 __author__ = 'RhodeCode GmbH'
@@ -56,6 +56,10 b' def includeme(config):'
56 56 pattern='/_repos')
57 57
58 58 config.add_route(
59 name='repo_group_list_data',
60 pattern='/_repo_groups')
61
62 config.add_route(
59 63 name='goto_switcher_data',
60 64 pattern='/_goto_data')
61 65
@@ -172,7 +172,9 b' class HomeView(BaseAppView):'
172 172 'id': obj.group_name,
173 173 'value': org_query,
174 174 'value_display': obj.group_name,
175 'text': obj.group_name,
175 176 'type': 'repo_group',
177 'repo_group_id': obj.group_id,
176 178 'url': h.route_path(
177 179 'repo_group_home', repo_group_name=obj.group_name)
178 180 }
@@ -302,6 +304,33 b' class HomeView(BaseAppView):'
302 304 }
303 305 return data
304 306
307 @LoginRequired()
308 @view_config(
309 route_name='repo_group_list_data', request_method='GET',
310 renderer='json_ext', xhr=True)
311 def repo_group_list_data(self):
312 _ = self.request.translate
313 self.load_default_context()
314
315 query = self.request.GET.get('query')
316
317 log.debug('generating repo group list, query:%s',
318 query)
319
320 res = []
321 repo_groups = self._get_repo_group_list(query)
322 if repo_groups:
323 res.append({
324 'text': _('Repository Groups'),
325 'children': repo_groups
326 })
327
328 data = {
329 'more': False,
330 'results': res
331 }
332 return data
333
305 334 def _get_default_search_queries(self, search_context, searcher, query):
306 335 if not searcher:
307 336 return []
@@ -95,6 +95,18 b' def includeme(config):'
95 95 pattern=ADMIN_PREFIX + '/my_account/watched')
96 96
97 97 config.add_route(
98 name='my_account_bookmarks',
99 pattern=ADMIN_PREFIX + '/my_account/bookmarks')
100
101 config.add_route(
102 name='my_account_bookmarks_update',
103 pattern=ADMIN_PREFIX + '/my_account/bookmarks/update')
104
105 config.add_route(
106 name='my_account_goto_bookmark',
107 pattern=ADMIN_PREFIX + '/my_account/bookmark/{bookmark_id}')
108
109 config.add_route(
98 110 name='my_account_perms',
99 111 pattern=ADMIN_PREFIX + '/my_account/perms')
100 112
@@ -20,29 +20,30 b''
20 20
21 21 import logging
22 22 import datetime
23 import string
23 24
24 25 import formencode
25 26 import formencode.htmlfill
27 import peppercorn
26 28 from pyramid.httpexceptions import HTTPFound
27 29 from pyramid.view import view_config
28 from pyramid.renderers import render
29 from pyramid.response import Response
30 30
31 31 from rhodecode.apps._base import BaseAppView, DataGridAppView
32 32 from rhodecode import forms
33 33 from rhodecode.lib import helpers as h
34 34 from rhodecode.lib import audit_logger
35 35 from rhodecode.lib.ext_json import json
36 from rhodecode.lib.auth import LoginRequired, NotAnonymous, CSRFRequired
36 from rhodecode.lib.auth import LoginRequired, NotAnonymous, CSRFRequired, \
37 HasRepoPermissionAny, HasRepoGroupPermissionAny
37 38 from rhodecode.lib.channelstream import (
38 39 channelstream_request, ChannelstreamException)
39 40 from rhodecode.lib.utils2 import safe_int, md5, str2bool
40 41 from rhodecode.model.auth_token import AuthTokenModel
41 42 from rhodecode.model.comment import CommentsModel
42 43 from rhodecode.model.db import (
43 Repository, UserEmailMap, UserApiKeys, UserFollowing, joinedload,
44 PullRequest)
45 from rhodecode.model.forms import UserForm, UserExtraEmailForm
44 IntegrityError, joinedload,
45 Repository, UserEmailMap, UserApiKeys, UserFollowing,
46 PullRequest, UserBookmark, RepoGroup)
46 47 from rhodecode.model.meta import Session
47 48 from rhodecode.model.pull_request import PullRequestModel
48 49 from rhodecode.model.scm import RepoList
@@ -392,6 +393,140 b' class MyAccountView(BaseAppView, DataGri'
392 393 @LoginRequired()
393 394 @NotAnonymous()
394 395 @view_config(
396 route_name='my_account_bookmarks', request_method='GET',
397 renderer='rhodecode:templates/admin/my_account/my_account.mako')
398 def my_account_bookmarks(self):
399 c = self.load_default_context()
400 c.active = 'bookmarks'
401 return self._get_template_context(c)
402
403 def _process_entry(self, entry, user_id):
404 position = safe_int(entry.get('position'))
405 if position is None:
406 return
407
408 # check if this is an existing entry
409 is_new = False
410 db_entry = UserBookmark().get_by_position_for_user(position, user_id)
411
412 if db_entry and str2bool(entry.get('remove')):
413 log.debug('Marked bookmark %s for deletion', db_entry)
414 Session().delete(db_entry)
415 return
416
417 if not db_entry:
418 # new
419 db_entry = UserBookmark()
420 is_new = True
421
422 should_save = False
423 default_redirect_url = ''
424
425 # save repo
426 if entry.get('bookmark_repo'):
427 repo = Repository.get(entry['bookmark_repo'])
428 perm_check = HasRepoPermissionAny(
429 'repository.read', 'repository.write', 'repository.admin')
430 if repo and perm_check(repo_name=repo.repo_name):
431 db_entry.repository = repo
432 should_save = True
433 default_redirect_url = '${repo_url}'
434 # save repo group
435 elif entry.get('bookmark_repo_group'):
436 repo_group = RepoGroup.get(entry['bookmark_repo_group'])
437 perm_check = HasRepoGroupPermissionAny(
438 'group.read', 'group.write', 'group.admin')
439
440 if repo_group and perm_check(group_name=repo_group.group_name):
441 db_entry.repository_group = repo_group
442 should_save = True
443 default_redirect_url = '${repo_group_url}'
444 # save generic info
445 elif entry.get('title') and entry.get('redirect_url'):
446 should_save = True
447
448 if should_save:
449 log.debug('Saving bookmark %s, new:%s', db_entry, is_new)
450 # mark user and position
451 db_entry.user_id = user_id
452 db_entry.position = position
453 db_entry.title = entry.get('title')
454 db_entry.redirect_url = entry.get('redirect_url') or default_redirect_url
455
456 Session().add(db_entry)
457
458 @LoginRequired()
459 @NotAnonymous()
460 @CSRFRequired()
461 @view_config(
462 route_name='my_account_bookmarks_update', request_method='POST')
463 def my_account_bookmarks_update(self):
464 _ = self.request.translate
465 c = self.load_default_context()
466 c.active = 'bookmarks'
467
468 controls = peppercorn.parse(self.request.POST.items())
469 user_id = c.user.user_id
470
471 try:
472 for entry in controls.get('bookmarks', []):
473 self._process_entry(entry, user_id)
474
475 Session().commit()
476 h.flash(_("Update Bookmarks"), category='success')
477 except IntegrityError:
478 h.flash(_("Failed to update bookmarks. "
479 "Make sure an unique position is used"), category='error')
480
481 return HTTPFound(h.route_path('my_account_bookmarks'))
482
483 @LoginRequired()
484 @NotAnonymous()
485 @view_config(
486 route_name='my_account_goto_bookmark', request_method='GET',
487 renderer='rhodecode:templates/admin/my_account/my_account.mako')
488 def my_account_goto_bookmark(self):
489
490 bookmark_id = self.request.matchdict['bookmark_id']
491 user_bookmark = UserBookmark().query()\
492 .filter(UserBookmark.user_id == self.request.user.user_id) \
493 .filter(UserBookmark.position == bookmark_id).scalar()
494
495 redirect_url = h.route_path('my_account_bookmarks')
496 if not user_bookmark:
497 raise HTTPFound(redirect_url)
498
499 if user_bookmark.repository:
500 repo_name = user_bookmark.repository.repo_name
501 base_redirect_url = h.route_path(
502 'repo_summary', repo_name=repo_name)
503 if user_bookmark.redirect_url and \
504 '${repo_url}' in user_bookmark.redirect_url:
505 redirect_url = string.Template(user_bookmark.redirect_url)\
506 .safe_substitute({'repo_url': base_redirect_url})
507 else:
508 redirect_url = base_redirect_url
509
510 elif user_bookmark.repository_group:
511 repo_group_name = user_bookmark.repository_group.group_name
512 base_redirect_url = h.route_path(
513 'repo_group_home', repo_group_name=repo_group_name)
514 if user_bookmark.redirect_url and \
515 '${repo_group_url}' in user_bookmark.redirect_url:
516 redirect_url = string.Template(user_bookmark.redirect_url)\
517 .safe_substitute({'repo_group_url': base_redirect_url})
518 else:
519 redirect_url = base_redirect_url
520
521 elif user_bookmark.redirect_url:
522 redirect_url = user_bookmark.redirect_url
523
524 log.debug('Redirecting bookmark %s to %s', user_bookmark, redirect_url)
525 raise HTTPFound(redirect_url)
526
527 @LoginRequired()
528 @NotAnonymous()
529 @view_config(
395 530 route_name='my_account_perms', request_method='GET',
396 531 renderer='rhodecode:templates/admin/my_account/my_account.mako')
397 532 def my_account_perms(self):
@@ -44,7 +44,7 b' from rhodecode.lib.exceptions import Use'
44 44 from rhodecode.lib.utils import (password_changed, get_enabled_hook_classes)
45 45 from rhodecode.lib.utils2 import (
46 46 str2bool, safe_unicode, AttributeDict, safe_int, sha1, aslist, safe_str)
47 from rhodecode.model.db import Repository, User, ChangesetComment
47 from rhodecode.model.db import Repository, User, ChangesetComment, UserBookmark
48 48 from rhodecode.model.notification import NotificationModel
49 49 from rhodecode.model.settings import VcsSettingsModel, SettingsModel
50 50
@@ -282,7 +282,7 b' def get_current_lang(request):'
282 282 return getattr(request, '_LOCALE_', request.locale_name)
283 283
284 284
285 def attach_context_attributes(context, request, user_id):
285 def attach_context_attributes(context, request, user_id=None):
286 286 """
287 287 Attach variables into template context called `c`.
288 288 """
@@ -422,7 +422,13 b' def attach_context_attributes(context, r'
422 422 context.csrf_token = auth.get_csrf_token(session=request.session)
423 423 context.backends = rhodecode.BACKENDS.keys()
424 424 context.backends.sort()
425 context.unread_notifications = NotificationModel().get_unread_cnt_for_user(user_id)
425 unread_count = 0
426 user_bookmark_list = []
427 if user_id:
428 unread_count = NotificationModel().get_unread_cnt_for_user(user_id)
429 user_bookmark_list = UserBookmark.get_bookmarks_for_user(user_id)
430 context.unread_notifications = unread_count
431 context.bookmark_items = user_bookmark_list
426 432
427 433 # web case
428 434 if hasattr(request, 'user'):
@@ -4797,6 +4797,49 b' class UserGroupToRepoBranchPermission(Ba'
4797 4797 self.user_group_repo_to_perm, self.branch_pattern)
4798 4798
4799 4799
4800 class UserBookmark(Base, BaseModel):
4801 __tablename__ = 'user_bookmarks'
4802 __table_args__ = (
4803 UniqueConstraint('user_id', 'bookmark_repo_id'),
4804 UniqueConstraint('user_id', 'bookmark_repo_group_id'),
4805 UniqueConstraint('user_id', 'bookmark_position'),
4806 base_table_args
4807 )
4808
4809 user_bookmark_id = Column("user_bookmark_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
4810 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
4811 position = Column("bookmark_position", Integer(), nullable=False)
4812 title = Column("bookmark_title", String(255), nullable=True, unique=None, default=None)
4813 redirect_url = Column("bookmark_redirect_url", String(10240), nullable=True, unique=None, default=None)
4814 created_on = Column("created_on", DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4815
4816 bookmark_repo_id = Column("bookmark_repo_id", Integer(), ForeignKey("repositories.repo_id"), nullable=True, unique=None, default=None)
4817 bookmark_repo_group_id = Column("bookmark_repo_group_id", Integer(), ForeignKey("groups.group_id"), nullable=True, unique=None, default=None)
4818
4819 user = relationship("User")
4820
4821 repository = relationship("Repository")
4822 repository_group = relationship("RepoGroup")
4823
4824 @classmethod
4825 def get_by_position_for_user(cls, position, user_id):
4826 return cls.query() \
4827 .filter(UserBookmark.user_id == user_id) \
4828 .filter(UserBookmark.position == position).scalar()
4829
4830 @classmethod
4831 def get_bookmarks_for_user(cls, user_id):
4832 return cls.query() \
4833 .filter(UserBookmark.user_id == user_id) \
4834 .options(joinedload(UserBookmark.repository)) \
4835 .options(joinedload(UserBookmark.repository_group)) \
4836 .order_by(UserBookmark.position.asc()) \
4837 .all()
4838
4839 def __unicode__(self):
4840 return u'<UserBookmark(%d @ %r)>' % (self.position, self.redirect_url)
4841
4842
4800 4843 class DbMigrateVersion(Base, BaseModel):
4801 4844 __tablename__ = 'db_migrate_version'
4802 4845 __table_args__ = (
@@ -200,7 +200,27 b''
200 200 .user-menu.submenu {
201 201 right: 0;
202 202 left: auto;
203 min-width: 290px;
203 204 }
205
206
207 .user-menu {
208 .bookmark-items {
209 padding: 4px 2px;
210 color: @grey3;
211 border-bottom: @grey3;
212
213 a {
214 padding: 0 !important;
215 color: @rcblue !important;
216 }
217 }
218 a.bookmark-item {
219 color: @rcblue !important;
220 }
221 }
222
223
204 224 #quick_login {
205 225 left: auto;
206 226 right: 0;
@@ -335,6 +335,7 b''
335 335 }
336 336 }
337 337 }
338
338 339 }
339 340
340 341
@@ -172,7 +172,9 b' table.dataTable {'
172 172 &.td-buttons {
173 173 padding: .3em 0;
174 174 }
175
175 &.td-align-top {
176 vertical-align: text-top
177 }
176 178 &.td-action {
177 179 // this is for the remove/delete/edit buttons
178 180 padding-right: 0;
@@ -526,6 +526,10 b' address {'
526 526 font-family: @text-regular;
527 527 }
528 528
529 .help-block-inline {
530 margin: 0;
531 }
532
529 533 // help block text
530 534 .help-block {
531 535 display: block;
@@ -51,6 +51,38 b' function setRCMouseBindings(repoName, re'
51 51 Mousetrap.bind(['g G'], function(e) {
52 52 window.location = pyroutes.url('gists_show', {'public': 1});
53 53 });
54
55 Mousetrap.bind(['g 0'], function(e) {
56 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 0});
57 });
58 Mousetrap.bind(['g 1'], function(e) {
59 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 1});
60 });
61 Mousetrap.bind(['g 2'], function(e) {
62 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 2});
63 });
64 Mousetrap.bind(['g 3'], function(e) {
65 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 3});
66 });
67 Mousetrap.bind(['g 4'], function(e) {
68 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 4});
69 });
70 Mousetrap.bind(['g 5'], function(e) {
71 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 5});
72 });
73 Mousetrap.bind(['g 6'], function(e) {
74 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 6});
75 });
76 Mousetrap.bind(['g 7'], function(e) {
77 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 7});
78 });
79 Mousetrap.bind(['g 8'], function(e) {
80 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 8});
81 });
82 Mousetrap.bind(['g 9'], function(e) {
83 window.location = pyroutes.url('my_account_goto_bookmark', {'bookmark_id': 9});
84 });
85
54 86 Mousetrap.bind(['n g'], function(e) {
55 87 window.location = pyroutes.url('gists_new');
56 88 });
@@ -58,7 +90,7 b' function setRCMouseBindings(repoName, re'
58 90 window.location = pyroutes.url('repo_new');
59 91 });
60 92
61 if (repoName && repoName != '') {
93 if (repoName && repoName !== '') {
62 94 // nav in repo context
63 95 Mousetrap.bind(['g s'], function(e) {
64 96 window.location = pyroutes.url(
@@ -143,6 +143,7 b' function registerRCRoutes() {'
143 143 pyroutes.register('user_autocomplete_data', '/_users', []);
144 144 pyroutes.register('user_group_autocomplete_data', '/_user_groups', []);
145 145 pyroutes.register('repo_list_data', '/_repos', []);
146 pyroutes.register('repo_group_list_data', '/_repo_groups', []);
146 147 pyroutes.register('goto_switcher_data', '/_goto_data', []);
147 148 pyroutes.register('markup_preview', '/_markup_preview', []);
148 149 pyroutes.register('store_user_session_value', '/_store_session_attr', []);
@@ -297,6 +298,9 b' function registerRCRoutes() {'
297 298 pyroutes.register('my_account_emails_delete', '/_admin/my_account/emails/delete', []);
298 299 pyroutes.register('my_account_repos', '/_admin/my_account/repos', []);
299 300 pyroutes.register('my_account_watched', '/_admin/my_account/watched', []);
301 pyroutes.register('my_account_bookmarks', '/_admin/my_account/bookmarks', []);
302 pyroutes.register('my_account_bookmarks_update', '/_admin/my_account/bookmarks/update', []);
303 pyroutes.register('my_account_goto_bookmark', '/_admin/my_account/bookmark/%(bookmark_id)s', ['bookmark_id']);
300 304 pyroutes.register('my_account_perms', '/_admin/my_account/perms', []);
301 305 pyroutes.register('my_account_notifications', '/_admin/my_account/notifications', []);
302 306 pyroutes.register('my_account_notifications_toggle_visibility', '/_admin/my_account/toggle_visibility', []);
@@ -28,6 +28,7 b''
28 28 <ul class="nav nav-pills nav-stacked">
29 29 <li class="${'active' if c.active=='profile' or c.active=='profile_edit' else ''}"><a href="${h.route_path('my_account_profile')}">${_('Profile')}</a></li>
30 30 <li class="${'active' if c.active=='password' else ''}"><a href="${h.route_path('my_account_password')}">${_('Password')}</a></li>
31 <li class="${'active' if c.active=='bookmarks' else ''}"><a href="${h.route_path('my_account_bookmarks')}">${_('Bookmarks')}</a></li>
31 32 <li class="${'active' if c.active=='auth_tokens' else ''}"><a href="${h.route_path('my_account_auth_tokens')}">${_('Auth Tokens')}</a></li>
32 33 <li class="${'active' if c.active in ['ssh_keys', 'ssh_keys_generate'] else ''}"><a href="${h.route_path('my_account_ssh_keys')}">${_('SSH Keys')}</a></li>
33 34 <li class="${'active' if c.active=='user_group_membership' else ''}"><a href="${h.route_path('my_account_user_group_membership')}">${_('User Group Membership')}</a></li>
@@ -52,7 +52,7 b''
52 52 <p class="server-instance" style="display:${sid}">
53 53 ## display hidden instance ID if specially defined
54 54 % if c.rhodecode_instanceid:
55 ${_('RhodeCode instance id: %s') % c.rhodecode_instanceid}
55 ${_('RhodeCode instance id: {}').format(c.rhodecode_instanceid)}
56 56 % endif
57 57 </p>
58 58 </div>
@@ -331,6 +331,50 b''
331 331 <li>${h.link_to(_(u'My personal group'), h.route_path('repo_group_home', repo_group_name=c.rhodecode_user.personal_repo_group.group_name))}</li>
332 332 % endif
333 333 <li>${h.link_to(_(u'Pull Requests'), h.route_path('my_account_pullrequests'))}</li>
334 ## bookmark-items
335 <li class="bookmark-items">
336 ${_('Bookmarks')}
337 <div class="pull-right">
338 <a href="${h.route_path('my_account_bookmarks')}">${_('Manage')}</a>
339 </div>
340 </li>
341 % if not c.bookmark_items:
342 <li>
343 <a href="${h.route_path('my_account_bookmarks')}">${_('No Bookmarks yet.')}</a>
344 </li>
345 % endif
346 % for item in c.bookmark_items:
347 <li>
348 % if item.repository:
349 <div>
350 <a class="bookmark-item" href="${h.route_path('my_account_goto_bookmark', bookmark_id=item.position)}">
351 ${item.position}
352 % if item.repository.repo_type == 'hg':
353 <i class="icon-hg" title="${_('Repository')}" style="font-size: 16px"></i>
354 % elif item.repository.repo_type == 'git':
355 <i class="icon-git" title="${_('Repository')}" style="font-size: 16px"></i>
356 % elif item.repository.repo_type == 'svn':
357 <i class="icon-svn" title="${_('Repository')}" style="font-size: 16px"></i>
358 % endif
359 ${(item.title or h.shorter(item.repository.repo_name, 30))}
360 </a>
361 </div>
362 % elif item.repository_group:
363 <div>
364 <a class="bookmark-item" href="${h.route_path('my_account_goto_bookmark', bookmark_id=item.position)}">
365 ${item.position}
366 <i class="icon-folder-close" title="${_('Repository group')}" style="font-size: 16px"></i>
367 ${(item.title or h.shorter(item.repository_group.group_name, 30))}
368 </a>
369 </div>
370 % else:
371 <a class="bookmark-item" href="${h.route_path('my_account_goto_bookmark', bookmark_id=item.position)}">
372 ${item.position}
373 ${item.title}
374 </a>
375 % endif
376 </li>
377 % endfor
334 378
335 379 <li class="logout">
336 380 ${h.secure_form(h.route_path('logout'), request=request)}
@@ -483,6 +527,26 b' commit:efced4, to search for commits'
483 527 }(result, escapeMarkup);
484 528 };
485 529
530 var formatRepoGroupResult = function(result, container, query, escapeMarkup) {
531 return function(data, escapeMarkup) {
532 if (!data.repo_group_id){
533 return data.text; // optgroup text Repositories
534 }
535
536 var tmpl = '';
537 var repoGroupName = data['text'];
538
539 if(data){
540
541 tmpl += '<i class="icon-folder-close"></i> ';
542
543 }
544 tmpl += escapeMarkup(repoGroupName);
545 return tmpl;
546
547 }(result, escapeMarkup);
548 };
549
486 550
487 551 var autocompleteMainFilterFormatResult = function (data, value, org_formatter) {
488 552
@@ -610,6 +674,7 b' commit:efced4, to search for commits'
610 674 ('g h', 'Goto home page'),
611 675 ('g g', 'Goto my private gists page'),
612 676 ('g G', 'Goto my public gists page'),
677 ('g 0-9', 'Goto bookmarked items from 0-9'),
613 678 ('n r', 'New repository page'),
614 679 ('n g', 'New gist page'),
615 680 ]
@@ -88,9 +88,9 b''
88 88 %endif
89 89
90 90 ##PRIVATE/PUBLIC
91 %if private and c.visual.show_private_icon:
91 %if private is True and c.visual.show_private_icon:
92 92 <i class="icon-lock" title="${_('Private repository')}"></i>
93 %elif not private and c.visual.show_public_icon:
93 %elif private is False and c.visual.show_public_icon:
94 94 <i class="icon-unlock-alt" title="${_('Public repository')}"></i>
95 95 %else:
96 96 <span></span>
General Comments 0
You need to be logged in to leave comments. Login now