~launchpad-pqm/launchpad/devel

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

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

"""Adapters for registry objects."""

__metaclass__ = type

__all__ = [

    'distroseries_to_distribution',

    'PollSubset',

    'productseries_to_product',

    'sourcepackage_to_distribution',

    ]

from zope.component import getUtility

from zope.component.interfaces import ComponentLookupError

from zope.interface import implements

from lp.archivepublisher.interfaces.publisherconfig import IPublisherConfigSet

from lp.registry.interfaces.poll import (

    IPollSet,

    IPollSubset,

    PollAlgorithm,

    PollStatus,

    )

from lp.services.webapp.interfaces import ILaunchpadPrincipal

def sourcepackage_to_distribution(source_package):

    """Adapts `ISourcePackage` object to `IDistribution`.

    This also supports `IDistributionSourcePackage`

    """

    return source_package.distribution

def distroseries_to_distribution(distroseries):

    """Adapts `IDistroSeries` object to `IDistribution`.

    This is useful for adapting to `IServiceUsage`

    or `ILaunchpadUsage`."""

    return distroseries.distribution

def person_from_principal(principal):

    """Adapt `ILaunchpadPrincipal` to `IPerson`."""

    if ILaunchpadPrincipal.providedBy(principal):

        if principal.person is None:

            raise ComponentLookupError

        return principal.person

    else:

        # This is not actually necessary when this is used as an adapter

        # from ILaunchpadPrincipal, as we know we always have an

        # ILaunchpadPrincipal.

        #

        # When Zope3 interfaces allow returning None for "cannot adapt"

        # we can return None here.

        ##return None

        raise ComponentLookupError

class PollSubset:

    """Adapt an `IPoll` to an `IPollSubset`."""

    implements(IPollSubset)

    title = 'Team polls'

    def __init__(self, team=None):

        self.team = team

    def new(self, name, title, proposition, dateopens, datecloses,

            secrecy, allowspoilt, poll_type=PollAlgorithm.SIMPLE):

        """See IPollSubset."""

        assert self.team is not None, (

            'team cannot be None to call this method.')

        return getUtility(IPollSet).new(

            self.team, name, title, proposition, dateopens,

            datecloses, secrecy, allowspoilt, poll_type)

    def getByName(self, name, default=None):

        """See IPollSubset."""

        assert self.team is not None, (

            'team cannot be None to call this method.')

        pollset = getUtility(IPollSet)

        return pollset.getByTeamAndName(self.team, name, default)

    def getAll(self):

        """See IPollSubset."""

        assert self.team is not None, (

            'team cannot be None to call this method.')

        return getUtility(IPollSet).selectByTeam(self.team)

    def getOpenPolls(self, when=None):

        """See IPollSubset."""

        assert self.team is not None, (

            'team cannot be None to call this method.')

        return getUtility(IPollSet).selectByTeam(

            self.team, [PollStatus.OPEN], orderBy='datecloses', when=when)

    def getClosedPolls(self, when=None):

        """See IPollSubset."""

        assert self.team is not None, (

            'team cannot be None to call this method.')

        return getUtility(IPollSet).selectByTeam(

            self.team, [PollStatus.CLOSED], orderBy='datecloses', when=when)

    def getNotYetOpenedPolls(self, when=None):

        """See IPollSubset."""

        assert self.team is not None, (

            'team cannot be None to call this method.')

        return getUtility(IPollSet).selectByTeam(

            self.team, [PollStatus.NOT_YET_OPENED],

            orderBy='dateopens', when=when)

def productseries_to_product(productseries):

    """Adapts `IProductSeries` object to `IProduct`.

    This is useful for adapting to `IHasExternalBugTracker`

    or `ILaunchpadUsage`.

    """

    return productseries.product

def distribution_to_publisherconfig(distro):

    """Adapts `IDistribution` to `IPublisherConfig`."""

    # Used for traversal from distro to +pubconf.

    config = getUtility(IPublisherConfigSet).getByDistribution(distro)

    return config

def package_to_sourcepackagename(package):

    """Adapts a package to its `ISourcePackageName`."""

    return package.sourcepackagename