Show More
__init__.py
357 lines
| 11.4 KiB
| text/x-python
|
PythonLexer
r1502 | # -*- coding: utf-8 -*- | |||
# Copyright (C) 2016-2017 RhodeCode GmbH | ||||
# | ||||
# This program is free software: you can redistribute it and/or modify | ||||
# it under the terms of the GNU Affero General Public License, version 3 | ||||
# (only), as published by the Free Software Foundation. | ||||
# | ||||
# 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 Affero General Public License | ||||
# along with this program. If not, see <http://www.gnu.org/licenses/>. | ||||
# | ||||
# This program is dual-licensed. If you wish to learn more about the | ||||
# RhodeCode Enterprise Edition, including its added features, Support services, | ||||
# and proprietary license terms, please see https://rhodecode.com/licenses/ | ||||
r1539 | import time | |||
r1502 | import logging | |||
from pylons import tmpl_context as c | ||||
r1537 | from pyramid.httpexceptions import HTTPFound | |||
r1502 | ||||
r1539 | from rhodecode.lib import helpers as h | |||
r1746 | from rhodecode.lib.utils import PartialRenderer | |||
from rhodecode.lib.utils2 import StrictAttributeDict, safe_int, datetime_to_time | ||||
r1714 | from rhodecode.lib.vcs.exceptions import RepositoryRequirementError | |||
r1746 | from rhodecode.lib.ext_json import json | |||
r1554 | from rhodecode.model import repo | |||
r1774 | from rhodecode.model import repo_group | |||
r1539 | from rhodecode.model.db import User | |||
r1554 | from rhodecode.model.scm import ScmModel | |||
r1502 | ||||
log = logging.getLogger(__name__) | ||||
r1505 | ADMIN_PREFIX = '/_admin' | |||
STATIC_FILE_PREFIX = '/_static' | ||||
r1774 | def add_route_with_slash(config,name, pattern, **kw): | |||
config.add_route(name, pattern, **kw) | ||||
if not pattern.endswith('/'): | ||||
config.add_route(name + '_slash', pattern + '/', **kw) | ||||
r1746 | def get_format_ref_id(repo): | |||
"""Returns a `repo` specific reference formatter function""" | ||||
if h.is_svn(repo): | ||||
return _format_ref_id_svn | ||||
else: | ||||
return _format_ref_id | ||||
def _format_ref_id(name, raw_id): | ||||
"""Default formatting of a given reference `name`""" | ||||
return name | ||||
def _format_ref_id_svn(name, raw_id): | ||||
"""Special way of formatting a reference for Subversion including path""" | ||||
return '%s@%s' % (name, raw_id) | ||||
r1502 | class TemplateArgs(StrictAttributeDict): | |||
pass | ||||
class BaseAppView(object): | ||||
def __init__(self, context, request): | ||||
self.request = request | ||||
self.context = context | ||||
self.session = request.session | ||||
r1534 | self._rhodecode_user = request.user # auth user | |||
r1537 | self._rhodecode_db_user = self._rhodecode_user.get_instance() | |||
r1539 | self._maybe_needs_password_change( | |||
request.matched_route.name, self._rhodecode_db_user) | ||||
def _maybe_needs_password_change(self, view_name, user_obj): | ||||
log.debug('Checking if user %s needs password change on view %s', | ||||
user_obj, view_name) | ||||
skip_user_views = [ | ||||
'logout', 'login', | ||||
'my_account_password', 'my_account_password_update' | ||||
] | ||||
if not user_obj: | ||||
return | ||||
if user_obj.username == User.DEFAULT_USER: | ||||
return | ||||
now = time.time() | ||||
should_change = user_obj.user_data.get('force_password_change') | ||||
change_after = safe_int(should_change) or 0 | ||||
if should_change and now > change_after: | ||||
log.debug('User %s requires password change', user_obj) | ||||
h.flash('You are required to change your password', 'warning', | ||||
ignore_duplicate=True) | ||||
if view_name not in skip_user_views: | ||||
raise HTTPFound( | ||||
self.request.route_path('my_account_password')) | ||||
r1502 | ||||
r1785 | def _get_local_tmpl_context(self, include_app_defaults=False): | |||
r1533 | c = TemplateArgs() | |||
c.auth_user = self.request.user | ||||
r1785 | if include_app_defaults: | |||
# NOTE(marcink): after full pyramid migration include_app_defaults | ||||
# should be turned on by default | ||||
from rhodecode.lib.base import attach_context_attributes | ||||
attach_context_attributes(c, self.request, self.request.user.user_id) | ||||
r1533 | return c | |||
r1502 | ||||
r1505 | def _register_global_c(self, tmpl_args): | |||
""" | ||||
Registers attributes to pylons global `c` | ||||
""" | ||||
# TODO(marcink): remove once pyramid migration is finished | ||||
for k, v in tmpl_args.items(): | ||||
setattr(c, k, v) | ||||
r1502 | def _get_template_context(self, tmpl_args): | |||
r1505 | self._register_global_c(tmpl_args) | |||
r1502 | ||||
r1536 | local_tmpl_args = { | |||
r1502 | 'defaults': {}, | |||
'errors': {}, | ||||
} | ||||
r1536 | local_tmpl_args.update(tmpl_args) | |||
return local_tmpl_args | ||||
r1502 | ||||
r1534 | def load_default_context(self): | |||
""" | ||||
example: | ||||
def load_default_context(self): | ||||
c = self._get_local_tmpl_context() | ||||
c.custom_var = 'foobar' | ||||
self._register_global_c(c) | ||||
return c | ||||
""" | ||||
raise NotImplementedError('Needs implementation in view class') | ||||
r1554 | ||||
class RepoAppView(BaseAppView): | ||||
def __init__(self, context, request): | ||||
super(RepoAppView, self).__init__(context, request) | ||||
self.db_repo = request.db_repo | ||||
self.db_repo_name = self.db_repo.repo_name | ||||
self.db_repo_pull_requests = ScmModel().get_pull_requests(self.db_repo) | ||||
r1714 | def _handle_missing_requirements(self, error): | |||
log.error( | ||||
'Requirements are missing for repository %s: %s', | ||||
self.db_repo_name, error.message) | ||||
r1785 | def _get_local_tmpl_context(self, include_app_defaults=False): | |||
c = super(RepoAppView, self)._get_local_tmpl_context( | ||||
include_app_defaults=include_app_defaults) | ||||
r1554 | # register common vars for this type of view | |||
c.rhodecode_db_repo = self.db_repo | ||||
c.repo_name = self.db_repo_name | ||||
c.repository_pull_requests = self.db_repo_pull_requests | ||||
r1714 | ||||
c.repository_requirements_missing = False | ||||
try: | ||||
self.rhodecode_vcs_repo = self.db_repo.scm_instance() | ||||
except RepositoryRequirementError as e: | ||||
c.repository_requirements_missing = True | ||||
self._handle_missing_requirements(e) | ||||
r1554 | return c | |||
r1646 | class DataGridAppView(object): | |||
""" | ||||
Common class to have re-usable grid rendering components | ||||
""" | ||||
r1649 | def _extract_ordering(self, request, column_map=None): | |||
column_map = column_map or {} | ||||
r1646 | column_index = safe_int(request.GET.get('order[0][column]')) | |||
order_dir = request.GET.get( | ||||
'order[0][dir]', 'desc') | ||||
order_by = request.GET.get( | ||||
'columns[%s][data][sort]' % column_index, 'name_raw') | ||||
# translate datatable to DB columns | ||||
r1649 | order_by = column_map.get(order_by) or order_by | |||
r1646 | ||||
search_q = request.GET.get('search[value]') | ||||
return search_q, order_by, order_dir | ||||
def _extract_chunk(self, request): | ||||
start = safe_int(request.GET.get('start'), 0) | ||||
length = safe_int(request.GET.get('length'), 25) | ||||
draw = safe_int(request.GET.get('draw')) | ||||
return draw, start, length | ||||
r1746 | class BaseReferencesView(RepoAppView): | |||
""" | ||||
Base for reference view for branches, tags and bookmarks. | ||||
""" | ||||
def load_default_context(self): | ||||
c = self._get_local_tmpl_context() | ||||
# TODO(marcink): remove repo_info and use c.rhodecode_db_repo instead | ||||
c.repo_info = self.db_repo | ||||
self._register_global_c(c) | ||||
return c | ||||
def load_refs_context(self, ref_items, partials_template): | ||||
_render = PartialRenderer(partials_template) | ||||
_data = [] | ||||
pre_load = ["author", "date", "message"] | ||||
is_svn = h.is_svn(self.rhodecode_vcs_repo) | ||||
format_ref_id = get_format_ref_id(self.rhodecode_vcs_repo) | ||||
for ref_name, commit_id in ref_items: | ||||
commit = self.rhodecode_vcs_repo.get_commit( | ||||
commit_id=commit_id, pre_load=pre_load) | ||||
# TODO: johbo: Unify generation of reference links | ||||
use_commit_id = '/' in ref_name or is_svn | ||||
files_url = h.url( | ||||
'files_home', | ||||
repo_name=c.repo_name, | ||||
f_path=ref_name if is_svn else '', | ||||
revision=commit_id if use_commit_id else ref_name, | ||||
at=ref_name) | ||||
_data.append({ | ||||
"name": _render('name', ref_name, files_url), | ||||
"name_raw": ref_name, | ||||
"date": _render('date', commit.date), | ||||
"date_raw": datetime_to_time(commit.date), | ||||
"author": _render('author', commit.author), | ||||
"commit": _render( | ||||
'commit', commit.message, commit.raw_id, commit.idx), | ||||
"commit_raw": commit.idx, | ||||
"compare": _render( | ||||
'compare', format_ref_id(ref_name, commit.raw_id)), | ||||
}) | ||||
c.has_references = bool(_data) | ||||
c.data = json.dumps(_data) | ||||
r1554 | class RepoRoutePredicate(object): | |||
def __init__(self, val, config): | ||||
self.val = val | ||||
def text(self): | ||||
return 'repo_route = %s' % self.val | ||||
phash = text | ||||
def __call__(self, info, request): | ||||
r1778 | ||||
if hasattr(request, 'vcs_call'): | ||||
# skip vcs calls | ||||
return | ||||
r1554 | repo_name = info['match']['repo_name'] | |||
repo_model = repo.RepoModel() | ||||
by_name_match = repo_model.get_by_repo_name(repo_name, cache=True) | ||||
r1774 | ||||
r1554 | if by_name_match: | |||
# register this as request object we can re-use later | ||||
request.db_repo = by_name_match | ||||
return True | ||||
by_id_match = repo_model.get_repo_by_id(repo_name) | ||||
if by_id_match: | ||||
request.db_repo = by_id_match | ||||
return True | ||||
return False | ||||
r1766 | class RepoTypeRoutePredicate(object): | |||
def __init__(self, val, config): | ||||
self.val = val or ['hg', 'git', 'svn'] | ||||
def text(self): | ||||
return 'repo_accepted_type = %s' % self.val | ||||
phash = text | ||||
def __call__(self, info, request): | ||||
r1778 | if hasattr(request, 'vcs_call'): | |||
# skip vcs calls | ||||
return | ||||
r1766 | ||||
rhodecode_db_repo = request.db_repo | ||||
log.debug( | ||||
'%s checking repo type for %s in %s', | ||||
self.__class__.__name__, rhodecode_db_repo.repo_type, self.val) | ||||
if rhodecode_db_repo.repo_type in self.val: | ||||
return True | ||||
else: | ||||
log.warning('Current view is not supported for repo type:%s', | ||||
rhodecode_db_repo.repo_type) | ||||
r1769 | # | |||
# h.flash(h.literal( | ||||
# _('Action not supported for %s.' % rhodecode_repo.alias)), | ||||
# category='warning') | ||||
# return redirect( | ||||
r1785 | # route_path('repo_summary', repo_name=cls.rhodecode_db_repo.repo_name)) | |||
r1769 | ||||
r1766 | return False | |||
r1774 | class RepoGroupRoutePredicate(object): | |||
def __init__(self, val, config): | ||||
self.val = val | ||||
def text(self): | ||||
return 'repo_group_route = %s' % self.val | ||||
phash = text | ||||
def __call__(self, info, request): | ||||
r1778 | if hasattr(request, 'vcs_call'): | |||
# skip vcs calls | ||||
return | ||||
r1774 | repo_group_name = info['match']['repo_group_name'] | |||
repo_group_model = repo_group.RepoGroupModel() | ||||
by_name_match = repo_group_model.get_by_group_name( | ||||
repo_group_name, cache=True) | ||||
if by_name_match: | ||||
# register this as request object we can re-use later | ||||
request.db_repo_group = by_name_match | ||||
return True | ||||
return False | ||||
r1766 | ||||
r1554 | def includeme(config): | |||
config.add_route_predicate( | ||||
'repo_route', RepoRoutePredicate) | ||||
r1766 | config.add_route_predicate( | |||
r1774 | 'repo_accepted_types', RepoTypeRoutePredicate) | |||
config.add_route_predicate( | ||||
'repo_group_route', RepoGroupRoutePredicate) | ||||