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