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