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