# copyright 2003-2013 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

#

# This file is part of CubicWeb.

#

# CubicWeb is free software: you can redistribute it and/or modify it under the

# terms of the GNU Lesser General Public License as published by the Free

# Software Foundation, either version 2.1 of the License, or (at your option)

# any later version.

#

# CubicWeb 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 Lesser General Public License for more

# details.

#

# You should have received a copy of the GNU Lesser General Public License along

# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""cubicweb.web.views.basecontrollers unit tests"""

from urlparse import urlsplit, urlunsplit, urljoin

# parse_qs is deprecated in cgi and has been moved to urlparse in Python 2.6

try:

    from urlparse import parse_qs as url_parse_query

except ImportError:

    from cgi import parse_qs as url_parse_query

from logilab.common.testlib import unittest_main, mock_object

from logilab.common.decorators import monkeypatch

from cubicweb import Binary, NoSelectableObject, ValidationError

from cubicweb.view import STRICT_DOCTYPE

from cubicweb.devtools.testlib import CubicWebTC

from cubicweb.utils import json_dumps

from cubicweb.uilib import rql_for_eid

from cubicweb.web import INTERNAL_FIELD_VALUE, Redirect, RequestError, RemoteCallFailed

import cubicweb.server.session

from cubicweb.server.session import Connection as OldConnection

from cubicweb.entities.authobjs import CWUser

from cubicweb.web.views.autoform import get_pending_inserts, get_pending_deletes

from cubicweb.web.views.basecontrollers import JSonController, xhtmlize, jsonize

from cubicweb.web.views.ajaxcontroller import ajaxfunc, AjaxFunction

import cubicweb.transaction as tx

from cubicweb.server.hook import Hook, Operation

from cubicweb.predicates import is_instance

u = unicode

def req_form(user):

    return {'eid': [str(user.eid)],

            '_cw_entity_fields:%s' % user.eid: '_cw_generic_field',

            '__type:%s' % user.eid: user.__regid__

            }

class EditControllerTC(CubicWebTC):

    def setUp(self):

        CubicWebTC.setUp(self)

    def tearDown(self):

        CubicWebTC.tearDown(self)

    def test_noparam_edit(self):

        """check behaviour of this controller without any form parameter

        """

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(self.request())

        self.assertEqual(cm.exception.errors, {None: u'no selected entities'})

    def test_validation_unique(self):

        """test creation of two linked entities

        """

        user = self.user()

        req = self.request()

        req.form = {'eid': 'X', '__type:X': 'CWUser',

                    '_cw_entity_fields:X': 'login-subject,upassword-subject',

                    'login-subject:X': u'admin',

                    'upassword-subject:X': u'toto',

                    'upassword-subject-confirm:X': u'toto',

                    }

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(req)

        cm.exception.translate(unicode)

        self.assertEqual(cm.exception.errors, {'login-subject': 'the value "admin" is already used, use another one'})

    def test_user_editing_itself(self):

        """checking that a manager user can edit itself

        """

        user = self.user()

        basegroups = [u(eid) for eid, in self.execute('CWGroup G WHERE X in_group G, X eid %(x)s', {'x': user.eid})]

        groupeids = [eid for eid, in self.execute('CWGroup G WHERE G name in ("managers", "users")')]

        groups = [u(eid) for eid in groupeids]

        req = self.request()

        eid = u(user.eid)

        req.form = {

            'eid': eid, '__type:'+eid: 'CWUser',

            '_cw_entity_fields:'+eid: 'login-subject,firstname-subject,surname-subject,in_group-subject',

            'login-subject:'+eid:     u(user.login),

            'surname-subject:'+eid: u'Th\xe9nault',

            'firstname-subject:'+eid:   u'Sylvain',

            'in_group-subject:'+eid:  groups,

            }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        e = self.execute('Any X WHERE X eid %(x)s', {'x': user.eid}).get_entity(0, 0)

        self.assertEqual(e.firstname, u'Sylvain')

        self.assertEqual(e.surname, u'Th\xe9nault')

        self.assertEqual(e.login, user.login)

        self.assertEqual([g.eid for g in e.in_group], groupeids)

    def test_user_can_change_its_password(self):

        req = self.request()

        user = self.create_user(req, 'user')

        cnx = self.login('user')

        eid = u(user.eid)

        req.form = {

            'eid': eid, '__maineid' : eid,

            '__type:'+eid: 'CWUser',

            '_cw_entity_fields:'+eid: 'upassword-subject',

            'upassword-subject:'+eid: 'tournicoton',

            'upassword-subject-confirm:'+eid: 'tournicoton',

            }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        cnx.commit() # commit to check we don't get late validation error for instance

        self.assertEqual(path, 'cwuser/user')

        self.assertFalse('vid' in params)

    def test_user_editing_itself_no_relation(self):

        """checking we can edit an entity without specifying some required

        relations (meaning no changes)

        """

        user = self.user()

        groupeids = [g.eid for g in user.in_group]

        req = self.request()

        eid = u(user.eid)

        req.form = {

            'eid':       eid,

            '__type:'+eid:    'CWUser',

            '_cw_entity_fields:'+eid: 'login-subject,firstname-subject,surname-subject',

            'login-subject:'+eid:     u(user.login),

            'firstname-subject:'+eid: u'Th\xe9nault',

            'surname-subject:'+eid:   u'Sylvain',

            }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        e = self.execute('Any X WHERE X eid %(x)s', {'x': user.eid}).get_entity(0, 0)

        self.assertEqual(e.login, user.login)

        self.assertEqual(e.firstname, u'Th\xe9nault')

        self.assertEqual(e.surname, u'Sylvain')

        self.assertEqual([g.eid for g in e.in_group], groupeids)

        self.assertEqual(e.cw_adapt_to('IWorkflowable').state, 'activated')

    def test_create_multiple_linked(self):

        gueid = self.execute('CWGroup G WHERE G name "users"')[0][0]

        req = self.request()

        req.form = {'eid': ['X', 'Y'], '__maineid' : 'X',

                    '__type:X': 'CWUser',

                    '_cw_entity_fields:X': 'login-subject,upassword-subject,surname-subject,in_group-subject',

                    'login-subject:X': u'adim',

                    'upassword-subject:X': u'toto', 'upassword-subject-confirm:X': u'toto',

                    'surname-subject:X': u'Di Mascio',

                    'in_group-subject:X': u(gueid),

                    '__type:Y': 'EmailAddress',

                    '_cw_entity_fields:Y': 'address-subject,use_email-object',

                    'address-subject:Y': u'dima@logilab.fr',

                    'use_email-object:Y': 'X',

                    }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        # should be redirected on the created person

        self.assertEqual(path, 'cwuser/adim')

        e = self.execute('Any P WHERE P surname "Di Mascio"').get_entity(0, 0)

        self.assertEqual(e.surname, 'Di Mascio')

        email = e.use_email[0]

        self.assertEqual(email.address, 'dima@logilab.fr')

    def test_create_mandatory_inlined(self):

        req = self.request()

        req.form = {'eid': ['X', 'Y'], '__maineid' : 'X',

                    '__type:X': 'Salesterm',

                    '_cw_entity_fields:X': '',

                    '__type:Y': 'File',

                    '_cw_entity_fields:Y': 'data-subject,described_by_test-object',

                    'data-subject:Y': (u'coucou.txt', Binary('coucou')),

                    'described_by_test-object:Y': 'X',

                    }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        self.assertTrue(path.startswith('salesterm/'), path)

        eid = path.split('/')[1]

        salesterm = req.entity_from_eid(eid)

        # The NOT NULL constraint of mandatory relation implies that the File

        # must be created before the Salesterm, otherwise Salesterm insertion

        # will fail.

        # NOTE: sqlite does have NOT NULL constraint, unlike Postgres so the

        # insertion does not fail and we have to check dumbly that File is

        # created before.

        self.assertGreater(salesterm.eid, salesterm.described_by_test[0].eid)

    def test_create_mandatory_inlined2(self):

        req = self.request()

        req.form = {'eid': ['X', 'Y'], '__maineid' : 'X',

                    '__type:X': 'Salesterm',

                    '_cw_entity_fields:X': 'described_by_test-subject',

                    'described_by_test-subject:X': 'Y',

                    '__type:Y': 'File',

                    '_cw_entity_fields:Y': 'data-subject',

                    'data-subject:Y': (u'coucou.txt', Binary('coucou')),

                    }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        self.assertTrue(path.startswith('salesterm/'), path)

        eid = path.split('/')[1]

        salesterm = req.entity_from_eid(eid)

        # The NOT NULL constraint of mandatory relation implies that the File

        # must be created before the Salesterm, otherwise Salesterm insertion

        # will fail.

        # NOTE: sqlite does have NOT NULL constraint, unlike Postgres so the

        # insertion does not fail and we have to check dumbly that File is

        # created before.

        self.assertGreater(salesterm.eid, salesterm.described_by_test[0].eid)

    def test_edit_mandatory_inlined3_object(self):

        # non regression test for #3120495. Without the fix, leads to

        # "unhashable type: 'list'" error

        req = self.request()

        cwrelation = u(req.execute('CWEType X WHERE X name "CWSource"')[0][0])

        req.form = {'eid': [cwrelation], '__maineid' : cwrelation,

                    '__type:'+cwrelation: 'CWEType',

                    '_cw_entity_fields:'+cwrelation: 'to_entity-object',

                    'to_entity-object:'+cwrelation: [9999, 9998],

                    }

        with self.session.deny_all_hooks_but():

            path, params = self.expect_redirect_handle_request(req, 'edit')

        self.assertTrue(path.startswith('cwetype/CWSource'), path)

    def test_edit_multiple_linked(self):

        req = self.request()

        peid = u(self.create_user(req, 'adim').eid)

        req.form = {'eid': [peid, 'Y'], '__maineid': peid,

                    '__type:'+peid: u'CWUser',

                    '_cw_entity_fields:'+peid: u'surname-subject',

                    'surname-subject:'+peid: u'Di Masci',

                    '__type:Y': u'EmailAddress',

                    '_cw_entity_fields:Y': u'address-subject,use_email-object',

                    'address-subject:Y': u'dima@logilab.fr',

                    'use_email-object:Y': peid,

                    }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        # should be redirected on the created person

        self.assertEqual(path, 'cwuser/adim')

        e = self.execute('Any P WHERE P surname "Di Masci"').get_entity(0, 0)

        email = e.use_email[0]

        self.assertEqual(email.address, 'dima@logilab.fr')

        emaileid = u(email.eid)

        req = self.request()

        req.form = {'eid': [peid, emaileid],

                    '__type:'+peid: u'CWUser',

                    '_cw_entity_fields:'+peid: u'surname-subject',

                    'surname-subject:'+peid: u'Di Masci',

                    '__type:'+emaileid: u'EmailAddress',

                    '_cw_entity_fields:'+emaileid: u'address-subject,use_email-object',

                    'address-subject:'+emaileid: u'adim@logilab.fr',

                    'use_email-object:'+emaileid: peid,

                    }

        path, params = self.expect_redirect_handle_request(req, 'edit')

        email.cw_clear_all_caches()

        self.assertEqual(email.address, 'adim@logilab.fr')

    def test_password_confirm(self):

        """test creation of two linked entities

        """

        user = self.user()

        req = self.request()

        req.form = {'eid': 'X',

                    '__cloned_eid:X': u(user.eid), '__type:X': 'CWUser',

                    '_cw_entity_fields:X': 'login-subject,upassword-subject',

                    'login-subject:X': u'toto',

                    'upassword-subject:X': u'toto',

                    }

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(req)

        self.assertEqual(cm.exception.errors, {'upassword-subject': u'password and confirmation don\'t match'})

        req = self.request()

        req.form = {'__cloned_eid:X': u(user.eid),

                    'eid': 'X', '__type:X': 'CWUser',

                    '_cw_entity_fields:X': 'login-subject,upassword-subject',

                    'login-subject:X': u'toto',

                    'upassword-subject:X': u'toto',

                    'upassword-subject-confirm:X': u'tutu',

                    }

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(req)

        self.assertEqual(cm.exception.errors, {'upassword-subject': u'password and confirmation don\'t match'})

    def test_interval_bound_constraint_success(self):

        feid = self.execute('INSERT File X: X data_name "toto.txt", X data %(data)s',

                            {'data': Binary('yo')})[0][0]

        self.commit()

        req = self.request(rollbackfirst=True)

        req.form = {'eid': ['X'],

                    '__type:X': 'Salesterm',

                    '_cw_entity_fields:X': 'amount-subject,described_by_test-subject',

                    'amount-subject:X': u'-10',

                    'described_by_test-subject:X': u(feid),

                }

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(req)

        cm.exception.translate(unicode)

        self.assertEqual(cm.exception.errors, {'amount-subject': 'value -10 must be >= 0'})

        req = self.request(rollbackfirst=True)

        req.form = {'eid': ['X'],

                    '__type:X': 'Salesterm',

                    '_cw_entity_fields:X': 'amount-subject,described_by_test-subject',

                    'amount-subject:X': u'110',

                    'described_by_test-subject:X': u(feid),

                    }

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(req)

        cm.exception.translate(unicode)

        self.assertEqual(cm.exception.errors, {'amount-subject': 'value 110 must be <= 100'})

        req = self.request(rollbackfirst=True)

        req.form = {'eid': ['X'],

                    '__type:X': 'Salesterm',

                    '_cw_entity_fields:X': 'amount-subject,described_by_test-subject',

                    'amount-subject:X': u'10',

                    'described_by_test-subject:X': u(feid),

                    }

        self.expect_redirect_handle_request(req, 'edit')

        # should be redirected on the created

        #eid = params['rql'].split()[-1]

        e = self.execute('Salesterm X').get_entity(0, 0)

        self.assertEqual(e.amount, 10)

    def test_interval_bound_constraint_validateform(self):

        """Test the FormValidatorController controller on entity with

        constrained attributes"""

        feid = self.execute('INSERT File X: X data_name "toto.txt", X data %(data)s',

                            {'data': Binary('yo')})[0][0]

        seid = self.request().create_entity('Salesterm', amount=0, described_by_test=feid).eid

        self.commit()

        # ensure a value that violate a constraint is properly detected

        req = self.request(rollbackfirst=True)