##// END OF EJS Templates
notifications: removed usage of pylons translation from models.
marcink -
r1921:12a61bbb default
parent child Browse files
Show More
@@ -1,2031 +1,2040 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2010-2017 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 21 """
22 22 Helper functions
23 23
24 24 Consists of functions to typically be used within templates, but also
25 25 available to Controllers. This module is available to both as 'h'.
26 26 """
27 27
28 28 import random
29 29 import hashlib
30 30 import StringIO
31 31 import urllib
32 32 import math
33 33 import logging
34 34 import re
35 35 import urlparse
36 36 import time
37 37 import string
38 38 import hashlib
39 39 from collections import OrderedDict
40 40
41 41 import pygments
42 42 import itertools
43 43 import fnmatch
44 44
45 45 from datetime import datetime
46 46 from functools import partial
47 47 from pygments.formatters.html import HtmlFormatter
48 48 from pygments import highlight as code_highlight
49 49 from pygments.lexers import (
50 50 get_lexer_by_name, get_lexer_for_filename, get_lexer_for_mimetype)
51 51
52 52 from pyramid.threadlocal import get_current_request
53 53
54 54 from webhelpers.html import literal, HTML, escape
55 55 from webhelpers.html.tools import *
56 56 from webhelpers.html.builder import make_tag
57 57 from webhelpers.html.tags import auto_discovery_link, checkbox, css_classes, \
58 58 end_form, file, form as wh_form, hidden, image, javascript_link, link_to, \
59 59 link_to_if, link_to_unless, ol, required_legend, select, stylesheet_link, \
60 60 submit, text, password, textarea, title, ul, xml_declaration, radio
61 61 from webhelpers.html.tools import auto_link, button_to, highlight, \
62 62 js_obfuscate, mail_to, strip_links, strip_tags, tag_re
63 63 from webhelpers.pylonslib import Flash as _Flash
64 64 from webhelpers.text import chop_at, collapse, convert_accented_entities, \
65 65 convert_misc_entities, lchop, plural, rchop, remove_formatting, \
66 66 replace_whitespace, urlify, truncate, wrap_paragraphs
67 67 from webhelpers.date import time_ago_in_words
68 68 from webhelpers.paginate import Page as _Page
69 69 from webhelpers.html.tags import _set_input_attrs, _set_id_attr, \
70 70 convert_boolean_attrs, NotGiven, _make_safe_id_component
71 71 from webhelpers2.number import format_byte_size
72 72
73 73 from rhodecode.lib.action_parser import action_parser
74 74 from rhodecode.lib.ext_json import json
75 75 from rhodecode.lib.utils import repo_name_slug, get_custom_lexer
76 76 from rhodecode.lib.utils2 import str2bool, safe_unicode, safe_str, \
77 77 get_commit_safe, datetime_to_time, time_to_datetime, time_to_utcdatetime, \
78 78 AttributeDict, safe_int, md5, md5_safe
79 79 from rhodecode.lib.markup_renderer import MarkupRenderer, relative_links
80 80 from rhodecode.lib.vcs.exceptions import CommitDoesNotExistError
81 81 from rhodecode.lib.vcs.backends.base import BaseChangeset, EmptyCommit
82 82 from rhodecode.config.conf import DATE_FORMAT, DATETIME_FORMAT
83 83 from rhodecode.model.changeset_status import ChangesetStatusModel
84 84 from rhodecode.model.db import Permission, User, Repository
85 85 from rhodecode.model.repo_group import RepoGroupModel
86 86 from rhodecode.model.settings import IssueTrackerSettingsModel
87 87
88 88 log = logging.getLogger(__name__)
89 89
90 90
91 91 DEFAULT_USER = User.DEFAULT_USER
92 92 DEFAULT_USER_EMAIL = User.DEFAULT_USER_EMAIL
93 93
94 94
95 95 def url(*args, **kw):
96 96 from pylons import url as pylons_url
97 97 return pylons_url(*args, **kw)
98 98
99 99
100 100 def pylons_url_current(*args, **kw):
101 101 """
102 102 This function overrides pylons.url.current() which returns the current
103 103 path so that it will also work from a pyramid only context. This
104 104 should be removed once port to pyramid is complete.
105 105 """
106 106 from pylons import url as pylons_url
107 107 if not args and not kw:
108 108 request = get_current_request()
109 109 return request.path
110 110 return pylons_url.current(*args, **kw)
111 111
112 112 url.current = pylons_url_current
113 113
114 114
115 115 def url_replace(**qargs):
116 116 """ Returns the current request url while replacing query string args """
117 117
118 118 request = get_current_request()
119 119 new_args = request.GET.mixed()
120 120 new_args.update(qargs)
121 121 return url('', **new_args)
122 122
123 123
124 124 def asset(path, ver=None, **kwargs):
125 125 """
126 126 Helper to generate a static asset file path for rhodecode assets
127 127
128 128 eg. h.asset('images/image.png', ver='3923')
129 129
130 130 :param path: path of asset
131 131 :param ver: optional version query param to append as ?ver=
132 132 """
133 133 request = get_current_request()
134 134 query = {}
135 135 query.update(kwargs)
136 136 if ver:
137 137 query = {'ver': ver}
138 138 return request.static_path(
139 139 'rhodecode:public/{}'.format(path), _query=query)
140 140
141 141
142 142 default_html_escape_table = {
143 143 ord('&'): u'&amp;',
144 144 ord('<'): u'&lt;',
145 145 ord('>'): u'&gt;',
146 146 ord('"'): u'&quot;',
147 147 ord("'"): u'&#39;',
148 148 }
149 149
150 150
151 151 def html_escape(text, html_escape_table=default_html_escape_table):
152 152 """Produce entities within text."""
153 153 return text.translate(html_escape_table)
154 154
155 155
156 156 def chop_at_smart(s, sub, inclusive=False, suffix_if_chopped=None):
157 157 """
158 158 Truncate string ``s`` at the first occurrence of ``sub``.
159 159
160 160 If ``inclusive`` is true, truncate just after ``sub`` rather than at it.
161 161 """
162 162 suffix_if_chopped = suffix_if_chopped or ''
163 163 pos = s.find(sub)
164 164 if pos == -1:
165 165 return s
166 166
167 167 if inclusive:
168 168 pos += len(sub)
169 169
170 170 chopped = s[:pos]
171 171 left = s[pos:].strip()
172 172
173 173 if left and suffix_if_chopped:
174 174 chopped += suffix_if_chopped
175 175
176 176 return chopped
177 177
178 178
179 179 def shorter(text, size=20):
180 180 postfix = '...'
181 181 if len(text) > size:
182 182 return text[:size - len(postfix)] + postfix
183 183 return text
184 184
185 185
186 186 def _reset(name, value=None, id=NotGiven, type="reset", **attrs):
187 187 """
188 188 Reset button
189 189 """
190 190 _set_input_attrs(attrs, type, name, value)
191 191 _set_id_attr(attrs, id, name)
192 192 convert_boolean_attrs(attrs, ["disabled"])
193 193 return HTML.input(**attrs)
194 194
195 195 reset = _reset
196 196 safeid = _make_safe_id_component
197 197
198 198
199 199 def branding(name, length=40):
200 200 return truncate(name, length, indicator="")
201 201
202 202
203 203 def FID(raw_id, path):
204 204 """
205 205 Creates a unique ID for filenode based on it's hash of path and commit
206 206 it's safe to use in urls
207 207
208 208 :param raw_id:
209 209 :param path:
210 210 """
211 211
212 212 return 'c-%s-%s' % (short_id(raw_id), md5_safe(path)[:12])
213 213
214 214
215 215 class _GetError(object):
216 216 """Get error from form_errors, and represent it as span wrapped error
217 217 message
218 218
219 219 :param field_name: field to fetch errors for
220 220 :param form_errors: form errors dict
221 221 """
222 222
223 223 def __call__(self, field_name, form_errors):
224 224 tmpl = """<span class="error_msg">%s</span>"""
225 225 if form_errors and field_name in form_errors:
226 226 return literal(tmpl % form_errors.get(field_name))
227 227
228 228 get_error = _GetError()
229 229
230 230
231 231 class _ToolTip(object):
232 232
233 233 def __call__(self, tooltip_title, trim_at=50):
234 234 """
235 235 Special function just to wrap our text into nice formatted
236 236 autowrapped text
237 237
238 238 :param tooltip_title:
239 239 """
240 240 tooltip_title = escape(tooltip_title)
241 241 tooltip_title = tooltip_title.replace('<', '&lt;').replace('>', '&gt;')
242 242 return tooltip_title
243 243 tooltip = _ToolTip()
244 244
245 245
246 246 def files_breadcrumbs(repo_name, commit_id, file_path):
247 247 if isinstance(file_path, str):
248 248 file_path = safe_unicode(file_path)
249 249
250 250 # TODO: johbo: Is this always a url like path, or is this operating
251 251 # system dependent?
252 252 path_segments = file_path.split('/')
253 253
254 254 repo_name_html = escape(repo_name)
255 255 if len(path_segments) == 1 and path_segments[0] == '':
256 256 url_segments = [repo_name_html]
257 257 else:
258 258 url_segments = [
259 259 link_to(
260 260 repo_name_html,
261 261 url('files_home',
262 262 repo_name=repo_name,
263 263 revision=commit_id,
264 264 f_path=''),
265 265 class_='pjax-link')]
266 266
267 267 last_cnt = len(path_segments) - 1
268 268 for cnt, segment in enumerate(path_segments):
269 269 if not segment:
270 270 continue
271 271 segment_html = escape(segment)
272 272
273 273 if cnt != last_cnt:
274 274 url_segments.append(
275 275 link_to(
276 276 segment_html,
277 277 url('files_home',
278 278 repo_name=repo_name,
279 279 revision=commit_id,
280 280 f_path='/'.join(path_segments[:cnt + 1])),
281 281 class_='pjax-link'))
282 282 else:
283 283 url_segments.append(segment_html)
284 284
285 285 return literal('/'.join(url_segments))
286 286
287 287
288 288 class CodeHtmlFormatter(HtmlFormatter):
289 289 """
290 290 My code Html Formatter for source codes
291 291 """
292 292
293 293 def wrap(self, source, outfile):
294 294 return self._wrap_div(self._wrap_pre(self._wrap_code(source)))
295 295
296 296 def _wrap_code(self, source):
297 297 for cnt, it in enumerate(source):
298 298 i, t = it
299 299 t = '<div id="L%s">%s</div>' % (cnt + 1, t)
300 300 yield i, t
301 301
302 302 def _wrap_tablelinenos(self, inner):
303 303 dummyoutfile = StringIO.StringIO()
304 304 lncount = 0
305 305 for t, line in inner:
306 306 if t:
307 307 lncount += 1
308 308 dummyoutfile.write(line)
309 309
310 310 fl = self.linenostart
311 311 mw = len(str(lncount + fl - 1))
312 312 sp = self.linenospecial
313 313 st = self.linenostep
314 314 la = self.lineanchors
315 315 aln = self.anchorlinenos
316 316 nocls = self.noclasses
317 317 if sp:
318 318 lines = []
319 319
320 320 for i in range(fl, fl + lncount):
321 321 if i % st == 0:
322 322 if i % sp == 0:
323 323 if aln:
324 324 lines.append('<a href="#%s%d" class="special">%*d</a>' %
325 325 (la, i, mw, i))
326 326 else:
327 327 lines.append('<span class="special">%*d</span>' % (mw, i))
328 328 else:
329 329 if aln:
330 330 lines.append('<a href="#%s%d">%*d</a>' % (la, i, mw, i))
331 331 else:
332 332 lines.append('%*d' % (mw, i))
333 333 else:
334 334 lines.append('')
335 335 ls = '\n'.join(lines)
336 336 else:
337 337 lines = []
338 338 for i in range(fl, fl + lncount):
339 339 if i % st == 0:
340 340 if aln:
341 341 lines.append('<a href="#%s%d">%*d</a>' % (la, i, mw, i))
342 342 else:
343 343 lines.append('%*d' % (mw, i))
344 344 else:
345 345 lines.append('')
346 346 ls = '\n'.join(lines)
347 347
348 348 # in case you wonder about the seemingly redundant <div> here: since the
349 349 # content in the other cell also is wrapped in a div, some browsers in
350 350 # some configurations seem to mess up the formatting...
351 351 if nocls:
352 352 yield 0, ('<table class="%stable">' % self.cssclass +
353 353 '<tr><td><div class="linenodiv" '
354 354 'style="background-color: #f0f0f0; padding-right: 10px">'
355 355 '<pre style="line-height: 125%">' +
356 356 ls + '</pre></div></td><td id="hlcode" class="code">')
357 357 else:
358 358 yield 0, ('<table class="%stable">' % self.cssclass +
359 359 '<tr><td class="linenos"><div class="linenodiv"><pre>' +
360 360 ls + '</pre></div></td><td id="hlcode" class="code">')
361 361 yield 0, dummyoutfile.getvalue()
362 362 yield 0, '</td></tr></table>'
363 363
364 364
365 365 class SearchContentCodeHtmlFormatter(CodeHtmlFormatter):
366 366 def __init__(self, **kw):
367 367 # only show these line numbers if set
368 368 self.only_lines = kw.pop('only_line_numbers', [])
369 369 self.query_terms = kw.pop('query_terms', [])
370 370 self.max_lines = kw.pop('max_lines', 5)
371 371 self.line_context = kw.pop('line_context', 3)
372 372 self.url = kw.pop('url', None)
373 373
374 374 super(CodeHtmlFormatter, self).__init__(**kw)
375 375
376 376 def _wrap_code(self, source):
377 377 for cnt, it in enumerate(source):
378 378 i, t = it
379 379 t = '<pre>%s</pre>' % t
380 380 yield i, t
381 381
382 382 def _wrap_tablelinenos(self, inner):
383 383 yield 0, '<table class="code-highlight %stable">' % self.cssclass
384 384
385 385 last_shown_line_number = 0
386 386 current_line_number = 1
387 387
388 388 for t, line in inner:
389 389 if not t:
390 390 yield t, line
391 391 continue
392 392
393 393 if current_line_number in self.only_lines:
394 394 if last_shown_line_number + 1 != current_line_number:
395 395 yield 0, '<tr>'
396 396 yield 0, '<td class="line">...</td>'
397 397 yield 0, '<td id="hlcode" class="code"></td>'
398 398 yield 0, '</tr>'
399 399
400 400 yield 0, '<tr>'
401 401 if self.url:
402 402 yield 0, '<td class="line"><a href="%s#L%i">%i</a></td>' % (
403 403 self.url, current_line_number, current_line_number)
404 404 else:
405 405 yield 0, '<td class="line"><a href="">%i</a></td>' % (
406 406 current_line_number)
407 407 yield 0, '<td id="hlcode" class="code">' + line + '</td>'
408 408 yield 0, '</tr>'
409 409
410 410 last_shown_line_number = current_line_number
411 411
412 412 current_line_number += 1
413 413
414 414
415 415 yield 0, '</table>'
416 416
417 417
418 418 def extract_phrases(text_query):
419 419 """
420 420 Extracts phrases from search term string making sure phrases
421 421 contained in double quotes are kept together - and discarding empty values
422 422 or fully whitespace values eg.
423 423
424 424 'some text "a phrase" more' => ['some', 'text', 'a phrase', 'more']
425 425
426 426 """
427 427
428 428 in_phrase = False
429 429 buf = ''
430 430 phrases = []
431 431 for char in text_query:
432 432 if in_phrase:
433 433 if char == '"': # end phrase
434 434 phrases.append(buf)
435 435 buf = ''
436 436 in_phrase = False
437 437 continue
438 438 else:
439 439 buf += char
440 440 continue
441 441 else:
442 442 if char == '"': # start phrase
443 443 in_phrase = True
444 444 phrases.append(buf)
445 445 buf = ''
446 446 continue
447 447 elif char == ' ':
448 448 phrases.append(buf)
449 449 buf = ''
450 450 continue
451 451 else:
452 452 buf += char
453 453
454 454 phrases.append(buf)
455 455 phrases = [phrase.strip() for phrase in phrases if phrase.strip()]
456 456 return phrases
457 457
458 458
459 459 def get_matching_offsets(text, phrases):
460 460 """
461 461 Returns a list of string offsets in `text` that the list of `terms` match
462 462
463 463 >>> get_matching_offsets('some text here', ['some', 'here'])
464 464 [(0, 4), (10, 14)]
465 465
466 466 """
467 467 offsets = []
468 468 for phrase in phrases:
469 469 for match in re.finditer(phrase, text):
470 470 offsets.append((match.start(), match.end()))
471 471
472 472 return offsets
473 473
474 474
475 475 def normalize_text_for_matching(x):
476 476 """
477 477 Replaces all non alnum characters to spaces and lower cases the string,
478 478 useful for comparing two text strings without punctuation
479 479 """
480 480 return re.sub(r'[^\w]', ' ', x.lower())
481 481
482 482
483 483 def get_matching_line_offsets(lines, terms):
484 484 """ Return a set of `lines` indices (starting from 1) matching a
485 485 text search query, along with `context` lines above/below matching lines
486 486
487 487 :param lines: list of strings representing lines
488 488 :param terms: search term string to match in lines eg. 'some text'
489 489 :param context: number of lines above/below a matching line to add to result
490 490 :param max_lines: cut off for lines of interest
491 491 eg.
492 492
493 493 text = '''
494 494 words words words
495 495 words words words
496 496 some text some
497 497 words words words
498 498 words words words
499 499 text here what
500 500 '''
501 501 get_matching_line_offsets(text, 'text', context=1)
502 502 {3: [(5, 9)], 6: [(0, 4)]]
503 503
504 504 """
505 505 matching_lines = {}
506 506 phrases = [normalize_text_for_matching(phrase)
507 507 for phrase in extract_phrases(terms)]
508 508
509 509 for line_index, line in enumerate(lines, start=1):
510 510 match_offsets = get_matching_offsets(
511 511 normalize_text_for_matching(line), phrases)
512 512 if match_offsets:
513 513 matching_lines[line_index] = match_offsets
514 514
515 515 return matching_lines
516 516
517 517
518 518 def hsv_to_rgb(h, s, v):
519 519 """ Convert hsv color values to rgb """
520 520
521 521 if s == 0.0:
522 522 return v, v, v
523 523 i = int(h * 6.0) # XXX assume int() truncates!
524 524 f = (h * 6.0) - i
525 525 p = v * (1.0 - s)
526 526 q = v * (1.0 - s * f)
527 527 t = v * (1.0 - s * (1.0 - f))
528 528 i = i % 6
529 529 if i == 0:
530 530 return v, t, p
531 531 if i == 1:
532 532 return q, v, p
533 533 if i == 2:
534 534 return p, v, t
535 535 if i == 3:
536 536 return p, q, v
537 537 if i == 4:
538 538 return t, p, v
539 539 if i == 5:
540 540 return v, p, q
541 541
542 542
543 543 def unique_color_generator(n=10000, saturation=0.10, lightness=0.95):
544 544 """
545 545 Generator for getting n of evenly distributed colors using
546 546 hsv color and golden ratio. It always return same order of colors
547 547
548 548 :param n: number of colors to generate
549 549 :param saturation: saturation of returned colors
550 550 :param lightness: lightness of returned colors
551 551 :returns: RGB tuple
552 552 """
553 553
554 554 golden_ratio = 0.618033988749895
555 555 h = 0.22717784590367374
556 556
557 557 for _ in xrange(n):
558 558 h += golden_ratio
559 559 h %= 1
560 560 HSV_tuple = [h, saturation, lightness]
561 561 RGB_tuple = hsv_to_rgb(*HSV_tuple)
562 562 yield map(lambda x: str(int(x * 256)), RGB_tuple)
563 563
564 564
565 565 def color_hasher(n=10000, saturation=0.10, lightness=0.95):
566 566 """
567 567 Returns a function which when called with an argument returns a unique
568 568 color for that argument, eg.
569 569
570 570 :param n: number of colors to generate
571 571 :param saturation: saturation of returned colors
572 572 :param lightness: lightness of returned colors
573 573 :returns: css RGB string
574 574
575 575 >>> color_hash = color_hasher()
576 576 >>> color_hash('hello')
577 577 'rgb(34, 12, 59)'
578 578 >>> color_hash('hello')
579 579 'rgb(34, 12, 59)'
580 580 >>> color_hash('other')
581 581 'rgb(90, 224, 159)'
582 582 """
583 583
584 584 color_dict = {}
585 585 cgenerator = unique_color_generator(
586 586 saturation=saturation, lightness=lightness)
587 587
588 588 def get_color_string(thing):
589 589 if thing in color_dict:
590 590 col = color_dict[thing]
591 591 else:
592 592 col = color_dict[thing] = cgenerator.next()
593 593 return "rgb(%s)" % (', '.join(col))
594 594
595 595 return get_color_string
596 596
597 597
598 598 def get_lexer_safe(mimetype=None, filepath=None):
599 599 """
600 600 Tries to return a relevant pygments lexer using mimetype/filepath name,
601 601 defaulting to plain text if none could be found
602 602 """
603 603 lexer = None
604 604 try:
605 605 if mimetype:
606 606 lexer = get_lexer_for_mimetype(mimetype)
607 607 if not lexer:
608 608 lexer = get_lexer_for_filename(filepath)
609 609 except pygments.util.ClassNotFound:
610 610 pass
611 611
612 612 if not lexer:
613 613 lexer = get_lexer_by_name('text')
614 614
615 615 return lexer
616 616
617 617
618 618 def get_lexer_for_filenode(filenode):
619 619 lexer = get_custom_lexer(filenode.extension) or filenode.lexer
620 620 return lexer
621 621
622 622
623 623 def pygmentize(filenode, **kwargs):
624 624 """
625 625 pygmentize function using pygments
626 626
627 627 :param filenode:
628 628 """
629 629 lexer = get_lexer_for_filenode(filenode)
630 630 return literal(code_highlight(filenode.content, lexer,
631 631 CodeHtmlFormatter(**kwargs)))
632 632
633 633
634 634 def is_following_repo(repo_name, user_id):
635 635 from rhodecode.model.scm import ScmModel
636 636 return ScmModel().is_following_repo(repo_name, user_id)
637 637
638 638
639 639 class _Message(object):
640 640 """A message returned by ``Flash.pop_messages()``.
641 641
642 642 Converting the message to a string returns the message text. Instances
643 643 also have the following attributes:
644 644
645 645 * ``message``: the message text.
646 646 * ``category``: the category specified when the message was created.
647 647 """
648 648
649 649 def __init__(self, category, message):
650 650 self.category = category
651 651 self.message = message
652 652
653 653 def __str__(self):
654 654 return self.message
655 655
656 656 __unicode__ = __str__
657 657
658 658 def __html__(self):
659 659 return escape(safe_unicode(self.message))
660 660
661 661
662 662 class Flash(_Flash):
663 663
664 664 def pop_messages(self, request=None):
665 665 """Return all accumulated messages and delete them from the session.
666 666
667 667 The return value is a list of ``Message`` objects.
668 668 """
669 669 messages = []
670 670
671 671 if request:
672 672 session = request.session
673 673 else:
674 674 from pylons import session
675 675
676 676 # Pop the 'old' pylons flash messages. They are tuples of the form
677 677 # (category, message)
678 678 for cat, msg in session.pop(self.session_key, []):
679 679 messages.append(_Message(cat, msg))
680 680
681 681 # Pop the 'new' pyramid flash messages for each category as list
682 682 # of strings.
683 683 for cat in self.categories:
684 684 for msg in session.pop_flash(queue=cat):
685 685 messages.append(_Message(cat, msg))
686 686 # Map messages from the default queue to the 'notice' category.
687 687 for msg in session.pop_flash():
688 688 messages.append(_Message('notice', msg))
689 689
690 690 session.save()
691 691 return messages
692 692
693 693 def json_alerts(self, request=None):
694 694 payloads = []
695 695 messages = flash.pop_messages(request=request)
696 696 if messages:
697 697 for message in messages:
698 698 subdata = {}
699 699 if hasattr(message.message, 'rsplit'):
700 700 flash_data = message.message.rsplit('|DELIM|', 1)
701 701 org_message = flash_data[0]
702 702 if len(flash_data) > 1:
703 703 subdata = json.loads(flash_data[1])
704 704 else:
705 705 org_message = message.message
706 706 payloads.append({
707 707 'message': {
708 708 'message': u'{}'.format(org_message),
709 709 'level': message.category,
710 710 'force': True,
711 711 'subdata': subdata
712 712 }
713 713 })
714 714 return json.dumps(payloads)
715 715
716 716 flash = Flash()
717 717
718 718 #==============================================================================
719 719 # SCM FILTERS available via h.
720 720 #==============================================================================
721 721 from rhodecode.lib.vcs.utils import author_name, author_email
722 722 from rhodecode.lib.utils2 import credentials_filter, age as _age
723 723 from rhodecode.model.db import User, ChangesetStatus
724 724
725 725 age = _age
726 726 capitalize = lambda x: x.capitalize()
727 727 email = author_email
728 728 short_id = lambda x: x[:12]
729 729 hide_credentials = lambda x: ''.join(credentials_filter(x))
730 730
731 731
732 732 def age_component(datetime_iso, value=None, time_is_local=False):
733 733 title = value or format_date(datetime_iso)
734 734 tzinfo = '+00:00'
735 735
736 736 # detect if we have a timezone info, otherwise, add it
737 737 if isinstance(datetime_iso, datetime) and not datetime_iso.tzinfo:
738 738 if time_is_local:
739 739 tzinfo = time.strftime("+%H:%M",
740 740 time.gmtime(
741 741 (datetime.now() - datetime.utcnow()).seconds + 1
742 742 )
743 743 )
744 744
745 745 return literal(
746 746 '<time class="timeago tooltip" '
747 747 'title="{1}{2}" datetime="{0}{2}">{1}</time>'.format(
748 748 datetime_iso, title, tzinfo))
749 749
750 750
751 751 def _shorten_commit_id(commit_id):
752 752 from rhodecode import CONFIG
753 753 def_len = safe_int(CONFIG.get('rhodecode_show_sha_length', 12))
754 754 return commit_id[:def_len]
755 755
756 756
757 757 def show_id(commit):
758 758 """
759 759 Configurable function that shows ID
760 760 by default it's r123:fffeeefffeee
761 761
762 762 :param commit: commit instance
763 763 """
764 764 from rhodecode import CONFIG
765 765 show_idx = str2bool(CONFIG.get('rhodecode_show_revision_number', True))
766 766
767 767 raw_id = _shorten_commit_id(commit.raw_id)
768 768 if show_idx:
769 769 return 'r%s:%s' % (commit.idx, raw_id)
770 770 else:
771 771 return '%s' % (raw_id, )
772 772
773 773
774 774 def format_date(date):
775 775 """
776 776 use a standardized formatting for dates used in RhodeCode
777 777
778 778 :param date: date/datetime object
779 779 :return: formatted date
780 780 """
781 781
782 782 if date:
783 783 _fmt = "%a, %d %b %Y %H:%M:%S"
784 784 return safe_unicode(date.strftime(_fmt))
785 785
786 786 return u""
787 787
788 788
789 789 class _RepoChecker(object):
790 790
791 791 def __init__(self, backend_alias):
792 792 self._backend_alias = backend_alias
793 793
794 794 def __call__(self, repository):
795 795 if hasattr(repository, 'alias'):
796 796 _type = repository.alias
797 797 elif hasattr(repository, 'repo_type'):
798 798 _type = repository.repo_type
799 799 else:
800 800 _type = repository
801 801 return _type == self._backend_alias
802 802
803 803 is_git = _RepoChecker('git')
804 804 is_hg = _RepoChecker('hg')
805 805 is_svn = _RepoChecker('svn')
806 806
807 807
808 808 def get_repo_type_by_name(repo_name):
809 809 repo = Repository.get_by_repo_name(repo_name)
810 810 return repo.repo_type
811 811
812 812
813 813 def is_svn_without_proxy(repository):
814 814 if is_svn(repository):
815 815 from rhodecode.model.settings import VcsSettingsModel
816 816 conf = VcsSettingsModel().get_ui_settings_as_config_obj()
817 817 return not str2bool(conf.get('vcs_svn_proxy', 'http_requests_enabled'))
818 818 return False
819 819
820 820
821 821 def discover_user(author):
822 822 """
823 823 Tries to discover RhodeCode User based on the autho string. Author string
824 824 is typically `FirstName LastName <email@address.com>`
825 825 """
826 826
827 827 # if author is already an instance use it for extraction
828 828 if isinstance(author, User):
829 829 return author
830 830
831 831 # Valid email in the attribute passed, see if they're in the system
832 832 _email = author_email(author)
833 833 if _email != '':
834 834 user = User.get_by_email(_email, case_insensitive=True, cache=True)
835 835 if user is not None:
836 836 return user
837 837
838 838 # Maybe it's a username, we try to extract it and fetch by username ?
839 839 _author = author_name(author)
840 840 user = User.get_by_username(_author, case_insensitive=True, cache=True)
841 841 if user is not None:
842 842 return user
843 843
844 844 return None
845 845
846 846
847 847 def email_or_none(author):
848 848 # extract email from the commit string
849 849 _email = author_email(author)
850 850
851 851 # If we have an email, use it, otherwise
852 852 # see if it contains a username we can get an email from
853 853 if _email != '':
854 854 return _email
855 855 else:
856 856 user = User.get_by_username(
857 857 author_name(author), case_insensitive=True, cache=True)
858 858
859 859 if user is not None:
860 860 return user.email
861 861
862 862 # No valid email, not a valid user in the system, none!
863 863 return None
864 864
865 865
866 866 def link_to_user(author, length=0, **kwargs):
867 867 user = discover_user(author)
868 868 # user can be None, but if we have it already it means we can re-use it
869 869 # in the person() function, so we save 1 intensive-query
870 870 if user:
871 871 author = user
872 872
873 873 display_person = person(author, 'username_or_name_or_email')
874 874 if length:
875 875 display_person = shorter(display_person, length)
876 876
877 877 if user:
878 878 return link_to(
879 879 escape(display_person),
880 880 route_path('user_profile', username=user.username),
881 881 **kwargs)
882 882 else:
883 883 return escape(display_person)
884 884
885 885
886 886 def person(author, show_attr="username_and_name"):
887 887 user = discover_user(author)
888 888 if user:
889 889 return getattr(user, show_attr)
890 890 else:
891 891 _author = author_name(author)
892 892 _email = email(author)
893 893 return _author or _email
894 894
895 895
896 896 def author_string(email):
897 897 if email:
898 898 user = User.get_by_email(email, case_insensitive=True, cache=True)
899 899 if user:
900 900 if user.first_name or user.last_name:
901 901 return '%s %s &lt;%s&gt;' % (
902 902 user.first_name, user.last_name, email)
903 903 else:
904 904 return email
905 905 else:
906 906 return email
907 907 else:
908 908 return None
909 909
910 910
911 911 def person_by_id(id_, show_attr="username_and_name"):
912 912 # attr to return from fetched user
913 913 person_getter = lambda usr: getattr(usr, show_attr)
914 914
915 915 #maybe it's an ID ?
916 916 if str(id_).isdigit() or isinstance(id_, int):
917 917 id_ = int(id_)
918 918 user = User.get(id_)
919 919 if user is not None:
920 920 return person_getter(user)
921 921 return id_
922 922
923 923
924 924 def gravatar_with_user(author, show_disabled=False):
925 925 from rhodecode.lib.utils import PartialRenderer
926 926 _render = PartialRenderer('base/base.mako')
927 927 return _render('gravatar_with_user', author, show_disabled=show_disabled)
928 928
929 929
930 930 def desc_stylize(value):
931 931 """
932 932 converts tags from value into html equivalent
933 933
934 934 :param value:
935 935 """
936 936 if not value:
937 937 return ''
938 938
939 939 value = re.sub(r'\[see\ \=\>\ *([a-zA-Z0-9\/\=\?\&\ \:\/\.\-]*)\]',
940 940 '<div class="metatag" tag="see">see =&gt; \\1 </div>', value)
941 941 value = re.sub(r'\[license\ \=\>\ *([a-zA-Z0-9\/\=\?\&\ \:\/\.\-]*)\]',
942 942 '<div class="metatag" tag="license"><a href="http:\/\/www.opensource.org/licenses/\\1">\\1</a></div>', value)
943 943 value = re.sub(r'\[(requires|recommends|conflicts|base)\ \=\>\ *([a-zA-Z0-9\-\/]*)\]',
944 944 '<div class="metatag" tag="\\1">\\1 =&gt; <a href="/\\2">\\2</a></div>', value)
945 945 value = re.sub(r'\[(lang|language)\ \=\>\ *([a-zA-Z\-\/\#\+]*)\]',
946 946 '<div class="metatag" tag="lang">\\2</div>', value)
947 947 value = re.sub(r'\[([a-z]+)\]',
948 948 '<div class="metatag" tag="\\1">\\1</div>', value)
949 949
950 950 return value
951 951
952 952
953 953 def escaped_stylize(value):
954 954 """
955 955 converts tags from value into html equivalent, but escaping its value first
956 956 """
957 957 if not value:
958 958 return ''
959 959
960 960 # Using default webhelper escape method, but has to force it as a
961 961 # plain unicode instead of a markup tag to be used in regex expressions
962 962 value = unicode(escape(safe_unicode(value)))
963 963
964 964 value = re.sub(r'\[see\ \=\&gt;\ *([a-zA-Z0-9\/\=\?\&amp;\ \:\/\.\-]*)\]',
965 965 '<div class="metatag" tag="see">see =&gt; \\1 </div>', value)
966 966 value = re.sub(r'\[license\ \=\&gt;\ *([a-zA-Z0-9\/\=\?\&amp;\ \:\/\.\-]*)\]',
967 967 '<div class="metatag" tag="license"><a href="http:\/\/www.opensource.org/licenses/\\1">\\1</a></div>', value)
968 968 value = re.sub(r'\[(requires|recommends|conflicts|base)\ \=\&gt;\ *([a-zA-Z0-9\-\/]*)\]',
969 969 '<div class="metatag" tag="\\1">\\1 =&gt; <a href="/\\2">\\2</a></div>', value)
970 970 value = re.sub(r'\[(lang|language)\ \=\&gt;\ *([a-zA-Z\-\/\#\+]*)\]',
971 971 '<div class="metatag" tag="lang">\\2</div>', value)
972 972 value = re.sub(r'\[([a-z]+)\]',
973 973 '<div class="metatag" tag="\\1">\\1</div>', value)
974 974
975 975 return value
976 976
977 977
978 978 def bool2icon(value):
979 979 """
980 980 Returns boolean value of a given value, represented as html element with
981 981 classes that will represent icons
982 982
983 983 :param value: given value to convert to html node
984 984 """
985 985
986 986 if value: # does bool conversion
987 987 return HTML.tag('i', class_="icon-true")
988 988 else: # not true as bool
989 989 return HTML.tag('i', class_="icon-false")
990 990
991 991
992 992 #==============================================================================
993 993 # PERMS
994 994 #==============================================================================
995 995 from rhodecode.lib.auth import HasPermissionAny, HasPermissionAll, \
996 996 HasRepoPermissionAny, HasRepoPermissionAll, HasRepoGroupPermissionAll, \
997 997 HasRepoGroupPermissionAny, HasRepoPermissionAnyApi, get_csrf_token, \
998 998 csrf_token_key
999 999
1000 1000
1001 1001 #==============================================================================
1002 1002 # GRAVATAR URL
1003 1003 #==============================================================================
1004 1004 class InitialsGravatar(object):
1005 1005 def __init__(self, email_address, first_name, last_name, size=30,
1006 1006 background=None, text_color='#fff'):
1007 1007 self.size = size
1008 1008 self.first_name = first_name
1009 1009 self.last_name = last_name
1010 1010 self.email_address = email_address
1011 1011 self.background = background or self.str2color(email_address)
1012 1012 self.text_color = text_color
1013 1013
1014 1014 def get_color_bank(self):
1015 1015 """
1016 1016 returns a predefined list of colors that gravatars can use.
1017 1017 Those are randomized distinct colors that guarantee readability and
1018 1018 uniqueness.
1019 1019
1020 1020 generated with: http://phrogz.net/css/distinct-colors.html
1021 1021 """
1022 1022 return [
1023 1023 '#bf3030', '#a67f53', '#00ff00', '#5989b3', '#392040', '#d90000',
1024 1024 '#402910', '#204020', '#79baf2', '#a700b3', '#bf6060', '#7f5320',
1025 1025 '#008000', '#003059', '#ee00ff', '#ff0000', '#8c4b00', '#007300',
1026 1026 '#005fb3', '#de73e6', '#ff4040', '#ffaa00', '#3df255', '#203140',
1027 1027 '#47004d', '#591616', '#664400', '#59b365', '#0d2133', '#83008c',
1028 1028 '#592d2d', '#bf9f60', '#73e682', '#1d3f73', '#73006b', '#402020',
1029 1029 '#b2862d', '#397341', '#597db3', '#e600d6', '#a60000', '#736039',
1030 1030 '#00b318', '#79aaf2', '#330d30', '#ff8080', '#403010', '#16591f',
1031 1031 '#002459', '#8c4688', '#e50000', '#ffbf40', '#00732e', '#102340',
1032 1032 '#bf60ac', '#8c4646', '#cc8800', '#00a642', '#1d3473', '#b32d98',
1033 1033 '#660e00', '#ffd580', '#80ffb2', '#7391e6', '#733967', '#d97b6c',
1034 1034 '#8c5e00', '#59b389', '#3967e6', '#590047', '#73281d', '#665200',
1035 1035 '#00e67a', '#2d50b3', '#8c2377', '#734139', '#b2982d', '#16593a',
1036 1036 '#001859', '#ff00aa', '#a65e53', '#ffcc00', '#0d3321', '#2d3959',
1037 1037 '#731d56', '#401610', '#4c3d00', '#468c6c', '#002ca6', '#d936a3',
1038 1038 '#d94c36', '#403920', '#36d9a3', '#0d1733', '#592d4a', '#993626',
1039 1039 '#cca300', '#00734d', '#46598c', '#8c005e', '#7f1100', '#8c7000',
1040 1040 '#00a66f', '#7382e6', '#b32d74', '#d9896c', '#ffe680', '#1d7362',
1041 1041 '#364cd9', '#73003d', '#d93a00', '#998a4d', '#59b3a1', '#5965b3',
1042 1042 '#e5007a', '#73341d', '#665f00', '#00b38f', '#0018b3', '#59163a',
1043 1043 '#b2502d', '#bfb960', '#00ffcc', '#23318c', '#a6537f', '#734939',
1044 1044 '#b2a700', '#104036', '#3d3df2', '#402031', '#e56739', '#736f39',
1045 1045 '#79f2ea', '#000059', '#401029', '#4c1400', '#ffee00', '#005953',
1046 1046 '#101040', '#990052', '#402820', '#403d10', '#00ffee', '#0000d9',
1047 1047 '#ff80c4', '#a66953', '#eeff00', '#00ccbe', '#8080ff', '#e673a1',
1048 1048 '#a62c00', '#474d00', '#1a3331', '#46468c', '#733950', '#662900',
1049 1049 '#858c23', '#238c85', '#0f0073', '#b20047', '#d9986c', '#becc00',
1050 1050 '#396f73', '#281d73', '#ff0066', '#ff6600', '#dee673', '#59adb3',
1051 1051 '#6559b3', '#590024', '#b2622d', '#98b32d', '#36ced9', '#332d59',
1052 1052 '#40001a', '#733f1d', '#526600', '#005359', '#242040', '#bf6079',
1053 1053 '#735039', '#cef23d', '#007780', '#5630bf', '#66001b', '#b24700',
1054 1054 '#acbf60', '#1d6273', '#25008c', '#731d34', '#a67453', '#50592d',
1055 1055 '#00ccff', '#6600ff', '#ff0044', '#4c1f00', '#8a994d', '#79daf2',
1056 1056 '#a173e6', '#d93662', '#402310', '#aaff00', '#2d98b3', '#8c40ff',
1057 1057 '#592d39', '#ff8c40', '#354020', '#103640', '#1a0040', '#331a20',
1058 1058 '#331400', '#334d00', '#1d5673', '#583973', '#7f0022', '#4c3626',
1059 1059 '#88cc00', '#36a3d9', '#3d0073', '#d9364c', '#33241a', '#698c23',
1060 1060 '#5995b3', '#300059', '#e57382', '#7f3300', '#366600', '#00aaff',
1061 1061 '#3a1659', '#733941', '#663600', '#74b32d', '#003c59', '#7f53a6',
1062 1062 '#73000f', '#ff8800', '#baf279', '#79caf2', '#291040', '#a6293a',
1063 1063 '#b2742d', '#587339', '#0077b3', '#632699', '#400009', '#d9a66c',
1064 1064 '#294010', '#2d4a59', '#aa00ff', '#4c131b', '#b25f00', '#5ce600',
1065 1065 '#267399', '#a336d9', '#990014', '#664e33', '#86bf60', '#0088ff',
1066 1066 '#7700b3', '#593a16', '#073300', '#1d4b73', '#ac60bf', '#e59539',
1067 1067 '#4f8c46', '#368dd9', '#5c0073'
1068 1068 ]
1069 1069
1070 1070 def rgb_to_hex_color(self, rgb_tuple):
1071 1071 """
1072 1072 Converts an rgb_tuple passed to an hex color.
1073 1073
1074 1074 :param rgb_tuple: tuple with 3 ints represents rgb color space
1075 1075 """
1076 1076 return '#' + ("".join(map(chr, rgb_tuple)).encode('hex'))
1077 1077
1078 1078 def email_to_int_list(self, email_str):
1079 1079 """
1080 1080 Get every byte of the hex digest value of email and turn it to integer.
1081 1081 It's going to be always between 0-255
1082 1082 """
1083 1083 digest = md5_safe(email_str.lower())
1084 1084 return [int(digest[i * 2:i * 2 + 2], 16) for i in range(16)]
1085 1085
1086 1086 def pick_color_bank_index(self, email_str, color_bank):
1087 1087 return self.email_to_int_list(email_str)[0] % len(color_bank)
1088 1088
1089 1089 def str2color(self, email_str):
1090 1090 """
1091 1091 Tries to map in a stable algorithm an email to color
1092 1092
1093 1093 :param email_str:
1094 1094 """
1095 1095 color_bank = self.get_color_bank()
1096 1096 # pick position (module it's length so we always find it in the
1097 1097 # bank even if it's smaller than 256 values
1098 1098 pos = self.pick_color_bank_index(email_str, color_bank)
1099 1099 return color_bank[pos]
1100 1100
1101 1101 def normalize_email(self, email_address):
1102 1102 import unicodedata
1103 1103 # default host used to fill in the fake/missing email
1104 1104 default_host = u'localhost'
1105 1105
1106 1106 if not email_address:
1107 1107 email_address = u'%s@%s' % (User.DEFAULT_USER, default_host)
1108 1108
1109 1109 email_address = safe_unicode(email_address)
1110 1110
1111 1111 if u'@' not in email_address:
1112 1112 email_address = u'%s@%s' % (email_address, default_host)
1113 1113
1114 1114 if email_address.endswith(u'@'):
1115 1115 email_address = u'%s%s' % (email_address, default_host)
1116 1116
1117 1117 email_address = unicodedata.normalize('NFKD', email_address)\
1118 1118 .encode('ascii', 'ignore')
1119 1119 return email_address
1120 1120
1121 1121 def get_initials(self):
1122 1122 """
1123 1123 Returns 2 letter initials calculated based on the input.
1124 1124 The algorithm picks first given email address, and takes first letter
1125 1125 of part before @, and then the first letter of server name. In case
1126 1126 the part before @ is in a format of `somestring.somestring2` it replaces
1127 1127 the server letter with first letter of somestring2
1128 1128
1129 1129 In case function was initialized with both first and lastname, this
1130 1130 overrides the extraction from email by first letter of the first and
1131 1131 last name. We add special logic to that functionality, In case Full name
1132 1132 is compound, like Guido Von Rossum, we use last part of the last name
1133 1133 (Von Rossum) picking `R`.
1134 1134
1135 1135 Function also normalizes the non-ascii characters to they ascii
1136 1136 representation, eg Δ„ => A
1137 1137 """
1138 1138 import unicodedata
1139 1139 # replace non-ascii to ascii
1140 1140 first_name = unicodedata.normalize(
1141 1141 'NFKD', safe_unicode(self.first_name)).encode('ascii', 'ignore')
1142 1142 last_name = unicodedata.normalize(
1143 1143 'NFKD', safe_unicode(self.last_name)).encode('ascii', 'ignore')
1144 1144
1145 1145 # do NFKD encoding, and also make sure email has proper format
1146 1146 email_address = self.normalize_email(self.email_address)
1147 1147
1148 1148 # first push the email initials
1149 1149 prefix, server = email_address.split('@', 1)
1150 1150
1151 1151 # check if prefix is maybe a 'first_name.last_name' syntax
1152 1152 _dot_split = prefix.rsplit('.', 1)
1153 1153 if len(_dot_split) == 2:
1154 1154 initials = [_dot_split[0][0], _dot_split[1][0]]
1155 1155 else:
1156 1156 initials = [prefix[0], server[0]]
1157 1157
1158 1158 # then try to replace either first_name or last_name
1159 1159 fn_letter = (first_name or " ")[0].strip()
1160 1160 ln_letter = (last_name.split(' ', 1)[-1] or " ")[0].strip()
1161 1161
1162 1162 if fn_letter:
1163 1163 initials[0] = fn_letter
1164 1164
1165 1165 if ln_letter:
1166 1166 initials[1] = ln_letter
1167 1167
1168 1168 return ''.join(initials).upper()
1169 1169
1170 1170 def get_img_data_by_type(self, font_family, img_type):
1171 1171 default_user = """
1172 1172 <svg xmlns="http://www.w3.org/2000/svg"
1173 1173 version="1.1" x="0px" y="0px" width="{size}" height="{size}"
1174 1174 viewBox="-15 -10 439.165 429.164"
1175 1175
1176 1176 xml:space="preserve"
1177 1177 style="background:{background};" >
1178 1178
1179 1179 <path d="M204.583,216.671c50.664,0,91.74-48.075,
1180 1180 91.74-107.378c0-82.237-41.074-107.377-91.74-107.377
1181 1181 c-50.668,0-91.74,25.14-91.74,107.377C112.844,
1182 1182 168.596,153.916,216.671,
1183 1183 204.583,216.671z" fill="{text_color}"/>
1184 1184 <path d="M407.164,374.717L360.88,
1185 1185 270.454c-2.117-4.771-5.836-8.728-10.465-11.138l-71.83-37.392
1186 1186 c-1.584-0.823-3.502-0.663-4.926,0.415c-20.316,
1187 1187 15.366-44.203,23.488-69.076,23.488c-24.877,
1188 1188 0-48.762-8.122-69.078-23.488
1189 1189 c-1.428-1.078-3.346-1.238-4.93-0.415L58.75,
1190 1190 259.316c-4.631,2.41-8.346,6.365-10.465,11.138L2.001,374.717
1191 1191 c-3.191,7.188-2.537,15.412,1.75,22.005c4.285,
1192 1192 6.592,11.537,10.526,19.4,10.526h362.861c7.863,0,15.117-3.936,
1193 1193 19.402-10.527 C409.699,390.129,
1194 1194 410.355,381.902,407.164,374.717z" fill="{text_color}"/>
1195 1195 </svg>""".format(
1196 1196 size=self.size,
1197 1197 background='#979797', # @grey4
1198 1198 text_color=self.text_color,
1199 1199 font_family=font_family)
1200 1200
1201 1201 return {
1202 1202 "default_user": default_user
1203 1203 }[img_type]
1204 1204
1205 1205 def get_img_data(self, svg_type=None):
1206 1206 """
1207 1207 generates the svg metadata for image
1208 1208 """
1209 1209
1210 1210 font_family = ','.join([
1211 1211 'proximanovaregular',
1212 1212 'Proxima Nova Regular',
1213 1213 'Proxima Nova',
1214 1214 'Arial',
1215 1215 'Lucida Grande',
1216 1216 'sans-serif'
1217 1217 ])
1218 1218 if svg_type:
1219 1219 return self.get_img_data_by_type(font_family, svg_type)
1220 1220
1221 1221 initials = self.get_initials()
1222 1222 img_data = """
1223 1223 <svg xmlns="http://www.w3.org/2000/svg" pointer-events="none"
1224 1224 width="{size}" height="{size}"
1225 1225 style="width: 100%; height: 100%; background-color: {background}"
1226 1226 viewBox="0 0 {size} {size}">
1227 1227 <text text-anchor="middle" y="50%" x="50%" dy="0.35em"
1228 1228 pointer-events="auto" fill="{text_color}"
1229 1229 font-family="{font_family}"
1230 1230 style="font-weight: 400; font-size: {f_size}px;">{text}
1231 1231 </text>
1232 1232 </svg>""".format(
1233 1233 size=self.size,
1234 1234 f_size=self.size/1.85, # scale the text inside the box nicely
1235 1235 background=self.background,
1236 1236 text_color=self.text_color,
1237 1237 text=initials.upper(),
1238 1238 font_family=font_family)
1239 1239
1240 1240 return img_data
1241 1241
1242 1242 def generate_svg(self, svg_type=None):
1243 1243 img_data = self.get_img_data(svg_type)
1244 1244 return "data:image/svg+xml;base64,%s" % img_data.encode('base64')
1245 1245
1246 1246
1247 1247 def initials_gravatar(email_address, first_name, last_name, size=30):
1248 1248 svg_type = None
1249 1249 if email_address == User.DEFAULT_USER_EMAIL:
1250 1250 svg_type = 'default_user'
1251 1251 klass = InitialsGravatar(email_address, first_name, last_name, size)
1252 1252 return klass.generate_svg(svg_type=svg_type)
1253 1253
1254 1254
1255 1255 def gravatar_url(email_address, size=30, request=None):
1256 1256 request = get_current_request()
1257 1257 if request and hasattr(request, 'call_context'):
1258 1258 _use_gravatar = request.call_context.visual.use_gravatar
1259 1259 _gravatar_url = request.call_context.visual.gravatar_url
1260 1260 else:
1261 1261 # doh, we need to re-import those to mock it later
1262 1262 from pylons import tmpl_context as c
1263 1263
1264 1264 _use_gravatar = c.visual.use_gravatar
1265 1265 _gravatar_url = c.visual.gravatar_url
1266 1266
1267 1267 _gravatar_url = _gravatar_url or User.DEFAULT_GRAVATAR_URL
1268 1268
1269 1269 email_address = email_address or User.DEFAULT_USER_EMAIL
1270 1270 if isinstance(email_address, unicode):
1271 1271 # hashlib crashes on unicode items
1272 1272 email_address = safe_str(email_address)
1273 1273
1274 1274 # empty email or default user
1275 1275 if not email_address or email_address == User.DEFAULT_USER_EMAIL:
1276 1276 return initials_gravatar(User.DEFAULT_USER_EMAIL, '', '', size=size)
1277 1277
1278 1278 if _use_gravatar:
1279 1279 # TODO: Disuse pyramid thread locals. Think about another solution to
1280 1280 # get the host and schema here.
1281 1281 request = get_current_request()
1282 1282 tmpl = safe_str(_gravatar_url)
1283 1283 tmpl = tmpl.replace('{email}', email_address)\
1284 1284 .replace('{md5email}', md5_safe(email_address.lower())) \
1285 1285 .replace('{netloc}', request.host)\
1286 1286 .replace('{scheme}', request.scheme)\
1287 1287 .replace('{size}', safe_str(size))
1288 1288 return tmpl
1289 1289 else:
1290 1290 return initials_gravatar(email_address, '', '', size=size)
1291 1291
1292 1292
1293 1293 class Page(_Page):
1294 1294 """
1295 1295 Custom pager to match rendering style with paginator
1296 1296 """
1297 1297
1298 1298 def _get_pos(self, cur_page, max_page, items):
1299 1299 edge = (items / 2) + 1
1300 1300 if (cur_page <= edge):
1301 1301 radius = max(items / 2, items - cur_page)
1302 1302 elif (max_page - cur_page) < edge:
1303 1303 radius = (items - 1) - (max_page - cur_page)
1304 1304 else:
1305 1305 radius = items / 2
1306 1306
1307 1307 left = max(1, (cur_page - (radius)))
1308 1308 right = min(max_page, cur_page + (radius))
1309 1309 return left, cur_page, right
1310 1310
1311 1311 def _range(self, regexp_match):
1312 1312 """
1313 1313 Return range of linked pages (e.g. '1 2 [3] 4 5 6 7 8').
1314 1314
1315 1315 Arguments:
1316 1316
1317 1317 regexp_match
1318 1318 A "re" (regular expressions) match object containing the
1319 1319 radius of linked pages around the current page in
1320 1320 regexp_match.group(1) as a string
1321 1321
1322 1322 This function is supposed to be called as a callable in
1323 1323 re.sub.
1324 1324
1325 1325 """
1326 1326 radius = int(regexp_match.group(1))
1327 1327
1328 1328 # Compute the first and last page number within the radius
1329 1329 # e.g. '1 .. 5 6 [7] 8 9 .. 12'
1330 1330 # -> leftmost_page = 5
1331 1331 # -> rightmost_page = 9
1332 1332 leftmost_page, _cur, rightmost_page = self._get_pos(self.page,
1333 1333 self.last_page,
1334 1334 (radius * 2) + 1)
1335 1335 nav_items = []
1336 1336
1337 1337 # Create a link to the first page (unless we are on the first page
1338 1338 # or there would be no need to insert '..' spacers)
1339 1339 if self.page != self.first_page and self.first_page < leftmost_page:
1340 1340 nav_items.append(self._pagerlink(self.first_page, self.first_page))
1341 1341
1342 1342 # Insert dots if there are pages between the first page
1343 1343 # and the currently displayed page range
1344 1344 if leftmost_page - self.first_page > 1:
1345 1345 # Wrap in a SPAN tag if nolink_attr is set
1346 1346 text = '..'
1347 1347 if self.dotdot_attr:
1348 1348 text = HTML.span(c=text, **self.dotdot_attr)
1349 1349 nav_items.append(text)
1350 1350
1351 1351 for thispage in xrange(leftmost_page, rightmost_page + 1):
1352 1352 # Hilight the current page number and do not use a link
1353 1353 if thispage == self.page:
1354 1354 text = '%s' % (thispage,)
1355 1355 # Wrap in a SPAN tag if nolink_attr is set
1356 1356 if self.curpage_attr:
1357 1357 text = HTML.span(c=text, **self.curpage_attr)
1358 1358 nav_items.append(text)
1359 1359 # Otherwise create just a link to that page
1360 1360 else:
1361 1361 text = '%s' % (thispage,)
1362 1362 nav_items.append(self._pagerlink(thispage, text))
1363 1363
1364 1364 # Insert dots if there are pages between the displayed
1365 1365 # page numbers and the end of the page range
1366 1366 if self.last_page - rightmost_page > 1:
1367 1367 text = '..'
1368 1368 # Wrap in a SPAN tag if nolink_attr is set
1369 1369 if self.dotdot_attr:
1370 1370 text = HTML.span(c=text, **self.dotdot_attr)
1371 1371 nav_items.append(text)
1372 1372
1373 1373 # Create a link to the very last page (unless we are on the last
1374 1374 # page or there would be no need to insert '..' spacers)
1375 1375 if self.page != self.last_page and rightmost_page < self.last_page:
1376 1376 nav_items.append(self._pagerlink(self.last_page, self.last_page))
1377 1377
1378 1378 ## prerender links
1379 1379 #_page_link = url.current()
1380 1380 #nav_items.append(literal('<link rel="prerender" href="%s?page=%s">' % (_page_link, str(int(self.page)+1))))
1381 1381 #nav_items.append(literal('<link rel="prefetch" href="%s?page=%s">' % (_page_link, str(int(self.page)+1))))
1382 1382 return self.separator.join(nav_items)
1383 1383
1384 1384 def pager(self, format='~2~', page_param='page', partial_param='partial',
1385 1385 show_if_single_page=False, separator=' ', onclick=None,
1386 1386 symbol_first='<<', symbol_last='>>',
1387 1387 symbol_previous='<', symbol_next='>',
1388 1388 link_attr={'class': 'pager_link', 'rel': 'prerender'},
1389 1389 curpage_attr={'class': 'pager_curpage'},
1390 1390 dotdot_attr={'class': 'pager_dotdot'}, **kwargs):
1391 1391
1392 1392 self.curpage_attr = curpage_attr
1393 1393 self.separator = separator
1394 1394 self.pager_kwargs = kwargs
1395 1395 self.page_param = page_param
1396 1396 self.partial_param = partial_param
1397 1397 self.onclick = onclick
1398 1398 self.link_attr = link_attr
1399 1399 self.dotdot_attr = dotdot_attr
1400 1400
1401 1401 # Don't show navigator if there is no more than one page
1402 1402 if self.page_count == 0 or (self.page_count == 1 and not show_if_single_page):
1403 1403 return ''
1404 1404
1405 1405 from string import Template
1406 1406 # Replace ~...~ in token format by range of pages
1407 1407 result = re.sub(r'~(\d+)~', self._range, format)
1408 1408
1409 1409 # Interpolate '%' variables
1410 1410 result = Template(result).safe_substitute({
1411 1411 'first_page': self.first_page,
1412 1412 'last_page': self.last_page,
1413 1413 'page': self.page,
1414 1414 'page_count': self.page_count,
1415 1415 'items_per_page': self.items_per_page,
1416 1416 'first_item': self.first_item,
1417 1417 'last_item': self.last_item,
1418 1418 'item_count': self.item_count,
1419 1419 'link_first': self.page > self.first_page and \
1420 1420 self._pagerlink(self.first_page, symbol_first) or '',
1421 1421 'link_last': self.page < self.last_page and \
1422 1422 self._pagerlink(self.last_page, symbol_last) or '',
1423 1423 'link_previous': self.previous_page and \
1424 1424 self._pagerlink(self.previous_page, symbol_previous) \
1425 1425 or HTML.span(symbol_previous, class_="pg-previous disabled"),
1426 1426 'link_next': self.next_page and \
1427 1427 self._pagerlink(self.next_page, symbol_next) \
1428 1428 or HTML.span(symbol_next, class_="pg-next disabled")
1429 1429 })
1430 1430
1431 1431 return literal(result)
1432 1432
1433 1433
1434 1434 #==============================================================================
1435 1435 # REPO PAGER, PAGER FOR REPOSITORY
1436 1436 #==============================================================================
1437 1437 class RepoPage(Page):
1438 1438
1439 1439 def __init__(self, collection, page=1, items_per_page=20,
1440 1440 item_count=None, url=None, **kwargs):
1441 1441
1442 1442 """Create a "RepoPage" instance. special pager for paging
1443 1443 repository
1444 1444 """
1445 1445 self._url_generator = url
1446 1446
1447 1447 # Safe the kwargs class-wide so they can be used in the pager() method
1448 1448 self.kwargs = kwargs
1449 1449
1450 1450 # Save a reference to the collection
1451 1451 self.original_collection = collection
1452 1452
1453 1453 self.collection = collection
1454 1454
1455 1455 # The self.page is the number of the current page.
1456 1456 # The first page has the number 1!
1457 1457 try:
1458 1458 self.page = int(page) # make it int() if we get it as a string
1459 1459 except (ValueError, TypeError):
1460 1460 self.page = 1
1461 1461
1462 1462 self.items_per_page = items_per_page
1463 1463
1464 1464 # Unless the user tells us how many items the collections has
1465 1465 # we calculate that ourselves.
1466 1466 if item_count is not None:
1467 1467 self.item_count = item_count
1468 1468 else:
1469 1469 self.item_count = len(self.collection)
1470 1470
1471 1471 # Compute the number of the first and last available page
1472 1472 if self.item_count > 0:
1473 1473 self.first_page = 1
1474 1474 self.page_count = int(math.ceil(float(self.item_count) /
1475 1475 self.items_per_page))
1476 1476 self.last_page = self.first_page + self.page_count - 1
1477 1477
1478 1478 # Make sure that the requested page number is the range of
1479 1479 # valid pages
1480 1480 if self.page > self.last_page:
1481 1481 self.page = self.last_page
1482 1482 elif self.page < self.first_page:
1483 1483 self.page = self.first_page
1484 1484
1485 1485 # Note: the number of items on this page can be less than
1486 1486 # items_per_page if the last page is not full
1487 1487 self.first_item = max(0, (self.item_count) - (self.page *
1488 1488 items_per_page))
1489 1489 self.last_item = ((self.item_count - 1) - items_per_page *
1490 1490 (self.page - 1))
1491 1491
1492 1492 self.items = list(self.collection[self.first_item:self.last_item + 1])
1493 1493
1494 1494 # Links to previous and next page
1495 1495 if self.page > self.first_page:
1496 1496 self.previous_page = self.page - 1
1497 1497 else:
1498 1498 self.previous_page = None
1499 1499
1500 1500 if self.page < self.last_page:
1501 1501 self.next_page = self.page + 1
1502 1502 else:
1503 1503 self.next_page = None
1504 1504
1505 1505 # No items available
1506 1506 else:
1507 1507 self.first_page = None
1508 1508 self.page_count = 0
1509 1509 self.last_page = None
1510 1510 self.first_item = None
1511 1511 self.last_item = None
1512 1512 self.previous_page = None
1513 1513 self.next_page = None
1514 1514 self.items = []
1515 1515
1516 1516 # This is a subclass of the 'list' type. Initialise the list now.
1517 1517 list.__init__(self, reversed(self.items))
1518 1518
1519 1519
1520 1520 def breadcrumb_repo_link(repo):
1521 1521 """
1522 1522 Makes a breadcrumbs path link to repo
1523 1523
1524 1524 ex::
1525 1525 group >> subgroup >> repo
1526 1526
1527 1527 :param repo: a Repository instance
1528 1528 """
1529 1529
1530 1530 path = [
1531 1531 link_to(group.name, route_path('repo_group_home', repo_group_name=group.group_name))
1532 1532 for group in repo.groups_with_parents
1533 1533 ] + [
1534 1534 link_to(repo.just_name, route_path('repo_summary', repo_name=repo.repo_name))
1535 1535 ]
1536 1536
1537 1537 return literal(' &raquo; '.join(path))
1538 1538
1539 1539
1540 1540 def format_byte_size_binary(file_size):
1541 1541 """
1542 1542 Formats file/folder sizes to standard.
1543 1543 """
1544 1544 formatted_size = format_byte_size(file_size, binary=True)
1545 1545 return formatted_size
1546 1546
1547 1547
1548 1548 def urlify_text(text_, safe=True):
1549 1549 """
1550 1550 Extrac urls from text and make html links out of them
1551 1551
1552 1552 :param text_:
1553 1553 """
1554 1554
1555 1555 url_pat = re.compile(r'''(http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@#.&+]'''
1556 1556 '''|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+)''')
1557 1557
1558 1558 def url_func(match_obj):
1559 1559 url_full = match_obj.groups()[0]
1560 1560 return '<a href="%(url)s">%(url)s</a>' % ({'url': url_full})
1561 1561 _newtext = url_pat.sub(url_func, text_)
1562 1562 if safe:
1563 1563 return literal(_newtext)
1564 1564 return _newtext
1565 1565
1566 1566
1567 1567 def urlify_commits(text_, repository):
1568 1568 """
1569 1569 Extract commit ids from text and make link from them
1570 1570
1571 1571 :param text_:
1572 1572 :param repository: repo name to build the URL with
1573 1573 """
1574 1574 from pylons import url # doh, we need to re-import url to mock it later
1575 1575 URL_PAT = re.compile(r'(^|\s)([0-9a-fA-F]{12,40})($|\s)')
1576 1576
1577 1577 def url_func(match_obj):
1578 1578 commit_id = match_obj.groups()[1]
1579 1579 pref = match_obj.groups()[0]
1580 1580 suf = match_obj.groups()[2]
1581 1581
1582 1582 tmpl = (
1583 1583 '%(pref)s<a class="%(cls)s" href="%(url)s">'
1584 1584 '%(commit_id)s</a>%(suf)s'
1585 1585 )
1586 1586 return tmpl % {
1587 1587 'pref': pref,
1588 1588 'cls': 'revision-link',
1589 1589 'url': url('changeset_home', repo_name=repository,
1590 1590 revision=commit_id, qualified=True),
1591 1591 'commit_id': commit_id,
1592 1592 'suf': suf
1593 1593 }
1594 1594
1595 1595 newtext = URL_PAT.sub(url_func, text_)
1596 1596
1597 1597 return newtext
1598 1598
1599 1599
1600 1600 def _process_url_func(match_obj, repo_name, uid, entry,
1601 1601 return_raw_data=False, link_format='html'):
1602 1602 pref = ''
1603 1603 if match_obj.group().startswith(' '):
1604 1604 pref = ' '
1605 1605
1606 1606 issue_id = ''.join(match_obj.groups())
1607 1607
1608 1608 if link_format == 'html':
1609 1609 tmpl = (
1610 1610 '%(pref)s<a class="%(cls)s" href="%(url)s">'
1611 1611 '%(issue-prefix)s%(id-repr)s'
1612 1612 '</a>')
1613 1613 elif link_format == 'rst':
1614 1614 tmpl = '`%(issue-prefix)s%(id-repr)s <%(url)s>`_'
1615 1615 elif link_format == 'markdown':
1616 1616 tmpl = '[%(issue-prefix)s%(id-repr)s](%(url)s)'
1617 1617 else:
1618 1618 raise ValueError('Bad link_format:{}'.format(link_format))
1619 1619
1620 1620 (repo_name_cleaned,
1621 1621 parent_group_name) = RepoGroupModel().\
1622 1622 _get_group_name_and_parent(repo_name)
1623 1623
1624 1624 # variables replacement
1625 1625 named_vars = {
1626 1626 'id': issue_id,
1627 1627 'repo': repo_name,
1628 1628 'repo_name': repo_name_cleaned,
1629 1629 'group_name': parent_group_name
1630 1630 }
1631 1631 # named regex variables
1632 1632 named_vars.update(match_obj.groupdict())
1633 1633 _url = string.Template(entry['url']).safe_substitute(**named_vars)
1634 1634
1635 1635 data = {
1636 1636 'pref': pref,
1637 1637 'cls': 'issue-tracker-link',
1638 1638 'url': _url,
1639 1639 'id-repr': issue_id,
1640 1640 'issue-prefix': entry['pref'],
1641 1641 'serv': entry['url'],
1642 1642 }
1643 1643 if return_raw_data:
1644 1644 return {
1645 1645 'id': issue_id,
1646 1646 'url': _url
1647 1647 }
1648 1648 return tmpl % data
1649 1649
1650 1650
1651 1651 def process_patterns(text_string, repo_name, link_format='html'):
1652 1652 allowed_formats = ['html', 'rst', 'markdown']
1653 1653 if link_format not in allowed_formats:
1654 1654 raise ValueError('Link format can be only one of:{} got {}'.format(
1655 1655 allowed_formats, link_format))
1656 1656
1657 1657 repo = None
1658 1658 if repo_name:
1659 1659 # Retrieving repo_name to avoid invalid repo_name to explode on
1660 1660 # IssueTrackerSettingsModel but still passing invalid name further down
1661 1661 repo = Repository.get_by_repo_name(repo_name, cache=True)
1662 1662
1663 1663 settings_model = IssueTrackerSettingsModel(repo=repo)
1664 1664 active_entries = settings_model.get_settings(cache=True)
1665 1665
1666 1666 issues_data = []
1667 1667 newtext = text_string
1668 1668
1669 1669 for uid, entry in active_entries.items():
1670 1670 log.debug('found issue tracker entry with uid %s' % (uid,))
1671 1671
1672 1672 if not (entry['pat'] and entry['url']):
1673 1673 log.debug('skipping due to missing data')
1674 1674 continue
1675 1675
1676 1676 log.debug('issue tracker entry: uid: `%s` PAT:%s URL:%s PREFIX:%s'
1677 1677 % (uid, entry['pat'], entry['url'], entry['pref']))
1678 1678
1679 1679 try:
1680 1680 pattern = re.compile(r'%s' % entry['pat'])
1681 1681 except re.error:
1682 1682 log.exception(
1683 1683 'issue tracker pattern: `%s` failed to compile',
1684 1684 entry['pat'])
1685 1685 continue
1686 1686
1687 1687 data_func = partial(
1688 1688 _process_url_func, repo_name=repo_name, entry=entry, uid=uid,
1689 1689 return_raw_data=True)
1690 1690
1691 1691 for match_obj in pattern.finditer(text_string):
1692 1692 issues_data.append(data_func(match_obj))
1693 1693
1694 1694 url_func = partial(
1695 1695 _process_url_func, repo_name=repo_name, entry=entry, uid=uid,
1696 1696 link_format=link_format)
1697 1697
1698 1698 newtext = pattern.sub(url_func, newtext)
1699 1699 log.debug('processed prefix:uid `%s`' % (uid,))
1700 1700
1701 1701 return newtext, issues_data
1702 1702
1703 1703
1704 1704 def urlify_commit_message(commit_text, repository=None):
1705 1705 """
1706 1706 Parses given text message and makes proper links.
1707 1707 issues are linked to given issue-server, and rest is a commit link
1708 1708
1709 1709 :param commit_text:
1710 1710 :param repository:
1711 1711 """
1712 1712 from pylons import url # doh, we need to re-import url to mock it later
1713 1713
1714 1714 def escaper(string):
1715 1715 return string.replace('<', '&lt;').replace('>', '&gt;')
1716 1716
1717 1717 newtext = escaper(commit_text)
1718 1718
1719 1719 # extract http/https links and make them real urls
1720 1720 newtext = urlify_text(newtext, safe=False)
1721 1721
1722 1722 # urlify commits - extract commit ids and make link out of them, if we have
1723 1723 # the scope of repository present.
1724 1724 if repository:
1725 1725 newtext = urlify_commits(newtext, repository)
1726 1726
1727 1727 # process issue tracker patterns
1728 1728 newtext, issues = process_patterns(newtext, repository or '')
1729 1729
1730 1730 return literal(newtext)
1731 1731
1732 1732
1733 1733 def render_binary(repo_name, file_obj):
1734 1734 """
1735 1735 Choose how to render a binary file
1736 1736 """
1737 1737 filename = file_obj.name
1738 1738
1739 1739 # images
1740 1740 for ext in ['*.png', '*.jpg', '*.ico', '*.gif']:
1741 1741 if fnmatch.fnmatch(filename, pat=ext):
1742 1742 alt = filename
1743 1743 src = url('files_raw_home', repo_name=repo_name,
1744 1744 revision=file_obj.commit.raw_id, f_path=file_obj.path)
1745 1745 return literal('<img class="rendered-binary" alt="{}" src="{}">'.format(alt, src))
1746 1746
1747 1747
1748 1748 def renderer_from_filename(filename, exclude=None):
1749 1749 """
1750 1750 choose a renderer based on filename, this works only for text based files
1751 1751 """
1752 1752
1753 1753 # ipython
1754 1754 for ext in ['*.ipynb']:
1755 1755 if fnmatch.fnmatch(filename, pat=ext):
1756 1756 return 'jupyter'
1757 1757
1758 1758 is_markup = MarkupRenderer.renderer_from_filename(filename, exclude=exclude)
1759 1759 if is_markup:
1760 1760 return is_markup
1761 1761 return None
1762 1762
1763 1763
1764 1764 def render(source, renderer='rst', mentions=False, relative_url=None,
1765 1765 repo_name=None):
1766 1766
1767 1767 def maybe_convert_relative_links(html_source):
1768 1768 if relative_url:
1769 1769 return relative_links(html_source, relative_url)
1770 1770 return html_source
1771 1771
1772 1772 if renderer == 'rst':
1773 1773 if repo_name:
1774 1774 # process patterns on comments if we pass in repo name
1775 1775 source, issues = process_patterns(
1776 1776 source, repo_name, link_format='rst')
1777 1777
1778 1778 return literal(
1779 1779 '<div class="rst-block">%s</div>' %
1780 1780 maybe_convert_relative_links(
1781 1781 MarkupRenderer.rst(source, mentions=mentions)))
1782 1782 elif renderer == 'markdown':
1783 1783 if repo_name:
1784 1784 # process patterns on comments if we pass in repo name
1785 1785 source, issues = process_patterns(
1786 1786 source, repo_name, link_format='markdown')
1787 1787
1788 1788 return literal(
1789 1789 '<div class="markdown-block">%s</div>' %
1790 1790 maybe_convert_relative_links(
1791 1791 MarkupRenderer.markdown(source, flavored=True,
1792 1792 mentions=mentions)))
1793 1793 elif renderer == 'jupyter':
1794 1794 return literal(
1795 1795 '<div class="ipynb">%s</div>' %
1796 1796 maybe_convert_relative_links(
1797 1797 MarkupRenderer.jupyter(source)))
1798 1798
1799 1799 # None means just show the file-source
1800 1800 return None
1801 1801
1802 1802
1803 1803 def commit_status(repo, commit_id):
1804 1804 return ChangesetStatusModel().get_status(repo, commit_id)
1805 1805
1806 1806
1807 1807 def commit_status_lbl(commit_status):
1808 1808 return dict(ChangesetStatus.STATUSES).get(commit_status)
1809 1809
1810 1810
1811 1811 def commit_time(repo_name, commit_id):
1812 1812 repo = Repository.get_by_repo_name(repo_name)
1813 1813 commit = repo.get_commit(commit_id=commit_id)
1814 1814 return commit.date
1815 1815
1816 1816
1817 1817 def get_permission_name(key):
1818 1818 return dict(Permission.PERMS).get(key)
1819 1819
1820 1820
1821 1821 def journal_filter_help(request):
1822 1822 _ = request.translate
1823 1823
1824 1824 return _(
1825 1825 'Example filter terms:\n' +
1826 1826 ' repository:vcs\n' +
1827 1827 ' username:marcin\n' +
1828 1828 ' username:(NOT marcin)\n' +
1829 1829 ' action:*push*\n' +
1830 1830 ' ip:127.0.0.1\n' +
1831 1831 ' date:20120101\n' +
1832 1832 ' date:[20120101100000 TO 20120102]\n' +
1833 1833 '\n' +
1834 1834 'Generate wildcards using \'*\' character:\n' +
1835 1835 ' "repository:vcs*" - search everything starting with \'vcs\'\n' +
1836 1836 ' "repository:*vcs*" - search for repository containing \'vcs\'\n' +
1837 1837 '\n' +
1838 1838 'Optional AND / OR operators in queries\n' +
1839 1839 ' "repository:vcs OR repository:test"\n' +
1840 1840 ' "username:test AND repository:test*"\n'
1841 1841 )
1842 1842
1843 1843
1844 1844 def search_filter_help(searcher, request):
1845 1845 _ = request.translate
1846 1846
1847 1847 terms = ''
1848 1848 return _(
1849 1849 'Example filter terms for `{searcher}` search:\n' +
1850 1850 '{terms}\n' +
1851 1851 'Generate wildcards using \'*\' character:\n' +
1852 1852 ' "repo_name:vcs*" - search everything starting with \'vcs\'\n' +
1853 1853 ' "repo_name:*vcs*" - search for repository containing \'vcs\'\n' +
1854 1854 '\n' +
1855 1855 'Optional AND / OR operators in queries\n' +
1856 1856 ' "repo_name:vcs OR repo_name:test"\n' +
1857 1857 ' "owner:test AND repo_name:test*"\n' +
1858 1858 'More: {search_doc}'
1859 1859 ).format(searcher=searcher.name,
1860 1860 terms=terms, search_doc=searcher.query_lang_doc)
1861 1861
1862 1862
1863 1863 def not_mapped_error(repo_name):
1864 1864 from rhodecode.translation import _
1865 1865 flash(_('%s repository is not mapped to db perhaps'
1866 1866 ' it was created or renamed from the filesystem'
1867 1867 ' please run the application again'
1868 1868 ' in order to rescan repositories') % repo_name, category='error')
1869 1869
1870 1870
1871 1871 def ip_range(ip_addr):
1872 1872 from rhodecode.model.db import UserIpMap
1873 1873 s, e = UserIpMap._get_ip_range(ip_addr)
1874 1874 return '%s - %s' % (s, e)
1875 1875
1876 1876
1877 1877 def form(url, method='post', needs_csrf_token=True, **attrs):
1878 1878 """Wrapper around webhelpers.tags.form to prevent CSRF attacks."""
1879 1879 if method.lower() != 'get' and needs_csrf_token:
1880 1880 raise Exception(
1881 1881 'Forms to POST/PUT/DELETE endpoints should have (in general) a ' +
1882 1882 'CSRF token. If the endpoint does not require such token you can ' +
1883 1883 'explicitly set the parameter needs_csrf_token to false.')
1884 1884
1885 1885 return wh_form(url, method=method, **attrs)
1886 1886
1887 1887
1888 1888 def secure_form(url, method="POST", multipart=False, **attrs):
1889 1889 """Start a form tag that points the action to an url. This
1890 1890 form tag will also include the hidden field containing
1891 1891 the auth token.
1892 1892
1893 1893 The url options should be given either as a string, or as a
1894 1894 ``url()`` function. The method for the form defaults to POST.
1895 1895
1896 1896 Options:
1897 1897
1898 1898 ``multipart``
1899 1899 If set to True, the enctype is set to "multipart/form-data".
1900 1900 ``method``
1901 1901 The method to use when submitting the form, usually either
1902 1902 "GET" or "POST". If "PUT", "DELETE", or another verb is used, a
1903 1903 hidden input with name _method is added to simulate the verb
1904 1904 over POST.
1905 1905
1906 1906 """
1907 1907 from webhelpers.pylonslib.secure_form import insecure_form
1908 1908 form = insecure_form(url, method, multipart, **attrs)
1909 1909
1910 1910 session = None
1911 1911 # TODO(marcink): after pyramid migration require request variable ALWAYS
1912 1912 if 'request' in attrs:
1913 1913 session = attrs['request'].session
1914 1914
1915 1915 token = literal(
1916 1916 '<input type="hidden" id="{}" name="{}" value="{}">'.format(
1917 1917 csrf_token_key, csrf_token_key, get_csrf_token(session)))
1918 1918
1919 1919 return literal("%s\n%s" % (form, token))
1920 1920
1921 1921
1922 1922 def dropdownmenu(name, selected, options, enable_filter=False, **attrs):
1923 1923 select_html = select(name, selected, options, **attrs)
1924 1924 select2 = """
1925 1925 <script>
1926 1926 $(document).ready(function() {
1927 1927 $('#%s').select2({
1928 1928 containerCssClass: 'drop-menu',
1929 1929 dropdownCssClass: 'drop-menu-dropdown',
1930 1930 dropdownAutoWidth: true%s
1931 1931 });
1932 1932 });
1933 1933 </script>
1934 1934 """
1935 1935 filter_option = """,
1936 1936 minimumResultsForSearch: -1
1937 1937 """
1938 1938 input_id = attrs.get('id') or name
1939 1939 filter_enabled = "" if enable_filter else filter_option
1940 1940 select_script = literal(select2 % (input_id, filter_enabled))
1941 1941
1942 1942 return literal(select_html+select_script)
1943 1943
1944 1944
1945 1945 def get_visual_attr(tmpl_context_var, attr_name):
1946 1946 """
1947 1947 A safe way to get a variable from visual variable of template context
1948 1948
1949 1949 :param tmpl_context_var: instance of tmpl_context, usually present as `c`
1950 1950 :param attr_name: name of the attribute we fetch from the c.visual
1951 1951 """
1952 1952 visual = getattr(tmpl_context_var, 'visual', None)
1953 1953 if not visual:
1954 1954 return
1955 1955 else:
1956 1956 return getattr(visual, attr_name, None)
1957 1957
1958 1958
1959 1959 def get_last_path_part(file_node):
1960 1960 if not file_node.path:
1961 1961 return u''
1962 1962
1963 1963 path = safe_unicode(file_node.path.split('/')[-1])
1964 1964 return u'../' + path
1965 1965
1966 1966
1967 1967 def route_url(*args, **kwargs):
1968 1968 """
1969 1969 Wrapper around pyramids `route_url` (fully qualified url) function.
1970 1970 It is used to generate URLs from within pylons views or templates.
1971 1971 This will be removed when pyramid migration if finished.
1972 1972 """
1973 1973 req = get_current_request()
1974 1974 return req.route_url(*args, **kwargs)
1975 1975
1976 1976
1977 1977 def route_path(*args, **kwargs):
1978 1978 """
1979 1979 Wrapper around pyramids `route_path` function. It is used to generate
1980 1980 URLs from within pylons views or templates. This will be removed when
1981 1981 pyramid migration if finished.
1982 1982 """
1983 1983 req = get_current_request()
1984 1984 return req.route_path(*args, **kwargs)
1985 1985
1986 1986
1987 1987 def route_path_or_none(*args, **kwargs):
1988 1988 try:
1989 1989 return route_path(*args, **kwargs)
1990 1990 except KeyError:
1991 1991 return None
1992 1992
1993 1993
1994 1994 def static_url(*args, **kwds):
1995 1995 """
1996 1996 Wrapper around pyramids `route_path` function. It is used to generate
1997 1997 URLs from within pylons views or templates. This will be removed when
1998 1998 pyramid migration if finished.
1999 1999 """
2000 2000 req = get_current_request()
2001 2001 return req.static_url(*args, **kwds)
2002 2002
2003 2003
2004 2004 def resource_path(*args, **kwds):
2005 2005 """
2006 2006 Wrapper around pyramids `route_path` function. It is used to generate
2007 2007 URLs from within pylons views or templates. This will be removed when
2008 2008 pyramid migration if finished.
2009 2009 """
2010 2010 req = get_current_request()
2011 2011 return req.resource_path(*args, **kwds)
2012 2012
2013 2013
2014 2014 def api_call_example(method, args):
2015 2015 """
2016 2016 Generates an API call example via CURL
2017 2017 """
2018 2018 args_json = json.dumps(OrderedDict([
2019 2019 ('id', 1),
2020 2020 ('auth_token', 'SECRET'),
2021 2021 ('method', method),
2022 2022 ('args', args)
2023 2023 ]))
2024 2024 return literal(
2025 2025 "curl {api_url} -X POST -H 'content-type:text/plain' --data-binary '{data}'"
2026 2026 "<br/><br/>SECRET can be found in <a href=\"{token_url}\">auth-tokens</a> page, "
2027 2027 "and needs to be of `api calls` role."
2028 2028 .format(
2029 2029 api_url=route_url('apiv2'),
2030 2030 token_url=route_url('my_account_auth_tokens'),
2031 2031 data=args_json))
2032
2033
2034 def notification_description(notification, request):
2035 """
2036 Generate notification human readable description based on notification type
2037 """
2038 from rhodecode.model.notification import NotificationModel
2039 return NotificationModel().make_description(
2040 notification, translate=request.translate)
@@ -1,4117 +1,4112 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2010-2017 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 21 """
22 22 Database Models for RhodeCode Enterprise
23 23 """
24 24
25 25 import re
26 26 import os
27 27 import time
28 28 import hashlib
29 29 import logging
30 30 import datetime
31 31 import warnings
32 32 import ipaddress
33 33 import functools
34 34 import traceback
35 35 import collections
36 36
37 37
38 38 from sqlalchemy import *
39 39 from sqlalchemy.ext.declarative import declared_attr
40 40 from sqlalchemy.ext.hybrid import hybrid_property
41 41 from sqlalchemy.orm import (
42 42 relationship, joinedload, class_mapper, validates, aliased)
43 43 from sqlalchemy.sql.expression import true
44 44 from beaker.cache import cache_region
45 45 from zope.cachedescriptors.property import Lazy as LazyProperty
46 46
47 47 from pyramid.threadlocal import get_current_request
48 48
49 49 from rhodecode.translation import _
50 50 from rhodecode.lib.vcs import get_vcs_instance
51 51 from rhodecode.lib.vcs.backends.base import EmptyCommit, Reference
52 52 from rhodecode.lib.utils2 import (
53 53 str2bool, safe_str, get_commit_safe, safe_unicode, md5_safe,
54 54 time_to_datetime, aslist, Optional, safe_int, get_clone_url, AttributeDict,
55 55 glob2re, StrictAttributeDict, cleaned_uri)
56 56 from rhodecode.lib.jsonalchemy import MutationObj, MutationList, JsonType
57 57 from rhodecode.lib.ext_json import json
58 58 from rhodecode.lib.caching_query import FromCache
59 59 from rhodecode.lib.encrypt import AESCipher
60 60
61 61 from rhodecode.model.meta import Base, Session
62 62
63 63 URL_SEP = '/'
64 64 log = logging.getLogger(__name__)
65 65
66 66 # =============================================================================
67 67 # BASE CLASSES
68 68 # =============================================================================
69 69
70 70 # this is propagated from .ini file rhodecode.encrypted_values.secret or
71 71 # beaker.session.secret if first is not set.
72 72 # and initialized at environment.py
73 73 ENCRYPTION_KEY = None
74 74
75 75 # used to sort permissions by types, '#' used here is not allowed to be in
76 76 # usernames, and it's very early in sorted string.printable table.
77 77 PERMISSION_TYPE_SORT = {
78 78 'admin': '####',
79 79 'write': '###',
80 80 'read': '##',
81 81 'none': '#',
82 82 }
83 83
84 84
85 85 def display_sort(obj):
86 86 """
87 87 Sort function used to sort permissions in .permissions() function of
88 88 Repository, RepoGroup, UserGroup. Also it put the default user in front
89 89 of all other resources
90 90 """
91 91
92 92 if obj.username == User.DEFAULT_USER:
93 93 return '#####'
94 94 prefix = PERMISSION_TYPE_SORT.get(obj.permission.split('.')[-1], '')
95 95 return prefix + obj.username
96 96
97 97
98 98 def _hash_key(k):
99 99 return md5_safe(k)
100 100
101 101
102 102 class EncryptedTextValue(TypeDecorator):
103 103 """
104 104 Special column for encrypted long text data, use like::
105 105
106 106 value = Column("encrypted_value", EncryptedValue(), nullable=False)
107 107
108 108 This column is intelligent so if value is in unencrypted form it return
109 109 unencrypted form, but on save it always encrypts
110 110 """
111 111 impl = Text
112 112
113 113 def process_bind_param(self, value, dialect):
114 114 if not value:
115 115 return value
116 116 if value.startswith('enc$aes$') or value.startswith('enc$aes_hmac$'):
117 117 # protect against double encrypting if someone manually starts
118 118 # doing
119 119 raise ValueError('value needs to be in unencrypted format, ie. '
120 120 'not starting with enc$aes')
121 121 return 'enc$aes_hmac$%s' % AESCipher(
122 122 ENCRYPTION_KEY, hmac=True).encrypt(value)
123 123
124 124 def process_result_value(self, value, dialect):
125 125 import rhodecode
126 126
127 127 if not value:
128 128 return value
129 129
130 130 parts = value.split('$', 3)
131 131 if not len(parts) == 3:
132 132 # probably not encrypted values
133 133 return value
134 134 else:
135 135 if parts[0] != 'enc':
136 136 # parts ok but without our header ?
137 137 return value
138 138 enc_strict_mode = str2bool(rhodecode.CONFIG.get(
139 139 'rhodecode.encrypted_values.strict') or True)
140 140 # at that stage we know it's our encryption
141 141 if parts[1] == 'aes':
142 142 decrypted_data = AESCipher(ENCRYPTION_KEY).decrypt(parts[2])
143 143 elif parts[1] == 'aes_hmac':
144 144 decrypted_data = AESCipher(
145 145 ENCRYPTION_KEY, hmac=True,
146 146 strict_verification=enc_strict_mode).decrypt(parts[2])
147 147 else:
148 148 raise ValueError(
149 149 'Encryption type part is wrong, must be `aes` '
150 150 'or `aes_hmac`, got `%s` instead' % (parts[1]))
151 151 return decrypted_data
152 152
153 153
154 154 class BaseModel(object):
155 155 """
156 156 Base Model for all classes
157 157 """
158 158
159 159 @classmethod
160 160 def _get_keys(cls):
161 161 """return column names for this model """
162 162 return class_mapper(cls).c.keys()
163 163
164 164 def get_dict(self):
165 165 """
166 166 return dict with keys and values corresponding
167 167 to this model data """
168 168
169 169 d = {}
170 170 for k in self._get_keys():
171 171 d[k] = getattr(self, k)
172 172
173 173 # also use __json__() if present to get additional fields
174 174 _json_attr = getattr(self, '__json__', None)
175 175 if _json_attr:
176 176 # update with attributes from __json__
177 177 if callable(_json_attr):
178 178 _json_attr = _json_attr()
179 179 for k, val in _json_attr.iteritems():
180 180 d[k] = val
181 181 return d
182 182
183 183 def get_appstruct(self):
184 184 """return list with keys and values tuples corresponding
185 185 to this model data """
186 186
187 187 l = []
188 188 for k in self._get_keys():
189 189 l.append((k, getattr(self, k),))
190 190 return l
191 191
192 192 def populate_obj(self, populate_dict):
193 193 """populate model with data from given populate_dict"""
194 194
195 195 for k in self._get_keys():
196 196 if k in populate_dict:
197 197 setattr(self, k, populate_dict[k])
198 198
199 199 @classmethod
200 200 def query(cls):
201 201 return Session().query(cls)
202 202
203 203 @classmethod
204 204 def get(cls, id_):
205 205 if id_:
206 206 return cls.query().get(id_)
207 207
208 208 @classmethod
209 209 def get_or_404(cls, id_, pyramid_exc=False):
210 210 if pyramid_exc:
211 211 # NOTE(marcink): backward compat, once migration to pyramid
212 212 # this should only use pyramid exceptions
213 213 from pyramid.httpexceptions import HTTPNotFound
214 214 else:
215 215 from webob.exc import HTTPNotFound
216 216
217 217 try:
218 218 id_ = int(id_)
219 219 except (TypeError, ValueError):
220 220 raise HTTPNotFound
221 221
222 222 res = cls.query().get(id_)
223 223 if not res:
224 224 raise HTTPNotFound
225 225 return res
226 226
227 227 @classmethod
228 228 def getAll(cls):
229 229 # deprecated and left for backward compatibility
230 230 return cls.get_all()
231 231
232 232 @classmethod
233 233 def get_all(cls):
234 234 return cls.query().all()
235 235
236 236 @classmethod
237 237 def delete(cls, id_):
238 238 obj = cls.query().get(id_)
239 239 Session().delete(obj)
240 240
241 241 @classmethod
242 242 def identity_cache(cls, session, attr_name, value):
243 243 exist_in_session = []
244 244 for (item_cls, pkey), instance in session.identity_map.items():
245 245 if cls == item_cls and getattr(instance, attr_name) == value:
246 246 exist_in_session.append(instance)
247 247 if exist_in_session:
248 248 if len(exist_in_session) == 1:
249 249 return exist_in_session[0]
250 250 log.exception(
251 251 'multiple objects with attr %s and '
252 252 'value %s found with same name: %r',
253 253 attr_name, value, exist_in_session)
254 254
255 255 def __repr__(self):
256 256 if hasattr(self, '__unicode__'):
257 257 # python repr needs to return str
258 258 try:
259 259 return safe_str(self.__unicode__())
260 260 except UnicodeDecodeError:
261 261 pass
262 262 return '<DB:%s>' % (self.__class__.__name__)
263 263
264 264
265 265 class RhodeCodeSetting(Base, BaseModel):
266 266 __tablename__ = 'rhodecode_settings'
267 267 __table_args__ = (
268 268 UniqueConstraint('app_settings_name'),
269 269 {'extend_existing': True, 'mysql_engine': 'InnoDB',
270 270 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
271 271 )
272 272
273 273 SETTINGS_TYPES = {
274 274 'str': safe_str,
275 275 'int': safe_int,
276 276 'unicode': safe_unicode,
277 277 'bool': str2bool,
278 278 'list': functools.partial(aslist, sep=',')
279 279 }
280 280 DEFAULT_UPDATE_URL = 'https://rhodecode.com/api/v1/info/versions'
281 281 GLOBAL_CONF_KEY = 'app_settings'
282 282
283 283 app_settings_id = Column("app_settings_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
284 284 app_settings_name = Column("app_settings_name", String(255), nullable=True, unique=None, default=None)
285 285 _app_settings_value = Column("app_settings_value", String(4096), nullable=True, unique=None, default=None)
286 286 _app_settings_type = Column("app_settings_type", String(255), nullable=True, unique=None, default=None)
287 287
288 288 def __init__(self, key='', val='', type='unicode'):
289 289 self.app_settings_name = key
290 290 self.app_settings_type = type
291 291 self.app_settings_value = val
292 292
293 293 @validates('_app_settings_value')
294 294 def validate_settings_value(self, key, val):
295 295 assert type(val) == unicode
296 296 return val
297 297
298 298 @hybrid_property
299 299 def app_settings_value(self):
300 300 v = self._app_settings_value
301 301 _type = self.app_settings_type
302 302 if _type:
303 303 _type = self.app_settings_type.split('.')[0]
304 304 # decode the encrypted value
305 305 if 'encrypted' in self.app_settings_type:
306 306 cipher = EncryptedTextValue()
307 307 v = safe_unicode(cipher.process_result_value(v, None))
308 308
309 309 converter = self.SETTINGS_TYPES.get(_type) or \
310 310 self.SETTINGS_TYPES['unicode']
311 311 return converter(v)
312 312
313 313 @app_settings_value.setter
314 314 def app_settings_value(self, val):
315 315 """
316 316 Setter that will always make sure we use unicode in app_settings_value
317 317
318 318 :param val:
319 319 """
320 320 val = safe_unicode(val)
321 321 # encode the encrypted value
322 322 if 'encrypted' in self.app_settings_type:
323 323 cipher = EncryptedTextValue()
324 324 val = safe_unicode(cipher.process_bind_param(val, None))
325 325 self._app_settings_value = val
326 326
327 327 @hybrid_property
328 328 def app_settings_type(self):
329 329 return self._app_settings_type
330 330
331 331 @app_settings_type.setter
332 332 def app_settings_type(self, val):
333 333 if val.split('.')[0] not in self.SETTINGS_TYPES:
334 334 raise Exception('type must be one of %s got %s'
335 335 % (self.SETTINGS_TYPES.keys(), val))
336 336 self._app_settings_type = val
337 337
338 338 def __unicode__(self):
339 339 return u"<%s('%s:%s[%s]')>" % (
340 340 self.__class__.__name__,
341 341 self.app_settings_name, self.app_settings_value,
342 342 self.app_settings_type
343 343 )
344 344
345 345
346 346 class RhodeCodeUi(Base, BaseModel):
347 347 __tablename__ = 'rhodecode_ui'
348 348 __table_args__ = (
349 349 UniqueConstraint('ui_key'),
350 350 {'extend_existing': True, 'mysql_engine': 'InnoDB',
351 351 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
352 352 )
353 353
354 354 HOOK_REPO_SIZE = 'changegroup.repo_size'
355 355 # HG
356 356 HOOK_PRE_PULL = 'preoutgoing.pre_pull'
357 357 HOOK_PULL = 'outgoing.pull_logger'
358 358 HOOK_PRE_PUSH = 'prechangegroup.pre_push'
359 359 HOOK_PRETX_PUSH = 'pretxnchangegroup.pre_push'
360 360 HOOK_PUSH = 'changegroup.push_logger'
361 361 HOOK_PUSH_KEY = 'pushkey.key_push'
362 362
363 363 # TODO: johbo: Unify way how hooks are configured for git and hg,
364 364 # git part is currently hardcoded.
365 365
366 366 # SVN PATTERNS
367 367 SVN_BRANCH_ID = 'vcs_svn_branch'
368 368 SVN_TAG_ID = 'vcs_svn_tag'
369 369
370 370 ui_id = Column(
371 371 "ui_id", Integer(), nullable=False, unique=True, default=None,
372 372 primary_key=True)
373 373 ui_section = Column(
374 374 "ui_section", String(255), nullable=True, unique=None, default=None)
375 375 ui_key = Column(
376 376 "ui_key", String(255), nullable=True, unique=None, default=None)
377 377 ui_value = Column(
378 378 "ui_value", String(255), nullable=True, unique=None, default=None)
379 379 ui_active = Column(
380 380 "ui_active", Boolean(), nullable=True, unique=None, default=True)
381 381
382 382 def __repr__(self):
383 383 return '<%s[%s]%s=>%s]>' % (self.__class__.__name__, self.ui_section,
384 384 self.ui_key, self.ui_value)
385 385
386 386
387 387 class RepoRhodeCodeSetting(Base, BaseModel):
388 388 __tablename__ = 'repo_rhodecode_settings'
389 389 __table_args__ = (
390 390 UniqueConstraint(
391 391 'app_settings_name', 'repository_id',
392 392 name='uq_repo_rhodecode_setting_name_repo_id'),
393 393 {'extend_existing': True, 'mysql_engine': 'InnoDB',
394 394 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
395 395 )
396 396
397 397 repository_id = Column(
398 398 "repository_id", Integer(), ForeignKey('repositories.repo_id'),
399 399 nullable=False)
400 400 app_settings_id = Column(
401 401 "app_settings_id", Integer(), nullable=False, unique=True,
402 402 default=None, primary_key=True)
403 403 app_settings_name = Column(
404 404 "app_settings_name", String(255), nullable=True, unique=None,
405 405 default=None)
406 406 _app_settings_value = Column(
407 407 "app_settings_value", String(4096), nullable=True, unique=None,
408 408 default=None)
409 409 _app_settings_type = Column(
410 410 "app_settings_type", String(255), nullable=True, unique=None,
411 411 default=None)
412 412
413 413 repository = relationship('Repository')
414 414
415 415 def __init__(self, repository_id, key='', val='', type='unicode'):
416 416 self.repository_id = repository_id
417 417 self.app_settings_name = key
418 418 self.app_settings_type = type
419 419 self.app_settings_value = val
420 420
421 421 @validates('_app_settings_value')
422 422 def validate_settings_value(self, key, val):
423 423 assert type(val) == unicode
424 424 return val
425 425
426 426 @hybrid_property
427 427 def app_settings_value(self):
428 428 v = self._app_settings_value
429 429 type_ = self.app_settings_type
430 430 SETTINGS_TYPES = RhodeCodeSetting.SETTINGS_TYPES
431 431 converter = SETTINGS_TYPES.get(type_) or SETTINGS_TYPES['unicode']
432 432 return converter(v)
433 433
434 434 @app_settings_value.setter
435 435 def app_settings_value(self, val):
436 436 """
437 437 Setter that will always make sure we use unicode in app_settings_value
438 438
439 439 :param val:
440 440 """
441 441 self._app_settings_value = safe_unicode(val)
442 442
443 443 @hybrid_property
444 444 def app_settings_type(self):
445 445 return self._app_settings_type
446 446
447 447 @app_settings_type.setter
448 448 def app_settings_type(self, val):
449 449 SETTINGS_TYPES = RhodeCodeSetting.SETTINGS_TYPES
450 450 if val not in SETTINGS_TYPES:
451 451 raise Exception('type must be one of %s got %s'
452 452 % (SETTINGS_TYPES.keys(), val))
453 453 self._app_settings_type = val
454 454
455 455 def __unicode__(self):
456 456 return u"<%s('%s:%s:%s[%s]')>" % (
457 457 self.__class__.__name__, self.repository.repo_name,
458 458 self.app_settings_name, self.app_settings_value,
459 459 self.app_settings_type
460 460 )
461 461
462 462
463 463 class RepoRhodeCodeUi(Base, BaseModel):
464 464 __tablename__ = 'repo_rhodecode_ui'
465 465 __table_args__ = (
466 466 UniqueConstraint(
467 467 'repository_id', 'ui_section', 'ui_key',
468 468 name='uq_repo_rhodecode_ui_repository_id_section_key'),
469 469 {'extend_existing': True, 'mysql_engine': 'InnoDB',
470 470 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
471 471 )
472 472
473 473 repository_id = Column(
474 474 "repository_id", Integer(), ForeignKey('repositories.repo_id'),
475 475 nullable=False)
476 476 ui_id = Column(
477 477 "ui_id", Integer(), nullable=False, unique=True, default=None,
478 478 primary_key=True)
479 479 ui_section = Column(
480 480 "ui_section", String(255), nullable=True, unique=None, default=None)
481 481 ui_key = Column(
482 482 "ui_key", String(255), nullable=True, unique=None, default=None)
483 483 ui_value = Column(
484 484 "ui_value", String(255), nullable=True, unique=None, default=None)
485 485 ui_active = Column(
486 486 "ui_active", Boolean(), nullable=True, unique=None, default=True)
487 487
488 488 repository = relationship('Repository')
489 489
490 490 def __repr__(self):
491 491 return '<%s[%s:%s]%s=>%s]>' % (
492 492 self.__class__.__name__, self.repository.repo_name,
493 493 self.ui_section, self.ui_key, self.ui_value)
494 494
495 495
496 496 class User(Base, BaseModel):
497 497 __tablename__ = 'users'
498 498 __table_args__ = (
499 499 UniqueConstraint('username'), UniqueConstraint('email'),
500 500 Index('u_username_idx', 'username'),
501 501 Index('u_email_idx', 'email'),
502 502 {'extend_existing': True, 'mysql_engine': 'InnoDB',
503 503 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
504 504 )
505 505 DEFAULT_USER = 'default'
506 506 DEFAULT_USER_EMAIL = 'anonymous@rhodecode.org'
507 507 DEFAULT_GRAVATAR_URL = 'https://secure.gravatar.com/avatar/{md5email}?d=identicon&s={size}'
508 508
509 509 user_id = Column("user_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
510 510 username = Column("username", String(255), nullable=True, unique=None, default=None)
511 511 password = Column("password", String(255), nullable=True, unique=None, default=None)
512 512 active = Column("active", Boolean(), nullable=True, unique=None, default=True)
513 513 admin = Column("admin", Boolean(), nullable=True, unique=None, default=False)
514 514 name = Column("firstname", String(255), nullable=True, unique=None, default=None)
515 515 lastname = Column("lastname", String(255), nullable=True, unique=None, default=None)
516 516 _email = Column("email", String(255), nullable=True, unique=None, default=None)
517 517 last_login = Column("last_login", DateTime(timezone=False), nullable=True, unique=None, default=None)
518 518 last_activity = Column('last_activity', DateTime(timezone=False), nullable=True, unique=None, default=None)
519 519
520 520 extern_type = Column("extern_type", String(255), nullable=True, unique=None, default=None)
521 521 extern_name = Column("extern_name", String(255), nullable=True, unique=None, default=None)
522 522 _api_key = Column("api_key", String(255), nullable=True, unique=None, default=None)
523 523 inherit_default_permissions = Column("inherit_default_permissions", Boolean(), nullable=False, unique=None, default=True)
524 524 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
525 525 _user_data = Column("user_data", LargeBinary(), nullable=True) # JSON data
526 526
527 527 user_log = relationship('UserLog')
528 528 user_perms = relationship('UserToPerm', primaryjoin="User.user_id==UserToPerm.user_id", cascade='all')
529 529
530 530 repositories = relationship('Repository')
531 531 repository_groups = relationship('RepoGroup')
532 532 user_groups = relationship('UserGroup')
533 533
534 534 user_followers = relationship('UserFollowing', primaryjoin='UserFollowing.follows_user_id==User.user_id', cascade='all')
535 535 followings = relationship('UserFollowing', primaryjoin='UserFollowing.user_id==User.user_id', cascade='all')
536 536
537 537 repo_to_perm = relationship('UserRepoToPerm', primaryjoin='UserRepoToPerm.user_id==User.user_id', cascade='all')
538 538 repo_group_to_perm = relationship('UserRepoGroupToPerm', primaryjoin='UserRepoGroupToPerm.user_id==User.user_id', cascade='all')
539 539 user_group_to_perm = relationship('UserUserGroupToPerm', primaryjoin='UserUserGroupToPerm.user_id==User.user_id', cascade='all')
540 540
541 541 group_member = relationship('UserGroupMember', cascade='all')
542 542
543 543 notifications = relationship('UserNotification', cascade='all')
544 544 # notifications assigned to this user
545 545 user_created_notifications = relationship('Notification', cascade='all')
546 546 # comments created by this user
547 547 user_comments = relationship('ChangesetComment', cascade='all')
548 548 # user profile extra info
549 549 user_emails = relationship('UserEmailMap', cascade='all')
550 550 user_ip_map = relationship('UserIpMap', cascade='all')
551 551 user_auth_tokens = relationship('UserApiKeys', cascade='all')
552 552 # gists
553 553 user_gists = relationship('Gist', cascade='all')
554 554 # user pull requests
555 555 user_pull_requests = relationship('PullRequest', cascade='all')
556 556 # external identities
557 557 extenal_identities = relationship(
558 558 'ExternalIdentity',
559 559 primaryjoin="User.user_id==ExternalIdentity.local_user_id",
560 560 cascade='all')
561 561
562 562 def __unicode__(self):
563 563 return u"<%s('id:%s:%s')>" % (self.__class__.__name__,
564 564 self.user_id, self.username)
565 565
566 566 @hybrid_property
567 567 def email(self):
568 568 return self._email
569 569
570 570 @email.setter
571 571 def email(self, val):
572 572 self._email = val.lower() if val else None
573 573
574 574 @hybrid_property
575 575 def first_name(self):
576 576 from rhodecode.lib import helpers as h
577 577 if self.name:
578 578 return h.escape(self.name)
579 579 return self.name
580 580
581 581 @hybrid_property
582 582 def last_name(self):
583 583 from rhodecode.lib import helpers as h
584 584 if self.lastname:
585 585 return h.escape(self.lastname)
586 586 return self.lastname
587 587
588 588 @hybrid_property
589 589 def api_key(self):
590 590 """
591 591 Fetch if exist an auth-token with role ALL connected to this user
592 592 """
593 593 user_auth_token = UserApiKeys.query()\
594 594 .filter(UserApiKeys.user_id == self.user_id)\
595 595 .filter(or_(UserApiKeys.expires == -1,
596 596 UserApiKeys.expires >= time.time()))\
597 597 .filter(UserApiKeys.role == UserApiKeys.ROLE_ALL).first()
598 598 if user_auth_token:
599 599 user_auth_token = user_auth_token.api_key
600 600
601 601 return user_auth_token
602 602
603 603 @api_key.setter
604 604 def api_key(self, val):
605 605 # don't allow to set API key this is deprecated for now
606 606 self._api_key = None
607 607
608 608 @property
609 609 def firstname(self):
610 610 # alias for future
611 611 return self.name
612 612
613 613 @property
614 614 def emails(self):
615 615 other = UserEmailMap.query().filter(UserEmailMap.user==self).all()
616 616 return [self.email] + [x.email for x in other]
617 617
618 618 @property
619 619 def auth_tokens(self):
620 620 return [x.api_key for x in self.extra_auth_tokens]
621 621
622 622 @property
623 623 def extra_auth_tokens(self):
624 624 return UserApiKeys.query().filter(UserApiKeys.user == self).all()
625 625
626 626 @property
627 627 def feed_token(self):
628 628 return self.get_feed_token()
629 629
630 630 def get_feed_token(self):
631 631 feed_tokens = UserApiKeys.query()\
632 632 .filter(UserApiKeys.user == self)\
633 633 .filter(UserApiKeys.role == UserApiKeys.ROLE_FEED)\
634 634 .all()
635 635 if feed_tokens:
636 636 return feed_tokens[0].api_key
637 637 return 'NO_FEED_TOKEN_AVAILABLE'
638 638
639 639 @classmethod
640 640 def extra_valid_auth_tokens(cls, user, role=None):
641 641 tokens = UserApiKeys.query().filter(UserApiKeys.user == user)\
642 642 .filter(or_(UserApiKeys.expires == -1,
643 643 UserApiKeys.expires >= time.time()))
644 644 if role:
645 645 tokens = tokens.filter(or_(UserApiKeys.role == role,
646 646 UserApiKeys.role == UserApiKeys.ROLE_ALL))
647 647 return tokens.all()
648 648
649 649 def authenticate_by_token(self, auth_token, roles=None, scope_repo_id=None):
650 650 from rhodecode.lib import auth
651 651
652 652 log.debug('Trying to authenticate user: %s via auth-token, '
653 653 'and roles: %s', self, roles)
654 654
655 655 if not auth_token:
656 656 return False
657 657
658 658 crypto_backend = auth.crypto_backend()
659 659
660 660 roles = (roles or []) + [UserApiKeys.ROLE_ALL]
661 661 tokens_q = UserApiKeys.query()\
662 662 .filter(UserApiKeys.user_id == self.user_id)\
663 663 .filter(or_(UserApiKeys.expires == -1,
664 664 UserApiKeys.expires >= time.time()))
665 665
666 666 tokens_q = tokens_q.filter(UserApiKeys.role.in_(roles))
667 667
668 668 plain_tokens = []
669 669 hash_tokens = []
670 670
671 671 for token in tokens_q.all():
672 672 # verify scope first
673 673 if token.repo_id:
674 674 # token has a scope, we need to verify it
675 675 if scope_repo_id != token.repo_id:
676 676 log.debug(
677 677 'Scope mismatch: token has a set repo scope: %s, '
678 678 'and calling scope is:%s, skipping further checks',
679 679 token.repo, scope_repo_id)
680 680 # token has a scope, and it doesn't match, skip token
681 681 continue
682 682
683 683 if token.api_key.startswith(crypto_backend.ENC_PREF):
684 684 hash_tokens.append(token.api_key)
685 685 else:
686 686 plain_tokens.append(token.api_key)
687 687
688 688 is_plain_match = auth_token in plain_tokens
689 689 if is_plain_match:
690 690 return True
691 691
692 692 for hashed in hash_tokens:
693 693 # TODO(marcink): this is expensive to calculate, but most secure
694 694 match = crypto_backend.hash_check(auth_token, hashed)
695 695 if match:
696 696 return True
697 697
698 698 return False
699 699
700 700 @property
701 701 def ip_addresses(self):
702 702 ret = UserIpMap.query().filter(UserIpMap.user == self).all()
703 703 return [x.ip_addr for x in ret]
704 704
705 705 @property
706 706 def username_and_name(self):
707 707 return '%s (%s %s)' % (self.username, self.first_name, self.last_name)
708 708
709 709 @property
710 710 def username_or_name_or_email(self):
711 711 full_name = self.full_name if self.full_name is not ' ' else None
712 712 return self.username or full_name or self.email
713 713
714 714 @property
715 715 def full_name(self):
716 716 return '%s %s' % (self.first_name, self.last_name)
717 717
718 718 @property
719 719 def full_name_or_username(self):
720 720 return ('%s %s' % (self.first_name, self.last_name)
721 721 if (self.first_name and self.last_name) else self.username)
722 722
723 723 @property
724 724 def full_contact(self):
725 725 return '%s %s <%s>' % (self.first_name, self.last_name, self.email)
726 726
727 727 @property
728 728 def short_contact(self):
729 729 return '%s %s' % (self.first_name, self.last_name)
730 730
731 731 @property
732 732 def is_admin(self):
733 733 return self.admin
734 734
735 735 @property
736 736 def AuthUser(self):
737 737 """
738 738 Returns instance of AuthUser for this user
739 739 """
740 740 from rhodecode.lib.auth import AuthUser
741 741 return AuthUser(user_id=self.user_id, username=self.username)
742 742
743 743 @hybrid_property
744 744 def user_data(self):
745 745 if not self._user_data:
746 746 return {}
747 747
748 748 try:
749 749 return json.loads(self._user_data)
750 750 except TypeError:
751 751 return {}
752 752
753 753 @user_data.setter
754 754 def user_data(self, val):
755 755 if not isinstance(val, dict):
756 756 raise Exception('user_data must be dict, got %s' % type(val))
757 757 try:
758 758 self._user_data = json.dumps(val)
759 759 except Exception:
760 760 log.error(traceback.format_exc())
761 761
762 762 @classmethod
763 763 def get_by_username(cls, username, case_insensitive=False,
764 764 cache=False, identity_cache=False):
765 765 session = Session()
766 766
767 767 if case_insensitive:
768 768 q = cls.query().filter(
769 769 func.lower(cls.username) == func.lower(username))
770 770 else:
771 771 q = cls.query().filter(cls.username == username)
772 772
773 773 if cache:
774 774 if identity_cache:
775 775 val = cls.identity_cache(session, 'username', username)
776 776 if val:
777 777 return val
778 778 else:
779 779 cache_key = "get_user_by_name_%s" % _hash_key(username)
780 780 q = q.options(
781 781 FromCache("sql_cache_short", cache_key))
782 782
783 783 return q.scalar()
784 784
785 785 @classmethod
786 786 def get_by_auth_token(cls, auth_token, cache=False):
787 787 q = UserApiKeys.query()\
788 788 .filter(UserApiKeys.api_key == auth_token)\
789 789 .filter(or_(UserApiKeys.expires == -1,
790 790 UserApiKeys.expires >= time.time()))
791 791 if cache:
792 792 q = q.options(
793 793 FromCache("sql_cache_short", "get_auth_token_%s" % auth_token))
794 794
795 795 match = q.first()
796 796 if match:
797 797 return match.user
798 798
799 799 @classmethod
800 800 def get_by_email(cls, email, case_insensitive=False, cache=False):
801 801
802 802 if case_insensitive:
803 803 q = cls.query().filter(func.lower(cls.email) == func.lower(email))
804 804
805 805 else:
806 806 q = cls.query().filter(cls.email == email)
807 807
808 808 email_key = _hash_key(email)
809 809 if cache:
810 810 q = q.options(
811 811 FromCache("sql_cache_short", "get_email_key_%s" % email_key))
812 812
813 813 ret = q.scalar()
814 814 if ret is None:
815 815 q = UserEmailMap.query()
816 816 # try fetching in alternate email map
817 817 if case_insensitive:
818 818 q = q.filter(func.lower(UserEmailMap.email) == func.lower(email))
819 819 else:
820 820 q = q.filter(UserEmailMap.email == email)
821 821 q = q.options(joinedload(UserEmailMap.user))
822 822 if cache:
823 823 q = q.options(
824 824 FromCache("sql_cache_short", "get_email_map_key_%s" % email_key))
825 825 ret = getattr(q.scalar(), 'user', None)
826 826
827 827 return ret
828 828
829 829 @classmethod
830 830 def get_from_cs_author(cls, author):
831 831 """
832 832 Tries to get User objects out of commit author string
833 833
834 834 :param author:
835 835 """
836 836 from rhodecode.lib.helpers import email, author_name
837 837 # Valid email in the attribute passed, see if they're in the system
838 838 _email = email(author)
839 839 if _email:
840 840 user = cls.get_by_email(_email, case_insensitive=True)
841 841 if user:
842 842 return user
843 843 # Maybe we can match by username?
844 844 _author = author_name(author)
845 845 user = cls.get_by_username(_author, case_insensitive=True)
846 846 if user:
847 847 return user
848 848
849 849 def update_userdata(self, **kwargs):
850 850 usr = self
851 851 old = usr.user_data
852 852 old.update(**kwargs)
853 853 usr.user_data = old
854 854 Session().add(usr)
855 855 log.debug('updated userdata with ', kwargs)
856 856
857 857 def update_lastlogin(self):
858 858 """Update user lastlogin"""
859 859 self.last_login = datetime.datetime.now()
860 860 Session().add(self)
861 861 log.debug('updated user %s lastlogin', self.username)
862 862
863 863 def update_lastactivity(self):
864 864 """Update user lastactivity"""
865 865 self.last_activity = datetime.datetime.now()
866 866 Session().add(self)
867 867 log.debug('updated user %s lastactivity', self.username)
868 868
869 869 def update_password(self, new_password):
870 870 from rhodecode.lib.auth import get_crypt_password
871 871
872 872 self.password = get_crypt_password(new_password)
873 873 Session().add(self)
874 874
875 875 @classmethod
876 876 def get_first_super_admin(cls):
877 877 user = User.query().filter(User.admin == true()).first()
878 878 if user is None:
879 879 raise Exception('FATAL: Missing administrative account!')
880 880 return user
881 881
882 882 @classmethod
883 883 def get_all_super_admins(cls):
884 884 """
885 885 Returns all admin accounts sorted by username
886 886 """
887 887 return User.query().filter(User.admin == true())\
888 888 .order_by(User.username.asc()).all()
889 889
890 890 @classmethod
891 891 def get_default_user(cls, cache=False, refresh=False):
892 892 user = User.get_by_username(User.DEFAULT_USER, cache=cache)
893 893 if user is None:
894 894 raise Exception('FATAL: Missing default account!')
895 895 if refresh:
896 896 # The default user might be based on outdated state which
897 897 # has been loaded from the cache.
898 898 # A call to refresh() ensures that the
899 899 # latest state from the database is used.
900 900 Session().refresh(user)
901 901 return user
902 902
903 903 def _get_default_perms(self, user, suffix=''):
904 904 from rhodecode.model.permission import PermissionModel
905 905 return PermissionModel().get_default_perms(user.user_perms, suffix)
906 906
907 907 def get_default_perms(self, suffix=''):
908 908 return self._get_default_perms(self, suffix)
909 909
910 910 def get_api_data(self, include_secrets=False, details='full'):
911 911 """
912 912 Common function for generating user related data for API
913 913
914 914 :param include_secrets: By default secrets in the API data will be replaced
915 915 by a placeholder value to prevent exposing this data by accident. In case
916 916 this data shall be exposed, set this flag to ``True``.
917 917
918 918 :param details: details can be 'basic|full' basic gives only a subset of
919 919 the available user information that includes user_id, name and emails.
920 920 """
921 921 user = self
922 922 user_data = self.user_data
923 923 data = {
924 924 'user_id': user.user_id,
925 925 'username': user.username,
926 926 'firstname': user.name,
927 927 'lastname': user.lastname,
928 928 'email': user.email,
929 929 'emails': user.emails,
930 930 }
931 931 if details == 'basic':
932 932 return data
933 933
934 934 api_key_length = 40
935 935 api_key_replacement = '*' * api_key_length
936 936
937 937 extras = {
938 938 'api_keys': [api_key_replacement],
939 939 'auth_tokens': [api_key_replacement],
940 940 'active': user.active,
941 941 'admin': user.admin,
942 942 'extern_type': user.extern_type,
943 943 'extern_name': user.extern_name,
944 944 'last_login': user.last_login,
945 945 'last_activity': user.last_activity,
946 946 'ip_addresses': user.ip_addresses,
947 947 'language': user_data.get('language')
948 948 }
949 949 data.update(extras)
950 950
951 951 if include_secrets:
952 952 data['api_keys'] = user.auth_tokens
953 953 data['auth_tokens'] = user.extra_auth_tokens
954 954 return data
955 955
956 956 def __json__(self):
957 957 data = {
958 958 'full_name': self.full_name,
959 959 'full_name_or_username': self.full_name_or_username,
960 960 'short_contact': self.short_contact,
961 961 'full_contact': self.full_contact,
962 962 }
963 963 data.update(self.get_api_data())
964 964 return data
965 965
966 966
967 967 class UserApiKeys(Base, BaseModel):
968 968 __tablename__ = 'user_api_keys'
969 969 __table_args__ = (
970 970 Index('uak_api_key_idx', 'api_key'),
971 971 Index('uak_api_key_expires_idx', 'api_key', 'expires'),
972 972 UniqueConstraint('api_key'),
973 973 {'extend_existing': True, 'mysql_engine': 'InnoDB',
974 974 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
975 975 )
976 976 __mapper_args__ = {}
977 977
978 978 # ApiKey role
979 979 ROLE_ALL = 'token_role_all'
980 980 ROLE_HTTP = 'token_role_http'
981 981 ROLE_VCS = 'token_role_vcs'
982 982 ROLE_API = 'token_role_api'
983 983 ROLE_FEED = 'token_role_feed'
984 984 ROLE_PASSWORD_RESET = 'token_password_reset'
985 985
986 986 ROLES = [ROLE_ALL, ROLE_HTTP, ROLE_VCS, ROLE_API, ROLE_FEED]
987 987
988 988 user_api_key_id = Column("user_api_key_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
989 989 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
990 990 api_key = Column("api_key", String(255), nullable=False, unique=True)
991 991 description = Column('description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
992 992 expires = Column('expires', Float(53), nullable=False)
993 993 role = Column('role', String(255), nullable=True)
994 994 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
995 995
996 996 # scope columns
997 997 repo_id = Column(
998 998 'repo_id', Integer(), ForeignKey('repositories.repo_id'),
999 999 nullable=True, unique=None, default=None)
1000 1000 repo = relationship('Repository', lazy='joined')
1001 1001
1002 1002 repo_group_id = Column(
1003 1003 'repo_group_id', Integer(), ForeignKey('groups.group_id'),
1004 1004 nullable=True, unique=None, default=None)
1005 1005 repo_group = relationship('RepoGroup', lazy='joined')
1006 1006
1007 1007 user = relationship('User', lazy='joined')
1008 1008
1009 1009 def __unicode__(self):
1010 1010 return u"<%s('%s')>" % (self.__class__.__name__, self.role)
1011 1011
1012 1012 def __json__(self):
1013 1013 data = {
1014 1014 'auth_token': self.api_key,
1015 1015 'role': self.role,
1016 1016 'scope': self.scope_humanized,
1017 1017 'expired': self.expired
1018 1018 }
1019 1019 return data
1020 1020
1021 1021 def get_api_data(self, include_secrets=False):
1022 1022 data = self.__json__()
1023 1023 if include_secrets:
1024 1024 return data
1025 1025 else:
1026 1026 data['auth_token'] = self.token_obfuscated
1027 1027 return data
1028 1028
1029 1029 @hybrid_property
1030 1030 def description_safe(self):
1031 1031 from rhodecode.lib import helpers as h
1032 1032 return h.escape(self.description)
1033 1033
1034 1034 @property
1035 1035 def expired(self):
1036 1036 if self.expires == -1:
1037 1037 return False
1038 1038 return time.time() > self.expires
1039 1039
1040 1040 @classmethod
1041 1041 def _get_role_name(cls, role):
1042 1042 return {
1043 1043 cls.ROLE_ALL: _('all'),
1044 1044 cls.ROLE_HTTP: _('http/web interface'),
1045 1045 cls.ROLE_VCS: _('vcs (git/hg/svn protocol)'),
1046 1046 cls.ROLE_API: _('api calls'),
1047 1047 cls.ROLE_FEED: _('feed access'),
1048 1048 }.get(role, role)
1049 1049
1050 1050 @property
1051 1051 def role_humanized(self):
1052 1052 return self._get_role_name(self.role)
1053 1053
1054 1054 def _get_scope(self):
1055 1055 if self.repo:
1056 1056 return repr(self.repo)
1057 1057 if self.repo_group:
1058 1058 return repr(self.repo_group) + ' (recursive)'
1059 1059 return 'global'
1060 1060
1061 1061 @property
1062 1062 def scope_humanized(self):
1063 1063 return self._get_scope()
1064 1064
1065 1065 @property
1066 1066 def token_obfuscated(self):
1067 1067 if self.api_key:
1068 1068 return self.api_key[:4] + "****"
1069 1069
1070 1070
1071 1071 class UserEmailMap(Base, BaseModel):
1072 1072 __tablename__ = 'user_email_map'
1073 1073 __table_args__ = (
1074 1074 Index('uem_email_idx', 'email'),
1075 1075 UniqueConstraint('email'),
1076 1076 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1077 1077 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
1078 1078 )
1079 1079 __mapper_args__ = {}
1080 1080
1081 1081 email_id = Column("email_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1082 1082 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1083 1083 _email = Column("email", String(255), nullable=True, unique=False, default=None)
1084 1084 user = relationship('User', lazy='joined')
1085 1085
1086 1086 @validates('_email')
1087 1087 def validate_email(self, key, email):
1088 1088 # check if this email is not main one
1089 1089 main_email = Session().query(User).filter(User.email == email).scalar()
1090 1090 if main_email is not None:
1091 1091 raise AttributeError('email %s is present is user table' % email)
1092 1092 return email
1093 1093
1094 1094 @hybrid_property
1095 1095 def email(self):
1096 1096 return self._email
1097 1097
1098 1098 @email.setter
1099 1099 def email(self, val):
1100 1100 self._email = val.lower() if val else None
1101 1101
1102 1102
1103 1103 class UserIpMap(Base, BaseModel):
1104 1104 __tablename__ = 'user_ip_map'
1105 1105 __table_args__ = (
1106 1106 UniqueConstraint('user_id', 'ip_addr'),
1107 1107 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1108 1108 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
1109 1109 )
1110 1110 __mapper_args__ = {}
1111 1111
1112 1112 ip_id = Column("ip_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1113 1113 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1114 1114 ip_addr = Column("ip_addr", String(255), nullable=True, unique=False, default=None)
1115 1115 active = Column("active", Boolean(), nullable=True, unique=None, default=True)
1116 1116 description = Column("description", String(10000), nullable=True, unique=None, default=None)
1117 1117 user = relationship('User', lazy='joined')
1118 1118
1119 1119 @hybrid_property
1120 1120 def description_safe(self):
1121 1121 from rhodecode.lib import helpers as h
1122 1122 return h.escape(self.description)
1123 1123
1124 1124 @classmethod
1125 1125 def _get_ip_range(cls, ip_addr):
1126 1126 net = ipaddress.ip_network(safe_unicode(ip_addr), strict=False)
1127 1127 return [str(net.network_address), str(net.broadcast_address)]
1128 1128
1129 1129 def __json__(self):
1130 1130 return {
1131 1131 'ip_addr': self.ip_addr,
1132 1132 'ip_range': self._get_ip_range(self.ip_addr),
1133 1133 }
1134 1134
1135 1135 def __unicode__(self):
1136 1136 return u"<%s('user_id:%s=>%s')>" % (self.__class__.__name__,
1137 1137 self.user_id, self.ip_addr)
1138 1138
1139 1139
1140 1140 class UserLog(Base, BaseModel):
1141 1141 __tablename__ = 'user_logs'
1142 1142 __table_args__ = (
1143 1143 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1144 1144 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1145 1145 )
1146 1146 VERSION_1 = 'v1'
1147 1147 VERSION_2 = 'v2'
1148 1148 VERSIONS = [VERSION_1, VERSION_2]
1149 1149
1150 1150 user_log_id = Column("user_log_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1151 1151 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1152 1152 username = Column("username", String(255), nullable=True, unique=None, default=None)
1153 1153 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=True)
1154 1154 repository_name = Column("repository_name", String(255), nullable=True, unique=None, default=None)
1155 1155 user_ip = Column("user_ip", String(255), nullable=True, unique=None, default=None)
1156 1156 action = Column("action", Text().with_variant(Text(1200000), 'mysql'), nullable=True, unique=None, default=None)
1157 1157 action_date = Column("action_date", DateTime(timezone=False), nullable=True, unique=None, default=None)
1158 1158
1159 1159 version = Column("version", String(255), nullable=True, default=VERSION_1)
1160 1160 user_data = Column('user_data_json', MutationObj.as_mutable(JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
1161 1161 action_data = Column('action_data_json', MutationObj.as_mutable(JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
1162 1162
1163 1163 def __unicode__(self):
1164 1164 return u"<%s('id:%s:%s')>" % (
1165 1165 self.__class__.__name__, self.repository_name, self.action)
1166 1166
1167 1167 def __json__(self):
1168 1168 return {
1169 1169 'user_id': self.user_id,
1170 1170 'username': self.username,
1171 1171 'repository_id': self.repository_id,
1172 1172 'repository_name': self.repository_name,
1173 1173 'user_ip': self.user_ip,
1174 1174 'action_date': self.action_date,
1175 1175 'action': self.action,
1176 1176 }
1177 1177
1178 1178 @property
1179 1179 def action_as_day(self):
1180 1180 return datetime.date(*self.action_date.timetuple()[:3])
1181 1181
1182 1182 user = relationship('User')
1183 1183 repository = relationship('Repository', cascade='')
1184 1184
1185 1185
1186 1186 class UserGroup(Base, BaseModel):
1187 1187 __tablename__ = 'users_groups'
1188 1188 __table_args__ = (
1189 1189 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1190 1190 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1191 1191 )
1192 1192
1193 1193 users_group_id = Column("users_group_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1194 1194 users_group_name = Column("users_group_name", String(255), nullable=False, unique=True, default=None)
1195 1195 user_group_description = Column("user_group_description", String(10000), nullable=True, unique=None, default=None)
1196 1196 users_group_active = Column("users_group_active", Boolean(), nullable=True, unique=None, default=None)
1197 1197 inherit_default_permissions = Column("users_group_inherit_default_permissions", Boolean(), nullable=False, unique=None, default=True)
1198 1198 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=False, default=None)
1199 1199 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1200 1200 _group_data = Column("group_data", LargeBinary(), nullable=True) # JSON data
1201 1201
1202 1202 members = relationship('UserGroupMember', cascade="all, delete, delete-orphan", lazy="joined")
1203 1203 users_group_to_perm = relationship('UserGroupToPerm', cascade='all')
1204 1204 users_group_repo_to_perm = relationship('UserGroupRepoToPerm', cascade='all')
1205 1205 users_group_repo_group_to_perm = relationship('UserGroupRepoGroupToPerm', cascade='all')
1206 1206 user_user_group_to_perm = relationship('UserUserGroupToPerm', cascade='all')
1207 1207 user_group_user_group_to_perm = relationship('UserGroupUserGroupToPerm ', primaryjoin="UserGroupUserGroupToPerm.target_user_group_id==UserGroup.users_group_id", cascade='all')
1208 1208
1209 1209 user = relationship('User')
1210 1210
1211 1211 @hybrid_property
1212 1212 def description_safe(self):
1213 1213 from rhodecode.lib import helpers as h
1214 1214 return h.escape(self.description)
1215 1215
1216 1216 @hybrid_property
1217 1217 def group_data(self):
1218 1218 if not self._group_data:
1219 1219 return {}
1220 1220
1221 1221 try:
1222 1222 return json.loads(self._group_data)
1223 1223 except TypeError:
1224 1224 return {}
1225 1225
1226 1226 @group_data.setter
1227 1227 def group_data(self, val):
1228 1228 try:
1229 1229 self._group_data = json.dumps(val)
1230 1230 except Exception:
1231 1231 log.error(traceback.format_exc())
1232 1232
1233 1233 def __unicode__(self):
1234 1234 return u"<%s('id:%s:%s')>" % (self.__class__.__name__,
1235 1235 self.users_group_id,
1236 1236 self.users_group_name)
1237 1237
1238 1238 @classmethod
1239 1239 def get_by_group_name(cls, group_name, cache=False,
1240 1240 case_insensitive=False):
1241 1241 if case_insensitive:
1242 1242 q = cls.query().filter(func.lower(cls.users_group_name) ==
1243 1243 func.lower(group_name))
1244 1244
1245 1245 else:
1246 1246 q = cls.query().filter(cls.users_group_name == group_name)
1247 1247 if cache:
1248 1248 q = q.options(
1249 1249 FromCache("sql_cache_short", "get_group_%s" % _hash_key(group_name)))
1250 1250 return q.scalar()
1251 1251
1252 1252 @classmethod
1253 1253 def get(cls, user_group_id, cache=False):
1254 1254 user_group = cls.query()
1255 1255 if cache:
1256 1256 user_group = user_group.options(
1257 1257 FromCache("sql_cache_short", "get_users_group_%s" % user_group_id))
1258 1258 return user_group.get(user_group_id)
1259 1259
1260 1260 def permissions(self, with_admins=True, with_owner=True):
1261 1261 q = UserUserGroupToPerm.query().filter(UserUserGroupToPerm.user_group == self)
1262 1262 q = q.options(joinedload(UserUserGroupToPerm.user_group),
1263 1263 joinedload(UserUserGroupToPerm.user),
1264 1264 joinedload(UserUserGroupToPerm.permission),)
1265 1265
1266 1266 # get owners and admins and permissions. We do a trick of re-writing
1267 1267 # objects from sqlalchemy to named-tuples due to sqlalchemy session
1268 1268 # has a global reference and changing one object propagates to all
1269 1269 # others. This means if admin is also an owner admin_row that change
1270 1270 # would propagate to both objects
1271 1271 perm_rows = []
1272 1272 for _usr in q.all():
1273 1273 usr = AttributeDict(_usr.user.get_dict())
1274 1274 usr.permission = _usr.permission.permission_name
1275 1275 perm_rows.append(usr)
1276 1276
1277 1277 # filter the perm rows by 'default' first and then sort them by
1278 1278 # admin,write,read,none permissions sorted again alphabetically in
1279 1279 # each group
1280 1280 perm_rows = sorted(perm_rows, key=display_sort)
1281 1281
1282 1282 _admin_perm = 'usergroup.admin'
1283 1283 owner_row = []
1284 1284 if with_owner:
1285 1285 usr = AttributeDict(self.user.get_dict())
1286 1286 usr.owner_row = True
1287 1287 usr.permission = _admin_perm
1288 1288 owner_row.append(usr)
1289 1289
1290 1290 super_admin_rows = []
1291 1291 if with_admins:
1292 1292 for usr in User.get_all_super_admins():
1293 1293 # if this admin is also owner, don't double the record
1294 1294 if usr.user_id == owner_row[0].user_id:
1295 1295 owner_row[0].admin_row = True
1296 1296 else:
1297 1297 usr = AttributeDict(usr.get_dict())
1298 1298 usr.admin_row = True
1299 1299 usr.permission = _admin_perm
1300 1300 super_admin_rows.append(usr)
1301 1301
1302 1302 return super_admin_rows + owner_row + perm_rows
1303 1303
1304 1304 def permission_user_groups(self):
1305 1305 q = UserGroupUserGroupToPerm.query().filter(UserGroupUserGroupToPerm.target_user_group == self)
1306 1306 q = q.options(joinedload(UserGroupUserGroupToPerm.user_group),
1307 1307 joinedload(UserGroupUserGroupToPerm.target_user_group),
1308 1308 joinedload(UserGroupUserGroupToPerm.permission),)
1309 1309
1310 1310 perm_rows = []
1311 1311 for _user_group in q.all():
1312 1312 usr = AttributeDict(_user_group.user_group.get_dict())
1313 1313 usr.permission = _user_group.permission.permission_name
1314 1314 perm_rows.append(usr)
1315 1315
1316 1316 return perm_rows
1317 1317
1318 1318 def _get_default_perms(self, user_group, suffix=''):
1319 1319 from rhodecode.model.permission import PermissionModel
1320 1320 return PermissionModel().get_default_perms(user_group.users_group_to_perm, suffix)
1321 1321
1322 1322 def get_default_perms(self, suffix=''):
1323 1323 return self._get_default_perms(self, suffix)
1324 1324
1325 1325 def get_api_data(self, with_group_members=True, include_secrets=False):
1326 1326 """
1327 1327 :param include_secrets: See :meth:`User.get_api_data`, this parameter is
1328 1328 basically forwarded.
1329 1329
1330 1330 """
1331 1331 user_group = self
1332 1332 data = {
1333 1333 'users_group_id': user_group.users_group_id,
1334 1334 'group_name': user_group.users_group_name,
1335 1335 'group_description': user_group.user_group_description,
1336 1336 'active': user_group.users_group_active,
1337 1337 'owner': user_group.user.username,
1338 1338 'owner_email': user_group.user.email,
1339 1339 }
1340 1340
1341 1341 if with_group_members:
1342 1342 users = []
1343 1343 for user in user_group.members:
1344 1344 user = user.user
1345 1345 users.append(user.get_api_data(include_secrets=include_secrets))
1346 1346 data['users'] = users
1347 1347
1348 1348 return data
1349 1349
1350 1350
1351 1351 class UserGroupMember(Base, BaseModel):
1352 1352 __tablename__ = 'users_groups_members'
1353 1353 __table_args__ = (
1354 1354 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1355 1355 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1356 1356 )
1357 1357
1358 1358 users_group_member_id = Column("users_group_member_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1359 1359 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
1360 1360 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
1361 1361
1362 1362 user = relationship('User', lazy='joined')
1363 1363 users_group = relationship('UserGroup')
1364 1364
1365 1365 def __init__(self, gr_id='', u_id=''):
1366 1366 self.users_group_id = gr_id
1367 1367 self.user_id = u_id
1368 1368
1369 1369
1370 1370 class RepositoryField(Base, BaseModel):
1371 1371 __tablename__ = 'repositories_fields'
1372 1372 __table_args__ = (
1373 1373 UniqueConstraint('repository_id', 'field_key'), # no-multi field
1374 1374 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1375 1375 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1376 1376 )
1377 1377 PREFIX = 'ex_' # prefix used in form to not conflict with already existing fields
1378 1378
1379 1379 repo_field_id = Column("repo_field_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1380 1380 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
1381 1381 field_key = Column("field_key", String(250))
1382 1382 field_label = Column("field_label", String(1024), nullable=False)
1383 1383 field_value = Column("field_value", String(10000), nullable=False)
1384 1384 field_desc = Column("field_desc", String(1024), nullable=False)
1385 1385 field_type = Column("field_type", String(255), nullable=False, unique=None)
1386 1386 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1387 1387
1388 1388 repository = relationship('Repository')
1389 1389
1390 1390 @property
1391 1391 def field_key_prefixed(self):
1392 1392 return 'ex_%s' % self.field_key
1393 1393
1394 1394 @classmethod
1395 1395 def un_prefix_key(cls, key):
1396 1396 if key.startswith(cls.PREFIX):
1397 1397 return key[len(cls.PREFIX):]
1398 1398 return key
1399 1399
1400 1400 @classmethod
1401 1401 def get_by_key_name(cls, key, repo):
1402 1402 row = cls.query()\
1403 1403 .filter(cls.repository == repo)\
1404 1404 .filter(cls.field_key == key).scalar()
1405 1405 return row
1406 1406
1407 1407
1408 1408 class Repository(Base, BaseModel):
1409 1409 __tablename__ = 'repositories'
1410 1410 __table_args__ = (
1411 1411 Index('r_repo_name_idx', 'repo_name', mysql_length=255),
1412 1412 {'extend_existing': True, 'mysql_engine': 'InnoDB',
1413 1413 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
1414 1414 )
1415 1415 DEFAULT_CLONE_URI = '{scheme}://{user}@{netloc}/{repo}'
1416 1416 DEFAULT_CLONE_URI_ID = '{scheme}://{user}@{netloc}/_{repoid}'
1417 1417
1418 1418 STATE_CREATED = 'repo_state_created'
1419 1419 STATE_PENDING = 'repo_state_pending'
1420 1420 STATE_ERROR = 'repo_state_error'
1421 1421
1422 1422 LOCK_AUTOMATIC = 'lock_auto'
1423 1423 LOCK_API = 'lock_api'
1424 1424 LOCK_WEB = 'lock_web'
1425 1425 LOCK_PULL = 'lock_pull'
1426 1426
1427 1427 NAME_SEP = URL_SEP
1428 1428
1429 1429 repo_id = Column(
1430 1430 "repo_id", Integer(), nullable=False, unique=True, default=None,
1431 1431 primary_key=True)
1432 1432 _repo_name = Column(
1433 1433 "repo_name", Text(), nullable=False, default=None)
1434 1434 _repo_name_hash = Column(
1435 1435 "repo_name_hash", String(255), nullable=False, unique=True)
1436 1436 repo_state = Column("repo_state", String(255), nullable=True)
1437 1437
1438 1438 clone_uri = Column(
1439 1439 "clone_uri", EncryptedTextValue(), nullable=True, unique=False,
1440 1440 default=None)
1441 1441 repo_type = Column(
1442 1442 "repo_type", String(255), nullable=False, unique=False, default=None)
1443 1443 user_id = Column(
1444 1444 "user_id", Integer(), ForeignKey('users.user_id'), nullable=False,
1445 1445 unique=False, default=None)
1446 1446 private = Column(
1447 1447 "private", Boolean(), nullable=True, unique=None, default=None)
1448 1448 enable_statistics = Column(
1449 1449 "statistics", Boolean(), nullable=True, unique=None, default=True)
1450 1450 enable_downloads = Column(
1451 1451 "downloads", Boolean(), nullable=True, unique=None, default=True)
1452 1452 description = Column(
1453 1453 "description", String(10000), nullable=True, unique=None, default=None)
1454 1454 created_on = Column(
1455 1455 'created_on', DateTime(timezone=False), nullable=True, unique=None,
1456 1456 default=datetime.datetime.now)
1457 1457 updated_on = Column(
1458 1458 'updated_on', DateTime(timezone=False), nullable=True, unique=None,
1459 1459 default=datetime.datetime.now)
1460 1460 _landing_revision = Column(
1461 1461 "landing_revision", String(255), nullable=False, unique=False,
1462 1462 default=None)
1463 1463 enable_locking = Column(
1464 1464 "enable_locking", Boolean(), nullable=False, unique=None,
1465 1465 default=False)
1466 1466 _locked = Column(
1467 1467 "locked", String(255), nullable=True, unique=False, default=None)
1468 1468 _changeset_cache = Column(
1469 1469 "changeset_cache", LargeBinary(), nullable=True) # JSON data
1470 1470
1471 1471 fork_id = Column(
1472 1472 "fork_id", Integer(), ForeignKey('repositories.repo_id'),
1473 1473 nullable=True, unique=False, default=None)
1474 1474 group_id = Column(
1475 1475 "group_id", Integer(), ForeignKey('groups.group_id'), nullable=True,
1476 1476 unique=False, default=None)
1477 1477
1478 1478 user = relationship('User', lazy='joined')
1479 1479 fork = relationship('Repository', remote_side=repo_id, lazy='joined')
1480 1480 group = relationship('RepoGroup', lazy='joined')
1481 1481 repo_to_perm = relationship(
1482 1482 'UserRepoToPerm', cascade='all',
1483 1483 order_by='UserRepoToPerm.repo_to_perm_id')
1484 1484 users_group_to_perm = relationship('UserGroupRepoToPerm', cascade='all')
1485 1485 stats = relationship('Statistics', cascade='all', uselist=False)
1486 1486
1487 1487 followers = relationship(
1488 1488 'UserFollowing',
1489 1489 primaryjoin='UserFollowing.follows_repo_id==Repository.repo_id',
1490 1490 cascade='all')
1491 1491 extra_fields = relationship(
1492 1492 'RepositoryField', cascade="all, delete, delete-orphan")
1493 1493 logs = relationship('UserLog')
1494 1494 comments = relationship(
1495 1495 'ChangesetComment', cascade="all, delete, delete-orphan")
1496 1496 pull_requests_source = relationship(
1497 1497 'PullRequest',
1498 1498 primaryjoin='PullRequest.source_repo_id==Repository.repo_id',
1499 1499 cascade="all, delete, delete-orphan")
1500 1500 pull_requests_target = relationship(
1501 1501 'PullRequest',
1502 1502 primaryjoin='PullRequest.target_repo_id==Repository.repo_id',
1503 1503 cascade="all, delete, delete-orphan")
1504 1504 ui = relationship('RepoRhodeCodeUi', cascade="all")
1505 1505 settings = relationship('RepoRhodeCodeSetting', cascade="all")
1506 1506 integrations = relationship('Integration',
1507 1507 cascade="all, delete, delete-orphan")
1508 1508
1509 1509 def __unicode__(self):
1510 1510 return u"<%s('%s:%s')>" % (self.__class__.__name__, self.repo_id,
1511 1511 safe_unicode(self.repo_name))
1512 1512
1513 1513 @hybrid_property
1514 1514 def description_safe(self):
1515 1515 from rhodecode.lib import helpers as h
1516 1516 return h.escape(self.description)
1517 1517
1518 1518 @hybrid_property
1519 1519 def landing_rev(self):
1520 1520 # always should return [rev_type, rev]
1521 1521 if self._landing_revision:
1522 1522 _rev_info = self._landing_revision.split(':')
1523 1523 if len(_rev_info) < 2:
1524 1524 _rev_info.insert(0, 'rev')
1525 1525 return [_rev_info[0], _rev_info[1]]
1526 1526 return [None, None]
1527 1527
1528 1528 @landing_rev.setter
1529 1529 def landing_rev(self, val):
1530 1530 if ':' not in val:
1531 1531 raise ValueError('value must be delimited with `:` and consist '
1532 1532 'of <rev_type>:<rev>, got %s instead' % val)
1533 1533 self._landing_revision = val
1534 1534
1535 1535 @hybrid_property
1536 1536 def locked(self):
1537 1537 if self._locked:
1538 1538 user_id, timelocked, reason = self._locked.split(':')
1539 1539 lock_values = int(user_id), timelocked, reason
1540 1540 else:
1541 1541 lock_values = [None, None, None]
1542 1542 return lock_values
1543 1543
1544 1544 @locked.setter
1545 1545 def locked(self, val):
1546 1546 if val and isinstance(val, (list, tuple)):
1547 1547 self._locked = ':'.join(map(str, val))
1548 1548 else:
1549 1549 self._locked = None
1550 1550
1551 1551 @hybrid_property
1552 1552 def changeset_cache(self):
1553 1553 from rhodecode.lib.vcs.backends.base import EmptyCommit
1554 1554 dummy = EmptyCommit().__json__()
1555 1555 if not self._changeset_cache:
1556 1556 return dummy
1557 1557 try:
1558 1558 return json.loads(self._changeset_cache)
1559 1559 except TypeError:
1560 1560 return dummy
1561 1561 except Exception:
1562 1562 log.error(traceback.format_exc())
1563 1563 return dummy
1564 1564
1565 1565 @changeset_cache.setter
1566 1566 def changeset_cache(self, val):
1567 1567 try:
1568 1568 self._changeset_cache = json.dumps(val)
1569 1569 except Exception:
1570 1570 log.error(traceback.format_exc())
1571 1571
1572 1572 @hybrid_property
1573 1573 def repo_name(self):
1574 1574 return self._repo_name
1575 1575
1576 1576 @repo_name.setter
1577 1577 def repo_name(self, value):
1578 1578 self._repo_name = value
1579 1579 self._repo_name_hash = hashlib.sha1(safe_str(value)).hexdigest()
1580 1580
1581 1581 @classmethod
1582 1582 def normalize_repo_name(cls, repo_name):
1583 1583 """
1584 1584 Normalizes os specific repo_name to the format internally stored inside
1585 1585 database using URL_SEP
1586 1586
1587 1587 :param cls:
1588 1588 :param repo_name:
1589 1589 """
1590 1590 return cls.NAME_SEP.join(repo_name.split(os.sep))
1591 1591
1592 1592 @classmethod
1593 1593 def get_by_repo_name(cls, repo_name, cache=False, identity_cache=False):
1594 1594 session = Session()
1595 1595 q = session.query(cls).filter(cls.repo_name == repo_name)
1596 1596
1597 1597 if cache:
1598 1598 if identity_cache:
1599 1599 val = cls.identity_cache(session, 'repo_name', repo_name)
1600 1600 if val:
1601 1601 return val
1602 1602 else:
1603 1603 cache_key = "get_repo_by_name_%s" % _hash_key(repo_name)
1604 1604 q = q.options(
1605 1605 FromCache("sql_cache_short", cache_key))
1606 1606
1607 1607 return q.scalar()
1608 1608
1609 1609 @classmethod
1610 1610 def get_by_full_path(cls, repo_full_path):
1611 1611 repo_name = repo_full_path.split(cls.base_path(), 1)[-1]
1612 1612 repo_name = cls.normalize_repo_name(repo_name)
1613 1613 return cls.get_by_repo_name(repo_name.strip(URL_SEP))
1614 1614
1615 1615 @classmethod
1616 1616 def get_repo_forks(cls, repo_id):
1617 1617 return cls.query().filter(Repository.fork_id == repo_id)
1618 1618
1619 1619 @classmethod
1620 1620 def base_path(cls):
1621 1621 """
1622 1622 Returns base path when all repos are stored
1623 1623
1624 1624 :param cls:
1625 1625 """
1626 1626 q = Session().query(RhodeCodeUi)\
1627 1627 .filter(RhodeCodeUi.ui_key == cls.NAME_SEP)
1628 1628 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
1629 1629 return q.one().ui_value
1630 1630
1631 1631 @classmethod
1632 1632 def is_valid(cls, repo_name):
1633 1633 """
1634 1634 returns True if given repo name is a valid filesystem repository
1635 1635
1636 1636 :param cls:
1637 1637 :param repo_name:
1638 1638 """
1639 1639 from rhodecode.lib.utils import is_valid_repo
1640 1640
1641 1641 return is_valid_repo(repo_name, cls.base_path())
1642 1642
1643 1643 @classmethod
1644 1644 def get_all_repos(cls, user_id=Optional(None), group_id=Optional(None),
1645 1645 case_insensitive=True):
1646 1646 q = Repository.query()
1647 1647
1648 1648 if not isinstance(user_id, Optional):
1649 1649 q = q.filter(Repository.user_id == user_id)
1650 1650
1651 1651 if not isinstance(group_id, Optional):
1652 1652 q = q.filter(Repository.group_id == group_id)
1653 1653
1654 1654 if case_insensitive:
1655 1655 q = q.order_by(func.lower(Repository.repo_name))
1656 1656 else:
1657 1657 q = q.order_by(Repository.repo_name)
1658 1658 return q.all()
1659 1659
1660 1660 @property
1661 1661 def forks(self):
1662 1662 """
1663 1663 Return forks of this repo
1664 1664 """
1665 1665 return Repository.get_repo_forks(self.repo_id)
1666 1666
1667 1667 @property
1668 1668 def parent(self):
1669 1669 """
1670 1670 Returns fork parent
1671 1671 """
1672 1672 return self.fork
1673 1673
1674 1674 @property
1675 1675 def just_name(self):
1676 1676 return self.repo_name.split(self.NAME_SEP)[-1]
1677 1677
1678 1678 @property
1679 1679 def groups_with_parents(self):
1680 1680 groups = []
1681 1681 if self.group is None:
1682 1682 return groups
1683 1683
1684 1684 cur_gr = self.group
1685 1685 groups.insert(0, cur_gr)
1686 1686 while 1:
1687 1687 gr = getattr(cur_gr, 'parent_group', None)
1688 1688 cur_gr = cur_gr.parent_group
1689 1689 if gr is None:
1690 1690 break
1691 1691 groups.insert(0, gr)
1692 1692
1693 1693 return groups
1694 1694
1695 1695 @property
1696 1696 def groups_and_repo(self):
1697 1697 return self.groups_with_parents, self
1698 1698
1699 1699 @LazyProperty
1700 1700 def repo_path(self):
1701 1701 """
1702 1702 Returns base full path for that repository means where it actually
1703 1703 exists on a filesystem
1704 1704 """
1705 1705 q = Session().query(RhodeCodeUi).filter(
1706 1706 RhodeCodeUi.ui_key == self.NAME_SEP)
1707 1707 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
1708 1708 return q.one().ui_value
1709 1709
1710 1710 @property
1711 1711 def repo_full_path(self):
1712 1712 p = [self.repo_path]
1713 1713 # we need to split the name by / since this is how we store the
1714 1714 # names in the database, but that eventually needs to be converted
1715 1715 # into a valid system path
1716 1716 p += self.repo_name.split(self.NAME_SEP)
1717 1717 return os.path.join(*map(safe_unicode, p))
1718 1718
1719 1719 @property
1720 1720 def cache_keys(self):
1721 1721 """
1722 1722 Returns associated cache keys for that repo
1723 1723 """
1724 1724 return CacheKey.query()\
1725 1725 .filter(CacheKey.cache_args == self.repo_name)\
1726 1726 .order_by(CacheKey.cache_key)\
1727 1727 .all()
1728 1728
1729 1729 def get_new_name(self, repo_name):
1730 1730 """
1731 1731 returns new full repository name based on assigned group and new new
1732 1732
1733 1733 :param group_name:
1734 1734 """
1735 1735 path_prefix = self.group.full_path_splitted if self.group else []
1736 1736 return self.NAME_SEP.join(path_prefix + [repo_name])
1737 1737
1738 1738 @property
1739 1739 def _config(self):
1740 1740 """
1741 1741 Returns db based config object.
1742 1742 """
1743 1743 from rhodecode.lib.utils import make_db_config
1744 1744 return make_db_config(clear_session=False, repo=self)
1745 1745
1746 1746 def permissions(self, with_admins=True, with_owner=True):
1747 1747 q = UserRepoToPerm.query().filter(UserRepoToPerm.repository == self)
1748 1748 q = q.options(joinedload(UserRepoToPerm.repository),
1749 1749 joinedload(UserRepoToPerm.user),
1750 1750 joinedload(UserRepoToPerm.permission),)
1751 1751
1752 1752 # get owners and admins and permissions. We do a trick of re-writing
1753 1753 # objects from sqlalchemy to named-tuples due to sqlalchemy session
1754 1754 # has a global reference and changing one object propagates to all
1755 1755 # others. This means if admin is also an owner admin_row that change
1756 1756 # would propagate to both objects
1757 1757 perm_rows = []
1758 1758 for _usr in q.all():
1759 1759 usr = AttributeDict(_usr.user.get_dict())
1760 1760 usr.permission = _usr.permission.permission_name
1761 1761 perm_rows.append(usr)
1762 1762
1763 1763 # filter the perm rows by 'default' first and then sort them by
1764 1764 # admin,write,read,none permissions sorted again alphabetically in
1765 1765 # each group
1766 1766 perm_rows = sorted(perm_rows, key=display_sort)
1767 1767
1768 1768 _admin_perm = 'repository.admin'
1769 1769 owner_row = []
1770 1770 if with_owner:
1771 1771 usr = AttributeDict(self.user.get_dict())
1772 1772 usr.owner_row = True
1773 1773 usr.permission = _admin_perm
1774 1774 owner_row.append(usr)
1775 1775
1776 1776 super_admin_rows = []
1777 1777 if with_admins:
1778 1778 for usr in User.get_all_super_admins():
1779 1779 # if this admin is also owner, don't double the record
1780 1780 if usr.user_id == owner_row[0].user_id:
1781 1781 owner_row[0].admin_row = True
1782 1782 else:
1783 1783 usr = AttributeDict(usr.get_dict())
1784 1784 usr.admin_row = True
1785 1785 usr.permission = _admin_perm
1786 1786 super_admin_rows.append(usr)
1787 1787
1788 1788 return super_admin_rows + owner_row + perm_rows
1789 1789
1790 1790 def permission_user_groups(self):
1791 1791 q = UserGroupRepoToPerm.query().filter(
1792 1792 UserGroupRepoToPerm.repository == self)
1793 1793 q = q.options(joinedload(UserGroupRepoToPerm.repository),
1794 1794 joinedload(UserGroupRepoToPerm.users_group),
1795 1795 joinedload(UserGroupRepoToPerm.permission),)
1796 1796
1797 1797 perm_rows = []
1798 1798 for _user_group in q.all():
1799 1799 usr = AttributeDict(_user_group.users_group.get_dict())
1800 1800 usr.permission = _user_group.permission.permission_name
1801 1801 perm_rows.append(usr)
1802 1802
1803 1803 return perm_rows
1804 1804
1805 1805 def get_api_data(self, include_secrets=False):
1806 1806 """
1807 1807 Common function for generating repo api data
1808 1808
1809 1809 :param include_secrets: See :meth:`User.get_api_data`.
1810 1810
1811 1811 """
1812 1812 # TODO: mikhail: Here there is an anti-pattern, we probably need to
1813 1813 # move this methods on models level.
1814 1814 from rhodecode.model.settings import SettingsModel
1815 1815 from rhodecode.model.repo import RepoModel
1816 1816
1817 1817 repo = self
1818 1818 _user_id, _time, _reason = self.locked
1819 1819
1820 1820 data = {
1821 1821 'repo_id': repo.repo_id,
1822 1822 'repo_name': repo.repo_name,
1823 1823 'repo_type': repo.repo_type,
1824 1824 'clone_uri': repo.clone_uri or '',
1825 1825 'url': RepoModel().get_url(self),
1826 1826 'private': repo.private,
1827 1827 'created_on': repo.created_on,
1828 1828 'description': repo.description_safe,
1829 1829 'landing_rev': repo.landing_rev,
1830 1830 'owner': repo.user.username,
1831 1831 'fork_of': repo.fork.repo_name if repo.fork else None,
1832 1832 'fork_of_id': repo.fork.repo_id if repo.fork else None,
1833 1833 'enable_statistics': repo.enable_statistics,
1834 1834 'enable_locking': repo.enable_locking,
1835 1835 'enable_downloads': repo.enable_downloads,
1836 1836 'last_changeset': repo.changeset_cache,
1837 1837 'locked_by': User.get(_user_id).get_api_data(
1838 1838 include_secrets=include_secrets) if _user_id else None,
1839 1839 'locked_date': time_to_datetime(_time) if _time else None,
1840 1840 'lock_reason': _reason if _reason else None,
1841 1841 }
1842 1842
1843 1843 # TODO: mikhail: should be per-repo settings here
1844 1844 rc_config = SettingsModel().get_all_settings()
1845 1845 repository_fields = str2bool(
1846 1846 rc_config.get('rhodecode_repository_fields'))
1847 1847 if repository_fields:
1848 1848 for f in self.extra_fields:
1849 1849 data[f.field_key_prefixed] = f.field_value
1850 1850
1851 1851 return data
1852 1852
1853 1853 @classmethod
1854 1854 def lock(cls, repo, user_id, lock_time=None, lock_reason=None):
1855 1855 if not lock_time:
1856 1856 lock_time = time.time()
1857 1857 if not lock_reason:
1858 1858 lock_reason = cls.LOCK_AUTOMATIC
1859 1859 repo.locked = [user_id, lock_time, lock_reason]
1860 1860 Session().add(repo)
1861 1861 Session().commit()
1862 1862
1863 1863 @classmethod
1864 1864 def unlock(cls, repo):
1865 1865 repo.locked = None
1866 1866 Session().add(repo)
1867 1867 Session().commit()
1868 1868
1869 1869 @classmethod
1870 1870 def getlock(cls, repo):
1871 1871 return repo.locked
1872 1872
1873 1873 def is_user_lock(self, user_id):
1874 1874 if self.lock[0]:
1875 1875 lock_user_id = safe_int(self.lock[0])
1876 1876 user_id = safe_int(user_id)
1877 1877 # both are ints, and they are equal
1878 1878 return all([lock_user_id, user_id]) and lock_user_id == user_id
1879 1879
1880 1880 return False
1881 1881
1882 1882 def get_locking_state(self, action, user_id, only_when_enabled=True):
1883 1883 """
1884 1884 Checks locking on this repository, if locking is enabled and lock is
1885 1885 present returns a tuple of make_lock, locked, locked_by.
1886 1886 make_lock can have 3 states None (do nothing) True, make lock
1887 1887 False release lock, This value is later propagated to hooks, which
1888 1888 do the locking. Think about this as signals passed to hooks what to do.
1889 1889
1890 1890 """
1891 1891 # TODO: johbo: This is part of the business logic and should be moved
1892 1892 # into the RepositoryModel.
1893 1893
1894 1894 if action not in ('push', 'pull'):
1895 1895 raise ValueError("Invalid action value: %s" % repr(action))
1896 1896
1897 1897 # defines if locked error should be thrown to user
1898 1898 currently_locked = False
1899 1899 # defines if new lock should be made, tri-state
1900 1900 make_lock = None
1901 1901 repo = self
1902 1902 user = User.get(user_id)
1903 1903
1904 1904 lock_info = repo.locked
1905 1905
1906 1906 if repo and (repo.enable_locking or not only_when_enabled):
1907 1907 if action == 'push':
1908 1908 # check if it's already locked !, if it is compare users
1909 1909 locked_by_user_id = lock_info[0]
1910 1910 if user.user_id == locked_by_user_id:
1911 1911 log.debug(
1912 1912 'Got `push` action from user %s, now unlocking', user)
1913 1913 # unlock if we have push from user who locked
1914 1914 make_lock = False
1915 1915 else:
1916 1916 # we're not the same user who locked, ban with
1917 1917 # code defined in settings (default is 423 HTTP Locked) !
1918 1918 log.debug('Repo %s is currently locked by %s', repo, user)
1919 1919 currently_locked = True
1920 1920 elif action == 'pull':
1921 1921 # [0] user [1] date
1922 1922 if lock_info[0] and lock_info[1]:
1923 1923 log.debug('Repo %s is currently locked by %s', repo, user)
1924 1924 currently_locked = True
1925 1925 else:
1926 1926 log.debug('Setting lock on repo %s by %s', repo, user)
1927 1927 make_lock = True
1928 1928
1929 1929 else:
1930 1930 log.debug('Repository %s do not have locking enabled', repo)
1931 1931
1932 1932 log.debug('FINAL locking values make_lock:%s,locked:%s,locked_by:%s',
1933 1933 make_lock, currently_locked, lock_info)
1934 1934
1935 1935 from rhodecode.lib.auth import HasRepoPermissionAny
1936 1936 perm_check = HasRepoPermissionAny('repository.write', 'repository.admin')
1937 1937 if make_lock and not perm_check(repo_name=repo.repo_name, user=user):
1938 1938 # if we don't have at least write permission we cannot make a lock
1939 1939 log.debug('lock state reset back to FALSE due to lack '
1940 1940 'of at least read permission')
1941 1941 make_lock = False
1942 1942
1943 1943 return make_lock, currently_locked, lock_info
1944 1944
1945 1945 @property
1946 1946 def last_db_change(self):
1947 1947 return self.updated_on
1948 1948
1949 1949 @property
1950 1950 def clone_uri_hidden(self):
1951 1951 clone_uri = self.clone_uri
1952 1952 if clone_uri:
1953 1953 import urlobject
1954 1954 url_obj = urlobject.URLObject(cleaned_uri(clone_uri))
1955 1955 if url_obj.password:
1956 1956 clone_uri = url_obj.with_password('*****')
1957 1957 return clone_uri
1958 1958
1959 1959 def clone_url(self, **override):
1960 1960 from rhodecode.model.settings import SettingsModel
1961 1961
1962 1962 uri_tmpl = None
1963 1963 if 'with_id' in override:
1964 1964 uri_tmpl = self.DEFAULT_CLONE_URI_ID
1965 1965 del override['with_id']
1966 1966
1967 1967 if 'uri_tmpl' in override:
1968 1968 uri_tmpl = override['uri_tmpl']
1969 1969 del override['uri_tmpl']
1970 1970
1971 1971 # we didn't override our tmpl from **overrides
1972 1972 if not uri_tmpl:
1973 1973 rc_config = SettingsModel().get_all_settings(cache=True)
1974 1974 uri_tmpl = rc_config.get(
1975 1975 'rhodecode_clone_uri_tmpl') or self.DEFAULT_CLONE_URI
1976 1976
1977 1977 request = get_current_request()
1978 1978 return get_clone_url(request=request,
1979 1979 uri_tmpl=uri_tmpl,
1980 1980 repo_name=self.repo_name,
1981 1981 repo_id=self.repo_id, **override)
1982 1982
1983 1983 def set_state(self, state):
1984 1984 self.repo_state = state
1985 1985 Session().add(self)
1986 1986 #==========================================================================
1987 1987 # SCM PROPERTIES
1988 1988 #==========================================================================
1989 1989
1990 1990 def get_commit(self, commit_id=None, commit_idx=None, pre_load=None):
1991 1991 return get_commit_safe(
1992 1992 self.scm_instance(), commit_id, commit_idx, pre_load=pre_load)
1993 1993
1994 1994 def get_changeset(self, rev=None, pre_load=None):
1995 1995 warnings.warn("Use get_commit", DeprecationWarning)
1996 1996 commit_id = None
1997 1997 commit_idx = None
1998 1998 if isinstance(rev, basestring):
1999 1999 commit_id = rev
2000 2000 else:
2001 2001 commit_idx = rev
2002 2002 return self.get_commit(commit_id=commit_id, commit_idx=commit_idx,
2003 2003 pre_load=pre_load)
2004 2004
2005 2005 def get_landing_commit(self):
2006 2006 """
2007 2007 Returns landing commit, or if that doesn't exist returns the tip
2008 2008 """
2009 2009 _rev_type, _rev = self.landing_rev
2010 2010 commit = self.get_commit(_rev)
2011 2011 if isinstance(commit, EmptyCommit):
2012 2012 return self.get_commit()
2013 2013 return commit
2014 2014
2015 2015 def update_commit_cache(self, cs_cache=None, config=None):
2016 2016 """
2017 2017 Update cache of last changeset for repository, keys should be::
2018 2018
2019 2019 short_id
2020 2020 raw_id
2021 2021 revision
2022 2022 parents
2023 2023 message
2024 2024 date
2025 2025 author
2026 2026
2027 2027 :param cs_cache:
2028 2028 """
2029 2029 from rhodecode.lib.vcs.backends.base import BaseChangeset
2030 2030 if cs_cache is None:
2031 2031 # use no-cache version here
2032 2032 scm_repo = self.scm_instance(cache=False, config=config)
2033 2033 if scm_repo:
2034 2034 cs_cache = scm_repo.get_commit(
2035 2035 pre_load=["author", "date", "message", "parents"])
2036 2036 else:
2037 2037 cs_cache = EmptyCommit()
2038 2038
2039 2039 if isinstance(cs_cache, BaseChangeset):
2040 2040 cs_cache = cs_cache.__json__()
2041 2041
2042 2042 def is_outdated(new_cs_cache):
2043 2043 if (new_cs_cache['raw_id'] != self.changeset_cache['raw_id'] or
2044 2044 new_cs_cache['revision'] != self.changeset_cache['revision']):
2045 2045 return True
2046 2046 return False
2047 2047
2048 2048 # check if we have maybe already latest cached revision
2049 2049 if is_outdated(cs_cache) or not self.changeset_cache:
2050 2050 _default = datetime.datetime.fromtimestamp(0)
2051 2051 last_change = cs_cache.get('date') or _default
2052 2052 log.debug('updated repo %s with new cs cache %s',
2053 2053 self.repo_name, cs_cache)
2054 2054 self.updated_on = last_change
2055 2055 self.changeset_cache = cs_cache
2056 2056 Session().add(self)
2057 2057 Session().commit()
2058 2058 else:
2059 2059 log.debug('Skipping update_commit_cache for repo:`%s` '
2060 2060 'commit already with latest changes', self.repo_name)
2061 2061
2062 2062 @property
2063 2063 def tip(self):
2064 2064 return self.get_commit('tip')
2065 2065
2066 2066 @property
2067 2067 def author(self):
2068 2068 return self.tip.author
2069 2069
2070 2070 @property
2071 2071 def last_change(self):
2072 2072 return self.scm_instance().last_change
2073 2073
2074 2074 def get_comments(self, revisions=None):
2075 2075 """
2076 2076 Returns comments for this repository grouped by revisions
2077 2077
2078 2078 :param revisions: filter query by revisions only
2079 2079 """
2080 2080 cmts = ChangesetComment.query()\
2081 2081 .filter(ChangesetComment.repo == self)
2082 2082 if revisions:
2083 2083 cmts = cmts.filter(ChangesetComment.revision.in_(revisions))
2084 2084 grouped = collections.defaultdict(list)
2085 2085 for cmt in cmts.all():
2086 2086 grouped[cmt.revision].append(cmt)
2087 2087 return grouped
2088 2088
2089 2089 def statuses(self, revisions=None):
2090 2090 """
2091 2091 Returns statuses for this repository
2092 2092
2093 2093 :param revisions: list of revisions to get statuses for
2094 2094 """
2095 2095 statuses = ChangesetStatus.query()\
2096 2096 .filter(ChangesetStatus.repo == self)\
2097 2097 .filter(ChangesetStatus.version == 0)
2098 2098
2099 2099 if revisions:
2100 2100 # Try doing the filtering in chunks to avoid hitting limits
2101 2101 size = 500
2102 2102 status_results = []
2103 2103 for chunk in xrange(0, len(revisions), size):
2104 2104 status_results += statuses.filter(
2105 2105 ChangesetStatus.revision.in_(
2106 2106 revisions[chunk: chunk+size])
2107 2107 ).all()
2108 2108 else:
2109 2109 status_results = statuses.all()
2110 2110
2111 2111 grouped = {}
2112 2112
2113 2113 # maybe we have open new pullrequest without a status?
2114 2114 stat = ChangesetStatus.STATUS_UNDER_REVIEW
2115 2115 status_lbl = ChangesetStatus.get_status_lbl(stat)
2116 2116 for pr in PullRequest.query().filter(PullRequest.source_repo == self).all():
2117 2117 for rev in pr.revisions:
2118 2118 pr_id = pr.pull_request_id
2119 2119 pr_repo = pr.target_repo.repo_name
2120 2120 grouped[rev] = [stat, status_lbl, pr_id, pr_repo]
2121 2121
2122 2122 for stat in status_results:
2123 2123 pr_id = pr_repo = None
2124 2124 if stat.pull_request:
2125 2125 pr_id = stat.pull_request.pull_request_id
2126 2126 pr_repo = stat.pull_request.target_repo.repo_name
2127 2127 grouped[stat.revision] = [str(stat.status), stat.status_lbl,
2128 2128 pr_id, pr_repo]
2129 2129 return grouped
2130 2130
2131 2131 # ==========================================================================
2132 2132 # SCM CACHE INSTANCE
2133 2133 # ==========================================================================
2134 2134
2135 2135 def scm_instance(self, **kwargs):
2136 2136 import rhodecode
2137 2137
2138 2138 # Passing a config will not hit the cache currently only used
2139 2139 # for repo2dbmapper
2140 2140 config = kwargs.pop('config', None)
2141 2141 cache = kwargs.pop('cache', None)
2142 2142 full_cache = str2bool(rhodecode.CONFIG.get('vcs_full_cache'))
2143 2143 # if cache is NOT defined use default global, else we have a full
2144 2144 # control over cache behaviour
2145 2145 if cache is None and full_cache and not config:
2146 2146 return self._get_instance_cached()
2147 2147 return self._get_instance(cache=bool(cache), config=config)
2148 2148
2149 2149 def _get_instance_cached(self):
2150 2150 @cache_region('long_term')
2151 2151 def _get_repo(cache_key):
2152 2152 return self._get_instance()
2153 2153
2154 2154 invalidator_context = CacheKey.repo_context_cache(
2155 2155 _get_repo, self.repo_name, None, thread_scoped=True)
2156 2156
2157 2157 with invalidator_context as context:
2158 2158 context.invalidate()
2159 2159 repo = context.compute()
2160 2160
2161 2161 return repo
2162 2162
2163 2163 def _get_instance(self, cache=True, config=None):
2164 2164 config = config or self._config
2165 2165 custom_wire = {
2166 2166 'cache': cache # controls the vcs.remote cache
2167 2167 }
2168 2168 repo = get_vcs_instance(
2169 2169 repo_path=safe_str(self.repo_full_path),
2170 2170 config=config,
2171 2171 with_wire=custom_wire,
2172 2172 create=False,
2173 2173 _vcs_alias=self.repo_type)
2174 2174
2175 2175 return repo
2176 2176
2177 2177 def __json__(self):
2178 2178 return {'landing_rev': self.landing_rev}
2179 2179
2180 2180 def get_dict(self):
2181 2181
2182 2182 # Since we transformed `repo_name` to a hybrid property, we need to
2183 2183 # keep compatibility with the code which uses `repo_name` field.
2184 2184
2185 2185 result = super(Repository, self).get_dict()
2186 2186 result['repo_name'] = result.pop('_repo_name', None)
2187 2187 return result
2188 2188
2189 2189
2190 2190 class RepoGroup(Base, BaseModel):
2191 2191 __tablename__ = 'groups'
2192 2192 __table_args__ = (
2193 2193 UniqueConstraint('group_name', 'group_parent_id'),
2194 2194 CheckConstraint('group_id != group_parent_id'),
2195 2195 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2196 2196 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
2197 2197 )
2198 2198 __mapper_args__ = {'order_by': 'group_name'}
2199 2199
2200 2200 CHOICES_SEPARATOR = '/' # used to generate select2 choices for nested groups
2201 2201
2202 2202 group_id = Column("group_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2203 2203 group_name = Column("group_name", String(255), nullable=False, unique=True, default=None)
2204 2204 group_parent_id = Column("group_parent_id", Integer(), ForeignKey('groups.group_id'), nullable=True, unique=None, default=None)
2205 2205 group_description = Column("group_description", String(10000), nullable=True, unique=None, default=None)
2206 2206 enable_locking = Column("enable_locking", Boolean(), nullable=False, unique=None, default=False)
2207 2207 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=False, default=None)
2208 2208 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
2209 2209 personal = Column('personal', Boolean(), nullable=True, unique=None, default=None)
2210 2210
2211 2211 repo_group_to_perm = relationship('UserRepoGroupToPerm', cascade='all', order_by='UserRepoGroupToPerm.group_to_perm_id')
2212 2212 users_group_to_perm = relationship('UserGroupRepoGroupToPerm', cascade='all')
2213 2213 parent_group = relationship('RepoGroup', remote_side=group_id)
2214 2214 user = relationship('User')
2215 2215 integrations = relationship('Integration',
2216 2216 cascade="all, delete, delete-orphan")
2217 2217
2218 2218 def __init__(self, group_name='', parent_group=None):
2219 2219 self.group_name = group_name
2220 2220 self.parent_group = parent_group
2221 2221
2222 2222 def __unicode__(self):
2223 2223 return u"<%s('id:%s:%s')>" % (
2224 2224 self.__class__.__name__, self.group_id, self.group_name)
2225 2225
2226 2226 @hybrid_property
2227 2227 def description_safe(self):
2228 2228 from rhodecode.lib import helpers as h
2229 2229 return h.escape(self.group_description)
2230 2230
2231 2231 @classmethod
2232 2232 def _generate_choice(cls, repo_group):
2233 2233 from webhelpers.html import literal as _literal
2234 2234 _name = lambda k: _literal(cls.CHOICES_SEPARATOR.join(k))
2235 2235 return repo_group.group_id, _name(repo_group.full_path_splitted)
2236 2236
2237 2237 @classmethod
2238 2238 def groups_choices(cls, groups=None, show_empty_group=True):
2239 2239 if not groups:
2240 2240 groups = cls.query().all()
2241 2241
2242 2242 repo_groups = []
2243 2243 if show_empty_group:
2244 2244 repo_groups = [(-1, u'-- %s --' % _('No parent'))]
2245 2245
2246 2246 repo_groups.extend([cls._generate_choice(x) for x in groups])
2247 2247
2248 2248 repo_groups = sorted(
2249 2249 repo_groups, key=lambda t: t[1].split(cls.CHOICES_SEPARATOR)[0])
2250 2250 return repo_groups
2251 2251
2252 2252 @classmethod
2253 2253 def url_sep(cls):
2254 2254 return URL_SEP
2255 2255
2256 2256 @classmethod
2257 2257 def get_by_group_name(cls, group_name, cache=False, case_insensitive=False):
2258 2258 if case_insensitive:
2259 2259 gr = cls.query().filter(func.lower(cls.group_name)
2260 2260 == func.lower(group_name))
2261 2261 else:
2262 2262 gr = cls.query().filter(cls.group_name == group_name)
2263 2263 if cache:
2264 2264 name_key = _hash_key(group_name)
2265 2265 gr = gr.options(
2266 2266 FromCache("sql_cache_short", "get_group_%s" % name_key))
2267 2267 return gr.scalar()
2268 2268
2269 2269 @classmethod
2270 2270 def get_user_personal_repo_group(cls, user_id):
2271 2271 user = User.get(user_id)
2272 2272 if user.username == User.DEFAULT_USER:
2273 2273 return None
2274 2274
2275 2275 return cls.query()\
2276 2276 .filter(cls.personal == true()) \
2277 2277 .filter(cls.user == user).scalar()
2278 2278
2279 2279 @classmethod
2280 2280 def get_all_repo_groups(cls, user_id=Optional(None), group_id=Optional(None),
2281 2281 case_insensitive=True):
2282 2282 q = RepoGroup.query()
2283 2283
2284 2284 if not isinstance(user_id, Optional):
2285 2285 q = q.filter(RepoGroup.user_id == user_id)
2286 2286
2287 2287 if not isinstance(group_id, Optional):
2288 2288 q = q.filter(RepoGroup.group_parent_id == group_id)
2289 2289
2290 2290 if case_insensitive:
2291 2291 q = q.order_by(func.lower(RepoGroup.group_name))
2292 2292 else:
2293 2293 q = q.order_by(RepoGroup.group_name)
2294 2294 return q.all()
2295 2295
2296 2296 @property
2297 2297 def parents(self):
2298 2298 parents_recursion_limit = 10
2299 2299 groups = []
2300 2300 if self.parent_group is None:
2301 2301 return groups
2302 2302 cur_gr = self.parent_group
2303 2303 groups.insert(0, cur_gr)
2304 2304 cnt = 0
2305 2305 while 1:
2306 2306 cnt += 1
2307 2307 gr = getattr(cur_gr, 'parent_group', None)
2308 2308 cur_gr = cur_gr.parent_group
2309 2309 if gr is None:
2310 2310 break
2311 2311 if cnt == parents_recursion_limit:
2312 2312 # this will prevent accidental infinit loops
2313 2313 log.error(('more than %s parents found for group %s, stopping '
2314 2314 'recursive parent fetching' % (parents_recursion_limit, self)))
2315 2315 break
2316 2316
2317 2317 groups.insert(0, gr)
2318 2318 return groups
2319 2319
2320 2320 @property
2321 2321 def children(self):
2322 2322 return RepoGroup.query().filter(RepoGroup.parent_group == self)
2323 2323
2324 2324 @property
2325 2325 def name(self):
2326 2326 return self.group_name.split(RepoGroup.url_sep())[-1]
2327 2327
2328 2328 @property
2329 2329 def full_path(self):
2330 2330 return self.group_name
2331 2331
2332 2332 @property
2333 2333 def full_path_splitted(self):
2334 2334 return self.group_name.split(RepoGroup.url_sep())
2335 2335
2336 2336 @property
2337 2337 def repositories(self):
2338 2338 return Repository.query()\
2339 2339 .filter(Repository.group == self)\
2340 2340 .order_by(Repository.repo_name)
2341 2341
2342 2342 @property
2343 2343 def repositories_recursive_count(self):
2344 2344 cnt = self.repositories.count()
2345 2345
2346 2346 def children_count(group):
2347 2347 cnt = 0
2348 2348 for child in group.children:
2349 2349 cnt += child.repositories.count()
2350 2350 cnt += children_count(child)
2351 2351 return cnt
2352 2352
2353 2353 return cnt + children_count(self)
2354 2354
2355 2355 def _recursive_objects(self, include_repos=True):
2356 2356 all_ = []
2357 2357
2358 2358 def _get_members(root_gr):
2359 2359 if include_repos:
2360 2360 for r in root_gr.repositories:
2361 2361 all_.append(r)
2362 2362 childs = root_gr.children.all()
2363 2363 if childs:
2364 2364 for gr in childs:
2365 2365 all_.append(gr)
2366 2366 _get_members(gr)
2367 2367
2368 2368 _get_members(self)
2369 2369 return [self] + all_
2370 2370
2371 2371 def recursive_groups_and_repos(self):
2372 2372 """
2373 2373 Recursive return all groups, with repositories in those groups
2374 2374 """
2375 2375 return self._recursive_objects()
2376 2376
2377 2377 def recursive_groups(self):
2378 2378 """
2379 2379 Returns all children groups for this group including children of children
2380 2380 """
2381 2381 return self._recursive_objects(include_repos=False)
2382 2382
2383 2383 def get_new_name(self, group_name):
2384 2384 """
2385 2385 returns new full group name based on parent and new name
2386 2386
2387 2387 :param group_name:
2388 2388 """
2389 2389 path_prefix = (self.parent_group.full_path_splitted if
2390 2390 self.parent_group else [])
2391 2391 return RepoGroup.url_sep().join(path_prefix + [group_name])
2392 2392
2393 2393 def permissions(self, with_admins=True, with_owner=True):
2394 2394 q = UserRepoGroupToPerm.query().filter(UserRepoGroupToPerm.group == self)
2395 2395 q = q.options(joinedload(UserRepoGroupToPerm.group),
2396 2396 joinedload(UserRepoGroupToPerm.user),
2397 2397 joinedload(UserRepoGroupToPerm.permission),)
2398 2398
2399 2399 # get owners and admins and permissions. We do a trick of re-writing
2400 2400 # objects from sqlalchemy to named-tuples due to sqlalchemy session
2401 2401 # has a global reference and changing one object propagates to all
2402 2402 # others. This means if admin is also an owner admin_row that change
2403 2403 # would propagate to both objects
2404 2404 perm_rows = []
2405 2405 for _usr in q.all():
2406 2406 usr = AttributeDict(_usr.user.get_dict())
2407 2407 usr.permission = _usr.permission.permission_name
2408 2408 perm_rows.append(usr)
2409 2409
2410 2410 # filter the perm rows by 'default' first and then sort them by
2411 2411 # admin,write,read,none permissions sorted again alphabetically in
2412 2412 # each group
2413 2413 perm_rows = sorted(perm_rows, key=display_sort)
2414 2414
2415 2415 _admin_perm = 'group.admin'
2416 2416 owner_row = []
2417 2417 if with_owner:
2418 2418 usr = AttributeDict(self.user.get_dict())
2419 2419 usr.owner_row = True
2420 2420 usr.permission = _admin_perm
2421 2421 owner_row.append(usr)
2422 2422
2423 2423 super_admin_rows = []
2424 2424 if with_admins:
2425 2425 for usr in User.get_all_super_admins():
2426 2426 # if this admin is also owner, don't double the record
2427 2427 if usr.user_id == owner_row[0].user_id:
2428 2428 owner_row[0].admin_row = True
2429 2429 else:
2430 2430 usr = AttributeDict(usr.get_dict())
2431 2431 usr.admin_row = True
2432 2432 usr.permission = _admin_perm
2433 2433 super_admin_rows.append(usr)
2434 2434
2435 2435 return super_admin_rows + owner_row + perm_rows
2436 2436
2437 2437 def permission_user_groups(self):
2438 2438 q = UserGroupRepoGroupToPerm.query().filter(UserGroupRepoGroupToPerm.group == self)
2439 2439 q = q.options(joinedload(UserGroupRepoGroupToPerm.group),
2440 2440 joinedload(UserGroupRepoGroupToPerm.users_group),
2441 2441 joinedload(UserGroupRepoGroupToPerm.permission),)
2442 2442
2443 2443 perm_rows = []
2444 2444 for _user_group in q.all():
2445 2445 usr = AttributeDict(_user_group.users_group.get_dict())
2446 2446 usr.permission = _user_group.permission.permission_name
2447 2447 perm_rows.append(usr)
2448 2448
2449 2449 return perm_rows
2450 2450
2451 2451 def get_api_data(self):
2452 2452 """
2453 2453 Common function for generating api data
2454 2454
2455 2455 """
2456 2456 group = self
2457 2457 data = {
2458 2458 'group_id': group.group_id,
2459 2459 'group_name': group.group_name,
2460 2460 'group_description': group.description_safe,
2461 2461 'parent_group': group.parent_group.group_name if group.parent_group else None,
2462 2462 'repositories': [x.repo_name for x in group.repositories],
2463 2463 'owner': group.user.username,
2464 2464 }
2465 2465 return data
2466 2466
2467 2467
2468 2468 class Permission(Base, BaseModel):
2469 2469 __tablename__ = 'permissions'
2470 2470 __table_args__ = (
2471 2471 Index('p_perm_name_idx', 'permission_name'),
2472 2472 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2473 2473 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
2474 2474 )
2475 2475 PERMS = [
2476 2476 ('hg.admin', _('RhodeCode Super Administrator')),
2477 2477
2478 2478 ('repository.none', _('Repository no access')),
2479 2479 ('repository.read', _('Repository read access')),
2480 2480 ('repository.write', _('Repository write access')),
2481 2481 ('repository.admin', _('Repository admin access')),
2482 2482
2483 2483 ('group.none', _('Repository group no access')),
2484 2484 ('group.read', _('Repository group read access')),
2485 2485 ('group.write', _('Repository group write access')),
2486 2486 ('group.admin', _('Repository group admin access')),
2487 2487
2488 2488 ('usergroup.none', _('User group no access')),
2489 2489 ('usergroup.read', _('User group read access')),
2490 2490 ('usergroup.write', _('User group write access')),
2491 2491 ('usergroup.admin', _('User group admin access')),
2492 2492
2493 2493 ('hg.repogroup.create.false', _('Repository Group creation disabled')),
2494 2494 ('hg.repogroup.create.true', _('Repository Group creation enabled')),
2495 2495
2496 2496 ('hg.usergroup.create.false', _('User Group creation disabled')),
2497 2497 ('hg.usergroup.create.true', _('User Group creation enabled')),
2498 2498
2499 2499 ('hg.create.none', _('Repository creation disabled')),
2500 2500 ('hg.create.repository', _('Repository creation enabled')),
2501 2501 ('hg.create.write_on_repogroup.true', _('Repository creation enabled with write permission to a repository group')),
2502 2502 ('hg.create.write_on_repogroup.false', _('Repository creation disabled with write permission to a repository group')),
2503 2503
2504 2504 ('hg.fork.none', _('Repository forking disabled')),
2505 2505 ('hg.fork.repository', _('Repository forking enabled')),
2506 2506
2507 2507 ('hg.register.none', _('Registration disabled')),
2508 2508 ('hg.register.manual_activate', _('User Registration with manual account activation')),
2509 2509 ('hg.register.auto_activate', _('User Registration with automatic account activation')),
2510 2510
2511 2511 ('hg.password_reset.enabled', _('Password reset enabled')),
2512 2512 ('hg.password_reset.hidden', _('Password reset hidden')),
2513 2513 ('hg.password_reset.disabled', _('Password reset disabled')),
2514 2514
2515 2515 ('hg.extern_activate.manual', _('Manual activation of external account')),
2516 2516 ('hg.extern_activate.auto', _('Automatic activation of external account')),
2517 2517
2518 2518 ('hg.inherit_default_perms.false', _('Inherit object permissions from default user disabled')),
2519 2519 ('hg.inherit_default_perms.true', _('Inherit object permissions from default user enabled')),
2520 2520 ]
2521 2521
2522 2522 # definition of system default permissions for DEFAULT user
2523 2523 DEFAULT_USER_PERMISSIONS = [
2524 2524 'repository.read',
2525 2525 'group.read',
2526 2526 'usergroup.read',
2527 2527 'hg.create.repository',
2528 2528 'hg.repogroup.create.false',
2529 2529 'hg.usergroup.create.false',
2530 2530 'hg.create.write_on_repogroup.true',
2531 2531 'hg.fork.repository',
2532 2532 'hg.register.manual_activate',
2533 2533 'hg.password_reset.enabled',
2534 2534 'hg.extern_activate.auto',
2535 2535 'hg.inherit_default_perms.true',
2536 2536 ]
2537 2537
2538 2538 # defines which permissions are more important higher the more important
2539 2539 # Weight defines which permissions are more important.
2540 2540 # The higher number the more important.
2541 2541 PERM_WEIGHTS = {
2542 2542 'repository.none': 0,
2543 2543 'repository.read': 1,
2544 2544 'repository.write': 3,
2545 2545 'repository.admin': 4,
2546 2546
2547 2547 'group.none': 0,
2548 2548 'group.read': 1,
2549 2549 'group.write': 3,
2550 2550 'group.admin': 4,
2551 2551
2552 2552 'usergroup.none': 0,
2553 2553 'usergroup.read': 1,
2554 2554 'usergroup.write': 3,
2555 2555 'usergroup.admin': 4,
2556 2556
2557 2557 'hg.repogroup.create.false': 0,
2558 2558 'hg.repogroup.create.true': 1,
2559 2559
2560 2560 'hg.usergroup.create.false': 0,
2561 2561 'hg.usergroup.create.true': 1,
2562 2562
2563 2563 'hg.fork.none': 0,
2564 2564 'hg.fork.repository': 1,
2565 2565 'hg.create.none': 0,
2566 2566 'hg.create.repository': 1
2567 2567 }
2568 2568
2569 2569 permission_id = Column("permission_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2570 2570 permission_name = Column("permission_name", String(255), nullable=True, unique=None, default=None)
2571 2571 permission_longname = Column("permission_longname", String(255), nullable=True, unique=None, default=None)
2572 2572
2573 2573 def __unicode__(self):
2574 2574 return u"<%s('%s:%s')>" % (
2575 2575 self.__class__.__name__, self.permission_id, self.permission_name
2576 2576 )
2577 2577
2578 2578 @classmethod
2579 2579 def get_by_key(cls, key):
2580 2580 return cls.query().filter(cls.permission_name == key).scalar()
2581 2581
2582 2582 @classmethod
2583 2583 def get_default_repo_perms(cls, user_id, repo_id=None):
2584 2584 q = Session().query(UserRepoToPerm, Repository, Permission)\
2585 2585 .join((Permission, UserRepoToPerm.permission_id == Permission.permission_id))\
2586 2586 .join((Repository, UserRepoToPerm.repository_id == Repository.repo_id))\
2587 2587 .filter(UserRepoToPerm.user_id == user_id)
2588 2588 if repo_id:
2589 2589 q = q.filter(UserRepoToPerm.repository_id == repo_id)
2590 2590 return q.all()
2591 2591
2592 2592 @classmethod
2593 2593 def get_default_repo_perms_from_user_group(cls, user_id, repo_id=None):
2594 2594 q = Session().query(UserGroupRepoToPerm, Repository, Permission)\
2595 2595 .join(
2596 2596 Permission,
2597 2597 UserGroupRepoToPerm.permission_id == Permission.permission_id)\
2598 2598 .join(
2599 2599 Repository,
2600 2600 UserGroupRepoToPerm.repository_id == Repository.repo_id)\
2601 2601 .join(
2602 2602 UserGroup,
2603 2603 UserGroupRepoToPerm.users_group_id ==
2604 2604 UserGroup.users_group_id)\
2605 2605 .join(
2606 2606 UserGroupMember,
2607 2607 UserGroupRepoToPerm.users_group_id ==
2608 2608 UserGroupMember.users_group_id)\
2609 2609 .filter(
2610 2610 UserGroupMember.user_id == user_id,
2611 2611 UserGroup.users_group_active == true())
2612 2612 if repo_id:
2613 2613 q = q.filter(UserGroupRepoToPerm.repository_id == repo_id)
2614 2614 return q.all()
2615 2615
2616 2616 @classmethod
2617 2617 def get_default_group_perms(cls, user_id, repo_group_id=None):
2618 2618 q = Session().query(UserRepoGroupToPerm, RepoGroup, Permission)\
2619 2619 .join((Permission, UserRepoGroupToPerm.permission_id == Permission.permission_id))\
2620 2620 .join((RepoGroup, UserRepoGroupToPerm.group_id == RepoGroup.group_id))\
2621 2621 .filter(UserRepoGroupToPerm.user_id == user_id)
2622 2622 if repo_group_id:
2623 2623 q = q.filter(UserRepoGroupToPerm.group_id == repo_group_id)
2624 2624 return q.all()
2625 2625
2626 2626 @classmethod
2627 2627 def get_default_group_perms_from_user_group(
2628 2628 cls, user_id, repo_group_id=None):
2629 2629 q = Session().query(UserGroupRepoGroupToPerm, RepoGroup, Permission)\
2630 2630 .join(
2631 2631 Permission,
2632 2632 UserGroupRepoGroupToPerm.permission_id ==
2633 2633 Permission.permission_id)\
2634 2634 .join(
2635 2635 RepoGroup,
2636 2636 UserGroupRepoGroupToPerm.group_id == RepoGroup.group_id)\
2637 2637 .join(
2638 2638 UserGroup,
2639 2639 UserGroupRepoGroupToPerm.users_group_id ==
2640 2640 UserGroup.users_group_id)\
2641 2641 .join(
2642 2642 UserGroupMember,
2643 2643 UserGroupRepoGroupToPerm.users_group_id ==
2644 2644 UserGroupMember.users_group_id)\
2645 2645 .filter(
2646 2646 UserGroupMember.user_id == user_id,
2647 2647 UserGroup.users_group_active == true())
2648 2648 if repo_group_id:
2649 2649 q = q.filter(UserGroupRepoGroupToPerm.group_id == repo_group_id)
2650 2650 return q.all()
2651 2651
2652 2652 @classmethod
2653 2653 def get_default_user_group_perms(cls, user_id, user_group_id=None):
2654 2654 q = Session().query(UserUserGroupToPerm, UserGroup, Permission)\
2655 2655 .join((Permission, UserUserGroupToPerm.permission_id == Permission.permission_id))\
2656 2656 .join((UserGroup, UserUserGroupToPerm.user_group_id == UserGroup.users_group_id))\
2657 2657 .filter(UserUserGroupToPerm.user_id == user_id)
2658 2658 if user_group_id:
2659 2659 q = q.filter(UserUserGroupToPerm.user_group_id == user_group_id)
2660 2660 return q.all()
2661 2661
2662 2662 @classmethod
2663 2663 def get_default_user_group_perms_from_user_group(
2664 2664 cls, user_id, user_group_id=None):
2665 2665 TargetUserGroup = aliased(UserGroup, name='target_user_group')
2666 2666 q = Session().query(UserGroupUserGroupToPerm, UserGroup, Permission)\
2667 2667 .join(
2668 2668 Permission,
2669 2669 UserGroupUserGroupToPerm.permission_id ==
2670 2670 Permission.permission_id)\
2671 2671 .join(
2672 2672 TargetUserGroup,
2673 2673 UserGroupUserGroupToPerm.target_user_group_id ==
2674 2674 TargetUserGroup.users_group_id)\
2675 2675 .join(
2676 2676 UserGroup,
2677 2677 UserGroupUserGroupToPerm.user_group_id ==
2678 2678 UserGroup.users_group_id)\
2679 2679 .join(
2680 2680 UserGroupMember,
2681 2681 UserGroupUserGroupToPerm.user_group_id ==
2682 2682 UserGroupMember.users_group_id)\
2683 2683 .filter(
2684 2684 UserGroupMember.user_id == user_id,
2685 2685 UserGroup.users_group_active == true())
2686 2686 if user_group_id:
2687 2687 q = q.filter(
2688 2688 UserGroupUserGroupToPerm.user_group_id == user_group_id)
2689 2689
2690 2690 return q.all()
2691 2691
2692 2692
2693 2693 class UserRepoToPerm(Base, BaseModel):
2694 2694 __tablename__ = 'repo_to_perm'
2695 2695 __table_args__ = (
2696 2696 UniqueConstraint('user_id', 'repository_id', 'permission_id'),
2697 2697 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2698 2698 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2699 2699 )
2700 2700 repo_to_perm_id = Column("repo_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2701 2701 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2702 2702 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2703 2703 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
2704 2704
2705 2705 user = relationship('User')
2706 2706 repository = relationship('Repository')
2707 2707 permission = relationship('Permission')
2708 2708
2709 2709 @classmethod
2710 2710 def create(cls, user, repository, permission):
2711 2711 n = cls()
2712 2712 n.user = user
2713 2713 n.repository = repository
2714 2714 n.permission = permission
2715 2715 Session().add(n)
2716 2716 return n
2717 2717
2718 2718 def __unicode__(self):
2719 2719 return u'<%s => %s >' % (self.user, self.repository)
2720 2720
2721 2721
2722 2722 class UserUserGroupToPerm(Base, BaseModel):
2723 2723 __tablename__ = 'user_user_group_to_perm'
2724 2724 __table_args__ = (
2725 2725 UniqueConstraint('user_id', 'user_group_id', 'permission_id'),
2726 2726 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2727 2727 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2728 2728 )
2729 2729 user_user_group_to_perm_id = Column("user_user_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2730 2730 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2731 2731 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2732 2732 user_group_id = Column("user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2733 2733
2734 2734 user = relationship('User')
2735 2735 user_group = relationship('UserGroup')
2736 2736 permission = relationship('Permission')
2737 2737
2738 2738 @classmethod
2739 2739 def create(cls, user, user_group, permission):
2740 2740 n = cls()
2741 2741 n.user = user
2742 2742 n.user_group = user_group
2743 2743 n.permission = permission
2744 2744 Session().add(n)
2745 2745 return n
2746 2746
2747 2747 def __unicode__(self):
2748 2748 return u'<%s => %s >' % (self.user, self.user_group)
2749 2749
2750 2750
2751 2751 class UserToPerm(Base, BaseModel):
2752 2752 __tablename__ = 'user_to_perm'
2753 2753 __table_args__ = (
2754 2754 UniqueConstraint('user_id', 'permission_id'),
2755 2755 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2756 2756 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2757 2757 )
2758 2758 user_to_perm_id = Column("user_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2759 2759 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2760 2760 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2761 2761
2762 2762 user = relationship('User')
2763 2763 permission = relationship('Permission', lazy='joined')
2764 2764
2765 2765 def __unicode__(self):
2766 2766 return u'<%s => %s >' % (self.user, self.permission)
2767 2767
2768 2768
2769 2769 class UserGroupRepoToPerm(Base, BaseModel):
2770 2770 __tablename__ = 'users_group_repo_to_perm'
2771 2771 __table_args__ = (
2772 2772 UniqueConstraint('repository_id', 'users_group_id', 'permission_id'),
2773 2773 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2774 2774 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2775 2775 )
2776 2776 users_group_to_perm_id = Column("users_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2777 2777 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2778 2778 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2779 2779 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
2780 2780
2781 2781 users_group = relationship('UserGroup')
2782 2782 permission = relationship('Permission')
2783 2783 repository = relationship('Repository')
2784 2784
2785 2785 @classmethod
2786 2786 def create(cls, users_group, repository, permission):
2787 2787 n = cls()
2788 2788 n.users_group = users_group
2789 2789 n.repository = repository
2790 2790 n.permission = permission
2791 2791 Session().add(n)
2792 2792 return n
2793 2793
2794 2794 def __unicode__(self):
2795 2795 return u'<UserGroupRepoToPerm:%s => %s >' % (self.users_group, self.repository)
2796 2796
2797 2797
2798 2798 class UserGroupUserGroupToPerm(Base, BaseModel):
2799 2799 __tablename__ = 'user_group_user_group_to_perm'
2800 2800 __table_args__ = (
2801 2801 UniqueConstraint('target_user_group_id', 'user_group_id', 'permission_id'),
2802 2802 CheckConstraint('target_user_group_id != user_group_id'),
2803 2803 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2804 2804 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2805 2805 )
2806 2806 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)
2807 2807 target_user_group_id = Column("target_user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2808 2808 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2809 2809 user_group_id = Column("user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2810 2810
2811 2811 target_user_group = relationship('UserGroup', primaryjoin='UserGroupUserGroupToPerm.target_user_group_id==UserGroup.users_group_id')
2812 2812 user_group = relationship('UserGroup', primaryjoin='UserGroupUserGroupToPerm.user_group_id==UserGroup.users_group_id')
2813 2813 permission = relationship('Permission')
2814 2814
2815 2815 @classmethod
2816 2816 def create(cls, target_user_group, user_group, permission):
2817 2817 n = cls()
2818 2818 n.target_user_group = target_user_group
2819 2819 n.user_group = user_group
2820 2820 n.permission = permission
2821 2821 Session().add(n)
2822 2822 return n
2823 2823
2824 2824 def __unicode__(self):
2825 2825 return u'<UserGroupUserGroup:%s => %s >' % (self.target_user_group, self.user_group)
2826 2826
2827 2827
2828 2828 class UserGroupToPerm(Base, BaseModel):
2829 2829 __tablename__ = 'users_group_to_perm'
2830 2830 __table_args__ = (
2831 2831 UniqueConstraint('users_group_id', 'permission_id',),
2832 2832 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2833 2833 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2834 2834 )
2835 2835 users_group_to_perm_id = Column("users_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2836 2836 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2837 2837 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2838 2838
2839 2839 users_group = relationship('UserGroup')
2840 2840 permission = relationship('Permission')
2841 2841
2842 2842
2843 2843 class UserRepoGroupToPerm(Base, BaseModel):
2844 2844 __tablename__ = 'user_repo_group_to_perm'
2845 2845 __table_args__ = (
2846 2846 UniqueConstraint('user_id', 'group_id', 'permission_id'),
2847 2847 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2848 2848 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2849 2849 )
2850 2850
2851 2851 group_to_perm_id = Column("group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2852 2852 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2853 2853 group_id = Column("group_id", Integer(), ForeignKey('groups.group_id'), nullable=False, unique=None, default=None)
2854 2854 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2855 2855
2856 2856 user = relationship('User')
2857 2857 group = relationship('RepoGroup')
2858 2858 permission = relationship('Permission')
2859 2859
2860 2860 @classmethod
2861 2861 def create(cls, user, repository_group, permission):
2862 2862 n = cls()
2863 2863 n.user = user
2864 2864 n.group = repository_group
2865 2865 n.permission = permission
2866 2866 Session().add(n)
2867 2867 return n
2868 2868
2869 2869
2870 2870 class UserGroupRepoGroupToPerm(Base, BaseModel):
2871 2871 __tablename__ = 'users_group_repo_group_to_perm'
2872 2872 __table_args__ = (
2873 2873 UniqueConstraint('users_group_id', 'group_id'),
2874 2874 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2875 2875 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2876 2876 )
2877 2877
2878 2878 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)
2879 2879 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2880 2880 group_id = Column("group_id", Integer(), ForeignKey('groups.group_id'), nullable=False, unique=None, default=None)
2881 2881 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2882 2882
2883 2883 users_group = relationship('UserGroup')
2884 2884 permission = relationship('Permission')
2885 2885 group = relationship('RepoGroup')
2886 2886
2887 2887 @classmethod
2888 2888 def create(cls, user_group, repository_group, permission):
2889 2889 n = cls()
2890 2890 n.users_group = user_group
2891 2891 n.group = repository_group
2892 2892 n.permission = permission
2893 2893 Session().add(n)
2894 2894 return n
2895 2895
2896 2896 def __unicode__(self):
2897 2897 return u'<UserGroupRepoGroupToPerm:%s => %s >' % (self.users_group, self.group)
2898 2898
2899 2899
2900 2900 class Statistics(Base, BaseModel):
2901 2901 __tablename__ = 'statistics'
2902 2902 __table_args__ = (
2903 2903 UniqueConstraint('repository_id'),
2904 2904 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2905 2905 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2906 2906 )
2907 2907 stat_id = Column("stat_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2908 2908 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=True, default=None)
2909 2909 stat_on_revision = Column("stat_on_revision", Integer(), nullable=False)
2910 2910 commit_activity = Column("commit_activity", LargeBinary(1000000), nullable=False)#JSON data
2911 2911 commit_activity_combined = Column("commit_activity_combined", LargeBinary(), nullable=False)#JSON data
2912 2912 languages = Column("languages", LargeBinary(1000000), nullable=False)#JSON data
2913 2913
2914 2914 repository = relationship('Repository', single_parent=True)
2915 2915
2916 2916
2917 2917 class UserFollowing(Base, BaseModel):
2918 2918 __tablename__ = 'user_followings'
2919 2919 __table_args__ = (
2920 2920 UniqueConstraint('user_id', 'follows_repository_id'),
2921 2921 UniqueConstraint('user_id', 'follows_user_id'),
2922 2922 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2923 2923 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
2924 2924 )
2925 2925
2926 2926 user_following_id = Column("user_following_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2927 2927 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2928 2928 follows_repo_id = Column("follows_repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=True, unique=None, default=None)
2929 2929 follows_user_id = Column("follows_user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
2930 2930 follows_from = Column('follows_from', DateTime(timezone=False), nullable=True, unique=None, default=datetime.datetime.now)
2931 2931
2932 2932 user = relationship('User', primaryjoin='User.user_id==UserFollowing.user_id')
2933 2933
2934 2934 follows_user = relationship('User', primaryjoin='User.user_id==UserFollowing.follows_user_id')
2935 2935 follows_repository = relationship('Repository', order_by='Repository.repo_name')
2936 2936
2937 2937 @classmethod
2938 2938 def get_repo_followers(cls, repo_id):
2939 2939 return cls.query().filter(cls.follows_repo_id == repo_id)
2940 2940
2941 2941
2942 2942 class CacheKey(Base, BaseModel):
2943 2943 __tablename__ = 'cache_invalidation'
2944 2944 __table_args__ = (
2945 2945 UniqueConstraint('cache_key'),
2946 2946 Index('key_idx', 'cache_key'),
2947 2947 {'extend_existing': True, 'mysql_engine': 'InnoDB',
2948 2948 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
2949 2949 )
2950 2950 CACHE_TYPE_ATOM = 'ATOM'
2951 2951 CACHE_TYPE_RSS = 'RSS'
2952 2952 CACHE_TYPE_README = 'README'
2953 2953
2954 2954 cache_id = Column("cache_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2955 2955 cache_key = Column("cache_key", String(255), nullable=True, unique=None, default=None)
2956 2956 cache_args = Column("cache_args", String(255), nullable=True, unique=None, default=None)
2957 2957 cache_active = Column("cache_active", Boolean(), nullable=True, unique=None, default=False)
2958 2958
2959 2959 def __init__(self, cache_key, cache_args=''):
2960 2960 self.cache_key = cache_key
2961 2961 self.cache_args = cache_args
2962 2962 self.cache_active = False
2963 2963
2964 2964 def __unicode__(self):
2965 2965 return u"<%s('%s:%s[%s]')>" % (
2966 2966 self.__class__.__name__,
2967 2967 self.cache_id, self.cache_key, self.cache_active)
2968 2968
2969 2969 def _cache_key_partition(self):
2970 2970 prefix, repo_name, suffix = self.cache_key.partition(self.cache_args)
2971 2971 return prefix, repo_name, suffix
2972 2972
2973 2973 def get_prefix(self):
2974 2974 """
2975 2975 Try to extract prefix from existing cache key. The key could consist
2976 2976 of prefix, repo_name, suffix
2977 2977 """
2978 2978 # this returns prefix, repo_name, suffix
2979 2979 return self._cache_key_partition()[0]
2980 2980
2981 2981 def get_suffix(self):
2982 2982 """
2983 2983 get suffix that might have been used in _get_cache_key to
2984 2984 generate self.cache_key. Only used for informational purposes
2985 2985 in repo_edit.mako.
2986 2986 """
2987 2987 # prefix, repo_name, suffix
2988 2988 return self._cache_key_partition()[2]
2989 2989
2990 2990 @classmethod
2991 2991 def delete_all_cache(cls):
2992 2992 """
2993 2993 Delete all cache keys from database.
2994 2994 Should only be run when all instances are down and all entries
2995 2995 thus stale.
2996 2996 """
2997 2997 cls.query().delete()
2998 2998 Session().commit()
2999 2999
3000 3000 @classmethod
3001 3001 def get_cache_key(cls, repo_name, cache_type):
3002 3002 """
3003 3003
3004 3004 Generate a cache key for this process of RhodeCode instance.
3005 3005 Prefix most likely will be process id or maybe explicitly set
3006 3006 instance_id from .ini file.
3007 3007 """
3008 3008 import rhodecode
3009 3009 prefix = safe_unicode(rhodecode.CONFIG.get('instance_id') or '')
3010 3010
3011 3011 repo_as_unicode = safe_unicode(repo_name)
3012 3012 key = u'{}_{}'.format(repo_as_unicode, cache_type) \
3013 3013 if cache_type else repo_as_unicode
3014 3014
3015 3015 return u'{}{}'.format(prefix, key)
3016 3016
3017 3017 @classmethod
3018 3018 def set_invalidate(cls, repo_name, delete=False):
3019 3019 """
3020 3020 Mark all caches of a repo as invalid in the database.
3021 3021 """
3022 3022
3023 3023 try:
3024 3024 qry = Session().query(cls).filter(cls.cache_args == repo_name)
3025 3025 if delete:
3026 3026 log.debug('cache objects deleted for repo %s',
3027 3027 safe_str(repo_name))
3028 3028 qry.delete()
3029 3029 else:
3030 3030 log.debug('cache objects marked as invalid for repo %s',
3031 3031 safe_str(repo_name))
3032 3032 qry.update({"cache_active": False})
3033 3033
3034 3034 Session().commit()
3035 3035 except Exception:
3036 3036 log.exception(
3037 3037 'Cache key invalidation failed for repository %s',
3038 3038 safe_str(repo_name))
3039 3039 Session().rollback()
3040 3040
3041 3041 @classmethod
3042 3042 def get_active_cache(cls, cache_key):
3043 3043 inv_obj = cls.query().filter(cls.cache_key == cache_key).scalar()
3044 3044 if inv_obj:
3045 3045 return inv_obj
3046 3046 return None
3047 3047
3048 3048 @classmethod
3049 3049 def repo_context_cache(cls, compute_func, repo_name, cache_type,
3050 3050 thread_scoped=False):
3051 3051 """
3052 3052 @cache_region('long_term')
3053 3053 def _heavy_calculation(cache_key):
3054 3054 return 'result'
3055 3055
3056 3056 cache_context = CacheKey.repo_context_cache(
3057 3057 _heavy_calculation, repo_name, cache_type)
3058 3058
3059 3059 with cache_context as context:
3060 3060 context.invalidate()
3061 3061 computed = context.compute()
3062 3062
3063 3063 assert computed == 'result'
3064 3064 """
3065 3065 from rhodecode.lib import caches
3066 3066 return caches.InvalidationContext(
3067 3067 compute_func, repo_name, cache_type, thread_scoped=thread_scoped)
3068 3068
3069 3069
3070 3070 class ChangesetComment(Base, BaseModel):
3071 3071 __tablename__ = 'changeset_comments'
3072 3072 __table_args__ = (
3073 3073 Index('cc_revision_idx', 'revision'),
3074 3074 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3075 3075 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3076 3076 )
3077 3077
3078 3078 COMMENT_OUTDATED = u'comment_outdated'
3079 3079 COMMENT_TYPE_NOTE = u'note'
3080 3080 COMMENT_TYPE_TODO = u'todo'
3081 3081 COMMENT_TYPES = [COMMENT_TYPE_NOTE, COMMENT_TYPE_TODO]
3082 3082
3083 3083 comment_id = Column('comment_id', Integer(), nullable=False, primary_key=True)
3084 3084 repo_id = Column('repo_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False)
3085 3085 revision = Column('revision', String(40), nullable=True)
3086 3086 pull_request_id = Column("pull_request_id", Integer(), ForeignKey('pull_requests.pull_request_id'), nullable=True)
3087 3087 pull_request_version_id = Column("pull_request_version_id", Integer(), ForeignKey('pull_request_versions.pull_request_version_id'), nullable=True)
3088 3088 line_no = Column('line_no', Unicode(10), nullable=True)
3089 3089 hl_lines = Column('hl_lines', Unicode(512), nullable=True)
3090 3090 f_path = Column('f_path', Unicode(1000), nullable=True)
3091 3091 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=False)
3092 3092 text = Column('text', UnicodeText().with_variant(UnicodeText(25000), 'mysql'), nullable=False)
3093 3093 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3094 3094 modified_at = Column('modified_at', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3095 3095 renderer = Column('renderer', Unicode(64), nullable=True)
3096 3096 display_state = Column('display_state', Unicode(128), nullable=True)
3097 3097
3098 3098 comment_type = Column('comment_type', Unicode(128), nullable=True, default=COMMENT_TYPE_NOTE)
3099 3099 resolved_comment_id = Column('resolved_comment_id', Integer(), ForeignKey('changeset_comments.comment_id'), nullable=True)
3100 3100 resolved_comment = relationship('ChangesetComment', remote_side=comment_id, backref='resolved_by')
3101 3101 author = relationship('User', lazy='joined')
3102 3102 repo = relationship('Repository')
3103 3103 status_change = relationship('ChangesetStatus', cascade="all, delete, delete-orphan", lazy='joined')
3104 3104 pull_request = relationship('PullRequest', lazy='joined')
3105 3105 pull_request_version = relationship('PullRequestVersion')
3106 3106
3107 3107 @classmethod
3108 3108 def get_users(cls, revision=None, pull_request_id=None):
3109 3109 """
3110 3110 Returns user associated with this ChangesetComment. ie those
3111 3111 who actually commented
3112 3112
3113 3113 :param cls:
3114 3114 :param revision:
3115 3115 """
3116 3116 q = Session().query(User)\
3117 3117 .join(ChangesetComment.author)
3118 3118 if revision:
3119 3119 q = q.filter(cls.revision == revision)
3120 3120 elif pull_request_id:
3121 3121 q = q.filter(cls.pull_request_id == pull_request_id)
3122 3122 return q.all()
3123 3123
3124 3124 @classmethod
3125 3125 def get_index_from_version(cls, pr_version, versions):
3126 3126 num_versions = [x.pull_request_version_id for x in versions]
3127 3127 try:
3128 3128 return num_versions.index(pr_version) +1
3129 3129 except (IndexError, ValueError):
3130 3130 return
3131 3131
3132 3132 @property
3133 3133 def outdated(self):
3134 3134 return self.display_state == self.COMMENT_OUTDATED
3135 3135
3136 3136 def outdated_at_version(self, version):
3137 3137 """
3138 3138 Checks if comment is outdated for given pull request version
3139 3139 """
3140 3140 return self.outdated and self.pull_request_version_id != version
3141 3141
3142 3142 def older_than_version(self, version):
3143 3143 """
3144 3144 Checks if comment is made from previous version than given
3145 3145 """
3146 3146 if version is None:
3147 3147 return self.pull_request_version_id is not None
3148 3148
3149 3149 return self.pull_request_version_id < version
3150 3150
3151 3151 @property
3152 3152 def resolved(self):
3153 3153 return self.resolved_by[0] if self.resolved_by else None
3154 3154
3155 3155 @property
3156 3156 def is_todo(self):
3157 3157 return self.comment_type == self.COMMENT_TYPE_TODO
3158 3158
3159 3159 @property
3160 3160 def is_inline(self):
3161 3161 return self.line_no and self.f_path
3162 3162
3163 3163 def get_index_version(self, versions):
3164 3164 return self.get_index_from_version(
3165 3165 self.pull_request_version_id, versions)
3166 3166
3167 3167 def __repr__(self):
3168 3168 if self.comment_id:
3169 3169 return '<DB:Comment #%s>' % self.comment_id
3170 3170 else:
3171 3171 return '<DB:Comment at %#x>' % id(self)
3172 3172
3173 3173 def get_api_data(self):
3174 3174 comment = self
3175 3175 data = {
3176 3176 'comment_id': comment.comment_id,
3177 3177 'comment_type': comment.comment_type,
3178 3178 'comment_text': comment.text,
3179 3179 'comment_status': comment.status_change,
3180 3180 'comment_f_path': comment.f_path,
3181 3181 'comment_lineno': comment.line_no,
3182 3182 'comment_author': comment.author,
3183 3183 'comment_created_on': comment.created_on
3184 3184 }
3185 3185 return data
3186 3186
3187 3187 def __json__(self):
3188 3188 data = dict()
3189 3189 data.update(self.get_api_data())
3190 3190 return data
3191 3191
3192 3192
3193 3193 class ChangesetStatus(Base, BaseModel):
3194 3194 __tablename__ = 'changeset_statuses'
3195 3195 __table_args__ = (
3196 3196 Index('cs_revision_idx', 'revision'),
3197 3197 Index('cs_version_idx', 'version'),
3198 3198 UniqueConstraint('repo_id', 'revision', 'version'),
3199 3199 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3200 3200 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3201 3201 )
3202 3202 STATUS_NOT_REVIEWED = DEFAULT = 'not_reviewed'
3203 3203 STATUS_APPROVED = 'approved'
3204 3204 STATUS_REJECTED = 'rejected'
3205 3205 STATUS_UNDER_REVIEW = 'under_review'
3206 3206
3207 3207 STATUSES = [
3208 3208 (STATUS_NOT_REVIEWED, _("Not Reviewed")), # (no icon) and default
3209 3209 (STATUS_APPROVED, _("Approved")),
3210 3210 (STATUS_REJECTED, _("Rejected")),
3211 3211 (STATUS_UNDER_REVIEW, _("Under Review")),
3212 3212 ]
3213 3213
3214 3214 changeset_status_id = Column('changeset_status_id', Integer(), nullable=False, primary_key=True)
3215 3215 repo_id = Column('repo_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False)
3216 3216 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None)
3217 3217 revision = Column('revision', String(40), nullable=False)
3218 3218 status = Column('status', String(128), nullable=False, default=DEFAULT)
3219 3219 changeset_comment_id = Column('changeset_comment_id', Integer(), ForeignKey('changeset_comments.comment_id'))
3220 3220 modified_at = Column('modified_at', DateTime(), nullable=False, default=datetime.datetime.now)
3221 3221 version = Column('version', Integer(), nullable=False, default=0)
3222 3222 pull_request_id = Column("pull_request_id", Integer(), ForeignKey('pull_requests.pull_request_id'), nullable=True)
3223 3223
3224 3224 author = relationship('User', lazy='joined')
3225 3225 repo = relationship('Repository')
3226 3226 comment = relationship('ChangesetComment', lazy='joined')
3227 3227 pull_request = relationship('PullRequest', lazy='joined')
3228 3228
3229 3229 def __unicode__(self):
3230 3230 return u"<%s('%s[v%s]:%s')>" % (
3231 3231 self.__class__.__name__,
3232 3232 self.status, self.version, self.author
3233 3233 )
3234 3234
3235 3235 @classmethod
3236 3236 def get_status_lbl(cls, value):
3237 3237 return dict(cls.STATUSES).get(value)
3238 3238
3239 3239 @property
3240 3240 def status_lbl(self):
3241 3241 return ChangesetStatus.get_status_lbl(self.status)
3242 3242
3243 3243 def get_api_data(self):
3244 3244 status = self
3245 3245 data = {
3246 3246 'status_id': status.changeset_status_id,
3247 3247 'status': status.status,
3248 3248 }
3249 3249 return data
3250 3250
3251 3251 def __json__(self):
3252 3252 data = dict()
3253 3253 data.update(self.get_api_data())
3254 3254 return data
3255 3255
3256 3256
3257 3257 class _PullRequestBase(BaseModel):
3258 3258 """
3259 3259 Common attributes of pull request and version entries.
3260 3260 """
3261 3261
3262 3262 # .status values
3263 3263 STATUS_NEW = u'new'
3264 3264 STATUS_OPEN = u'open'
3265 3265 STATUS_CLOSED = u'closed'
3266 3266
3267 3267 title = Column('title', Unicode(255), nullable=True)
3268 3268 description = Column(
3269 3269 'description', UnicodeText().with_variant(UnicodeText(10240), 'mysql'),
3270 3270 nullable=True)
3271 3271 # new/open/closed status of pull request (not approve/reject/etc)
3272 3272 status = Column('status', Unicode(255), nullable=False, default=STATUS_NEW)
3273 3273 created_on = Column(
3274 3274 'created_on', DateTime(timezone=False), nullable=False,
3275 3275 default=datetime.datetime.now)
3276 3276 updated_on = Column(
3277 3277 'updated_on', DateTime(timezone=False), nullable=False,
3278 3278 default=datetime.datetime.now)
3279 3279
3280 3280 @declared_attr
3281 3281 def user_id(cls):
3282 3282 return Column(
3283 3283 "user_id", Integer(), ForeignKey('users.user_id'), nullable=False,
3284 3284 unique=None)
3285 3285
3286 3286 # 500 revisions max
3287 3287 _revisions = Column(
3288 3288 'revisions', UnicodeText().with_variant(UnicodeText(20500), 'mysql'))
3289 3289
3290 3290 @declared_attr
3291 3291 def source_repo_id(cls):
3292 3292 # TODO: dan: rename column to source_repo_id
3293 3293 return Column(
3294 3294 'org_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3295 3295 nullable=False)
3296 3296
3297 3297 source_ref = Column('org_ref', Unicode(255), nullable=False)
3298 3298
3299 3299 @declared_attr
3300 3300 def target_repo_id(cls):
3301 3301 # TODO: dan: rename column to target_repo_id
3302 3302 return Column(
3303 3303 'other_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3304 3304 nullable=False)
3305 3305
3306 3306 target_ref = Column('other_ref', Unicode(255), nullable=False)
3307 3307 _shadow_merge_ref = Column('shadow_merge_ref', Unicode(255), nullable=True)
3308 3308
3309 3309 # TODO: dan: rename column to last_merge_source_rev
3310 3310 _last_merge_source_rev = Column(
3311 3311 'last_merge_org_rev', String(40), nullable=True)
3312 3312 # TODO: dan: rename column to last_merge_target_rev
3313 3313 _last_merge_target_rev = Column(
3314 3314 'last_merge_other_rev', String(40), nullable=True)
3315 3315 _last_merge_status = Column('merge_status', Integer(), nullable=True)
3316 3316 merge_rev = Column('merge_rev', String(40), nullable=True)
3317 3317
3318 3318 reviewer_data = Column(
3319 3319 'reviewer_data_json', MutationObj.as_mutable(
3320 3320 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
3321 3321
3322 3322 @property
3323 3323 def reviewer_data_json(self):
3324 3324 return json.dumps(self.reviewer_data)
3325 3325
3326 3326 @hybrid_property
3327 3327 def description_safe(self):
3328 3328 from rhodecode.lib import helpers as h
3329 3329 return h.escape(self.description)
3330 3330
3331 3331 @hybrid_property
3332 3332 def revisions(self):
3333 3333 return self._revisions.split(':') if self._revisions else []
3334 3334
3335 3335 @revisions.setter
3336 3336 def revisions(self, val):
3337 3337 self._revisions = ':'.join(val)
3338 3338
3339 3339 @declared_attr
3340 3340 def author(cls):
3341 3341 return relationship('User', lazy='joined')
3342 3342
3343 3343 @declared_attr
3344 3344 def source_repo(cls):
3345 3345 return relationship(
3346 3346 'Repository',
3347 3347 primaryjoin='%s.source_repo_id==Repository.repo_id' % cls.__name__)
3348 3348
3349 3349 @property
3350 3350 def source_ref_parts(self):
3351 3351 return self.unicode_to_reference(self.source_ref)
3352 3352
3353 3353 @declared_attr
3354 3354 def target_repo(cls):
3355 3355 return relationship(
3356 3356 'Repository',
3357 3357 primaryjoin='%s.target_repo_id==Repository.repo_id' % cls.__name__)
3358 3358
3359 3359 @property
3360 3360 def target_ref_parts(self):
3361 3361 return self.unicode_to_reference(self.target_ref)
3362 3362
3363 3363 @property
3364 3364 def shadow_merge_ref(self):
3365 3365 return self.unicode_to_reference(self._shadow_merge_ref)
3366 3366
3367 3367 @shadow_merge_ref.setter
3368 3368 def shadow_merge_ref(self, ref):
3369 3369 self._shadow_merge_ref = self.reference_to_unicode(ref)
3370 3370
3371 3371 def unicode_to_reference(self, raw):
3372 3372 """
3373 3373 Convert a unicode (or string) to a reference object.
3374 3374 If unicode evaluates to False it returns None.
3375 3375 """
3376 3376 if raw:
3377 3377 refs = raw.split(':')
3378 3378 return Reference(*refs)
3379 3379 else:
3380 3380 return None
3381 3381
3382 3382 def reference_to_unicode(self, ref):
3383 3383 """
3384 3384 Convert a reference object to unicode.
3385 3385 If reference is None it returns None.
3386 3386 """
3387 3387 if ref:
3388 3388 return u':'.join(ref)
3389 3389 else:
3390 3390 return None
3391 3391
3392 3392 def get_api_data(self, with_merge_state=True):
3393 3393 from rhodecode.model.pull_request import PullRequestModel
3394 3394
3395 3395 pull_request = self
3396 3396 if with_merge_state:
3397 3397 merge_status = PullRequestModel().merge_status(pull_request)
3398 3398 merge_state = {
3399 3399 'status': merge_status[0],
3400 3400 'message': safe_unicode(merge_status[1]),
3401 3401 }
3402 3402 else:
3403 3403 merge_state = {'status': 'not_available',
3404 3404 'message': 'not_available'}
3405 3405
3406 3406 merge_data = {
3407 3407 'clone_url': PullRequestModel().get_shadow_clone_url(pull_request),
3408 3408 'reference': (
3409 3409 pull_request.shadow_merge_ref._asdict()
3410 3410 if pull_request.shadow_merge_ref else None),
3411 3411 }
3412 3412
3413 3413 data = {
3414 3414 'pull_request_id': pull_request.pull_request_id,
3415 3415 'url': PullRequestModel().get_url(pull_request),
3416 3416 'title': pull_request.title,
3417 3417 'description': pull_request.description,
3418 3418 'status': pull_request.status,
3419 3419 'created_on': pull_request.created_on,
3420 3420 'updated_on': pull_request.updated_on,
3421 3421 'commit_ids': pull_request.revisions,
3422 3422 'review_status': pull_request.calculated_review_status(),
3423 3423 'mergeable': merge_state,
3424 3424 'source': {
3425 3425 'clone_url': pull_request.source_repo.clone_url(),
3426 3426 'repository': pull_request.source_repo.repo_name,
3427 3427 'reference': {
3428 3428 'name': pull_request.source_ref_parts.name,
3429 3429 'type': pull_request.source_ref_parts.type,
3430 3430 'commit_id': pull_request.source_ref_parts.commit_id,
3431 3431 },
3432 3432 },
3433 3433 'target': {
3434 3434 'clone_url': pull_request.target_repo.clone_url(),
3435 3435 'repository': pull_request.target_repo.repo_name,
3436 3436 'reference': {
3437 3437 'name': pull_request.target_ref_parts.name,
3438 3438 'type': pull_request.target_ref_parts.type,
3439 3439 'commit_id': pull_request.target_ref_parts.commit_id,
3440 3440 },
3441 3441 },
3442 3442 'merge': merge_data,
3443 3443 'author': pull_request.author.get_api_data(include_secrets=False,
3444 3444 details='basic'),
3445 3445 'reviewers': [
3446 3446 {
3447 3447 'user': reviewer.get_api_data(include_secrets=False,
3448 3448 details='basic'),
3449 3449 'reasons': reasons,
3450 3450 'review_status': st[0][1].status if st else 'not_reviewed',
3451 3451 }
3452 3452 for reviewer, reasons, mandatory, st in
3453 3453 pull_request.reviewers_statuses()
3454 3454 ]
3455 3455 }
3456 3456
3457 3457 return data
3458 3458
3459 3459
3460 3460 class PullRequest(Base, _PullRequestBase):
3461 3461 __tablename__ = 'pull_requests'
3462 3462 __table_args__ = (
3463 3463 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3464 3464 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3465 3465 )
3466 3466
3467 3467 pull_request_id = Column(
3468 3468 'pull_request_id', Integer(), nullable=False, primary_key=True)
3469 3469
3470 3470 def __repr__(self):
3471 3471 if self.pull_request_id:
3472 3472 return '<DB:PullRequest #%s>' % self.pull_request_id
3473 3473 else:
3474 3474 return '<DB:PullRequest at %#x>' % id(self)
3475 3475
3476 3476 reviewers = relationship('PullRequestReviewers',
3477 3477 cascade="all, delete, delete-orphan")
3478 3478 statuses = relationship('ChangesetStatus',
3479 3479 cascade="all, delete, delete-orphan")
3480 3480 comments = relationship('ChangesetComment',
3481 3481 cascade="all, delete, delete-orphan")
3482 3482 versions = relationship('PullRequestVersion',
3483 3483 cascade="all, delete, delete-orphan",
3484 3484 lazy='dynamic')
3485 3485
3486 3486 @classmethod
3487 3487 def get_pr_display_object(cls, pull_request_obj, org_pull_request_obj,
3488 3488 internal_methods=None):
3489 3489
3490 3490 class PullRequestDisplay(object):
3491 3491 """
3492 3492 Special object wrapper for showing PullRequest data via Versions
3493 3493 It mimics PR object as close as possible. This is read only object
3494 3494 just for display
3495 3495 """
3496 3496
3497 3497 def __init__(self, attrs, internal=None):
3498 3498 self.attrs = attrs
3499 3499 # internal have priority over the given ones via attrs
3500 3500 self.internal = internal or ['versions']
3501 3501
3502 3502 def __getattr__(self, item):
3503 3503 if item in self.internal:
3504 3504 return getattr(self, item)
3505 3505 try:
3506 3506 return self.attrs[item]
3507 3507 except KeyError:
3508 3508 raise AttributeError(
3509 3509 '%s object has no attribute %s' % (self, item))
3510 3510
3511 3511 def __repr__(self):
3512 3512 return '<DB:PullRequestDisplay #%s>' % self.attrs.get('pull_request_id')
3513 3513
3514 3514 def versions(self):
3515 3515 return pull_request_obj.versions.order_by(
3516 3516 PullRequestVersion.pull_request_version_id).all()
3517 3517
3518 3518 def is_closed(self):
3519 3519 return pull_request_obj.is_closed()
3520 3520
3521 3521 @property
3522 3522 def pull_request_version_id(self):
3523 3523 return getattr(pull_request_obj, 'pull_request_version_id', None)
3524 3524
3525 3525 attrs = StrictAttributeDict(pull_request_obj.get_api_data())
3526 3526
3527 3527 attrs.author = StrictAttributeDict(
3528 3528 pull_request_obj.author.get_api_data())
3529 3529 if pull_request_obj.target_repo:
3530 3530 attrs.target_repo = StrictAttributeDict(
3531 3531 pull_request_obj.target_repo.get_api_data())
3532 3532 attrs.target_repo.clone_url = pull_request_obj.target_repo.clone_url
3533 3533
3534 3534 if pull_request_obj.source_repo:
3535 3535 attrs.source_repo = StrictAttributeDict(
3536 3536 pull_request_obj.source_repo.get_api_data())
3537 3537 attrs.source_repo.clone_url = pull_request_obj.source_repo.clone_url
3538 3538
3539 3539 attrs.source_ref_parts = pull_request_obj.source_ref_parts
3540 3540 attrs.target_ref_parts = pull_request_obj.target_ref_parts
3541 3541 attrs.revisions = pull_request_obj.revisions
3542 3542
3543 3543 attrs.shadow_merge_ref = org_pull_request_obj.shadow_merge_ref
3544 3544 attrs.reviewer_data = org_pull_request_obj.reviewer_data
3545 3545 attrs.reviewer_data_json = org_pull_request_obj.reviewer_data_json
3546 3546
3547 3547 return PullRequestDisplay(attrs, internal=internal_methods)
3548 3548
3549 3549 def is_closed(self):
3550 3550 return self.status == self.STATUS_CLOSED
3551 3551
3552 3552 def __json__(self):
3553 3553 return {
3554 3554 'revisions': self.revisions,
3555 3555 }
3556 3556
3557 3557 def calculated_review_status(self):
3558 3558 from rhodecode.model.changeset_status import ChangesetStatusModel
3559 3559 return ChangesetStatusModel().calculated_review_status(self)
3560 3560
3561 3561 def reviewers_statuses(self):
3562 3562 from rhodecode.model.changeset_status import ChangesetStatusModel
3563 3563 return ChangesetStatusModel().reviewers_statuses(self)
3564 3564
3565 3565 @property
3566 3566 def workspace_id(self):
3567 3567 from rhodecode.model.pull_request import PullRequestModel
3568 3568 return PullRequestModel()._workspace_id(self)
3569 3569
3570 3570 def get_shadow_repo(self):
3571 3571 workspace_id = self.workspace_id
3572 3572 vcs_obj = self.target_repo.scm_instance()
3573 3573 shadow_repository_path = vcs_obj._get_shadow_repository_path(
3574 3574 workspace_id)
3575 3575 return vcs_obj._get_shadow_instance(shadow_repository_path)
3576 3576
3577 3577
3578 3578 class PullRequestVersion(Base, _PullRequestBase):
3579 3579 __tablename__ = 'pull_request_versions'
3580 3580 __table_args__ = (
3581 3581 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3582 3582 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3583 3583 )
3584 3584
3585 3585 pull_request_version_id = Column(
3586 3586 'pull_request_version_id', Integer(), nullable=False, primary_key=True)
3587 3587 pull_request_id = Column(
3588 3588 'pull_request_id', Integer(),
3589 3589 ForeignKey('pull_requests.pull_request_id'), nullable=False)
3590 3590 pull_request = relationship('PullRequest')
3591 3591
3592 3592 def __repr__(self):
3593 3593 if self.pull_request_version_id:
3594 3594 return '<DB:PullRequestVersion #%s>' % self.pull_request_version_id
3595 3595 else:
3596 3596 return '<DB:PullRequestVersion at %#x>' % id(self)
3597 3597
3598 3598 @property
3599 3599 def reviewers(self):
3600 3600 return self.pull_request.reviewers
3601 3601
3602 3602 @property
3603 3603 def versions(self):
3604 3604 return self.pull_request.versions
3605 3605
3606 3606 def is_closed(self):
3607 3607 # calculate from original
3608 3608 return self.pull_request.status == self.STATUS_CLOSED
3609 3609
3610 3610 def calculated_review_status(self):
3611 3611 return self.pull_request.calculated_review_status()
3612 3612
3613 3613 def reviewers_statuses(self):
3614 3614 return self.pull_request.reviewers_statuses()
3615 3615
3616 3616
3617 3617 class PullRequestReviewers(Base, BaseModel):
3618 3618 __tablename__ = 'pull_request_reviewers'
3619 3619 __table_args__ = (
3620 3620 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3621 3621 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3622 3622 )
3623 3623
3624 3624 @hybrid_property
3625 3625 def reasons(self):
3626 3626 if not self._reasons:
3627 3627 return []
3628 3628 return self._reasons
3629 3629
3630 3630 @reasons.setter
3631 3631 def reasons(self, val):
3632 3632 val = val or []
3633 3633 if any(not isinstance(x, basestring) for x in val):
3634 3634 raise Exception('invalid reasons type, must be list of strings')
3635 3635 self._reasons = val
3636 3636
3637 3637 pull_requests_reviewers_id = Column(
3638 3638 'pull_requests_reviewers_id', Integer(), nullable=False,
3639 3639 primary_key=True)
3640 3640 pull_request_id = Column(
3641 3641 "pull_request_id", Integer(),
3642 3642 ForeignKey('pull_requests.pull_request_id'), nullable=False)
3643 3643 user_id = Column(
3644 3644 "user_id", Integer(), ForeignKey('users.user_id'), nullable=True)
3645 3645 _reasons = Column(
3646 3646 'reason', MutationList.as_mutable(
3647 3647 JsonType('list', dialect_map=dict(mysql=UnicodeText(16384)))))
3648 3648 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
3649 3649 user = relationship('User')
3650 3650 pull_request = relationship('PullRequest')
3651 3651
3652 3652
3653 3653 class Notification(Base, BaseModel):
3654 3654 __tablename__ = 'notifications'
3655 3655 __table_args__ = (
3656 3656 Index('notification_type_idx', 'type'),
3657 3657 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3658 3658 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
3659 3659 )
3660 3660
3661 3661 TYPE_CHANGESET_COMMENT = u'cs_comment'
3662 3662 TYPE_MESSAGE = u'message'
3663 3663 TYPE_MENTION = u'mention'
3664 3664 TYPE_REGISTRATION = u'registration'
3665 3665 TYPE_PULL_REQUEST = u'pull_request'
3666 3666 TYPE_PULL_REQUEST_COMMENT = u'pull_request_comment'
3667 3667
3668 3668 notification_id = Column('notification_id', Integer(), nullable=False, primary_key=True)
3669 3669 subject = Column('subject', Unicode(512), nullable=True)
3670 3670 body = Column('body', UnicodeText().with_variant(UnicodeText(50000), 'mysql'), nullable=True)
3671 3671 created_by = Column("created_by", Integer(), ForeignKey('users.user_id'), nullable=True)
3672 3672 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3673 3673 type_ = Column('type', Unicode(255))
3674 3674
3675 3675 created_by_user = relationship('User')
3676 3676 notifications_to_users = relationship('UserNotification', lazy='joined',
3677 3677 cascade="all, delete, delete-orphan")
3678 3678
3679 3679 @property
3680 3680 def recipients(self):
3681 3681 return [x.user for x in UserNotification.query()\
3682 3682 .filter(UserNotification.notification == self)\
3683 3683 .order_by(UserNotification.user_id.asc()).all()]
3684 3684
3685 3685 @classmethod
3686 3686 def create(cls, created_by, subject, body, recipients, type_=None):
3687 3687 if type_ is None:
3688 3688 type_ = Notification.TYPE_MESSAGE
3689 3689
3690 3690 notification = cls()
3691 3691 notification.created_by_user = created_by
3692 3692 notification.subject = subject
3693 3693 notification.body = body
3694 3694 notification.type_ = type_
3695 3695 notification.created_on = datetime.datetime.now()
3696 3696
3697 3697 for u in recipients:
3698 3698 assoc = UserNotification()
3699 3699 assoc.notification = notification
3700 3700
3701 3701 # if created_by is inside recipients mark his notification
3702 3702 # as read
3703 3703 if u.user_id == created_by.user_id:
3704 3704 assoc.read = True
3705 3705
3706 3706 u.notifications.append(assoc)
3707 3707 Session().add(notification)
3708 3708
3709 3709 return notification
3710 3710
3711 @property
3712 def description(self):
3713 from rhodecode.model.notification import NotificationModel
3714 return NotificationModel().make_description(self)
3715
3716 3711
3717 3712 class UserNotification(Base, BaseModel):
3718 3713 __tablename__ = 'user_to_notification'
3719 3714 __table_args__ = (
3720 3715 UniqueConstraint('user_id', 'notification_id'),
3721 3716 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3722 3717 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3723 3718 )
3724 3719 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), primary_key=True)
3725 3720 notification_id = Column("notification_id", Integer(), ForeignKey('notifications.notification_id'), primary_key=True)
3726 3721 read = Column('read', Boolean, default=False)
3727 3722 sent_on = Column('sent_on', DateTime(timezone=False), nullable=True, unique=None)
3728 3723
3729 3724 user = relationship('User', lazy="joined")
3730 3725 notification = relationship('Notification', lazy="joined",
3731 3726 order_by=lambda: Notification.created_on.desc(),)
3732 3727
3733 3728 def mark_as_read(self):
3734 3729 self.read = True
3735 3730 Session().add(self)
3736 3731
3737 3732
3738 3733 class Gist(Base, BaseModel):
3739 3734 __tablename__ = 'gists'
3740 3735 __table_args__ = (
3741 3736 Index('g_gist_access_id_idx', 'gist_access_id'),
3742 3737 Index('g_created_on_idx', 'created_on'),
3743 3738 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3744 3739 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3745 3740 )
3746 3741 GIST_PUBLIC = u'public'
3747 3742 GIST_PRIVATE = u'private'
3748 3743 DEFAULT_FILENAME = u'gistfile1.txt'
3749 3744
3750 3745 ACL_LEVEL_PUBLIC = u'acl_public'
3751 3746 ACL_LEVEL_PRIVATE = u'acl_private'
3752 3747
3753 3748 gist_id = Column('gist_id', Integer(), primary_key=True)
3754 3749 gist_access_id = Column('gist_access_id', Unicode(250))
3755 3750 gist_description = Column('gist_description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
3756 3751 gist_owner = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=True)
3757 3752 gist_expires = Column('gist_expires', Float(53), nullable=False)
3758 3753 gist_type = Column('gist_type', Unicode(128), nullable=False)
3759 3754 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3760 3755 modified_at = Column('modified_at', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3761 3756 acl_level = Column('acl_level', Unicode(128), nullable=True)
3762 3757
3763 3758 owner = relationship('User')
3764 3759
3765 3760 def __repr__(self):
3766 3761 return '<Gist:[%s]%s>' % (self.gist_type, self.gist_access_id)
3767 3762
3768 3763 @hybrid_property
3769 3764 def description_safe(self):
3770 3765 from rhodecode.lib import helpers as h
3771 3766 return h.escape(self.gist_description)
3772 3767
3773 3768 @classmethod
3774 3769 def get_or_404(cls, id_, pyramid_exc=False):
3775 3770
3776 3771 if pyramid_exc:
3777 3772 from pyramid.httpexceptions import HTTPNotFound
3778 3773 else:
3779 3774 from webob.exc import HTTPNotFound
3780 3775
3781 3776 res = cls.query().filter(cls.gist_access_id == id_).scalar()
3782 3777 if not res:
3783 3778 raise HTTPNotFound
3784 3779 return res
3785 3780
3786 3781 @classmethod
3787 3782 def get_by_access_id(cls, gist_access_id):
3788 3783 return cls.query().filter(cls.gist_access_id == gist_access_id).scalar()
3789 3784
3790 3785 def gist_url(self):
3791 3786 from rhodecode.model.gist import GistModel
3792 3787 return GistModel().get_url(self)
3793 3788
3794 3789 @classmethod
3795 3790 def base_path(cls):
3796 3791 """
3797 3792 Returns base path when all gists are stored
3798 3793
3799 3794 :param cls:
3800 3795 """
3801 3796 from rhodecode.model.gist import GIST_STORE_LOC
3802 3797 q = Session().query(RhodeCodeUi)\
3803 3798 .filter(RhodeCodeUi.ui_key == URL_SEP)
3804 3799 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
3805 3800 return os.path.join(q.one().ui_value, GIST_STORE_LOC)
3806 3801
3807 3802 def get_api_data(self):
3808 3803 """
3809 3804 Common function for generating gist related data for API
3810 3805 """
3811 3806 gist = self
3812 3807 data = {
3813 3808 'gist_id': gist.gist_id,
3814 3809 'type': gist.gist_type,
3815 3810 'access_id': gist.gist_access_id,
3816 3811 'description': gist.gist_description,
3817 3812 'url': gist.gist_url(),
3818 3813 'expires': gist.gist_expires,
3819 3814 'created_on': gist.created_on,
3820 3815 'modified_at': gist.modified_at,
3821 3816 'content': None,
3822 3817 'acl_level': gist.acl_level,
3823 3818 }
3824 3819 return data
3825 3820
3826 3821 def __json__(self):
3827 3822 data = dict(
3828 3823 )
3829 3824 data.update(self.get_api_data())
3830 3825 return data
3831 3826 # SCM functions
3832 3827
3833 3828 def scm_instance(self, **kwargs):
3834 3829 full_repo_path = os.path.join(self.base_path(), self.gist_access_id)
3835 3830 return get_vcs_instance(
3836 3831 repo_path=safe_str(full_repo_path), create=False)
3837 3832
3838 3833
3839 3834 class ExternalIdentity(Base, BaseModel):
3840 3835 __tablename__ = 'external_identities'
3841 3836 __table_args__ = (
3842 3837 Index('local_user_id_idx', 'local_user_id'),
3843 3838 Index('external_id_idx', 'external_id'),
3844 3839 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3845 3840 'mysql_charset': 'utf8'})
3846 3841
3847 3842 external_id = Column('external_id', Unicode(255), default=u'',
3848 3843 primary_key=True)
3849 3844 external_username = Column('external_username', Unicode(1024), default=u'')
3850 3845 local_user_id = Column('local_user_id', Integer(),
3851 3846 ForeignKey('users.user_id'), primary_key=True)
3852 3847 provider_name = Column('provider_name', Unicode(255), default=u'',
3853 3848 primary_key=True)
3854 3849 access_token = Column('access_token', String(1024), default=u'')
3855 3850 alt_token = Column('alt_token', String(1024), default=u'')
3856 3851 token_secret = Column('token_secret', String(1024), default=u'')
3857 3852
3858 3853 @classmethod
3859 3854 def by_external_id_and_provider(cls, external_id, provider_name,
3860 3855 local_user_id=None):
3861 3856 """
3862 3857 Returns ExternalIdentity instance based on search params
3863 3858
3864 3859 :param external_id:
3865 3860 :param provider_name:
3866 3861 :return: ExternalIdentity
3867 3862 """
3868 3863 query = cls.query()
3869 3864 query = query.filter(cls.external_id == external_id)
3870 3865 query = query.filter(cls.provider_name == provider_name)
3871 3866 if local_user_id:
3872 3867 query = query.filter(cls.local_user_id == local_user_id)
3873 3868 return query.first()
3874 3869
3875 3870 @classmethod
3876 3871 def user_by_external_id_and_provider(cls, external_id, provider_name):
3877 3872 """
3878 3873 Returns User instance based on search params
3879 3874
3880 3875 :param external_id:
3881 3876 :param provider_name:
3882 3877 :return: User
3883 3878 """
3884 3879 query = User.query()
3885 3880 query = query.filter(cls.external_id == external_id)
3886 3881 query = query.filter(cls.provider_name == provider_name)
3887 3882 query = query.filter(User.user_id == cls.local_user_id)
3888 3883 return query.first()
3889 3884
3890 3885 @classmethod
3891 3886 def by_local_user_id(cls, local_user_id):
3892 3887 """
3893 3888 Returns all tokens for user
3894 3889
3895 3890 :param local_user_id:
3896 3891 :return: ExternalIdentity
3897 3892 """
3898 3893 query = cls.query()
3899 3894 query = query.filter(cls.local_user_id == local_user_id)
3900 3895 return query
3901 3896
3902 3897
3903 3898 class Integration(Base, BaseModel):
3904 3899 __tablename__ = 'integrations'
3905 3900 __table_args__ = (
3906 3901 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3907 3902 'mysql_charset': 'utf8', 'sqlite_autoincrement': True}
3908 3903 )
3909 3904
3910 3905 integration_id = Column('integration_id', Integer(), primary_key=True)
3911 3906 integration_type = Column('integration_type', String(255))
3912 3907 enabled = Column('enabled', Boolean(), nullable=False)
3913 3908 name = Column('name', String(255), nullable=False)
3914 3909 child_repos_only = Column('child_repos_only', Boolean(), nullable=False,
3915 3910 default=False)
3916 3911
3917 3912 settings = Column(
3918 3913 'settings_json', MutationObj.as_mutable(
3919 3914 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
3920 3915 repo_id = Column(
3921 3916 'repo_id', Integer(), ForeignKey('repositories.repo_id'),
3922 3917 nullable=True, unique=None, default=None)
3923 3918 repo = relationship('Repository', lazy='joined')
3924 3919
3925 3920 repo_group_id = Column(
3926 3921 'repo_group_id', Integer(), ForeignKey('groups.group_id'),
3927 3922 nullable=True, unique=None, default=None)
3928 3923 repo_group = relationship('RepoGroup', lazy='joined')
3929 3924
3930 3925 @property
3931 3926 def scope(self):
3932 3927 if self.repo:
3933 3928 return repr(self.repo)
3934 3929 if self.repo_group:
3935 3930 if self.child_repos_only:
3936 3931 return repr(self.repo_group) + ' (child repos only)'
3937 3932 else:
3938 3933 return repr(self.repo_group) + ' (recursive)'
3939 3934 if self.child_repos_only:
3940 3935 return 'root_repos'
3941 3936 return 'global'
3942 3937
3943 3938 def __repr__(self):
3944 3939 return '<Integration(%r, %r)>' % (self.integration_type, self.scope)
3945 3940
3946 3941
3947 3942 class RepoReviewRuleUser(Base, BaseModel):
3948 3943 __tablename__ = 'repo_review_rules_users'
3949 3944 __table_args__ = (
3950 3945 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3951 3946 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
3952 3947 )
3953 3948 repo_review_rule_user_id = Column('repo_review_rule_user_id', Integer(), primary_key=True)
3954 3949 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
3955 3950 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False)
3956 3951 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
3957 3952 user = relationship('User')
3958 3953
3959 3954 def rule_data(self):
3960 3955 return {
3961 3956 'mandatory': self.mandatory
3962 3957 }
3963 3958
3964 3959
3965 3960 class RepoReviewRuleUserGroup(Base, BaseModel):
3966 3961 __tablename__ = 'repo_review_rules_users_groups'
3967 3962 __table_args__ = (
3968 3963 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3969 3964 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
3970 3965 )
3971 3966 repo_review_rule_users_group_id = Column('repo_review_rule_users_group_id', Integer(), primary_key=True)
3972 3967 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
3973 3968 users_group_id = Column("users_group_id", Integer(),ForeignKey('users_groups.users_group_id'), nullable=False)
3974 3969 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
3975 3970 users_group = relationship('UserGroup')
3976 3971
3977 3972 def rule_data(self):
3978 3973 return {
3979 3974 'mandatory': self.mandatory
3980 3975 }
3981 3976
3982 3977
3983 3978 class RepoReviewRule(Base, BaseModel):
3984 3979 __tablename__ = 'repo_review_rules'
3985 3980 __table_args__ = (
3986 3981 {'extend_existing': True, 'mysql_engine': 'InnoDB',
3987 3982 'mysql_charset': 'utf8', 'sqlite_autoincrement': True,}
3988 3983 )
3989 3984
3990 3985 repo_review_rule_id = Column(
3991 3986 'repo_review_rule_id', Integer(), primary_key=True)
3992 3987 repo_id = Column(
3993 3988 "repo_id", Integer(), ForeignKey('repositories.repo_id'))
3994 3989 repo = relationship('Repository', backref='review_rules')
3995 3990
3996 3991 _branch_pattern = Column("branch_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
3997 3992 _file_pattern = Column("file_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
3998 3993
3999 3994 use_authors_for_review = Column("use_authors_for_review", Boolean(), nullable=False, default=False)
4000 3995 forbid_author_to_review = Column("forbid_author_to_review", Boolean(), nullable=False, default=False)
4001 3996 forbid_commit_author_to_review = Column("forbid_commit_author_to_review", Boolean(), nullable=False, default=False)
4002 3997 forbid_adding_reviewers = Column("forbid_adding_reviewers", Boolean(), nullable=False, default=False)
4003 3998
4004 3999 rule_users = relationship('RepoReviewRuleUser')
4005 4000 rule_user_groups = relationship('RepoReviewRuleUserGroup')
4006 4001
4007 4002 @hybrid_property
4008 4003 def branch_pattern(self):
4009 4004 return self._branch_pattern or '*'
4010 4005
4011 4006 def _validate_glob(self, value):
4012 4007 re.compile('^' + glob2re(value) + '$')
4013 4008
4014 4009 @branch_pattern.setter
4015 4010 def branch_pattern(self, value):
4016 4011 self._validate_glob(value)
4017 4012 self._branch_pattern = value or '*'
4018 4013
4019 4014 @hybrid_property
4020 4015 def file_pattern(self):
4021 4016 return self._file_pattern or '*'
4022 4017
4023 4018 @file_pattern.setter
4024 4019 def file_pattern(self, value):
4025 4020 self._validate_glob(value)
4026 4021 self._file_pattern = value or '*'
4027 4022
4028 4023 def matches(self, branch, files_changed):
4029 4024 """
4030 4025 Check if this review rule matches a branch/files in a pull request
4031 4026
4032 4027 :param branch: branch name for the commit
4033 4028 :param files_changed: list of file paths changed in the pull request
4034 4029 """
4035 4030
4036 4031 branch = branch or ''
4037 4032 files_changed = files_changed or []
4038 4033
4039 4034 branch_matches = True
4040 4035 if branch:
4041 4036 branch_regex = re.compile('^' + glob2re(self.branch_pattern) + '$')
4042 4037 branch_matches = bool(branch_regex.search(branch))
4043 4038
4044 4039 files_matches = True
4045 4040 if self.file_pattern != '*':
4046 4041 files_matches = False
4047 4042 file_regex = re.compile(glob2re(self.file_pattern))
4048 4043 for filename in files_changed:
4049 4044 if file_regex.search(filename):
4050 4045 files_matches = True
4051 4046 break
4052 4047
4053 4048 return branch_matches and files_matches
4054 4049
4055 4050 @property
4056 4051 def review_users(self):
4057 4052 """ Returns the users which this rule applies to """
4058 4053
4059 4054 users = collections.OrderedDict()
4060 4055
4061 4056 for rule_user in self.rule_users:
4062 4057 if rule_user.user.active:
4063 4058 if rule_user.user not in users:
4064 4059 users[rule_user.user.username] = {
4065 4060 'user': rule_user.user,
4066 4061 'source': 'user',
4067 4062 'source_data': {},
4068 4063 'data': rule_user.rule_data()
4069 4064 }
4070 4065
4071 4066 for rule_user_group in self.rule_user_groups:
4072 4067 source_data = {
4073 4068 'name': rule_user_group.users_group.users_group_name,
4074 4069 'members': len(rule_user_group.users_group.members)
4075 4070 }
4076 4071 for member in rule_user_group.users_group.members:
4077 4072 if member.user.active:
4078 4073 users[member.user.username] = {
4079 4074 'user': member.user,
4080 4075 'source': 'user_group',
4081 4076 'source_data': source_data,
4082 4077 'data': rule_user_group.rule_data()
4083 4078 }
4084 4079
4085 4080 return users
4086 4081
4087 4082 def __repr__(self):
4088 4083 return '<RepoReviewerRule(id=%r, repo=%r)>' % (
4089 4084 self.repo_review_rule_id, self.repo)
4090 4085
4091 4086
4092 4087 class DbMigrateVersion(Base, BaseModel):
4093 4088 __tablename__ = 'db_migrate_version'
4094 4089 __table_args__ = (
4095 4090 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4096 4091 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
4097 4092 )
4098 4093 repository_id = Column('repository_id', String(250), primary_key=True)
4099 4094 repository_path = Column('repository_path', Text)
4100 4095 version = Column('version', Integer)
4101 4096
4102 4097
4103 4098 class DbSession(Base, BaseModel):
4104 4099 __tablename__ = 'db_session'
4105 4100 __table_args__ = (
4106 4101 {'extend_existing': True, 'mysql_engine': 'InnoDB',
4107 4102 'mysql_charset': 'utf8', 'sqlite_autoincrement': True},
4108 4103 )
4109 4104
4110 4105 def __repr__(self):
4111 4106 return '<DB:DbSession({})>'.format(self.id)
4112 4107
4113 4108 id = Column('id', Integer())
4114 4109 namespace = Column('namespace', String(255), primary_key=True)
4115 4110 accessed = Column('accessed', DateTime, nullable=False)
4116 4111 created = Column('created', DateTime, nullable=False)
4117 4112 data = Column('data', PickleType, nullable=False)
@@ -1,381 +1,377 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2011-2017 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 21
22 22 """
23 23 Model for notifications
24 24 """
25 25
26
27 26 import logging
28 27 import traceback
29 28
30 from pylons.i18n.translation import _, ungettext
31 29 from sqlalchemy.sql.expression import false, true
32 from mako import exceptions
33 30
34 31 import rhodecode
35 32 from rhodecode.lib import helpers as h
36 33 from rhodecode.lib.utils import PartialRenderer
37 34 from rhodecode.model import BaseModel
38 35 from rhodecode.model.db import Notification, User, UserNotification
39 36 from rhodecode.model.meta import Session
40 from rhodecode.model.settings import SettingsModel
41 37 from rhodecode.translation import TranslationString
42 38
43 39 log = logging.getLogger(__name__)
44 40
45 41
46 42 class NotificationModel(BaseModel):
47 43
48 44 cls = Notification
49 45
50 46 def __get_notification(self, notification):
51 47 if isinstance(notification, Notification):
52 48 return notification
53 49 elif isinstance(notification, (int, long)):
54 50 return Notification.get(notification)
55 51 else:
56 52 if notification:
57 53 raise Exception('notification must be int, long or Instance'
58 54 ' of Notification got %s' % type(notification))
59 55
60 56 def create(
61 57 self, created_by, notification_subject, notification_body,
62 58 notification_type=Notification.TYPE_MESSAGE, recipients=None,
63 59 mention_recipients=None, with_email=True, email_kwargs=None):
64 60 """
65 61
66 62 Creates notification of given type
67 63
68 64 :param created_by: int, str or User instance. User who created this
69 65 notification
70 66 :param notification_subject: subject of notification itself
71 67 :param notification_body: body of notification text
72 68 :param notification_type: type of notification, based on that we
73 69 pick templates
74 70
75 71 :param recipients: list of int, str or User objects, when None
76 72 is given send to all admins
77 73 :param mention_recipients: list of int, str or User objects,
78 74 that were mentioned
79 75 :param with_email: send email with this notification
80 76 :param email_kwargs: dict with arguments to generate email
81 77 """
82 78
83 79 from rhodecode.lib.celerylib import tasks, run_task
84 80
85 81 if recipients and not getattr(recipients, '__iter__', False):
86 82 raise Exception('recipients must be an iterable object')
87 83
88 84 created_by_obj = self._get_user(created_by)
89 85 # default MAIN body if not given
90 86 email_kwargs = email_kwargs or {'body': notification_body}
91 87 mention_recipients = mention_recipients or set()
92 88
93 89 if not created_by_obj:
94 90 raise Exception('unknown user %s' % created_by)
95 91
96 92 if recipients is None:
97 93 # recipients is None means to all admins
98 94 recipients_objs = User.query().filter(User.admin == true()).all()
99 95 log.debug('sending notifications %s to admins: %s',
100 96 notification_type, recipients_objs)
101 97 else:
102 98 recipients_objs = []
103 99 for u in recipients:
104 100 obj = self._get_user(u)
105 101 if obj:
106 102 recipients_objs.append(obj)
107 103 else: # we didn't find this user, log the error and carry on
108 104 log.error('cannot notify unknown user %r', u)
109 105
110 106 recipients_objs = set(recipients_objs)
111 107 if not recipients_objs:
112 108 raise Exception('no valid recipients specified')
113 109
114 110 log.debug('sending notifications %s to %s',
115 111 notification_type, recipients_objs)
116 112
117 113 # add mentioned users into recipients
118 114 final_recipients = set(recipients_objs).union(mention_recipients)
119 115 notification = Notification.create(
120 116 created_by=created_by_obj, subject=notification_subject,
121 117 body=notification_body, recipients=final_recipients,
122 118 type_=notification_type
123 119 )
124 120
125 121 if not with_email: # skip sending email, and just create notification
126 122 return notification
127 123
128 124 # don't send email to person who created this comment
129 125 rec_objs = set(recipients_objs).difference(set([created_by_obj]))
130 126
131 127 # now notify all recipients in question
132 128
133 129 for recipient in rec_objs.union(mention_recipients):
134 130 # inject current recipient
135 131 email_kwargs['recipient'] = recipient
136 132 email_kwargs['mention'] = recipient in mention_recipients
137 133 (subject, headers, email_body,
138 134 email_body_plaintext) = EmailNotificationModel().render_email(
139 135 notification_type, **email_kwargs)
140 136
141 137 log.debug(
142 138 'Creating notification email task for user:`%s`', recipient)
143 139 task = run_task(
144 140 tasks.send_email, recipient.email, subject,
145 141 email_body_plaintext, email_body)
146 142 log.debug('Created email task: %s', task)
147 143
148 144 return notification
149 145
150 146 def delete(self, user, notification):
151 147 # we don't want to remove actual notification just the assignment
152 148 try:
153 149 notification = self.__get_notification(notification)
154 150 user = self._get_user(user)
155 151 if notification and user:
156 152 obj = UserNotification.query()\
157 153 .filter(UserNotification.user == user)\
158 154 .filter(UserNotification.notification == notification)\
159 155 .one()
160 156 Session().delete(obj)
161 157 return True
162 158 except Exception:
163 159 log.error(traceback.format_exc())
164 160 raise
165 161
166 162 def get_for_user(self, user, filter_=None):
167 163 """
168 164 Get mentions for given user, filter them if filter dict is given
169 165 """
170 166 user = self._get_user(user)
171 167
172 168 q = UserNotification.query()\
173 169 .filter(UserNotification.user == user)\
174 170 .join((
175 171 Notification, UserNotification.notification_id ==
176 172 Notification.notification_id))
177 173 if filter_ == ['all']:
178 174 q = q # no filter
179 175 elif filter_ == ['unread']:
180 176 q = q.filter(UserNotification.read == false())
181 177 elif filter_:
182 178 q = q.filter(Notification.type_.in_(filter_))
183 179
184 180 return q
185 181
186 182 def mark_read(self, user, notification):
187 183 try:
188 184 notification = self.__get_notification(notification)
189 185 user = self._get_user(user)
190 186 if notification and user:
191 187 obj = UserNotification.query()\
192 188 .filter(UserNotification.user == user)\
193 189 .filter(UserNotification.notification == notification)\
194 190 .one()
195 191 obj.read = True
196 192 Session().add(obj)
197 193 return True
198 194 except Exception:
199 195 log.error(traceback.format_exc())
200 196 raise
201 197
202 198 def mark_all_read_for_user(self, user, filter_=None):
203 199 user = self._get_user(user)
204 200 q = UserNotification.query()\
205 201 .filter(UserNotification.user == user)\
206 202 .filter(UserNotification.read == false())\
207 203 .join((
208 204 Notification, UserNotification.notification_id ==
209 205 Notification.notification_id))
210 206 if filter_ == ['unread']:
211 207 q = q.filter(UserNotification.read == false())
212 208 elif filter_:
213 209 q = q.filter(Notification.type_.in_(filter_))
214 210
215 211 # this is a little inefficient but sqlalchemy doesn't support
216 212 # update on joined tables :(
217 213 for obj in q.all():
218 214 obj.read = True
219 215 Session().add(obj)
220 216
221 217 def get_unread_cnt_for_user(self, user):
222 218 user = self._get_user(user)
223 219 return UserNotification.query()\
224 220 .filter(UserNotification.read == false())\
225 221 .filter(UserNotification.user == user).count()
226 222
227 223 def get_unread_for_user(self, user):
228 224 user = self._get_user(user)
229 225 return [x.notification for x in UserNotification.query()
230 226 .filter(UserNotification.read == false())
231 227 .filter(UserNotification.user == user).all()]
232 228
233 229 def get_user_notification(self, user, notification):
234 230 user = self._get_user(user)
235 231 notification = self.__get_notification(notification)
236 232
237 233 return UserNotification.query()\
238 234 .filter(UserNotification.notification == notification)\
239 235 .filter(UserNotification.user == user).scalar()
240 236
241 def make_description(self, notification, show_age=True, translate=None):
237 def make_description(self, notification, translate, show_age=True):
242 238 """
243 239 Creates a human readable description based on properties
244 240 of notification object
245 241 """
246
242 _ = translate
247 243 _map = {
248 244 notification.TYPE_CHANGESET_COMMENT: [
249 245 _('%(user)s commented on commit %(date_or_age)s'),
250 246 _('%(user)s commented on commit at %(date_or_age)s'),
251 247 ],
252 248 notification.TYPE_MESSAGE: [
253 249 _('%(user)s sent message %(date_or_age)s'),
254 250 _('%(user)s sent message at %(date_or_age)s'),
255 251 ],
256 252 notification.TYPE_MENTION: [
257 253 _('%(user)s mentioned you %(date_or_age)s'),
258 254 _('%(user)s mentioned you at %(date_or_age)s'),
259 255 ],
260 256 notification.TYPE_REGISTRATION: [
261 257 _('%(user)s registered in RhodeCode %(date_or_age)s'),
262 258 _('%(user)s registered in RhodeCode at %(date_or_age)s'),
263 259 ],
264 260 notification.TYPE_PULL_REQUEST: [
265 261 _('%(user)s opened new pull request %(date_or_age)s'),
266 262 _('%(user)s opened new pull request at %(date_or_age)s'),
267 263 ],
268 264 notification.TYPE_PULL_REQUEST_COMMENT: [
269 265 _('%(user)s commented on pull request %(date_or_age)s'),
270 266 _('%(user)s commented on pull request at %(date_or_age)s'),
271 267 ],
272 268 }
273 269
274 270 templates = _map[notification.type_]
275 271
276 272 if show_age:
277 273 template = templates[0]
278 274 date_or_age = h.age(notification.created_on)
279 275 if translate:
280 276 date_or_age = translate(date_or_age)
281 277
282 278 if isinstance(date_or_age, TranslationString):
283 279 date_or_age = date_or_age.interpolate()
284 280
285 281 else:
286 282 template = templates[1]
287 283 date_or_age = h.format_date(notification.created_on)
288 284
289 285 return template % {
290 286 'user': notification.created_by_user.username,
291 287 'date_or_age': date_or_age,
292 288 }
293 289
294 290
295 291 class EmailNotificationModel(BaseModel):
296 292 TYPE_COMMIT_COMMENT = Notification.TYPE_CHANGESET_COMMENT
297 293 TYPE_REGISTRATION = Notification.TYPE_REGISTRATION
298 294 TYPE_PULL_REQUEST = Notification.TYPE_PULL_REQUEST
299 295 TYPE_PULL_REQUEST_COMMENT = Notification.TYPE_PULL_REQUEST_COMMENT
300 296 TYPE_MAIN = Notification.TYPE_MESSAGE
301 297
302 298 TYPE_PASSWORD_RESET = 'password_reset'
303 299 TYPE_PASSWORD_RESET_CONFIRMATION = 'password_reset_confirmation'
304 300 TYPE_EMAIL_TEST = 'email_test'
305 301 TYPE_TEST = 'test'
306 302
307 303 email_types = {
308 304 TYPE_MAIN: 'email_templates/main.mako',
309 305 TYPE_TEST: 'email_templates/test.mako',
310 306 TYPE_EMAIL_TEST: 'email_templates/email_test.mako',
311 307 TYPE_REGISTRATION: 'email_templates/user_registration.mako',
312 308 TYPE_PASSWORD_RESET: 'email_templates/password_reset.mako',
313 309 TYPE_PASSWORD_RESET_CONFIRMATION: 'email_templates/password_reset_confirmation.mako',
314 310 TYPE_COMMIT_COMMENT: 'email_templates/commit_comment.mako',
315 311 TYPE_PULL_REQUEST: 'email_templates/pull_request_review.mako',
316 312 TYPE_PULL_REQUEST_COMMENT: 'email_templates/pull_request_comment.mako',
317 313 }
318 314
319 315 def __init__(self):
320 316 """
321 317 Example usage::
322 318
323 319 (subject, headers, email_body,
324 320 email_body_plaintext) = EmailNotificationModel().render_email(
325 321 EmailNotificationModel.TYPE_TEST, **email_kwargs)
326 322
327 323 """
328 324 super(EmailNotificationModel, self).__init__()
329 325 self.rhodecode_instance_name = rhodecode.CONFIG.get('rhodecode_title')
330 326
331 327 def _update_kwargs_for_render(self, kwargs):
332 328 """
333 329 Inject params required for Mako rendering
334 330
335 331 :param kwargs:
336 332 """
337 333
338 334 kwargs['rhodecode_instance_name'] = self.rhodecode_instance_name
339 335 instance_url = h.route_url('home')
340 336 _kwargs = {
341 337 'instance_url': instance_url,
342 338 'whitespace_filter': self.whitespace_filter
343 339 }
344 340 _kwargs.update(kwargs)
345 341 return _kwargs
346 342
347 343 def whitespace_filter(self, text):
348 344 return text.replace('\n', '').replace('\t', '')
349 345
350 346 def get_renderer(self, type_):
351 347 template_name = self.email_types[type_]
352 348 return PartialRenderer(template_name)
353 349
354 350 def render_email(self, type_, **kwargs):
355 351 """
356 352 renders template for email, and returns a tuple of
357 353 (subject, email_headers, email_html_body, email_plaintext_body)
358 354 """
359 355 # translator and helpers inject
360 356 _kwargs = self._update_kwargs_for_render(kwargs)
361 357
362 358 email_template = self.get_renderer(type_)
363 359
364 360 subject = email_template.render('subject', **_kwargs)
365 361
366 362 try:
367 363 headers = email_template.render('headers', **_kwargs)
368 364 except AttributeError:
369 365 # it's not defined in template, ok we can skip it
370 366 headers = ''
371 367
372 368 try:
373 369 body_plaintext = email_template.render('body_plaintext', **_kwargs)
374 370 except AttributeError:
375 371 # it's not defined in template, ok we can skip it
376 372 body_plaintext = ''
377 373
378 374 # render WHOLE template
379 375 body = email_template.render(None, **_kwargs)
380 376
381 377 return subject, headers, body, body_plaintext
@@ -1,46 +1,46 b''
1 1 <%namespace name="base" file="/base/base.mako"/>
2 2
3 3 <div class="panel panel-default">
4 4 <div class="panel-heading">
5 5 <h3 class="panel-title">${_('My notifications')}</h3>
6 6 </div>
7 7
8 8 <div class="panel-body">
9 9 %if c.notifications:
10 10
11 11 <div class="notification-list notification-table">
12 12 %for notification in c.notifications:
13 13 <div id="notification_${notification.notification.notification_id}" class="container ${'unread' if not notification.read else '' }">
14 14 <div class="notification-header">
15 15 <div class="desc ${'unread' if not notification.read else '' }">
16 16 <a href="${h.route_path('notifications_show', notification_id=notification.notification.notification_id)}">
17 17 ${base.gravatar(notification.notification.created_by_user.email, 16)}
18 ${notification.notification.description}
18 ${h.notification_description(notification.notification, request)}
19 19 </a>
20 20 </div>
21 21 <div class="delete-notifications">
22 22 <span onclick="deleteNotification(${notification.notification.notification_id})" class="delete-notification tooltip" title="${_('Delete')}"><i class="icon-delete"></i></span>
23 23 </div>
24 24 <div class="read-notifications">
25 25 %if not notification.read:
26 26 <span onclick="readNotification(${notification.notification.notification_id})" class="read-notification tooltip" title="${_('Mark as read')}"><i class="icon-ok"></i></span>
27 27 %endif
28 28 </div>
29 29 </div>
30 30 <div class="notification-subject"></div>
31 31 </div>
32 32 %endfor
33 33 </div>
34 34
35 35 <div class="notification-paginator">
36 36 <div class="pagination-wh pagination-left">
37 37 ${c.notifications.pager('$link_previous ~2~ $link_next')}
38 38 </div>
39 39 </div>
40 40
41 41 %else:
42 42 <div class="table">${_('No notifications here yet')}</div>
43 43 %endif
44 44
45 45 </div>
46 46 </div>
@@ -1,50 +1,50 b''
1 1 ## -*- coding: utf-8 -*-
2 2 <%inherit file="/base/base.mako"/>
3 3
4 4 <%def name="title()">
5 5 ${_('Show notification')} ${c.rhodecode_user.username}
6 6 %if c.rhodecode_name:
7 7 &middot; ${h.branding(c.rhodecode_name)}
8 8 %endif
9 9 </%def>
10 10
11 11 <%def name="breadcrumbs_links()">
12 12 ${h.link_to(_('My Notifications'), h.route_path('notifications_show_all'))}
13 13 &raquo;
14 14 ${_('Show notification')}
15 15 </%def>
16 16
17 17 <%def name="menu_bar_nav()">
18 18 ${self.menu_items(active='admin')}
19 19 </%def>
20 20
21 21 <%def name="main()">
22 22 <div class="box">
23 23 <!-- box / title -->
24 24 <div class="title">
25 25 ${self.breadcrumbs()}
26 26 </div>
27 27 <div class="table">
28 28 <div id="notification_${c.notification.notification_id}" class="main-content-full">
29 29 <div class="notification-header">
30 30 ${self.gravatar(c.notification.created_by_user.email, 30)}
31 31 <div class="desc">
32 ${c.notification.description}
32 ${h.notification_description(c.notification, request)}
33 33 </div>
34 34 <div class="delete-notifications">
35 35 <span class="delete-notification tooltip" title="${_('Delete')}" onclick="deleteNotification(${c.notification.notification_id}, [function(){window.location=pyroutes.url('notifications_show_all')}])" class="delete-notification action"><i class="icon-delete" ></i></span>
36 36 </div>
37 37 </div>
38 38 <div class="notification-body">
39 39 <div class="notification-subject">
40 40 <h3>${_('Subject')}: ${c.notification.subject}</h3>
41 41 </div>
42 42 %if c.notification.body:
43 43 ${h.render(c.notification.body, renderer=c.visual.default_renderer, mentions=True)}
44 44 %endif
45 45 </div>
46 46 </div>
47 47 </div>
48 48 </div>
49 49
50 50 </%def>
General Comments 0
You need to be logged in to leave comments. Login now