Files
@ c98c7d4c9ec3
Branch filter:
Location: kallithea/kallithea/lib/helpers.py
c98c7d4c9ec3
41.2 KiB
text/x-python
model: changes toward import whole modules
*If* there should be circular dependencies, importing 'from' another module
could fail because the module at that time only was partially imported. That
had to be worked around by importing at runtime instead of globally.
Instead, try to always import whole modules. (But we should still try to avoid
cycles.)
*If* there should be circular dependencies, importing 'from' another module
could fail because the module at that time only was partially imported. That
had to be worked around by importing at runtime instead of globally.
Instead, try to always import whole modules. (But we should still try to avoid
cycles.)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 | # -*- coding: utf-8 -*-
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Helper functions
Consists of functions to typically be used within templates, but also
available to Controllers. This module is available to both as 'h'.
"""
import hashlib
import json
import logging
import re
import textwrap
import urllib.parse
from beaker.cache import cache_region
from pygments import highlight as code_highlight
from pygments.formatters.html import HtmlFormatter
from tg.i18n import ugettext as _
import kallithea
from kallithea.lib.annotate import annotate_highlight
#==============================================================================
# PERMS
#==============================================================================
from kallithea.lib.auth import HasPermissionAny, HasRepoGroupPermissionLevel, HasRepoPermissionLevel
from kallithea.lib.diffs import BIN_FILENODE, CHMOD_FILENODE, DEL_FILENODE, MOD_FILENODE, NEW_FILENODE, RENAMED_FILENODE
from kallithea.lib.markup_renderer import url_re
from kallithea.lib.pygmentsutils import get_custom_lexer
from kallithea.lib.utils2 import (MENTIONS_REGEX, AttributeDict, age, asbool, credentials_filter, fmt_date, link_to_ref, safe_bytes, safe_int, safe_str,
shorter, time_to_datetime)
from kallithea.lib.vcs.backends.base import BaseChangeset, EmptyChangeset
from kallithea.lib.vcs.exceptions import ChangesetDoesNotExistError
#==============================================================================
# SCM FILTERS available via h.
#==============================================================================
from kallithea.lib.vcs.utils import author_email, author_name
from kallithea.lib.webutils import (HTML, Option, canonical_url, checkbox, chop_at, end_form, escape, form, format_byte_size, hidden, html_escape, link_to,
literal, password, pop_flash_messages, radio, reset, safeid, select, session_csrf_secret_name, session_csrf_secret_token,
submit, text, textarea, truncate, url, wrap_paragraphs)
from kallithea.model import db
from kallithea.model.changeset_status import ChangesetStatusModel
# mute pyflakes "imported but unused"
# from webutils
assert Option
assert canonical_url
assert checkbox
assert chop_at
assert end_form
assert form
assert format_byte_size
assert hidden
assert password
assert pop_flash_messages
assert radio
assert reset
assert safeid
assert select
assert session_csrf_secret_name
assert session_csrf_secret_token
assert submit
assert text
assert textarea
assert wrap_paragraphs
# from kallithea.lib.auth
assert HasPermissionAny
assert HasRepoGroupPermissionLevel
assert HasRepoPermissionLevel
# from utils2
assert age
assert fmt_date
assert link_to_ref
assert shorter
assert time_to_datetime
# from vcs
assert EmptyChangeset
log = logging.getLogger(__name__)
def js(value):
"""Convert Python value to the corresponding JavaScript representation.
This is necessary to safely insert arbitrary values into HTML <script>
sections e.g. using Mako template expression substitution.
Note: Rather than using this function, it's preferable to avoid the
insertion of values into HTML <script> sections altogether. Instead,
data should (to the extent possible) be passed to JavaScript using
data attributes or AJAX calls, eliminating the need for JS specific
escaping.
Note: This is not safe for use in attributes (e.g. onclick), because
quotes are not escaped.
Because the rules for parsing <script> varies between XHTML (where
normal rules apply for any special characters) and HTML (where
entities are not interpreted, but the literal string "</script>"
is forbidden), the function ensures that the result never contains
'&', '<' and '>', thus making it safe in both those contexts (but
not in attributes).
"""
return literal(
('(' + json.dumps(value) + ')')
# In JSON, the following can only appear in string literals.
.replace('&', r'\x26')
.replace('<', r'\x3c')
.replace('>', r'\x3e')
)
def jshtml(val):
"""HTML escapes a string value, then converts the resulting string
to its corresponding JavaScript representation (see `js`).
This is used when a plain-text string (possibly containing special
HTML characters) will be used by a script in an HTML context (e.g.
element.innerHTML or jQuery's 'html' method).
If in doubt, err on the side of using `jshtml` over `js`, since it's
better to escape too much than too little.
"""
return js(escape(val))
def FID(raw_id, path):
"""
Creates a unique ID for filenode based on it's hash of path and revision
it's safe to use in urls
"""
return 'C-%s-%s' % (short_id(raw_id), hashlib.md5(safe_bytes(path)).hexdigest()[:12])
def get_ignore_whitespace_diff(GET):
"""Return true if URL requested whitespace to be ignored"""
return bool(GET.get('ignorews'))
def ignore_whitespace_link(GET, anchor=None):
"""Return snippet with link to current URL with whitespace ignoring toggled"""
params = dict(GET) # ignoring duplicates
if get_ignore_whitespace_diff(GET):
params.pop('ignorews')
title = _("Show whitespace changes")
else:
params['ignorews'] = '1'
title = _("Ignore whitespace changes")
params['anchor'] = anchor
return link_to(
literal('<i class="icon-strike"></i>'),
url.current(**params),
title=title,
**{'data-toggle': 'tooltip'})
def get_diff_context_size(GET):
"""Return effective context size requested in URL"""
return safe_int(GET.get('context'), default=3)
def increase_context_link(GET, anchor=None):
"""Return snippet with link to current URL with double context size"""
context = get_diff_context_size(GET) * 2
params = dict(GET) # ignoring duplicates
params['context'] = str(context)
params['anchor'] = anchor
return link_to(
literal('<i class="icon-sort"></i>'),
url.current(**params),
title=_('Increase diff context to %(num)s lines') % {'num': context},
**{'data-toggle': 'tooltip'})
class _FilesBreadCrumbs(object):
def __call__(self, repo_name, rev, paths):
url_l = [link_to(repo_name, url('files_home',
repo_name=repo_name,
revision=rev, f_path=''),
class_='ypjax-link')]
paths_l = paths.split('/')
for cnt, p in enumerate(paths_l):
if p != '':
url_l.append(link_to(p,
url('files_home',
repo_name=repo_name,
revision=rev,
f_path='/'.join(paths_l[:cnt + 1])
),
class_='ypjax-link'
)
)
return literal('/'.join(url_l))
files_breadcrumbs = _FilesBreadCrumbs()
class CodeHtmlFormatter(HtmlFormatter):
"""
My code Html Formatter for source codes
"""
def wrap(self, source, outfile):
return self._wrap_div(self._wrap_pre(self._wrap_code(source)))
def _wrap_code(self, source):
for cnt, it in enumerate(source):
i, t = it
t = '<span id="L%s">%s</span>' % (cnt + 1, t)
yield i, t
def _wrap_tablelinenos(self, inner):
inner_lines = []
lncount = 0
for t, line in inner:
if t:
lncount += 1
inner_lines.append(line)
fl = self.linenostart
mw = len(str(lncount + fl - 1))
sp = self.linenospecial
st = self.linenostep
la = self.lineanchors
aln = self.anchorlinenos
nocls = self.noclasses
if sp:
lines = []
for i in range(fl, fl + lncount):
if i % st == 0:
if i % sp == 0:
if aln:
lines.append('<a href="#%s%d" class="special">%*d</a>' %
(la, i, mw, i))
else:
lines.append('<span class="special">%*d</span>' % (mw, i))
else:
if aln:
lines.append('<a href="#%s%d">%*d</a>' % (la, i, mw, i))
else:
lines.append('%*d' % (mw, i))
else:
lines.append('')
ls = '\n'.join(lines)
else:
lines = []
for i in range(fl, fl + lncount):
if i % st == 0:
if aln:
lines.append('<a href="#%s%d">%*d</a>' % (la, i, mw, i))
else:
lines.append('%*d' % (mw, i))
else:
lines.append('')
ls = '\n'.join(lines)
# in case you wonder about the seemingly redundant <div> here: since the
# content in the other cell also is wrapped in a div, some browsers in
# some configurations seem to mess up the formatting...
if nocls:
yield 0, ('<table class="%stable">' % self.cssclass +
'<tr><td><div class="linenodiv">'
'<pre>' + ls + '</pre></div></td>'
'<td id="hlcode" class="code">')
else:
yield 0, ('<table class="%stable">' % self.cssclass +
'<tr><td class="linenos"><div class="linenodiv">'
'<pre>' + ls + '</pre></div></td>'
'<td id="hlcode" class="code">')
yield 0, ''.join(inner_lines)
yield 0, '</td></tr></table>'
_whitespace_re = re.compile(r'(\t)|( )(?=\n|</div>)')
def _markup_whitespace(m):
groups = m.groups()
if groups[0]:
return '<u>\t</u>'
if groups[1]:
return ' <i></i>'
def markup_whitespace(s):
return _whitespace_re.sub(_markup_whitespace, s)
def pygmentize(filenode, **kwargs):
"""
pygmentize function using pygments
:param filenode:
"""
lexer = get_custom_lexer(filenode.extension) or filenode.lexer
return literal(markup_whitespace(
code_highlight(safe_str(filenode.content), lexer, CodeHtmlFormatter(**kwargs))))
def hsv_to_rgb(h, s, v):
if s == 0.0:
return v, v, v
i = int(h * 6.0) # XXX assume int() truncates!
f = (h * 6.0) - i
p = v * (1.0 - s)
q = v * (1.0 - s * f)
t = v * (1.0 - s * (1.0 - f))
i = i % 6
if i == 0:
return v, t, p
if i == 1:
return q, v, p
if i == 2:
return p, v, t
if i == 3:
return p, q, v
if i == 4:
return t, p, v
if i == 5:
return v, p, q
def gen_color(n=10000):
"""generator for getting n of evenly distributed colors using
hsv color and golden ratio. It always return same order of colors
:returns: RGB tuple
"""
golden_ratio = 0.618033988749895
h = 0.22717784590367374
for _unused in range(n):
h += golden_ratio
h %= 1
HSV_tuple = [h, 0.95, 0.95]
RGB_tuple = hsv_to_rgb(*HSV_tuple)
yield [str(int(x * 256)) for x in RGB_tuple]
def pygmentize_annotation(repo_name, filenode, **kwargs):
"""
pygmentize function for annotation
:param filenode:
"""
cgenerator = gen_color()
color_dict = {}
def get_color_string(cs):
if cs in color_dict:
col = color_dict[cs]
else:
col = color_dict[cs] = next(cgenerator)
return "color: rgb(%s)! important;" % (', '.join(col))
def url_func(changeset):
author = escape(changeset.author)
date = changeset.date
message = escape(changeset.message)
tooltip_html = ("<b>Author:</b> %s<br/>"
"<b>Date:</b> %s</b><br/>"
"<b>Message:</b> %s") % (author, date, message)
lnk_format = show_id(changeset)
uri = link_to(
lnk_format,
url('changeset_home', repo_name=repo_name,
revision=changeset.raw_id),
style=get_color_string(changeset.raw_id),
**{'data-toggle': 'popover',
'data-content': tooltip_html}
)
uri += '\n'
return uri
return literal(markup_whitespace(annotate_highlight(filenode, url_func, **kwargs)))
def capitalize(x):
return x.capitalize()
def short_id(x):
return x[:12]
def hide_credentials(x):
return ''.join(credentials_filter(x))
def show_id(cs):
"""
Configurable function that shows ID
by default it's r123:fffeeefffeee
:param cs: changeset instance
"""
def_len = safe_int(kallithea.CONFIG.get('show_sha_length', 12))
show_rev = asbool(kallithea.CONFIG.get('show_revision_number', False))
raw_id = cs.raw_id[:def_len]
if show_rev:
return 'r%s:%s' % (cs.revision, raw_id)
else:
return raw_id
def is_git(repository):
if hasattr(repository, 'alias'):
_type = repository.alias
elif hasattr(repository, 'repo_type'):
_type = repository.repo_type
else:
_type = repository
return _type == 'git'
def is_hg(repository):
if hasattr(repository, 'alias'):
_type = repository.alias
elif hasattr(repository, 'repo_type'):
_type = repository.repo_type
else:
_type = repository
return _type == 'hg'
@cache_region('long_term', 'user_attr_or_none')
def user_attr_or_none(author, show_attr):
"""Try to match email part of VCS committer string with a local user and return show_attr
- or return None if user not found"""
email = author_email(author)
if email:
user = db.User.get_by_email(email)
if user is not None:
return getattr(user, show_attr)
return None
def email_or_none(author):
"""Try to match email part of VCS committer string with a local user.
Return primary email of user, email part of the specified author name, or None."""
if not author:
return None
email = user_attr_or_none(author, 'email')
if email is not None:
return email # always use user's main email address - not necessarily the one used to find user
# extract email from the commit string
email = author_email(author)
if email:
return email
# No valid email, not a valid user in the system, none!
return None
def person(author, show_attr="username"):
"""Find the user identified by 'author', return one of the users attributes,
default to the username attribute, None if there is no user"""
# if author is already an instance use it for extraction
if isinstance(author, db.User):
return getattr(author, show_attr)
value = user_attr_or_none(author, show_attr)
if value is not None:
return value
# Still nothing? Just pass back the author name if any, else the email
return author_name(author) or author_email(author)
def person_by_id(id_, show_attr="username"):
# maybe it's an ID ?
if str(id_).isdigit() or isinstance(id_, int):
id_ = int(id_)
user = db.User.get(id_)
if user is not None:
return getattr(user, show_attr)
return id_
def boolicon(value):
"""Returns boolean value of a value, represented as small html image of true/false
icons
:param value: value
"""
if value:
return HTML.tag('i', class_="icon-ok")
else:
return HTML.tag('i', class_="icon-minus-circled")
def action_parser(user_log, feed=False, parse_cs=False):
"""
This helper will action_map the specified string action into translated
fancy names with icons and links
:param user_log: user log instance
:param feed: use output for feeds (no html and fancy icons)
:param parse_cs: parse Changesets into VCS instances
"""
action = user_log.action
action_params = ' '
x = action.split(':')
if len(x) > 1:
action, action_params = x
def get_cs_links():
revs_limit = 3 # display this amount always
revs_top_limit = 50 # show upto this amount of changesets hidden
revs_ids = action_params.split(',')
deleted = user_log.repository is None
if deleted:
return ','.join(revs_ids)
repo_name = user_log.repository.repo_name
def lnk(rev, repo_name):
lazy_cs = False
title_ = None
url_ = '#'
if isinstance(rev, BaseChangeset) or isinstance(rev, AttributeDict):
if rev.op and rev.ref_name:
if rev.op == 'delete_branch':
lbl = _('Deleted branch: %s') % rev.ref_name
elif rev.op == 'tag':
lbl = _('Created tag: %s') % rev.ref_name
else:
lbl = 'Unknown operation %s' % rev.op
else:
lazy_cs = True
lbl = rev.short_id[:8]
url_ = url('changeset_home', repo_name=repo_name,
revision=rev.raw_id)
else:
# changeset cannot be found - it might have been stripped or removed
lbl = rev[:12]
title_ = _('Changeset %s not found') % lbl
if parse_cs:
return link_to(lbl, url_, title=title_, **{'data-toggle': 'tooltip'})
return link_to(lbl, url_, class_='lazy-cs' if lazy_cs else '',
**{'data-raw_id': rev.raw_id, 'data-repo_name': repo_name})
def _get_op(rev_txt):
_op = None
_name = rev_txt
if len(rev_txt.split('=>')) == 2:
_op, _name = rev_txt.split('=>')
return _op, _name
revs = []
if len([v for v in revs_ids if v != '']) > 0:
repo = None
for rev in revs_ids[:revs_top_limit]:
_op, _name = _get_op(rev)
# we want parsed changesets, or new log store format is bad
if parse_cs:
try:
if repo is None:
repo = user_log.repository.scm_instance
_rev = repo.get_changeset(rev)
revs.append(_rev)
except ChangesetDoesNotExistError:
log.error('cannot find revision %s in this repo', rev)
revs.append(rev)
else:
_rev = AttributeDict({
'short_id': rev[:12],
'raw_id': rev,
'message': '',
'op': _op,
'ref_name': _name
})
revs.append(_rev)
cs_links = [" " + ', '.join(
[lnk(rev, repo_name) for rev in revs[:revs_limit]]
)]
_op1, _name1 = _get_op(revs_ids[0])
_op2, _name2 = _get_op(revs_ids[-1])
_rev = '%s...%s' % (_name1, _name2)
compare_view = (
' <div class="compare_view" data-toggle="tooltip" title="%s">'
'<a href="%s">%s</a> </div>' % (
_('Show all combined changesets %s->%s') % (
revs_ids[0][:12], revs_ids[-1][:12]
),
url('changeset_home', repo_name=repo_name,
revision=_rev
),
_('Compare view')
)
)
# if we have exactly one more than normally displayed
# just display it, takes less space than displaying
# "and 1 more revisions"
if len(revs_ids) == revs_limit + 1:
cs_links.append(", " + lnk(revs[revs_limit], repo_name))
# hidden-by-default ones
if len(revs_ids) > revs_limit + 1:
uniq_id = revs_ids[0]
html_tmpl = (
'<span> %s <a class="show_more" id="_%s" '
'href="#more">%s</a> %s</span>'
)
if not feed:
cs_links.append(html_tmpl % (
_('and'),
uniq_id, _('%s more') % (len(revs_ids) - revs_limit),
_('revisions')
)
)
if not feed:
html_tmpl = '<span id="%s" style="display:none">, %s </span>'
else:
html_tmpl = '<span id="%s"> %s </span>'
morelinks = ', '.join(
[lnk(rev, repo_name) for rev in revs[revs_limit:]]
)
if len(revs_ids) > revs_top_limit:
morelinks += ', ...'
cs_links.append(html_tmpl % (uniq_id, morelinks))
if len(revs) > 1:
cs_links.append(compare_view)
return ''.join(cs_links)
def get_fork_name():
repo_name = action_params
url_ = url('summary_home', repo_name=repo_name)
return _('Fork name %s') % link_to(action_params, url_)
def get_user_name():
user_name = action_params
return user_name
def get_users_group():
group_name = action_params
return group_name
def get_pull_request():
pull_request_id = action_params
nice_id = db.PullRequest.make_nice_id(pull_request_id)
deleted = user_log.repository is None
if deleted:
repo_name = user_log.repository_name
else:
repo_name = user_log.repository.repo_name
return link_to(_('Pull request %s') % nice_id,
url('pullrequest_show', repo_name=repo_name,
pull_request_id=pull_request_id))
def get_archive_name():
archive_name = action_params
return archive_name
# action : translated str, callback(extractor), icon
action_map = {
'user_deleted_repo': (_('[deleted] repository'),
None, 'icon-trashcan'),
'user_created_repo': (_('[created] repository'),
None, 'icon-plus'),
'user_created_fork': (_('[created] repository as fork'),
None, 'icon-fork'),
'user_forked_repo': (_('[forked] repository'),
get_fork_name, 'icon-fork'),
'user_updated_repo': (_('[updated] repository'),
None, 'icon-pencil'),
'user_downloaded_archive': (_('[downloaded] archive from repository'),
get_archive_name, 'icon-download-cloud'),
'admin_deleted_repo': (_('[delete] repository'),
None, 'icon-trashcan'),
'admin_created_repo': (_('[created] repository'),
None, 'icon-plus'),
'admin_forked_repo': (_('[forked] repository'),
None, 'icon-fork'),
'admin_updated_repo': (_('[updated] repository'),
None, 'icon-pencil'),
'admin_created_user': (_('[created] user'),
get_user_name, 'icon-user'),
'admin_updated_user': (_('[updated] user'),
get_user_name, 'icon-user'),
'admin_created_users_group': (_('[created] user group'),
get_users_group, 'icon-pencil'),
'admin_updated_users_group': (_('[updated] user group'),
get_users_group, 'icon-pencil'),
'user_commented_revision': (_('[commented] on revision in repository'),
get_cs_links, 'icon-comment'),
'user_commented_pull_request': (_('[commented] on pull request for'),
get_pull_request, 'icon-comment'),
'user_closed_pull_request': (_('[closed] pull request for'),
get_pull_request, 'icon-ok'),
'push': (_('[pushed] into'),
get_cs_links, 'icon-move-up'),
'push_local': (_('[committed via Kallithea] into repository'),
get_cs_links, 'icon-pencil'),
'push_remote': (_('[pulled from remote] into repository'),
get_cs_links, 'icon-move-up'),
'pull': (_('[pulled] from'),
None, 'icon-move-down'),
'started_following_repo': (_('[started following] repository'),
None, 'icon-heart'),
'stopped_following_repo': (_('[stopped following] repository'),
None, 'icon-heart-empty'),
}
action_str = action_map.get(action, action)
if feed:
action = action_str[0].replace('[', '').replace(']', '')
else:
action = action_str[0] \
.replace('[', '<b>') \
.replace(']', '</b>')
action_params_func = action_str[1] if callable(action_str[1]) else (lambda: "")
def action_parser_icon():
action = user_log.action
action_params = None
x = action.split(':')
if len(x) > 1:
action, action_params = x
ico = action_map.get(action, ['', '', ''])[2]
html = """<i class="%s"></i>""" % ico
return literal(html)
# returned callbacks we need to call to get
return [lambda: literal(action), action_params_func, action_parser_icon]
#==============================================================================
# GRAVATAR URL
#==============================================================================
def gravatar_div(email_address, cls='', size=30, **div_attributes):
"""Return an html literal with a span around a gravatar if they are enabled.
Extra keyword parameters starting with 'div_' will get the prefix removed
and '_' changed to '-' and be used as attributes on the div. The default
class is 'gravatar'.
"""
from tg import tmpl_context as c
if not c.visual.use_gravatar:
return ''
if 'div_class' not in div_attributes:
div_attributes['div_class'] = "gravatar"
attributes = []
for k, v in sorted(div_attributes.items()):
assert k.startswith('div_'), k
attributes.append(' %s="%s"' % (k[4:].replace('_', '-'), escape(v)))
return literal("""<span%s>%s</span>""" %
(''.join(attributes),
gravatar(email_address, cls=cls, size=size)))
def gravatar(email_address, cls='', size=30):
"""return html element of the gravatar
This method will return an <img> with the resolution double the size (for
retina screens) of the image. If the url returned from gravatar_url is
empty then we fallback to using an icon.
"""
from tg import tmpl_context as c
if not c.visual.use_gravatar:
return ''
src = gravatar_url(email_address, size * 2)
if src:
# here it makes sense to use style="width: ..." (instead of, say, a
# stylesheet) because we using this to generate a high-res (retina) size
html = ('<i class="icon-gravatar {cls}"'
' style="font-size: {size}px;background-size: {size}px;background-image: url(\'{src}\')"'
'></i>').format(cls=cls, size=size, src=src)
else:
# if src is empty then there was no gravatar, so we use a font icon
html = ("""<i class="icon-user {cls}" style="font-size: {size}px;"></i>"""
.format(cls=cls, size=size))
return literal(html)
def gravatar_url(email_address, size=30, default=''):
from tg import tmpl_context as c
if not c.visual.use_gravatar:
return ""
_def = 'anonymous@kallithea-scm.org' # default gravatar
email_address = email_address or _def
if email_address == _def:
return default
parsed_url = urllib.parse.urlparse(url.current(qualified=True))
return (c.visual.gravatar_url or db.User.DEFAULT_GRAVATAR_URL) \
.replace('{email}', email_address) \
.replace('{md5email}', hashlib.md5(safe_bytes(email_address).lower()).hexdigest()) \
.replace('{netloc}', parsed_url.netloc) \
.replace('{scheme}', parsed_url.scheme) \
.replace('{size}', str(size))
def changed_tooltip(nodes):
"""
Generates a html string for changed nodes in changeset page.
It limits the output to 30 entries
:param nodes: LazyNodesGenerator
"""
if nodes:
pref = ': <br/> '
suf = ''
if len(nodes) > 30:
suf = '<br/>' + _(' and %s more') % (len(nodes) - 30)
return literal(pref + '<br/> '.join([x.path
for x in nodes[:30]]) + suf)
else:
return ': ' + _('No files')
def fancy_file_stats(stats):
"""
Displays a fancy two colored bar for number of added/deleted
lines of code on file
:param stats: two element list of added/deleted lines of code
"""
a, d = stats['added'], stats['deleted']
width = 100
if stats['binary']:
# binary mode
lbl = ''
bin_op = 1
if BIN_FILENODE in stats['ops']:
lbl = 'bin+'
if NEW_FILENODE in stats['ops']:
lbl += _('new file')
bin_op = NEW_FILENODE
elif MOD_FILENODE in stats['ops']:
lbl += _('mod')
bin_op = MOD_FILENODE
elif DEL_FILENODE in stats['ops']:
lbl += _('del')
bin_op = DEL_FILENODE
elif RENAMED_FILENODE in stats['ops']:
lbl += _('rename')
bin_op = RENAMED_FILENODE
# chmod can go with other operations
if CHMOD_FILENODE in stats['ops']:
_org_lbl = _('chmod')
lbl += _org_lbl if lbl.endswith('+') else '+%s' % _org_lbl
#import ipdb;ipdb.set_trace()
b_d = '<div class="bin bin%s progress-bar" style="width:100%%">%s</div>' % (bin_op, lbl)
b_a = '<div class="bin bin1" style="width:0%"></div>'
return literal('<div style="width:%spx" class="progress">%s%s</div>' % (width, b_a, b_d))
t = stats['added'] + stats['deleted']
unit = float(width) / (t or 1)
# needs > 9% of width to be visible or 0 to be hidden
a_p = max(9, unit * a) if a > 0 else 0
d_p = max(9, unit * d) if d > 0 else 0
p_sum = a_p + d_p
if p_sum > width:
# adjust the percentage to be == 100% since we adjusted to 9
if a_p > d_p:
a_p = a_p - (p_sum - width)
else:
d_p = d_p - (p_sum - width)
a_v = a if a > 0 else ''
d_v = d if d > 0 else ''
d_a = '<div class="added progress-bar" style="width:%s%%">%s</div>' % (
a_p, a_v
)
d_d = '<div class="deleted progress-bar" style="width:%s%%">%s</div>' % (
d_p, d_v
)
return literal('<div class="progress" style="width:%spx">%s%s</div>' % (width, d_a, d_d))
_URLIFY_RE = re.compile(r'''
# URL markup
(?P<url>%s) |
# @mention markup
(?P<mention>%s) |
# Changeset hash markup
(?<!\w|[-_])
(?P<hash>[0-9a-f]{12,40})
(?!\w|[-_]) |
# Markup of *bold text*
(?:
(?:^|(?<=\s))
(?P<bold> [*] (?!\s) [^*\n]* (?<!\s) [*] )
(?![*\w])
) |
# "Stylize" markup
\[see\ \=>\ *(?P<seen>[a-zA-Z0-9\/\=\?\&\ \:\/\.\-]*)\] |
\[license\ \=>\ *(?P<license>[a-zA-Z0-9\/\=\?\&\ \:\/\.\-]*)\] |
\[(?P<tagtype>requires|recommends|conflicts|base)\ \=>\ *(?P<tagvalue>[a-zA-Z0-9\-\/]*)\] |
\[(?:lang|language)\ \=>\ *(?P<lang>[a-zA-Z\-\/\#\+]*)\] |
\[(?P<tag>[a-z]+)\]
''' % (url_re.pattern, MENTIONS_REGEX.pattern),
re.VERBOSE | re.MULTILINE | re.IGNORECASE)
def urlify_text(s, repo_name=None, link_=None, truncate=None, stylize=False, truncatef=truncate):
"""
Parses given text message and make literal html with markup.
The text will be truncated to the specified length.
Hashes are turned into changeset links to specified repository.
URLs links to what they say.
Issues are linked to given issue-server.
If link_ is provided, all text not already linking somewhere will link there.
>>> urlify_text("Urlify http://example.com/ and 'https://example.com' *and* <b>markup/b>")
literal('Urlify <a href="http://example.com/">http://example.com/</a> and '<a href="https://example.com&apos">https://example.com&apos</a>; <b>*and*</b> <b>markup/b>')
"""
def _replace(match_obj):
match_url = match_obj.group('url')
if match_url is not None:
return '<a href="%(url)s">%(url)s</a>' % {'url': match_url}
mention = match_obj.group('mention')
if mention is not None:
return '<b>%s</b>' % mention
hash_ = match_obj.group('hash')
if hash_ is not None and repo_name is not None:
return '<a class="changeset_hash" href="%(url)s">%(hash)s</a>' % {
'url': url('changeset_home', repo_name=repo_name, revision=hash_),
'hash': hash_,
}
bold = match_obj.group('bold')
if bold is not None:
return '<b>*%s*</b>' % _urlify(bold[1:-1])
if stylize:
seen = match_obj.group('seen')
if seen:
return '<div class="label label-meta" data-tag="see">see => %s</div>' % seen
license = match_obj.group('license')
if license:
return '<div class="label label-meta" data-tag="license"><a href="http://www.opensource.org/licenses/%s">%s</a></div>' % (license, license)
tagtype = match_obj.group('tagtype')
if tagtype:
tagvalue = match_obj.group('tagvalue')
return '<div class="label label-meta" data-tag="%s">%s => <a href="/%s">%s</a></div>' % (tagtype, tagtype, tagvalue, tagvalue)
lang = match_obj.group('lang')
if lang:
return '<div class="label label-meta" data-tag="lang">%s</div>' % lang
tag = match_obj.group('tag')
if tag:
return '<div class="label label-meta" data-tag="%s">%s</div>' % (tag, tag)
return match_obj.group(0)
def _urlify(s):
"""
Extract urls from text and make html links out of them
"""
return _URLIFY_RE.sub(_replace, s)
if truncate is None:
s = s.rstrip()
else:
s = truncatef(s, truncate, whole_word=True)
s = html_escape(s)
s = _urlify(s)
if repo_name is not None:
s = urlify_issues(s, repo_name)
if link_ is not None:
# make href around everything that isn't a href already
s = linkify_others(s, link_)
s = s.replace('\r\n', '<br/>').replace('\n', '<br/>')
# Turn HTML5 into more valid HTML4 as required by some mail readers.
# (This is not done in one step in html_escape, because character codes like
# { risk to be seen as an issue reference due to the presence of '#'.)
s = s.replace("'", "'")
return literal(s)
def linkify_others(t, l):
"""Add a default link to html with links.
HTML doesn't allow nesting of links, so the outer link must be broken up
in pieces and give space for other links.
"""
urls = re.compile(r'(\<a.*?\<\/a\>)',)
links = []
for e in urls.split(t):
if e.strip() and not urls.match(e):
links.append('<a class="message-link" href="%s">%s</a>' % (l, e))
else:
links.append(e)
return ''.join(links)
# Global variable that will hold the actual urlify_issues function body.
# Will be set on first use when the global configuration has been read.
_urlify_issues_f = None
def urlify_issues(newtext, repo_name):
"""Urlify issue references according to .ini configuration"""
global _urlify_issues_f
if _urlify_issues_f is None:
assert kallithea.CONFIG['sqlalchemy.url'] # make sure config has been loaded
# Build chain of urlify functions, starting with not doing any transformation
def tmp_urlify_issues_f(s):
return s
issue_pat_re = re.compile(r'issue_pat(.*)')
for k in kallithea.CONFIG:
# Find all issue_pat* settings that also have corresponding server_link and prefix configuration
m = issue_pat_re.match(k)
if m is None:
continue
suffix = m.group(1)
issue_pat = kallithea.CONFIG.get(k)
issue_server_link = kallithea.CONFIG.get('issue_server_link%s' % suffix)
issue_sub = kallithea.CONFIG.get('issue_sub%s' % suffix)
issue_prefix = kallithea.CONFIG.get('issue_prefix%s' % suffix)
if issue_prefix:
log.error('found unsupported issue_prefix%s = %r - use issue_sub%s instead', suffix, issue_prefix, suffix)
if not issue_pat:
log.error('skipping incomplete issue pattern %r: it needs a regexp', k)
continue
if not issue_server_link:
log.error('skipping incomplete issue pattern %r: it needs issue_server_link%s', k, suffix)
continue
if issue_sub is None: # issue_sub can be empty but should be present
log.error('skipping incomplete issue pattern %r: it needs (a potentially empty) issue_sub%s', k, suffix)
continue
# Wrap tmp_urlify_issues_f with substitution of this pattern, while making sure all loop variables (and compiled regexpes) are bound
try:
issue_re = re.compile(issue_pat)
except re.error as e:
log.error('skipping invalid issue pattern %r: %r -> %r %r. Error: %s', k, issue_pat, issue_server_link, issue_sub, str(e))
continue
log.debug('issue pattern %r: %r -> %r %r', k, issue_pat, issue_server_link, issue_sub)
def issues_replace(match_obj,
issue_server_link=issue_server_link, issue_sub=issue_sub):
try:
issue_url = match_obj.expand(issue_server_link)
except (IndexError, re.error) as e:
log.error('invalid issue_url setting %r -> %r %r. Error: %s', issue_pat, issue_server_link, issue_sub, str(e))
issue_url = issue_server_link
issue_url = issue_url.replace('{repo}', repo_name)
issue_url = issue_url.replace('{repo_name}', repo_name.split(kallithea.URL_SEP)[-1])
# if issue_sub is empty use the matched issue reference verbatim
if not issue_sub:
issue_text = match_obj.group()
else:
try:
issue_text = match_obj.expand(issue_sub)
except (IndexError, re.error) as e:
log.error('invalid issue_sub setting %r -> %r %r. Error: %s', issue_pat, issue_server_link, issue_sub, str(e))
issue_text = match_obj.group()
return (
'<a class="issue-tracker-link" href="%(url)s">'
'%(text)s'
'</a>'
) % {
'url': issue_url,
'text': issue_text,
}
def tmp_urlify_issues_f(s, issue_re=issue_re, issues_replace=issues_replace, chain_f=tmp_urlify_issues_f):
return issue_re.sub(issues_replace, chain_f(s))
# Set tmp function globally - atomically
_urlify_issues_f = tmp_urlify_issues_f
return _urlify_issues_f(newtext)
def render_w_mentions(source, repo_name=None):
"""
Render plain text with revision hashes and issue references urlified
and with @mention highlighting.
"""
s = safe_str(source)
s = urlify_text(s, repo_name=repo_name)
return literal('<div class="formatted-fixed">%s</div>' % s)
def changeset_status(repo, revision):
return ChangesetStatusModel().get_status(repo, revision)
def changeset_status_lbl(changeset_status):
return db.ChangesetStatus.get_status_lbl(changeset_status)
def get_permission_name(key):
return dict(db.Permission.PERMS).get(key)
def journal_filter_help():
return _(textwrap.dedent('''
Example filter terms:
repository:vcs
username:developer
action:*push*
ip:127.0.0.1
date:20120101
date:[20120101100000 TO 20120102]
Generate wildcards using '*' character:
"repository:vcs*" - search everything starting with 'vcs'
"repository:*vcs*" - search for repository containing 'vcs'
Optional AND / OR operators in queries
"repository:vcs OR repository:test"
"username:test AND repository:test*"
'''))
def ip_range(ip_addr):
s, e = db.UserIpMap._get_ip_range(ip_addr)
return '%s - %s' % (s, e)
|