rhodecode/controllers/changeset.py

# -*- coding: utf-8 -*-
"""
    rhodecode.controllers.changeset
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    changeset controller for pylons showoing changes beetween
    revisions

    :created_on: Apr 25, 2010
    :author: marcink
    :copyright: (C) 2009-2011 Marcin Kuzminski <[e-mail]>
    :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
from collections import defaultdict
from webob.exc import HTTPForbidden

from pylons import tmpl_context as c, url, request, response
from pylons.i18n.translation import _
from pylons.controllers.util import redirect
from pylons.decorators import jsonify

from vcs.exceptions import RepositoryError, ChangesetError, \
    ChangesetDoesNotExistError
from vcs.nodes import FileNode

import rhodecode.lib.helpers as h
from rhodecode.lib.auth import LoginRequired, HasRepoPermissionAnyDecorator
from rhodecode.lib.base import BaseRepoController, render
from rhodecode.lib.utils import EmptyChangeset
from rhodecode.lib.compat import OrderedDict
from rhodecode.lib import diffs
from rhodecode.model.db import ChangesetComment
from rhodecode.model.comment import ChangesetCommentsModel
from rhodecode.model.meta import Session

log = logging.getLogger(__name__)


def anchor_url(revision,path):
    fid = h.FID(revision, path)
    return h.url.current(anchor=fid,**request.GET)

def get_ignore_ws(fid, GET):
    ig_ws_global = request.GET.get('ignorews')
    ig_ws = filter(lambda k:k.startswith('WS'),GET.getall(fid))
    if ig_ws:
        try:
            return int(ig_ws[0].split(':')[-1])
        except:
            pass
    return ig_ws_global

def _ignorews_url(fileid=None):

    params = defaultdict(list)
    lbl = _('show white space')
    ig_ws = get_ignore_ws(fileid, request.GET)
    ln_ctx = get_line_ctx(fileid, request.GET)
    # global option
    if fileid is None:
        if ig_ws is None:
            params['ignorews'] += [1]
            lbl = _('ignore white space')
        ctx_key = 'context'
        ctx_val = ln_ctx
    # per file options
    else:
        if ig_ws is None:
            params[fileid] += ['WS:1']
            lbl = _('ignore white space')

        ctx_key = fileid
        ctx_val = 'C:%s' % ln_ctx
    # if we have passed in ln_ctx pass it along to our params
    if ln_ctx:
        params[ctx_key] += [ctx_val]
    
    params['anchor'] = fileid
    return h.link_to(lbl, h.url.current(**params))

def get_line_ctx(fid, GET):
    ln_ctx_global = request.GET.get('context')
    ln_ctx = filter(lambda k:k.startswith('C'),GET.getall(fid))
    
    if ln_ctx:
        retval = ln_ctx[0].split(':')[-1]
    else:
        retval = ln_ctx_global

    try:
        return int(retval)
    except:
        return

def _context_url(fileid=None):
    """
    Generates url for context lines
    
    :param fileid:
    """
    ig_ws = get_ignore_ws(fileid, request.GET)
    ln_ctx = (get_line_ctx(fileid, request.GET) or 3) * 2

    params = defaultdict(list)

    # global option
    if fileid is None:
        if ln_ctx > 0:
            params['context'] += [ln_ctx]

        if ig_ws:
            ig_ws_key = 'ignorews'
            ig_ws_val = 1

    # per file option
    else:
        params[fileid] += ['C:%s' % ln_ctx]
        ig_ws_key = fileid
        ig_ws_val = 'WS:%s' % 1
        
    if ig_ws:
        params[ig_ws_key] += [ig_ws_val]

    lbl = _('%s line context') % ln_ctx

    params['anchor'] = fileid
    return h.link_to(lbl, h.url.current(**params))

def wrap_to_table(str_):
    return '''<table class="code-difftable">
                <tr class="line">
                <td class="lineno new"></td>
                <td class="code"><pre>%s</pre></td>
                </tr>
              </table>''' % str_

class ChangesetController(BaseRepoController):

    @LoginRequired()
    @HasRepoPermissionAnyDecorator('repository.read', 'repository.write',
                                   'repository.admin')
    def __before__(self):
        super(ChangesetController, self).__before__()
        c.affected_files_cut_off = 60

    def index(self, revision):

        c.anchor_url = anchor_url
        c.ignorews_url = _ignorews_url
        c.context_url = _context_url

        #get ranges of revisions if preset
        rev_range = revision.split('...')[:2]

        try:
            if len(rev_range) == 2:
                rev_start = rev_range[0]
                rev_end = rev_range[1]
                rev_ranges = c.rhodecode_repo.get_changesets(start=rev_start,
                                                            end=rev_end)
            else:
                rev_ranges = [c.rhodecode_repo.get_changeset(revision)]

            c.cs_ranges = list(rev_ranges)
            if not c.cs_ranges:
                raise RepositoryError('Changeset range returned empty result')

        except (RepositoryError, ChangesetDoesNotExistError, Exception), e:
            log.error(traceback.format_exc())
            h.flash(str(e), category='warning')
            return redirect(url('home'))

        c.changes = OrderedDict()
        c.sum_added = 0
        c.sum_removed = 0
        c.lines_added = 0
        c.lines_deleted = 0
        c.cut_off = False  # defines if cut off limit is reached

        c.comments = []
        c.inline_comments = []
        c.inline_cnt = 0
        # Iterate over ranges (default changeset view is always one changeset)
        for changeset in c.cs_ranges:
            c.comments.extend(ChangesetCommentsModel()\
                              .get_comments(c.rhodecode_db_repo.repo_id,
                                            changeset.raw_id))
            inlines = ChangesetCommentsModel()\
                        .get_inline_comments(c.rhodecode_db_repo.repo_id,
                                             changeset.raw_id)
            c.inline_comments.extend(inlines)
            c.changes[changeset.raw_id] = []
            try:
                changeset_parent = changeset.parents[0]
            except IndexError:
                changeset_parent = None

            #==================================================================
            # ADDED FILES
            #==================================================================
            for node in changeset.added:

                filenode_old = FileNode(node.path, '', EmptyChangeset())
                if filenode_old.is_binary or node.is_binary:
                    diff = wrap_to_table(_('binary file'))
                    st = (0, 0)
                else:
                    # in this case node.size is good parameter since those are
                    # added nodes and their size defines how many changes were
                    # made
                    c.sum_added += node.size
                    fid = h.FID(revision, node.path)
                    line_context_lcl = get_line_ctx(fid, request.GET)
                    ignore_whitespace_lcl = get_ignore_ws(fid, request.GET)
                    if c.sum_added < self.cut_off_limit:
                        f_gitdiff = diffs.get_gitdiff(filenode_old, node,
                                        ignore_whitespace=ignore_whitespace_lcl,
                                        context=line_context_lcl)
                        d = diffs.DiffProcessor(f_gitdiff, format='gitdiff')

                        st = d.stat()
                        diff = d.as_html()

                    else:
                        diff = wrap_to_table(_('Changeset is to big and '
                                               'was cut off, see raw '
                                               'changeset instead'))
                        c.cut_off = True
                        break

                cs1 = None
                cs2 = node.last_changeset.raw_id
                c.lines_added += st[0]
                c.lines_deleted += st[1]
                c.changes[changeset.raw_id].append(('added', node, diff,
                                                    cs1, cs2, st))

            #==================================================================
            # CHANGED FILES
            #==================================================================
            if not c.cut_off:
                for node in changeset.changed:
                    try:
                        filenode_old = changeset_parent.get_node(node.path)
                    except ChangesetError:
                        log.warning('Unable to fetch parent node for diff')
                        filenode_old = FileNode(node.path, '',
                                                EmptyChangeset())

                    if filenode_old.is_binary or node.is_binary:
                        diff = wrap_to_table(_('binary file'))
                        st = (0, 0)
                    else:

                        if c.sum_removed < self.cut_off_limit:
                            fid = h.FID(revision, node.path)
                            line_context_lcl = get_line_ctx(fid, request.GET)
                            ignore_whitespace_lcl = get_ignore_ws(fid, request.GET,)
                            f_gitdiff = diffs.get_gitdiff(filenode_old, node,
                                    ignore_whitespace=ignore_whitespace_lcl,
                                    context=line_context_lcl)
                            d = diffs.DiffProcessor(f_gitdiff,
                                                     format='gitdiff')
                            st = d.stat()
                            if (st[0] + st[1]) * 256 > self.cut_off_limit:
                                diff = wrap_to_table(_('Diff is to big '
                                                       'and was cut off, see '
                                                       'raw diff instead'))
                            else:
                                diff = d.as_html()

                            if diff:
                                c.sum_removed += len(diff)
                        else:
                            diff = wrap_to_table(_('Changeset is to big and '
                                                   'was cut off, see raw '
                                                   'changeset instead'))
                            c.cut_off = True
                            break

                    cs1 = filenode_old.last_changeset.raw_id
                    cs2 = node.last_changeset.raw_id
                    c.lines_added += st[0]
                    c.lines_deleted += st[1]
                    c.changes[changeset.raw_id].append(('changed', node, diff,
                                                        cs1, cs2, st))

            #==================================================================
            # REMOVED FILES
            #==================================================================
            if not c.cut_off:
                for node in changeset.removed:
                    c.changes[changeset.raw_id].append(('removed', node, None,
                                                        None, None, (0, 0)))

        # count inline comments
        for path, lines in c.inline_comments:
            for comments in lines.values():
                c.inline_cnt += len(comments)

        if len(c.cs_ranges) == 1:
            c.changeset = c.cs_ranges[0]
            c.changes = c.changes[c.changeset.raw_id]

            return render('changeset/changeset.html')
        else:
            return render('changeset/changeset_range.html')

    def raw_changeset(self, revision):

        method = request.GET.get('diff', 'show')
        ignore_whitespace = request.GET.get('ignorews') == '1'
        line_context = request.GET.get('context', 3)
        try:
            c.scm_type = c.rhodecode_repo.alias
            c.changeset = c.rhodecode_repo.get_changeset(revision)
        except RepositoryError:
            log.error(traceback.format_exc())
            return redirect(url('home'))
        else:
            try:
                c.changeset_parent = c.changeset.parents[0]
            except IndexError:
                c.changeset_parent = None
            c.changes = []

            for node in c.changeset.added:
                filenode_old = FileNode(node.path, '')
                if filenode_old.is_binary or node.is_binary:
                    diff = _('binary file') + '\n'
                else:
                    f_gitdiff = diffs.get_gitdiff(filenode_old, node,
                                           ignore_whitespace=ignore_whitespace,
                                           context=line_context)
                    diff = diffs.DiffProcessor(f_gitdiff,
                                                format='gitdiff').raw_diff()

                cs1 = None
                cs2 = node.last_changeset.raw_id
                c.changes.append(('added', node, diff, cs1, cs2))

            for node in c.changeset.changed:
                filenode_old = c.changeset_parent.get_node(node.path)
                if filenode_old.is_binary or node.is_binary:
                    diff = _('binary file')
                else:
                    f_gitdiff = diffs.get_gitdiff(filenode_old, node,
                                           ignore_whitespace=ignore_whitespace,
                                           context=line_context)
                    diff = diffs.DiffProcessor(f_gitdiff,
                                                format='gitdiff').raw_diff()

                cs1 = filenode_old.last_changeset.raw_id
                cs2 = node.last_changeset.raw_id
                c.changes.append(('changed', node, diff, cs1, cs2))

        response.content_type = 'text/plain'

        if method == 'download':
            response.content_disposition = 'attachment; filename=%s.patch' \
                                            % revision

        c.parent_tmpl = ''.join(['# Parent  %s\n' % x.raw_id for x in
                                                 c.changeset.parents])

        c.diffs = ''
        for x in c.changes:
            c.diffs += x[2]

        return render('changeset/raw_changeset.html')

    def comment(self, repo_name, revision):
        ChangesetCommentsModel().create(text=request.POST.get('text'),
                                        repo_id=c.rhodecode_db_repo.repo_id,
                                        user_id=c.rhodecode_user.user_id,
                                        revision=revision,
                                        f_path=request.POST.get('f_path'),
                                        line_no=request.POST.get('line'))
        Session.commit()
        return redirect(h.url('changeset_home', repo_name=repo_name,
                              revision=revision))

    @jsonify
    def delete_comment(self, repo_name, comment_id):
        co = ChangesetComment.get(comment_id)
        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()