# Copyright (C) 2015-2017 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman 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.
#
# GNU Mailman 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
# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.

""""""

from mailman.core.i18n import _
from mailman.interfaces.workflows import IUnsubscriptionWorkflow
from mailman.workflows.common import (ConfirmationMixin, ModerationMixin,
                                      UnsubscriptionBase)
from public import public
from zope.interface import implementer


@public
@implementer(IUnsubscriptionWorkflow)
class OpenUnsubscriptionPolicy(UnsubscriptionBase):
    """"""

    name = 'unsub-policy-open'
    description = _(
            'An open unsubscription policy, only requires verification.')
    initial_state = 'prepare'
    save_attributes = (
        'address_key',
        'subscriber_key',
        'user_key',
        'token_owner_key',
        )

    def __init__(self, mlist, subscriber=None):
        """

        :param mlist:
        :param subscriber: The user or address to unsubscribe.
        :type subscriber: ``IUser`` or ``IAddress``
        """
        UnsubscriptionBase.__init__(self, mlist, subscriber)

    def _step_prepare(self):
        self.push('do_unsubscription')
        self.push('subscription_checks')


@public
@implementer(IUnsubscriptionWorkflow)
class ConfirmUnsubscriptionPolicy(UnsubscriptionBase, ConfirmationMixin):
    """"""

    name = 'unsub-policy-confirm'
    description = _('An unsubscription policy that requires confirmation.')
    initial_state = 'prepare'
    save_attributes = (
        'confirmed',
        'address_key',
        'subscriber_key',
        'user_key',
        'token_owner_key',
        )

    def __init__(self, mlist, subscriber=None, *,
                 pre_confirmed=False):
        """

        :param mlist:
        :param subscriber: The user or address to unsubscribe.
        :type subscriber: ``IUser`` or ``IAddress``
        :param pre_confirmed: A flag indicating whether, when required by the
            unsubscription policy, an unsubscription request should be
            considered pre-confirmed.  Normally in such cases, a mail-back
            confirmation message is sent to the subscriber, which must be
            positively acknowledged by some manner.  Setting this flag to True
            automatically confirms the unsubscription request.  (A confirmation
            message may still be sent under other conditions.)
        :type pre_confirmed: bool
        """
        UnsubscriptionBase.__init__(self, mlist, subscriber)
        ConfirmationMixin.__init__(self, pre_confirmed=pre_confirmed)

    def _step_prepare(self):
        self.push('do_unsubscription')
        self.push('confirmation_checks')
        self.push('subscription_checks')


@public
@implementer(IUnsubscriptionWorkflow)
class ModerationUnsubscriptionPolicy(UnsubscriptionBase, ModerationMixin):
    """"""

    name = 'unsub-policy-moderate'
    description = _('An unsubscription policy that requires moderation.')
    initial_state = 'prepare'
    save_attributes = (
        'approved',
        'address_key',
        'subscriber_key',
        'user_key',
        'token_owner_key',
        )

    def __init__(self, mlist, subscriber=None, *,
                 pre_approved=False):
        """

        :param mlist:
        :param subscriber: The user or address to unsubscribe.
        :type subscriber: ``IUser`` or ``IAddress``
        :param pre_approved: A flag indicating whether, when required by the
            unsubscription policy, an unsubscription request should be
            considered pre-approved.  Normally in such cases, the list
            administrator is notified that an approval is necessary, which
            must be positively acknowledged in some manner.  Setting this flag
            to True automatically approves the unsubscription request.
        :type pre_approved: bool
        """
        UnsubscriptionBase.__init__(self, mlist, subscriber)
        ModerationMixin.__init__(self, pre_approved=pre_approved)

    def _step_prepare(self):
        self.push('do_unsubscription')
        self.push('moderation_checks')
        self.push('subscription_checks')


@public
@implementer(IUnsubscriptionWorkflow)
class ConfirmModerationUnsubscriptionPolicy(UnsubscriptionBase,
                                            ConfirmationMixin,
                                            ModerationMixin):
    """"""

    name = 'unsub-policy-confirm-moderate'
    description = _(
        'An unsubscription policy, requires moderation after confirmation.')
    initial_state = 'prepare'
    save_attributes = (
        'approved',
        'confirmed',
        'address_key',
        'subscriber_key',
        'user_key',
        'token_owner_key',
        )

    def __init__(self, mlist, subscriber=None, *,
                 pre_confirmed=False, pre_approved=False):
        """

        :param mlist:
        :param subscriber: The user or address to unsubscribe.
        :type subscriber: ``IUser`` or ``IAddress``
        :param pre_confirmed: A flag indicating whether, when required by the
            unsubscription policy, an unsubscription request should be
            considered pre-confirmed.  Normally in such cases, a mail-back
            confirmation message is sent to the subscriber, which must be
            positively acknowledged by some manner.  Setting this flag to True
            automatically confirms the unsubscription request.  (A confirmation
            message may still be sent under other conditions.)
        :type pre_confirmed: bool
        :param pre_approved: A flag indicating whether, when required by the
            unsubscription policy, an unsubscription request should be
            considered pre-approved.  Normally in such cases, the list
            administrator is notified that an approval is necessary, which
            must be positively acknowledged in some manner.  Setting this flag
            to True automatically approves the unsubscription request.
        :type pre_approved: bool
        """
        UnsubscriptionBase.__init__(self, mlist, subscriber)
        ConfirmationMixin.__init__(self, pre_confirmed=pre_confirmed)
        ModerationMixin.__init__(self, pre_approved=pre_approved)

    def _step_prepare(self):
        self.push('do_unsubscription')
        self.push('moderation_checks')
        self.push('confirmation_checks')
        self.push('subscription_checks')