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