# Copyright (C) 2009-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/>.

"""Example plugin with hooks and REST for testing purposes."""

from mailman.config import config
from mailman.interfaces.plugin import IPlugin
from mailman.rest.helpers import bad_request, child, etag, no_content, okay
from mailman.rest.validator import Validator
from public import public
from zope.interface import implementer


@public
class GoodREST:

    def on_get(self, request, response):
        okay(response, etag({'good': True}))


@public
class BadREST:

    def on_get(self, request, response):
        bad_request(response, etag({'good': False}))


@public
class CountingREST:

    def __init__(self):
        self._plugin = config.plugins['example']

    def on_get(self, request, response):
        okay(response, etag({'count': self._plugin.counter}))

    def on_post(self, request, response):
        try:
            counter = Validator(count=int)(request)
            self._plugin.counter = counter['count']
        except ValueError as error:
            bad_request(response, str(error))
        else:
            no_content(response)

    def on_delete(self, request, response):
        self._plugin.counter = 0
        no_content(response)


@public
class RESTExample:

    def on_get(self, request, response):
        okay(response, etag({'example-plugin-reply': 'yes'}))

    def on_post(self, request, response):
        bad_request(response)

    @child()
    def good(self, context, segments):
        return GoodREST(), []

    @child()
    def bad(self, context, segments):
        return BadREST(), []

    @child()
    def count(self, context, segments):
        return CountingREST(), []


@public
@implementer(IPlugin)
class ExamplePlugin:

    def __init__(self):
        self.counter = 0

    def pre_hook(self):
        pass

    def post_hook(self):
        pass

    def rest_object(self):
        return RESTExample()