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
|
# copyright (C) 1997-2005 Jean-Luc Fontaine (mailto:jfontain@free.fr)
# this program is free software: please read the COPYRIGHT file enclosed in this package or use the Help Copyright menu
# $Id: database.tcl,v 1.78 2005/01/02 00:45:07 jfontain Exp $
# database interface: SQLite is single file based, MySQL is natively supported, the other engines by ODBC.
class database {
set (dateTimeFormat) {%Y-%m-%d %T}
# note: error messages are not internationalized since they can be written to the system log, and debug messages are for english
# speaking technical people
proc database {this args} switched {$args} {
set ($this,error) {}
switched::complete $this
if {[package vcompare $::tcl_version 8.4] < 0} {
set ($this,rowType) INTEGER ;# 32 bits row
} else {
set ($this,rowType) BIGINT ;# 64 bits row
}
if {[string length $switched::($this,-file)] > 0} { ;# SQLite file based single user database
set ($this,file) 1
set ($this,odbc) 0
if {[catch {package require sqlite3} result3] && [catch {package require sqlite 2} result2]} { ;# try version 3 first
set ($this,error) "SQLite interface error:\n$result3\n$result2"
return
} elseif {$switched::($this,-debuglevel)} {
set message "loaded SQLite library version "
if {[info exists result3]} {append message $result3} else {append message $result2}
if {$global::withGUI} {puts $message} else {writeLog $message debug}
}
if {[catch {package present sqlite3}]} {set ($this,sqliteExtension) {}} else {set ($this,sqliteExtension) 3}
sqliteOpen $this ;# can fail on misconfiguration
if {[string length $($this,error)] > 0} return ;# abort so that object can be cleanly deleted
} elseif {[string length $switched::($this,-dsn)] > 0} { ;# ODBC (moodss (or other name) database must be already created)
set ($this,file) 0
set ($this,odbc) 1
if {[catch {package require tclodbc 2} result]} {
set ($this,error) "Tcl ODBC interface error: $result"
return
}
foreach list [::database datasources] {
foreach {dsn driver} $list {}
if {[string equal $dsn $switched::($this,-dsn)]} break ;# found driver
}
if {$switched::($this,-debuglevel)} {
set message "loaded ODBC driver $driver version $result"
if {$global::withGUI} {puts $message} else {writeLog $message debug}
}
odbcConnect $this ;# can fail on misconfiguration
if {[string length $($this,error)] > 0} return ;# abort so that object can be cleanly deleted
set ($this,limit) {LIMIT %l}
set ($this,prefix) {} ;# columns name common prefix
set ($this,timeStamp) TIMESTAMP
set ($this,text) TEXT ;# column text type
set ($this,lock) BEGIN
set ($this,unlock) COMMIT
switch -glob [string tolower $driver] {
*my* { ;# matches MySQL, /usr/lib/libmyodbc.so, ...
set ($this,timeStamp) DATETIME ;# safer as not changed by manual updates, changes, ... of the database
set ($this,lock) {LOCK TABLES %t WRITE}
set ($this,unlock) {UNLOCK TABLES}
set ($this,type) mysql
}
*postg* - *psql* - *pgsql* { ;# PostgreSQL
set ($this,type) postgres
}
*db2* { ;# DB2
set ($this,lock) {LOCK TABLE %t IN EXCLUSIVE MODE}
set ($this,limit) {FETCH FIRST %l ROWS ONLY}
set ($this,type) db2
}
*ora* { ;# Oracle
set ($this,prefix) c ;# to work around the many limitations on column names
set ($this,timeStamp) DATE
set ($this,text) VARCHAR2(4000)
unset ($this,lock) ($this,unlock)
set ($this,rowType) INTEGER
set ($this,type) oracle
}
}
} else { ;# MySQL
set ($this,file) 0
set ($this,odbc) 0
if {[catch {package require mysqltcl} result]} {
set ($this,error) "Tcl MySQL interface error: $result"
return
} elseif {$switched::($this,-debuglevel)} {
set message "loaded MySQL native driver version $result"
if {$global::withGUI} {puts $message} else {writeLog $message debug}
}
mysqlConnect $this ;# can fail on misconfiguration
if {[string length $($this,error)] > 0} return ;# abort so that object can be cleanly deleted
set ($this,lock) {LOCK TABLES %t WRITE}
set ($this,unlock) {UNLOCK TABLES}
}
initialize $this
if {[string length $($this,error)] > 0} return ;# abort on fatal error in initialization
checkFormat $this
if {[string length $($this,error)] > 0} return ;# abort on fatal error in format checking
if {$global::withGUI} {
# upper time limit for all queries since database may be constantly written to (so the cache can function properly)
set ($this,start) [dateTime $this]
} else {
if {$($this,oldFormat)} {
# only reading from an old format database is implemented (writing requires new format starting at moomps 2.3)
set ($this,error) {cannot write to a database in old format (see upgrading section in database documentation)}
}
}
}
proc ~database {this} {
variable ${this}cache
catch {unset ${this}cache}
disconnect $this
}
proc options {this} { ;# force initialization of index and label
# -database and -port options are solely for MySQL, -file solely for SQLite, -dsn solely for ODBC
return [list\
[list -database moodss moodss]\
[list -debuglevel 0 0]\
[list -dsn {} {}]\
[list -file {} {}]\
[list -host {} {}]\
[list -password {} {}]\
[list -port {} {}]\
[list -user $::tcl_platform(user) $::tcl_platform(user)]\
]
}
foreach option {-database -dsn -file -host -password -port -user} {
proc set$option {this value} "
if {\$switched::(\$this,complete)} {
::error {option $option cannot be set dynamically}
}
"
}
proc set-debuglevel {this value} { ;# at this time, there are no debug levels, so level should be viewed as a boolean
if {$switched::($this,complete)} {
::error {option -debuglevel cannot be set dynamically}
}
}
if {$global::withGUI} {
# note: use error data member so that error occurence can be detected by its non emptiness
proc errorTrace {this message} {
if {[info exists ($this,ignoreErrors)]} return
if {$switched::($this,-debuglevel)} {puts $message}
residentTraceModule 1
modules::trace {} moodss(database) $message
}
proc sqliteOpen {this} {
set ($this,error) {}
catch {unset ($this,connection)}
if {$switched::($this,-debuglevel)} {puts "opening file \"$switched::($this,-file)\""}
set connection sqlite$this ;# use a unique connection name
if {[catch {::sqlite$($this,sqliteExtension) $connection $switched::($this,-file)} message]} {
errorTrace $this [set ($this,error) $message]
} else {
set ($this,connection) $connection ;# successful connection
}
}
proc sqliteEvaluate {this sql} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {puts [string trim $sql]}
if {[catch {$($this,connection) eval $sql} result]} {
errorTrace $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc sqliteClose {this} {
set ($this,error) {}
if {![info exists ($this,connection)]} return ;# not connected
if {$switched::($this,-debuglevel)} {puts "closing file \"$switched::($this,-file)\""}
if {[catch {$($this,connection) close} message]} {
errorTrace $this [set ($this,error) $message]
} else {
unset ($this,connection)
}
}
proc odbcConnect {this} {
set ($this,error) {}
catch {unset ($this,connection)}
if {$switched::($this,-debuglevel)} {puts "connecting to ODBC DSN $switched::($this,-dsn)"}
set arguments [list $switched::($this,-dsn)]
if {[string length $switched::($this,-user)] > 0} {lappend arguments $switched::($this,-user)}
if {[string length $switched::($this,-password)] > 0} {lappend arguments $switched::($this,-password)}
if {[catch {set connection [eval ::database odbc$this $arguments]} message]} { ;# use a unique connection name
errorTrace $this [set ($this,error) $message]
} else {
set ($this,connection) $connection ;# successful connection
}
}
proc odbcConnection {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {puts "[eval concat $args]"}
if {[catch {eval $($this,connection) $args} result]} {
errorTrace $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc odbcDisconnect {this} {
set ($this,error) {}
if {![info exists ($this,connection)]} return ;# not connected
if {$switched::($this,-debuglevel)} {puts {closing ODBC connection}}
if {[catch {$($this,connection) disconnect} message]} {
errorTrace $this [set ($this,error) $message]
} else {
unset ($this,connection)
}
}
proc mysqlConnect {this} {
set ($this,error) {}
catch {unset ($this,connection)}
if {$switched::($this,-debuglevel)} {puts "connecting to database $switched::($this,-database)"}
set arguments [list -db $switched::($this,-database)] ;# database must exist
if {[string length $switched::($this,-host)] > 0} {lappend arguments -host $switched::($this,-host)}
if {[string length $switched::($this,-user)] > 0} {lappend arguments -user $switched::($this,-user)}
if {[string length $switched::($this,-password)] > 0} {lappend arguments -password $switched::($this,-password)}
if {[string length $switched::($this,-port)] > 0} {lappend arguments -port $switched::($this,-port)}
if {[catch {set connection [eval mysqlconnect $arguments]} message]} {
errorTrace $this [set ($this,error) $message]
} else {
set ($this,connection) $connection ;# successful connection
}
}
proc mysqlSelect {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {puts [string trim [lindex $args 0]]} ;# only keep query, without options
if {[catch {eval mysqlsel $($this,connection) $args} result]} {
errorTrace $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc mysqlExecute {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {puts [string trim [lindex $args 0]]} ;# only keep statement, without options
if {[catch {eval mysqlexec $($this,connection) $args} message]} {
errorTrace $this [set ($this,error) $message]
}
}
proc mysqlColumns {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {puts "SHOW COLUMNS FROM [lindex $args 0]"} ;# table
if {[catch {eval mysqlcol $($this,connection) $args} result]} {
errorTrace $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc mysqlDisconnect {this} {
set ($this,error) {}
if {![info exists ($this,connection)]} return ;# not connected
if {$switched::($this,-debuglevel)} {puts {closing MySQL connection}}
if {[catch {mysqlclose $($this,connection)} message]} {
errorTrace $this [set ($this,error) $message]
} else {
unset ($this,connection)
}
}
} else {
proc error {this} { ;# use a procedure since daemon interpreters have no access to database data members
return $($this,error)
}
proc errorLog {this message} {
if {[info exists ($this,ignoreErrors)]} return
writeLog $message error
}
proc sqliteOpen {this} {
set ($this,error) {}
catch {unset ($this,connection)}
if {$switched::($this,-debuglevel)} {writeLog "opening file \"$switched::($this,-file)\"" debug}
set connection sqlite$this ;# use a unique connection name
if {[catch {::sqlite$($this,sqliteExtension) $connection $switched::($this,-file)} message]} {
errorLog $this [set ($this,error) $message]
} else {
set ($this,connection) $connection ;# successful connection
}
}
proc sqliteEvaluate {this sql} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {writeLog [string trim $sql] debug}
if {[catch {$($this,connection) eval $sql} result]} {
errorLog $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc sqliteClose {this} {
set ($this,error) {}
if {![info exists ($this,connection)]} return ;# not connected
if {$switched::($this,-debuglevel)} {writeLog "closing file \"$switched::($this,-file)\"" debug}
if {[catch {$($this,connection) close} message]} {
errorLog $this [set ($this,error) $message]
} else {
unset ($this,connection)
}
}
proc odbcConnect {this} {
set ($this,error) {}
catch {unset ($this,connection)}
if {$switched::($this,-debuglevel)} {writeLog "connecting to ODBC DSN $switched::($this,-dsn)" debug}
set arguments [list $switched::($this,-dsn)]
if {[string length $switched::($this,-user)] > 0} {lappend arguments $switched::($this,-user)}
if {[string length $switched::($this,-password)] > 0} {lappend arguments $switched::($this,-password)}
if {[catch {set connection [eval ::database odbc$this $arguments]} message]} { ;# use a unique connection name
errorLog $this [set ($this,error) $message]
} else {
set ($this,connection) $connection ;# successful connection
}
}
proc odbcConnection {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {writeLog "[eval concat $args]" debug}
if {[catch {eval $($this,connection) $args} result]} {
errorLog $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc odbcDisconnect {this} {
set ($this,error) {}
if {![info exists ($this,connection)]} return ;# not connected
if {$switched::($this,-debuglevel)} {writeLog {closing ODBC connection} debug}
if {[catch {$($this,connection) disconnect} message]} {
errorLog $this [set ($this,error) $message]
} else {
unset ($this,connection)
}
}
proc mysqlConnect {this} {
set ($this,error) {}
catch {unset ($this,connection)}
if {$switched::($this,-debuglevel)} {writeLog "connecting to database $switched::($this,-database)" debug}
set arguments [list -db $switched::($this,-database)] ;# database must exist
if {[string length $switched::($this,-host)] > 0} {lappend arguments -host $switched::($this,-host)}
if {[string length $switched::($this,-user)] > 0} {lappend arguments -user $switched::($this,-user)}
if {[string length $switched::($this,-password)] > 0} {lappend arguments -password $switched::($this,-password)}
if {[string length $switched::($this,-port)] > 0} {lappend arguments -port $switched::($this,-port)}
if {[catch {set connection [eval mysqlconnect $arguments]} message]} {
errorLog $this [set ($this,error) $message]
} else {
set ($this,connection) $connection ;# successful connection
}
}
proc mysqlSelect {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {writeLog [string trim [lindex $args 0]] debug}
if {[catch {eval mysqlsel $($this,connection) $args} result]} {
errorLog $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc mysqlExecute {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {writeLog [string trim [lindex $args 0]] debug}
if {[catch {eval mysqlexec $($this,connection) $args} message]} {
errorLog $this [set ($this,error) $message]
}
}
proc mysqlColumns {this args} {
set ($this,error) {}
if {$switched::($this,-debuglevel)} {writeLog "SHOW COLUMNS FROM [lindex $args 0]" debug}
if {[catch {eval mysqlcol $($this,connection) $args} result]} {
errorLog $this [set ($this,error) $result]
return {}
} else {
return $result
}
}
proc mysqlDisconnect {this} {
set ($this,error) {}
if {![info exists ($this,connection)]} return ;# not connected
if {$switched::($this,-debuglevel)} {writeLog {closing MySQL connection} debug}
if {[catch {mysqlclose $($this,connection)} message]} {
errorLog $this [set ($this,error) $message]
} else {
unset ($this,connection)
}
}
}
proc initialize {this} { ;# create tables if they do not exist (database must always have been manually created)
set file $($this,file)
set odbc $($this,odbc)
if {$file} {
set timeStamp INTEGER ;# store seconds since SQLite has no native date time type
set prefix {}
set text TEXT
} elseif {$odbc} {
set timeStamp $($this,timeStamp)
set prefix $($this,prefix)
set text $($this,text)
} else { ;# MySQL
set timeStamp DATETIME ;# safer as not changed by manual updates, changes, ... of the database
set prefix {}
set text TEXT
}
set rowType $($this,rowType) ;# row column type
# see tables documentation in moomps documentation
array set statements "
instances {
{
CREATE TABLE instances (
${prefix}number INTEGER NOT NULL PRIMARY KEY,
${prefix}start $timeStamp NOT NULL,
${prefix}module VARCHAR(255) NOT NULL,
${prefix}identifier VARCHAR(255),
${prefix}major INTEGER NOT NULL,
${prefix}minor INTEGER NOT NULL
)
}
} options {
{
CREATE TABLE options (
${prefix}instance INTEGER NOT NULL REFERENCES instances,
${prefix}name VARCHAR(255) NOT NULL,
${prefix}value $text
)
}
} entries {
{
CREATE TABLE entries (
${prefix}instance INTEGER NOT NULL REFERENCES instances,
${prefix}number INTEGER NOT NULL,
${prefix}indexed INTEGER NOT NULL,
${prefix}label VARCHAR(255) NOT NULL,
${prefix}type VARCHAR(16) NOT NULL,
${prefix}message $text NOT NULL,
${prefix}anchor VARCHAR(16),
UNIQUE(${prefix}instance, ${prefix}number)
)
}
} history {
{
CREATE TABLE history (
${prefix}instant $timeStamp NOT NULL,
${prefix}instance INTEGER NOT NULL REFERENCES instances,
${prefix}row $rowType NOT NULL,
${prefix}entry INTEGER NOT NULL,
${prefix}value VARCHAR(255)
)
} {
CREATE INDEX cell ON history (${prefix}instance, ${prefix}row, ${prefix}entry)
}
} data {
{
CREATE TABLE data (
${prefix}instance INTEGER NOT NULL REFERENCES instances,
${prefix}row $rowType NOT NULL,
${prefix}entry INTEGER NOT NULL,
${prefix}label VARCHAR(255) NOT NULL,
${prefix}comment VARCHAR(255),
UNIQUE(${prefix}instance, ${prefix}row, ${prefix}entry)
)
}
}
"
set ($this,created) 0 ;# public flag so that we know whether one or more tables were just created
foreach table {instances options entries history data} { ;# in proper order for references to work
set query "SELECT COUNT(*) FROM $table"
set ($this,ignoreErrors) {} ;# just for the time when table existence is checked
if {$file} {
sqliteEvaluate $this $query
} elseif {$odbc} {
odbcConnection $this $query
} else {
mysqlSelect $this $query
}
unset ($this,ignoreErrors)
if {[string length $($this,error)] == 0} continue ;# table exists already
if {$global::withGUI} {
lifoLabel::push $global::messenger [format [mc {creating database table %s...}] $table]
busy 1 .
}
foreach statement $statements($table) {
if {$file} {
sqliteEvaluate $this $statement
} elseif {$odbc} {
odbcConnection $this $statement
} else {
mysqlExecute $this $statement
}
if {[string length $($this,error)] > 0} break ;# fatal error, abort, as error is handled by invoker
}
if {$global::withGUI} {
busy 0 .
lifoLabel::pop $global::messenger
}
set ($this,created) [expr {[string length $($this,error)] == 0}]
if {[string length $($this,error)] > 0} break ;# fatal error, abort, as error is handled by invoker
}
}
proc checkFormat {this} { ;# check columns for the tables that have changed at moomps version 2.3
if {$($this,file)} {
set ($this,oldFormat) 0
set ($this,64bits) 1 ;# SQLite columns are typeless
return ;# SQLite support came later
}
if {$($this,odbc)} { ;# "$connection columns $table" is not supported by PostgreSQL, so use brute method
set prefix $($this,prefix)
set ($this,ignoreErrors) {}
odbcConnection $this "SELECT COUNT(${prefix}identifier) FROM instances"
if {[string length $($this,error)] == 0} {set instances(identifier) {}}
odbcConnection $this "SELECT COUNT(${prefix}instance) FROM entries"
if {[string length $($this,error)] == 0} {set entries(instance) {}}
unset ($this,ignoreErrors)
} else { ;# MySQL native driver
foreach table {instances entries} {
set columns [mysqlColumns $this $table name]
if {[string length $($this,error)] > 0} return ;# fatal error, abort, as error is handled by invoker
foreach column $columns {
set ${table}($column) {}
}
}
}
if {[info exists instances(identifier)]} {
set new instances
if {![info exists entries(instance)]} {set old entries}
set ($this,oldFormat) 0
} else {
set old instances
if {[info exists entries(instance)]} {set new entries}
set ($this,oldFormat) 1
}
if {[info exists old] && [info exists new]} {
set ($this,error) "database fatal error: \"$new\" table in new format but \"$old\" table in old format (see upgrading section in database documentation)"
}
foreach {data history} [64bitRows $this] {}
if {$data != $history} {
set ($this,error) "database fatal error: data and history tables have mismatched types for the row column"
}
set ($this,64bits) $data
if {$($this,64bits) && [package vcompare $::tcl_version 8.4] < 0} {
set ($this,error) "error: database has 64 bits support for rows but Tcl core (version $::tcl_version) does not"
}
}
proc 64bitRows {this} { ;# return data and history table 64 bit rows support in a list of booleans
if {$($this,odbc)} {
if {[string equal $($this,type) oracle]} {
return [list 1 1] ;# base INTEGER type already supports huge numbers
}
if {[string equal $::tcl_platform(platform) windows]} { ;### no checking ###
return [list 1 1] ;### tclodbc windows bug, sample bogus data found below: "{} 4 {} {} {} NO {} {} {} {} {} {}" ###
}
foreach data [concat [odbcConnection $this columns data] [odbcConnection $this columns history]] {
foreach {qualifier owner name column typeCode type precision length scale radix nullable remarks} $data {}
if {[string equal $column row]} {
lappend list [string equal $type bigint]
continue
}
}
return $list
} else {
foreach table [list data history] {
set type [lindex [mysqlSelect $this "SHOW COLUMNS FROM $table LIKE 'row'" -flatlist] 1]
lappend list [string match -nocase BIGINT* $type]
}
return $list
}
}
# return date and time in a format suitable for direct insertion into a date and time column, or use in a query
proc dateTime {this {seconds {}}} {
if {[string length $seconds] == 0} {set seconds [clock seconds]} ;# use current time if not specified
if {$($this,file)} {
return $seconds ;# SQLite cannot handle dates and times, just numbers or text
}
set string [clock format $seconds -format $(dateTimeFormat)]
if {$($this,odbc) && [string equal $($this,type) oracle]} { ;# Oracle special case
return "TO_DATE('$string', 'YYYY-MM-DD HH:MI:SS')"
} else {
return '$string' ;# pre-formatted with quotes
}
}
}
if {$global::withGUI} {
class database {
proc modules {this} {
# ignore zero instance (may be needed in a converted old format table) and post creation instances
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT DISTINCT ${prefix}module FROM instances WHERE (${prefix}number > 0) AND (${prefix}start <= $($this,start)) ORDER BY ${prefix}module"
return [join [odbcConnection $this $query]]
} else {
set query "SELECT DISTINCT module FROM instances WHERE (number > 0) AND (start <= $($this,start)) ORDER BY module"
if {$($this,file)} {
return [sqliteEvaluate $this $query]
} else {
return [mysqlSelect $this $query -flatlist]
}
}
}
proc moduleRange {this module {busyWidgets .}} { ;# return time boundaries for all module instances
lifoLabel::push $global::messenger [mc {retrieving module instances range from database...}]
busy 1 $busyWidgets
# find time boundaries from all cell histories for that module instances:
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT MIN(${prefix}instant), MAX(${prefix}instant) FROM instances, history WHERE (${prefix}module = '$module') AND (${prefix}instance = ${prefix}number) AND (${prefix}instant <= $($this,start))"
set list [join [odbcConnection $this $query]]
} else {
set query "SELECT MIN(instant), MAX(instant) FROM instances, history WHERE (module = '$module') AND (instance = number) AND (instant <= $($this,start))"
if {$($this,file)} {
set list [sqliteEvaluate $this $query]
foreach {minimum maximum} $list {}
if {[string length $minimum] > 0} { ;# if no history, a list of empty values is returned by SQLite
set list\
[list [clock format $minimum -format $(dateTimeFormat)] [clock format $maximum -format $(dateTimeFormat)]]
}
} else {
set list [mysqlSelect $this $query -flatlist]
}
}
busy 0 $busyWidgets
lifoLabel::pop $global::messenger
return $list
}
proc instances {this module} {
# ignore zero instance (may be needed in a converted old format table) and post creation instances
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT ${prefix}number FROM instances WHERE (${prefix}number > 0) AND (${prefix}module = '$module') AND (${prefix}start <= $($this,start)) ORDER BY ${prefix}number"
return [join [odbcConnection $this $query]]
} else {
set query "SELECT number FROM instances WHERE (number > 0) AND (module = '$module') AND (start <= $($this,start)) ORDER BY number"
if {$($this,file)} {
return [sqliteEvaluate $this $query]
} else {
return [mysqlSelect $this $query -flatlist]
}
}
}
proc instanceRange {this instance {busyWidgets .}} { ;# return time boundaries for instance
lifoLabel::push $global::messenger [mc {retrieving module instance range from database...}]
busy 1 $busyWidgets
# find time boundaries from all cell histories for that instance:
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT MIN(${prefix}instant), MAX(${prefix}instant) FROM history WHERE (${prefix}instance = $instance) AND (${prefix}instant <= $($this,start))"
set list [join [odbcConnection $this $query]]
} else {
set query "SELECT MIN(instant), MAX(instant) FROM history WHERE (instance = $instance) AND (instant <= $($this,start))"
if {$($this,file)} {
set list [sqliteEvaluate $this $query]
foreach {minimum maximum} $list {}
if {[string length $minimum] > 0} { ;# if no history, a list of empty values is returned by SQLite
set list\
[list [clock format $minimum -format $(dateTimeFormat)] [clock format $maximum -format $(dateTimeFormat)]]
}
} else {
set list [mysqlSelect $this $query -flatlist]
}
}
busy 0 $busyWidgets
lifoLabel::pop $global::messenger
return $list
}
proc arguments {this instance} {
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT ${prefix}name, ${prefix}value FROM options WHERE ${prefix}instance = $instance ORDER BY ${prefix}name"
return [join [odbcConnection $this $query]]
} else {
set query "SELECT name, value FROM options WHERE instance = $instance ORDER BY name"
if {$($this,file)} {
return [sqliteEvaluate $this $query]
} else {
return [mysqlSelect $this $query -flatlist]
}
}
}
proc identifier {this instance} {
if {!$($this,oldFormat)} { ;# new database format
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT ${prefix}identifier FROM instances WHERE ${prefix}number = $instance"
set identifier [lindex [join [odbcConnection $this $query]] 0]
} else {
set query "SELECT identifier FROM instances WHERE number = $instance"
if {$($this,file)} {
set identifier [lindex [sqliteEvaluate $this $query] 0]
} else {
set identifier [lindex [mysqlSelect $this $query -flatlist] 0]
}
}
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
if {[string length $identifier] > 0} { ;# valid identifier was found in the new database format
return $identifier
}
} ;# else identifier column may have been added to the instances table in an old format database, so return module
# note: old database format was never used against oracle and therefore no table column name prefixing is needed
set query "SELECT module FROM instances WHERE number = $instance"
if {$($this,odbc)} {
return [lindex [join [odbcConnection $this $query]] 0]
} else {
return [lindex [mysqlSelect $this $query -flatlist] 0]
}
}
proc version {this instance} { ;# return major.minor (2.1 for example)
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT ${prefix}major, ${prefix}minor FROM instances WHERE ${prefix}number = $instance"
return [join [join [odbcConnection $this $query]] .]
} else {
set query "SELECT major, minor FROM instances WHERE number = $instance"
if {$($this,file)} {
return [join [sqliteEvaluate $this $query] .]
} else {
return [join [mysqlSelect $this $query -flatlist] .]
}
}
}
proc cellsData {this instance} {
set list {}
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT ${prefix}row, ${prefix}entry, ${prefix}label, ${prefix}comment FROM data WHERE ${prefix}instance = $instance ORDER BY ${prefix}row, ${prefix}entry"
foreach {row entry label comment} [join [odbcConnection $this $query]] {
if {$row < 0} {set row [unsigned $this $row]}
lappend list $row $entry $label $comment
}
} else {
set query "SELECT row, entry, label, comment FROM data WHERE instance = $instance ORDER BY row, entry"
if {$($this,file)} {
foreach {row entry label comment} [sqliteEvaluate $this $query] {
if {$row < 0} {set row [unsigned $this $row]}
lappend list $row $entry $label $comment
}
} else {
foreach {row entry label comment} [mysqlSelect $this $query -flatlist] {
if {$row < 0} {set row [unsigned $this $row]}
lappend list $row $entry $label $comment
}
}
}
return $list
}
# If time limits are not specified, return timestamp limits for whole data cell history.
# If start and end times are specified, return timestamp limits for data cell history lying between specified parameter times.
proc cellRange {this instance row entry {startSeconds {}} {endSeconds {}} {busyWidgets .}} { ;# seconds as in UNIX time
variable ${this}cache
set index range,$instance,$row,$entry,$startSeconds,$endSeconds
if {[info exists ${this}cache($index)]} {
return [set ${this}cache($index)]
}
set odbc $($this,odbc)
if {$odbc} {
set prefix $($this,prefix)
set query "SELECT MIN(${prefix}instant), MAX(${prefix}instant) FROM history WHERE (${prefix}instance = $instance) AND (${prefix}row = [signed $this $row]) AND (${prefix}entry = $entry) AND (${prefix}instant <= $($this,start))"
} else {
set query "SELECT MIN(instant), MAX(instant) FROM history WHERE (instance = $instance) AND (row = [signed $this $row]) AND (entry = $entry) AND (instant <= $($this,start))"
}
if {([string length $startSeconds] > 0) && ([string length $endSeconds] > 0)} {
if {$odbc} {
append query " AND (${prefix}instant BETWEEN [dateTime $this $startSeconds] AND [dateTime $this $endSeconds])"
} else {
append query " AND (instant BETWEEN [dateTime $this $startSeconds] AND [dateTime $this $endSeconds])"
}
}
lifoLabel::push $global::messenger [mc {retrieving cell range from database...}]
busy 1 $busyWidgets
if {$($this,file)} {
set list [sqliteEvaluate $this $query]
foreach {minimum maximum} $list {}
if {[string length $minimum] > 0} { ;# if no history, a list of empty values is returned by SQLite
set list [list [clock format $minimum -format $(dateTimeFormat)] [clock format $maximum -format $(dateTimeFormat)]]
}
} elseif {$odbc} {
set list [join [odbcConnection $this $query]]
} else {
set list [mysqlSelect $this $query -flatlist]
}
busy 0 $busyWidgets
lifoLabel::pop $global::messenger
return [set ${this}cache($index) $list] ;# (a list of 2 empty strings if no history data)
}
proc moduleData {this instance} {
if {!$($this,oldFormat)} { ;# new database format (starting at moomps 2.3)
if {$($this,odbc)} {
set prefix $($this,prefix)
set query "SELECT ${prefix}number, ${prefix}indexed, ${prefix}label, ${prefix}type, ${prefix}message, ${prefix}anchor FROM entries WHERE ${prefix}instance = $instance"
set list [odbcConnection $this $query]
} else {
set query "SELECT number, indexed, label, type, message, anchor FROM entries WHERE instance = $instance"
if {$($this,file)} {
set list {}
foreach {number indexed label type message anchor} [sqliteEvaluate $this $query] {
lappend list [list $number $indexed $label $type $message $anchor]
}
} else {
set list [mysqlSelect $this $query -list]
}
}
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
if {[llength $list] > 0} { ;# valid data was found in the new database format
return $list ;# list of lists
}
} ;# else instance column may have been added to the entries table in an old format database, so try old method below
# note: old database format was never used against oracle and therefore no table column name prefixing is needed
set query "SELECT module, major, minor FROM instances WHERE number = $instance"
if {$($this,odbc)} {
foreach {module major minor} [join [odbcConnection $this $query]] {}
} else {
foreach {module major minor} [mysqlSelect $this $query -flatlist] {}
}
set query "SELECT number, indexed, label, type, message, anchor FROM entries WHERE (module = '$module') AND (major = $major) AND (minor = $minor)"
if {$($this,odbc)} {
return [odbcConnection $this $query] ;# list of lists
} else {
return [mysqlSelect $this $query -list] ;# list of lists
}
}
# Return timestamp, value, timestamp, value, ... flat list.
# If time limits are not specified, return all samples ever recorded for data cell.
# If only end time is specified, return sole sample that recorded nearest (before or at) the specified time.
# If start and end times are specified, return all samples recorded between (inclusive) specified times.
proc cellHistory {this instance row entry startSeconds endSeconds last {busyWidgets .}} { ;# seconds as in UNIX time
variable ${this}cache
set index history,$instance,$row,$entry,$startSeconds,$endSeconds
if {$last && [info exists ${this}cache($index)]} {
return [set ${this}cache($index)]
}
set odbc $($this,odbc)
if {$odbc} {
set prefix $($this,prefix)
set query "SELECT ${prefix}instant, ${prefix}value FROM history WHERE (${prefix}instance = $instance) AND (${prefix}row = [signed $this $row]) AND (${prefix}entry = $entry) AND (${prefix}instant BETWEEN [dateTime $this $startSeconds] AND [dateTime $this $endSeconds]) AND (${prefix}instant <= $($this,start))"
} else {
set query "SELECT instant, value FROM history WHERE (instance = $instance) AND (row = [signed $this $row]) AND (entry = $entry) AND (instant BETWEEN [dateTime $this $startSeconds] AND [dateTime $this $endSeconds]) AND (instant <= $($this,start))"
}
if {$last} { ;# sole sample
if {$odbc} {
if {[string equal $($this,type) oracle]} {
append query " AND (ROWNUM <= 1) ORDER BY ${prefix}instant DESC"
} else {
append query " ORDER BY ${prefix}instant DESC "
regsub -all %l $($this,limit) 1 limit
append query $limit
}
} else {
append query " ORDER BY instant DESC LIMIT 1"
}
} else { ;# range
if {$odbc} {
append query " ORDER BY ${prefix}instant"
} else {
append query " ORDER BY instant"
}
}
if {$last} { ;# sole sample
lifoLabel::push $global::messenger [mc {retrieving cell value before end cursor from database...}]
} else { ;# range
lifoLabel::push $global::messenger [mc {retrieving cell history from database...}]
}
busy 1 $busyWidgets
if {$($this,file)} {
set list {}
foreach {seconds value} [sqliteEvaluate $this $query] {
lappend list [clock format $seconds -format $(dateTimeFormat)] $value
}
} elseif {$odbc} {
set list [join [odbcConnection $this $query]]
} else { ;# MySQL: format time stamp into a standard form
set list [mysqlSelect $this $query -flatlist]
}
busy 0 $busyWidgets
lifoLabel::pop $global::messenger
if {$last} { ;# always cache single values since it does not take much memory
set ${this}cache($index) $list
}
return $list ;# empty in case of database error
}
# return SQL query in strings list form, so it can be used (for example by pasting in a client) to retrieve data cell history
proc historyQuery {this instance row entry start end} {
set odbc $($this,odbc)
if {$odbc} {
set prefix $($this,prefix)
lappend list \
"SELECT ${prefix}instant, ${prefix}value FROM history
WHERE (${prefix}instance = $instance) AND (${prefix}row = [signed $this $row]) AND (${prefix}entry = $entry)"
} else {
lappend list \
"SELECT instant, value FROM history
WHERE (instance = $instance) AND (row = [signed $this $row]) AND (entry = $entry)"
}
if {([string length $start] > 0) && ([string length $end] > 0)} { ;# else no data
if {$odbc} {
if {[string equal $($this,type) oracle]} { ;# Oracle special case
lappend list "AND (${prefix}instant >= TO_DATE('$start', 'YYYY-MM-DD HH:MI:SS')) AND (${prefix}instant <= TO_DATE('$end', 'YYYY-MM-DD HH:MI:SS'))"
} else {
lappend list "AND (${prefix}instant >= '$start') AND (${prefix}instant <= '$end')"
}
} else {
lappend list "AND (instant >= '$start') AND (instant <= '$end')"
}
} else {
lappend list {} ;# time limits are optional
}
if {$odbc} {
lappend list "ORDER BY ${prefix}instant"
} else {
lappend list "ORDER BY instant"
}
return $list
}
}
}
class database {
# the code below is executed in the main interpreter, since there is only 1 database object, which corresponds to 1 connection
proc register {this instanceData} { ;# array contents as a list
array set data $instanceData
set module $data(module)
set file $($this,file)
set odbc $($this,odbc)
foreach {major minor} [lrange [split $data(version) .] 0 1] {} ;# only keep major and minor version parts
if {$odbc} {
set prefix $($this,prefix)
set arguments {}
}
# first find out whether there is a recorded instance for the module with the same major version number and options
if {![info exists data(options)] || ([llength $data(options)] == 0)} { ;# no options special case
if {$odbc} {
set query "SELECT ${prefix}number FROM instances LEFT OUTER JOIN options ON ${prefix}number = ${prefix}instance WHERE (${prefix}module = '$module') AND (${prefix}major = $major) GROUP BY ${prefix}number HAVING COUNT(${prefix}instance) = 0"
} else {
set query "SELECT number FROM instances LEFT OUTER JOIN options ON number = instance WHERE (module = '$module') AND (major = $major) GROUP BY number HAVING COUNT(instance) = 0"
}
} else {
# use a left join on options table self, the matching instance being the unique one if any, with the correct number of
# options and that all match
if {$odbc} {
set query "SELECT ${prefix}number FROM instances, options LEFT OUTER JOIN options AS joined ON (options.${prefix}instance = joined.${prefix}instance) AND (options.${prefix}name = joined.${prefix}name)"
} else {
set query "SELECT number FROM instances, options LEFT OUTER JOIN options AS joined ON (options.instance = joined.instance) AND (options.name = joined.name)"
}
set count 0
foreach {name value} $data(options) { ;# options are switch/value pairs in a flat list
if {$count == 0} {
append query " AND ("
} else {
append query " OR "
}
if {$odbc} { ;# pass names (which may contain special characters) as statement arguments for automatic escaping
append query "((options.${prefix}name = "
append query ?
lappend arguments $name
append query ") AND (options.${prefix}value "
} else {
append query "((options.name = "
if {$file} {
append query '[sqliteEscape $name]' ;# eventually escape special characters
} else {
append query '[mysqlescape $name]' ;# eventually escape special characters
}
append query ") AND (options.value "
}
if {[string length $value] == 0} {
append query "IS NULL"
} else {
append query "= "
if {$file} {
append query '[sqliteEscape $value]' ;# eventually escape special characters
} elseif {$odbc} {
# pass values (which may contain special characters) as statement arguments for automatic escaping
append query ?
lappend arguments $value
} else {
append query '[mysqlescape $value]' ;# eventually escape special characters
}
}
append query "))"
incr count
}
if {$count > 0} { ;# there were options
append query ")"
}
if {$odbc} { ;# note: grouping by options instance is not necessary but required by PostgreSQL
append query " WHERE (${prefix}module = '$module') AND (${prefix}major = $major) AND (${prefix}number = options.${prefix}instance) GROUP BY ${prefix}number, options.${prefix}instance HAVING (COUNT(*) = COUNT(joined.${prefix}instance)) AND (COUNT(*) = $count)"
} else {
append query " WHERE (module = '$module') AND (major = $major) AND (number = options.instance) GROUP BY number, options.instance HAVING (COUNT(*) = COUNT(joined.instance)) AND (COUNT(*) = $count)"
}
}
if {$file} {
set instance [lindex [sqliteEvaluate $this $query] 0]
} elseif {$odbc} {
set instance [lindex [join [odbcConnection $this $query $arguments]] 0]
} else {
set instance [lindex [mysqlSelect $this $query -flatlist] 0]
}
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
if {[string length $instance] == 0} { ;# no matching instance: create new entries for that module and its specific options
if {[info exists data(options)]} {set options $data(options)} else {set options {}}
set instance [insertInstance $this $module $data(identifier) $major $minor $options]
} else {
updateInstance $this $instance $data(identifier) $minor
}
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
updateEntries $this $instance $data(indexColumns) $data(data) ;# always update entries
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
return $instance
}
proc insertInstance {this module identifier major minor options} {
set file $($this,file)
set odbc $($this,odbc)
if {[info exists ($this,lock)]} { ;# eventually lock table to prevent concurrency induced problems
regsub -all %t $($this,lock) instances statement
if {$odbc} {odbcConnection $this $statement} else {mysqlExecute $this $statement}
}
if {$odbc} {
set prefix $($this,prefix)
set query "SELECT MAX(${prefix}number) FROM instances"
set instance [lindex [join [odbcConnection $this $query]] 0]
} else {
set query "SELECT MAX(number) FROM instances"
if {$file} {
set instance [lindex [sqliteEvaluate $this $query] 0]
} else {
set instance [lindex [mysqlSelect $this $query -flatlist] 0]
}
}
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
if {[string length $instance] == 0} {set instance 0} ;# there were no instances yet
incr instance ;# take next number
set statement "INSERT INTO instances VALUES ($instance, [dateTime $this], " ;# store very first instance creation time
if {$file} {
append statement "'[sqliteEscape $module]', '[sqliteEscape $identifier]', " ;# escape special characters
} elseif {$odbc} { ;# pass names (which may contain special characters) as statement arguments for automatic escaping
append statement {?, ?, }
set arguments [list $module $identifier]
} else {
append statement "'[mysqlescape $module]', '[mysqlescape $identifier]', " ;# escape special characters
}
append statement "$major, $minor)" ;# store very first instance minor version
if {$file} {
sqliteEvaluate $this $statement
} elseif {$odbc} {
odbcConnection $this $statement $arguments
} else {
mysqlExecute $this $statement
}
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
if {[info exists ($this,unlock)]} {
regsub -all %t $($this,unlock) instances statement
if {$odbc} {odbcConnection $this $statement} else {mysqlExecute $this $statement}
}
foreach {name value} $options {
if {$odbc} {
set arguments {}
}
set statement "INSERT INTO options VALUES ($instance, "
if {$file} {
append statement '[sqliteEscape $name]' ;# eventually escape special characters
} elseif {$odbc} { ;# pass names (which may contain special characters) as statement arguments for automatic escaping
append statement ?
lappend arguments $name
} else {
append statement '[mysqlescape $name]' ;# eventually escape special characters
}
append statement ", "
if {[string length $value] == 0} {
append statement NULL
} else {
if {[regexp $global::passwordOptionExpression $name]} {
set value [string repeat * [string length $value]] ;# do not store readable password value
}
if {$file} {
append statement '[sqliteEscape $value]' ;# eventually escape special characters
} elseif {$odbc} {
# pass names (which may contain special characters) as statement arguments for automatic escaping
append statement ?
lappend arguments $value
} else {
append statement '[mysqlescape $value]' ;# eventually escape special characters
}
}
append statement )
if {$file} {
sqliteEvaluate $this $statement
} elseif {$odbc} {
odbcConnection $this $statement $arguments
} else {
mysqlExecute $this $statement
}
if {[string length $($this,error)] > 0} {return {}} ;# abort in case of error
}
return $instance
}
proc updateInstance {this instance identifier minor} { ;# update instance variable parts
set odbc $($this,odbc)
set file $($this,file)
if {$odbc} { ;# pass name (which may contain special characters) as statement argument for automatic escaping
set prefix $($this,prefix)
set statement "UPDATE instances SET ${prefix}start = [dateTime $this], ${prefix}identifier = "
append statement ?
append statement ", ${prefix}minor = $minor WHERE ${prefix}number = $instance"
} else {
set statement "UPDATE instances SET start = [dateTime $this], identifier = "
if {$file} {
append statement '[sqliteEscape $identifier]' ;# escape special characters
} else {
append statement '[mysqlescape $identifier]' ;# escape special characters
}
append statement ", minor = $minor WHERE number = $instance"
}
if {$file} {
sqliteEvaluate $this $statement
} elseif {$odbc} {
odbcConnection $this $statement [list $identifier]
} else {
mysqlExecute $this $statement
}
}
proc updateEntries {this instance indexColumns data} {
set file $($this,file)
set odbc $($this,odbc)
# delete existing entries if any first for resiliency sake
if {$odbc} {
set prefix $($this,prefix)
set statement "DELETE FROM entries WHERE ${prefix}instance = $instance"
odbcConnection $this $statement
} else {
set statement "DELETE FROM entries WHERE instance = $instance"
if {$file} {
sqliteEvaluate $this $statement
} else {
mysqlExecute $this $statement
}
}
if {[string length $($this,error)] > 0} return ;# abort in case of error
foreach index $indexColumns {set indexed($index) {}}
set index 0 ;# column index
foreach {label type message anchor} $data { ;# now store module columns data
if {$odbc} {
set arguments {}
}
# entries table may still include module, major and minor columns, so use a statement with named columns:
if {$odbc} {
set statement "INSERT INTO entries (${prefix}instance, ${prefix}number, ${prefix}indexed, ${prefix}label, ${prefix}type, ${prefix}message, ${prefix}anchor) VALUES ("
} else {
set statement "INSERT INTO entries (instance, number, indexed, label, type, message, anchor) VALUES ("
}
append statement "$instance, $index, [info exists indexed($index)], "
if {$file} {
append statement '[sqliteEscape $label]' ;# eventually escape special characters
} elseif {$odbc} { ;# pass labels (which may contain special characters) as statement arguments for automatic escaping
append statement ?
lappend arguments $label
} else {
append statement '[mysqlescape $label]' ;# eventually escape special characters
}
append statement ", '$type', "
if {$file} {
append statement '[sqliteEscape $message]'
} elseif {$odbc} {
append statement ?
lappend arguments $message
} else {
append statement '[mysqlescape $message]'
}
append statement ", "
if {[string length $anchor] == 0} {
append statement NULL
} else {
append statement '$anchor'
}
append statement )
if {$file} {
sqliteEvaluate $this $statement
} elseif {$odbc} {
odbcConnection $this $statement $arguments
} else {
mysqlExecute $this $statement
}
if {[string length $($this,error)] > 0} return ;# abort in case of error
incr index
}
}
proc update {this instance row entry value} { ;# update data cell value
set file $($this,file)
set odbc $($this,odbc)
if {![info exists ($this,connection)]} { ;# disconnected on prior error: attempt to reconnect
if {$file} {
sqliteOpen $this
} elseif {$odbc} {
odbcConnect $this
} else {
mysqlConnect $this
}
if {[string length $($this,error)] > 0} return ;# retry later
}
if {$odbc} {
set arguments {}
}
set statement "INSERT"
if {!$file && (!$odbc || [string equal $($this,type) mysql])} { ;# MySQL database
# make statement very quick so as not to affect modules, such as snmp which may time out if MySQL server is very busy
append statement " DELAYED"
}
append statement " INTO history VALUES ([dateTime $this], $instance, [signed $this $row], $entry, "
if {[string equal $value ?]} { ;# unknown value
append statement NULL
} elseif {$odbc} {
append statement ?
lappend arguments $value
} else {
if {$file} {
append statement '[sqliteEscape $value]' ;# eventually escape special characters
} else {
append statement '[mysqlescape $value]' ;# eventually escape special characters
}
}
append statement )
if {$file} {
sqliteEvaluate $this $statement
} elseif {$odbc} {
odbcConnection $this $statement $arguments
} else {
mysqlExecute $this $statement
}
if {[string length $($this,error)] > 0} { ;# error: probably a disconnection
disconnect $this ;# just in case, but ignore errors
}
}
proc monitor {this instance row entry label comment} { ;# initialize some data cell static data
set file $($this,file)
set odbc $($this,odbc)
if {$odbc} {
set arguments {}
}
if {$odbc} {
set prefix $($this,prefix)
set statement "DELETE FROM data WHERE (${prefix}instance = $instance) AND (${prefix}row = [signed $this $row]) AND (${prefix}entry = $entry)"
odbcConnection $this $statement
} else {
set statement "DELETE FROM data WHERE (instance = $instance) AND (row = [signed $this $row]) AND (entry = $entry)"
if {$file} {
sqliteEvaluate $this $statement
} else {
mysqlExecute $this $statement
}
}
set statement "INSERT INTO data VALUES ($instance, [signed $this $row], $entry, "
if {$file} {
append statement '[sqliteEscape $label]' ;# eventually escape special characters
} elseif {$odbc} { ;# pass label (which may contain special characters) as statement arguments for automatic escaping
append statement ?
lappend arguments $label
} else {
append statement '[mysqlescape $label]' ;# eventually escape special characters
}
append statement ", "
if {[string equal $comment {}]} {
append statement NULL
} elseif {$odbc} {
append statement ?
lappend arguments $comment
} else {
if {$file} {
append statement '[sqliteEscape $comment]' ;# eventually escape special characters
} else {
append statement '[mysqlescape $comment]' ;# eventually escape special characters
}
}
append statement )
if {$file} {
sqliteEvaluate $this $statement
} elseif {$odbc} {
odbcConnection $this $statement $arguments
} else {
mysqlExecute $this $statement
}
}
proc sqliteEscape {string} {
regsub -all ' $string '' string ;# escape quotes
return $string
}
proc disconnect {this} {
if {$($this,file)} {
sqliteClose $this
} elseif {$($this,odbc)} {
odbcDisconnect $this
} else {
mysqlDisconnect $this
}
}
if {[package vcompare $::tcl_version 8.4] < 0} {
# convert row into a suitable negative integer value compatible with the database type
proc signed {this integer} {return [expr {$integer}]}
# transform a negative 32 bit integer back into its unsigned representation, as: -1 -> 4294967295, -2147483648 -> 2147483648
# as standard SQL databases do not support unsigned integers
proc unsigned {this integer} {return [format %lu $integer]}
} else { ;# Tcl 8.4, which can handle 64 bit integers
proc signed {this integer} {
if {$($this,64bits)} {return [expr {$integer}]} else {return [expr {int($integer)}]}
}
proc unsigned {this integer} {
if {$($this,64bits)} {return [format %lu $integer]} else {return [expr {$integer & 0xFFFFFFFF}]}
}
}
}
|
