#
# This file is part of Checkbox.
#
# Copyright 2010 Canonical Ltd.
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.

#
# Checkbox 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 Checkbox.  If not, see <http://www.gnu.org/licenses/>.
#
from gettext import gettext as _

from checkbox.contrib.persist import Persist, MemoryBackend

from checkbox.plugin import Plugin
from checkbox.user_interface import NEXT, CONTINUE_ANSWER, \
                                    RERUN_ANSWER, RESTART_ANSWER

class RecoverPrompt(Plugin):

    @property
    def persist(self):
        if self._persist is None:
            self._persist = Persist(backend=MemoryBackend())

        return self._persist.root_at("recover_prompt")

    def register(self, manager):
        super(RecoverPrompt, self).register(manager)

        self._persist = None

        for (rt, rh) in [
             ("begin-persist", self.begin_persist),
             ("prompt-begin", self.prompt_begin),
             ("prompt-finish", self.prompt_finish)]:
            self._manager.reactor.call_on(rt, rh)

    def begin_persist(self, persist):
        self._persist = persist

    def prompt_begin(self, interface):
        if interface.direction == NEXT \
           and self.persist.get("recover", False):
            responses = [RESTART_ANSWER, CONTINUE_ANSWER, RERUN_ANSWER]
            #The actual responses and default need to be translated...
            translated_responses = [_(re) for re in responses]
            translated_default = _(RESTART_ANSWER)
            #Show_info will return a unicode version of the translated
            #response. We need to map that to one of our response 
            #constants, this dictionary helps with that:
            response_map = { _(response):response for response in responses} 
            response = interface.show_info(
                _("Checkbox did not finish completely.\n"
                  "Do you want to rerun the last test,\n"
                  "continue to the next test, or\n"
                  "restart from the beginning?"),
                translated_responses, translated_default)

            self._manager.reactor.fire("begin-recover", response_map[response])

        self.persist.set("recover", True)

    def prompt_finish(self, interface):
        if interface.direction == NEXT:
            self.persist.set("recover", False)


factory = RecoverPrompt
