Changeset 508

Timestamp:

10/02/08 23:09:34 (5 years ago)

Author:

rcorsaro

Message:

• Added documentation to oforge api
• Removed some test code
• Made add_dashboard_project public method
• Added add-to-dashboard command and remove-from-console command
• Removed sqlite dependency in create project method
• Took out hard coded oforge trac.ini location

Location:

trunk/plugins/oforgeplugin

Files:

• oforge/api.py (modified) (15 diffs)
• oforge/console.py (modified) (2 diffs)
• setup.py (modified) (1 diff)
• share/cgi-bin/oforge-auth.wsgi (modified) (2 diffs)

trunk/plugins/oforgeplugin/oforge/api.py

@@ -43 +43 @@
     '''MASTER_CONFIG lets oforge find the base trac site config file'''
     def __init__(self, configpath=None):
+        """
+        The master ini is the trac.ini file that all projects
+        inherit from.  If the config path is not provided, we 
+        will check for an oforge ini file in etc.  This can 
+        provide the location of the master ini.
+        """
         if not configpath:
             for oforge_config in self.MASTER_CONFIG:
@@ -53 +59 @@
 
     def postgres_db_props(self):
+        """
+        Get all project dashboard db related connection options.
+        """
         props = {}
         props['database'] = \
@@ -67 +76 @@
 
     def warehouse_db_cnx(self):
+        """
+        Context for the project dashboard postgres schema.
+        """
         p = self.postgres_db_props()
 
@@ -86 +98 @@
 
     def getenv(self, name):
+        """
+        Get an environment by name.
+        """
         base = self.config.get('oforge', 'trac_base')
         thepath = path.join(base, name)
@@ -92 +107 @@
 
     def getconfig(self, name):
+        """
+        Return the config object of an environment by name.
+        """
         base = self.config.get('oforge', 'trac_base')
         thepath = path.join(base, name, 'conf/trac.ini')
@@ -99 +117 @@
     def get_project(self, env):
         """
-        Return a map of all project properties.
+        Return a project object from the django project dashboard api.
         """
         return Project.objects.get(id=env.config.getint('oforge', 'proj_id'))
@@ -132 +150 @@
 
     def converttopostgres(self, name):
+        """
+        Convert a project from sqlite to postgresql.
+        """
         # Setup vars
         config = self.getconfig(name)
@@ -169 +190 @@
             # Commit all changes
             target_db_cnx.commit()
-            self._add_dashboard.project(name)
         except Exception, e:
             config.set('trac','database', olddburl)
@@ -182 +202 @@
             raise e
 
-    def warehouseproject(self, name):
-        traclocation = path.join(self.config.get('oforge', 'trac_base'), 
-                name)
-        env = Environment(traclocation)
-        db = env.config.get('trac', 'database')
-        # cp old project
-
-    def _add_dashboard_project(self, name):
+    def add_dashboard_project(self, name):
+        """
+        Connect a project to the project dashboard.
+        """
         env = self.getenv(name)
+        if env.config.get('oforge', 'proj_id', None):
+            raise OForgeException("Project already registered")
         display_name = env.config.get('project', 'name')
         type = env.config.get('project', 'category')
@@ -199 +217 @@
         env.config.save()
         return p.id
+
+    def remove_dashboard_project(self, name):
+        """
+        Disconnect a project from the project dashboard.
+        """
+        env = self.getenv(name)
+        proj_id = env.config.getint('oforge', 'proj_id', -1)
+        if proj_id != -1:
+            Project.objects.filter(id=proj_id).delete()
+            env.config.set('oforge', 'proj_id', None)
+            env.config.save()
+        else:
+            raise OForgeProjectException("Project not registered")
 
     def createproject(self, name, **kwargs):
@@ -294 +325 @@
                         "Using source project %s"%(defaultworkspace))
                 sourceenv = self.getenv(defaultworkspace)
+                src_dbstr = sourceenv.config.get('trac', 'database')
+                src_is_postgres = \
+                        re.match('^postgres', src_dbstr)
                 try: 
                     self.logger.debug('Cloning default workspace')
-                    self.cloneproject(sourceenv, env)
+                    self.cloneproject(sourceenv, env, src_is_postgres=src_is_postgres)
                 finally:
                     sourceenv.shutdown()
             env.upgrade(backup=False)
-            proj_id = self._add_dashboard_project(name)
+            proj_id = self.add_dashboard_project(name)
             project_created = True
             self.logger.debug('Environment creation complete')
@@ -383 +417 @@
         return env
     
-    def cloneproject(self, sourceenv, targetenv):
+    def cloneproject(self, sourceenv, targetenv, src_is_postgres=False):
         '''
         Extract data from one project and insert it into the other
@@ -397 +431 @@
         try:
             for table in tables:
-                self._copy_table(source_db, target_db, table)
+                self._copy_table(source_db, target_db, table, 
+                        src_is_postgres=src_is_postgres)
         except Exception, e:
             target_db.rollback()
@@ -406 +441 @@
        
 
-    def _copy_table(self, src_db, dest_db, table, do_close_tran=False):
+    def _copy_table(self, src_db, dest_db, table, do_close_tran=False, src_is_postgres=False):
         '''
         Copy a table from one DB to another
@@ -412 +447 @@
         src_cursor = src_db.cursor()
         dest_cursor = dest_db.cursor()
-
-        if src_cursor.execute("select name from sqlite_master " + \
-                "where name = '%s'"%(table)).fetchone():
+        test_query = """SELECT name FROM sqlite_master 
+                        WHERE name = '%s'"""%(table)
+        if src_is_postgres:
+            src_cursor.execute("SHOW search_path")
+            schema = src_cursor.fetchone()[0]
+            test_query = """SELECT table_name FROM information_schema.tables
+                            WHERE table_name = '%s' AND 
+                                table_schema = '%s'"""%(table, schema)
+        # TODO: this needs to work with postgres too
+        src_cursor.execute(test_query)
+        if src_cursor.fetchone():
             src_cursor.execute('SELECT * FROM %s'%(table))
             dest_cursor.execute('SELECT * FROM %s LIMIT 1'%(table))

trunk/plugins/oforgeplugin/oforge/console.py

@@ -24 +24 @@
 from oforge.api import OForge
 
+MASTER_CONFIG = ('/etc/oforge.ini', '/etc/oforge/oforge.ini')
+
 def oforge_admin():
     _init_oforge_logger()
-    MASTER_CONFIG = ('/etc/oforge.ini', '/etc/oforge/oforge.ini')
 
     mconfig = None
@@ -189 +190 @@
 
 def convert_to_postgres():
-    parser = OptionParser()
+    usage = "%prog [options] workspace-shortname  \n - Remove workspace from dashboard."
+    parser = OptionParser(usage)
+
+    parser.set_defaults(master_trac_ini=_get_master_trac_ini())
+
+    parser.add_option("--master-trac-ini", dest="master_trac_ini",
+        help="Master trac ini that describes project locations.")
     (opts, args) = parser.parse_args()
     proj = args[0]
     if proj:
-        oforge = OForge('/var/oforge/share/conf/trac.ini')
+        oforge = OForge(opts.master_trac_ini)
         oforge.converttopostgres(proj)
+
+def add_to_dashboard():
+    usage = "%prog [options] workspace-shortname  \n - Remove workspace from dashboard."
+    parser = OptionParser(usage)
+
+    parser.set_defaults(master_trac_ini=_get_master_trac_ini())
+
+    parser.add_option("--master-trac-ini", dest="master_trac_ini",
+        help="Master trac ini that describes project locations.")
+    (opts, args) = parser.parse_args()
+    proj = args[0]
+    if proj:
+        oforge = OForge(opts.master_trac_ini)
+        oforge.add_dashboard_project(proj)
+
+def remove_from_dashboard():
+    usage = "%prog [options] workspace-shortname  \n - Remove workspace from dashboard."
+    parser = OptionParser(usage)
+
+    parser.set_defaults(master_trac_ini=_get_master_trac_ini())
+
+    parser.add_option("--master-trac-ini", dest="master_trac_ini",
+        help="Master trac ini that describes project locations.")
+    (opts, args) = parser.parse_args()
+    proj = args[0]
+    if proj:
+        oforge = OForge(opts.master_trac_ini)
+        oforge.remove_dashboard_project(proj)
+
+def _get_master_trac_ini():
+    mconfig = None
+    for config_path in MASTER_CONFIG:
+        if path.exists(config_path):
+            mconfig = Configuration(config_path)
+            return mconfig.get('oforge', 'configfile', '/var/oforge/share/conf/trac.ini')
+    if not mconfig:
+        return '/var/oforge/share/conf/trac.ini'
 
 def _init_oforge_logger():

trunk/plugins/oforgeplugin/setup.py

@@ -39 +39 @@
           'oforge-projects-upgrade = oforge.console:projects_upgrade',
           'oforge-convert-to-postgres = oforge.console:convert_to_postgres',
+          'oforge-add-to-dashboard = oforge.console:add_to_dashboard',
+          'oforge-remove-from-dashboard = oforge.console:remove_from_dashboard'
       ]}, 
       zip_safe=True,

trunk/plugins/oforgeplugin/share/cgi-bin/oforge-auth.wsgi

@@ -35 +35 @@
 from os import path
 import re
-trac_path_match = re.compile(r'^/[^/]+/([^/]+)')
+trac_path_match = re.compile(r'^/trac/(master/projects/)?([^/]+)')
 
 TRAC_ENV_PARENT_DIR = "/var/oforge/trac/"
@@ -43 +43 @@
     m=trac_path_match.match(environ.get('REQUEST_URI'))
     if m:
-        env_path=path.join(TRAC_ENV_PARENT_DIR,m.group(1))
+        env_path=path.join(TRAC_ENV_PARENT_DIR,m.group(2))
         if path.isfile(path.join(env_path,'VERSION')):
             try: