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