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