##// END OF EJS Templates
ui: fixed default gravatar b64 code
super-admin -
r5108:2c6a98a4 default
parent child Browse files
Show More
@@ -1,2160 +1,2160 b''
1 1 # Copyright (C) 2010-2023 RhodeCode GmbH
2 2 #
3 3 # This program is free software: you can redistribute it and/or modify
4 4 # it under the terms of the GNU Affero General Public License, version 3
5 5 # (only), as published by the Free Software Foundation.
6 6 #
7 7 # This program is distributed in the hope that it will be useful,
8 8 # but WITHOUT ANY WARRANTY; without even the implied warranty of
9 9 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 10 # GNU General Public License for more details.
11 11 #
12 12 # You should have received a copy of the GNU Affero General Public License
13 13 # along with this program. If not, see <http://www.gnu.org/licenses/>.
14 14 #
15 15 # This program is dual-licensed. If you wish to learn more about the
16 16 # RhodeCode Enterprise Edition, including its added features, Support services,
17 17 # and proprietary license terms, please see https://rhodecode.com/licenses/
18 18
19 19 """
20 20 Helper functions
21 21
22 22 Consists of functions to typically be used within templates, but also
23 23 available to Controllers. This module is available to both as 'h'.
24 24 """
25 25 import base64
26 26 import collections
27 27
28 28 import os
29 29 import random
30 30 import hashlib
31 31 import io
32 32 import textwrap
33 33 import urllib.request
34 34 import urllib.parse
35 35 import urllib.error
36 36 import math
37 37 import logging
38 38 import re
39 39 import time
40 40 import string
41 41 import regex
42 42 from collections import OrderedDict
43 43
44 44 import pygments
45 45 import itertools
46 46 import fnmatch
47 47
48 48 from datetime import datetime
49 49 from functools import partial
50 50 from pygments.formatters.html import HtmlFormatter
51 51 from pygments.lexers import (
52 52 get_lexer_by_name, get_lexer_for_filename, get_lexer_for_mimetype)
53 53
54 54 from pyramid.threadlocal import get_current_request
55 55 from tempita import looper
56 56 from webhelpers2.html import literal, HTML, escape
57 57 from webhelpers2.html._autolink import _auto_link_urls
58 58 from webhelpers2.html.tools import (
59 59 button_to, highlight, js_obfuscate, strip_links, strip_tags)
60 60
61 61 from webhelpers2.text import (
62 62 chop_at, collapse, convert_accented_entities,
63 63 convert_misc_entities, lchop, plural, rchop, remove_formatting,
64 64 replace_whitespace, urlify, truncate, wrap_paragraphs)
65 65 from webhelpers2.date import time_ago_in_words
66 66
67 67 from webhelpers2.html.tags import (
68 68 _input, NotGiven, _make_safe_id_component as safeid,
69 69 form as insecure_form,
70 70 auto_discovery_link, checkbox, end_form, file,
71 71 hidden, image, javascript_link, link_to, link_to_if, link_to_unless, ol,
72 72 stylesheet_link, submit, text, password, textarea,
73 73 ul, radio, Options)
74 74
75 75 from webhelpers2.number import format_byte_size
76 76 # python3.11 backport fixes for webhelpers2
77 77 from rhodecode.lib._vendor.webhelpers_backports import raw_select
78 78
79 79 from rhodecode.lib.action_parser import action_parser
80 80 from rhodecode.lib.html_filters import sanitize_html
81 81 from rhodecode.lib.pagination import Page, RepoPage, SqlPage
82 82 from rhodecode.lib import ext_json
83 83 from rhodecode.lib.ext_json import json
84 from rhodecode.lib.str_utils import safe_bytes, convert_special_chars
84 from rhodecode.lib.str_utils import safe_bytes, convert_special_chars, base64_to_str
85 85 from rhodecode.lib.utils import repo_name_slug, get_custom_lexer
86 86 from rhodecode.lib.str_utils import safe_str
87 87 from rhodecode.lib.utils2 import (
88 88 str2bool,
89 89 get_commit_safe, datetime_to_time, time_to_datetime, time_to_utcdatetime,
90 90 AttributeDict, safe_int, md5, md5_safe, get_host_info)
91 91 from rhodecode.lib.markup_renderer import MarkupRenderer, relative_links
92 92 from rhodecode.lib.vcs.exceptions import CommitDoesNotExistError
93 93 from rhodecode.lib.vcs.backends.base import BaseChangeset, EmptyCommit
94 94 from rhodecode.lib.vcs.conf.settings import ARCHIVE_SPECS
95 95 from rhodecode.lib.index.search_utils import get_matching_line_offsets
96 96 from rhodecode.config.conf import DATE_FORMAT, DATETIME_FORMAT
97 97 from rhodecode.model.changeset_status import ChangesetStatusModel
98 98 from rhodecode.model.db import Permission, User, Repository, UserApiKeys, FileStore
99 99 from rhodecode.model.repo_group import RepoGroupModel
100 100 from rhodecode.model.settings import IssueTrackerSettingsModel
101 101
102 102
103 103 log = logging.getLogger(__name__)
104 104
105 105
106 106 DEFAULT_USER = User.DEFAULT_USER
107 107 DEFAULT_USER_EMAIL = User.DEFAULT_USER_EMAIL
108 108
109 109
110 110 def asset(path, ver=None, **kwargs):
111 111 """
112 112 Helper to generate a static asset file path for rhodecode assets
113 113
114 114 eg. h.asset('images/image.png', ver='3923')
115 115
116 116 :param path: path of asset
117 117 :param ver: optional version query param to append as ?ver=
118 118 """
119 119 request = get_current_request()
120 120 query = {}
121 121 query.update(kwargs)
122 122 if ver:
123 123 query = {'ver': ver}
124 124 return request.static_path(
125 125 f'rhodecode:public/{path}', _query=query)
126 126
127 127
128 128 default_html_escape_table = {
129 129 ord('&'): '&amp;',
130 130 ord('<'): '&lt;',
131 131 ord('>'): '&gt;',
132 132 ord('"'): '&quot;',
133 133 ord("'"): '&#39;',
134 134 }
135 135
136 136
137 137 def html_escape(text, html_escape_table=default_html_escape_table):
138 138 """Produce entities within text."""
139 139 return text.translate(html_escape_table)
140 140
141 141
142 142 def str_json(*args, **kwargs):
143 143 return ext_json.str_json(*args, **kwargs)
144 144
145 145
146 146 def formatted_str_json(*args, **kwargs):
147 147 return ext_json.formatted_str_json(*args, **kwargs)
148 148
149 149
150 150 def chop_at_smart(s, sub, inclusive=False, suffix_if_chopped=None):
151 151 """
152 152 Truncate string ``s`` at the first occurrence of ``sub``.
153 153
154 154 If ``inclusive`` is true, truncate just after ``sub`` rather than at it.
155 155 """
156 156 suffix_if_chopped = suffix_if_chopped or ''
157 157 pos = s.find(sub)
158 158 if pos == -1:
159 159 return s
160 160
161 161 if inclusive:
162 162 pos += len(sub)
163 163
164 164 chopped = s[:pos]
165 165 left = s[pos:].strip()
166 166
167 167 if left and suffix_if_chopped:
168 168 chopped += suffix_if_chopped
169 169
170 170 return chopped
171 171
172 172
173 173 def shorter(text, size=20, prefix=False):
174 174 postfix = '...'
175 175 if len(text) > size:
176 176 if prefix:
177 177 # shorten in front
178 178 return postfix + text[-(size - len(postfix)):]
179 179 else:
180 180 return text[:size - len(postfix)] + postfix
181 181 return text
182 182
183 183
184 184 def reset(name, value=None, id=NotGiven, type="reset", **attrs):
185 185 """
186 186 Reset button
187 187 """
188 188 return _input(type, name, value, id, attrs)
189 189
190 190
191 191 def select(name, selected_values, options, id=NotGiven, **attrs):
192 192
193 193 if isinstance(options, (list, tuple)):
194 194 options_iter = options
195 195 # Handle old value,label lists ... where value also can be value,label lists
196 196 options = Options()
197 197 for opt in options_iter:
198 198 if isinstance(opt, tuple) and len(opt) == 2:
199 199 value, label = opt
200 200 elif isinstance(opt, str):
201 201 value = label = opt
202 202 else:
203 203 raise ValueError('invalid select option type %r' % type(opt))
204 204
205 205 if isinstance(value, (list, tuple)):
206 206 option_group = options.add_optgroup(label)
207 207 for opt2 in value:
208 208 if isinstance(opt2, tuple) and len(opt2) == 2:
209 209 group_value, group_label = opt2
210 210 elif isinstance(opt2, str):
211 211 group_value = group_label = opt2
212 212 else:
213 213 raise ValueError('invalid select option type %r' % type(opt2))
214 214
215 215 option_group.add_option(group_label, group_value)
216 216 else:
217 217 options.add_option(label, value)
218 218
219 219 return raw_select(name, selected_values, options, id=id, **attrs)
220 220
221 221
222 222 def branding(name, length=40):
223 223 return truncate(name, length, indicator="")
224 224
225 225
226 226 def FID(raw_id, path):
227 227 """
228 228 Creates a unique ID for filenode based on it's hash of path and commit
229 229 it's safe to use in urls
230 230
231 231 :param raw_id:
232 232 :param path:
233 233 """
234 234
235 235 return 'c-%s-%s' % (short_id(raw_id), md5_safe(path)[:12])
236 236
237 237
238 238 class _GetError(object):
239 239 """Get error from form_errors, and represent it as span wrapped error
240 240 message
241 241
242 242 :param field_name: field to fetch errors for
243 243 :param form_errors: form errors dict
244 244 """
245 245
246 246 def __call__(self, field_name, form_errors):
247 247 tmpl = """<span class="error_msg">%s</span>"""
248 248 if form_errors and field_name in form_errors:
249 249 return literal(tmpl % form_errors.get(field_name))
250 250
251 251
252 252 get_error = _GetError()
253 253
254 254
255 255 class _ToolTip(object):
256 256
257 257 def __call__(self, tooltip_title, trim_at=50):
258 258 """
259 259 Special function just to wrap our text into nice formatted
260 260 autowrapped text
261 261
262 262 :param tooltip_title:
263 263 """
264 264 tooltip_title = escape(tooltip_title)
265 265 tooltip_title = tooltip_title.replace('<', '&lt;').replace('>', '&gt;')
266 266 return tooltip_title
267 267
268 268
269 269 tooltip = _ToolTip()
270 270
271 271 files_icon = '<i class="file-breadcrumb-copy tooltip icon-clipboard clipboard-action" data-clipboard-text="{}" title="Copy file path"></i>'
272 272
273 273
274 274 def files_breadcrumbs(repo_name, repo_type, commit_id, file_path, landing_ref_name=None, at_ref=None,
275 275 limit_items=False, linkify_last_item=False, hide_last_item=False,
276 276 copy_path_icon=True):
277 277
278 278 if at_ref:
279 279 route_qry = {'at': at_ref}
280 280 default_landing_ref = at_ref or landing_ref_name or commit_id
281 281 else:
282 282 route_qry = None
283 283 default_landing_ref = commit_id
284 284
285 285 # first segment is a `HOME` link to repo files root location
286 286 root_name = literal('<i class="icon-home"></i>')
287 287
288 288 url_segments = [
289 289 link_to(
290 290 root_name,
291 291 repo_files_by_ref_url(
292 292 repo_name,
293 293 repo_type,
294 294 f_path=None, # None here is a special case for SVN repos,
295 295 # that won't prefix with a ref
296 296 ref_name=default_landing_ref,
297 297 commit_id=commit_id,
298 298 query=route_qry
299 299 )
300 300 )]
301 301
302 302 path_segments = file_path.split('/')
303 303 last_cnt = len(path_segments) - 1
304 304 for cnt, segment in enumerate(path_segments):
305 305 if not segment:
306 306 continue
307 307 segment_html = escape(segment)
308 308
309 309 last_item = cnt == last_cnt
310 310
311 311 if last_item and hide_last_item:
312 312 # iterate over and hide last element
313 313 continue
314 314
315 315 if last_item and linkify_last_item is False:
316 316 # plain version
317 317 url_segments.append(segment_html)
318 318 else:
319 319 url_segments.append(
320 320 link_to(
321 321 segment_html,
322 322 repo_files_by_ref_url(
323 323 repo_name,
324 324 repo_type,
325 325 f_path='/'.join(path_segments[:cnt + 1]),
326 326 ref_name=default_landing_ref,
327 327 commit_id=commit_id,
328 328 query=route_qry
329 329 ),
330 330 ))
331 331
332 332 limited_url_segments = url_segments[:1] + ['...'] + url_segments[-5:]
333 333 if limit_items and len(limited_url_segments) < len(url_segments):
334 334 url_segments = limited_url_segments
335 335
336 336 full_path = file_path
337 337 if copy_path_icon:
338 338 icon = files_icon.format(escape(full_path))
339 339 else:
340 340 icon = ''
341 341
342 342 if file_path == '':
343 343 return root_name
344 344 else:
345 345 return literal(' / '.join(url_segments) + icon)
346 346
347 347
348 348 def files_url_data(request):
349 349 matchdict = request.matchdict
350 350
351 351 if 'f_path' not in matchdict:
352 352 matchdict['f_path'] = ''
353 353 else:
354 354 matchdict['f_path'] = urllib.parse.quote(safe_str(matchdict['f_path']))
355 355 if 'commit_id' not in matchdict:
356 356 matchdict['commit_id'] = 'tip'
357 357
358 358 return ext_json.str_json(matchdict)
359 359
360 360
361 361 def repo_files_by_ref_url(db_repo_name, db_repo_type, f_path, ref_name, commit_id, query=None, ):
362 362 _is_svn = is_svn(db_repo_type)
363 363 final_f_path = f_path
364 364
365 365 if _is_svn:
366 366 """
367 367 For SVN the ref_name cannot be used as a commit_id, it needs to be prefixed with
368 368 actually commit_id followed by the ref_name. This should be done only in case
369 369 This is a initial landing url, without additional paths.
370 370
371 371 like: /1000/tags/1.0.0/?at=tags/1.0.0
372 372 """
373 373
374 374 if ref_name and ref_name != 'tip':
375 375 # NOTE(marcink): for svn the ref_name is actually the stored path, so we prefix it
376 376 # for SVN we only do this magic prefix if it's root, .eg landing revision
377 377 # of files link. If we are in the tree we don't need this since we traverse the url
378 378 # that has everything stored
379 379 if f_path in ['', '/']:
380 380 final_f_path = '/'.join([ref_name, f_path])
381 381
382 382 # SVN always needs a commit_id explicitly, without a named REF
383 383 default_commit_id = commit_id
384 384 else:
385 385 """
386 386 For git and mercurial we construct a new URL using the names instead of commit_id
387 387 like: /master/some_path?at=master
388 388 """
389 389 # We currently do not support branches with slashes
390 390 if '/' in ref_name:
391 391 default_commit_id = commit_id
392 392 else:
393 393 default_commit_id = ref_name
394 394
395 395 # sometimes we pass f_path as None, to indicate explicit no prefix,
396 396 # we translate it to string to not have None
397 397 final_f_path = final_f_path or ''
398 398
399 399 files_url = route_path(
400 400 'repo_files',
401 401 repo_name=db_repo_name,
402 402 commit_id=default_commit_id,
403 403 f_path=final_f_path,
404 404 _query=query
405 405 )
406 406 return files_url
407 407
408 408
409 409 def code_highlight(code, lexer, formatter, use_hl_filter=False):
410 410 """
411 411 Lex ``code`` with ``lexer`` and format it with the formatter ``formatter``.
412 412
413 413 If ``outfile`` is given and a valid file object (an object
414 414 with a ``write`` method), the result will be written to it, otherwise
415 415 it is returned as a string.
416 416 """
417 417 if use_hl_filter:
418 418 # add HL filter
419 419 from rhodecode.lib.index import search_utils
420 420 lexer.add_filter(search_utils.ElasticSearchHLFilter())
421 421 return pygments.format(pygments.lex(code, lexer), formatter)
422 422
423 423
424 424 class CodeHtmlFormatter(HtmlFormatter):
425 425 """
426 426 My code Html Formatter for source codes
427 427 """
428 428
429 429 def wrap(self, source):
430 430 return self._wrap_div(self._wrap_pre(self._wrap_code(source)))
431 431
432 432 def _wrap_code(self, source):
433 433 for cnt, it in enumerate(source):
434 434 i, t = it
435 435 t = f'<div id="L{cnt+1}">{t}</div>'
436 436 yield i, t
437 437
438 438 def _wrap_tablelinenos(self, inner):
439 439 dummyoutfile = io.StringIO()
440 440 lncount = 0
441 441 for t, line in inner:
442 442 if t:
443 443 lncount += 1
444 444 dummyoutfile.write(line)
445 445
446 446 fl = self.linenostart
447 447 mw = len(str(lncount + fl - 1))
448 448 sp = self.linenospecial
449 449 st = self.linenostep
450 450 la = self.lineanchors
451 451 aln = self.anchorlinenos
452 452 nocls = self.noclasses
453 453 if sp:
454 454 lines = []
455 455
456 456 for i in range(fl, fl + lncount):
457 457 if i % st == 0:
458 458 if i % sp == 0:
459 459 if aln:
460 460 lines.append('<a href="#%s%d" class="special">%*d</a>' %
461 461 (la, i, mw, i))
462 462 else:
463 463 lines.append('<span class="special">%*d</span>' % (mw, i))
464 464 else:
465 465 if aln:
466 466 lines.append('<a href="#%s%d">%*d</a>' % (la, i, mw, i))
467 467 else:
468 468 lines.append('%*d' % (mw, i))
469 469 else:
470 470 lines.append('')
471 471 ls = '\n'.join(lines)
472 472 else:
473 473 lines = []
474 474 for i in range(fl, fl + lncount):
475 475 if i % st == 0:
476 476 if aln:
477 477 lines.append('<a href="#%s%d">%*d</a>' % (la, i, mw, i))
478 478 else:
479 479 lines.append('%*d' % (mw, i))
480 480 else:
481 481 lines.append('')
482 482 ls = '\n'.join(lines)
483 483
484 484 # in case you wonder about the seemingly redundant <div> here: since the
485 485 # content in the other cell also is wrapped in a div, some browsers in
486 486 # some configurations seem to mess up the formatting...
487 487 if nocls:
488 488 yield 0, ('<table class="%stable">' % self.cssclass +
489 489 '<tr><td><div class="linenodiv" '
490 490 'style="background-color: #f0f0f0; padding-right: 10px">'
491 491 '<pre style="line-height: 125%">' +
492 492 ls + '</pre></div></td><td id="hlcode" class="code">')
493 493 else:
494 494 yield 0, ('<table class="%stable">' % self.cssclass +
495 495 '<tr><td class="linenos"><div class="linenodiv"><pre>' +
496 496 ls + '</pre></div></td><td id="hlcode" class="code">')
497 497 yield 0, dummyoutfile.getvalue()
498 498 yield 0, '</td></tr></table>'
499 499
500 500
501 501 class SearchContentCodeHtmlFormatter(CodeHtmlFormatter):
502 502 def __init__(self, **kw):
503 503 # only show these line numbers if set
504 504 self.only_lines = kw.pop('only_line_numbers', [])
505 505 self.query_terms = kw.pop('query_terms', [])
506 506 self.max_lines = kw.pop('max_lines', 5)
507 507 self.line_context = kw.pop('line_context', 3)
508 508 self.url = kw.pop('url', None)
509 509
510 510 super(CodeHtmlFormatter, self).__init__(**kw)
511 511
512 512 def _wrap_code(self, source):
513 513 for cnt, it in enumerate(source):
514 514 i, t = it
515 515 t = '<pre>%s</pre>' % t
516 516 yield i, t
517 517
518 518 def _wrap_tablelinenos(self, inner):
519 519 yield 0, '<table class="code-highlight %stable">' % self.cssclass
520 520
521 521 last_shown_line_number = 0
522 522 current_line_number = 1
523 523
524 524 for t, line in inner:
525 525 if not t:
526 526 yield t, line
527 527 continue
528 528
529 529 if current_line_number in self.only_lines:
530 530 if last_shown_line_number + 1 != current_line_number:
531 531 yield 0, '<tr>'
532 532 yield 0, '<td class="line">...</td>'
533 533 yield 0, '<td id="hlcode" class="code"></td>'
534 534 yield 0, '</tr>'
535 535
536 536 yield 0, '<tr>'
537 537 if self.url:
538 538 yield 0, '<td class="line"><a href="%s#L%i">%i</a></td>' % (
539 539 self.url, current_line_number, current_line_number)
540 540 else:
541 541 yield 0, '<td class="line"><a href="">%i</a></td>' % (
542 542 current_line_number)
543 543 yield 0, '<td id="hlcode" class="code">' + line + '</td>'
544 544 yield 0, '</tr>'
545 545
546 546 last_shown_line_number = current_line_number
547 547
548 548 current_line_number += 1
549 549
550 550 yield 0, '</table>'
551 551
552 552
553 553 def hsv_to_rgb(h, s, v):
554 554 """ Convert hsv color values to rgb """
555 555
556 556 if s == 0.0:
557 557 return v, v, v
558 558 i = int(h * 6.0) # XXX assume int() truncates!
559 559 f = (h * 6.0) - i
560 560 p = v * (1.0 - s)
561 561 q = v * (1.0 - s * f)
562 562 t = v * (1.0 - s * (1.0 - f))
563 563 i = i % 6
564 564 if i == 0:
565 565 return v, t, p
566 566 if i == 1:
567 567 return q, v, p
568 568 if i == 2:
569 569 return p, v, t
570 570 if i == 3:
571 571 return p, q, v
572 572 if i == 4:
573 573 return t, p, v
574 574 if i == 5:
575 575 return v, p, q
576 576
577 577
578 578 def unique_color_generator(n=10000, saturation=0.10, lightness=0.95):
579 579 """
580 580 Generator for getting n of evenly distributed colors using
581 581 hsv color and golden ratio. It always return same order of colors
582 582
583 583 :param n: number of colors to generate
584 584 :param saturation: saturation of returned colors
585 585 :param lightness: lightness of returned colors
586 586 :returns: RGB tuple
587 587 """
588 588
589 589 golden_ratio = 0.618033988749895
590 590 h = 0.22717784590367374
591 591
592 592 for _ in range(n):
593 593 h += golden_ratio
594 594 h %= 1
595 595 HSV_tuple = [h, saturation, lightness]
596 596 RGB_tuple = hsv_to_rgb(*HSV_tuple)
597 597 yield [str(int(x * 256)) for x in RGB_tuple]
598 598
599 599
600 600 def color_hasher(n=10000, saturation=0.10, lightness=0.95):
601 601 """
602 602 Returns a function which when called with an argument returns a unique
603 603 color for that argument, eg.
604 604
605 605 :param n: number of colors to generate
606 606 :param saturation: saturation of returned colors
607 607 :param lightness: lightness of returned colors
608 608 :returns: css RGB string
609 609
610 610 >>> color_hash = color_hasher()
611 611 >>> color_hash('hello')
612 612 'rgb(34, 12, 59)'
613 613 >>> color_hash('hello')
614 614 'rgb(34, 12, 59)'
615 615 >>> color_hash('other')
616 616 'rgb(90, 224, 159)'
617 617 """
618 618
619 619 color_dict = {}
620 620 cgenerator = unique_color_generator(
621 621 saturation=saturation, lightness=lightness)
622 622
623 623 def get_color_string(thing):
624 624 if thing in color_dict:
625 625 col = color_dict[thing]
626 626 else:
627 627 col = color_dict[thing] = next(cgenerator)
628 628 return "rgb(%s)" % (', '.join(col))
629 629
630 630 return get_color_string
631 631
632 632
633 633 def get_lexer_safe(mimetype=None, filepath=None):
634 634 """
635 635 Tries to return a relevant pygments lexer using mimetype/filepath name,
636 636 defaulting to plain text if none could be found
637 637 """
638 638 lexer = None
639 639 try:
640 640 if mimetype:
641 641 lexer = get_lexer_for_mimetype(mimetype)
642 642 if not lexer:
643 643 lexer = get_lexer_for_filename(filepath)
644 644 except pygments.util.ClassNotFound:
645 645 pass
646 646
647 647 if not lexer:
648 648 lexer = get_lexer_by_name('text')
649 649
650 650 return lexer
651 651
652 652
653 653 def get_lexer_for_filenode(filenode):
654 654 lexer = get_custom_lexer(filenode.extension) or filenode.lexer
655 655 return lexer
656 656
657 657
658 658 def pygmentize(filenode, **kwargs):
659 659 """
660 660 pygmentize function using pygments
661 661
662 662 :param filenode:
663 663 """
664 664 lexer = get_lexer_for_filenode(filenode)
665 665 return literal(code_highlight(filenode.content, lexer,
666 666 CodeHtmlFormatter(**kwargs)))
667 667
668 668
669 669 def is_following_repo(repo_name, user_id):
670 670 from rhodecode.model.scm import ScmModel
671 671 return ScmModel().is_following_repo(repo_name, user_id)
672 672
673 673
674 674 class _Message(object):
675 675 """A message returned by ``Flash.pop_messages()``.
676 676
677 677 Converting the message to a string returns the message text. Instances
678 678 also have the following attributes:
679 679
680 680 * ``message``: the message text.
681 681 * ``category``: the category specified when the message was created.
682 682 """
683 683
684 684 def __init__(self, category, message, sub_data=None):
685 685 self.category = category
686 686 self.message = message
687 687 self.sub_data = sub_data or {}
688 688
689 689 def __str__(self):
690 690 return self.message
691 691
692 692 __unicode__ = __str__
693 693
694 694 def __html__(self):
695 695 return escape(safe_str(self.message))
696 696
697 697
698 698 class Flash(object):
699 699 # List of allowed categories. If None, allow any category.
700 700 categories = ["warning", "notice", "error", "success"]
701 701
702 702 # Default category if none is specified.
703 703 default_category = "notice"
704 704
705 705 def __init__(self, session_key="flash", categories=None,
706 706 default_category=None):
707 707 """
708 708 Instantiate a ``Flash`` object.
709 709
710 710 ``session_key`` is the key to save the messages under in the user's
711 711 session.
712 712
713 713 ``categories`` is an optional list which overrides the default list
714 714 of categories.
715 715
716 716 ``default_category`` overrides the default category used for messages
717 717 when none is specified.
718 718 """
719 719 self.session_key = session_key
720 720 if categories is not None:
721 721 self.categories = categories
722 722 if default_category is not None:
723 723 self.default_category = default_category
724 724 if self.categories and self.default_category not in self.categories:
725 725 raise ValueError(
726 726 "unrecognized default category %r" % (self.default_category,))
727 727
728 728 def pop_messages(self, session=None, request=None):
729 729 """
730 730 Return all accumulated messages and delete them from the session.
731 731
732 732 The return value is a list of ``Message`` objects.
733 733 """
734 734 messages = []
735 735
736 736 if not session:
737 737 if not request:
738 738 request = get_current_request()
739 739 session = request.session
740 740
741 741 # Pop the 'old' pylons flash messages. They are tuples of the form
742 742 # (category, message)
743 743 for cat, msg in session.pop(self.session_key, []):
744 744 messages.append(_Message(cat, msg))
745 745
746 746 # Pop the 'new' pyramid flash messages for each category as list
747 747 # of strings.
748 748 for cat in self.categories:
749 749 for msg in session.pop_flash(queue=cat):
750 750 sub_data = {}
751 751 if hasattr(msg, 'rsplit'):
752 752 flash_data = msg.rsplit('|DELIM|', 1)
753 753 org_message = flash_data[0]
754 754 if len(flash_data) > 1:
755 755 sub_data = json.loads(flash_data[1])
756 756 else:
757 757 org_message = msg
758 758
759 759 messages.append(_Message(cat, org_message, sub_data=sub_data))
760 760
761 761 # Map messages from the default queue to the 'notice' category.
762 762 for msg in session.pop_flash():
763 763 messages.append(_Message('notice', msg))
764 764
765 765 session.save()
766 766 return messages
767 767
768 768 def json_alerts(self, session=None, request=None):
769 769 payloads = []
770 770 messages = flash.pop_messages(session=session, request=request) or []
771 771 for message in messages:
772 772 payloads.append({
773 773 'message': {
774 774 'message': '{}'.format(message.message),
775 775 'level': message.category,
776 776 'force': True,
777 777 'subdata': message.sub_data
778 778 }
779 779 })
780 780 return safe_str(json.dumps(payloads))
781 781
782 782 def __call__(self, message, category=None, ignore_duplicate=True,
783 783 session=None, request=None):
784 784
785 785 if not session:
786 786 if not request:
787 787 request = get_current_request()
788 788 session = request.session
789 789
790 790 session.flash(
791 791 message, queue=category, allow_duplicate=not ignore_duplicate)
792 792
793 793
794 794 flash = Flash()
795 795
796 796 #==============================================================================
797 797 # SCM FILTERS available via h.
798 798 #==============================================================================
799 799 from rhodecode.lib.vcs.utils import author_name, author_email
800 800 from rhodecode.lib.utils2 import age, age_from_seconds
801 801 from rhodecode.model.db import User, ChangesetStatus
802 802
803 803
804 804 email = author_email
805 805
806 806
807 807 def capitalize(raw_text):
808 808 return raw_text.capitalize()
809 809
810 810
811 811 def short_id(long_id):
812 812 return long_id[:12]
813 813
814 814
815 815 def hide_credentials(url):
816 816 from rhodecode.lib.utils2 import credentials_filter
817 817 return credentials_filter(url)
818 818
819 819 import zoneinfo
820 820 import tzlocal
821 821 local_timezone = tzlocal.get_localzone()
822 822
823 823
824 824 def get_timezone(datetime_iso, time_is_local=False):
825 825 tzinfo = '+00:00'
826 826
827 827 # detect if we have a timezone info, otherwise, add it
828 828 if time_is_local and isinstance(datetime_iso, datetime) and not datetime_iso.tzinfo:
829 829 force_timezone = os.environ.get('RC_TIMEZONE', '')
830 830 if force_timezone:
831 831 force_timezone = zoneinfo.ZoneInfo(force_timezone)
832 832 timezone = force_timezone or local_timezone
833 833
834 834 offset = datetime_iso.replace(tzinfo=timezone).strftime('%z')
835 835 tzinfo = '{}:{}'.format(offset[:-2], offset[-2:])
836 836 return tzinfo
837 837
838 838
839 839 def age_component(datetime_iso, value=None, time_is_local=False, tooltip=True):
840 840 title = value or format_date(datetime_iso)
841 841 tzinfo = get_timezone(datetime_iso, time_is_local=time_is_local)
842 842
843 843 return literal(
844 844 '<time class="timeago {cls}" title="{tt_title}" datetime="{dt}{tzinfo}">{title}</time>'.format(
845 845 cls='tooltip' if tooltip else '',
846 846 tt_title=('{title}{tzinfo}'.format(title=title, tzinfo=tzinfo)) if tooltip else '',
847 847 title=title, dt=datetime_iso, tzinfo=tzinfo
848 848 ))
849 849
850 850
851 851 def _shorten_commit_id(commit_id, commit_len=None):
852 852 if commit_len is None:
853 853 request = get_current_request()
854 854 commit_len = request.call_context.visual.show_sha_length
855 855 return commit_id[:commit_len]
856 856
857 857
858 858 def show_id(commit, show_idx=None, commit_len=None):
859 859 """
860 860 Configurable function that shows ID
861 861 by default it's r123:fffeeefffeee
862 862
863 863 :param commit: commit instance
864 864 """
865 865 if show_idx is None:
866 866 request = get_current_request()
867 867 show_idx = request.call_context.visual.show_revision_number
868 868
869 869 raw_id = _shorten_commit_id(commit.raw_id, commit_len=commit_len)
870 870 if show_idx:
871 871 return 'r%s:%s' % (commit.idx, raw_id)
872 872 else:
873 873 return '%s' % (raw_id, )
874 874
875 875
876 876 def format_date(date):
877 877 """
878 878 use a standardized formatting for dates used in RhodeCode
879 879
880 880 :param date: date/datetime object
881 881 :return: formatted date
882 882 """
883 883
884 884 if date:
885 885 _fmt = "%a, %d %b %Y %H:%M:%S"
886 886 return safe_str(date.strftime(_fmt))
887 887
888 888 return ""
889 889
890 890
891 891 class _RepoChecker(object):
892 892
893 893 def __init__(self, backend_alias):
894 894 self._backend_alias = backend_alias
895 895
896 896 def __call__(self, repository):
897 897 if hasattr(repository, 'alias'):
898 898 _type = repository.alias
899 899 elif hasattr(repository, 'repo_type'):
900 900 _type = repository.repo_type
901 901 else:
902 902 _type = repository
903 903 return _type == self._backend_alias
904 904
905 905
906 906 is_git = _RepoChecker('git')
907 907 is_hg = _RepoChecker('hg')
908 908 is_svn = _RepoChecker('svn')
909 909
910 910
911 911 def get_repo_type_by_name(repo_name):
912 912 repo = Repository.get_by_repo_name(repo_name)
913 913 if repo:
914 914 return repo.repo_type
915 915
916 916
917 917 def is_svn_without_proxy(repository):
918 918 if is_svn(repository):
919 919 from rhodecode.model.settings import VcsSettingsModel
920 920 conf = VcsSettingsModel().get_ui_settings_as_config_obj()
921 921 return not str2bool(conf.get('vcs_svn_proxy', 'http_requests_enabled'))
922 922 return False
923 923
924 924
925 925 def discover_user(author):
926 926 """
927 927 Tries to discover RhodeCode User based on the author string. Author string
928 928 is typically `FirstName LastName <email@address.com>`
929 929 """
930 930
931 931 # if author is already an instance use it for extraction
932 932 if isinstance(author, User):
933 933 return author
934 934
935 935 # Valid email in the attribute passed, see if they're in the system
936 936 _email = author_email(author)
937 937 if _email != '':
938 938 user = User.get_by_email(_email, case_insensitive=True, cache=True)
939 939 if user is not None:
940 940 return user
941 941
942 942 # Maybe it's a username, we try to extract it and fetch by username ?
943 943 _author = author_name(author)
944 944 user = User.get_by_username(_author, case_insensitive=True, cache=True)
945 945 if user is not None:
946 946 return user
947 947
948 948 return None
949 949
950 950
951 951 def email_or_none(author):
952 952 # extract email from the commit string
953 953 _email = author_email(author)
954 954
955 955 # If we have an email, use it, otherwise
956 956 # see if it contains a username we can get an email from
957 957 if _email != '':
958 958 return _email
959 959 else:
960 960 user = User.get_by_username(
961 961 author_name(author), case_insensitive=True, cache=True)
962 962
963 963 if user is not None:
964 964 return user.email
965 965
966 966 # No valid email, not a valid user in the system, none!
967 967 return None
968 968
969 969
970 970 def link_to_user(author, length=0, **kwargs):
971 971 user = discover_user(author)
972 972 # user can be None, but if we have it already it means we can re-use it
973 973 # in the person() function, so we save 1 intensive-query
974 974 if user:
975 975 author = user
976 976
977 977 display_person = person(author, 'username_or_name_or_email')
978 978 if length:
979 979 display_person = shorter(display_person, length)
980 980
981 981 if user and user.username != user.DEFAULT_USER:
982 982 return link_to(
983 983 escape(display_person),
984 984 route_path('user_profile', username=user.username),
985 985 **kwargs)
986 986 else:
987 987 return escape(display_person)
988 988
989 989
990 990 def link_to_group(users_group_name, **kwargs):
991 991 return link_to(
992 992 escape(users_group_name),
993 993 route_path('user_group_profile', user_group_name=users_group_name),
994 994 **kwargs)
995 995
996 996
997 997 def person(author, show_attr="username_and_name"):
998 998 user = discover_user(author)
999 999 if user:
1000 1000 return getattr(user, show_attr)
1001 1001 else:
1002 1002 _author = author_name(author)
1003 1003 _email = email(author)
1004 1004 return _author or _email
1005 1005
1006 1006
1007 1007 def author_string(email):
1008 1008 if email:
1009 1009 user = User.get_by_email(email, case_insensitive=True, cache=True)
1010 1010 if user:
1011 1011 if user.first_name or user.last_name:
1012 1012 return '%s %s &lt;%s&gt;' % (
1013 1013 user.first_name, user.last_name, email)
1014 1014 else:
1015 1015 return email
1016 1016 else:
1017 1017 return email
1018 1018 else:
1019 1019 return None
1020 1020
1021 1021
1022 1022 def person_by_id(id_, show_attr="username_and_name"):
1023 1023 # attr to return from fetched user
1024 1024 def person_getter(usr):
1025 1025 return getattr(usr, show_attr)
1026 1026
1027 1027 #maybe it's an ID ?
1028 1028 if str(id_).isdigit() or isinstance(id_, int):
1029 1029 id_ = int(id_)
1030 1030 user = User.get(id_)
1031 1031 if user is not None:
1032 1032 return person_getter(user)
1033 1033 return id_
1034 1034
1035 1035
1036 1036 def gravatar_with_user(request, author, show_disabled=False, tooltip=False):
1037 1037 _render = request.get_partial_renderer('rhodecode:templates/base/base.mako')
1038 1038 return _render('gravatar_with_user', author, show_disabled=show_disabled, tooltip=tooltip)
1039 1039
1040 1040
1041 1041 tags_paterns = OrderedDict((
1042 1042 ('lang', (re.compile(r'\[(lang|language)\ \=\&gt;\ *([a-zA-Z\-\/\#\+\.]*)\]'),
1043 1043 '<div class="metatag" tag="lang">\\2</div>')),
1044 1044
1045 1045 ('see', (re.compile(r'\[see\ \=\&gt;\ *([a-zA-Z0-9\/\=\?\&amp;\ \:\/\.\-]*)\]'),
1046 1046 '<div class="metatag" tag="see">see: \\1 </div>')),
1047 1047
1048 1048 ('url', (re.compile(r'\[url\ \=\&gt;\ \[([a-zA-Z0-9\ \.\-\_]+)\]\((http://|https://|/)(.*?)\)\]'),
1049 1049 '<div class="metatag" tag="url"> <a href="\\2\\3">\\1</a> </div>')),
1050 1050
1051 1051 ('license', (re.compile(r'\[license\ \=\&gt;\ *([a-zA-Z0-9\/\=\?\&amp;\ \:\/\.\-]*)\]'),
1052 1052 '<div class="metatag" tag="license"><a href="http:\/\/www.opensource.org/licenses/\\1">\\1</a></div>')),
1053 1053
1054 1054 ('ref', (re.compile(r'\[(requires|recommends|conflicts|base)\ \=\&gt;\ *([a-zA-Z0-9\-\/]*)\]'),
1055 1055 '<div class="metatag" tag="ref \\1">\\1: <a href="/\\2">\\2</a></div>')),
1056 1056
1057 1057 ('state', (re.compile(r'\[(stable|featured|stale|dead|dev|deprecated)\]'),
1058 1058 '<div class="metatag" tag="state \\1">\\1</div>')),
1059 1059
1060 1060 # label in grey
1061 1061 ('label', (re.compile(r'\[([a-z]+)\]'),
1062 1062 '<div class="metatag" tag="label">\\1</div>')),
1063 1063
1064 1064 # generic catch all in grey
1065 1065 ('generic', (re.compile(r'\[([a-zA-Z0-9\.\-\_]+)\]'),
1066 1066 '<div class="metatag" tag="generic">\\1</div>')),
1067 1067 ))
1068 1068
1069 1069
1070 1070 def extract_metatags(value):
1071 1071 """
1072 1072 Extract supported meta-tags from given text value
1073 1073 """
1074 1074 tags = []
1075 1075 if not value:
1076 1076 return tags, ''
1077 1077
1078 1078 for key, val in list(tags_paterns.items()):
1079 1079 pat, replace_html = val
1080 1080 tags.extend([(key, x.group()) for x in pat.finditer(value)])
1081 1081 value = pat.sub('', value)
1082 1082
1083 1083 return tags, value
1084 1084
1085 1085
1086 1086 def style_metatag(tag_type, value):
1087 1087 """
1088 1088 converts tags from value into html equivalent
1089 1089 """
1090 1090 if not value:
1091 1091 return ''
1092 1092
1093 1093 html_value = value
1094 1094 tag_data = tags_paterns.get(tag_type)
1095 1095 if tag_data:
1096 1096 pat, replace_html = tag_data
1097 1097 # convert to plain `str` instead of a markup tag to be used in
1098 1098 # regex expressions. safe_str doesn't work here
1099 1099 html_value = pat.sub(replace_html, value)
1100 1100
1101 1101 return html_value
1102 1102
1103 1103
1104 1104 def bool2icon(value, show_at_false=True):
1105 1105 """
1106 1106 Returns boolean value of a given value, represented as html element with
1107 1107 classes that will represent icons
1108 1108
1109 1109 :param value: given value to convert to html node
1110 1110 """
1111 1111
1112 1112 if value: # does bool conversion
1113 1113 return HTML.tag('i', class_="icon-true", title='True')
1114 1114 else: # not true as bool
1115 1115 if show_at_false:
1116 1116 return HTML.tag('i', class_="icon-false", title='False')
1117 1117 return HTML.tag('i')
1118 1118
1119 1119
1120 1120 def b64(inp):
1121 1121 return base64.b64encode(safe_bytes(inp))
1122 1122
1123 1123 #==============================================================================
1124 1124 # PERMS
1125 1125 #==============================================================================
1126 1126 from rhodecode.lib.auth import (
1127 1127 HasPermissionAny, HasPermissionAll,
1128 1128 HasRepoPermissionAny, HasRepoPermissionAll, HasRepoGroupPermissionAll,
1129 1129 HasRepoGroupPermissionAny, HasRepoPermissionAnyApi, get_csrf_token,
1130 1130 csrf_token_key, AuthUser)
1131 1131
1132 1132
1133 1133 #==============================================================================
1134 1134 # GRAVATAR URL
1135 1135 #==============================================================================
1136 1136 class InitialsGravatar(object):
1137 1137 def __init__(self, email_address, first_name, last_name, size=30,
1138 1138 background=None, text_color='#fff'):
1139 1139 self.size = size
1140 1140 self.first_name = first_name
1141 1141 self.last_name = last_name
1142 1142 self.email_address = email_address
1143 1143 self.background = background or self.str2color(email_address)
1144 1144 self.text_color = text_color
1145 1145
1146 1146 def get_color_bank(self):
1147 1147 """
1148 1148 returns a predefined list of colors that gravatars can use.
1149 1149 Those are randomized distinct colors that guarantee readability and
1150 1150 uniqueness.
1151 1151
1152 1152 generated with: http://phrogz.net/css/distinct-colors.html
1153 1153 """
1154 1154 return [
1155 1155 '#bf3030', '#a67f53', '#00ff00', '#5989b3', '#392040', '#d90000',
1156 1156 '#402910', '#204020', '#79baf2', '#a700b3', '#bf6060', '#7f5320',
1157 1157 '#008000', '#003059', '#ee00ff', '#ff0000', '#8c4b00', '#007300',
1158 1158 '#005fb3', '#de73e6', '#ff4040', '#ffaa00', '#3df255', '#203140',
1159 1159 '#47004d', '#591616', '#664400', '#59b365', '#0d2133', '#83008c',
1160 1160 '#592d2d', '#bf9f60', '#73e682', '#1d3f73', '#73006b', '#402020',
1161 1161 '#b2862d', '#397341', '#597db3', '#e600d6', '#a60000', '#736039',
1162 1162 '#00b318', '#79aaf2', '#330d30', '#ff8080', '#403010', '#16591f',
1163 1163 '#002459', '#8c4688', '#e50000', '#ffbf40', '#00732e', '#102340',
1164 1164 '#bf60ac', '#8c4646', '#cc8800', '#00a642', '#1d3473', '#b32d98',
1165 1165 '#660e00', '#ffd580', '#80ffb2', '#7391e6', '#733967', '#d97b6c',
1166 1166 '#8c5e00', '#59b389', '#3967e6', '#590047', '#73281d', '#665200',
1167 1167 '#00e67a', '#2d50b3', '#8c2377', '#734139', '#b2982d', '#16593a',
1168 1168 '#001859', '#ff00aa', '#a65e53', '#ffcc00', '#0d3321', '#2d3959',
1169 1169 '#731d56', '#401610', '#4c3d00', '#468c6c', '#002ca6', '#d936a3',
1170 1170 '#d94c36', '#403920', '#36d9a3', '#0d1733', '#592d4a', '#993626',
1171 1171 '#cca300', '#00734d', '#46598c', '#8c005e', '#7f1100', '#8c7000',
1172 1172 '#00a66f', '#7382e6', '#b32d74', '#d9896c', '#ffe680', '#1d7362',
1173 1173 '#364cd9', '#73003d', '#d93a00', '#998a4d', '#59b3a1', '#5965b3',
1174 1174 '#e5007a', '#73341d', '#665f00', '#00b38f', '#0018b3', '#59163a',
1175 1175 '#b2502d', '#bfb960', '#00ffcc', '#23318c', '#a6537f', '#734939',
1176 1176 '#b2a700', '#104036', '#3d3df2', '#402031', '#e56739', '#736f39',
1177 1177 '#79f2ea', '#000059', '#401029', '#4c1400', '#ffee00', '#005953',
1178 1178 '#101040', '#990052', '#402820', '#403d10', '#00ffee', '#0000d9',
1179 1179 '#ff80c4', '#a66953', '#eeff00', '#00ccbe', '#8080ff', '#e673a1',
1180 1180 '#a62c00', '#474d00', '#1a3331', '#46468c', '#733950', '#662900',
1181 1181 '#858c23', '#238c85', '#0f0073', '#b20047', '#d9986c', '#becc00',
1182 1182 '#396f73', '#281d73', '#ff0066', '#ff6600', '#dee673', '#59adb3',
1183 1183 '#6559b3', '#590024', '#b2622d', '#98b32d', '#36ced9', '#332d59',
1184 1184 '#40001a', '#733f1d', '#526600', '#005359', '#242040', '#bf6079',
1185 1185 '#735039', '#cef23d', '#007780', '#5630bf', '#66001b', '#b24700',
1186 1186 '#acbf60', '#1d6273', '#25008c', '#731d34', '#a67453', '#50592d',
1187 1187 '#00ccff', '#6600ff', '#ff0044', '#4c1f00', '#8a994d', '#79daf2',
1188 1188 '#a173e6', '#d93662', '#402310', '#aaff00', '#2d98b3', '#8c40ff',
1189 1189 '#592d39', '#ff8c40', '#354020', '#103640', '#1a0040', '#331a20',
1190 1190 '#331400', '#334d00', '#1d5673', '#583973', '#7f0022', '#4c3626',
1191 1191 '#88cc00', '#36a3d9', '#3d0073', '#d9364c', '#33241a', '#698c23',
1192 1192 '#5995b3', '#300059', '#e57382', '#7f3300', '#366600', '#00aaff',
1193 1193 '#3a1659', '#733941', '#663600', '#74b32d', '#003c59', '#7f53a6',
1194 1194 '#73000f', '#ff8800', '#baf279', '#79caf2', '#291040', '#a6293a',
1195 1195 '#b2742d', '#587339', '#0077b3', '#632699', '#400009', '#d9a66c',
1196 1196 '#294010', '#2d4a59', '#aa00ff', '#4c131b', '#b25f00', '#5ce600',
1197 1197 '#267399', '#a336d9', '#990014', '#664e33', '#86bf60', '#0088ff',
1198 1198 '#7700b3', '#593a16', '#073300', '#1d4b73', '#ac60bf', '#e59539',
1199 1199 '#4f8c46', '#368dd9', '#5c0073'
1200 1200 ]
1201 1201
1202 1202 def rgb_to_hex_color(self, rgb_tuple):
1203 1203 """
1204 1204 Converts an rgb_tuple passed to an hex color.
1205 1205
1206 1206 :param rgb_tuple: tuple with 3 ints represents rgb color space
1207 1207 """
1208 1208 return '#' + ("".join(map(chr, rgb_tuple)).encode('hex'))
1209 1209
1210 1210 def email_to_int_list(self, email_str):
1211 1211 """
1212 1212 Get every byte of the hex digest value of email and turn it to integer.
1213 1213 It's going to be always between 0-255
1214 1214 """
1215 1215 digest = md5_safe(email_str.lower())
1216 1216 return [int(digest[i * 2:i * 2 + 2], 16) for i in range(16)]
1217 1217
1218 1218 def pick_color_bank_index(self, email_str, color_bank):
1219 1219 return self.email_to_int_list(email_str)[0] % len(color_bank)
1220 1220
1221 1221 def str2color(self, email_str):
1222 1222 """
1223 1223 Tries to map in a stable algorithm an email to color
1224 1224
1225 1225 :param email_str:
1226 1226 """
1227 1227 color_bank = self.get_color_bank()
1228 1228 # pick position (module it's length so we always find it in the
1229 1229 # bank even if it's smaller than 256 values
1230 1230 pos = self.pick_color_bank_index(email_str, color_bank)
1231 1231 return color_bank[pos]
1232 1232
1233 1233 def normalize_email(self, email_address):
1234 1234 # default host used to fill in the fake/missing email
1235 1235 default_host = 'localhost'
1236 1236
1237 1237 if not email_address:
1238 1238 email_address = f'{User.DEFAULT_USER}@{default_host}'
1239 1239
1240 1240 email_address = safe_str(email_address)
1241 1241
1242 1242 if '@' not in email_address:
1243 1243 email_address = f'{email_address}@{default_host}'
1244 1244
1245 1245 if email_address.endswith('@'):
1246 1246 email_address = f'{email_address}{default_host}'
1247 1247
1248 1248 email_address = convert_special_chars(email_address)
1249 1249
1250 1250 return email_address
1251 1251
1252 1252 def get_initials(self):
1253 1253 """
1254 1254 Returns 2 letter initials calculated based on the input.
1255 1255 The algorithm picks first given email address, and takes first letter
1256 1256 of part before @, and then the first letter of server name. In case
1257 1257 the part before @ is in a format of `somestring.somestring2` it replaces
1258 1258 the server letter with first letter of somestring2
1259 1259
1260 1260 In case function was initialized with both first and lastname, this
1261 1261 overrides the extraction from email by first letter of the first and
1262 1262 last name. We add special logic to that functionality, In case Full name
1263 1263 is compound, like Guido Von Rossum, we use last part of the last name
1264 1264 (Von Rossum) picking `R`.
1265 1265
1266 1266 Function also normalizes the non-ascii characters to they ascii
1267 1267 representation, eg Δ„ => A
1268 1268 """
1269 1269 # replace non-ascii to ascii
1270 1270 first_name = convert_special_chars(self.first_name)
1271 1271 last_name = convert_special_chars(self.last_name)
1272 1272 # multi word last names, Guido Von Rossum, we take the last part only
1273 1273 last_name = last_name.split(' ', 1)[-1]
1274 1274
1275 1275 # do NFKD encoding, and also make sure email has proper format
1276 1276 email_address = self.normalize_email(self.email_address)
1277 1277
1278 1278 # first push the email initials
1279 1279 prefix, server = email_address.split('@', 1)
1280 1280
1281 1281 # check if prefix is maybe a 'first_name.last_name' syntax
1282 1282 _dot_split = prefix.rsplit('.', 1)
1283 1283 if len(_dot_split) == 2 and _dot_split[1]:
1284 1284 initials = [_dot_split[0][0], _dot_split[1][0]]
1285 1285 else:
1286 1286 initials = [prefix[0], server[0]]
1287 1287
1288 1288 # get first letter of first and last names to create initials
1289 1289 fn_letter = (first_name or " ")[0].strip()
1290 1290 ln_letter = (last_name or " ")[0].strip()
1291 1291
1292 1292 if fn_letter:
1293 1293 initials[0] = fn_letter
1294 1294
1295 1295 if ln_letter:
1296 1296 initials[1] = ln_letter
1297 1297
1298 1298 return ''.join(initials).upper()
1299 1299
1300 1300 def get_img_data_by_type(self, font_family, img_type):
1301 1301 default_user = """
1302 1302 <svg xmlns="http://www.w3.org/2000/svg"
1303 1303 version="1.1" x="0px" y="0px" width="{size}" height="{size}"
1304 1304 viewBox="-15 -10 439.165 429.164"
1305 1305
1306 1306 xml:space="preserve"
1307 font-family="{font_family}
1307 font-family="{font_family}"
1308 1308 style="background:{background};" >
1309 1309
1310 1310 <path d="M204.583,216.671c50.664,0,91.74-48.075,
1311 1311 91.74-107.378c0-82.237-41.074-107.377-91.74-107.377
1312 1312 c-50.668,0-91.74,25.14-91.74,107.377C112.844,
1313 1313 168.596,153.916,216.671,
1314 1314 204.583,216.671z" fill="{text_color}"/>
1315 1315 <path d="M407.164,374.717L360.88,
1316 1316 270.454c-2.117-4.771-5.836-8.728-10.465-11.138l-71.83-37.392
1317 1317 c-1.584-0.823-3.502-0.663-4.926,0.415c-20.316,
1318 1318 15.366-44.203,23.488-69.076,23.488c-24.877,
1319 1319 0-48.762-8.122-69.078-23.488
1320 1320 c-1.428-1.078-3.346-1.238-4.93-0.415L58.75,
1321 1321 259.316c-4.631,2.41-8.346,6.365-10.465,11.138L2.001,374.717
1322 1322 c-3.191,7.188-2.537,15.412,1.75,22.005c4.285,
1323 1323 6.592,11.537,10.526,19.4,10.526h362.861c7.863,0,15.117-3.936,
1324 1324 19.402-10.527 C409.699,390.129,
1325 1325 410.355,381.902,407.164,374.717z" fill="{text_color}"/>
1326 1326 </svg>""".format(
1327 1327 size=self.size,
1328 1328 background='#979797', # @grey4
1329 1329 text_color=self.text_color,
1330 1330 font_family=font_family)
1331 1331
1332 1332 return {
1333 1333 "default_user": default_user
1334 1334 }[img_type]
1335 1335
1336 1336 def get_img_data(self, svg_type=None):
1337 1337 """
1338 1338 generates the svg metadata for image
1339 1339 """
1340 1340 fonts = [
1341 1341 '-apple-system',
1342 1342 'BlinkMacSystemFont',
1343 1343 'Segoe UI',
1344 1344 'Roboto',
1345 1345 'Oxygen-Sans',
1346 1346 'Ubuntu',
1347 1347 'Cantarell',
1348 1348 'Helvetica Neue',
1349 1349 'sans-serif'
1350 1350 ]
1351 1351 font_family = ','.join(fonts)
1352 1352 if svg_type:
1353 1353 return self.get_img_data_by_type(font_family, svg_type)
1354 1354
1355 1355 initials = self.get_initials()
1356 1356 img_data = """
1357 1357 <svg xmlns="http://www.w3.org/2000/svg" pointer-events="none"
1358 1358 width="{size}" height="{size}"
1359 1359 style="width: 100%; height: 100%; background-color: {background}"
1360 1360 viewBox="0 0 {size} {size}">
1361 1361 <text text-anchor="middle" y="50%" x="50%" dy="0.35em"
1362 1362 pointer-events="auto" fill="{text_color}"
1363 1363 font-family="{font_family}"
1364 1364 style="font-weight: 400; font-size: {f_size}px;">{text}
1365 1365 </text>
1366 1366 </svg>""".format(
1367 1367 size=self.size,
1368 1368 f_size=self.size/2.05, # scale the text inside the box nicely
1369 1369 background=self.background,
1370 1370 text_color=self.text_color,
1371 1371 text=initials.upper(),
1372 1372 font_family=font_family)
1373 1373
1374 1374 return img_data
1375 1375
1376 1376 def generate_svg(self, svg_type=None):
1377 img_data = safe_bytes(self.get_img_data(svg_type))
1378 return "data:image/svg+xml;base64,%s" % safe_str(base64.b64encode(img_data))
1377 img_data = base64_to_str(self.get_img_data(svg_type))
1378 return "data:image/svg+xml;base64,{}".format(img_data)
1379 1379
1380 1380
1381 1381 def initials_gravatar(request, email_address, first_name, last_name, size=30, store_on_disk=False):
1382 1382
1383 1383 svg_type = None
1384 1384 if email_address == User.DEFAULT_USER_EMAIL:
1385 1385 svg_type = 'default_user'
1386 1386
1387 1387 klass = InitialsGravatar(email_address, first_name, last_name, size)
1388 1388
1389 1389 if store_on_disk:
1390 1390 from rhodecode.apps.file_store import utils as store_utils
1391 1391 from rhodecode.apps.file_store.exceptions import FileNotAllowedException, \
1392 1392 FileOverSizeException
1393 1393 from rhodecode.model.db import Session
1394 1394
1395 1395 image_key = md5_safe(email_address.lower()
1396 1396 + first_name.lower() + last_name.lower())
1397 1397
1398 1398 storage = store_utils.get_file_storage(request.registry.settings)
1399 1399 filename = '{}.svg'.format(image_key)
1400 1400 subdir = 'gravatars'
1401 1401 # since final name has a counter, we apply the 0
1402 1402 uid = storage.apply_counter(0, store_utils.uid_filename(filename, randomized=False))
1403 1403 store_uid = os.path.join(subdir, uid)
1404 1404
1405 1405 db_entry = FileStore.get_by_store_uid(store_uid)
1406 1406 if db_entry:
1407 1407 return request.route_path('download_file', fid=store_uid)
1408 1408
1409 1409 img_data = klass.get_img_data(svg_type=svg_type)
1410 1410 img_file = store_utils.bytes_to_file_obj(img_data)
1411 1411
1412 1412 try:
1413 1413 store_uid, metadata = storage.save_file(
1414 1414 img_file, filename, directory=subdir,
1415 1415 extensions=['.svg'], randomized_name=False)
1416 1416 except (FileNotAllowedException, FileOverSizeException):
1417 1417 raise
1418 1418
1419 1419 try:
1420 1420 entry = FileStore.create(
1421 1421 file_uid=store_uid, filename=metadata["filename"],
1422 1422 file_hash=metadata["sha256"], file_size=metadata["size"],
1423 1423 file_display_name=filename,
1424 1424 file_description=f'user gravatar `{safe_str(filename)}`',
1425 1425 hidden=True, check_acl=False, user_id=1
1426 1426 )
1427 1427 Session().add(entry)
1428 1428 Session().commit()
1429 1429 log.debug('Stored upload in DB as %s', entry)
1430 1430 except Exception:
1431 1431 raise
1432 1432
1433 1433 return request.route_path('download_file', fid=store_uid)
1434 1434
1435 1435 else:
1436 1436 return klass.generate_svg(svg_type=svg_type)
1437 1437
1438 1438
1439 1439 def gravatar_external(request, gravatar_url_tmpl, email_address, size=30):
1440 1440 return safe_str(gravatar_url_tmpl)\
1441 1441 .replace('{email}', email_address) \
1442 1442 .replace('{md5email}', md5_safe(email_address.lower())) \
1443 1443 .replace('{netloc}', request.host) \
1444 1444 .replace('{scheme}', request.scheme) \
1445 1445 .replace('{size}', safe_str(size))
1446 1446
1447 1447
1448 1448 def gravatar_url(email_address, size=30, request=None):
1449 1449 request = request or get_current_request()
1450 1450 _use_gravatar = request.call_context.visual.use_gravatar
1451 1451
1452 1452 email_address = email_address or User.DEFAULT_USER_EMAIL
1453 1453 if isinstance(email_address, str):
1454 1454 # hashlib crashes on unicode items
1455 1455 email_address = safe_str(email_address)
1456 1456
1457 1457 # empty email or default user
1458 1458 if not email_address or email_address == User.DEFAULT_USER_EMAIL:
1459 1459 return initials_gravatar(request, User.DEFAULT_USER_EMAIL, '', '', size=size)
1460 1460
1461 1461 if _use_gravatar:
1462 1462 gravatar_url_tmpl = request.call_context.visual.gravatar_url \
1463 1463 or User.DEFAULT_GRAVATAR_URL
1464 1464 return gravatar_external(request, gravatar_url_tmpl, email_address, size=size)
1465 1465
1466 1466 else:
1467 1467 return initials_gravatar(request, email_address, '', '', size=size)
1468 1468
1469 1469
1470 1470 def breadcrumb_repo_link(repo):
1471 1471 """
1472 1472 Makes a breadcrumbs path link to repo
1473 1473
1474 1474 ex::
1475 1475 group >> subgroup >> repo
1476 1476
1477 1477 :param repo: a Repository instance
1478 1478 """
1479 1479
1480 1480 path = [
1481 1481 link_to(group.name, route_path('repo_group_home', repo_group_name=group.group_name),
1482 1482 title='last change:{}'.format(format_date(group.last_commit_change)))
1483 1483 for group in repo.groups_with_parents
1484 1484 ] + [
1485 1485 link_to(repo.just_name, route_path('repo_summary', repo_name=repo.repo_name),
1486 1486 title='last change:{}'.format(format_date(repo.last_commit_change)))
1487 1487 ]
1488 1488
1489 1489 return literal(' &raquo; '.join(path))
1490 1490
1491 1491
1492 1492 def breadcrumb_repo_group_link(repo_group):
1493 1493 """
1494 1494 Makes a breadcrumbs path link to repo
1495 1495
1496 1496 ex::
1497 1497 group >> subgroup
1498 1498
1499 1499 :param repo_group: a Repository Group instance
1500 1500 """
1501 1501
1502 1502 path = [
1503 1503 link_to(group.name,
1504 1504 route_path('repo_group_home', repo_group_name=group.group_name),
1505 1505 title='last change:{}'.format(format_date(group.last_commit_change)))
1506 1506 for group in repo_group.parents
1507 1507 ] + [
1508 1508 link_to(repo_group.name,
1509 1509 route_path('repo_group_home', repo_group_name=repo_group.group_name),
1510 1510 title='last change:{}'.format(format_date(repo_group.last_commit_change)))
1511 1511 ]
1512 1512
1513 1513 return literal(' &raquo; '.join(path))
1514 1514
1515 1515
1516 1516 def format_byte_size_binary(file_size):
1517 1517 """
1518 1518 Formats file/folder sizes to standard.
1519 1519 """
1520 1520 if file_size is None:
1521 1521 file_size = 0
1522 1522
1523 1523 formatted_size = format_byte_size(file_size, binary=True)
1524 1524 return formatted_size
1525 1525
1526 1526
1527 1527 def urlify_text(text_, safe=True, **href_attrs):
1528 1528 """
1529 1529 Extract urls from text and make html links out of them
1530 1530 """
1531 1531
1532 1532 url_pat = re.compile(r'''(http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@#.&+]'''
1533 1533 '''|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+)''')
1534 1534
1535 1535 def url_func(match_obj):
1536 1536 url_full = match_obj.groups()[0]
1537 1537 a_options = dict(href_attrs)
1538 1538 a_options['href'] = url_full
1539 1539 a_text = url_full
1540 1540 return HTML.tag("a", a_text, **a_options)
1541 1541
1542 1542 _new_text = url_pat.sub(url_func, text_)
1543 1543
1544 1544 if safe:
1545 1545 return literal(_new_text)
1546 1546 return _new_text
1547 1547
1548 1548
1549 1549 def urlify_commits(text_, repo_name):
1550 1550 """
1551 1551 Extract commit ids from text and make link from them
1552 1552
1553 1553 :param text_:
1554 1554 :param repo_name: repo name to build the URL with
1555 1555 """
1556 1556
1557 1557 url_pat = re.compile(r'(^|\s)([0-9a-fA-F]{12,40})($|\s)')
1558 1558
1559 1559 def url_func(match_obj):
1560 1560 commit_id = match_obj.groups()[1]
1561 1561 pref = match_obj.groups()[0]
1562 1562 suf = match_obj.groups()[2]
1563 1563
1564 1564 tmpl = (
1565 1565 '%(pref)s<a class="tooltip-hovercard %(cls)s" href="%(url)s" data-hovercard-alt="%(hovercard_alt)s" data-hovercard-url="%(hovercard_url)s">'
1566 1566 '%(commit_id)s</a>%(suf)s'
1567 1567 )
1568 1568 return tmpl % {
1569 1569 'pref': pref,
1570 1570 'cls': 'revision-link',
1571 1571 'url': route_url(
1572 1572 'repo_commit', repo_name=repo_name, commit_id=commit_id),
1573 1573 'commit_id': commit_id,
1574 1574 'suf': suf,
1575 1575 'hovercard_alt': 'Commit: {}'.format(commit_id),
1576 1576 'hovercard_url': route_url(
1577 1577 'hovercard_repo_commit', repo_name=repo_name, commit_id=commit_id)
1578 1578 }
1579 1579
1580 1580 new_text = url_pat.sub(url_func, text_)
1581 1581
1582 1582 return new_text
1583 1583
1584 1584
1585 1585 def _process_url_func(match_obj, repo_name, uid, entry,
1586 1586 return_raw_data=False, link_format='html'):
1587 1587 pref = ''
1588 1588 if match_obj.group().startswith(' '):
1589 1589 pref = ' '
1590 1590
1591 1591 issue_id = ''.join(match_obj.groups())
1592 1592
1593 1593 if link_format == 'html':
1594 1594 tmpl = (
1595 1595 '%(pref)s<a class="tooltip %(cls)s" href="%(url)s" title="%(title)s">'
1596 1596 '%(issue-prefix)s%(id-repr)s'
1597 1597 '</a>')
1598 1598 elif link_format == 'html+hovercard':
1599 1599 tmpl = (
1600 1600 '%(pref)s<a class="tooltip-hovercard %(cls)s" href="%(url)s" data-hovercard-url="%(hovercard_url)s">'
1601 1601 '%(issue-prefix)s%(id-repr)s'
1602 1602 '</a>')
1603 1603 elif link_format in ['rst', 'rst+hovercard']:
1604 1604 tmpl = '`%(issue-prefix)s%(id-repr)s <%(url)s>`_'
1605 1605 elif link_format in ['markdown', 'markdown+hovercard']:
1606 1606 tmpl = '[%(pref)s%(issue-prefix)s%(id-repr)s](%(url)s)'
1607 1607 else:
1608 1608 raise ValueError('Bad link_format:{}'.format(link_format))
1609 1609
1610 1610 (repo_name_cleaned,
1611 1611 parent_group_name) = RepoGroupModel()._get_group_name_and_parent(repo_name)
1612 1612
1613 1613 # variables replacement
1614 1614 named_vars = {
1615 1615 'id': issue_id,
1616 1616 'repo': repo_name,
1617 1617 'repo_name': repo_name_cleaned,
1618 1618 'group_name': parent_group_name,
1619 1619 # set dummy keys so we always have them
1620 1620 'hostname': '',
1621 1621 'netloc': '',
1622 1622 'scheme': ''
1623 1623 }
1624 1624
1625 1625 request = get_current_request()
1626 1626 if request:
1627 1627 # exposes, hostname, netloc, scheme
1628 1628 host_data = get_host_info(request)
1629 1629 named_vars.update(host_data)
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 desc = string.Template(escape(entry['desc'])).safe_substitute(**named_vars)
1635 1635 hovercard_url = string.Template(entry.get('hovercard_url', '')).safe_substitute(**named_vars)
1636 1636
1637 1637 def quote_cleaner(input_str):
1638 1638 """Remove quotes as it's HTML"""
1639 1639 return input_str.replace('"', '')
1640 1640
1641 1641 data = {
1642 1642 'pref': pref,
1643 1643 'cls': quote_cleaner('issue-tracker-link'),
1644 1644 'url': quote_cleaner(_url),
1645 1645 'id-repr': issue_id,
1646 1646 'issue-prefix': entry['pref'],
1647 1647 'serv': entry['url'],
1648 1648 'title': sanitize_html(desc, strip=True),
1649 1649 'hovercard_url': hovercard_url
1650 1650 }
1651 1651
1652 1652 if return_raw_data:
1653 1653 return {
1654 1654 'id': issue_id,
1655 1655 'url': _url
1656 1656 }
1657 1657 return tmpl % data
1658 1658
1659 1659
1660 1660 def get_active_pattern_entries(repo_name):
1661 1661 repo = None
1662 1662 if repo_name:
1663 1663 # Retrieving repo_name to avoid invalid repo_name to explode on
1664 1664 # IssueTrackerSettingsModel but still passing invalid name further down
1665 1665 repo = Repository.get_by_repo_name(repo_name, cache=True)
1666 1666
1667 1667 settings_model = IssueTrackerSettingsModel(repo=repo)
1668 1668 active_entries = settings_model.get_settings(cache=True)
1669 1669 return active_entries
1670 1670
1671 1671
1672 1672 pr_pattern_re = regex.compile(r'(?:(?:^!)|(?: !))(\d+)')
1673 1673
1674 1674 allowed_link_formats = [
1675 1675 'html', 'rst', 'markdown', 'html+hovercard', 'rst+hovercard', 'markdown+hovercard']
1676 1676
1677 1677 compile_cache = {
1678 1678
1679 1679 }
1680 1680
1681 1681
1682 1682 def process_patterns(text_string, repo_name, link_format='html', active_entries=None):
1683 1683
1684 1684 if link_format not in allowed_link_formats:
1685 1685 raise ValueError('Link format can be only one of:{} got {}'.format(
1686 1686 allowed_link_formats, link_format))
1687 1687 issues_data = []
1688 1688 errors = []
1689 1689 new_text = text_string
1690 1690
1691 1691 if active_entries is None:
1692 1692 log.debug('Fetch active issue tracker patterns for repo: %s', repo_name)
1693 1693 active_entries = get_active_pattern_entries(repo_name)
1694 1694
1695 1695 log.debug('Got %s pattern entries to process', len(active_entries))
1696 1696
1697 1697 for uid, entry in list(active_entries.items()):
1698 1698
1699 1699 if not (entry['pat'] and entry['url']):
1700 1700 log.debug('skipping due to missing data')
1701 1701 continue
1702 1702
1703 1703 log.debug('issue tracker entry: uid: `%s` PAT:%s URL:%s PREFIX:%s',
1704 1704 uid, entry['pat'], entry['url'], entry['pref'])
1705 1705
1706 1706 if entry.get('pat_compiled'):
1707 1707 pattern = entry['pat_compiled']
1708 1708 elif entry['pat'] in compile_cache:
1709 1709 pattern = compile_cache[entry['pat']]
1710 1710 else:
1711 1711 try:
1712 1712 pattern = regex.compile(r'%s' % entry['pat'])
1713 1713 except regex.error as e:
1714 1714 regex_err = ValueError('{}:{}'.format(entry['pat'], e))
1715 1715 log.exception('issue tracker pattern: `%s` failed to compile', regex_err)
1716 1716 errors.append(regex_err)
1717 1717 continue
1718 1718 compile_cache[entry['pat']] = pattern
1719 1719
1720 1720 data_func = partial(
1721 1721 _process_url_func, repo_name=repo_name, entry=entry, uid=uid,
1722 1722 return_raw_data=True)
1723 1723
1724 1724 for match_obj in pattern.finditer(text_string):
1725 1725 issues_data.append(data_func(match_obj))
1726 1726
1727 1727 url_func = partial(
1728 1728 _process_url_func, repo_name=repo_name, entry=entry, uid=uid,
1729 1729 link_format=link_format)
1730 1730
1731 1731 new_text = pattern.sub(url_func, new_text)
1732 1732 log.debug('processed prefix:uid `%s`', uid)
1733 1733
1734 1734 # finally use global replace, eg !123 -> pr-link, those will not catch
1735 1735 # if already similar pattern exists
1736 1736 server_url = '${scheme}://${netloc}'
1737 1737 pr_entry = {
1738 1738 'pref': '!',
1739 1739 'url': server_url + '/_admin/pull-requests/${id}',
1740 1740 'desc': 'Pull Request !${id}',
1741 1741 'hovercard_url': server_url + '/_hovercard/pull_request/${id}'
1742 1742 }
1743 1743 pr_url_func = partial(
1744 1744 _process_url_func, repo_name=repo_name, entry=pr_entry, uid=None,
1745 1745 link_format=link_format+'+hovercard')
1746 1746 new_text = pr_pattern_re.sub(pr_url_func, new_text)
1747 1747 log.debug('processed !pr pattern')
1748 1748
1749 1749 return new_text, issues_data, errors
1750 1750
1751 1751
1752 1752 def urlify_commit_message(commit_text, repository=None, active_pattern_entries=None,
1753 1753 issues_container_callback=None, error_container=None):
1754 1754 """
1755 1755 Parses given text message and makes proper links.
1756 1756 issues are linked to given issue-server, and rest is a commit link
1757 1757 """
1758 1758
1759 1759 def escaper(_text):
1760 1760 return _text.replace('<', '&lt;').replace('>', '&gt;')
1761 1761
1762 1762 new_text = escaper(commit_text)
1763 1763
1764 1764 # extract http/https links and make them real urls
1765 1765 new_text = urlify_text(new_text, safe=False)
1766 1766
1767 1767 # urlify commits - extract commit ids and make link out of them, if we have
1768 1768 # the scope of repository present.
1769 1769 if repository:
1770 1770 new_text = urlify_commits(new_text, repository)
1771 1771
1772 1772 # process issue tracker patterns
1773 1773 new_text, issues, errors = process_patterns(
1774 1774 new_text, repository or '', active_entries=active_pattern_entries)
1775 1775
1776 1776 if issues_container_callback is not None:
1777 1777 for issue in issues:
1778 1778 issues_container_callback(issue)
1779 1779
1780 1780 if error_container is not None:
1781 1781 error_container.extend(errors)
1782 1782
1783 1783 return literal(new_text)
1784 1784
1785 1785
1786 1786 def render_binary(repo_name, file_obj):
1787 1787 """
1788 1788 Choose how to render a binary file
1789 1789 """
1790 1790
1791 1791 # unicode
1792 1792 filename = file_obj.name
1793 1793
1794 1794 # images
1795 1795 for ext in ['*.png', '*.jpeg', '*.jpg', '*.ico', '*.gif']:
1796 1796 if fnmatch.fnmatch(filename, pat=ext):
1797 1797 src = route_path(
1798 1798 'repo_file_raw', repo_name=repo_name,
1799 1799 commit_id=file_obj.commit.raw_id,
1800 1800 f_path=file_obj.path)
1801 1801
1802 1802 return literal(
1803 1803 '<img class="rendered-binary" alt="rendered-image" src="{}">'.format(src))
1804 1804
1805 1805
1806 1806 def renderer_from_filename(filename, exclude=None):
1807 1807 """
1808 1808 choose a renderer based on filename, this works only for text based files
1809 1809 """
1810 1810
1811 1811 # ipython
1812 1812 for ext in ['*.ipynb']:
1813 1813 if fnmatch.fnmatch(filename, pat=ext):
1814 1814 return 'jupyter'
1815 1815
1816 1816 is_markup = MarkupRenderer.renderer_from_filename(filename, exclude=exclude)
1817 1817 if is_markup:
1818 1818 return is_markup
1819 1819 return None
1820 1820
1821 1821
1822 1822 def render(source, renderer='rst', mentions=False, relative_urls=None,
1823 1823 repo_name=None, active_pattern_entries=None, issues_container_callback=None):
1824 1824
1825 1825 def maybe_convert_relative_links(html_source):
1826 1826 if relative_urls:
1827 1827 return relative_links(html_source, relative_urls)
1828 1828 return html_source
1829 1829
1830 1830 if renderer == 'plain':
1831 1831 return literal(
1832 1832 MarkupRenderer.plain(source, leading_newline=False))
1833 1833
1834 1834 elif renderer == 'rst':
1835 1835 if repo_name:
1836 1836 # process patterns on comments if we pass in repo name
1837 1837 source, issues, errors = process_patterns(
1838 1838 source, repo_name, link_format='rst',
1839 1839 active_entries=active_pattern_entries)
1840 1840 if issues_container_callback is not None:
1841 1841 for issue in issues:
1842 1842 issues_container_callback(issue)
1843 1843
1844 1844 rendered_block = maybe_convert_relative_links(
1845 1845 MarkupRenderer.rst(source, mentions=mentions))
1846 1846
1847 1847 return literal(f'<div class="rst-block">{rendered_block}</div>')
1848 1848
1849 1849 elif renderer == 'markdown':
1850 1850 if repo_name:
1851 1851 # process patterns on comments if we pass in repo name
1852 1852 source, issues, errors = process_patterns(
1853 1853 source, repo_name, link_format='markdown',
1854 1854 active_entries=active_pattern_entries)
1855 1855 if issues_container_callback is not None:
1856 1856 for issue in issues:
1857 1857 issues_container_callback(issue)
1858 1858
1859 1859 rendered_block = maybe_convert_relative_links(
1860 1860 MarkupRenderer.markdown(source, flavored=True, mentions=mentions))
1861 1861 return literal(f'<div class="markdown-block">{rendered_block}</div>')
1862 1862
1863 1863 elif renderer == 'jupyter':
1864 1864 rendered_block = maybe_convert_relative_links(
1865 1865 MarkupRenderer.jupyter(source))
1866 1866 return literal(f'<div class="ipynb">{rendered_block}</div>')
1867 1867
1868 1868 # None means just show the file-source
1869 1869 return None
1870 1870
1871 1871
1872 1872 def commit_status(repo, commit_id):
1873 1873 return ChangesetStatusModel().get_status(repo, commit_id)
1874 1874
1875 1875
1876 1876 def commit_status_lbl(commit_status):
1877 1877 return dict(ChangesetStatus.STATUSES).get(commit_status)
1878 1878
1879 1879
1880 1880 def commit_time(repo_name, commit_id):
1881 1881 repo = Repository.get_by_repo_name(repo_name)
1882 1882 commit = repo.get_commit(commit_id=commit_id)
1883 1883 return commit.date
1884 1884
1885 1885
1886 1886 def get_permission_name(key):
1887 1887 return dict(Permission.PERMS).get(key)
1888 1888
1889 1889
1890 1890 def journal_filter_help(request):
1891 1891 _ = request.translate
1892 1892 from rhodecode.lib.audit_logger import ACTIONS
1893 1893 actions = '\n'.join(textwrap.wrap(', '.join(sorted(ACTIONS.keys())), 80))
1894 1894
1895 1895 return _(
1896 1896 'Example filter terms:\n' +
1897 1897 ' repository:vcs\n' +
1898 1898 ' username:marcin\n' +
1899 1899 ' username:(NOT marcin)\n' +
1900 1900 ' action:*push*\n' +
1901 1901 ' ip:127.0.0.1\n' +
1902 1902 ' date:20120101\n' +
1903 1903 ' date:[20120101100000 TO 20120102]\n' +
1904 1904 '\n' +
1905 1905 'Actions: {actions}\n' +
1906 1906 '\n' +
1907 1907 'Generate wildcards using \'*\' character:\n' +
1908 1908 ' "repository:vcs*" - search everything starting with \'vcs\'\n' +
1909 1909 ' "repository:*vcs*" - search for repository containing \'vcs\'\n' +
1910 1910 '\n' +
1911 1911 'Optional AND / OR operators in queries\n' +
1912 1912 ' "repository:vcs OR repository:test"\n' +
1913 1913 ' "username:test AND repository:test*"\n'
1914 1914 ).format(actions=actions)
1915 1915
1916 1916
1917 1917 def not_mapped_error(repo_name):
1918 1918 from rhodecode.translation import _
1919 1919 flash(_('%s repository is not mapped to db perhaps'
1920 1920 ' it was created or renamed from the filesystem'
1921 1921 ' please run the application again'
1922 1922 ' in order to rescan repositories') % repo_name, category='error')
1923 1923
1924 1924
1925 1925 def ip_range(ip_addr):
1926 1926 from rhodecode.model.db import UserIpMap
1927 1927 s, e = UserIpMap._get_ip_range(ip_addr)
1928 1928 return '%s - %s' % (s, e)
1929 1929
1930 1930
1931 1931 def form(url, method='post', needs_csrf_token=True, **attrs):
1932 1932 """Wrapper around webhelpers.tags.form to prevent CSRF attacks."""
1933 1933 if method.lower() != 'get' and needs_csrf_token:
1934 1934 raise Exception(
1935 1935 'Forms to POST/PUT/DELETE endpoints should have (in general) a ' +
1936 1936 'CSRF token. If the endpoint does not require such token you can ' +
1937 1937 'explicitly set the parameter needs_csrf_token to false.')
1938 1938
1939 1939 return insecure_form(url, method=method, **attrs)
1940 1940
1941 1941
1942 1942 def secure_form(form_url, method="POST", multipart=False, **attrs):
1943 1943 """Start a form tag that points the action to an url. This
1944 1944 form tag will also include the hidden field containing
1945 1945 the auth token.
1946 1946
1947 1947 The url options should be given either as a string, or as a
1948 1948 ``url()`` function. The method for the form defaults to POST.
1949 1949
1950 1950 Options:
1951 1951
1952 1952 ``multipart``
1953 1953 If set to True, the enctype is set to "multipart/form-data".
1954 1954 ``method``
1955 1955 The method to use when submitting the form, usually either
1956 1956 "GET" or "POST". If "PUT", "DELETE", or another verb is used, a
1957 1957 hidden input with name _method is added to simulate the verb
1958 1958 over POST.
1959 1959
1960 1960 """
1961 1961
1962 1962 if 'request' in attrs:
1963 1963 session = attrs['request'].session
1964 1964 del attrs['request']
1965 1965 else:
1966 1966 raise ValueError(
1967 1967 'Calling this form requires request= to be passed as argument')
1968 1968
1969 1969 _form = insecure_form(form_url, method, multipart, **attrs)
1970 1970 token = literal(
1971 1971 '<input type="hidden" name="{}" value="{}">'.format(
1972 1972 csrf_token_key, get_csrf_token(session)))
1973 1973
1974 1974 return literal("%s\n%s" % (_form, token))
1975 1975
1976 1976
1977 1977 def dropdownmenu(name, selected, options, enable_filter=False, **attrs):
1978 1978 select_html = select(name, selected, options, **attrs)
1979 1979
1980 1980 select2 = """
1981 1981 <script>
1982 1982 $(document).ready(function() {
1983 1983 $('#%s').select2({
1984 1984 containerCssClass: 'drop-menu %s',
1985 1985 dropdownCssClass: 'drop-menu-dropdown',
1986 1986 dropdownAutoWidth: true%s
1987 1987 });
1988 1988 });
1989 1989 </script>
1990 1990 """
1991 1991
1992 1992 filter_option = """,
1993 1993 minimumResultsForSearch: -1
1994 1994 """
1995 1995 input_id = attrs.get('id') or name
1996 1996 extra_classes = ' '.join(attrs.pop('extra_classes', []))
1997 1997 filter_enabled = "" if enable_filter else filter_option
1998 1998 select_script = literal(select2 % (input_id, extra_classes, filter_enabled))
1999 1999
2000 2000 return literal(select_html+select_script)
2001 2001
2002 2002
2003 2003 def get_visual_attr(tmpl_context_var, attr_name):
2004 2004 """
2005 2005 A safe way to get a variable from visual variable of template context
2006 2006
2007 2007 :param tmpl_context_var: instance of tmpl_context, usually present as `c`
2008 2008 :param attr_name: name of the attribute we fetch from the c.visual
2009 2009 """
2010 2010 visual = getattr(tmpl_context_var, 'visual', None)
2011 2011 if not visual:
2012 2012 return
2013 2013 else:
2014 2014 return getattr(visual, attr_name, None)
2015 2015
2016 2016
2017 2017 def get_last_path_part(file_node):
2018 2018 if not file_node.path:
2019 2019 return '/'
2020 2020
2021 2021 path = safe_str(file_node.path.split('/')[-1])
2022 2022 return '../' + path
2023 2023
2024 2024
2025 2025 def route_url(*args, **kwargs):
2026 2026 """
2027 2027 Wrapper around pyramids `route_url` (fully qualified url) function.
2028 2028 """
2029 2029 req = get_current_request()
2030 2030 return req.route_url(*args, **kwargs)
2031 2031
2032 2032
2033 2033 def route_path(*args, **kwargs):
2034 2034 """
2035 2035 Wrapper around pyramids `route_path` function.
2036 2036 """
2037 2037 req = get_current_request()
2038 2038 return req.route_path(*args, **kwargs)
2039 2039
2040 2040
2041 2041 def route_path_or_none(*args, **kwargs):
2042 2042 try:
2043 2043 return route_path(*args, **kwargs)
2044 2044 except KeyError:
2045 2045 return None
2046 2046
2047 2047
2048 2048 def current_route_path(request, **kw):
2049 2049 new_args = request.GET.mixed()
2050 2050 new_args.update(kw)
2051 2051 return request.current_route_path(_query=new_args)
2052 2052
2053 2053
2054 2054 def curl_api_example(method, args):
2055 2055 args_json = json.dumps(OrderedDict([
2056 2056 ('id', 1),
2057 2057 ('auth_token', 'SECRET'),
2058 2058 ('method', method),
2059 2059 ('args', args)
2060 2060 ]))
2061 2061
2062 2062 return "curl {api_url} -X POST -H 'content-type:text/plain' --data-binary '{args_json}'".format(
2063 2063 api_url=route_url('apiv2'),
2064 2064 args_json=args_json
2065 2065 )
2066 2066
2067 2067
2068 2068 def api_call_example(method, args):
2069 2069 """
2070 2070 Generates an API call example via CURL
2071 2071 """
2072 2072 curl_call = curl_api_example(method, args)
2073 2073
2074 2074 return literal(
2075 2075 curl_call +
2076 2076 "<br/><br/>SECRET can be found in <a href=\"{token_url}\">auth-tokens</a> page, "
2077 2077 "and needs to be of `api calls` role."
2078 2078 .format(token_url=route_url('my_account_auth_tokens')))
2079 2079
2080 2080
2081 2081 def notification_description(notification, request):
2082 2082 """
2083 2083 Generate notification human readable description based on notification type
2084 2084 """
2085 2085 from rhodecode.model.notification import NotificationModel
2086 2086 return NotificationModel().make_description(
2087 2087 notification, translate=request.translate)
2088 2088
2089 2089
2090 2090 def go_import_header(request, db_repo=None):
2091 2091 """
2092 2092 Creates a header for go-import functionality in Go Lang
2093 2093 """
2094 2094
2095 2095 if not db_repo:
2096 2096 return
2097 2097 if 'go-get' not in request.GET:
2098 2098 return
2099 2099
2100 2100 clone_url = db_repo.clone_url()
2101 2101 prefix = re.split(r'^https?:\/\/', clone_url)[-1]
2102 2102 # we have a repo and go-get flag,
2103 2103 return literal('<meta name="go-import" content="{} {} {}">'.format(
2104 2104 prefix, db_repo.repo_type, clone_url))
2105 2105
2106 2106
2107 2107 def reviewer_as_json(*args, **kwargs):
2108 2108 from rhodecode.apps.repository.utils import reviewer_as_json as _reviewer_as_json
2109 2109 return _reviewer_as_json(*args, **kwargs)
2110 2110
2111 2111
2112 2112 def get_repo_view_type(request):
2113 2113 route_name = request.matched_route.name
2114 2114 route_to_view_type = {
2115 2115 'repo_changelog': 'commits',
2116 2116 'repo_commits': 'commits',
2117 2117 'repo_files': 'files',
2118 2118 'repo_summary': 'summary',
2119 2119 'repo_commit': 'commit'
2120 2120 }
2121 2121
2122 2122 return route_to_view_type.get(route_name)
2123 2123
2124 2124
2125 2125 def is_active(menu_entry, selected):
2126 2126 """
2127 2127 Returns active class for selecting menus in templates
2128 2128 <li class=${h.is_active('settings', current_active)}></li>
2129 2129 """
2130 2130 if not isinstance(menu_entry, list):
2131 2131 menu_entry = [menu_entry]
2132 2132
2133 2133 if selected in menu_entry:
2134 2134 return "active"
2135 2135
2136 2136
2137 2137 class IssuesRegistry(object):
2138 2138 """
2139 2139 issue_registry = IssuesRegistry()
2140 2140 some_func(issues_callback=issues_registry(...))
2141 2141 """
2142 2142
2143 2143 def __init__(self):
2144 2144 self.issues = []
2145 2145 self.unique_issues = collections.defaultdict(lambda: [])
2146 2146
2147 2147 def __call__(self, commit_dict=None):
2148 2148 def callback(issue):
2149 2149 if commit_dict and issue:
2150 2150 issue['commit'] = commit_dict
2151 2151 self.issues.append(issue)
2152 2152 self.unique_issues[issue['id']].append(issue)
2153 2153 return callback
2154 2154
2155 2155 def get_issues(self):
2156 2156 return self.issues
2157 2157
2158 2158 @property
2159 2159 def issues_unique_count(self):
2160 2160 return len(set(i['id'] for i in self.issues))
General Comments 0
You need to be logged in to leave comments. Login now