[go: up one dir, main page]

Menu

[82a575]: / roundup / hyperdb.py  Maximize  Restore  History

Download this file

1006 lines (892 with data), 39.6 kB

   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
#
# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
# This module is free software, and you may redistribute it and/or modify
# under the same terms as Python, so long as this copyright message and
# disclaimer are retained in their original form.
#
# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
# DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
# OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#
# $Id: hyperdb.py,v 1.34 2001-11-21 04:04:43 richard Exp $
# standard python modules
import cPickle, re, string
# roundup modules
import date, password
#
# Types
#
class String:
"""An object designating a String property."""
def __repr__(self):
return '<%s>'%self.__class__
class Password:
"""An object designating a Password property."""
def __repr__(self):
return '<%s>'%self.__class__
class Date:
"""An object designating a Date property."""
def __repr__(self):
return '<%s>'%self.__class__
class Interval:
"""An object designating an Interval property."""
def __repr__(self):
return '<%s>'%self.__class__
class Link:
"""An object designating a Link property that links to a
node in a specified class."""
def __init__(self, classname):
self.classname = classname
def __repr__(self):
return '<%s to "%s">'%(self.__class__, self.classname)
class Multilink:
"""An object designating a Multilink property that links
to nodes in a specified class.
"""
def __init__(self, classname):
self.classname = classname
def __repr__(self):
return '<%s to "%s">'%(self.__class__, self.classname)
class DatabaseError(ValueError):
pass
#
# the base Database class
#
class Database:
# flag to set on retired entries
RETIRED_FLAG = '__hyperdb_retired'
_marker = []
#
# The base Class class
#
class Class:
"""The handle to a particular class of nodes in a hyperdatabase."""
def __init__(self, db, classname, **properties):
"""Create a new class with a given name and property specification.
'classname' must not collide with the name of an existing class,
or a ValueError is raised. The keyword arguments in 'properties'
must map names to property objects, or a TypeError is raised.
"""
self.classname = classname
self.properties = properties
self.db = db
self.key = ''
# do the db-related init stuff
db.addclass(self)
# Editing nodes:
def create(self, **propvalues):
"""Create a new node of this class and return its id.
The keyword arguments in 'propvalues' map property names to values.
The values of arguments must be acceptable for the types of their
corresponding properties or a TypeError is raised.
If this class has a key property, it must be present and its value
must not collide with other key strings or a ValueError is raised.
Any other properties on this class that are missing from the
'propvalues' dictionary are set to None.
If an id in a link or multilink property does not refer to a valid
node, an IndexError is raised.
"""
if propvalues.has_key('id'):
raise KeyError, '"id" is reserved'
if self.db.journaltag is None:
raise DatabaseError, 'Database open read-only'
# new node's id
newid = str(self.count() + 1)
# validate propvalues
num_re = re.compile('^\d+$')
for key, value in propvalues.items():
if key == self.key:
try:
self.lookup(value)
except KeyError:
pass
else:
raise ValueError, 'node with key "%s" exists'%value
# try to handle this property
try:
prop = self.properties[key]
except KeyError:
raise KeyError, '"%s" has no property "%s"'%(self.classname,
key)
if isinstance(prop, Link):
if type(value) != type(''):
raise ValueError, 'link value must be String'
link_class = self.properties[key].classname
# if it isn't a number, it's a key
if not num_re.match(value):
try:
value = self.db.classes[link_class].lookup(value)
except:
raise IndexError, 'new property "%s": %s not a %s'%(
key, value, self.properties[key].classname)
propvalues[key] = value
if not self.db.hasnode(link_class, value):
raise IndexError, '%s has no node %s'%(link_class, value)
# register the link with the newly linked node
self.db.addjournal(link_class, value, 'link',
(self.classname, newid, key))
elif isinstance(prop, Multilink):
if type(value) != type([]):
raise TypeError, 'new property "%s" not a list of ids'%key
link_class = self.properties[key].classname
l = []
for entry in value:
if type(entry) != type(''):
raise ValueError, 'link value must be String'
# if it isn't a number, it's a key
if not num_re.match(entry):
try:
entry = self.db.classes[link_class].lookup(entry)
except:
raise IndexError, 'new property "%s": %s not a %s'%(
key, entry, self.properties[key].classname)
l.append(entry)
value = l
propvalues[key] = value
# handle additions
for id in value:
if not self.db.hasnode(link_class, id):
raise IndexError, '%s has no node %s'%(link_class, id)
# register the link with the newly linked node
self.db.addjournal(link_class, id, 'link',
(self.classname, newid, key))
elif isinstance(prop, String):
if type(value) != type(''):
raise TypeError, 'new property "%s" not a string'%key
elif isinstance(prop, Password):
if not isinstance(value, password.Password):
raise TypeError, 'new property "%s" not a Password'%key
elif isinstance(prop, Date):
if not isinstance(value, date.Date):
raise TypeError, 'new property "%s" not a Date'%key
elif isinstance(prop, Interval):
if not isinstance(value, date.Interval):
raise TypeError, 'new property "%s" not an Interval'%key
# make sure there's data where there needs to be
for key, prop in self.properties.items():
if propvalues.has_key(key):
continue
if key == self.key:
raise ValueError, 'key property "%s" is required'%key
if isinstance(prop, Multilink):
propvalues[key] = []
else:
propvalues[key] = None
# convert all data to strings
for key, prop in self.properties.items():
if isinstance(prop, Date):
propvalues[key] = propvalues[key].get_tuple()
elif isinstance(prop, Interval):
propvalues[key] = propvalues[key].get_tuple()
elif isinstance(prop, Password):
propvalues[key] = str(propvalues[key])
# done
self.db.addnode(self.classname, newid, propvalues)
self.db.addjournal(self.classname, newid, 'create', propvalues)
return newid
def get(self, nodeid, propname, default=_marker):
"""Get the value of a property on an existing node of this class.
'nodeid' must be the id of an existing node of this class or an
IndexError is raised. 'propname' must be the name of a property
of this class or a KeyError is raised.
"""
d = self.db.getnode(self.classname, nodeid)
# convert the marshalled data to instances
for key, prop in self.properties.items():
if isinstance(prop, Date):
d[key] = date.Date(d[key])
elif isinstance(prop, Interval):
d[key] = date.Interval(d[key])
elif isinstance(prop, Password):
p = password.Password()
p.unpack(d[key])
d[key] = p
if propname == 'id':
return nodeid
if not d.has_key(propname) and default is not _marker:
return default
return d[propname]
# XXX not in spec
def getnode(self, nodeid):
''' Return a convenience wrapper for the node
'''
return Node(self, nodeid)
def set(self, nodeid, **propvalues):
"""Modify a property on an existing node of this class.
'nodeid' must be the id of an existing node of this class or an
IndexError is raised.
Each key in 'propvalues' must be the name of a property of this
class or a KeyError is raised.
All values in 'propvalues' must be acceptable types for their
corresponding properties or a TypeError is raised.
If the value of the key property is set, it must not collide with
other key strings or a ValueError is raised.
If the value of a Link or Multilink property contains an invalid
node id, a ValueError is raised.
"""
if not propvalues:
return
if propvalues.has_key('id'):
raise KeyError, '"id" is reserved'
if self.db.journaltag is None:
raise DatabaseError, 'Database open read-only'
node = self.db.getnode(self.classname, nodeid)
if node.has_key(self.db.RETIRED_FLAG):
raise IndexError
num_re = re.compile('^\d+$')
for key, value in propvalues.items():
# check to make sure we're not duplicating an existing key
if key == self.key and node[key] != value:
try:
self.lookup(value)
except KeyError:
pass
else:
raise ValueError, 'node with key "%s" exists'%value
# this will raise the KeyError if the property isn't valid
# ... we don't use getprops() here because we only care about
# the writeable properties.
prop = self.properties[key]
if isinstance(prop, Link):
link_class = self.properties[key].classname
# if it isn't a number, it's a key
if type(value) != type(''):
raise ValueError, 'link value must be String'
if not num_re.match(value):
try:
value = self.db.classes[link_class].lookup(value)
except:
raise IndexError, 'new property "%s": %s not a %s'%(
key, value, self.properties[key].classname)
if not self.db.hasnode(link_class, value):
raise IndexError, '%s has no node %s'%(link_class, value)
# register the unlink with the old linked node
if node[key] is not None:
self.db.addjournal(link_class, node[key], 'unlink',
(self.classname, nodeid, key))
# register the link with the newly linked node
if value is not None:
self.db.addjournal(link_class, value, 'link',
(self.classname, nodeid, key))
elif isinstance(prop, Multilink):
if type(value) != type([]):
raise TypeError, 'new property "%s" not a list of ids'%key
link_class = self.properties[key].classname
l = []
for entry in value:
# if it isn't a number, it's a key
if type(entry) != type(''):
raise ValueError, 'link value must be String'
if not num_re.match(entry):
try:
entry = self.db.classes[link_class].lookup(entry)
except:
raise IndexError, 'new property "%s": %s not a %s'%(
key, entry, self.properties[key].classname)
l.append(entry)
value = l
propvalues[key] = value
#handle removals
l = node[key]
for id in l[:]:
if id in value:
continue
# register the unlink with the old linked node
self.db.addjournal(link_class, id, 'unlink',
(self.classname, nodeid, key))
l.remove(id)
# handle additions
for id in value:
if not self.db.hasnode(link_class, id):
raise IndexError, '%s has no node %s'%(link_class, id)
if id in l:
continue
# register the link with the newly linked node
self.db.addjournal(link_class, id, 'link',
(self.classname, nodeid, key))
l.append(id)
elif isinstance(prop, String):
if value is not None and type(value) != type(''):
raise TypeError, 'new property "%s" not a string'%key
elif isinstance(prop, Password):
if not isinstance(value, password.Password):
raise TypeError, 'new property "%s" not a Password'% key
propvalues[key] = value = str(value)
elif isinstance(prop, Date):
if not isinstance(value, date.Date):
raise TypeError, 'new property "%s" not a Date'% key
propvalues[key] = value = value.get_tuple()
elif isinstance(prop, Interval):
if not isinstance(value, date.Interval):
raise TypeError, 'new property "%s" not an Interval'% key
propvalues[key] = value = value.get_tuple()
node[key] = value
self.db.setnode(self.classname, nodeid, node)
self.db.addjournal(self.classname, nodeid, 'set', propvalues)
def retire(self, nodeid):
"""Retire a node.
The properties on the node remain available from the get() method,
and the node's id is never reused.
Retired nodes are not returned by the find(), list(), or lookup()
methods, and other nodes may reuse the values of their key properties.
"""
if self.db.journaltag is None:
raise DatabaseError, 'Database open read-only'
node = self.db.getnode(self.classname, nodeid)
node[self.db.RETIRED_FLAG] = 1
self.db.setnode(self.classname, nodeid, node)
self.db.addjournal(self.classname, nodeid, 'retired', None)
def history(self, nodeid):
"""Retrieve the journal of edits on a particular node.
'nodeid' must be the id of an existing node of this class or an
IndexError is raised.
The returned list contains tuples of the form
(date, tag, action, params)
'date' is a Timestamp object specifying the time of the change and
'tag' is the journaltag specified when the database was opened.
"""
return self.db.getjournal(self.classname, nodeid)
# Locating nodes:
def setkey(self, propname):
"""Select a String property of this class to be the key property.
'propname' must be the name of a String property of this class or
None, or a TypeError is raised. The values of the key property on
all existing nodes must be unique or a ValueError is raised.
"""
# TODO: validate that the property is a String!
self.key = propname
def getkey(self):
"""Return the name of the key property for this class or None."""
return self.key
def labelprop(self, default_to_id=0):
''' Return the property name for a label for the given node.
This method attempts to generate a consistent label for the node.
It tries the following in order:
1. key property
2. "name" property
3. "title" property
4. first property from the sorted property name list
'''
k = self.getkey()
if k:
return k
props = self.getprops()
if props.has_key('name'):
return 'name'
elif props.has_key('title'):
return 'title'
if default_to_id:
return 'id'
props = props.keys()
props.sort()
return props[0]
# TODO: set up a separate index db file for this? profile?
def lookup(self, keyvalue):
"""Locate a particular node by its key property and return its id.
If this class has no key property, a TypeError is raised. If the
'keyvalue' matches one of the values for the key property among
the nodes in this class, the matching node's id is returned;
otherwise a KeyError is raised.
"""
cldb = self.db.getclassdb(self.classname)
for nodeid in self.db.getnodeids(self.classname, cldb):
node = self.db.getnode(self.classname, nodeid, cldb)
if node.has_key(self.db.RETIRED_FLAG):
continue
if node[self.key] == keyvalue:
return nodeid
cldb.close()
raise KeyError, keyvalue
# XXX: change from spec - allows multiple props to match
def find(self, **propspec):
"""Get the ids of nodes in this class which link to a given node.
'propspec' consists of keyword args propname=nodeid
'propname' must be the name of a property in this class, or a
KeyError is raised. That property must be a Link or Multilink
property, or a TypeError is raised.
'nodeid' must be the id of an existing node in the class linked
to by the given property, or an IndexError is raised.
"""
propspec = propspec.items()
for propname, nodeid in propspec:
# check the prop is OK
prop = self.properties[propname]
if not isinstance(prop, Link) and not isinstance(prop, Multilink):
raise TypeError, "'%s' not a Link/Multilink property"%propname
if not self.db.hasnode(prop.classname, nodeid):
raise ValueError, '%s has no node %s'%(prop.classname, nodeid)
# ok, now do the find
cldb = self.db.getclassdb(self.classname)
l = []
for id in self.db.getnodeids(self.classname, cldb):
node = self.db.getnode(self.classname, id, cldb)
if node.has_key(self.db.RETIRED_FLAG):
continue
for propname, nodeid in propspec:
property = node[propname]
if isinstance(prop, Link) and nodeid == property:
l.append(id)
elif isinstance(prop, Multilink) and nodeid in property:
l.append(id)
cldb.close()
return l
def stringFind(self, **requirements):
"""Locate a particular node by matching a set of its String
properties in a caseless search.
If the property is not a String property, a TypeError is raised.
The return is a list of the id of all nodes that match.
"""
for propname in requirements.keys():
prop = self.properties[propname]
if isinstance(not prop, String):
raise TypeError, "'%s' not a String property"%propname
requirements[propname] = requirements[propname].lower()
l = []
cldb = self.db.getclassdb(self.classname)
for nodeid in self.db.getnodeids(self.classname, cldb):
node = self.db.getnode(self.classname, nodeid, cldb)
if node.has_key(self.db.RETIRED_FLAG):
continue
for key, value in requirements.items():
if node[key] and node[key].lower() != value:
break
else:
l.append(nodeid)
cldb.close()
return l
def list(self):
"""Return a list of the ids of the active nodes in this class."""
l = []
cn = self.classname
cldb = self.db.getclassdb(cn)
for nodeid in self.db.getnodeids(cn, cldb):
node = self.db.getnode(cn, nodeid, cldb)
if node.has_key(self.db.RETIRED_FLAG):
continue
l.append(nodeid)
l.sort()
cldb.close()
return l
# XXX not in spec
def filter(self, filterspec, sort, group, num_re = re.compile('^\d+$')):
''' Return a list of the ids of the active nodes in this class that
match the 'filter' spec, sorted by the group spec and then the
sort spec
'''
cn = self.classname
# optimise filterspec
l = []
props = self.getprops()
for k, v in filterspec.items():
propclass = props[k]
if isinstance(propclass, Link):
if type(v) is not type([]):
v = [v]
# replace key values with node ids
u = []
link_class = self.db.classes[propclass.classname]
for entry in v:
if entry == '-1': entry = None
elif not num_re.match(entry):
try:
entry = link_class.lookup(entry)
except:
raise ValueError, 'property "%s": %s not a %s'%(
k, entry, self.properties[k].classname)
u.append(entry)
l.append((0, k, u))
elif isinstance(propclass, Multilink):
if type(v) is not type([]):
v = [v]
# replace key values with node ids
u = []
link_class = self.db.classes[propclass.classname]
for entry in v:
if not num_re.match(entry):
try:
entry = link_class.lookup(entry)
except:
raise ValueError, 'new property "%s": %s not a %s'%(
k, entry, self.properties[k].classname)
u.append(entry)
l.append((1, k, u))
elif isinstance(propclass, String):
# simple glob searching
v = re.sub(r'([\|\{\}\\\.\+\[\]\(\)])', r'\\\1', v)
v = v.replace('?', '.')
v = v.replace('*', '.*?')
l.append((2, k, re.compile(v, re.I)))
else:
l.append((6, k, v))
filterspec = l
# now, find all the nodes that are active and pass filtering
l = []
cldb = self.db.getclassdb(cn)
for nodeid in self.db.getnodeids(cn, cldb):
node = self.db.getnode(cn, nodeid, cldb)
if node.has_key(self.db.RETIRED_FLAG):
continue
# apply filter
for t, k, v in filterspec:
if t == 0 and node[k] not in v:
# link - if this node'd property doesn't appear in the
# filterspec's nodeid list, skip it
break
elif t == 1:
# multilink - if any of the nodeids required by the
# filterspec aren't in this node's property, then skip
# it
for value in v:
if value not in node[k]:
break
else:
continue
break
elif t == 2 and not v.search(node[k]):
# RE search
break
elif t == 6 and node[k] != v:
# straight value comparison for the other types
break
else:
l.append((nodeid, node))
l.sort()
cldb.close()
# optimise sort
m = []
for entry in sort:
if entry[0] != '-':
m.append(('+', entry))
else:
m.append((entry[0], entry[1:]))
sort = m
# optimise group
m = []
for entry in group:
if entry[0] != '-':
m.append(('+', entry))
else:
m.append((entry[0], entry[1:]))
group = m
# now, sort the result
def sortfun(a, b, sort=sort, group=group, properties=self.getprops(),
db = self.db, cl=self):
a_id, an = a
b_id, bn = b
# sort by group and then sort
for list in group, sort:
for dir, prop in list:
# sorting is class-specific
propclass = properties[prop]
# handle the properties that might be "faked"
# also, handle possible missing properties
try:
if not an.has_key(prop):
an[prop] = cl.get(a_id, prop)
av = an[prop]
except KeyError:
# the node doesn't have a value for this property
if isinstance(propclass, Multilink): av = []
else: av = ''
try:
if not bn.has_key(prop):
bn[prop] = cl.get(b_id, prop)
bv = bn[prop]
except KeyError:
# the node doesn't have a value for this property
if isinstance(propclass, Multilink): bv = []
else: bv = ''
# String and Date values are sorted in the natural way
if isinstance(propclass, String):
# clean up the strings
if av and av[0] in string.uppercase:
av = an[prop] = av.lower()
if bv and bv[0] in string.uppercase:
bv = bn[prop] = bv.lower()
if (isinstance(propclass, String) or
isinstance(propclass, Date)):
# it might be a string that's really an integer
try:
av = int(av)
bv = int(bv)
except:
pass
if dir == '+':
r = cmp(av, bv)
if r != 0: return r
elif dir == '-':
r = cmp(bv, av)
if r != 0: return r
# Link properties are sorted according to the value of
# the "order" property on the linked nodes if it is
# present; or otherwise on the key string of the linked
# nodes; or finally on the node ids.
elif isinstance(propclass, Link):
link = db.classes[propclass.classname]
if av is None and bv is not None: return -1
if av is not None and bv is None: return 1
if av is None and bv is None: return 0
if link.getprops().has_key('order'):
if dir == '+':
r = cmp(link.get(av, 'order'),
link.get(bv, 'order'))
if r != 0: return r
elif dir == '-':
r = cmp(link.get(bv, 'order'),
link.get(av, 'order'))
if r != 0: return r
elif link.getkey():
key = link.getkey()
if dir == '+':
r = cmp(link.get(av, key), link.get(bv, key))
if r != 0: return r
elif dir == '-':
r = cmp(link.get(bv, key), link.get(av, key))
if r != 0: return r
else:
if dir == '+':
r = cmp(av, bv)
if r != 0: return r
elif dir == '-':
r = cmp(bv, av)
if r != 0: return r
# Multilink properties are sorted according to how many
# links are present.
elif isinstance(propclass, Multilink):
if dir == '+':
r = cmp(len(av), len(bv))
if r != 0: return r
elif dir == '-':
r = cmp(len(bv), len(av))
if r != 0: return r
# end for dir, prop in list:
# end for list in sort, group:
# if all else fails, compare the ids
return cmp(a[0], b[0])
l.sort(sortfun)
return [i[0] for i in l]
def count(self):
"""Get the number of nodes in this class.
If the returned integer is 'numnodes', the ids of all the nodes
in this class run from 1 to numnodes, and numnodes+1 will be the
id of the next node to be created in this class.
"""
return self.db.countnodes(self.classname)
# Manipulating properties:
def getprops(self, protected=1):
"""Return a dictionary mapping property names to property objects.
If the "protected" flag is true, we include protected properties -
those which may not be modified."""
d = self.properties.copy()
if protected:
d['id'] = String()
return d
def addprop(self, **properties):
"""Add properties to this class.
The keyword arguments in 'properties' must map names to property
objects, or a TypeError is raised. None of the keys in 'properties'
may collide with the names of existing properties, or a ValueError
is raised before any properties have been added.
"""
for key in properties.keys():
if self.properties.has_key(key):
raise ValueError, key
self.properties.update(properties)
# XXX not in spec
class Node:
''' A convenience wrapper for the given node
'''
def __init__(self, cl, nodeid):
self.__dict__['cl'] = cl
self.__dict__['nodeid'] = nodeid
def keys(self, protected=1):
return self.cl.getprops(protected=protected).keys()
def values(self, protected=1):
l = []
for name in self.cl.getprops(protected=protected).keys():
l.append(self.cl.get(self.nodeid, name))
return l
def items(self, protected=1):
l = []
for name in self.cl.getprops(protected=protected).keys():
l.append((name, self.cl.get(self.nodeid, name)))
return l
def has_key(self, name):
return self.cl.getprops().has_key(name)
def __getattr__(self, name):
if self.__dict__.has_key(name):
return self.__dict__[name]
try:
return self.cl.get(self.nodeid, name)
except KeyError, value:
raise AttributeError, str(value)
def __getitem__(self, name):
return self.cl.get(self.nodeid, name)
def __setattr__(self, name, value):
try:
return self.cl.set(self.nodeid, **{name: value})
except KeyError, value:
raise AttributeError, str(value)
def __setitem__(self, name, value):
self.cl.set(self.nodeid, **{name: value})
def history(self):
return self.cl.history(self.nodeid)
def retire(self):
return self.cl.retire(self.nodeid)
def Choice(name, *options):
cl = Class(db, name, name=hyperdb.String(), order=hyperdb.String())
for i in range(len(options)):
cl.create(name=option[i], order=i)
return hyperdb.Link(name)
#
# $Log: not supported by cvs2svn $
# Revision 1.33 2001/11/21 03:40:54 richard
# more new property handling
#
# Revision 1.32 2001/11/21 03:11:28 richard
# Better handling of new properties.
#
# Revision 1.31 2001/11/12 22:01:06 richard
# Fixed issues with nosy reaction and author copies.
#
# Revision 1.30 2001/11/09 10:11:08 richard
# . roundup-admin now handles all hyperdb exceptions
#
# Revision 1.29 2001/10/27 00:17:41 richard
# Made Class.stringFind() do caseless matching.
#
# Revision 1.28 2001/10/21 04:44:50 richard
# bug #473124: UI inconsistency with Link fields.
# This also prompted me to fix a fairly long-standing usability issue -
# that of being able to turn off certain filters.
#
# Revision 1.27 2001/10/20 23:44:27 richard
# Hyperdatabase sorts strings-that-look-like-numbers as numbers now.
#
# Revision 1.26 2001/10/16 03:48:01 richard
# admin tool now complains if a "find" is attempted with a non-link property.
#
# Revision 1.25 2001/10/11 00:17:51 richard
# Reverted a change in hyperdb so the default value for missing property
# values in a create() is None and not '' (the empty string.) This obviously
# breaks CSV import/export - the string 'None' will be created in an
# export/import operation.
#
# Revision 1.24 2001/10/10 03:54:57 richard
# Added database importing and exporting through CSV files.
# Uses the csv module from object-craft for exporting if it's available.
# Requires the csv module for importing.
#
# Revision 1.23 2001/10/09 23:58:10 richard
# Moved the data stringification up into the hyperdb.Class class' get, set
# and create methods. This means that the data is also stringified for the
# journal call, and removes duplication of code from the backends. The
# backend code now only sees strings.
#
# Revision 1.22 2001/10/09 07:25:59 richard
# Added the Password property type. See "pydoc roundup.password" for
# implementation details. Have updated some of the documentation too.
#
# Revision 1.21 2001/10/05 02:23:24 richard
# . roundup-admin create now prompts for property info if none is supplied
# on the command-line.
# . hyperdb Class getprops() method may now return only the mutable
# properties.
# . Login now uses cookies, which makes it a whole lot more flexible. We can
# now support anonymous user access (read-only, unless there's an
# "anonymous" user, in which case write access is permitted). Login
# handling has been moved into cgi_client.Client.main()
# . The "extended" schema is now the default in roundup init.
# . The schemas have had their page headings modified to cope with the new
# login handling. Existing installations should copy the interfaces.py
# file from the roundup lib directory to their instance home.
# . Incorrectly had a Bizar Software copyright on the cgitb.py module from
# Ping - has been removed.
# . Fixed a whole bunch of places in the CGI interface where we should have
# been returning Not Found instead of throwing an exception.
# . Fixed a deviation from the spec: trying to modify the 'id' property of
# an item now throws an exception.
#
# Revision 1.20 2001/10/04 02:12:42 richard
# Added nicer command-line item adding: passing no arguments will enter an
# interactive more which asks for each property in turn. While I was at it, I
# fixed an implementation problem WRT the spec - I wasn't raising a
# ValueError if the key property was missing from a create(). Also added a
# protected=boolean argument to getprops() so we can list only the mutable
# properties (defaults to yes, which lists the immutables).
#
# Revision 1.19 2001/08/29 04:47:18 richard
# Fixed CGI client change messages so they actually include the properties
# changed (again).
#
# Revision 1.18 2001/08/16 07:34:59 richard
# better CGI text searching - but hidden filter fields are disappearing...
#
# Revision 1.17 2001/08/16 06:59:58 richard
# all searches use re now - and they're all case insensitive
#
# Revision 1.16 2001/08/15 23:43:18 richard
# Fixed some isFooTypes that I missed.
# Refactored some code in the CGI code.
#
# Revision 1.15 2001/08/12 06:32:36 richard
# using isinstance(blah, Foo) now instead of isFooType
#
# Revision 1.14 2001/08/07 00:24:42 richard
# stupid typo
#
# Revision 1.13 2001/08/07 00:15:51 richard
# Added the copyright/license notice to (nearly) all files at request of
# Bizar Software.
#
# Revision 1.12 2001/08/02 06:38:17 richard
# Roundupdb now appends "mailing list" information to its messages which
# include the e-mail address and web interface address. Templates may
# override this in their db classes to include specific information (support
# instructions, etc).
#
# Revision 1.11 2001/08/01 04:24:21 richard
# mailgw was assuming certain properties existed on the issues being created.
#
# Revision 1.10 2001/07/30 02:38:31 richard
# get() now has a default arg - for migration only.
#
# Revision 1.9 2001/07/29 09:28:23 richard
# Fixed sorting by clicking on column headings.
#
# Revision 1.8 2001/07/29 08:27:40 richard
# Fixed handling of passed-in values in form elements (ie. during a
# drill-down)
#
# Revision 1.7 2001/07/29 07:01:39 richard
# Added vim command to all source so that we don't get no steenkin' tabs :)
#
# Revision 1.6 2001/07/29 05:36:14 richard
# Cleanup of the link label generation.
#
# Revision 1.5 2001/07/29 04:05:37 richard
# Added the fabricated property "id".
#
# Revision 1.4 2001/07/27 06:25:35 richard
# Fixed some of the exceptions so they're the right type.
# Removed the str()-ification of node ids so we don't mask oopsy errors any
# more.
#
# Revision 1.3 2001/07/27 05:17:14 richard
# just some comments
#
# Revision 1.2 2001/07/22 12:09:32 richard
# Final commit of Grande Splite
#
# Revision 1.1 2001/07/22 11:58:35 richard
# More Grande Splite
#
#
# vim: set filetype=python ts=4 sw=4 et si