authentication: use registerd UID for plugin definition for more consistent loading of auth plugins.
authentication: use registerd UID for plugin definition for more consistent loading of auth plugins.

File last commit:

r3112:f3f66eb3 default
r3246:ef7f5bf1 default
Show More
repo.py
356 lines | 11.2 KiB | text/x-python | PythonLexer
# Copyright (C) 2016-2018 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/
import collections
import logging
import datetime
from rhodecode.translation import lazy_ugettext
from rhodecode.model.db import User, Repository, Session
from rhodecode.events.base import RhodeCodeIntegrationEvent
from rhodecode.lib.vcs.exceptions import CommitDoesNotExistError
log = logging.getLogger(__name__)
def _commits_as_dict(event, commit_ids, repos):
"""
Helper function to serialize commit_ids
:param event: class calling this method
:param commit_ids: commits to get
:param repos: list of repos to check
"""
from rhodecode.lib.utils2 import extract_mentioned_users
from rhodecode.lib.helpers import (
urlify_commit_message, process_patterns, chop_at_smart)
from rhodecode.model.repo import RepoModel
if not repos:
raise Exception('no repo defined')
if not isinstance(repos, (tuple, list)):
repos = [repos]
if not commit_ids:
return []
needed_commits = list(commit_ids)
commits = []
reviewers = []
for repo in repos:
if not needed_commits:
return commits # return early if we have the commits we need
vcs_repo = repo.scm_instance(cache=False)
try:
# use copy of needed_commits since we modify it while iterating
for commit_id in list(needed_commits):
if commit_id.startswith('tag=>'):
raw_id = commit_id[5:]
cs_data = {
'raw_id': commit_id, 'short_id': commit_id,
'branch': None,
'git_ref_change': 'tag_add',
'message': 'Added new tag {}'.format(raw_id),
'author': event.actor.full_contact,
'date': datetime.datetime.now(),
'refs': {
'branches': [],
'bookmarks': [],
'tags': []
}
}
commits.append(cs_data)
elif commit_id.startswith('delete_branch=>'):
raw_id = commit_id[15:]
cs_data = {
'raw_id': commit_id, 'short_id': commit_id,
'branch': None,
'git_ref_change': 'branch_delete',
'message': 'Deleted branch {}'.format(raw_id),
'author': event.actor.full_contact,
'date': datetime.datetime.now(),
'refs': {
'branches': [],
'bookmarks': [],
'tags': []
}
}
commits.append(cs_data)
else:
try:
cs = vcs_repo.get_commit(commit_id)
except CommitDoesNotExistError:
continue # maybe its in next repo
cs_data = cs.__json__()
cs_data['refs'] = cs._get_refs()
cs_data['mentions'] = extract_mentioned_users(cs_data['message'])
cs_data['reviewers'] = reviewers
cs_data['url'] = RepoModel().get_commit_url(
repo, cs_data['raw_id'], request=event.request)
cs_data['permalink_url'] = RepoModel().get_commit_url(
repo, cs_data['raw_id'], request=event.request,
permalink=True)
urlified_message, issues_data = process_patterns(
cs_data['message'], repo.repo_name)
cs_data['issues'] = issues_data
cs_data['message_html'] = urlify_commit_message(
cs_data['message'], repo.repo_name)
cs_data['message_html_title'] = chop_at_smart(
cs_data['message'], '\n', suffix_if_chopped='...')
commits.append(cs_data)
needed_commits.remove(commit_id)
except Exception:
log.exception('Failed to extract commits data')
# we don't send any commits when crash happens, only full list
# matters we short circuit then.
return []
missing_commits = set(commit_ids) - set(c['raw_id'] for c in commits)
if missing_commits:
log.error('Inconsistent repository state. '
'Missing commits: %s', ', '.join(missing_commits))
return commits
def _issues_as_dict(commits):
""" Helper function to serialize issues from commits """
issues = {}
for commit in commits:
for issue in commit['issues']:
issues[issue['id']] = issue
return issues
class RepoEvent(RhodeCodeIntegrationEvent):
"""
Base class for events acting on a repository.
:param repo: a :class:`Repository` instance
"""
def __init__(self, repo):
super(RepoEvent, self).__init__()
self.repo = repo
def as_dict(self):
from rhodecode.model.repo import RepoModel
data = super(RepoEvent, self).as_dict()
extra_fields = collections.OrderedDict()
for field in self.repo.extra_fields:
extra_fields[field.field_key] = field.field_value
data.update({
'repo': {
'repo_id': self.repo.repo_id,
'repo_name': self.repo.repo_name,
'repo_type': self.repo.repo_type,
'url': RepoModel().get_url(
self.repo, request=self.request),
'permalink_url': RepoModel().get_url(
self.repo, request=self.request, permalink=True),
'extra_fields': extra_fields
}
})
return data
class RepoPreCreateEvent(RepoEvent):
"""
An instance of this class is emitted as an :term:`event` before a repo is
created.
"""
name = 'repo-pre-create'
display_name = lazy_ugettext('repository pre create')
class RepoCreateEvent(RepoEvent):
"""
An instance of this class is emitted as an :term:`event` whenever a repo is
created.
"""
name = 'repo-create'
display_name = lazy_ugettext('repository created')
class RepoPreDeleteEvent(RepoEvent):
"""
An instance of this class is emitted as an :term:`event` whenever a repo is
created.
"""
name = 'repo-pre-delete'
display_name = lazy_ugettext('repository pre delete')
class RepoDeleteEvent(RepoEvent):
"""
An instance of this class is emitted as an :term:`event` whenever a repo is
created.
"""
name = 'repo-delete'
display_name = lazy_ugettext('repository deleted')
class RepoVCSEvent(RepoEvent):
"""
Base class for events triggered by the VCS
"""
def __init__(self, repo_name, extras):
self.repo = Repository.get_by_repo_name(repo_name)
if not self.repo:
raise Exception('repo by this name %s does not exist' % repo_name)
self.extras = extras
super(RepoVCSEvent, self).__init__(self.repo)
@property
def actor(self):
if self.extras.get('username'):
return User.get_by_username(self.extras['username'])
@property
def actor_ip(self):
if self.extras.get('ip'):
return self.extras['ip']
@property
def server_url(self):
if self.extras.get('server_url'):
return self.extras['server_url']
@property
def request(self):
return self.extras.get('request') or self.get_request()
class RepoPrePullEvent(RepoVCSEvent):
"""
An instance of this class is emitted as an :term:`event` before commits
are pulled from a repo.
"""
name = 'repo-pre-pull'
display_name = lazy_ugettext('repository pre pull')
class RepoPullEvent(RepoVCSEvent):
"""
An instance of this class is emitted as an :term:`event` after commits
are pulled from a repo.
"""
name = 'repo-pull'
display_name = lazy_ugettext('repository pull')
class RepoPrePushEvent(RepoVCSEvent):
"""
An instance of this class is emitted as an :term:`event` before commits
are pushed to a repo.
"""
name = 'repo-pre-push'
display_name = lazy_ugettext('repository pre push')
class RepoPushEvent(RepoVCSEvent):
"""
An instance of this class is emitted as an :term:`event` after commits
are pushed to a repo.
:param extras: (optional) dict of data from proxied VCS actions
"""
name = 'repo-push'
display_name = lazy_ugettext('repository push')
def __init__(self, repo_name, pushed_commit_ids, extras):
super(RepoPushEvent, self).__init__(repo_name, extras)
self.pushed_commit_ids = pushed_commit_ids
self.new_refs = extras.new_refs
def as_dict(self):
data = super(RepoPushEvent, self).as_dict()
def branch_url(branch_name):
return '{}/changelog?branch={}'.format(
data['repo']['url'], branch_name)
def tag_url(tag_name):
return '{}/files/{}/'.format(
data['repo']['url'], tag_name)
commits = _commits_as_dict(
self, commit_ids=self.pushed_commit_ids, repos=[self.repo])
last_branch = None
for commit in reversed(commits):
commit['branch'] = commit['branch'] or last_branch
last_branch = commit['branch']
issues = _issues_as_dict(commits)
branches = set()
tags = set()
for commit in commits:
if commit['refs']['tags']:
for tag in commit['refs']['tags']:
tags.add(tag)
if commit['branch']:
branches.add(commit['branch'])
# maybe we have branches in new_refs ?
try:
branches = branches.union(set(self.new_refs['branches']))
except Exception:
pass
branches = [
{
'name': branch,
'url': branch_url(branch)
}
for branch in branches
]
# maybe we have branches in new_refs ?
try:
tags = tags.union(set(self.new_refs['tags']))
except Exception:
pass
tags = [
{
'name': tag,
'url': tag_url(tag)
}
for tag in tags
]
data['push'] = {
'commits': commits,
'issues': issues,
'branches': branches,
'tags': tags,
}
return data