#!/usr/bin/python
# -*- coding: utf-8 -*-

# SAT: a jabber client
# Copyright (C) 2009, 2010, 2011, 2012, 2013  Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from sat.core.i18n import _
from sat.test import helpers
from twisted.trial import unittest
import traceback
from constants import Const
from xml.dom import minidom


class MemoryTest(unittest.TestCase):

    def setUp(self):
        self.host = helpers.FakeSAT()

    def _getParamXML(self, name=None, category=None, security_level=None):
        if not name:
            name = Const.ENABLE_UNIBOX_PARAM
        if not category:
            category = Const.ENABLE_UNIBOX_KEY
        return """
        <params>
        <individual>
        <category name="%(category_name)s" label="%(category_label)s">
            <param name="%(param_name)s" label="%(param_label)s" value="true" type="bool" %(security)s/>
         </category>
        </individual>
        </params>
        """ % {
            'category_name': category,
            'category_label': _(category),
            'param_name': name,
            'param_label': _(name),
            'security': '' if security_level is None else ('security="%d"' % security_level)
        }

    def _paramExists(self, name=None, category=None, src=None):
        """@return: True is the param (category, name) exists"""
        if not name:
            name = Const.ENABLE_UNIBOX_PARAM
        if not category:
            category = Const.ENABLE_UNIBOX_KEY
        if src is None:
            src = self.host.memory.params.dom.documentElement
        for type_node in src.childNodes:
            # when src comes self.host.memory.params.dom, we have here
            # some "individual" or "general" elements, when it comes
            # from Memory.getParams we have here a "params" elements
            if type_node.nodeName not in ("individual", "general", "params"):
                continue
            for cat_node in type_node.childNodes:
                if cat_node.nodeName != "category" or cat_node.getAttribute("name") != category:
                    continue
                for param in cat_node.childNodes:
                    if param.nodeName == "param" and param.getAttribute("name") == name:
                        return True
        return False

    def _assert(self, src, true=True):
        """@param src: a deferred result from Memory.getParams"""
        assertion = self._paramExists(src=minidom.parseString(src.encode("utf-8")))
        if not true:
            assertion = not assertion
        try:
            assert(assertion)
        except AssertionError as e:
            # in this stack we can see the line where the error came from,
            # if limit=5 is not enough you can increase the value
            print "---------------------- stack start ----------------------"
            traceback.print_stack(limit=5 if true else 6)
            print "----------------------- stack end -----------------------"
            raise e

    def _assert_not(self, src):
        """@param src: a deferred result from Memory.getParams"""
        self._assert(src, False)

    def _getParams(self, security_limit, app='', profile_key='@NONE@'):
        if profile_key == '@NONE@':
            profile_key = '@DEFAULT@'
        return self.host.memory.getParams(security_limit, app, profile_key)

    def test_updateParams(self):
        self.host.memory.init()
        # check if the update works
        self.host.memory.updateParams(self._getParamXML())
        assert(self._paramExists())
        previous = self.host.memory.params.dom.cloneNode(True)
        # now check if it is really updated and not duplicated
        self.host.memory.updateParams(self._getParamXML())
        self.assertEqual(previous.toxml().encode("utf-8"), self.host.memory.params.dom.toxml().encode("utf-8"))

    def test_getParams(self):
        # tests with no security level on the parameter (most secure)
        params = self._getParamXML()
        self.host.memory.init()
        self.host.memory.updateParams(params)
        self._getParams(Const.NO_SECURITY_LIMIT).addCallback(self._assert)
        self._getParams(0).addCallback(self._assert_not)
        self._getParams(1).addCallback(self._assert_not)
        # tests with security level 0 on the parameter (not secure)
        params = self._getParamXML(security_level=0)
        self.host.memory.init()
        self.host.memory.updateParams(params)
        self._getParams(Const.NO_SECURITY_LIMIT).addCallback(self._assert)
        self._getParams(0).addCallback(self._assert)
        self._getParams(1).addCallback(self._assert)
        # tests with security level 1 on the parameter (more secure)
        params = self._getParamXML(security_level=1)
        self.host.memory.init()
        self.host.memory.updateParams(params)
        self._getParams(Const.NO_SECURITY_LIMIT).addCallback(self._assert)
        self._getParams(0).addCallback(self._assert_not)
        self._getParams(1).addCallback(self._assert)

    def test_paramsRegisterApp(self):
        # tests with no security level on the parameter (most secure)
        params = self._getParamXML()
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, Const.NO_SECURITY_LIMIT, Const.APP_NAME)
        assert(self._paramExists())
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, 0, Const.APP_NAME)
        assert(not self._paramExists())
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, 1, Const.APP_NAME)
        assert(not self._paramExists())
        # tests with security level 0 on the parameter (not secure)
        params = self._getParamXML(security_level=0)
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, Const.NO_SECURITY_LIMIT, Const.APP_NAME)
        assert(self._paramExists())
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, 0, Const.APP_NAME)
        assert(self._paramExists())
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, 1, Const.APP_NAME)
        assert(self._paramExists())
        # tests with security level 1 on the parameter (more secure)
        params = self._getParamXML(security_level=1)
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, Const.NO_SECURITY_LIMIT, Const.APP_NAME)
        assert(self._paramExists())
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, 0, Const.APP_NAME)
        assert(not self._paramExists())
        self.host.memory.init()
        self.host.memory.paramsRegisterApp(params, 1, Const.APP_NAME)
        assert(self._paramExists())

    def test_paramsRegisterApp_getParams(self):
        # test retrieving the parameter for a specific frontend
        self.host.memory.init()
        params = self._getParamXML(security_level=1)
        self.host.memory.paramsRegisterApp(params, 1, Const.APP_NAME)
        self._getParams(1, '').addCallback(self._assert)
        self._getParams(1, Const.APP_NAME).addCallback(self._assert)
        self._getParams(1, 'another_dummy_frontend').addCallback(self._assert_not)