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

:organization: Logilab

:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.

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

:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses

"""

import simplejson

from logilab.common.testlib import unittest_main, mock_object

from cubicweb.devtools.apptest import EnvBasedTC, ControllerTC

from cubicweb import Binary, NoSelectableObject, ValidationError

from cubicweb.view import STRICT_DOCTYPE

from cubicweb.common.uilib import rql_for_eid

from cubicweb.web import INTERNAL_FIELD_VALUE, Redirect, RequestError

from cubicweb.entities.authobjs import CWUser

class EditControllerTC(ControllerTC):

    def setUp(self):

        ControllerTC.setUp(self)

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

    def tearDown(self):

        ControllerTC.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

        """

        self.req.form = {}

        self.assertRaises(ValidationError, self.publish, self.req)

    def test_validation_unique(self):

        """test creation of two linked entities

        """

        user = self.user()

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

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

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

                         }

        self.assertRaises(ValidationError, self.publish, self.req)

    def test_user_editing_itself(self):

        """checking that a manager user can edit itself

        """

        user = self.user()

        basegroups = [str(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 = [str(eid) for eid in groupeids]

        stateeid = [eid for eid, in self.execute('State S WHERE S name "activated"')][0]

        self.req.form = {

            'eid':       `user.eid`,

            '__type:'+`user.eid`:    'CWUser',

            'login:'+`user.eid`:     unicode(user.login),

            'firstname:'+`user.eid`: u'Th\xe9nault',

            'surname:'+`user.eid`:   u'Sylvain',

            'in_group:'+`user.eid`:  groups,

            'in_state:'+`user.eid`:  `stateeid`,

            #

            'edits-login:'+`user.eid`:     unicode(user.login),

            'edits-firstname:'+`user.eid`: u'',

            'edits-surname:'+`user.eid`:   u'',

            'edits-in_group:'+`user.eid`:  basegroups,

            'edits-in_state:'+`user.eid`:  `stateeid`,

            }

        path, params = self.expect_redirect_publish()

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

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

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

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

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

        self.assertEquals(e.in_state[0].eid, stateeid)

    def test_user_can_change_its_password(self):

        user = self.create_user('user')

        cnx = self.login('user')

        req = self.request()

        #self.assertEquals(self.ctrl.schema['CWUser']._groups['read'],

        #                  ('managers', 'users'))

        req.form = {

            'eid': `user.eid`, '__type:'+`user.eid`: 'CWUser',

            '__maineid' : str(user.eid),

            'upassword:'+`user.eid`: 'tournicoton',

            'upassword-confirm:'+`user.eid`: 'tournicoton',

            'edits-upassword:'+`user.eid`:  '',

            }

        path, params = self.expect_redirect_publish(req)

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

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

        self.failIf('vid' in params)

    def testr_user_editing_itself_no_relation(self):

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

        relations (meaning no changes)

        """

        user = self.user()

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

        self.req.form = {

            'eid':       `user.eid`,

            '__type:'+`user.eid`:    'CWUser',

            'login:'+`user.eid`:     unicode(user.login),

            'firstname:'+`user.eid`: u'Th\xe9nault',

            'surname:'+`user.eid`:   u'Sylvain',

            #

            'edits-login:'+`user.eid`:     unicode(user.login),

            'edits-firstname:'+`user.eid`: u'',

            'edits-surname:'+`user.eid`:   u'',

            }

        path, params = self.expect_redirect_publish()

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

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

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

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

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

        stateeids = [eid for eid, in self.execute('State S WHERE S name "activated"')]

        self.assertEquals([s.eid for s in e.in_state], stateeids)

    def test_create_multiple_linked(self):

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

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

                         '__type:X': 'CWUser',

                         '__maineid' : 'X',

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

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

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

                         'in_group:X': `gueid`, 'edits-in_group:X': INTERNAL_FIELD_VALUE,

                         '__type:Y': 'EmailAddress',

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

                         'use_email:X': 'Y', 'edits-use_email:X': INTERNAL_FIELD_VALUE,

                         }

        path, params = self.expect_redirect_publish()

        # should be redirected on the created person

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

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

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

        email = e.use_email[0]

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

    def test_edit_multiple_linked(self):

        peid = self.create_user('adim').eid

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

                         '__type:%s'%peid: 'CWUser',

                         'surname:%s'%peid: u'Di Masci', 'edits-surname:%s'%peid: '',

                         '__type:Y': 'EmailAddress',

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

                         'use_email:%s'%peid: 'Y', 'edits-use_email:%s'%peid: INTERNAL_FIELD_VALUE,

                         '__redirectrql': 'Any X WHERE X eid %s'%peid,

                         }

        path, params = self.expect_redirect_publish()

        # should be redirected on the created person

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

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

        self.assertEquals(e.surname, 'Di Masci')

        email = e.use_email[0]

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

        emaileid = email.eid

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

                         '__type:%s'%peid: 'CWUser',

                         'surname:%s'%peid: u'Di Masci', 'edits-surname:%s'%peid: 'Di Masci',

                         '__type:%s'%emaileid: 'EmailAddress',

                         'address:%s'%emaileid: u'adim@logilab.fr', 'edits-address:%s'%emaileid: 'dima@logilab.fr',

                         'use_email:%s'%peid: `emaileid`, 'edits-use_email:%s'%peid: `emaileid`,

                         '__redirectrql': 'Any X WHERE X eid %s'%peid,

                         }

        path, params = self.expect_redirect_publish()

        # should be redirected on the created person

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

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

        self.assertEquals(e.surname, 'Di Masci')

        email = e.use_email[0]

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

    def test_password_confirm(self):

        """test creation of two linked entities

        """

        user = self.user()

        self.req.form = {'__cloned_eid:X': user.eid,

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

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

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

                         }

        self.assertRaises(ValidationError, self.publish, self.req)

        self.req.form = {'__cloned_eid:X': user.eid,

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

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

                         'upassword:X': u'toto', 'upassword-confirm:X': u'tutu', 'edits-upassword:X': u'',

                         }

        self.assertRaises(ValidationError, self.publish, self.req)

    def test_interval_bound_constraint_success(self):

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

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

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

                         '__type:X': 'Salesterm',

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

                         'described_by_test:X': str(feid), 'edits-described_by_test:X': INTERNAL_FIELD_VALUE,

                         }

        self.assertRaises(ValidationError, self.publish, self.req)

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

                         '__type:X': 'Salesterm',

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

                         'described_by_test:X': str(feid), 'edits-described_by_test:X': INTERNAL_FIELD_VALUE,

                         }

        self.assertRaises(ValidationError, self.publish, self.req)

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

                         '__type:X': 'Salesterm',

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

                         'described_by_test:X': str(feid), 'edits-described_by_test:X': INTERNAL_FIELD_VALUE,

                         }

        self.expect_redirect_publish()

        # should be redirected on the created

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

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

        self.assertEquals(e.amount, 10)

    def test_req_pending_insert(self):

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

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

        user = self.user()

        self.req.set_session_data('pending_insert', set([(user.eid, 'in_group', tmpgroup.eid)]))

        path, params = self.expect_redirect_publish()

        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.assertUnorderedIterableEquals(usergroups, ['managers', 'test'])

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

    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.assertUnorderedIterableEquals(usergroups, ['managers', 'test'])

        # now try to delete the relation

        self.req.set_session_data('pending_delete', set([(user.eid, 'in_group', groupeid)]))

        path, params = self.expect_redirect_publish()

        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.assertUnorderedIterableEquals(usergroups, ['managers'])

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

    def test_custom_attribute_handler(self):

        def custom_login_edit(self, formparams, value, relations):

            formparams['login'] = value.upper()

            relations.append('X login %(login)s')

        CWUser.custom_login_edit = custom_login_edit

        try:

            user = self.user()

            eid = repr(user.eid)

            self.req.form = {

                'eid': eid,

                '__type:'+eid:  'CWUser',

                'login:'+eid: u'foo',

                'edits-login:'+eid:  unicode(user.login),

                }

            path, params = self.expect_redirect_publish()

            rset = self.execute('Any L WHERE X eid %(x)s, X login L', {'x': user.eid}, 'x')

            self.assertEquals(rset[0][0], 'FOO')

        finally:

            del CWUser.custom_login_edit

    def test_redirect_apply_button(self):

        redirectrql = rql_for_eid(4012) # whatever

        self.req.form = {

                         'eid': 'A', '__type:A': 'BlogEntry',

                         '__maineid' : 'A',

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

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

                         '__redirectrql': redirectrql,

                         '__redirectvid': 'primary',

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

                         '__form_id': 'edition',

                         '__action_apply': '',

                         }

        path, params = self.expect_redirect_publish()

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

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

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

        self.assertNotEquals(int(eid), 4012)

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

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

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

    def test_redirect_ok_button(self):

        redirectrql = rql_for_eid(4012) # whatever

        self.req.form = {

                         'eid': 'A', '__type:A': 'BlogEntry',

                         '__maineid' : 'A',

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

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

                         '__redirectrql': redirectrql,

                         '__redirectvid': 'primary',

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

                         '__form_id': 'edition',

                         }

        path, params = self.expect_redirect_publish()

        self.assertEquals(path, 'view')

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

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

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

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

    def test_redirect_delete_button(self):

        eid = self.add_entity('BlogEntry', title=u'hop', content=u'hop').eid

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

                         '__action_delete': ''}

        path, params = self.expect_redirect_publish()

        self.assertEquals(path, 'blogentry')

        self.assertEquals(params, {u'__message': u'entity deleted'})

        eid = self.add_entity('EmailAddress', address=u'hop@logilab.fr').eid

        self.execute('SET X use_email E WHERE E eid %(e)s, X eid %(x)s',

                     {'x': self.session().user.eid, 'e': eid}, 'x')

        self.commit()

        self.req.form = {'eid': str(eid), '__type:%s'%eid: 'EmailAddress',

                         '__action_delete': ''}

        path, params = self.expect_redirect_publish()

        self.assertEquals(path, 'cwuser/admin')

        self.assertEquals(params, {u'__message': u'entity deleted'})

        eid1 = self.add_entity('BlogEntry', title=u'hop', content=u'hop').eid

        eid2 = self.add_entity('EmailAddress', address=u'hop@logilab.fr').eid

        self.req.form = {'eid': [str(eid1), str(eid2)],

                         '__type:%s'%eid1: 'BlogEntry',

                         '__type:%s'%eid2: 'EmailAddress',

                         '__action_delete': ''}