pull requests controller for rhodecode for initializing pull requests

    :created_on: May 7, 2012

    :author: marcink

    :copyright: (C) 2010-2012 Marcin Kuzminski <marcin@python-works.com>

    :license: GPLv3, see COPYING for more details.

"""

# 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/>.

import logging

import traceback

import formencode

from webob.exc import HTTPNotFound, HTTPForbidden

from collections import defaultdict

from itertools import groupby

from pylons import request, response, session, tmpl_context as c, url

from pylons.controllers.util import abort, redirect

from pylons.i18n.translation import _

from pylons.decorators import jsonify

from rhodecode.lib.compat import json

from rhodecode.lib.base import BaseRepoController, render

from rhodecode.lib.auth import LoginRequired, HasRepoPermissionAnyDecorator,\

    NotAnonymous

from rhodecode.lib import helpers as h

from rhodecode.lib import diffs

from rhodecode.lib.utils import action_logger

from rhodecode.model.db import User, PullRequest, ChangesetStatus,\

    ChangesetComment

from rhodecode.model.pull_request import PullRequestModel

from rhodecode.model.meta import Session

from rhodecode.model.repo import RepoModel

from rhodecode.model.comment import ChangesetCommentsModel

from rhodecode.model.changeset_status import ChangesetStatusModel

from rhodecode.model.forms import PullRequestForm

log = logging.getLogger(__name__)

class PullrequestsController(BaseRepoController):

    @LoginRequired()

    @HasRepoPermissionAnyDecorator('repository.read', 'repository.write',

                                   'repository.admin')

    def __before__(self):

        super(PullrequestsController, self).__before__()

        repo_model = RepoModel()

        c.users_array = repo_model.get_users_js()

        c.users_groups_array = repo_model.get_users_groups_js()

    def _get_repo_refs(self, repo):

        hist_l = []

        branches_group = ([('branch:%s:%s' % (k, v), k) for

                         k, v in repo.branches.iteritems()], _("Branches"))

        bookmarks_group = ([('book:%s:%s' % (k, v), k) for

                         k, v in repo.bookmarks.iteritems()], _("Bookmarks"))

        tags_group = ([('tag:%s:%s' % (k, v), k) for

                         k, v in repo.tags.iteritems()], _("Tags"))

        hist_l.append(bookmarks_group)

        hist_l.append(branches_group)

        hist_l.append(tags_group)

        return hist_l

    def show_all(self, repo_name):

        c.pull_requests = PullRequestModel().get_all(repo_name)

        c.repo_name = repo_name

        return render('/pullrequests/pullrequest_show_all.html')

    @NotAnonymous()

    def index(self):

        org_repo = c.rhodecode_db_repo

        if org_repo.scm_instance.alias != 'hg':

            log.error('Review not available for GIT REPOS')

            raise HTTPNotFound

        other_repos_info = {}

        c.org_refs = self._get_repo_refs(c.rhodecode_repo)

        c.org_repos = []

        c.other_repos = []

        c.org_repos.append((org_repo.repo_name, '%s/%s' % (

                                org_repo.user.username, c.repo_name))

                           )

        # add org repo to other so we can open pull request agains itself

        c.other_repos.extend(c.org_repos)

        c.default_pull_request = org_repo.repo_name

        c.default_revs = self._get_repo_refs(org_repo.scm_instance)

        #add orginal repo

        other_repos_info[org_repo.repo_name] = {

            'gravatar': h.gravatar_url(org_repo.user.email, 24),

            'description': org_repo.description,

            'revs': h.select('other_ref', '', c.default_revs, class_='refs')

        }

        #gather forks and add to this list

        for fork in org_repo.forks:

            c.other_repos.append((fork.repo_name, '%s/%s' % (

                                    fork.user.username, fork.repo_name))

                                 )

            other_repos_info[fork.repo_name] = {

                'gravatar': h.gravatar_url(fork.user.email, 24),

                'description': fork.description,

                'revs': h.select('other_ref', '',

                                 self._get_repo_refs(fork.scm_instance),

                                 class_='refs')

            }

        #add parents of this fork also

        if org_repo.parent:

            c.default_pull_request = org_repo.parent.repo_name

            c.other_repos.append((org_repo.parent.repo_name, '%s/%s' % (

                                        org_repo.parent.user.username,

                                        org_repo.parent.repo_name))

                                     )

            other_repos_info[org_repo.parent.repo_name] = {

                'gravatar': h.gravatar_url(org_repo.parent.user.email, 24),

                'description': org_repo.parent.description,

                'revs': h.select('other_ref', '',

                                 self._get_repo_refs(org_repo.parent.scm_instance),

                                 class_='refs')

            }

        c.other_repos_info = json.dumps(other_repos_info)

        c.review_members = [org_repo.user]

        return render('/pullrequests/pullrequest.html')

    @NotAnonymous()

    def create(self, repo_name):

        try:

            _form = PullRequestForm()().to_python(request.POST)

        except formencode.Invalid, errors:

            log.error(traceback.format_exc())

            if errors.error_dict.get('revisions'):

                msg = 'Revisions: %s' % errors.error_dict['revisions']

            elif errors.error_dict.get('pullrequest_title'):

                msg = _('Pull request requires a title with min. 3 chars')

            else:

                msg = _('error during creation of pull request')

            h.flash(msg, 'error')

            return redirect(url('pullrequest_home', repo_name=repo_name))

        org_repo = _form['org_repo']

        org_ref = _form['org_ref']

        other_repo = _form['other_repo']

        other_ref = _form['other_ref']

        revisions = _form['revisions']

        reviewers = _form['review_members']

        title = _form['pullrequest_title']

        description = _form['pullrequest_desc']

        try:

            pull_request = PullRequestModel().create(

                self.rhodecode_user.user_id, org_repo, org_ref, other_repo,

                other_ref, revisions, reviewers, title, description

            )

            Session().commit()

            h.flash(_('Successfully opened new pull request'),

                    category='success')

        except Exception:

            h.flash(_('Error occurred during sending pull request'),

                    category='error')

            log.error(traceback.format_exc())

            return redirect(url('pullrequest_home', repo_name=repo_name))

        return redirect(url('pullrequest_show', repo_name=other_repo,

                            pull_request_id=pull_request.pull_request_id))

    @NotAnonymous()

    @jsonify

    def update(self, repo_name, pull_request_id):

        pull_request = PullRequest.get_or_404(pull_request_id)

        if pull_request.is_closed():

            raise HTTPForbidden()

        reviewers_ids = map(int, filter(lambda v: v not in [None, ''],

                   request.POST.get('reviewers_ids', '').split(',')))

        PullRequestModel().update_reviewers(pull_request_id, reviewers_ids)

        Session.commit()

        return True

    @NotAnonymous()

    @jsonify

    def delete(self, repo_name, pull_request_id):

        pull_request = PullRequest.get_or_404(pull_request_id)

        #only owner can delete it !

        if pull_request.author.user_id == c.rhodecode_user.user_id:

            PullRequestModel().delete(pull_request)

            Session().commit()

            h.flash(_('Successfully deleted pull request'),

                    category='success')

            return redirect(url('admin_settings_my_account'))

            raise HTTPForbidden()

    def _load_compare_data(self, pull_request, enable_comments=True):

        """

        Load context data needed for generating compare diff

        :param pull_request:

        :type pull_request:

        """

        org_repo = pull_request.org_repo

        (org_ref_type,

         org_ref_name,

         org_ref_rev) = pull_request.org_ref.split(':')

        other_repo = pull_request.other_repo

        (other_ref_type,

         other_ref_name,

         other_ref_rev) = pull_request.other_ref.split(':')

        # despite opening revisions for bookmarks/branches/tags, we always

        # convert this to rev to prevent changes after book or branch change

        org_ref = ('rev', org_ref_rev)

        other_ref = ('rev', other_ref_rev)

        c.org_repo = org_repo

        c.other_repo = other_repo

        c.cs_ranges, discovery_data = PullRequestModel().get_compare_data(

                                       org_repo, org_ref, other_repo, other_ref

                                      )

        c.statuses = c.rhodecode_db_repo.statuses([x.raw_id for x in

                                                   c.cs_ranges])

        # defines that we need hidden inputs with changesets

        c.as_form = request.GET.get('as_form', False)

        c.org_ref = org_ref[1]

        c.other_ref = other_ref[1]

        # diff needs to have swapped org with other to generate proper diff

        _diff = diffs.differ(other_repo, other_ref, org_repo, org_ref,

                             discovery_data)

        diff_processor = diffs.DiffProcessor(_diff, format='gitdiff')

        _parsed = diff_processor.prepare()

        c.files = []

        c.changes = {}

        for f in _parsed:

            fid = h.FID('', f['filename'])

            c.files.append([fid, f['operation'], f['filename'], f['stats']])

            diff = diff_processor.as_html(enable_comments=enable_comments,

                                          diff_lines=[f])

            c.changes[fid] = [f['operation'], f['filename'], diff]

    def show(self, repo_name, pull_request_id):

        repo_model = RepoModel()

        c.users_array = repo_model.get_users_js()

        c.users_groups_array = repo_model.get_users_groups_js()

        c.pull_request = PullRequest.get_or_404(pull_request_id)

        cc_model = ChangesetCommentsModel()

        cs_model = ChangesetStatusModel()

        _cs_statuses = cs_model.get_statuses(c.pull_request.org_repo,

                                            pull_request=c.pull_request,

                                            with_revisions=True)

        cs_statuses = defaultdict(list)

        for st in _cs_statuses:

            cs_statuses[st.author.username] += [st]

        c.pull_request_reviewers = []

        c.pull_request_pending_reviewers = []

        for o in c.pull_request.reviewers:

            st = cs_statuses.get(o.user.username, None)

            if st:

                sorter = lambda k: k.version

                st = [(x, list(y)[0])

                      for x, y in (groupby(sorted(st, key=sorter), sorter))]

            else:

                c.pull_request_pending_reviewers.append(o.user)

            c.pull_request_reviewers.append([o.user, st])

        # pull_requests repo_name we opened it against

        # ie. other_repo must match

        if repo_name != c.pull_request.other_repo.repo_name:

            raise HTTPNotFound

        # load compare data into template context

        enable_comments = not c.pull_request.is_closed()

        self._load_compare_data(c.pull_request, enable_comments=enable_comments)

        # inline comments

        c.inline_cnt = 0

        c.inline_comments = cc_model.get_inline_comments(

                                c.rhodecode_db_repo.repo_id,

                                pull_request=pull_request_id)

        # count inline comments

        for __, lines in c.inline_comments:

            for comments in lines.values():

                c.inline_cnt += len(comments)

        # comments

        c.comments = cc_model.get_comments(c.rhodecode_db_repo.repo_id,

                                           pull_request=pull_request_id)

        # changeset(pull-request) status

        c.current_changeset_status = cs_model.calculate_status(

                                        c.pull_request_reviewers

                                     )

        c.changeset_statuses = ChangesetStatus.STATUSES

        c.target_repo = c.pull_request.org_repo.repo_name

        return render('/pullrequests/pullrequest_show.html')

    @NotAnonymous()

    @jsonify

    def comment(self, repo_name, pull_request_id):

        pull_request = PullRequest.get_or_404(pull_request_id)

        if pull_request.is_closed():

            raise HTTPForbidden()

        status = request.POST.get('changeset_status')

        change_status = request.POST.get('change_changeset_status')

        comm = ChangesetCommentsModel().create(

            text=request.POST.get('text'),

            repo=c.rhodecode_db_repo.repo_id,

            user=c.rhodecode_user.user_id,

            pull_request=pull_request_id,

            f_path=request.POST.get('f_path'),

            line_no=request.POST.get('line'),

            status_change=(ChangesetStatus.get_status_lbl(status)

                           if status and change_status else None)

        )

        # get status if set !

        if status and change_status:

            ChangesetStatusModel().set_status(

                c.rhodecode_db_repo.repo_id,

                status,

                c.rhodecode_user.user_id,

                comm,

                pull_request=pull_request_id

            )

        action_logger(self.rhodecode_user,

                      'user_commented_pull_request:%s' % pull_request_id,

                      c.rhodecode_db_repo, self.ip_addr, self.sa)

        if request.POST.get('save_close'):

            PullRequestModel().close_pull_request(pull_request_id)

            action_logger(self.rhodecode_user,

                      'user_closed_pull_request:%s' % pull_request_id,

                      c.rhodecode_db_repo, self.ip_addr, self.sa)

        Session().commit()

        if not request.environ.get('HTTP_X_PARTIAL_XHR'):

            return redirect(h.url('pullrequest_show', repo_name=repo_name,

                                  pull_request_id=pull_request_id))

        data = {

           'target_id': h.safeid(h.safe_unicode(request.POST.get('f_path'))),

        }

        if comm:

            c.co = comm

            data.update(comm.get_dict())

            data.update({'rendered_text':

                         render('changeset/changeset_comment_block.html')})

        return data

    @NotAnonymous()

    @jsonify

    def delete_comment(self, repo_name, comment_id):

        co = ChangesetComment.get(comment_id)

        if co.pull_request.is_closed():

            #don't allow deleting comments on closed pull request

            raise HTTPForbidden()

        owner = lambda: co.author.user_id == c.rhodecode_user.user_id

        if h.HasPermissionAny('hg.admin', 'repository.admin')() or owner:

            ChangesetCommentsModel().delete(comment=co)

            Session().commit()

            return True

        else:

            raise HTTPForbidden()

import logging

import datetime

from sqlalchemy import *

from sqlalchemy.exc import DatabaseError

from sqlalchemy.orm import relation, backref, class_mapper

from sqlalchemy.orm.session import Session

from sqlalchemy.ext.declarative import declarative_base

from rhodecode.lib.dbmigrate.migrate import *

from rhodecode.lib.dbmigrate.migrate.changeset import *

from rhodecode.model.meta import Base

from rhodecode.model import meta

log = logging.getLogger(__name__)

def upgrade(migrate_engine):

    """

    Upgrade operations go here.

    Don't create your own engine; bind migrate_engine to your metadata

    """

    #==========================================================================

    # USEREMAILMAP

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_4_0 import UserEmailMap

    tbl = UserEmailMap.__table__

    tbl.create()

    #==========================================================================

    # PULL REQUEST

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_4_0 import PullRequest

    tbl = PullRequest.__table__

    tbl.create()

    #==========================================================================

    # PULL REQUEST REVIEWERS

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_4_0 import PullRequestReviewers

    tbl = PullRequestReviewers.__table__

    tbl.create()

    #==========================================================================

    # CHANGESET STATUS

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_4_0 import ChangesetStatus

    tbl = ChangesetStatus.__table__

    tbl.create()

    ## RESET COMPLETLY THE metadata for sqlalchemy to use the 1_3_0 Base 

    Base = declarative_base()

    Base.metadata.clear()

    Base.metadata = MetaData()

    Base.metadata.bind = migrate_engine

    meta.Base = Base

    #==========================================================================

    # USERS TABLE

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_3_0 import User

    tbl = User.__table__

    # change column name -> firstname

    col = User.__table__.columns.name

    col.alter(index=Index('u_username_idx', 'username'))

    col.alter(index=Index('u_email_idx', 'email'))

    col.alter(name="firstname", table=tbl)

    inherit_default_permissions = Column("inherit_default_permissions",

                                         Boolean(), nullable=True, unique=None,

                                         default=True)

    inherit_default_permissions.create(table=tbl)

    inherit_default_permissions.alter(nullable=False, default=True, table=tbl)

    #==========================================================================

    # REPOSITORIES

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_3_0 import Repository

    tbl = Repository.__table__

    enable_locking = Column("enable_locking", Boolean(), nullable=True,

                            unique=None, default=False)

    enable_locking.create(table=tbl)

    enable_locking.alter(nullable=False, default=False, table=tbl)

    _locked = Column("locked", String(255), nullable=True, unique=False,

                     default=None)

    _locked.create(table=tbl)

    landing_rev = Column("landing_revision", String(255), nullable=True,

                         unique=False, default='tip')

    landing_rev.create(table=tbl)

    landing_rev.alter(nullable=False, default='tip', table=tbl)

    #==========================================================================

    # GROUPS

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_3_0 import RepoGroup

    tbl = RepoGroup.__table__

    enable_locking = Column("enable_locking", Boolean(), nullable=True,

                            unique=None, default=False)

    enable_locking.create(table=tbl)

    enable_locking.alter(nullable=False, default=False)

    #==========================================================================

    # CACHE INVALIDATION

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_3_0 import CacheInvalidation

    tbl = CacheInvalidation.__table__

    col = CacheInvalidation.__table__.columns.cache_key

    col.alter(index=Index('key_idx', 'cache_key'))

    #==========================================================================

    # NOTIFICATION

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_3_0 import Notification

    tbl = Notification.__table__

    col = Notification.__table__.columns.type

    col.alter(index=Index('notification_type_idx', 'type'),)

    #==========================================================================

    # CHANGESET_COMMENTS

    #==========================================================================

    from rhodecode.lib.dbmigrate.schema.db_1_3_0 import ChangesetComment

    tbl = ChangesetComment.__table__

    col.alter(index=Index('cc_revision_idx', 'revision'),)

    hl_lines = Column('hl_lines', Unicode(512), nullable=True)

    hl_lines.create(table=tbl)

    created_on = Column('created_on', DateTime(timezone=False), nullable=True,

                        default=datetime.datetime.now)

    created_on.create(table=tbl)

    created_on.alter(nullable=False, default=datetime.datetime.now)

    modified_at = Column('modified_at', DateTime(timezone=False), nullable=False,

                         default=datetime.datetime.now)

    modified_at.alter(type=DateTime(timezone=False), table=tbl)

    pull_request_id = Column("pull_request_id", Integer(),

                             ForeignKey('pull_requests.pull_request_id'),

                             nullable=True)

    pull_request_id.create(table=tbl)

    ## RESET COMPLETLY THE metadata for sqlalchemy back after using 1_3_0

    Base = declarative_base()

    Base.metadata.clear()

    Base.metadata = MetaData()

    Base.metadata.bind = migrate_engine

    meta.Base = Base

def downgrade(migrate_engine):

    meta = MetaData()

    meta.bind = migrate_engine