package.py

# -*- coding: utf-8 -*-
#
#   package.py — Package controller
#
#   This file is part of debexpo - https://alioth.debian.org/projects/debexpo/
#
#   Copyright © 2008 Jonny Lamb <jonny@debian.org>
#   Copyright © 2010 Jan Dittberner <jandd@debian.org>
#               2011 Arno Töll <debian@toell.net>
#
#   Permission is hereby granted, free of charge, to any person
#   obtaining a copy of this software and associated documentation
#   files (the "Software"), to deal in the Software without
#   restriction, including without limitation the rights to use,
#   copy, modify, merge, publish, distribute, sublicense, and/or sell
#   copies of the Software, and to permit persons to whom the
#   Software is furnished to do so, subject to the following
#   conditions:
#
#   The above copyright notice and this permission notice shall be
#   included in all copies or substantial portions of the Software.
#
#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
#   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
#   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
#   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
#   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
#   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
#   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
#   OTHER DEALINGS IN THE SOFTWARE.

"""
Holds the PackageController.
"""

__author__ = 'Jonny Lamb'
__copyright__ = 'Copyright © 2008 Jonny Lamb, Copyright © 2010 Jan Dittberner'
__license__ = 'MIT'

from datetime import datetime
import logging
import os

from debexpo.lib.base import *
from debexpo.lib import constants, form
from debexpo.lib.utils import get_package_dir
from debexpo.lib.email import Email
from debexpo.lib.filesystem import CheckFiles
from debexpo.lib.schemas import PackageSubscribeForm, PackageCommentForm
from debexpo.lib.plugins import Plugins

from debexpo.model import meta
from debexpo.model.packages import Package
from debexpo.model.package_versions import PackageVersion
from debexpo.model.users import User
from debexpo.model.package_comments import PackageComment
from debexpo.model.package_info import PackageInfo
from debexpo.model.source_packages import SourcePackage
from debexpo.model.binary_packages import BinaryPackage
from debexpo.model.package_files import PackageFile
from debexpo.model.package_subscriptions import PackageSubscription

log = logging.getLogger(__name__)

class PackageController(BaseController):

    def _get_package(self, packagename, from_controller=True):
        """
        """
        log.debug('Details of package "%s" requested' % packagename)

        package = meta.session.query(Package).filter_by(name=packagename).first()

        if package is None and from_controller:
            log.error('Could not get package information')
            redirect(url(controller='packages', action='index', packagename=None))
        if package is None and not from_controller:
            return None

	if from_controller:
            c.package = package
            c.config = config
            c.package_dir = get_package_dir(package.name)
        return package

    def index(self, packagename = None):
        """
        Entry point into the controller. Displays information about the package.

        ``packagename``
            Package name to look at.
        """

        package = self._get_package(packagename)

        c.session = session
        c.constants = constants
        c.outcomes = [
            (constants.PACKAGE_COMMENT_OUTCOME_UNREVIEWED, _('Unreviewed')),
            (constants.PACKAGE_COMMENT_OUTCOME_NEEDS_WORK, _('Needs work')),
            (constants.PACKAGE_COMMENT_OUTCOME_PERFECT, _('Perfect'))
        ]

        c.plugins = Plugins
        c.log = log

        if 'user_id' in session:
            c.user = meta.session.query(User).filter_by(id=session['user_id']).one()
        else:
            c.user = None

        c.plugins = dict()
        for package_version in package.package_versions:
            pv_plugins = Plugins('qa', package_version)
            pv_plugins.load_plugins()
            pv_plugins.load_results()
            c.plugins[package_version.id] = pv_plugins

        log.debug('Rendering page')
        return render('/package/index.mako')

    def subscribe(self, packagename):
        """
        Package subscription.

        ``packagename``
            Package name to look at.
        """
        if 'user_id' not in session:
            log.debug('Requires authentication')
            session['path_before_login'] = request.path_info
            session.save()
            redirect(url('login'))

        package = self._get_package(packagename)

        query = meta.session.query(PackageSubscription).filter_by(
            package=packagename).filter_by(user_id=session['user_id'])
        subscription = query.first()

        validation = False
        if request.method == 'POST':
            # The form has been submitted.
            try:
                fields = form.validate(PackageSubscribeForm,
                                       user_id=session['user_id'])
            except Exception, e:
                log.error('Failed validation')
                validation = e
            if not validation:
                if subscription is None:
                    # There is no previous subscription.
                    if fields['level'] != -1:
                        log.debug('Creating new subscription on %s' % packagename)
                        subscription = PackageSubscription(
                            package=packagename,
                            user_id=session['user_id'],
                            level=fields['level'])
                        meta.session.add(subscription)
                else:
                    # There is a previous subscription.
                    if fields['level'] != -1:
                        log.debug('Changing previous subscription on %s' % packagename)
                        subscription.level = fields['level']
                    else:
                        log.debug('Deleting previous subscription on %s' % packagename)
                        meta.session.delete(subscription)
                meta.session.commit()
                redirect(url('package', packagename=packagename))

        c.subscriptions = [
            (-1, _('No subscription')),
            (constants.SUBSCRIPTION_LEVEL_UPLOADS,
             _('Package upload notifications only')),
            (constants.SUBSCRIPTION_LEVEL_COMMENTS,
             _('Package upload and comment notifications'))]

        if subscription is None:
            c.current_subscription = -1
        else:
            c.current_subscription = subscription.level

        log.debug('Rendering page')
        if validation:
            return form.htmlfill(render('/package/subscribe.mako'), validation)
        return render('/package/subscribe.mako')

    def delete(self, packagename, key):
        """
        Delete package.

        ``packagename``
            Package name to delete.
        """
        if 'user_id' not in session:
            log.debug('Requires authentication')
            session['path_before_login'] = request.path_info
            session.save()
            redirect(url('login'))
        else:
            user = meta.session.query(User).filter_by(id=session['user_id']).one()

        package = self._get_package(packagename)

        if session['user_id'] != package.user_id:
            log.error("User %d is not allowed to change properties of foreign package %s" %(session['user_id'], packagename))
            abort(403)

        if user.get_upload_key() != key:
            log.error("Possible CSRF attack, upload key does not match user's session key")
            abort(402)

        # The user should have already been prompted with a nice dialog box
        # confirming their choice, so no mercy here.
        CheckFiles().delete_files_for_package(package)
        meta.session.delete(package)
        meta.session.commit()

        redirect(url(controller='packages', action='my'))

    @validate(schema=PackageCommentForm(), form='index')
    def _comment_submit(self, packagename):
        """
        Comment submission.

        ``packagename``
            Package name to look at.
        """
        log.debug("Comment form validation successful")

        if 'user_id' not in session:
            log.debug('Requires authentication')
            session['path_before_login'] = request.path_info
            session.save()
            redirect(url('login'))

        package = self._get_package(packagename)

        status = constants.PACKAGE_COMMENT_STATUS_NOT_UPLOADED

        if self.form_result['status']:
            status = constants.PACKAGE_COMMENT_STATUS_UPLOADED

        comment = PackageComment(user_id=session['user_id'],
            package_version_id=self.form_result['package_version'],
            text=self.form_result['text'],
            time=datetime.now(),
            outcome=self.form_result['outcome'],
            status=status)

        meta.session.add(comment)
        meta.session.commit()

        subscribers = meta.session.query(PackageSubscription).filter_by(
            package=packagename).filter(
            PackageSubscription.level <= constants.SUBSCRIPTION_LEVEL_COMMENTS).all()

        if len(subscribers) > 0:
            user = meta.session.query(User).filter_by(id=session['user_id']).one()

            email = Email('comment_posted')
            email.send([s.user.email for s in subscribers], package=packagename,
                comment=self.form_result['text'], user=user)

        redirect(url('package', packagename=packagename))

    def comment(self, packagename):
        if request.method == 'POST':
            log.debug("Comment form submitted")
            return self._comment_submit(packagename)
        else:
            #abort(405)
            redirect(url('package', packagename=packagename))

    def sponsor(self, packagename, key):
        if 'user_id' not in session:
            log.debug('Requires authentication')
            session['path_before_login'] = request.path_info
            session.save()
            redirect(url('login'))
        else:
            user = meta.session.query(User).filter_by(id=session['user_id']).one()

        if user.get_upload_key() != key:
            log.error("Possible CSRF attack, upload key does not match user's session key")
            abort(402)

        package = meta.session.query(Package).filter_by(name=packagename).one()

        if session['user_id'] != package.user_id:
            log.error("User %d is not allowed to change properties of foreign package %s" %(session['user_id'], packagename))
            abort(403)

        if package.needs_sponsor:
                package.needs_sponsor = 0
        else:
                package.needs_sponsor = 1
        log.debug("Toggle 'needs sponsor' flag = %d" % package.needs_sponsor)
        meta.session.commit()

        redirect(url('package', packagename=packagename))