#! /usr/bin/env python
from __future__ import absolute_import
import datetime
import os
import sys
import unittest
import tempfile
import shutil
from subprocess import check_output, CalledProcessError
from irods import MAX_PASSWORD_LENGTH
from irods.exception import GroupDoesNotExist, UserDoesNotExist
from irods.meta import iRODSMetaCollection, iRODSMeta
from irods.models import User, Group, UserMeta, Quota
from irods.session import iRODSSession
import irods.exception as ex
import irods.test.helpers as helpers
from irods.user import iRODSUser, Bad_password_change_parameter
from six.moves import range

def user_quotas_implemented():
    return getattr(iRODSUser, "set_quota", None) is not None

def icommands_available():
    try:
        which_output = check_output(['which', 'ihelp'])
        return b'ihelp' in which_output
    except CalledProcessError:
        pass # 'which' returned nonzero status
    return False

def set_user_quota(session, user_name, bytes_total):
    success = False
    if user_quotas_implemented():
        try:
            session.users.set_quota(user_name, bytes_total)
            success = True
        except:
            pass
    if not success and icommands_available():
        return_code = os.system("iadmin suq {} total {}".format(user_name, bytes_total))
        if return_code == 0:
            success = True
    return success

class TestUserAndGroup(unittest.TestCase):

    def setUp(self):
        self.sess = helpers.make_session()

    def tearDown(self):
        '''Close connections
        '''
        self.sess.cleanup()

    def test_modify_password__328(self):
        ses = self.sess
        if ses.users.get( ses.username ).type != 'rodsadmin':
            self.skipTest( 'Only a rodsadmin may run this test.')

        OLDPASS = 'apass'
        NEWPASS = 'newpass'
        try:
            ses.users.create('alice', 'rodsuser')
            ses.users.modify('alice', 'password', OLDPASS)

            with iRODSSession(user='alice', password=OLDPASS, host=ses.host, port=ses.port, zone=ses.zone) as alice:
                me = alice.users.get(alice.username)
                me.modify_password(OLDPASS, NEWPASS)

            with iRODSSession(user='alice', password=NEWPASS, host=ses.host, port=ses.port, zone=ses.zone) as alice:
                home = helpers.home_collection( alice )
                alice.collections.get( home ) # Non-trivial operation to test success!
        finally:
            try:
                ses.users.get('alice').remove()
            except UserDoesNotExist:
                pass

    @staticmethod
    def do_something(session):
        return session.username in [i[User.name] for i in session.query(User)]

    def test_modify_password_with_changing_auth_file__328(self):
        ses = self.sess
        if ses.users.get( ses.username ).type != 'rodsadmin':
            self.skipTest( 'Only a rodsadmin may run this test.')
        OLDPASS = 'apass'
        def generator(p = OLDPASS):
            n = 1
            old_pw = p
            while True:
                pw = p + str(n)
                yield old_pw, pw
                n += 1; old_pw = pw
        password_generator = generator()
        ENV_DIR = tempfile.mkdtemp()
        d = dict(password = OLDPASS, user = 'alice', host = ses.host, port = ses.port, zone = ses.zone)
        (alice_env, alice_auth) = helpers.make_environment_and_auth_files(ENV_DIR, **d)
        try:
            ses.users.create('alice', 'rodsuser')
            ses.users.modify('alice', 'password', OLDPASS)
            for modify_option, sess_factory in [ (alice_auth, lambda: iRODSSession(**d)),
                                                 (True,
                                                 lambda: helpers.make_session(irods_env_file = alice_env,
                                                                              irods_authentication_file = alice_auth)) ]:
                OLDPASS,NEWPASS=next(password_generator)
                with sess_factory() as alice_ses:
                    alice = alice_ses.users.get(alice_ses.username)
                    alice.modify_password(OLDPASS, NEWPASS, modify_irods_authentication_file = modify_option)
            d['password'] = NEWPASS
            with iRODSSession(**d) as session:
                self.do_something(session)           # can we still do stuff with the final value of the password?
        finally:
            shutil.rmtree(ENV_DIR)
            ses.users.remove('alice')

    def test_modifying_password_at_various_lengths__issue_328(self):
        ses = self.sess
        try:
            pw_lengths = [3,                         # minimum password length
                          MAX_PASSWORD_LENGTH - 8,   # maximum password length
                          26]                        # one greater than threshold (See irods/irods#7084)

            # Test different combinations of new and old password lengths
            tuples_of_old_and_new_password = [('a'*x,'b'*y) for x in pw_lengths for y in pw_lengths]
            ses.users.create('alice', 'rodsuser')

            for old_pw, new_pw in tuples_of_old_and_new_password:
                ses.users.modify('alice', 'password',old_pw)
                # Successful change of own password
                with iRODSSession(user = 'alice', password = old_pw, host = ses.host, port = ses.port, zone = ses.zone) as user_sess:
                    user_sess.users.modify_password(old_pw, new_pw)
                # Test new password is usable
                with iRODSSession(user = 'alice', password = new_pw, host = ses.host, port = ses.port, zone = ses.zone) as user_sess:
                    self.do_something(user_sess)
        finally:
            ses.users.remove('alice')

    def test_password_corruption_can_be_prevented__issue_448(self):
        ses = self.sess
        try:
            # Threshold value of new password length, at which the server cannot
            #   properly detect the old-password value is incorrect).
            #   this is because its descrambled value does not contain space
            #   for the trailing sixteen character pattern needed by the server to detect a
            #   valid result for descramble. Of course, it goes ahead and modifies
            #   the database anyway....so we must screen for this in the client interface.
            #   (See irods/irods#7084)

            threshold = 25

            max_pw_len = MAX_PASSWORD_LENGTH - 8
            tuples_of_old_and_new_password = [ ('a'*24,'b'*threshold),
                                               ('a'*24,'b'*(max_pw_len)),
                                               ('a'*24,'b'*(max_pw_len + 1)) ]
            ses.users.create('alice', 'rodsuser')
            for old_pw, new_pw in tuples_of_old_and_new_password:
                ses.users.modify('alice', 'password', old_pw)

                # Test that we catch the attempt to change the old password when providing incorrect old password
                with self.assertRaises(Bad_password_change_parameter):
                    with iRODSSession(user = 'alice', password = old_pw, host = ses.host, port = ses.port, zone = ses.zone) as user_sess:
                        user_sess.users.modify_password(old_pw+".", new_pw)

                # Test that we can still change to a valid new password and that the new login is useable.
                new_pw = new_pw[:max_pw_len] #-> forcing to valid length
                with iRODSSession(user = 'alice', password = old_pw, host = ses.host, port = ses.port, zone = ses.zone) as user_sess:
                    user_sess.users.modify_password(old_pw, new_pw)
                with iRODSSession(user = 'alice', password = new_pw, host = ses.host, port = ses.port, zone = ses.zone) as user_sess:
                    self.do_something(user_sess)
        finally:
            ses.users.remove('alice')

    def test_modify_password_with_incorrect_old_value__issue_328(self):
        ses = self.sess
        if ses.users.get( ses.username ).type != 'rodsadmin':
            self.skipTest( 'Only a rodsadmin may run this test.')
        OLDPASS = 'apass'
        NEWPASS = 'newpass'
        ENV_DIR = tempfile.mkdtemp()
        try:
            ses.users.create('alice', 'rodsuser')
            ses.users.modify('alice', 'password', OLDPASS)
            d = dict(password = OLDPASS, user = 'alice', host = ses.host, port = ses.port, zone = ses.zone)
            (alice_env, alice_auth) = helpers.make_environment_and_auth_files(ENV_DIR, **d)
            session_factories = [
                       (lambda: iRODSSession(**d)),
                       (lambda: helpers.make_session( irods_env_file = alice_env, irods_authentication_file = alice_auth)),
            ]
            for factory in session_factories:
                with factory() as alice_ses:
                    alice = alice_ses.users.get(alice_ses.username)
                    with self.assertRaises(Bad_password_change_parameter):
                        alice.modify_password(OLDPASS + ".", NEWPASS)
            with iRODSSession(**d) as alice_ses:
                self.do_something(alice_ses)
        finally:
            shutil.rmtree(ENV_DIR)
            ses.users.remove('alice')

    def test_create_group(self):
        group_name = "test_group"

        # group should not be already present
        with self.assertRaises(GroupDoesNotExist):
            self.sess.groups.get(group_name)

        # create group
        group = self.sess.groups.create(group_name)

        # assertions
        self.assertEqual(group.name, group_name)
        self.assertEqual(
            repr(group), "<iRODSGroup {0} {1}>".format(group.id, group_name))

        # delete group
        group.remove()

        # group should be gone
        with self.assertRaises(GroupDoesNotExist):
            self.sess.groups.get(group_name)

    def test_add_users_to_group(self):
        group_name = "test_group"
        group_size = 15
        base_user_name = "test_user"

        # group should not be already present
        with self.assertRaises(GroupDoesNotExist):
            self.sess.groups.get(group_name)

        # create test group
        group = self.sess.groups.create(group_name)

        # create test users names
        test_user_names = []
        for i in range(group_size):
            test_user_names.append(base_user_name + str(i))

        # make test users and add them to test group
        for test_user_name in test_user_names:
            user = self.sess.users.create(test_user_name, 'rodsuser')
            group.addmember(user.name)

        # list group members
        member_names = [user.name for user in group.members]

        # compare lists
        self.assertSetEqual(set(member_names), set(test_user_names))

        # exercise iRODSGroup.hasmember()
        for test_user_name in test_user_names:
            self.assertTrue(group.hasmember(test_user_name))

        # remove test users from group and delete them
        for test_user_name in test_user_names:
            user = self.sess.users.get(test_user_name)
            group.removemember(user.name)
            user.remove()

        # delete group
        group.remove()

        # group should be gone
        with self.assertRaises(GroupDoesNotExist):
            self.sess.groups.get(group_name)

    def test_user_dn(self):
        # https://github.com/irods/irods/issues/3620
        if self.sess.server_version == (4, 2, 1):
            self.skipTest('Broken in 4.2.1')

        user_name = "testuser"
        user_DNs = ['foo', 'bar']

        # create user
        user = self.sess.users.create(user_name, 'rodsuser')

        # expect no dn
        self.assertEqual(user.dn, [])

        # add dn
        user.modify('addAuth', user_DNs[0])
        self.assertEqual(user.dn[0], user_DNs[0])

        # add other dn
        user.modify('addAuth', user_DNs[1])
        self.assertEqual( sorted(user.dn), sorted(user_DNs) )

        # remove first dn
        user.modify('rmAuth', user_DNs[0])

        # confirm removal
        self.assertEqual(sorted(user.dn), sorted(user_DNs[1:]))

        # delete user
        user.remove()

    def test_group_metadata(self):
        group_name = "test_group"

        # group should not be already present
        with self.assertRaises(GroupDoesNotExist):
            self.sess.groups.get(group_name)

        group = None

        try:
            # create group
            group = self.sess.groups.create(group_name)

            # add metadata to group
            triple = ['key', 'value', 'unit']
            group.metadata[triple[0]] = iRODSMeta(*triple)

            result =  self.sess.query(UserMeta, Group).filter(Group.name == group_name,
                                                              UserMeta.name == 'key').one()

            self.assertTrue([result[k] for k in (UserMeta.name, UserMeta.value, UserMeta.units)] == triple)

        finally:
            if group:
                group.remove()
                helpers.remove_unused_metadata(self.sess)

    def test_user_metadata(self):
        user_name = "testuser"
        user = None

        try:
            user = self.sess.users.create(user_name, 'rodsuser')

            # metadata collection is the right type?
            self.assertIsInstance(user.metadata, iRODSMetaCollection)

            # add three AVUs, two having the same key
            user.metadata['key0'] = iRODSMeta('key0', 'value', 'units')
            sorted_triples = sorted( [ ['key1', 'value0', 'units0'],
                                       ['key1', 'value1', 'units1']  ] )
            for m in sorted_triples:
                user.metadata.add(iRODSMeta(*m))

            # general query gives the right results?
            result_0 =  self.sess.query(UserMeta, User)\
                         .filter( User.name == user_name, UserMeta.name == 'key0').one()

            self.assertTrue( [result_0[k] for k in (UserMeta.name, UserMeta.value, UserMeta.units)]
                              == ['key0', 'value', 'units'] )

            results_1 =  self.sess.query(UserMeta, User)\
                         .filter(User.name == user_name, UserMeta.name == 'key1')

            retrieved_triples = [ [ res[k] for k in (UserMeta.name, UserMeta.value, UserMeta.units) ]
                                  for res in results_1
                                ]

            self.assertTrue( sorted_triples == sorted(retrieved_triples))

        finally:
            if user:
                user.remove()
                helpers.remove_unused_metadata(self.sess)

    def test_get_user_metadata(self):
        user_name = "testuser"
        user = None

        try:
            # create user
            user = self.sess.users.create(user_name, 'rodsuser')
            meta = user.metadata.get_all('key')

            # There should be no metadata
            self.assertEqual(len(meta), 0)
        finally:
            if user: user.remove()

    def test_add_user_metadata(self):
        user_name = "testuser"
        user = None

        try:
            # create user
            user = self.sess.users.create(user_name, 'rodsuser')

            user.metadata.add('key0', 'value0')
            user.metadata.add('key1', 'value1', 'unit1')
            user.metadata.add('key2', 'value2a', 'unit2')
            user.metadata.add('key2', 'value2b', 'unit2')

            meta0 = user.metadata.get_all('key0')
            self.assertEqual(len(meta0),1)
            self.assertEqual(meta0[0].name, 'key0')
            self.assertEqual(meta0[0].value, 'value0')

            meta1 = user.metadata.get_all('key1')
            self.assertEqual(len(meta1),1)
            self.assertEqual(meta1[0].name, 'key1')
            self.assertEqual(meta1[0].value, 'value1')
            self.assertEqual(meta1[0].units, 'unit1')

            meta2 = sorted(user.metadata.get_all('key2'), key = lambda AVU : AVU.value)
            self.assertEqual(len(meta2),2)
            self.assertEqual(meta2[0].name, 'key2')
            self.assertEqual(meta2[0].value, 'value2a')
            self.assertEqual(meta2[0].units, 'unit2')
            self.assertEqual(meta2[1].name, 'key2')
            self.assertEqual(meta2[1].value, 'value2b')
            self.assertEqual(meta2[1].units, 'unit2')

            user.metadata.remove('key1', 'value1', 'unit1')
            metadata = user.metadata.items()
            self.assertEqual(len(metadata), 3)

            user.metadata.remove('key2', 'value2a', 'unit2')
            metadata = user.metadata.items()
            self.assertEqual(len(metadata), 2)

        finally:
            if user:
                user.remove()
                helpers.remove_unused_metadata(self.sess)

    def create_groupadmin_user_and_session(self, groupadmin_user_name):

        # Generate a random password.
        ga_password = helpers.unique_name(helpers.my_function_name(),
                                          datetime.datetime.now())[:MAX_PASSWORD_LENGTH]

        # Create a groupadmin user with that password, and a session object for logging in as that user.
        groupadmin = self.sess.users.create(groupadmin_user_name, 'groupadmin')
        self.sess.users.modify(groupadmin_user_name, 'password', ga_password)
        session = iRODSSession(user = groupadmin_user_name,
                               password = ga_password,
                               host = self.sess.host,
                               port = self.sess.port,
                               zone = self.sess.zone)

        # Return two objects: the user and the session.
        return (groupadmin, session)

    def test_group_admin_can_create_and_administer_groups__issue_426(self):
        admin = self.sess
        alice = groupadmin = lab = None
        GROUP_ADMIN = 'groupadmin_426'
        try:
            # Create a rodsuser and a groupadmin.
            alice = admin.users.create('alice','rodsuser')
            alice.modify('password', 'apass')
            groupadmin, groupadmin_session = self.create_groupadmin_user_and_session(GROUP_ADMIN)

            # As the groupadmin:
            #    * Add two users to the group (one being the groupadmin) and assert membership.
            #    * Remove those users from the group, and assert they are no longer members.
            with groupadmin_session:
                lab = groupadmin_session.groups.create('lab')
                groupadmin_session.groups.addmember('lab',GROUP_ADMIN)
                groupadmin_session.groups.addmember('lab','alice')

                # Check that our members got added.
                # (For set objects in Python, s1 <= s2 comparison means "is s1 a subset of s2?")
                self.assertLessEqual(set(('alice',GROUP_ADMIN)), set(member.name for member in lab.members))

                groupadmin_session.groups.removemember('lab','alice')
                groupadmin_session.groups.removemember('lab',GROUP_ADMIN)

                # Check that our members got removed.
                self.assertFalse(set(('alice',GROUP_ADMIN)) & set(member.name for member in lab.members))
        finally:
            if groupadmin:
                groupadmin.remove()
            # NB: groups and users, even if created by a groupadmin, must be removed by a rodsadmin.
            if alice:
                alice.remove()
            if lab:
                admin.groups.remove(lab.name)

    def test_group_admin_can_create_users__issue_428(self):
        admin = self.sess
        if admin.server_version < (4, 2, 12) or admin.server_version == (4,3,0):
            self.skipTest('Password initialization is broken before iRODS 4.2.12, and in 4.3.0')
        rodsuser = groupadmin = None
        rodsuser_name = 'bob'
        rodsuser_password = 'random_password'
        try:
            # Create a groupadmin.
            groupadmin, groupadmin_session = self.create_groupadmin_user_and_session('groupadmin_428')

            # Use the groupadmin to create a new user initialized with a known password; then, test the
            # new user/password combination by logging in and grabbing the home collection object.
            with groupadmin_session:
                rodsuser = groupadmin_session.users.create_with_password(rodsuser_name, rodsuser_password)
                with iRODSSession(user = rodsuser_name,
                                  password = rodsuser_password,
                                  host = admin.host, port = admin.port, zone = admin.zone) as rodsuser_session:
                    rodsuser_session.collections.get(helpers.home_collection(rodsuser_session))
        finally:
            if groupadmin:
                groupadmin.remove()
            # NB: Although created by a groupadmin, the rodsuser must be removed by a rodsadmin.
            if rodsuser:
                admin.users.remove(rodsuser.name)

    def test_demonstrating_database_password_corruption_in_modify_password__issue_448(self):
        ses = helpers.make_session()
        if ses.users.get( ses.username ).type != 'rodsadmin':
            self.skipTest( 'Only a rodsadmin may run this test.')

        user_alice = None
        extra="."
        NEWPASS='1234567890123456789012345'
        OLDPASS='123456789012345678901234'

        try:
            user_alice = ses.users.create('alice', 'rodsuser')
            ses.users.modify('alice', 'password', OLDPASS)

            def alice_login(pw):
                with iRODSSession(user='alice', password=pw, host=ses.host, port=ses.port, zone=ses.zone) as alice:
                    home = helpers.home_collection( alice )
                    alice.collections.get(home)

            alice_login(OLDPASS)

            # Alice makes an unsuccessful attempt at changing her own password.
            with iRODSSession(user='alice', password=OLDPASS, host=ses.host, port=ses.port, zone=ses.zone) as alice:
                me = alice.users.get(alice.username)
                try:
                    me.modify_password(OLDPASS+extra, NEWPASS)
                except Bad_password_change_parameter:
                    pass

            # Whether the server raises an error or not, one would expect that either password in the catalog should
            # at this point have the desired new value, or it should have been left as it was.
            # Unfortunately the iRODS server does not guarantee this during the unfiltered use of USER_ADMIN_AN.
            # (See https://github.com/irods/python-irodsclient/issues/448 .)
            # Thus, here we make two trials to ensure the condition of integrity.  If neither the old nor the new
            # password works, 'successes' will stay 0 and the assertion below will fail.  This would indicate the
            # corruption of the database-stored password that is the subject of this test.
            successes = 0
            for password in (OLDPASS, NEWPASS):
                try:
                    alice_login(password)
                except ex.CAT_INVALID_AUTHENTICATION:
                    pass
                else:
                    successes += 1
            self.assertGreater(successes, 0)

        finally:
            if user_alice:
                user_alice.remove()

    def test_set_and_query_group_quota(self):
        #import pdb
        #pdb.set_trace()
        bob = quota_group = None
        ses = self.sess
        test_object = None
        my_quota = 10000
        my_object_size = 1400
        try:
            bob = self.sess.users.create('bob', 'rodsuser')
            ses.users.modify('bob', 'password', 'bpass')
            quota_group = self.sess.groups.create('quota_group_for_bob')
            quota_group.addmember(bob.name)
            quota_group.set_quota(my_quota)
            with iRODSSession(user = 'bob', password = 'bpass', host = ses.host, port = ses.port, zone = ses.zone) as user_sess:
                test_object = user_sess.data_objects.create('/tempZone/home/public/bob_file_testing_group_quota')
                with test_object.open('w') as f:
                    f.write(b'_' * my_object_size)
            ses.groups.calculate_usage()
            for i in ses.query(Quota).filter(Quota.user_id == quota_group.id):
                self.assertEqual(int(i[Quota.over]), -my_quota + my_object_size)
        finally:
            if test_object:
                test_object.unlink(force = True)
            if quota_group:
                quota_group.remove()
            if bob:
                ses.users.remove(bob.name)

    @unittest.skipIf(not user_quotas_implemented()
                     and not icommands_available(), "Can't set up user quota for removal in test")
    def test_set_and_query_user_quota(self):
        bob = None
        if self.sess.server_version >= (4, 3):
            self.skipTest('iRODS servers 4.3.0 and higher have dropped user quotas in favor of group quotas.')
        ses = self.sess
        test_object = None
        try:
            bob = self.sess.users.create('bob', 'rodsuser')
            ses.users.modify('bob', 'password', 'bpass')
            set_user_quota(ses, 'bob', 10000)
            with iRODSSession(user = 'bob', password = 'bpass', host = ses.host, port = ses.port, zone = ses.zone) as user_sess:
               test_object = user_sess.data_objects.create('/tempZone/home/public/bobfile')
               with test_object.open('w') as f:
                   f.write(b'_'*1000)
            ses.users.calculate_usage()
            for i in ses.query(Quota).filter(Quota.user_id == bob.id):
                self.assertEqual(int(i[Quota.over]), -9000)
        finally:
            if test_object:
                test_object.unlink(force = True)
            if bob:
                ses.users.remove(bob.name)


if __name__ == '__main__':
    # let the tests find the parent irods lib
    sys.path.insert(0, os.path.abspath('../..'))
    unittest.main()
