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