# 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 __future__ import with_statement

from logilab.common.testlib import unittest_main, mock_object

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

from cubicweb.entities.authobjs import CWUser

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

u = unicode

def req_form(user):

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

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

            }

class EditControllerTC(CubicWebTC):

    def setUp(self):

        CubicWebTC.setUp(self)

        self.failUnless('users' in self.schema.eschema('CWGroup').get_groups('read'))

    def tearDown(self):

        CubicWebTC.tearDown(self)

        self.failUnless('users' in self.schema.eschema('CWGroup').get_groups('read'))

    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',

                    '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)

        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',

            '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_publish(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',

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

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

            }

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

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

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

        self.failIf('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',

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

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

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

            }

        path, params = self.expect_redirect_publish(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',

                    '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',

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

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

                    }

        path, params = self.expect_redirect_publish(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_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',

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

                    '__type:Y': u'EmailAddress',

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

                    'use_email-object:Y': peid,

                    }

        path, params = self.expect_redirect_publish(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',

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

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

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

                    'use_email-object:'+emaileid: peid,

                    }

        path, params = self.expect_redirect_publish(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',

                    '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',

                    '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',

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

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

                }

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(req)

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

        req = self.request(rollbackfirst=True)

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

                    '__type:X': 'Salesterm',

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

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

                    }

        with self.assertRaises(ValidationError) as cm:

            self.ctrl_publish(req)

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

        req = self.request(rollbackfirst=True)

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

                    '__type:X': 'Salesterm',

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

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

                    }

        self.expect_redirect_publish(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_req_pending_insert(self):

        """make sure req's pending insertions are taken into account"""

        tmpgroup = self.request().create_entity('CWGroup', name=u"test")

        user = self.user()

        req = self.request(**req_form(user))

        req.session.data['pending_insert'] = set([(user.eid, 'in_group', tmpgroup.eid)])

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

        usergroups = [gname for gname, in

                      self.execute('Any N WHERE G name N, U in_group G, U eid %(u)s', {'u': user.eid})]

        self.assertItemsEqual(usergroups, ['managers', 'test'])

        self.assertEqual(get_pending_inserts(req), [])

    def test_req_pending_delete(self):

        """make sure req's pending deletions are taken into account"""

        user = self.user()

        groupeid = self.execute('INSERT CWGroup G: G name "test", U in_group G WHERE U eid %(x)s',

                                {'x': user.eid})[0][0]

        usergroups = [gname for gname, in

                      self.execute('Any N WHERE G name N, U in_group G, U eid %(u)s', {'u': user.eid})]

        # just make sure everything was set correctly

        self.assertItemsEqual(usergroups, ['managers', 'test'])

        # now try to delete the relation

        req = self.request(**req_form(user))

        req.session.data['pending_delete'] = set([(user.eid, 'in_group', groupeid)])

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

        usergroups = [gname for gname, in

                      self.execute('Any N WHERE G name N, U in_group G, U eid %(u)s', {'u': user.eid})]

        self.assertItemsEqual(usergroups, ['managers'])

        self.assertEqual(get_pending_deletes(req), [])

    def test_redirect_apply_button(self):

        redirectrql = rql_for_eid(4012) # whatever

        req = self.request()

        req.form = {

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

            'content-subject:A': u'"13:03:43"',

            'title-subject:A': u'huuu',

            '__redirectrql': redirectrql,

            '__redirectvid': 'primary',

            '__redirectparams': 'toto=tutu&tata=titi',

            '__form_id': 'edition',

            '__action_apply': '',

            }

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

        self.failUnless(path.startswith('blogentry/'))

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

        self.assertEqual(params['vid'], 'edition')

        self.assertNotEqual(int(eid), 4012)

        self.assertEqual(params['__redirectrql'], redirectrql)

        self.assertEqual(params['__redirectvid'], 'primary')

        self.assertEqual(params['__redirectparams'], 'toto=tutu&tata=titi')

    def test_redirect_ok_button(self):

        redirectrql = rql_for_eid(4012) # whatever

        req = self.request()

        req.form = {

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

            'content-subject:A': u'"13:03:43"',

            'title-subject:A': u'huuu',

            '__redirectrql': redirectrql,

            '__redirectvid': 'primary',

            '__redirectparams': 'toto=tutu&tata=titi',

            '__form_id': 'edition',

            }

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

        self.assertEqual(path, 'view')

        self.assertEqual(params['rql'], redirectrql)

        self.assertEqual(params['vid'], 'primary')

        self.assertEqual(params['tata'], 'titi')

        self.assertEqual(params['toto'], 'tutu')

    def test_redirect_delete_button(self):

        req = self.request()

        eid = req.create_entity('BlogEntry', title=u'hop', content=u'hop').eid

        req.form = {'eid': u(eid), '__type:%s'%eid: 'BlogEntry',

                    '__action_delete': ''}

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

        self.assertEqual(path, 'blogentry')