PostgresqlPatch: pgsql_patch_11.diff

scripts/trac-admin

@@ -27 +27 @@
-import time
-import cmd
-import shlex
-import sqlite
-import StringIO
+import traceback
-
-from trac import perm
-from trac import util
@@ -93 +93 @@
-            return 0
-        return 1
-        
-
+, db_str
-        try:
-create=1
+1, db_str
-            return self.__env
-        except Exception, e:
-            print 'Failed to create environment.', e
@@ -112 +112 @@
-
-    def db_execsql (self, sql, cursor=None):
-        data = []
+        row = None
-        if not cursor:
-            cnx=self.db_open()
-            cursor = cnx.cursor()
@@ -119 +120 @@
-            cnx = None
-        cursor.execute(sql)
-        while 1:
-
+
+
+
+
-            if row == None:
-                break
-            data.append(row)
@@ -452 +456 @@
-
-    ## Initenv
-    _help_initenv = [('initenv', 'Create and initialize a new environment interactively'),
-
+ <dbms> [dbms options]
-                      'Create and initialize a new environment from arguments')]
-
-    def do_initdb(self, line):
@@ -485 +489 @@
-        dt = trac.siteconfig.__default_templates_dir__
-        prompt = 'Templates directory [%s]> ' % dt
-        returnvals.append(raw_input(prompt) or dt)
+        print
+        print " Please enter the database in which you wish to store Trac data."
+        print " Default is 'sqlite', but others are supported:"
+        print " 'sqlite' - SQLite       http://www.sqlite.org"
+        print " 'pgsql'  - PostgreSQL   http://www.postgresql.org"
+        print
+        ddb = "sqlite"
+        prompt =  'database system [%s]> ' % ddb
+        dbms = raw_input(prompt) or ddb
+        returnvals.append(dbms)
+        
+        # PostgreSQL - additional questions
+        if dbms == "pgsql":
+            print
+            print " Please enter the host of your PostgreSQL database."
+            print " Default is 'localhost'"
+            print
+            host = "localhost"
+            prompt = "PostgreSQL host [%s]> " % host
+            returnvals.append(raw_input(prompt) or host)
+            
+            print
+            print " Please enter the port of your PostgreSQL database."
+            print " Default is '5432'"
+            print
+            port = "5432"
+            prompt = "PostgreSQL port [%s]> " % port
+            returnvals.append(raw_input(prompt) or port)
+            
+            print
+            print " Please enter the name of your PostgreSQL database."
+            print " Default is 'trac'"
+            print " Note: This database should not exist, as trac-admin will" \
+                  " attempt to create it."
+            print
+            name = "trac"
+            prompt = "PostgreSQL database [%s]> " % name
+            returnvals.append(raw_input(prompt) or name)
+            
+            print
+            print " Please enter the user of your PostgreSQL database."
+            print " Default is 'trac'"
+            print
+            user = "trac"
+            prompt = "PostgreSQL user [%s]> " % user
+            returnvals.append(raw_input(prompt) or user)
+            
+            print
+            print " Please enter the password of your PostgreSQL database."
+            print " Default is 'trac'"
+            print
+            password = "trac"
+            prompt = "PostgreSQL password [%s]> " % password
+            returnvals.append(raw_input(prompt) or password)
+            
-        return returnvals
-         
-    def do_initenv(self, line):
@@ -495 +554 @@
-        project_name = None
-        repository_dir = None
-        templates_dir = None
+        db_str = None
-        if len(arg) == 1:
-            returnvals = self.get_initenv_args()
-            project_name = returnvals[0]
-            repository_dir = returnvals[1]
-            templates_dir = returnvals[2]
-
+
+
-            print 'Wrong number of arguments to initenv %d' % len(arg)
-            return
-        else:
-            project_name = arg[0]
-            repository_dir = arg[1]
-            templates_dir = arg[2]
+            db_str = arg[3]
+        
+        # sqlite-specific stuff
+        if db_str.lower() == "sqlite":
+            db_str = 'sqlite:"db/trac.db",timeout=10000'
+        
+        # postgres-specific stuff
+        if db_str.lower() == "pgsql":
+            if len(arg) == 1:
+                host = returnvals[4]
+                port = returnvals[5]
+                database = returnvals[6]
+                user = returnvals[7]
+                password = returnvals[8]
+            elif len(arg) != 9:
+                print 'Wrong number of arguments to initenv %d' % len(arg)
+                print 'For PostgreSQL (after pgsql): <host> <port> <database>' \
+                      ' <user> <password>'
+                return
+            else:
+                host = arg[4]
+                port = arg[5]
+                database = arg[6]
+                user = arg[7]
+                password = arg[8]
+            db_str = "pgsql:\"\",host='%s:%s',database='%s',user='%s'," \
+                     "password='%s'" \
+                     % (host, port, database, user, password)
+            createdb_str = "createdb --host=%s --port=%s --owner=%s " \
+                           "--username=%s %s\n" \
+                           % (host, port, user, user, database)
+            print createdb_str
+            try:
+                # TODO: this is not cross-platform.
+                # for Windows, look at win32pipe.popen()
+                os.popen(createdb_str)
+            except Exception, e:
+                print "Error creating PostgreSQL database: %s" % e
+                print "command: %s" % createdb_str
+        
-        from svn import util, repos, core
-        core.apr_initialize()
-        pool = core.svn_pool_create(None)
@@ -525 +626 @@
-            return
-        try:
-            print 'Creating and Initializing Project'
-
+db_str
-            cnx = self.__env.get_db_cnx()
-            print ' Inserting default data'
-            self.__env.insert_default_data()
@@ -664 +765 @@
-                self.do_help ('wiki')
-        except Exception, e:
-            print 'Wiki %s failed:' % arg[0], e
+            print traceback.print_exc()
+            
-
-    def _do_wiki_list(self):
-        data = self.db_execsql('SELECT name,max(version),time'
@@ -794 +897 @@
-        self.print_listing(['Possible Values'], data)
-
-    def _do_enum_add(self, type, name):
+
-        sql = ("INSERT INTO enum(value,type,name) "
-               " SELECT 1+COALESCE(max(value),0),'%(type)s','%(name)s'"
-               "   FROM enum WHERE type='%(type)s'" 

trac/db_default.py

@@ -172 +172 @@
-CREATE INDEX session_idx        ON session(sid,var_name);
-"""
-
+schema_pgsql = """
+CREATE TABLE revision (
+        rev             integer,
+        time            integer,
+        author          text,
+        message         text,
+        CONSTRAINT revision_pkey PRIMARY KEY (rev)
+);
+
+CREATE TABLE node_change (
+        rev             integer,
+        name            text,
+        change          char(1),
+        CONSTRAINT node_change_pkey PRIMARY KEY (rev, name, change)
+);
+
+CREATE TABLE auth_cookie (
+        cookie          text,
+        name            text,
+        ipnr            text,
+        time            integer,
+        CONSTRAINT auth_cookie_pkey PRIMARY KEY(cookie, name, ipnr)
+);
+
+CREATE TABLE enum (
+        type            text,
+        name            text,
+        value           integer,
+        CONSTRAINT enum_pkey PRIMARY KEY(name,type)
+);
+
+CREATE TABLE system (
+        name            text,
+        value           text,
+        CONSTRAINT system_pkey PRIMARY KEY(name)
+);
+
+CREATE TABLE lock (
+        name            text,
+        owner           text,
+        ipnr            text,
+        time            integer,
+        CONSTRAINT lock_pkey PRIMARY KEY(name)
+);
+
+--CREATE SEQUENCE ticket_id_seq;
+CREATE TABLE ticket (
+        id              serial,
+        time            integer,        -- the time it was created
+        changetime      integer,
+        component       text,
+        severity        text,
+        priority        text,
+        owner           text,           -- who is this ticket assigned to
+        reporter        text,
+        cc              text,           -- email addresses to notify
+        url             text,           -- url related to this ticket
+        version         text,           -- 
+        milestone       text,           -- 
+        status          text,
+        resolution      text,
+        summary         text,           -- one-line summary
+        description     text,           -- problem description (long)
+        keywords        text,
+        CONSTRAINT ticket_pkey PRIMARY KEY(id)
+);
+
+CREATE TABLE ticket_change (
+        ticket          integer,
+        time            integer,
+        author          text,
+        field           text,
+        oldvalue        text,
+        newvalue        text,
+        CONSTRAINT ticket_change_pkey PRIMARY KEY(ticket, time, field)
+);
+
+CREATE TABLE ticket_custom (
+       ticket           integer,
+       name             text,
+       value            text,
+       CONSTRAINT ticket_custom_pkey PRIMARY KEY(ticket,name)
+);
+
+--CREATE SEQUENCE report_id_seq;
+CREATE TABLE report (
+        id              serial,
+        author          text,
+        title           text,
+        sql             text,
+        description     text,
+        CONSTRAINT report_pkey PRIMARY KEY(id)
+);
+
+CREATE TABLE permission (
+        username        text,           -- 
+        action          text,           -- allowable activity
+        CONSTRAINT permission_pkey PRIMARY KEY(username,action)
+);
+
+CREATE TABLE component (
+         name            text,
+         owner           text,
+         CONSTRAINT component_pkey PRIMARY KEY(name)
+);
+
+CREATE TABLE milestone (
+         name            text,
+         due             integer, -- Due date/time
+         completed       integer, -- Completed date/time
+         description     text,
+         CONSTRAINT milestone_pkey PRIMARY KEY(name)
+);
+
+CREATE TABLE version (
+         name            text,
+         time            integer,
+         CONSTRAINT version_pkey PRIMARY KEY(name)
+);
+
+CREATE TABLE wiki (
+         name            text,
+         version         integer,
+         time            integer,
+         author          text,
+         ipnr            text,
+         text            text,
+         comment         text,
+         readonly        integer,
+         CONSTRAINT wiki_pkey PRIMARY KEY(name,version)
+);
+
+CREATE TABLE attachment (
+         type            text,
+         id              text,
+         filename        text,
+         size            integer,
+         time            integer,
+         description     text,
+         author          text,
+         ipnr            text,
+         CONSTRAINT attachment_pkey PRIMARY KEY(type,id,filename)
+);
+
+CREATE TABLE session (
+         sid             text,
+         username        text,
+         var_name        text,
+         var_value       text,
+         CONSTRAINT session_pkey PRIMARY KEY(sid,var_name)
+);
+
+"""
+
-##
-## Default Reports
-##
@@ -293 +447 @@
-  FROM ticket t,enum p
-  WHERE p.name=t.priority AND p.type='priority'
-  ORDER BY (milestone IS NULL), milestone DESC, (status = 'closed'), 
-modified
+changetime
-"""),
-#----------------------------------------------------------------------------
-('My Tickets',
@@ -411 +565 @@
- (('trac', 'htdocs_location', '/trac/'),
-  ('trac', 'repository_dir', '/var/svn/myrep'),
-  ('trac', 'templates_dir', '/usr/lib/trac/templates'),
-db/trac.db
+"db/trac.db",timeout=10000
-  ('trac', 'default_charset', 'iso-8859-15'),
-  ('logging', 'log_type', 'none'),
-  ('logging', 'log_file', 'trac.log'),

trac/Search.py

@@ -117 +117 @@
-
-        cursor = self.db.cursor ()
-
+        # ugly 'cast' hack for sqlite vs other dbms
+        # and UNION ALL requiring like column datatypes
+        data_changeset = 'rev'
+        data_tickets = 'a.id'
+        dbms = self.env.dbms
+        if dbms != 'sqlite':
+            data_changeset = 'cast(rev as text)'
+            data_tickets = 'cast(a.id as text)'
+
-        q = []
-        if changeset:
-            q.append('SELECT 1 as type, message AS title, message, author, '
-rev
+%s
-                     ' FROM revision WHERE %s OR %s' % 
-
+
+
-                      self.query_to_sql(query, 'author')))
-        if tickets:
-            q.append('SELECT DISTINCT 2 as type, a.summary AS title, '
-                     ' a.description AS message, a.reporter AS author, '
-
-
-
-
-
+
+
+
+
+
+
-                       self.query_to_sql(query, 'summary'),
-                       self.query_to_sql(query, 'keywords'),
-                       self.query_to_sql(query, 'description'),

trac/Query.py

@@ -155 +155 @@
-        sql.append("\nFROM ticket")
-        for k in [k for k in cols if k in custom_fields]:
-           sql.append("\n  LEFT OUTER JOIN ticket_custom AS %s ON " \
-
+ tc
-
-        for col in [c for c in ['status', 'resolution', 'priority', 'severity']
-                    if c == self.order or c == self.group]:
-            sql.append("\n  LEFT OUTER JOIN (SELECT name AS %s_name, " \
-                                            "value AS %s_value " \
-
+ e
-                       " ON %s_name=%s" % (col, col, col, col, col))
-        for col in [c for c in ['milestone', 'version']
-                    if c == self.order or c == self.group]:
-            time_col = col == 'milestone' and 'due' or 'time'
-            sql.append("\n  LEFT OUTER JOIN (SELECT name AS %s_name, " \
-
+ a
-                       " ON %s_name=%s" % (col, time_col, col, col, col, col))
-
-        def get_constraint_sql(name, value, mode, neg):

trac/Report.py

@@ -111 +111 @@
-        self.perm.assert_permission(perm.REPORT_CREATE)
-
-        cursor = self.db.cursor()
-
-
-
+
+
+
+
-        self.db.commit()
-        req.redirect(self.env.href.report(id))
-

trac/tests/tracadmin-tests.txt

@@ -1 +1 @@
-===== test_help_ok =====
-%(version)s
+0.8
-
-Usage: trac-admin </path/to/projenv> [command [subcommand] [option ...]]
-
-Invoking trac-admin without command starts interactive mode.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
--- Set version date (Format: "%(date_format_hint)s
-
-
-
-
--- Set milestone due date (Format: "%(date_format_hint)s
--- Set milestone completed date (Format: "%(date_format_hint)s
-
+                      
+                      
+                      
+<dbms> [dbms options] 
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      
+                      -- Set version date (Format: "MM/DD/YY
+                      
+                      
+                      
+                      
+                      -- Set milestone due date (Format: "MM/DD/YY
+                      -- Set milestone completed date (Format: "MM/DD/YY
+                      
-
-Visit the Trac Project at http://trac.edgewall.com/
-

trac/tests/environment.py

@@ -36 +36 @@
-
-    def test_config(self):
-        """Testing env.get/set_config"""
-
+
+
-        self.env.set_config('foo', 'bar', 'baz')
-        self.env.save_config()
-        assert self.env.get_config('foo', 'bar') == 'baz'

trac/tests/query.py

@@ -35 +35 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,priority,milestone,component
-FROM ticket
-
+e 
-ORDER BY COALESCE(priority,'')='',priority_value,id""")
-
-    def test_all_ordered_by_priority_desc(self):
@@ -44 +44 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,priority,milestone,component
-FROM ticket
-
+e 
-ORDER BY COALESCE(priority,'')='' DESC,priority_value DESC,id""")
-
-    def test_all_ordered_by_version(self):
@@ -53 +53 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,priority,milestone,version
-FROM ticket
-
+a 
-ORDER BY COALESCE(version,'')='',COALESCE(version_time,0)=0,version_time,version,id""")
-
-    def test_all_ordered_by_version_desc(self):
@@ -62 +62 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,priority,milestone,version
-FROM ticket
-
+a 
-ORDER BY COALESCE(version,'')='' DESC,COALESCE(version_time,0)=0 DESC,version_time DESC,version DESC,id""")
-
-    def test_constrained_by_milestone(self):
@@ -81 +81 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,priority,component,version,milestone
-FROM ticket
-
+a 
-ORDER BY COALESCE(milestone,'')='',COALESCE(milestone_time,0)=0,milestone_time,milestone,COALESCE(id,0)=0,id""")
-
-    def test_all_grouped_by_milestone_desc(self):
@@ -90 +90 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,priority,component,version,milestone
-FROM ticket
-
+a 
-ORDER BY COALESCE(milestone,'')='' DESC,COALESCE(milestone_time,0)=0 DESC,milestone_time DESC,milestone DESC,COALESCE(id,0)=0,id""")
-
-    def test_grouped_by_priority(self):
@@ -99 +99 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,milestone,component,version,priority
-FROM ticket
-
+e 
-ORDER BY COALESCE(priority,'')='',priority_value,id""")
-
-    def test_constrained_by_milestone_not(self):
@@ -170 +170 @@
-        self.assertEqual(sql,
-"""SELECT id,summary,status,owner,priority,milestone,component, foo.value AS foo
-FROM ticket
-
+ tc
-WHERE COALESCE(foo,'')='something'
-ORDER BY COALESCE(id,0)=0,id""")
-

trac/tests/db.py

@@ +1 @@
+
+import unittest
+from trac.Environment import Environment # TODO: take out trac. when being run
+                                         #       from normal trac/test.py
+
+class DBTestBase:
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+class DBTestCase(DBTestBase, unittest.TestCase):
+    def test_connect(self):
+        """Testing db.connect"""
+        env = Environment('/var/trac/test')  # TODO: make more generic
+                                             # for now, it's my local pgsql env
+        cnx = env.get_db_cnx()
+        cursor = cnx.cursor()
+        cursor.execute("select * from system")
+        row = cursor.fetchone()
+        print row
+        cnx.close()
+
+    def test_parse_args(self):
+        """Testing db.parse_args"""
+        
+def suite():
+    return unittest.makeSuite(DBTestCase,'test')
+    
+# TODO: take this out when we put this in with the other tests
+# Q: will we be able to do these tests for different dbms's in the test suite?
+if __name__ == '__main__':
+    unittest.main(defaultTest='suite')
+        

trac/Session.py

@@ -64 +64 @@
-    def get_session(self, sid):
-        self.sid = sid
-        curs = self.db.cursor()
-
-self.sid
+ 
+(self.sid,)
-        rows = curs.fetchall()
-        if (not rows                              # No session data yet
-            or rows[0][0] == 'anonymous'          # Anon session

trac/db.py

@@ +1 @@
+# -*- coding: iso8859-1 -*-
+#
+# Copyright (C) 2005 Edgewall Software
+# Copyright (C) 2005 Brad Anderson <brad@dsource.org>
+#
+# Trac is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# Trac 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
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+# Author: Brad Anderson <brad@dsource.org>
+
+import os
+
+def get_cnx(db_str, path, check_exists):
+    pos = db_str.find(':')
+    if pos == -1:
+        raise EnvironmentError, 'Connection param must be of form ' \
+              '(db_module_name):(db_connect_params), the value "%s ' \
+              'does not match' % db_str
+    module_name = db_str[:pos]
+    connect_params = db_str[pos+1:].split(',')
+    
+    # TODO: factory here?
+    if module_name.lower() == 'sqlite':
+        conn = SQLiteDBConnection(module_name, connect_params, path, 
+                   check_exists)
+    elif module_name.lower() == 'pgsql':
+        conn = PostgreSQLDBConnection(module_name, connect_params, path, 
+                   check_exists)
+    else:
+        raise EnvironmentError, 'Unrecognized database in trac.ini: %s' \
+                                % module_name
+    return conn
+            
+
+class DBConnection:
+    
+    def __init__(self, module_name, connect_params, path, check_exists):
+        # set some variables
+        self.module_name = module_name
+        self.path = path
+        
+        # prepare the connection
+        self.parse_args(connect_params)
+        self.connect(check_exists)
+    
+    def __getattr__(self, name):
+        """DBConnection is a wrapper for the dbms's connection, and here's 
+           the magic that allows this."""
+        return getattr(self.db, name)
+
+    def parse_args(self, connect_params):
+        """very crude code for parsing the arguments in connect_params"""
+        kargs = {}
+        arg_list = []
+        for x in connect_params:
+            pos1 = x.find('=')
+            pos2 = x.find('"')
+            pos3 = x.find("'")
+            if pos1 > -1:
+                if pos2 > -1 and pos2 < pos1:
+                    arg_list.append(eval(x))
+                elif pos3 > -1 and pos3 < pos1:
+                    arg_list.append(eval(x))
+                else:
+                    name = x[:pos1].strip()
+                    value = eval(x[pos1+1:].strip())
+                    kargs[name] = value
+            else:
+                arg_list.append(eval(x))
+        self.args = tuple(arg_list)
+        self.kargs = kargs
+        
+        
+class SQLiteDBConnection(DBConnection):
+    """specific implementation of DBConnection for SQLite"""
+    
+    def connect(self, check_exists):
+
+        # since Trac has a slightly closer relationship with sqlite than
+        # other db's, there's a special case setup here so that when the
+        # path to the sqlite db is specified, its relative to TRAC_ENV
+        db_name = os.path.join(self.path, self.args[0])
+        args = list(self.args)
+        args[0] = '%s' % db_name
+        self.args = tuple(args)
+
+        # check to see if db exists
+        if check_exists == 1 and not os.access(db_name, os.F_OK):
+            raise EnvironmentError, 'Database "%s" not found.' % db_name
+        
+        # make sure db is readable/writable by web server user
+        directory = os.path.dirname(db_name)
+        if (check_exists == 1 and not os.access(db_name, os.R_OK + os.W_OK)) \
+            or not os.access(directory, os.R_OK + os.W_OK):
+            raise EnvironmentError, \
+                  'The web server user requires read _and_ write permission\n' \
+                  'to the database %s and the directory in which this file ' \
+                  'is located.' % db_name
+                          
+        # import database module
+        import_str = 'import sqlite'
+        exec import_str
+        m = eval('sqlite')
+        
+        # get connection
+        self.db = m.connect(*self.args, **self.kargs)
+
+    def get_last_id(self, table, field, cursor):
+        id = self.db.db.sqlite_last_insert_rowid()
+        return id
+
+
+class PostgreSQLDBConnection(DBConnection):
+    """specific implementation of DBConnection for PostgreSQL"""
+    
+    def connect(self, check_exists):
+        
+        # check to see if db exists
+        # TODO:
+        
+        # get strings for proper pgsql module (add more as needed)
+        if self.module_name == 'pgsql':
+            import_str = 'from pyPgSQL import PgSQL'
+            module_str = 'PgSQL'
+        else:
+            raise EnvironmentError, "Unknown PostgreSQL DB module '%s'" \
+                                    % self.module_name
+        
+        # import database module
+        exec import_str
+        m = eval(module_str)
+        
+        # get connection
+        self.db = m.connect(*self.args, **self.kargs)
+        
+    def get_last_id(self, table, field, cursor):
+        sql = "SELECT %s FROM %s " \
+              "WHERE %s = CURRVAL('%s_%s_seq')" \
+              % (field, table, field, table, field)
+        cursor.execute(sql)
+        id = cursor.fetchone()[0]
+        return id
+