Changeset 1102 for trunk/rp/trac

Timestamp:

11/21/07 09:40:55 (14 months ago)

Author:

dbuss

Message:

Added dependency checking, fixed several exceptions in the ldapstore, moved the database files into a common location and made it so that trac-admin /pathtotrac upgrade command would create databases if the ldapstores were configured, prevent double click on infocard icon

Location:

trunk/rp/trac/infocard_acct/0.11

Files:

• infocard_acct/console.py (modified) (4 diffs)
• infocard_acct/db.py (modified) (2 diffs)
• infocard_acct/db_default.py (added)
• infocard_acct/ldapstore.py (modified) (5 diffs)
• infocard_acct/templates/authenticate.html (modified) (2 diffs)
• setup.py (modified) (1 diff)

trunk/rp/trac/infocard_acct/0.11/infocard_acct/console.py

@@ -99 +99 @@
 from acct_mgr.api import AccountManager
 
+import db_default
+from db import InfoCardAccountEnv
+
 INFOCARD_ACCT_VERSION = pkg_resources.get_distribution('InfoCardAccountManager').version
 TRAC_VERSION = pkg_resources.get_distribution('Trac').version
@@ -199 +202 @@
                 if params:
                         cursor.execute(sql, params)
+                        print 'finished executing %s :: %s' % (sql, params)
                 else:
                         cursor.execute(sql)
+                        print 'finished executing %s' % (sql)
                 if cnx:
                         cnx.commit()
+
+        def db_attempt(self, sql, cursor=None, params=None):
+                try:
+                        if not cursor:
+                                cnx = self.db_open()
+                                cursor = cnx.cursor()
+                        else:
+                                cnx = None
+                        if params:
+                                cursor.execute(sql, params)
+                                print 'finished executing %s :: %s' % (sql, params)
+                        else:
+                                cursor.execute(sql)
+                                print 'finished executing %s' % (sql)
+                        if cnx:
+                                cnx.commit()
+                except Exception, e:
+                        print 'Ignoring error executing: %s' % (sql)
 
         ##
@@ -285 +308 @@
                 env = self.env_open()
                 ctx = self.db_open()
-                cursor = ctx.cursor()
 
                 tables = None
-                user = Table('user', key=('username'))[
-                                Column('username'),
-                                Column('passwordhash'),
-                                Index(['username'])
-                                ]
-                cards = Table('cardkey', key=('cardkeyhash'))[
-                                Column('username'),
-                                Column('cardkeyhash'),
-                                Index(['username']),
-                                Index(['cardkeyhash'])
-                                ] 
-                usertables =  [ user ]
-                cardtables = [ cards ]
-                alltables = [user, cards]
-                
-                
                 if arg[0] == 'user':
-                        tables = usertables
+                        tables = db_default.usertables
                 elif arg[0] == 'card':
-                        tables = cardtables
-                else:
-                        tables = alltables
-                        
+                        tables = db_default.cardtables
+                else:
+                        tables = db_default.alltables
+
                 try:
-        
-                        db_connector, _ = DatabaseManager(env)._get_connector()
-                        for table in tables:
-                                for stmt in db_connector.to_sql(table):
-                                        cursor.execute(stmt)
+                        ienv = InfoCardAccountEnv(env)
+                        ienv.upgrade_environment(ctx, tables)
                 except TracError, e:
                         msg = unicode(e)
@@ -337 +340 @@
         
                 if arg[0] == 'user':
-                        cursor.execute("DROP TABLE user")
+                        self.db_attempt("DROP TABLE user", cursor)
                 elif  arg[0] == 'card':
-                        cursor.execute("DROP TABLE cardkey")
-                else:
-                        cursor.execute("DROP TABLE user")
-                        cursor.execute("DROP TABLE cardkey")
+                        self.db_attempt("DROP TABLE cardkey", cursor)
+                else:
+                        self.db_attempt("DROP TABLE user", cursor)
+                        self.db_attempt("DROP TABLE cardkey", cursor)
+                self.db_update("DELETE from system WHERE name=%s", cursor, (db_default.db_name,))
                 ctx.commit()
                 print 'cleanenv done.'          

trunk/rp/trac/infocard_acct/0.11/infocard_acct/db.py

@@ -36 +36 @@
 from trac.config import ExtensionOption
 from trac.db import Table, Column, Index, DatabaseManager
+from trac.env import IEnvironmentSetupParticipant
+
+import db_default
 
 from acct_mgr.api import IPasswordStore
@@ -161 +164 @@
                 # is there another way to get count instead of using has_user?
                 return True
-                
+
+
+class InfoCardAccountEnv(Component):
+
+        implements(IEnvironmentSetupParticipant)
+        # IEnvironmentSetupParticipant methods
+        """Extension point interface for components that need to participate in the
+        creation and upgrading of Trac environments, used to setup our database
+        tables, we store our component version in the .db for later use."""
+
+        def environment_created(self):
+                """Called when a new Trac environment is created."""
+                self.found_db_version = 0
+                self.upgrade_environment(self.env.get_db_cnx())
+
+        def environment_needs_upgrade(self, db):
+                """Called when Trac checks whether the environment needs to be upgraded.
+                Should return `True` if this participant needs an upgrade to be
+                performed, `False` otherwise. If the version in the db is newer
+                should we downgrade or abort?
+                """
+
+                self.found_db_version = 0
+                cursor = db.cursor()
+                cursor.execute("SELECT value FROM system WHERE name=%s", (db_default.db_name,))
+                value = cursor.fetchone()
+                if value:
+                        self.found_db_version = int(value[0])
+
+                self.log.debug('InfoCardAccountEnv: Current db version %s, required is %s' \
+                                % (self.found_db_version, db_default.db_version))
+
+                if self.found_db_version == db_default.db_version:
+                        return False
+
+                return True
+                        
+        def upgrade_environment(self, db, tables=db_default.alltables):
+                """Actually perform an environment upgrade, the magic all happens here,
+                Note that the commit is called by the caller if we don't raise an error
+                """
+                
+                if self.environment_needs_upgrade(db):
+                        db_connector, _ = DatabaseManager(self.env)._get_connector()
+
+                        # Insert the default table
+                        old_data = {} # {table_name: (col_names, [row, ...]), ...}
+                        cursor = db.cursor()
+                        if not self.found_db_version:
+                                cursor.execute("INSERT INTO system (name, value) VALUES (%s, %s)",(db_default.db_name, db_default.db_version))
+                        else:
+                                cursor.execute("UPDATE system SET value=%s WHERE name=%s",(db_default.db_version, db_default.db_name))
+                                for tbl in tables:
+                                        try:
+                                                cursor.execute('SELECT * FROM %s'%tbl.name)
+                                                old_data[tbl.name] = ([d[0] for d in cursor.description], cursor.fetchall())
+                                                cursor.execute('DROP TABLE %s'%tbl.name)
+                                        except Exception, e:
+                                                if 'OperationalError' not in e.__class__.__name__:
+                                                        raise e # If it is an OperationalError, just move on to the next table
+
+                        for tbl in tables:
+                                for sql in db_connector.to_sql(tbl):
+                                        cursor.execute(sql)
+
+                        # Try to reinsert any old data
+                        if tbl.name in old_data:
+                                data = old_data[tbl.name]
+                                sql = 'INSERT INTO %s (%s) VALUES (%s)' % \
+                                          (tbl.name, ','.join(data[0]), ','.join(['%s'] * len(data[0])))
+                                for row in data[1]:
+                                        try:
+                                                cursor.execute(sql, row)
+                                        except Exception, e:
+                                                if 'OperationalError' not in e.__class__.__name__:
+                                                        raise e
+
+

trunk/rp/trac/infocard_acct/0.11/infocard_acct/ldapstore.py

@@ -79 +79 @@
                 return None;
                 
-        def _get_attr(self, url):
+        def _get_attrs(self, url):
                 if len(url.attrs) > 0:
-                        return url.attrs[0].encode('utf-8')
+                        attrList = []
+                        for attr in url.attrs:
+                                attrList.append(attr.encode('utf-8'))
+                        return attrList
                 else:
-                        return 'uid'    
+                        return ('uid',) 
                 
         def _user_is_invalid(self, user):
@@ -93 +96 @@
                 return None
         
+        def _get_userfilterstr(self, search_url, user):
+                attrs = self._get_attrs(search_url)
+                if len(attrs) == 1:
+                        return  '(& ' + search_url.filterstr + '('+ self._get_attrs(search_url)+'='+ user       +'))'
+                else:
+                        return '(& ' + search_url.filterstr + '(|' + ''.join("(%s=%s)" \
+                                        % (attr, user) for attr in attrs)+'))'
+
         def get_users(self):
-                """Returns an iterable of the known usernames
+                """Return known usernames
                 """
                 search_url = self._setup_search_url()
-                users =[]
                 if search_url:
+                        self.log.debug('LDAPUserStore:get_users: binding as \"%s\" '
+                                        + 'using \"%s\"', search_url.who, search_url.cred)
                         l = ldap.open(search_url.hostport)
                         l.simple_bind_s(search_url.who, search_url.cred)
                         
                         #get first attr, place in list
-                        attrs = (self._get_attr(search_url))
+                        attrs = self._get_attrs(search_url)
+                        self.log.debug('LDAPUserStore:get_users: searching \"%s\" '
+                                        + 'for \"%s\"', search_url.dn, search_url.filterstr)
                         results = l.search_s(search_url.dn, search_url.scope, 
                                 search_url.filterstr, attrs)
                                 
-                        #works because there is only one attr by convention
+                        #works because there is only one attr per entry based on the number
+                        # of attributes in the attrs variable above
                         for entry in results:
-                                for attr in entry[1]:
-                                        users.append(entry[1][attr])
-                return users
-                
+#                               if entry[1].items() == 1:
+                                for attr in entry[1].values():
+                                        self.log.debug('LDAPUserStore:get_users returning: %s' % (attr[0], ))
+                                        yield attr[0]
+#                               else:
+#                                       self.log.debug('LDAPUserStore:get_users found incorrect number of items')
+
         def has_user(self, user):
 #               if self._user_is_invalid(user):
 #                       return False
-                search_url = self._setup_search_url()
-                if search_url:
-                        l = ldap.open(search_url.hostport)
-                        l.simple_bind_s(search_url.who, search_url.cred)
-                        #todo fix so it looks for the user.
-                        results = l.search_s(search_url.dn, search_url.scope, 
-                                search_url.filterstr)
-                        if len(results) == 1:
-                                return True
+                try:
+                        search_url = self._setup_search_url()
+                        if search_url:
+                                l = ldap.open(search_url.hostport)
+                                l.simple_bind_s(search_url.who, search_url.cred)
+                                #todo fix so it looks for the user.
+                                results = l.search_s(search_url.dn, search_url.scope, 
+                                        self._userfilterstr(search_url, user))
+                                if len(results) == 1:
+                                        return True
+                except:
+                        pass
                 return False
 
@@ -135 +156 @@
                                 l = ldap.open(search_url.hostport)
                                 l.simple_bind_s(search_url.who, search_url.cred)
-                                searchfilter = '(& ' + search_url.filterstr + '('+ self._get_attr(search_url)+'='+ user +'))'
-#                               self.log.debug('LDAPUserStore:check_password: searching \"%s\" '
-#                                       + 'for \"%s\"', search_url.dn, searchfilter)
+                                searchfilter = self._get_userfilterstr(search_url, user)
+                                self.log.debug('LDAPUserStore:check_password: searching \"%s\" '
+                                        + 'for \"%s\"', search_url.dn, searchfilter)
                                 results = l.search_s(search_url.dn, search_url.scope, searchfilter)
                                 if len(results) == 1:
@@ -148 +169 @@
 #                                       self.log.debug('LDAPUserStore:check_password succeeded')
                                         return True
-#                               elif len(results) == 0:
-#                                       self.log.debug('LDAPUserStore:check_password search failed')
+                                elif len(results) == 0:
+                                        self.log.debug('LDAPUserStore:check_password search failed')
 #                               else:
 #                                       for entry in results:
@@ -156 +177 @@
                 except:
                         #on error just return the password failed
-                        self.log.debug('LDAPUserStore:check_password failed')
+                        self.log.debug('LDAPUserStore:check_password for \"%s\" failed' % (user))
                         return False
 
-        def delete_user(self, user):
-                """Deletes the user account.
-                Returns True if the account existed and was deleted, False otherwise.
-                """
-                if not self.has_user(user):
-                        return False
-                db = self.env.get_db_cnx()
-                cursor = db.cursor()
-                cursor.execute("DELETE FROM user "
-                                           "WHERE username=%s", (user,))
-                # TODO cursor.rowcount doesn't seem to get # deleted
-                # is there another way to get count instead of using has_user?
-                return True
+#       def delete_user(self, user):
+#               """Deletes the user account.
+#               Returns True if the account existed and was deleted, False otherwise.
+#               """
+#               return False
                 

trunk/rp/trac/infocard_acct/0.11/infocard_acct/templates/authenticate.html

@@ -12 +12 @@
         $('#user')[0].focus();
     });
+        
+        submited = false;
+        function image_disable(ref)
+        {
+                if (!submited)
+                {
+                        ref.submit();
+                        submited = true;
+                }
+        };
     </script>
   </head>
@@ -59 +69 @@
                         src="${href.chrome('/infocard_acct/images/infocard_92x64.png')}"
                                 alt="InfoCard Login"  
-                        onClick='infocardLogin.submit()'/>
+                        onClick='image_disable(infocardLogin)'/>
                         <input type="hidden" name="referer" value="${referer}" />
                         <input py:if="blockID" type="hidden" name="blockID" value="${blockID}" />

trunk/rp/trac/infocard_acct/0.11/setup.py

@@ -130 +130 @@
 
     install_requires = [
-#        'Trac>=0.11',
-#               'M2Crypto>=0.18'
+        'TracAccountManager',
+        'Trac >= 0.11dev_r6153',
+        'M2Crypto >= 0.18'
     ],