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