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