Source

testman4trac / tracgenericclass / trunk / tracgenericclass / model.py

Full commit
   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
# -*- coding: utf-8 -*-
#
# Copyright (C) 2010-2012 Roberto Longobardi
# 
# This file is part of the Test Manager plugin for Trac.
# 
# The Test Manager plugin for 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 3 of the License, or (at your option) any later 
# version.
# 
# The Test Manager plugin for 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 the Test Manager plugin for Trac. See the file LICENSE.txt. 
# If not, see <http://www.gnu.org/licenses/>.
#

import copy
import re
import sys
import time
import traceback

from datetime import date, datetime

from trac.attachment import Attachment
from trac.core import *
from trac.db import Table, Column, Index
from trac.env import IEnvironmentSetupParticipant
from trac.resource import Resource, ResourceNotFound
from trac.util.datefmt import utc, utcmax
from trac.util.text import CRLF
from trac.util.translation import _, N_, gettext
from trac.wiki.api import WikiSystem
from trac.wiki.model import WikiPage
from trac.wiki.web_ui import WikiModule

from tracgenericclass.util import *


class IConcreteClassProvider(Interface):
    """
    Extension point interface for components willing to implement
    concrete classes based on this generic class framework.
    """

    def get_realms():
        """
        Return class realms provided by the component.

        :rtype: `basestring` generator
        """

    def get_data_models():
        """
        Return database tables metadata to allow the framework to create the
        db schema for the classes provided by the component.

        :rtype: a dictionary, which keys are schema names and values 
                are dictionaries with table metadata, as in the following example:
                return {'sample_realm':
                            {'table':
                                Table('samplerealm', key = ('id', 'otherid'))[
                                      Column('id'),
                                      Column('otherid'),
                                      Column('prop1'),
                                      Column('prop2'),
                                      Column('time', type='int64')],
                             'has_custom': True,
                             'has_change': True},
                       }
        """

    def get_fields():
        """
        Return the standard fields for classes in all the realms 
        provided by the component.

        :rtype: a dictionary, which keys are realm names and values 
                are arrays of fields metadata, as in the following example:
                return {'sample_realm': [
                            {'name': 'id', 'type': 'text', 'label': N_('ID')},
                            {'name': 'otherid', 'type': 'text', 'label': N_('Other ID')},
                            {'name': 'prop1', 'type': 'text', 'label': N_('Property 1')},
                            {'name': 'prop2', 'type': 'text', 'label': N_('Property 2')},
                            {'name': 'time', 'type': 'time', 'label': N_('Last Change')}
                       }
        """
        
    def get_metadata():
        """
        Return a set of metadata about the classes in all the realms 
        provided by the component.

        :rtype: a dictionary, which keys are realm names and values 
                are dictionaries of properties.
                
                Available metadata properties are:
                    label: A User-friendly name for the objects in this class.
                    searchable: If present and equal to True indicates the class
                                partecipates in the Trac search framework, and
                                must implement the get_search_results() method.
                    'has_custom': If present and equal to True indicates the class
                                  supports custom fields.
                    'has_change': If present and equal to True indicates the class
                                  supports property change history.
                    
                See the following example:
                return {'sample_realm': {
                                'label': "Sample Realm", 
                                'searchable': True
                            }
                       }
        """
        
    def create_instance(realm, props=None):
        """
        Return an instance of the specified realm, with the specified properties,
        or an empty object if props is None.

        :rtype: `AbstractVariableFieldsObject` sub-class instance
        """


    def check_permission(req, realm, key_str=None, operation='set', name=None, value=None):
        """
        Checks whether the logged in User has permission to perform
        the specified operation on a resource of the specified realm and 
        optionally with the specified key.
        
        Raise an exception if authorization is denied.
        
        Possible operations are:
            'set': set a property with a value. 'name' and 'value' parameters are required.
            'search': search for objects of this class.
        
        :param key_str: optional, the object's key, in the form of a string representing 
                        a dictionary. To get a dictionary back from this string, use the 
                        get_dictionary_from_string() function in the
                        tracgenericclass.util package.
        :param operation: optional, the operation to be performed on the object.
        :param name: optional property name, valid for the 'set' operation type
        :param value: optional property value, valid for the 'set' operation type
        """

        
class AbstractVariableFieldsObject(object):
    """ 
    An object which fields are declaratively specified.
    
    The specific object "type" is specified during construction
    as the "realm" parameter.
    This name must also correspond to the database table storing the
    corresponding objects, and is used as the base name for the 
    custom fields table and the change tracking table (see below).
    
    Features:
        * Support for custom fields, specified in the trac.ini file
          with the same syntax as for custom Ticket fields. Custom
          fields are kept in a "<schema>_custom" table
        * Keeping track of all changes to any field, into a separate
          "<schema>_change" table
        * A set of callbacks to allow for subclasses to control and 
          perform actions pre and post any operation pertaining the 
          object's lifecycle
        * Registering listeners, via the IGenericObjectChangeListener
          interface, for object creation, modification and deletion.
        * Searching objects matching any set of valorized fields,
          (even non-key fields), applying the "dynamic record" pattern. 
          See the method list_matching_objects.
    
    Notes on special fields:
    
        self.exists : always tells whether the object currently exists 
                      in the database.
                      
        self.resource: points to a Resource, in the trac environment,
                       corresponding to this object. This is used, for 
                       example, in the workflow implementation.
                       
        self.fields: points to an array of dictionary objects describing
                     name, label, type and other properties of all of
                     this object's fields.
                     
        self.metadata: points to a dictionary object describing 
                       further meta-data about this object.
    
    Note: database tables for specific realms are supposed to already
          exist, this object does not create any tables.
          See below the GenericClassModelProvider to see how to 
          declaratively create the required tables.
    """

    def __init__(self, env, realm='variable_fields_obj', key=None, db=None):
        """
        Creates an empty object and also tries to fetches it from the 
        database, if an object with a matching key is found.
        
        To create an empty, template object, do not specify a key.
        
        To create an object to be later stored in the database:
           1) specify a key at contruction time
           2) set any other property via the obj['fieldname'] = value
              syntax, including custom fields
           3) call the insert() method.
           
        To fetch an existing object from the database:
           1) specify a key at contruction time: the object will be 
            filled with all of the values form the database
           2) modify any other property via the obj['fieldname'] = value
              syntax, including custom fields. This syntax is the only
              one to keep track of the changes to any field
           3) call the save_changes() method.
        """
        self.env = env

        self.exists = False
        
        self.realm = realm
        
        tmmodelprovider = GenericClassModelProvider(self.env)
        
        self.fields = tmmodelprovider.get_fields(realm)
        self.time_fields = [f['name'] for f in self.fields
                            if f['type'] == 'time']

        self.metadata = tmmodelprovider.get_metadata(realm)

        if key is not None and len(key) > 0:
            self.key = key
            self.resource = Resource(realm, self.gey_key_string())
        else:
            self.resource = None
            
        if not key or not self._fetch_object(key, db):
            self._init_defaults(db)
            self.exists = False

        self.env.log.debug("Exists: %s" % self.exists)
        self.env.log.debug(self.values)
        
        self._old = {}

    def get_key_prop_names(self):
        """
        Returns an array with the fields representing the identity
        of this object. 
        The specified fields are assumed being also part of the 
        self.fields array.
        The specified fields are also assumed to correspond to
        columns with same name in the database table.
        """
        return ['id']
        
    def get_key_prop_values(self):
        """
        Returns an array of values for the properties returned by
        get_key_prop_names.
        """
        result = []

        for f in self.get_key_prop_names():
             result.append(self.values[f])
             
        return result

    def get_resource_id(self):
        """
        Returns a string representation of the object's identity.
        Used with the trac Resource API.
        """
        return [str(self.values[f])+'|' for f in self.get_key_prop_names()]
        
    def _init_defaults(self, db=None):
        """ 
        Initializes default values for a new object, based on
        default values specified in the trac.ini file.
        """
        for field in self.fields:
            default = None
            if field['name'] in self.protected_fields:
                # Ignore for new - only change through workflow
                pass
            elif not field.get('custom'):
                default = self.env.config.get(self.realm,
                                              'default_' + field['name'])
            else:
                default = field.get('value')
                options = field.get('options')
                if default and options and default not in options:
                    try:
                        default = options[int(default)]
                    except (ValueError, IndexError):
                        self.env.log.warning('Invalid default value "%s" '
                                             'for custom field "%s"'
                                             % (default, field['name']))
            if default:
                self.values.setdefault(field['name'], default)

    def _fetch_object(self, key, db=None):
        self.env.log.debug('>>> _fetch_object')
    
        if db is None:
            db = get_db(self.env, db)
        
        if not self.pre_fetch_object(db):
            return
        
        row = None

        # Fetch the standard fields
        std_fields = [f['name'] for f in self.fields
                      if not f.get('custom')]
        cursor = db.cursor()

        sql_where = "WHERE 1=1"
        for k in self.get_key_prop_names():
            sql_where += " AND " + k + "=%%s" 

        self.env.log.debug("Searching for %s: %s" % (self.realm, sql_where))
        for k in self.get_key_prop_names():
            self.env.log.debug("%s = %s" % (k, self[k]))
        
        cursor.execute(("SELECT %s FROM %s " + sql_where)
                       % (','.join(std_fields), self.realm), self.get_key_prop_values())
        row = cursor.fetchone()

        if not row:
            #raise ResourceNotFound(_('The specified object of type %(realm)s does not exist.', 
            #                         realm=self.realm), _('Invalid object key'))
            self.env.log.debug("Object NOT found.")
            return False

        self.env.log.debug("Object found.")
            
        self.key = self.build_key_object()
        for i, field in enumerate(std_fields):
            value = row[i]
            if field in self.time_fields:
                self.values[field] = from_any_timestamp(value)
            elif value is None:
                self.values[field] = '0'
            else:
                self.values[field] = value

        # Fetch custom fields if available
        custom_fields = [f['name'] for f in self.fields if f.get('custom')]
        if len(custom_fields) > 0:
            cursor.execute(("SELECT name,value FROM %s_custom " + sql_where)
                           % self.realm, self.get_key_prop_values())

            for name, value in cursor:
                if name in custom_fields:
                    if value is None:
                        self.values[name] = '0'
                    else:
                        self.values[name] = value

        self.post_fetch_object(db)
        
        self.exists = True

        self.env.log.debug('<<< _fetch_object')
        return True
        
    def build_key_object(self):
        """
        Builds and returns a dictionary object with the key properties,
        as returned by get_key_prop_names.
        """
        key = None
        for k in self.get_key_prop_names():
            if (self.values[k] is not None):
                if key is None:
                    key = {}

                key[k] = self.values[k]
        
        return key

    def gey_key_string(self):
        """
        Returns a JSON string with the object key properties
        """
        return get_string_from_dictionary(self.key)

    def get_values_as_string(self, props):
        """
        Returns a JSON string for the specified object properties.
        
        :param props: An array of field names. 
        """
        return get_string_from_dictionary(props, self.values)

    def __getitem__(self, name):
        """
        Allows for using the syntax "obj['fieldname']" to access this
        object's values.
        """
        return self.values.get(name)

    def __setitem__(self, name, value):
        """
        Allows for using the syntax "obj['fieldname']" to access this
        object's values.
        Also logs object modifications so the table <realm>_change 
        can be updated.
        """
        if name in self.values:
            self.env.log.debug("Value before: %s" % self.values[name])
            
        if name in self.values and self.values[name] == value:
            return
        if name not in self._old: # Changed field
            self.env.log.debug("Changing field value.")
            self._old[name] = self.values.get(name)
        elif self._old[name] == value: # Change of field reverted
            del self._old[name]
        if value:
            if isinstance(value, list):
                raise TracError(_("Multi-values fields not supported yet"))
            field = [field for field in self.fields if field['name'] == name]
            if field and field[0].get('type') == 'text':
                value = value.strip()
        self.values[name] = value
        self.env.log.debug("Value after: %s" % self.values[name])

    def get_value_or_default(self, name):
        """
        Return the value of a field or the default value if it is undefined
        """
        try:
            value = self.values[name]
            if value is not '0':
                return value
            field = [field for field in self.fields if field['name'] == name]
            if field:
                return field[0].get('value', '')
        except KeyError:
            pass
        
    def populate(self, values):
        """
        Populate the object with 'suitable' values from a dictionary
        """
        field_names = [f['name'] for f in self.fields]
        for name in [name for name in values.keys() if name in field_names]:
            self[name] = values.get(name, '')

        # We have to do an extra trick to catch unchecked checkboxes
        for name in [name for name in values.keys() if name[9:] in field_names
                     and name.startswith('checkbox_')]:
            if name[9:] not in values:
                self[name[9:]] = '0'

    def insert(self, when=None, db=None):
        """
        Add object to database.
        
        Parameters:
            When: a datetime object to specify a creation date.
        
        The `db` argument is deprecated in favor of `with_transaction()`.
        """
        self.env.log.debug('>>> insert')

        assert not self.exists, 'Cannot insert an existing object'

        db, handle_ta = get_db_for_write(self.env, db)

        # Add a timestamp
        if when is None:
            when = datetime.now(utc)
        self.values['time'] = self.values['changetime'] = when

        # Perform type conversions
        self.env.log.debug('  Performing type conversions')
        values = dict(self.values)
        for field in self.time_fields:
            if field in values:
                values[field] = to_any_timestamp(values[field])
        
        # Insert record
        self.env.log.debug('  Getting fields')
        std_fields = []
        custom_fields = []
        for f in self.fields:
            fname = f['name']
            if fname in self.values:
                if f.get('custom'):
                    custom_fields.append(fname)
                else:
                    std_fields.append(fname)

        if not self.pre_insert(db):
            return

        self.env.log.debug('  Inserting record')
        cursor = db.cursor()
        cursor.execute("INSERT INTO %s (%s) VALUES (%s)"
                       % (self.realm,
                          ','.join(std_fields),
                          ','.join(['%s'] * len(std_fields))),
                       [values[name] for name in std_fields])

        # Insert custom fields
        key_names = self.get_key_prop_names()
        key_values = self.get_key_prop_values()
        if len(custom_fields) > 0:
            self.env.log.debug('  Inserting custom fields')
            cursor.executemany("""
            INSERT INTO %s_custom (%s,name,value) VALUES (%s,%%s,%%s)
            """ 
            % (self.realm, 
               ','.join(key_names),
               ','.join(['%s'] * len(key_names))),
            [to_list((key_values, name, self[name])) for name in custom_fields])

        self.post_insert(db)
                
        if handle_ta:
            db.commit()

        self.env.log.debug('  Setting up internal fields')
        self.exists = True
        self.resource = self.resource(id=self.get_resource_id())
        self._old = {}

        self.env.log.debug('  Calling listeners')
        from tracgenericclass.api import GenericClassSystem
        for listener in GenericClassSystem(self.env).change_listeners:
            listener.object_created(self.realm, self)

        self.env.log.debug('<<< insert')
        return self.key

    def save_changes(self, author=None, comment=None, when=None, db=None, cnum=''):
        """
        Store object changes in the database. The object must already exist in
        the database.  Returns False if there were no changes to save, True
        otherwise.
        
        The `db` argument is deprecated in favor of `with_transaction()`.
        """
        self.env.log.debug('>>> save_changes')
        assert self.exists, 'Cannot update a new object'

        if not self._old and not comment:
            return False # Not modified

        db, handle_ta = get_db_for_write(self.env, db)

        if when is None:
            when = datetime.now(utc)
        when_ts = to_any_timestamp(when)

        if not self.pre_save_changes(db):
            return
        
        cursor = db.cursor()

        # store fields
        custom_fields = [f['name'] for f in self.fields if f.get('custom')]
        
        key_names = self.get_key_prop_names()
        key_values = self.get_key_prop_values()
        sql_where = '1=1'
        for k in key_names:
            sql_where += " AND " + k + "=%%s" 

        for name in self._old.keys():
            if name in custom_fields:
                cursor.execute(("""
                    SELECT * FROM %s_custom 
                    WHERE name=%%s AND 
                    """ + sql_where) % self.realm, to_list((name, key_values)))
                    
                if cursor.fetchone():
                    cursor.execute(("""
                        UPDATE %s_custom SET value=%%s
                        WHERE name=%%s AND 
                        """ + sql_where) % self.realm, to_list((self[name], name, key_values)))
                else:
                    cursor.execute("""
                        INSERT INTO %s_custom (%s,name,value) 
                        VALUES (%s,%%s,%%s)
                        """ 
                        % (self.realm, 
                        ','.join(key_names),
                        ','.join(['%s'] * len(key_names))),
                        to_list((key_values, name, self[name])))
            else:
                cursor.execute(("""
                    UPDATE %s SET %s=%%s WHERE 
                    """ + sql_where) 
                    % (self.realm, name),
                    to_list((self[name], key_values)))
            
            if self.metadata['has_change']:
                cursor.execute(("""
                    INSERT INTO %s_change
                        (%s, time,author,field,oldvalue,newvalue)
                    VALUES (%s, %%s, %%s, %%s, %%s, %%s)
                    """
                    % (self.realm, 
                    ','.join(key_names),
                    ','.join(['%s'] * len(key_names)))),
                    to_list((key_values, when_ts, author, name, 
                    self._old[name], self[name])))
        
        self.post_save_changes(db)

        if handle_ta:
            db.commit()

        old_values = self._old
        self._old = {}
        self.values['changetime'] = when

        from tracgenericclass.api import GenericClassSystem
        for listener in GenericClassSystem(self.env).change_listeners:
            listener.object_changed(self.realm, self, comment, author, old_values)

        self.env.log.debug('<<< save_changes')
        return True

    def delete(self, db=None):
        """
        Delete the object. Also clears the change history and the
        custom fields.
        
        The `db` argument is deprecated in favor of `with_transaction()`.
        """

        self.env.log.debug('>>> delete')

        db, handle_ta = get_db_for_write(self.env, db)

        if not self.pre_delete(db):
            return
            
        #Attachment.delete_all(self.env, 'ticket', self.id, db)

        cursor = db.cursor()

        key_names = self.get_key_prop_names()
        key_values = self.get_key_prop_values()

        sql_where = 'WHERE 1=1'
        for k in key_names:
            sql_where += " AND " + k + "=%%s" 

        self.env.log.debug("Deleting %s: %s" % (self.realm, sql_where))
        for k in key_names:
            self.env.log.debug("%s = %s" % (k, self[k]))
                       
        cursor.execute(("DELETE FROM %s " + sql_where)
            % self.realm, key_values)
            
        if self.metadata['has_change']:
            cursor.execute(("DELETE FROM %s_change " + sql_where)
                % self.realm, key_values)

        if self.metadata['has_custom']:
            custom_fields = [f['name'] for f in self.fields if f.get('custom')]
            if len(custom_fields) > 0:
                cursor.execute(("DELETE FROM %s_custom " + sql_where) 
                    % self.realm, key_values)

        self.post_delete(db)
                
        if handle_ta:
            db.commit()

        from tracgenericclass.api import GenericClassSystem
        for listener in GenericClassSystem(self.env).change_listeners:
            listener.object_deleted(self.realm, self)
        
        self.exists = False
        self.env.log.debug('<<< delete')

    def save_as(self, new_key, when=None, db=None):
        """
        Saves (a copy of) the object with different key.
        The previous object is not deleted, so if needed it must be
        deleted explicitly.
        """
        self.env.log.debug('>>> save_as')

        db, handle_ta = get_db_for_write(self.env, db)

        old_key = self.key
        if self.pre_save_as(old_key, new_key, db):
            self.key = new_key
        
            # Copy values from key into corresponding self.values field
            for f in self.get_key_prop_names():
                 self.values[f] = new_key[f]

            self.exists = False

            # Create object with new key
            self.insert(when, db)
        
            self.post_save_as(old_key, new_key, db)

            if handle_ta:
                db.commit()

        self.env.log.debug('<<< save_as')
        
    def list_change_history(self, db=None):
        """
        Returns an ordered list of all the changes to standard and
        custom field, with the old and new value, along with timestamp
        and author, starting from the most recent.
        """
        self.env.log.debug('>>> list_change_history')

        if self.metadata['has_change']:
            std_fields = [f['name'] for f in self.fields
                          if not f.get('custom')]

            sql_where = "WHERE 1=1"
            for k in self.get_key_prop_names():
                sql_where += " AND " + k + "=%%s" 

            if db is None:
                db = get_db(self.env, db)

            cursor = db.cursor()

            cursor.execute(("SELECT time,author,field,oldvalue,newvalue FROM %s_change " + sql_where+ " ORDER BY time DESC")
                           % self.realm, self.get_key_prop_values())

            for ts, author, fname, oldvalue, newvalue in cursor:
                yield ts, author, fname, oldvalue, newvalue

        self.env.log.debug('<<< list_change_history')

    def get_non_empty_prop_names(self):
        """
        Returns a list of names of the fields that are not None.
        """
        std_field_names = []
        custom_field_names = []

        for field in self.fields:
            n = field.get('name')

            if n in self.values and self.values[n] is not None:
                if not field.get('custom'):
                    std_field_names.append(n)
                else:
                    custom_field_names.append(n)
                
        return std_field_names, custom_field_names
        
    def get_values(self, prop_names):
        """ 
        Returns a list of the values for the specified properties,
        in the same order as the property names.
        """
        result = []
        
        for n in prop_names:
            result.append(self.values[n])
                
        return result
                
    def set_values(self, props):
        """
        Sets multiple properties into this object.
        
        Note: this method does not keep history of property changes.
        """
        for n in props:
            self.values[n] = props[n]
                
    def _get_key_from_row(self, row):
        """
        Given a database row with the key properties, builds a 
        dictionary with this object's key.
        """
        key = {}
        
        for i, f in enumerate(self.get_key_prop_names()):
            key[f] = row[i]

        return key
        
    def create_instance(self, key):
        """ 
        Subclasses should override this method to create an instance
        of them with the specified key.
        """
        pass
            
    def list_matching_objects(self, exact_match=True, operator=None, db=None):
        """
        List the objects that match the current values of this object's
        fields.
        To use this method, first create an instance with no key, then
        fill some of its fields with the values you want to find a 
        match on, then call this method.
        A collection of objects found in the database matching the 
        fields you had provided values for will be returned.
        An exact match, i.e. an SQL '=' operator, will be used, unless you
        specify exact_match=False, in which case the SQL 'LIKE' operator
        will be used.
        
        The `db` argument is deprecated in favor of `with_transaction()`.
        """
        self.env.log.debug('>>> list_matching_objects')
        
        if db is None:
            db = get_db(self.env, db)

        self.pre_list_matching_objects(db)

        cursor = db.cursor()

        non_empty_std_names, non_empty_custom_names = self.get_non_empty_prop_names()
        
        non_empty_std_values = self.get_values(non_empty_std_names)
        non_empty_custom_values = self.get_values(non_empty_custom_names)

        if operator == None:
            operator = '='
            if not exact_match:
                operator = ' LIKE '
        
        sql_where = '1=1'
        for k in non_empty_std_names:
            sql_where += " AND " + k + operator + '%%s'
        
        cursor.execute(('SELECT %s FROM %s WHERE ' + sql_where)
                       % (','.join(self.get_key_prop_names()), self.realm), 
                       non_empty_std_values)

        for row in cursor:
            key = self._get_key_from_row(row)
            self.env.log.debug('<<< list_matching_objects - returning result')
            yield self.create_instance(key)

        self.env.log.debug('<<< list_matching_objects')
       
    def get_search_results(self, req, terms, filters):
        """
        Called in the context of the trac search API, to return a list
        of objects of this class matching the specified terms.
        
        Concrete classes should override this method to perform class-specific
        searches.
        """
        if False:
            yield None

    # Following is a set of callbacks allowing subclasses to perform
    # actions around the operations that pertain the lifecycle of 
    # this object.
    
    def pre_fetch_object(self, db):
        """ 
        Use this method to perform initialization before fetching the
        object from the database.
        Return False to prevent the object from being fetched from the 
        database.
        """
        return True

    def post_fetch_object(self, db):
        """
        Use this method to further fulfill your object after being
        fetched from the database.
        """
        pass
        
    def pre_insert(self, db):
        """ 
        Use this method to perform work before inserting the
        object into the database.
        Return False to prevent the object from being inserted into the 
        database.
        """
        return True

    def post_insert(self, db):
        """
        Use this method to perform further work after your object has
        been inserted into the database.
        """
        pass
        
    def pre_save_changes(self, db):
        """ 
        Use this method to perform work before saving the object changes
        into the database.
        Return False to prevent the object changes from being saved into 
        the database.
        """
        return True

    def post_save_changes(self, db):
        """
        Use this method to perform further work after your object 
        changes have been saved into the database.
        """
        pass
        
    def pre_delete(self, db):
        """ 
        Use this method to perform work before deleting the object from 
        the database.
        Return False to prevent the object from being deleted from the 
        database.
        """
        return True

    def post_delete(self, db):
        """
        Use this method to perform further work after your object 
        has been deleted from the database.
        """
        pass
        
    def pre_save_as(self, old_key, new_key, db):
        """ 
        Use this method to perform work before saving the object with
        a different identity into the database.
        Return False to prevent the object from being saved into the 
        database.
        """
        return True
        
    def post_save_as(self, old_key, new_key, db):
        """
        Use this method to perform further work after your object 
        has been saved into the database.
        """
        pass
        
    def pre_list_matching_objects(self, db):
        """ 
        Use this method to perform work before finding matches in the 
        database.
        Return False to prevent the search.
        """
        return True


class AbstractWikiPageWrapper(AbstractVariableFieldsObject):
    """
    This subclass is a generic object that is based on a wiki page,
    identified by the 'page_name' field.
    The wiki page lifecycle is managed along with the normal object's
    one.     
    """
    def __init__(self, env, realm='wiki_wrapper_obj', key=None, db=None):
        AbstractVariableFieldsObject.__init__(self, env, realm, key, db)
    
    def post_fetch_object(self, db):
        self.wikipage = WikiPage(self.env, self.values['page_name'])
    
    def delete(self, del_wiki_page=True, db=None):
        """
        Delete the object. Also deletes the Wiki page if so specified in the parameters.
        
        The `db` argument is deprecated in favor of `with_transaction()`.
        """
        
        # The actual wiki page deletion is delayed until pre_delete.
        self.del_wiki_page = del_wiki_page
        
        AbstractVariableFieldsObject.delete(self, db)
        
    def pre_insert(self, db):
        """ 
        Assuming the following fields have been given a value before this call:
        text, author, remote_addr, values['page_name']
        """
        
        wikipage = WikiPage(self.env, self.values['page_name'])
        wikipage.text = self.text
        wikipage.save(self.author, '', self.remote_addr)
        
        self.wikipage = wikipage
        
        return True

    def pre_save_changes(self, db):
        """ 
        Assuming the following fields have been given a value before this call:
        text, author, remote_addr, values['page_name']
        """
        
        wikipage = WikiPage(self.env, self.values['page_name'])
        wikipage.text = self.text
        wikipage.save(self.author, '', self.remote_addr)
    
        self.wikipage = wikipage

        return True

    def pre_delete(self, db):
        """ 
        Assuming the following fields have been given a value before this call:
        values['page_name']
        """
        
        if self.del_wiki_page:
            wikipage = WikiPage(self.env, self.values['page_name'])
            wikipage.delete()
            
        self.wikipage = None
        
        return True


    def get_search_results(self, req, terms, filters):
        """
        Currently delegates the search to the Wiki module. 
        """
        for result in WikiModule(self.env).get_search_results(req, terms, ('wiki',)):
            yield result


class GenericClassModelProvider(Component):
    """
    This class provides a factory for generic classes and derivatives.
    
    The actual data model on the db is created starting from the
    SCHEMA declaration below.
    For each table, we specify whether to create also a '_custom' and
    a '_change' table.
    
    This class also provides the specification of the available fields
    for each class, being them standard fields and the custom fields
    specified in the trac.ini file.
    The custom field specification follows the same syntax as for
    Tickets.
    Currently, only 'text' type of fields are supported.
    """
    implements(IEnvironmentSetupParticipant)

    class_providers = ExtensionPoint(IConcreteClassProvider)
    
    all_fields = {}
    all_custom_fields = {}
    all_metadata = {}
    
    _class_providers_map = None

    # Class providers managament
    def get_class_provider(self, realm):
        """
        Return the component responsible for providing the specified
        concrete class implementation.

        :param  realm: the realm which uniquely identifies the class.
        :return: a `Component` implementing `IConcreteClassProvider`
                 or `None`
        """
        # build a dict of realm keys to IConcreteClassProvider
        # implementations
        if not self._class_providers_map:
            map = {}
            for provider in self.class_providers:
                for r in provider.get_realms() or []:
                    self.env.log.debug("Mapping realm %s to provider %s" % (r, provider))
                    map[r] = provider
            self._class_providers_map = map
        
        if realm in self._class_providers_map:
            return self._class_providers_map.get(realm)
        else:
            return None

    def get_known_realms(self):
        """
        Return a list of all the realm names of registered
        class providers.
        """
        realms = []
        for provider in self.class_providers:
            for realm in provider.get_realms() or []:
                realms.append(realm)
                
        return realms


    # Factory method
    def get_object(self, realm, key=None):
        """
        Returns an instance of the specified class (by means of its 
        realm name), with the specified key.
        """
        obj = None
        
        provider = self.get_class_provider(realm)
        self.env.log.debug("Provider for realm %s is %s" % (realm, provider))

        if provider:
            self.env.log.debug("Object key is %s" % key)
            return provider.create_instance(realm, key)
        else:
            self.env.log.debug("Provider for realm %s not found" % realm)
            return None


    # Permission check
    def check_permission(self, req, realm, key_str=None, operation='set', name=None, value=None):
        """
        Checks whether the logged in User has permission to perform
        the specified operation on a resource of the specified realm and 
        optionally with the specified key.
        
        Raise an exception if authorization is denied.

        Actually delegates to the concrete class provider the permission check.

        See the IConcreteClassProvider method with the same name for more details
        about the available operations and the function parameters.
        """

        provider = self.get_class_provider(realm)
        if provider is not None:
            provider.check_permission(req, realm, key_str, operation, name, value)

            
    # Fields management
    def reset_fields(self):
        """
        Invalidate field cache.
        """
        self.all_fields = {}
        
    def get_fields(self, realm):
        self.env.log.debug(">>> get_fields")
        
        if realm not in self.fields():
            raise TracError("Requested field information not found for class %s." % realm)
            
        fields = copy.deepcopy(self.fields()[realm])
        #label = 'label' # workaround gettext extraction bug
        #for f in fields:
        #    f[label] = gettext(f[label])

        self.env.log.debug("<<< get_fields")
        return fields
        
    def get_metadata(self, realm):
        tmp_metadata = self.metadata()
        if realm in tmp_metadata:
            metadata = copy.deepcopy(tmp_metadata[realm])
        else:
            metadata = None

        return metadata
        
    def fields(self, refresh=False):
        """Return the list of fields available for every realm."""

        if refresh or not self.all_fields:
            fields = {}

            for provider in self.class_providers:
                realm_fields = provider.get_fields()
                for realm in realm_fields:
                    tmp_fields = realm_fields[realm]

                    self.append_custom_fields(tmp_fields, self.get_custom_fields_for_realm(realm))

                    fields[realm] = tmp_fields

            self.all_fields = fields

            # Print debug information about all known realms and fields
            for r in self.all_fields:
                self.env.log.debug("Fields for realm %s:" % r)
                for f in self.all_fields[r]:
                    self.env.log.debug("   %s : %s" % (f['name'], f['type']))
                    if 'custom' in f:
                        self.env.log.debug("     (custom)")

        return self.all_fields
        
    def metadata(self):
        """Return metadata information about concrete classes."""

        if not self.all_metadata:
            metadata = {}

            for provider in self.class_providers:
                realm_metadata = provider.get_metadata()
                for realm in realm_metadata:
                    metadata[realm] = realm_metadata[realm]

            self.all_metadata = metadata

        return self.all_metadata

    def append_custom_fields(self, fields, custom_fields):
        if len(custom_fields) > 0:
            for f in custom_fields:
                fields.append(f)
        
    def get_custom_fields_for_realm(self, realm):
        fields = []
    
        for field in self.get_custom_fields(realm):
            field['custom'] = True
            fields.append(field)
            
        return fields

    def get_custom_fields(self, realm):
        return copy.deepcopy(self.custom_fields(realm))

    def custom_fields(self, realm, refresh=False):
        """Return the list of available custom fields."""
        
        if refresh or not realm in self.all_custom_fields:
            fields = []
            config = self.config[realm+'-tm_custom']

            self.env.log.debug(config.options())
    
            for name in [option for option, value in config.options()
                         if '.' not in option]:
                if not re.match('^[a-zA-Z][a-zA-Z0-9_]+$', name):
                    self.log.warning('Invalid name for custom field: "%s" '
                                     '(ignoring)', name)
                    continue

                self.env.log.debug("  Option: %s" % name)
                         
                field = {
                    'name': name,
                    'type': config.get(name),
                    'order': config.getint(name + '.order', 0),
                    'label': config.get(name + '.label') or name.capitalize(),
                    'value': config.get(name + '.value', '')
                }
                if field['type'] == 'select' or field['type'] == 'radio':
                    field['options'] = config.getlist(name + '.options', sep='|')
                    if '' in field['options']:
                        field['optional'] = True
                        field['options'].remove('')
                elif field['type'] == 'text':
                    field['format'] = config.get(name + '.format', 'plain')
                elif field['type'] == 'textarea':
                    field['format'] = config.get(name + '.format', 'plain')
                    field['width'] = config.getint(name + '.cols')
                    field['height'] = config.getint(name + '.rows')
                fields.append(field)

            fields.sort(lambda x, y: cmp(x['order'], y['order']))
            
            self.all_custom_fields[realm] = fields
            
        return self.all_custom_fields[realm]



    # IEnvironmentSetupParticipant methods
    def environment_created(self):
        self.upgrade_environment(get_db(self.env))

    def environment_needs_upgrade(self, db):
        return (self._need_initialization(db) or self._need_upgrade(db))

    def upgrade_environment(self, db):
        # Create db
        if self._need_initialization(db):
            try:
                try:
                    from trac.db import DatabaseManager
                    db_backend, _ = DatabaseManager(self.env)._get_connector()
                except ImportError:
                    db_backend = self.env.get_db_cnx()

                cursor = db.cursor()

                # Create base table
                self.env.log.info("Creating table tracgenericclassconfig...")
                tablem = Table('tracgenericclassconfig', key = ('propname'))[
                          Column('propname'),
                          Column('value')]
                for stmt in db_backend.to_sql(tablem):
                    self.env.log.debug(stmt)
                    cursor.execute(stmt)

                db.commit()

                # Create default values for configuration properties and initialize counters
                db_set_config_property(self.env, 'tracgenericclassconfig', 'tracgenericclass_dbversion', '1')
                
                db.commit()
            except:
                db.rollback()
                self.env.log.error("Exception during upgrade")
                raise

    def _need_initialization(self, db):
        return self._need_upgrade(db)

    def _need_upgrade(self, db):
        # Check for configuration table
        cursor = db.cursor()
        try:
            cursor.execute("select count(*) from tracgenericclassconfig")
            cursor.fetchone()
            
            return False
        except:
            db.rollback()
            self.env.log.info("Need to create db table 'tracgenericclassconfig'.")
            return True


# Methods to help components create their databases
def need_db_upgrade(env, schema, db):
    """
    Obsolete method.
    """
    return False

def upgrade_db(env, schema, db):
    """
    Obsolete method.
    """
    pass

def need_db_create_for_realm(env, realm, realm_metadata, db):
    """
    Call this method from inside your Component IEnvironmentSetupParticipant's
    environment_needs_upgrade() function to check whether your Component 
    using the generic classes needs to create the corresponding database tables.
    
    :param tablename: The db table that, if missing, means that the database 
                   must be created. 
    """
    table_metadata = realm_metadata['table']
    tablename = table_metadata.name

    cursor = db.cursor()
    try:
        cursor.execute("select count(*) from %s" % tablename)
        cursor.fetchone()
        
        return False
    except:
        db.rollback()
        return True

def need_db_upgrade_for_realm(env, realm, realm_metadata, db=None):
    """
    Call this method from inside your Component IEnvironmentSetupParticipant's
    environment_needs_upgrade() function to check whether your Component 
    using the generic classes needs to update the corresponding database tables.
    
    :param schema: The db schema definition, as returned by 
                   the get_data_models() function in the IConcreteClassProvider
                   interface.
    """
    cursor = db.cursor()
    try:
        table_metadata = realm_metadata['table']
        version = realm_metadata['version']

        dbversion = db_get_config_property(env, 'tracgenericclassconfig', realm + "_dbversion")
        if dbversion is None:
            dbversion = '1'
        
        if int(dbversion) < version:
            return True
        
    except:
        db.rollback()
        env.log.debug("Need to create db tables for class '%s'." % realm)
        return True


def create_db_for_realm(env, realm, realm_metadata, db, do_commit=True):
    """
    Call this method from inside your Component IEnvironmentSetupParticipant's
    upgrade_environment() function to create the database tables corresponding to
    your Component's generic classes.
    
    :param schema: The db schema definition, as returned by 
                   the get_data_models() function in the IConcreteClassProvider
                   interface.
    """
    try:
        try:
            from trac.db import DatabaseManager
            db_backend, _ = DatabaseManager(env)._get_connector()
        except ImportError:
            db_backend = env.get_db_cnx()

        env.log.info("Creating DB for class '%s'." % realm)
            
        # Create the required tables
        table_metadata = realm_metadata['table']
        version = realm_metadata['version']
        tablename = table_metadata.name
        
        cursor = db.cursor()
        key_names = [k for k in table_metadata.key]
        
        # Create base table
        env.log.info("Creating base table %s..." % tablename)
        for stmt in db_backend.to_sql(table_metadata):
            env.log.debug(stmt)
            cursor.execute(stmt)

        # Create custom fields table if required
        if realm_metadata['has_custom']:
            cols = []
            for k in key_names:
                # Determine type of column k
                type = 'text'
                for c in table_metadata.columns:
                    if c.name == k:
                        type = c.type
                        
                cols.append(Column(k, type=type))
                
            cols.append(Column('name'))
            cols.append(Column('value'))
            
            custom_key = copy.deepcopy(key_names)
            custom_key.append('name')
            
            table_custom = Table(tablename+'_custom', key = custom_key)[cols]
            env.log.info("Creating custom properties table %s..." % table_custom.name)
            for stmt in db_backend.to_sql(table_custom):
                env.log.debug(stmt)
                cursor.execute(stmt)

        # Create change history table if required
        if realm_metadata['has_change']:
            cols = []
            for k in key_names:
                # Determine type of column k
                type = 'text'
                for c in table_metadata.columns:
                    if c.name == k:
                        type = c.type

                cols.append(Column(k, type=type))
                
            cols.append(Column('time', type=get_timestamp_db_type()))
            cols.append(Column('author'))
            cols.append(Column('field'))
            cols.append(Column('oldvalue'))
            cols.append(Column('newvalue'))
            cols.append(Index(key_names))

            change_key = copy.deepcopy(key_names)
            change_key.append('time')
            change_key.append('field')

            table_change = Table(tablename+'_change', key = change_key)[cols]
            env.log.info("Creating change history table %s..." % table_change.name)
            for stmt in db_backend.to_sql(table_change):
                env.log.debug(stmt)
                cursor.execute(stmt)

        db_set_config_property(env, 'tracgenericclassconfig', realm + '_dbversion', version)

        if do_commit:
            db.commit()

    except:
        env.log.error(formatExceptionInfo())
        env.log.error("Exception during database creation for class '%s'." % realm)

        db.rollback()
        raise

def upgrade_db_for_realm(env, package_name, realm, realm_metadata, db, do_commit=True):
    """
    Each db version should have its own upgrade module, named
    upgrades/db_<schema>_<N>.py, where 'N' is the version number (int).
    """
    try:
        try:
            from trac.db import DatabaseManager
            db_backend, _ = DatabaseManager(env)._get_connector()
        except ImportError:
            db_backend = env.get_db_cnx()

        env.log.info("Upgrading DB for class '%s'." % realm)
            
        # Create the required tables
        table_metadata = realm_metadata['table']
        version = realm_metadata['version']
        tablename = table_metadata.name
            
        cursor = db.cursor()
        current_version = db_get_config_property(env, 'tracgenericclassconfig', realm + "_dbversion")
        
        if current_version is None:
            current_version = 1

        for i in range(current_version + 1, version + 1):
            env.log.info('Upgrading database version for class \'%s\' from %d to %d', realm, i - 1, i)

            name  = 'db_%s_%i' % (realm, i)
            try:
                upgrades = __import__(package_name, globals(), locals(), [name])
                script = getattr(upgrades, name)
            except AttributeError:
                raise TracError(_('No upgrade module for version %(num)i '
                                  '(%(version)s.py)', num=i, version=name))
            script.do_upgrade(env, i, db_backend, db)

            db_set_config_property(env, 'tracgenericclassconfig', realm + '_dbversion', str(i))

            env.log.info('Upgrade successful.')
            if do_commit:
                db.commit()

    except:
        env.log.error(formatExceptionInfo())
        env.log.error("Exception during database upgrade for class '%s'." % realm)

        db.rollback()
        raise