~launchpad-pqm/launchpad/devel

# Copyright 2009-2011 Canonical Ltd.  This software is licensed under the

# GNU Affero General Public License version 3 (see the file LICENSE).

"""Browser views for distributions."""

__metaclass__ = type

__all__ = [

    'DerivativeDistributionOverviewMenu',

    'DistributionAddView',

    'DistributionArchiveMirrorsRSSView',

    'DistributionArchiveMirrorsView',

    'DistributionArchivesView',

    'DistributionChangeMembersView',

    'DistributionChangeMirrorAdminView',

    'DistributionCountryArchiveMirrorsView',

    'DistributionDisabledMirrorsView',

    'DistributionEditView',

    'DistributionFacets',

    'DistributionNavigation',

    'DistributionPPASearchView',

    'DistributionPackageSearchView',

    'DistributionPendingReviewMirrorsView',

    'DistributionPublisherConfigView',

    'DistributionReassignmentView',

    'DistributionSeriesView',

    'DistributionDerivativesView',

    'DistributionSeriesMirrorsRSSView',

    'DistributionSeriesMirrorsView',

    'DistributionSetActionNavigationMenu',

    'DistributionSetBreadcrumb',

    'DistributionSetContextMenu',

    'DistributionSetFacets',

    'DistributionSetNavigation',

    'DistributionSetView',

    'DistributionSpecificationsMenu',

    'DistributionUnofficialMirrorsView',

    'DistributionView',

    ]

from collections import defaultdict

import datetime

from zope.component import getUtility

from zope.event import notify

from zope.formlib import form

from zope.interface import implements

from zope.lifecycleevent import ObjectCreatedEvent

from zope.security.interfaces import Unauthorized

from canonical.launchpad.browser.feeds import FeedsMixin

from canonical.launchpad.components.decoratedresultset import (

    DecoratedResultSet,

    )

from canonical.launchpad.helpers import english_list

from canonical.launchpad.webapp import (

    ApplicationMenu,

    canonical_url,

    ContextMenu,

    enabled_with_permission,

    GetitemNavigation,

    LaunchpadView,

    Link,

    Navigation,

    NavigationMenu,

    redirection,

    StandardLaunchpadFacets,

    stepthrough,

    )

from canonical.launchpad.webapp.batching import BatchNavigator

from canonical.launchpad.webapp.breadcrumb import Breadcrumb

from canonical.launchpad.webapp.interfaces import ILaunchBag

from lp.answers.browser.faqtarget import FAQTargetNavigationMixin

from lp.answers.browser.questiontarget import (

    QuestionTargetFacetMixin,

    QuestionTargetTraversalMixin,

    )

from lp.app.browser.launchpadform import (

    action,

    custom_widget,

    LaunchpadFormView,

    )

from lp.app.errors import NotFoundError

from lp.app.widgets.image import ImageChangeWidget

from lp.archivepublisher.interfaces.publisherconfig import (

    IPublisherConfig,

    IPublisherConfigSet,

    )

from lp.blueprints.browser.specificationtarget import (

    HasSpecificationsMenuMixin,

    )

from lp.bugs.browser.bugtask import BugTargetTraversalMixin

from lp.bugs.browser.structuralsubscription import (

    expose_structural_subscription_data_to_js,

    StructuralSubscriptionMenuMixin,

    StructuralSubscriptionTargetTraversalMixin,

    )

from lp.registry.browser import (

    add_subscribe_link,

    RegistryEditFormView,

    )

from lp.registry.browser.announcement import HasAnnouncementsView

from lp.registry.browser.menu import (

    IRegistryCollectionNavigationMenu,

    RegistryCollectionActionMenuBase,

    )

from lp.registry.browser.pillar import PillarBugsMenu

from lp.registry.browser.objectreassignment import ObjectReassignmentView

from lp.registry.interfaces.distribution import (

    IDerivativeDistribution,

    IDistribution,

    IDistributionMirrorMenuMarker,

    IDistributionSet,

    )

from lp.registry.interfaces.distributionmirror import (

    IDistributionMirrorSet,

    MirrorContent,

    MirrorSpeed,

    )

from lp.registry.interfaces.series import SeriesStatus

from lp.services.geoip.helpers import (

    ipaddress_from_request,

    request_country,

    )

from lp.services.propertycache import cachedproperty

from lp.soyuz.browser.packagesearch import PackageSearchViewBase

from lp.soyuz.enums import ArchivePurpose

from lp.soyuz.interfaces.archive import IArchiveSet

class DistributionNavigation(

    GetitemNavigation, BugTargetTraversalMixin, QuestionTargetTraversalMixin,

    FAQTargetNavigationMixin, StructuralSubscriptionTargetTraversalMixin):

    usedfor = IDistribution

    @redirection('+source', status=301)

    def redirect_source(self):

        return canonical_url(self.context)

    @stepthrough('+mirror')

    def traverse_mirrors(self, name):

        return self.context.getMirrorByName(name)

    @stepthrough('+source')

    def traverse_sources(self, name):

        return self.context.getSourcePackage(name)

    @stepthrough('+milestone')

    def traverse_milestone(self, name):

        return self.context.getMilestone(name)

    @stepthrough('+announcement')

    def traverse_announcement(self, name):

        return self.context.getAnnouncement(name)

    @stepthrough('+spec')

    def traverse_spec(self, name):

        return self.context.getSpecification(name)

    @stepthrough('+archive')

    def traverse_archive(self, name):

        return self.context.getArchive(name)

class DistributionSetNavigation(Navigation):

    usedfor = IDistributionSet

    def traverse(self, name):

        # Raise a 404 on an invalid distribution name

        distribution = self.context.getByName(name)

        if distribution is None:

            raise NotFoundError(name)

        return self.redirectSubTree(canonical_url(distribution))

class DistributionFacets(QuestionTargetFacetMixin, StandardLaunchpadFacets):

    usedfor = IDistribution

    enable_only = [

        'overview',

        'branches',

        'bugs',

        'answers',

        'specifications',

        'translations',

        ]

    def specifications(self):

        text = 'Blueprints'

        summary = 'Feature specifications for %s' % self.context.displayname

        return Link('', text, summary)

class DistributionSetBreadcrumb(Breadcrumb):

    """Builds a breadcrumb for an `IDistributionSet`."""

    text = 'Distributions'

class DistributionSetFacets(StandardLaunchpadFacets):

    usedfor = IDistributionSet

    enable_only = ['overview', ]

class DistributionSetContextMenu(ContextMenu):

    usedfor = IDistributionSet

    links = ['products', 'distributions', 'people', 'meetings']

    def distributions(self):

        return Link('/distros/', 'View distributions')

    def products(self):

        return Link('/projects/', 'View projects')

    def people(self):

        return Link('/people/', 'View people')

    def meetings(self):

        return Link('/sprints/', 'View meetings')

class DistributionMirrorsNavigationMenu(NavigationMenu):

    usedfor = IDistributionMirrorMenuMarker

    facet = 'overview'

    links = ('cdimage_mirrors',

             'archive_mirrors',

             'disabled_mirrors',

             'pending_review_mirrors',

             'unofficial_mirrors',

             )

    @property

    def distribution(self):

        """Helper method to return the distribution object.

        self.context is the view, so return *its* context.

        """

        return self.context.context

    def cdimage_mirrors(self):

        text = 'CD mirrors'

        return Link('+cdmirrors', text, icon='info')

    def archive_mirrors(self):

        text = 'Archive mirrors'

        return Link('+archivemirrors', text, icon='info')

    def newmirror(self):

        text = 'Register mirror'

        return Link('+newmirror', text, icon='add')

    def _userCanSeeNonPublicMirrorListings(self):

        """Does the user have rights to see non-public mirrors listings?"""

        user = getUtility(ILaunchBag).user

        return (self.distribution.full_functionality

                and user is not None

                and user.inTeam(self.distribution.mirror_admin))

    def disabled_mirrors(self):

        text = 'Disabled mirrors'

        enabled = self._userCanSeeNonPublicMirrorListings()

        return Link('+disabledmirrors', text, enabled=enabled, icon='info')

    def pending_review_mirrors(self):

        text = 'Pending-review mirrors'

        enabled = self._userCanSeeNonPublicMirrorListings()

        return Link(

            '+pendingreviewmirrors', text, enabled=enabled, icon='info')

    def unofficial_mirrors(self):

        text = 'Unofficial mirrors'

        enabled = self._userCanSeeNonPublicMirrorListings()

        return Link('+unofficialmirrors', text, enabled=enabled, icon='info')

class DistributionLinksMixin(StructuralSubscriptionMenuMixin):

    """A mixin to provide common links to menus."""

    @enabled_with_permission('launchpad.Edit')

    def edit(self):

        text = 'Change details'

        return Link('+edit', text, icon='edit')

class DistributionNavigationMenu(NavigationMenu, DistributionLinksMixin):

    """A menu of context actions."""

    usedfor = IDistribution

    facet = 'overview'

    @enabled_with_permission("launchpad.Admin")

    def pubconf(self):

        text = "Configure publisher"

        return Link("+pubconf", text, icon="edit")

    @cachedproperty

    def links(self):

        return ['edit', 'pubconf', 'subscribe_to_bug_mail', 'edit_bug_mail']

class DistributionOverviewMenu(ApplicationMenu, DistributionLinksMixin):

    usedfor = IDistribution

    facet = 'overview'

    links = [

        'edit',

        'branding',

        'driver',

        'search',

        'members',

        'mirror_admin',

        'reassign',

        'addseries',

        'series',

        'derivatives',

        'milestones',

        'top_contributors',

        'builds',

        'cdimage_mirrors',

        'archive_mirrors',

        'pending_review_mirrors',

        'disabled_mirrors',

        'unofficial_mirrors',

        'newmirror',

        'announce',

        'announcements',

        'ppas',

        'configure_answers',

        'configure_blueprints',

        'configure_translations',

        ]

    @enabled_with_permission('launchpad.Edit')

    def branding(self):

        text = 'Change branding'

        return Link('+branding', text, icon='edit')

    @enabled_with_permission('launchpad.Edit')

    def driver(self):

        text = 'Appoint driver'

        summary = 'Someone with permission to set goals for all series'

        return Link('+driver', text, summary, icon='edit')

    @enabled_with_permission('launchpad.Edit')

    def reassign(self):

        text = 'Change maintainer'

        return Link('+reassign', text, icon='edit')

    def newmirror(self):

        text = 'Register a new mirror'

        enabled = self.context.full_functionality

        return Link('+newmirror', text, enabled=enabled, icon='add')

    def top_contributors(self):

        text = 'More contributors'

        return Link('+topcontributors', text, icon='info')

    def cdimage_mirrors(self):

        text = 'CD mirrors'

        return Link('+cdmirrors', text, icon='info')

    def archive_mirrors(self):

        text = 'Archive mirrors'

        return Link('+archivemirrors', text, icon='info')

    def _userCanSeeNonPublicMirrorListings(self):

        """Does the user have rights to see non-public mirrors listings?"""

        user = getUtility(ILaunchBag).user

        return (self.context.full_functionality

                and user is not None

                and user.inTeam(self.context.mirror_admin))

    def disabled_mirrors(self):

        text = 'Disabled mirrors'

        enabled = self._userCanSeeNonPublicMirrorListings()

        return Link('+disabledmirrors', text, enabled=enabled, icon='info')

    def pending_review_mirrors(self):

        text = 'Pending-review mirrors'

        enabled = self._userCanSeeNonPublicMirrorListings()

        return Link(

            '+pendingreviewmirrors', text, enabled=enabled, icon='info')

    def unofficial_mirrors(self):

        text = 'Unofficial mirrors'

        enabled = self._userCanSeeNonPublicMirrorListings()

        return Link('+unofficialmirrors', text, enabled=enabled, icon='info')

    @enabled_with_permission('launchpad.Edit')

    def members(self):

        text = 'Change members team'

        return Link('+selectmemberteam', text, icon='edit')

    @enabled_with_permission('launchpad.Edit')

    def mirror_admin(self):

        text = 'Change mirror admins'

        enabled = self.context.full_functionality

        return Link('+selectmirroradmins', text, enabled=enabled, icon='edit')

    def search(self):

        text = 'Search packages'

        return Link('+search', text, icon='search')

    @enabled_with_permission('launchpad.Admin')

    def addseries(self):

        text = 'Add series'

        return Link('+addseries', text, icon='add')

    def series(self):

        text = 'All series'

        return Link('+series', text, icon='info')

    def derivatives(self):

        text = 'All derivatives'

        return Link('+derivatives', text, icon='info')

    def milestones(self):

        text = 'All milestones'

        return Link('+milestones', text, icon='info')

    @enabled_with_permission('launchpad.Edit')

    def announce(self):

        text = 'Make announcement'

        summary = 'Publish an item of news for this project'

        return Link('+announce', text, summary, icon='add')

    def announcements(self):

        text = 'Read all announcements'

        enabled = bool(self.context.getAnnouncements())

        return Link('+announcements', text, icon='info', enabled=enabled)

    def builds(self):

        text = 'Builds'

        return Link('+builds', text, icon='info')

    def ppas(self):

        text = 'Personal Package Archives'

        return Link('+ppas', text, icon='info')

    @enabled_with_permission('launchpad.Edit')

    def configure_answers(self):

        text = 'Configure support tracker'

        summary = 'Allow users to ask questions on this project'

        return Link('+edit', text, summary, icon='edit')

    @enabled_with_permission('launchpad.Edit')

    def configure_blueprints(self):

        text = 'Configure blueprints'

        summary = 'Enable tracking of feature planning.'

        return Link('+edit', text, summary, icon='edit')

    @enabled_with_permission('launchpad.TranslationsAdmin')

    def configure_translations(self):

        text = 'Configure translations'

        summary = 'Allow users to provide translations for this project.'

        return Link('+configure-translations', text, summary, icon='edit')

class DerivativeDistributionOverviewMenu(DistributionOverviewMenu):

    usedfor = IDerivativeDistribution

    @enabled_with_permission('launchpad.Moderate')

    def addseries(self):

        text = 'Add series'

        return Link('+addseries', text, icon='add')

class DistributionBugsMenu(PillarBugsMenu):

    usedfor = IDistribution

    facet = 'bugs'

    @property

    def links(self):

        links = [

            'bugsupervisor',

            'securitycontact',

            'cve',

            'filebug',

            ]

        add_subscribe_link(links)

        return links

class DistributionSpecificationsMenu(NavigationMenu,

                                     HasSpecificationsMenuMixin):

    usedfor = IDistribution

    facet = 'specifications'

    links = ['listall', 'doc', 'assignments', 'new', 'register_sprint']

class DistributionPackageSearchView(PackageSearchViewBase):

    """Customised PackageSearchView for Distribution"""

    def initialize(self):

        """Save the search type if provided."""

        super(DistributionPackageSearchView, self).initialize()

        # If the distribution contains binary packages, then we'll

        # default to searches on binary names, but allow the user to

        # select.

        if self.context.has_published_binaries:

            self.search_type = self.request.get("search_type", 'binary')

        else:

            self.search_type = 'source'

    def contextSpecificSearch(self):

        """See `AbstractPackageSearchView`."""

        if self.search_by_binary_name:

            return self.context.searchBinaryPackages(self.text)

        else:

            non_exact_matches = self.context.searchSourcePackageCaches(

                self.text)

            # The searchBinaryPackageCaches() method returns tuples, so we

            # use the DecoratedResultSet here to just get the

            # DistributionSourcePackag objects for the template.

            def tuple_to_package_cache(cache_name_tuple):

                return cache_name_tuple[0]

            non_exact_matches = DecoratedResultSet(

                non_exact_matches, tuple_to_package_cache)

        return non_exact_matches.config(distinct=True)

    @property

    def search_by_binary_name(self):

        """Return whether the search is on binary names.

        By default, we search by binary names, as this produces much

        better results. But the user may decide to search by sources, or

        in the case of other distributions, it will be the only option.

        """

        return self.search_type == "binary"

    @property

    def source_search_url(self):

        """Return the equivalent search on source packages.

        By default, we search by binary names, but also provide a link

        to the equivalent source package search in some circumstances.

        """

        return "%s/+search?search_type=source&%s" % (

            canonical_url(self.context),

            self.request.get('QUERY_STRING'),

            )

    @cachedproperty

    def exact_matches(self):

        return self.context.searchBinaryPackages(

            self.text, exact_match=True).order_by('name')

    @property

    def has_exact_matches(self):

        return self.exact_matches.count() > 0

    @property

    def has_matches(self):

        return self.matches > 0

    @cachedproperty

    def matching_binary_names(self):

        """Define the matching binary names for each result in the batch."""

        names = {}

        for package_cache in self.batchnav.currentBatch():

            names[package_cache.name] = self._listFirstFiveMatchingNames(

                self.text, package_cache.binpkgnames)

        return names

    def _listFirstFiveMatchingNames(self, match_text, space_separated_list):

        """Returns a comma-separated list of the first five matching items"""

        name_list = space_separated_list.split(' ')

        matching_names = [

            name for name in name_list if match_text in name]

        if len(matching_names) > 5:

            matching_names = matching_names[:5]

            matching_names.append('...')

        return ", ".join(matching_names)

    @cachedproperty

    def distroseries_names(self):

        """Define the distroseries for each package name in exact matches."""

        names = {}

        for package_cache in self.exact_matches:

            package = package_cache.distributionsourcepackage

            # In the absense of Python3.0's set comprehension, we

            # create a list, convert the list to a set and back again:

            distroseries_list = [

                pubrec.distroseries.name

                    for pubrec in package.current_publishing_records

                        if pubrec.distroseries.active]

            distroseries_list = list(set(distroseries_list))

            # Yay for alphabetical series names.

            distroseries_list.sort()

            names[package.name] = ", ".join(distroseries_list)

        return names

    @property

    def display_exact_matches(self):

        """Return whether exact match results should be displayed."""

        if not self.search_by_binary_name:

            return False

        if self.batchnav.start > 0:

            return False

        return self.has_exact_matches

class DistributionView(HasAnnouncementsView, FeedsMixin):

    """Default Distribution view class."""

    def initialize(self):

        super(DistributionView, self).initialize()

        expose_structural_subscription_data_to_js(

            self.context, self.request, self.user)

    def linkedMilestonesForSeries(self, series):

        """Return a string of linkified milestones in the series."""

        # Listify to remove repeated queries.

        milestones = list(series.milestones)

        if len(milestones) == 0:

            return ""

        linked_milestones = []

        for milestone in milestones:

            linked_milestones.append(

                "<a href=%s>%s</a>" % (

                    canonical_url(milestone), milestone.name))

        return english_list(linked_milestones)

    @cachedproperty

    def latest_derivatives(self):

        """The 5 most recent derivatives."""

        return self.context.derivatives[:5]

class DistributionArchivesView(LaunchpadView):

    @property

    def batchnav(self):

        """Return the batch navigator for the archives."""

        return BatchNavigator(self.archive_list, self.request)

    @cachedproperty

    def archive_list(self):

        """Returns the list of archives for the given distribution.

        The context may be an IDistroSeries or a users archives.

        """

        results = getUtility(IArchiveSet).getArchivesForDistribution(

            self.context, purposes=[ArchivePurpose.COPY], user=self.user,

            exclude_disabled=False)

        return results.order_by('date_created DESC')

class DistributionPPASearchView(LaunchpadView):

    """Search PPAs belonging to the Distribution in question."""