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