# copyright 2003-2012 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/>.

"""functional tests for server'security"""

from __future__ import with_statement

import sys

from logilab.common.testlib import unittest_main, TestCase

from rql import RQLException

from cubicweb.devtools.testlib import CubicWebTC

from cubicweb import Unauthorized, ValidationError, QueryError

from cubicweb.schema import ERQLExpression

from cubicweb.server.querier import check_read_access

class BaseSecurityTC(CubicWebTC):

    def setup_database(self):

        super(BaseSecurityTC, self).setup_database()

        self.create_user(self.request(), 'iaminusersgrouponly')

class LowLevelSecurityFunctionTC(BaseSecurityTC):

    def test_check_read_access(self):

        rql = u'Personne U where U nom "managers"'

        rqlst = self.repo.vreg.rqlhelper.parse(rql).children[0]

        with self.temporary_permissions(Personne={'read': ('users', 'managers')}):

            self.repo.vreg.solutions(self.session, rqlst, None)

            solution = rqlst.solutions[0]

            check_read_access(self.session, rqlst, solution, {})

            with self.login('anon') as cu:

                self.assertRaises(Unauthorized,

                                  check_read_access,

                                  self.session, rqlst, solution, {})

                self.assertRaises(Unauthorized, cu.execute, rql)

    def test_upassword_not_selectable(self):

        self.assertRaises(Unauthorized,

                          self.execute, 'Any X,P WHERE X is CWUser, X upassword P')

        self.rollback()

        with self.login('iaminusersgrouponly') as cu:

            self.assertRaises(Unauthorized,

                              cu.execute, 'Any X,P WHERE X is CWUser, X upassword P')

class SecurityRewritingTC(BaseSecurityTC):

    def hijack_source_execute(self):

        def syntax_tree_search(*args, **kwargs):

            self.query = (args, kwargs)

            return []

        self.repo.system_source.syntax_tree_search = syntax_tree_search

    def tearDown(self):

        self.repo.system_source.__dict__.pop('syntax_tree_search', None)

        super(SecurityRewritingTC, self).tearDown()

    def test_not_relation_read_security(self):

        with self.login('iaminusersgrouponly'):

            self.hijack_source_execute()

            self.execute('Any U WHERE NOT A todo_by U, A is Affaire')

            self.assertEqual(self.query[0][1].as_string(),

                              'Any U WHERE NOT EXISTS(A todo_by U), A is Affaire')

            self.execute('Any U WHERE NOT EXISTS(A todo_by U), A is Affaire')

            self.assertEqual(self.query[0][1].as_string(),

                              'Any U WHERE NOT EXISTS(A todo_by U), A is Affaire')

class SecurityTC(BaseSecurityTC):

    def setUp(self):

        BaseSecurityTC.setUp(self)

        # implicitly test manager can add some entities

        self.execute("INSERT Affaire X: X sujet 'cool'")

        self.execute("INSERT Societe X: X nom 'logilab'")

        self.execute("INSERT Personne X: X nom 'bidule'")

        self.execute('INSERT CWGroup X: X name "staff"')

        self.commit()

    def test_insert_security(self):

        with self.login('anon') as cu:

            cu.execute("INSERT Personne X: X nom 'bidule'")

            self.assertRaises(Unauthorized, self.commit)

            self.assertEqual(cu.execute('Personne X').rowcount, 1)

    def test_insert_rql_permission(self):

        # test user can only add une affaire related to a societe he owns

        with self.login('iaminusersgrouponly') as cu:

            cu.execute("INSERT Affaire X: X sujet 'cool'")

            self.assertRaises(Unauthorized, self.commit)

        # test nothing has actually been inserted

        self.assertEqual(self.execute('Affaire X').rowcount, 1)

        with self.login('iaminusersgrouponly') as cu:

            cu.execute("INSERT Affaire X: X sujet 'cool'")

            cu.execute("INSERT Societe X: X nom 'chouette'")

            cu.execute("SET A concerne S WHERE A sujet 'cool', S nom 'chouette'")

            self.commit()

    def test_update_security_1(self):

        with self.login('anon') as cu:

            # local security check

            cu.execute( "SET X nom 'bidulechouette' WHERE X is Personne")

            self.assertRaises(Unauthorized, self.commit)

        self.assertEqual(self.execute('Personne X WHERE X nom "bidulechouette"').rowcount, 0)

    def test_update_security_2(self):

        with self.temporary_permissions(Personne={'read': ('users', 'managers'),

                                                  'add': ('guests', 'users', 'managers')}):

            with self.login('anon') as cu:

                self.assertRaises(Unauthorized, cu.execute, "SET X nom 'bidulechouette' WHERE X is Personne")

                self.rollback()

                # self.assertRaises(Unauthorized, cnx.commit)

        # test nothing has actually been inserted

        self.assertEqual(self.execute('Personne X WHERE X nom "bidulechouette"').rowcount, 0)

    def test_update_security_3(self):

        with self.login('iaminusersgrouponly') as cu:

            cu.execute("INSERT Personne X: X nom 'biduuule'")

            cu.execute("INSERT Societe X: X nom 'looogilab'")

            cu.execute("SET X travaille S WHERE X nom 'biduuule', S nom 'looogilab'")

    def test_update_rql_permission(self):

        self.execute("SET A concerne S WHERE A is Affaire, S is Societe")

        self.commit()

        # test user can only update une affaire related to a societe he owns

        with self.login('iaminusersgrouponly') as cu:

            cu.execute("SET X sujet 'pascool' WHERE X is Affaire")

            # this won't actually do anything since the selection query won't return anything

            self.commit()

            # to actually get Unauthorized exception, try to update an entity we can read

            cu.execute("SET X nom 'toto' WHERE X is Societe")

            self.assertRaises(Unauthorized, self.commit)

            cu.execute("INSERT Affaire X: X sujet 'pascool'")

            cu.execute("INSERT Societe X: X nom 'chouette'")

            cu.execute("SET A concerne S WHERE A sujet 'pascool', S nom 'chouette'")

            cu.execute("SET X sujet 'habahsicestcool' WHERE X sujet 'pascool'")

            self.commit()

    def test_delete_security(self):

        # FIXME: sample below fails because we don't detect "owner" can't delete

        # user anyway, and since no user with login == 'bidule' exists, no

        # exception is raised

        #user._groups = {'guests':1}

        #self.assertRaises(Unauthorized,

        #                  self.o.execute, user, "DELETE CWUser X WHERE X login 'bidule'")

        # check local security

        with self.login('iaminusersgrouponly') as cu:

            self.assertRaises(Unauthorized, cu.execute, "DELETE CWGroup Y WHERE Y name 'staff'")

            self.rollback()

    def test_delete_rql_permission(self):

        self.execute("SET A concerne S WHERE A is Affaire, S is Societe")

        self.commit()

        # test user can only dele une affaire related to a societe he owns

        with self.login('iaminusersgrouponly') as cu:

            # this won't actually do anything since the selection query won't return anything

            cu.execute("DELETE Affaire X")

            self.commit()

            # to actually get Unauthorized exception, try to delete an entity we can read

            self.assertRaises(Unauthorized, cu.execute, "DELETE Societe S")

            self.assertRaises(QueryError, self.commit) # can't commit anymore

            self.rollback() # required after Unauthorized

            cu.execute("INSERT Affaire X: X sujet 'pascool'")

            cu.execute("INSERT Societe X: X nom 'chouette'")

            cu.execute("SET A concerne S WHERE A sujet 'pascool', S nom 'chouette'")

            self.commit()

##         # this one should fail since it will try to delete two affaires, one authorized

##         # and the other not

##         self.assertRaises(Unauthorized, cu.execute, "DELETE Affaire X")

            cu.execute("DELETE Affaire X WHERE X sujet 'pascool'")

            self.commit()

    def test_insert_relation_rql_permission(self):

        with self.login('iaminusersgrouponly') as cu:

            cu.execute("SET A concerne S WHERE A is Affaire, S is Societe")

            # should raise Unauthorized since user don't own S though this won't

            # actually do anything since the selection query won't return

            # anything

            self.commit()

            # to actually get Unauthorized exception, try to insert a relation

            # were we can read both entities

            rset = cu.execute('Personne P')

            self.assertEqual(len(rset), 1)

            ent = rset.get_entity(0, 0)

            self.assertFalse(cu.execute('Any P,S WHERE P travaille S,P is Personne, S is Societe'))

            self.assertRaises(Unauthorized, ent.cw_check_perm, 'update')

            self.assertRaises(Unauthorized,

                              cu.execute, "SET P travaille S WHERE P is Personne, S is Societe")

            self.assertRaises(QueryError, self.commit) # can't commit anymore

            self.rollback()

            # test nothing has actually been inserted:

            self.assertFalse(cu.execute('Any P,S WHERE P travaille S,P is Personne, S is Societe'))

            cu.execute("INSERT Societe X: X nom 'chouette'")

            cu.execute("SET A concerne S WHERE A is Affaire, S nom 'chouette'")

            self.commit()

    def test_delete_relation_rql_permission(self):

        self.execute("SET A concerne S WHERE A is Affaire, S is Societe")

        self.commit()

        with self.login('iaminusersgrouponly') as cu:

            # this won't actually do anything since the selection query won't return anything

            cu.execute("DELETE A concerne S")

            self.commit()

        # to actually get Unauthorized exception, try to delete a relation we can read

        eid = self.execute("INSERT Affaire X: X sujet 'pascool'")[0][0]

        self.execute('SET X owned_by U WHERE X eid %(x)s, U login "iaminusersgrouponly"', {'x': eid})

        self.execute("SET A concerne S WHERE A sujet 'pascool', S is Societe")

        self.commit()

        with self.login('iaminusersgrouponly') as cu:

            self.assertRaises(Unauthorized, cu.execute, "DELETE A concerne S")

            self.assertRaises(QueryError, self.commit) # can't commit anymore

            self.rollback() # required after Unauthorized

            cu.execute("INSERT Societe X: X nom 'chouette'")

            cu.execute("SET A concerne S WHERE A is Affaire, S nom 'chouette'")

            self.commit()

            cu.execute("DELETE A concerne S WHERE S nom 'chouette'")

            self.commit()

    def test_user_can_change_its_upassword(self):

        req = self.request()

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

        with self.login('user') as cu:

            cu.execute('SET X upassword %(passwd)s WHERE X eid %(x)s',

                       {'x': ueid, 'passwd': 'newpwd'})

            self.commit()

        cnx = self.login('user', password='newpwd')

        cnx.close()

    def test_user_cant_change_other_upassword(self):

        req = self.request()

        ueid = self.create_user(req, 'otheruser').eid

        with self.login('iaminusersgrouponly') as cu:

            cu.execute('SET X upassword %(passwd)s WHERE X eid %(x)s',

                       {'x': ueid, 'passwd': 'newpwd'})

            self.assertRaises(Unauthorized, self.commit)

    # read security test

    def test_read_base(self):

        with self.temporary_permissions(Personne={'read': ('users', 'managers')}):

            with self.login('anon') as cu:

                self.assertRaises(Unauthorized,

                                  cu.execute, 'Personne U where U nom "managers"')

                self.rollback()

    def test_read_erqlexpr_base(self):

        eid = self.execute("INSERT Affaire X: X sujet 'cool'")[0][0]

        self.commit()

        with self.login('iaminusersgrouponly') as cu:

            rset = cu.execute('Affaire X')

            self.assertEqual(rset.rows, [])

            self.assertRaises(Unauthorized, cu.execute, 'Any X WHERE X eid %(x)s', {'x': eid})

            # cache test

            self.assertRaises(Unauthorized, cu.execute, 'Any X WHERE X eid %(x)s', {'x': eid})

            aff2 = cu.execute("INSERT Affaire X: X sujet 'cool'")[0][0]

            soc1 = cu.execute("INSERT Societe X: X nom 'chouette'")[0][0]

            cu.execute("SET A concerne S WHERE A is Affaire, S is Societe")

            self.commit()

            rset = cu.execute('Any X WHERE X eid %(x)s', {'x': aff2})

            self.assertEqual(rset.rows, [[aff2]])

            # more cache test w/ NOT eid

            rset = cu.execute('Affaire X WHERE NOT X eid %(x)s', {'x': eid})

            self.assertEqual(rset.rows, [[aff2]])

            rset = cu.execute('Affaire X WHERE NOT X eid %(x)s', {'x': aff2})

            self.assertEqual(rset.rows, [])

            # test can't update an attribute of an entity that can't be readen

            self.assertRaises(Unauthorized, cu.execute, 'SET X sujet "hacked" WHERE X eid %(x)s', {'x': eid})

            self.rollback()

    def test_entity_created_in_transaction(self):

        affschema = self.schema['Affaire']

        with self.temporary_permissions(Affaire={'read': affschema.permissions['add']}):

            with self.login('iaminusersgrouponly') as cu:

                aff2 = cu.execute("INSERT Affaire X: X sujet 'cool'")[0][0]

                # entity created in transaction are readable *by eid*

                self.assertTrue(cu.execute('Any X WHERE X eid %(x)s', {'x':aff2}))

                # XXX would be nice if it worked

                rset = cu.execute("Affaire X WHERE X sujet 'cool'")

                self.assertEqual(len(rset), 0)

                self.assertRaises(Unauthorized, self.commit)

    def test_read_erqlexpr_has_text1(self):

        aff1 = self.execute("INSERT Affaire X: X sujet 'cool'")[0][0]

        card1 = self.execute("INSERT Card X: X title 'cool'")[0][0]

        self.execute('SET X owned_by U WHERE X eid %(x)s, U login "iaminusersgrouponly"', {'x': card1})

        self.commit()

        with self.login('iaminusersgrouponly') as cu:

            aff2 = cu.execute("INSERT Affaire X: X sujet 'cool'")[0][0]

            soc1 = cu.execute("INSERT Societe X: X nom 'chouette'")[0][0]

            cu.execute("SET A concerne S WHERE A eid %(a)s, S eid %(s)s", {'a': aff2, 's': soc1})

            self.commit()

            self.assertRaises(Unauthorized, cu.execute, 'Any X WHERE X eid %(x)s', {'x':aff1})

            self.assertTrue(cu.execute('Any X WHERE X eid %(x)s', {'x':aff2}))

            self.assertTrue(cu.execute('Any X WHERE X eid %(x)s', {'x':card1}))

            rset = cu.execute("Any X WHERE X has_text 'cool'")

            self.assertEqual(sorted(eid for eid, in rset.rows),

                              [card1, aff2])

            self.rollback()

    def test_read_erqlexpr_has_text2(self):

        self.execute("INSERT Personne X: X nom 'bidule'")

        self.execute("INSERT Societe X: X nom 'bidule'")

        self.commit()

        with self.temporary_permissions(Personne={'read': ('managers',)}):

            with self.login('iaminusersgrouponly') as cu:

                rset = cu.execute('Any N WHERE N has_text "bidule"')

                self.assertEqual(len(rset.rows), 1, rset.rows)

                rset = cu.execute('Any N WITH N BEING (Any N WHERE N has_text "bidule")')

                self.assertEqual(len(rset.rows), 1, rset.rows)

    def test_read_erqlexpr_optional_rel(self):

        self.execute("INSERT Personne X: X nom 'bidule'")

        self.execute("INSERT Societe X: X nom 'bidule'")

        self.commit()

        with self.temporary_permissions(Personne={'read': ('managers',)}):

            with self.login('anon') as cu:

                rset = cu.execute('Any N,U WHERE N has_text "bidule", N owned_by U?')

                self.assertEqual(len(rset.rows), 1, rset.rows)

    def test_read_erqlexpr_aggregat(self):

        self.execute("INSERT Affaire X: X sujet 'cool'")[0][0]

        self.commit()

        with self.login('iaminusersgrouponly') as cu:

            rset = cu.execute('Any COUNT(X) WHERE X is Affaire')

            self.assertEqual(rset.rows, [[0]])

            aff2 = cu.execute("INSERT Affaire X: X sujet 'cool'")[0][0]

            soc1 = cu.execute("INSERT Societe X: X nom 'chouette'")[0][0]

            cu.execute("SET A concerne S WHERE A is Affaire, S is Societe")

            self.commit()

            rset = cu.execute('Any COUNT(X) WHERE X is Affaire')

            self.assertEqual(rset.rows, [[1]])

            rset = cu.execute('Any ETN, COUNT(X) GROUPBY ETN WHERE X is ET, ET name ETN')

            values = dict(rset)

            self.assertEqual(values['Affaire'], 1)

            self.assertEqual(values['Societe'], 2)

            rset = cu.execute('Any ETN, COUNT(X) GROUPBY ETN WHERE X is ET, ET name ETN WITH X BEING ((Affaire X) UNION (Societe X))')

            self.assertEqual(len(rset), 2)

            values = dict(rset)