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