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
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* Welcome to the storage database migration.
*
* If you would like to change anything in the database schema, you must follow
* some steps to make sure that upgrading from old versions works fine.
*
* First of all you must increment the DB_SCHEMA_VERSION variable below. Then
* you must write your upgrader. To do this, create a new function and add it to
* the upgrade object, similar to the existing upgraders below. An example is
* given below.
*
* An upgrader MUST update both the database (if it is passed) AND the table
* data javascript object. An example for a such object is in the v1/v2
* upgrader. The process of upgrading calls the latest upgrader with the
* database object and the current database version. The whole chain of
* upgraders is then called (down to v1). The first upgrader (v1/v2) provides
* the basic table data object. Each further upgrader then updates this object
* to correspond with the database tables and columns. No actual database calls
* are made until the first upgrader with a higher version than the current
* database version is called. When this version is arrived, both the table data
* object and the database are updated. This process continues until the
* database is at the latest version.
*
* Note that your upgrader is not necessarily called with a database object,
* for example if the user's database is already at a higher version. In this
* case your upgrader is called to compile the table data object. To make
* calling code easier, there are a bunch of helper functions below that can be
* called with a null database object and only call the database object if it is
* not null. If you need to call new functions on the database object, check out
* the createDBDelegate function below.
*
* When adding new tables to the table data object, please note that there is a
* special prefix for indexes. These are also kept in the table data object to
* make sure that getAllSql also includes CREATE INDEX statements. New tables
* MUST NOT be prefixed with "idx_". If you would like to add a new index,
* please use the createIndex function.
*
* The basic structure for an upgrader is (NN is current version, XX = NN - 1)
*
* upgrader.vNN = function upgrade_vNN(db, version) {
* let tbl = upgrade.vXX(version < XX && db, version);
* LOGdb(db, "Storage: Upgrading to vNN");
*
* beginTransaction(db);
* try {
* // Do stuff here
* setDbVersionAndCommit(db, NN);
* } catch (e) {
* throw reportErrorAndRollback(db, e);
* }
* return tbl;
* }
*
* Regardless of how your upgrader looks, make sure you:
* - use an sql transaction, if you have a database
* - If everything succeeds, call setDbVersionAndCommit to update the database
* version (setDbVersionAndCommit also commits the transaction)
* - If something fails, throw reportErrorAndRollback(db, e) to report the
* failure and roll back the transaction.
*
* If this documentation isn't sufficient to make upgrading understandable,
* please file a bug.
*/
var EXPORTED_SYMBOLS = [
"DB_SCHEMA_VERSION",
"getSql",
"getAllSql",
"getSqlTable",
"upgradeDB",
"backupDB",
];
var { cal } = ChromeUtils.import("resource:///modules/calendar/calUtils.jsm");
var { CAL_ITEM_FLAG, textToDate, getTimezone, newDateTime } = ChromeUtils.import(
"resource:///modules/calendar/calStorageHelpers.jsm"
);
var { XPCOMUtils } = ChromeUtils.importESModule("resource://gre/modules/XPCOMUtils.sys.mjs");
const lazy = {};
XPCOMUtils.defineLazyModuleGetters(lazy, {
CalAlarm: "resource:///modules/CalAlarm.jsm",
CalAttachment: "resource:///modules/CalAttachment.jsm",
CalAttendee: "resource:///modules/CalAttendee.jsm",
CalRelation: "resource:///modules/CalRelation.jsm",
});
// The current database version. Be sure to increment this when you create a new
// updater.
var DB_SCHEMA_VERSION = 23;
/**
* Gets the SQL for the given table data and table name. This can be both a real
* table or the name of an index. Indexes must contain the idx_ prefix.
*
* @param tblName The name of the table or index to retrieve sql for
* @param tblData The table data object, as returned from the upgrade_v*
* functions. If null, then the latest table data is
* retrieved.
* @param alternateName (optional) The table or index name to be used in the
* resulting CREATE statement. If not set, tblName will
* be used.
* @returns The SQL Statement for the given table or index and
* version as a string.
*/
function getSql(tblName, tblData, alternateName) {
tblData = tblData || getSqlTable();
let altName = alternateName || tblName;
let sql;
if (tblName.substr(0, 4) == "idx_") {
// If this is an index, we need construct the SQL differently
let idxTbl = tblData[tblName].shift();
let idxOn = idxTbl + "(" + tblData[tblName].join(",") + ")";
sql = `CREATE INDEX ${altName} ON ${idxOn};`;
} else {
sql = `CREATE TABLE ${altName} (\n`;
for (let [key, type] of Object.entries(tblData[tblName])) {
sql += ` ${key} ${type},\n`;
}
}
return sql.replace(/,\s*$/, ");");
}
/**
* Gets all SQL for the given table data
*
* @param version The database schema version to retrieve. If null, the
* latest schema version will be used.
* @returns The SQL Statement for the given version as a string.
*/
function getAllSql(version) {
let tblData = getSqlTable(version);
let sql = "";
for (let tblName in tblData) {
sql += getSql(tblName, tblData) + "\n\n";
}
cal.LOG("Storage: Full SQL statement is " + sql);
return sql;
}
/**
* Get the JS object corresponding to the given schema version. This object will
* contain both tables and indexes, where indexes are prefixed with "idx_".
*
* @param schemaVersion The schema version to get. If null, the latest
* schema version will be used.
* @returns The javascript object containing the table
* definition.
*/
function getSqlTable(schemaVersion) {
let version = "v" + (schemaVersion || DB_SCHEMA_VERSION);
if (version in upgrade) {
return upgrade[version]();
}
return {};
}
/**
* Gets the current version of the storage database
*/
function getVersion(db) {
let selectSchemaVersion;
let version = null;
try {
selectSchemaVersion = createStatement(
db,
"SELECT version FROM cal_calendar_schema_version LIMIT 1"
);
if (selectSchemaVersion.executeStep()) {
version = selectSchemaVersion.row.version;
}
if (version !== null) {
// This is the only place to leave this function gracefully.
return version;
}
} catch (e) {
throw reportErrorAndRollback(db, e);
} finally {
if (selectSchemaVersion) {
selectSchemaVersion.finalize();
}
}
throw new Error("cal_calendar_schema_version SELECT returned no results");
}
/**
* Backup the database and notify the user via error console of the process
*/
function backupDB(db, currentVersion) {
cal.LOG("Storage: Backing up current database...");
try {
// Prepare filenames and path
let backupFilename = "local.v" + currentVersion + ".sqlite";
let backupPath = cal.provider.getCalendarDirectory();
backupPath.append("backup");
if (!backupPath.exists()) {
backupPath.create(Ci.nsIFile.DIRECTORY_TYPE, parseInt("0755", 8));
}
// Create a backup file and notify the user via WARN, since LOG will not
// be visible unless a pref is set.
let file = Services.storage.backupDatabaseFile(db.databaseFile, backupFilename, backupPath);
cal.WARN(
"Storage: Upgrading to v" + DB_SCHEMA_VERSION + ", a backup was written to: " + file.path
);
} catch (e) {
cal.ERROR("Storage: Error creating backup file: " + e);
}
}
/**
* Upgrade the passed database.
*
* @param storageCalendar - An instance of CalStorageCalendar.
*/
function upgradeDB(storageCalendar) {
let db = storageCalendar.db;
cal.ASSERT(db, "Database has not been opened!", true);
if (db.tableExists("cal_calendar_schema_version")) {
let version = getVersion(db);
if (version < DB_SCHEMA_VERSION) {
upgradeExistingDB(db, version);
} else if (version > DB_SCHEMA_VERSION) {
handleTooNewSchema(storageCalendar);
return;
}
} else {
upgradeBrandNewDB(db);
}
ensureUpdatedTimezones(db);
storageCalendar.afterUpgradeDB();
}
/**
* Upgrade a brand new database.
*
* @param {mozIStorageAsyncConnection} db - New database to upgrade.
*/
function upgradeBrandNewDB(db) {
cal.LOG("Storage: Creating tables from scratch");
beginTransaction(db);
try {
executeSimpleSQL(db, getAllSql());
setDbVersionAndCommit(db, DB_SCHEMA_VERSION);
} catch (e) {
reportErrorAndRollback(db, e);
}
}
/**
* Upgrade an existing database.
*
* @param {mozIStorageAsyncConnection} db - Existing database to upgrade.
* @param {number} version - Version of the database before upgrading.
*/
function upgradeExistingDB(db, version) {
// First, create a backup
backupDB(db, version);
// Then start the latest upgrader
cal.LOG("Storage: Preparing to upgrade v" + version + " to v" + DB_SCHEMA_VERSION);
upgrade["v" + DB_SCHEMA_VERSION](db, version);
}
/**
* Called when the user has downgraded Thunderbird and the older version of
* Thunderbird does not know about the newer schema of their calendar data.
* Log an error, make a backup copy of the data by renaming the data file, and
* restart the database initialization process, which will create a new data
* file that will have the correct schema.
*
* The user will find that their calendar events/tasks are gone. They should
* have exported them to an ICS file before downgrading, and then they can
* import them to get them back.
*
* @param storageCalendar - An instance of CalStorageCalendar.
*/
function handleTooNewSchema(storageCalendar) {
// Create a string like this: "2020-05-11T21-30-17".
let dateTime = new Date().toISOString().split(".")[0].replace(/:/g, "-");
let copyFileName = `local-${dateTime}.sqlite`;
storageCalendar.db.databaseFile.renameTo(null, copyFileName);
storageCalendar.db.close();
let appName = cal.l10n.getAnyString("branding", "brand", "brandShortName");
let errorText = cal.l10n.getCalString("tooNewSchemaErrorText", [appName, copyFileName]);
cal.ERROR(errorText);
storageCalendar.prepareInitDB();
}
/**
* Sets the db version and commits any open transaction.
*
* @param db The mozIStorageConnection to commit on
* @param version The version to set
*/
function setDbVersionAndCommit(db, version) {
let sql =
"DELETE FROM cal_calendar_schema_version;" +
`INSERT INTO cal_calendar_schema_version (version) VALUES (${version})`;
executeSimpleSQL(db, sql);
if (db && db.transactionInProgress) {
commitTransaction(db);
}
}
/**
* Creates a function that calls the given function |funcName| on it's passed
* database. In addition, if no database is passed, the call is ignored.
*
* @param funcName The function name to delegate.
* @returns The delegate function for the passed named function.
*/
function createDBDelegate(funcName) {
return function (db, ...args) {
if (db) {
try {
return db[funcName](...args);
} catch (e) {
cal.ERROR(
"Error calling '" +
funcName +
"' db error: '" +
lastErrorString(db) +
"'.\nException: " +
e
);
cal.WARN(cal.STACK(10));
}
}
return null;
};
}
/**
* Creates a delegate function for a database getter. Returns a function that
* can be called to get the specified attribute, if a database is passed. If no
* database is passed, no error is thrown but null is returned.
*
* @param getterAttr The getter to delegate.
* @returns The function that delegates the getter.
*/
function createDBDelegateGetter(getterAttr) {
return function (db) {
return db ? db[getterAttr] : null;
};
}
// These functions use the db delegate to allow easier calling of common
// database functions.
var beginTransaction = createDBDelegate("beginTransaction");
var commitTransaction = createDBDelegate("commitTransaction");
var rollbackTransaction = createDBDelegate("rollbackTransaction");
var createStatement = createDBDelegate("createStatement");
var executeSimpleSQL = createDBDelegate("executeSimpleSQL");
var removeFunction = createDBDelegate("removeFunction");
var createFunction = createDBDelegate("createFunction");
var lastErrorString = createDBDelegateGetter("lastErrorString");
/**
* Helper function to create an index on the database if it doesn't already
* exist.
*
* @param tblData The table data object to save the index in.
* @param tblName The name of the table to index.
* @param colNameArray An array of columns to index over.
* @param db (optional) The database to create the index on.
*/
function createIndex(tblData, tblName, colNameArray, db) {
let idxName = "idx_" + tblName + "_" + colNameArray.join("_");
let idxOn = tblName + "(" + colNameArray.join(",") + ")";
// Construct the table data for this index
tblData[idxName] = colNameArray.concat([]);
tblData[idxName].unshift(tblName);
// Execute the sql, if there is a db
return executeSimpleSQL(db, `CREATE INDEX IF NOT EXISTS ${idxName} ON ${idxOn}`);
}
/**
* Often in an upgrader we want to log something only if there is a database. To
* make code less cludgy, here a helper function.
*
* @param db The database, or null if nothing should be logged.
* @param msg The message to log.
*/
function LOGdb(db, msg) {
if (db) {
cal.LOG(msg);
}
}
/**
* Report an error and roll back the last transaction.
*
* @param db The database to roll back on.
* @param e The exception to report
* @returns The passed exception, for chaining.
*/
function reportErrorAndRollback(db, e) {
if (db && db.transactionInProgress) {
rollbackTransaction(db);
}
cal.ERROR(
`++++++ Storage error! ++++++ DB Error: ${lastErrorString(db)}\n++++++ Exception: ${e}`
);
return e;
}
/**
* Make sure the timezones of the events in the database are up to date.
*
* @param db The database to bring up to date
*/
function ensureUpdatedTimezones(db) {
// check if timezone version has changed:
let selectTzVersion = createStatement(db, "SELECT version FROM cal_tz_version LIMIT 1");
let tzServiceVersion = cal.timezoneService.version;
let version;
try {
version = selectTzVersion.executeStep() ? selectTzVersion.row.version : null;
} finally {
selectTzVersion.finalize();
}
let versionComp = 1;
if (version) {
versionComp = Services.vc.compare(tzServiceVersion, version);
}
if (versionComp != 0) {
cal.LOG(
"[calStorageCalendar] Timezones have been changed from " +
version +
" to " +
tzServiceVersion +
", updating calendar data."
);
let zonesToUpdate = [];
let getZones = createStatement(
db,
"SELECT DISTINCT(zone) FROM (" +
"SELECT recurrence_id_tz AS zone FROM cal_attendees WHERE recurrence_id_tz IS NOT NULL UNION " +
"SELECT recurrence_id_tz AS zone FROM cal_events WHERE recurrence_id_tz IS NOT NULL UNION " +
"SELECT event_start_tz AS zone FROM cal_events WHERE event_start_tz IS NOT NULL UNION " +
"SELECT event_end_tz AS zone FROM cal_events WHERE event_end_tz IS NOT NULL UNION " +
"SELECT recurrence_id_tz AS zone FROM cal_properties WHERE recurrence_id_tz IS NOT NULL UNION " +
"SELECT recurrence_id_tz AS zone FROM cal_todos WHERE recurrence_id_tz IS NOT NULL UNION " +
"SELECT todo_entry_tz AS zone FROM cal_todos WHERE todo_entry_tz IS NOT NULL UNION " +
"SELECT todo_due_tz AS zone FROM cal_todos WHERE todo_due_tz IS NOT NULL UNION " +
"SELECT recurrence_id_tz AS zone FROM cal_alarms WHERE recurrence_id_tz IS NOT NULL UNION " +
"SELECT recurrence_id_tz AS zone FROM cal_relations WHERE recurrence_id_tz IS NOT NULL UNION " +
"SELECT recurrence_id_tz AS zone FROM cal_attachments WHERE recurrence_id_tz IS NOT NULL" +
");"
);
try {
while (getZones.executeStep()) {
let zone = getZones.row.zone;
// Send the timezones off to the timezone service to attempt conversion:
let timezone = getTimezone(zone);
if (timezone) {
let refTz = cal.timezoneService.getTimezone(timezone.tzid);
if (refTz && refTz.tzid != zone) {
zonesToUpdate.push({ oldTzId: zone, newTzId: refTz.tzid });
}
}
}
} catch (e) {
cal.ERROR("Error updating timezones: " + e + "\nDB Error " + lastErrorString(db));
} finally {
getZones.finalize();
}
beginTransaction(db);
try {
for (let update of zonesToUpdate) {
executeSimpleSQL(
db,
// prettier-ignore
`UPDATE cal_attendees SET recurrence_id_tz = '${update.newTzId}' WHERE recurrence_id_tz = '${update.oldTzId}'; ` +
`UPDATE cal_events SET recurrence_id_tz = '${update.newTzId}' WHERE recurrence_id_tz = '${update.oldTzId}'; ` +
`UPDATE cal_events SET event_start_tz = '${update.newTzId}' WHERE event_start_tz = '${update.oldTzId}'; ` +
`UPDATE cal_events SET event_end_tz = '${update.newTzId}' WHERE event_end_tz = '${update.oldTzId}'; ` +
`UPDATE cal_properties SET recurrence_id_tz = '${update.newTzId}' WHERE recurrence_id_tz = '${update.oldTzId}'; ` +
`UPDATE cal_todos SET recurrence_id_tz = '${update.newTzId}' WHERE recurrence_id_tz = '${update.oldTzId}'; ` +
`UPDATE cal_todos SET todo_entry_tz = '${update.newTzId}' WHERE todo_entry_tz = '${update.oldTzId}'; ` +
`UPDATE cal_todos SET todo_due_tz = '${update.newTzId}' WHERE todo_due_tz = '${update.oldTzId}'; ` +
`UPDATE cal_alarms SET recurrence_id_tz = '${update.newTzId}' WHERE recurrence_id_tz = '${update.oldTzId}'; ` +
`UPDATE cal_relations SET recurrence_id_tz = '${update.newTzId}' WHERE recurrence_id_tz = '${update.oldTzId}'; ` +
`UPDATE cal_attachments SET recurrence_id_tz = '${update.newTzId}' WHERE recurrence_id_tz = '${update.oldTzId}';`
);
}
executeSimpleSQL(
db,
// prettier-ignore
"DELETE FROM cal_tz_version; " +
`INSERT INTO cal_tz_version VALUES ('${cal.timezoneService.version}');`
);
commitTransaction(db);
} catch (e) {
cal.ASSERT(false, "Timezone update failed! DB Error: " + lastErrorString(db));
rollbackTransaction(db);
throw e;
}
}
}
/**
* Adds a column to the given table.
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to add on
* @param colName The column name to add
* @param colType The type of the column to add
* @param db (optional) The database to apply the operation on
*/
function addColumn(tblData, tblName, colName, colType, db) {
cal.ASSERT(tblName in tblData, `Table ${tblName} is missing from table def`, true);
tblData[tblName][colName] = colType;
executeSimpleSQL(db, `ALTER TABLE ${tblName} ADD COLUMN ${colName} ${colType}`);
}
/**
* Deletes columns from the given table.
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to delete on
* @param colNameArray An array of column names to delete
* @param db (optional) The database to apply the operation on
*/
function deleteColumns(tblData, tblName, colNameArray, db) {
for (let colName of colNameArray) {
delete tblData[tblName][colName];
}
let columns = Object.keys(tblData[tblName]);
executeSimpleSQL(db, getSql(tblName, tblData, tblName + "_temp"));
executeSimpleSQL(
db,
// prettier-ignore
`INSERT INTO ${tblName}_temp (${columns.join(",")}) ` +
`SELECT ${columns.join(",")}` +
` FROM ${tblName};`
);
executeSimpleSQL(
db,
// prettier-ignore
`DROP TABLE ${tblName}; ` +
`ALTER TABLE ${tblName}_temp` +
` RENAME TO ${tblName};`
);
}
/**
* Does a full copy of the given table
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to copy
* @param newTblName The target table name.
* @param db (optional) The database to apply the operation on
* @param condition (optional) The condition to respect when copying
* @param selectOptions (optional) Extra options for the SELECT, i.e DISTINCT
*/
function copyTable(tblData, tblName, newTblName, db, condition, selectOptions) {
function objcopy(obj) {
return JSON.parse(JSON.stringify(obj));
}
tblData[newTblName] = objcopy(tblData[tblName]);
let columns = Object.keys(tblData[newTblName]);
executeSimpleSQL(db, getSql(newTblName, tblData));
executeSimpleSQL(
db,
// prettier-ignore
`INSERT INTO ${newTblName} (${columns.join(",")}) ` +
`SELECT ${selectOptions} ${columns.join(",")}` +
` FROM ${tblName} ${condition ? condition : ""};`
);
}
/**
* Alter the type of a certain column
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to alter
* @param colNameArray An array of column names to delete
* @param newType The new type of the column
* @param db (optional) The database to apply the operation on
*/
function alterTypes(tblData, tblName, colNameArray, newType, db) {
for (let colName of colNameArray) {
tblData[tblName][colName] = newType;
}
let columns = Object.keys(tblData[tblName]);
executeSimpleSQL(db, getSql(tblName, tblData, tblName + "_temp"));
executeSimpleSQL(
db,
// prettier-ignore
`INSERT INTO ${tblName}_temp (${columns.join(",")}) ` +
`SELECT ${columns.join(",")}` +
` FROM ${tblName};`
);
executeSimpleSQL(
db,
// prettier-ignore
`DROP TABLE ${tblName}; ` +
`ALTER TABLE ${tblName}_temp` +
` RENAME TO ${tblName};`
);
}
/**
* Renames the given table, giving it a new name.
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to rename.
* @param newTblName The new name of the table.
* @param db (optional) The database to apply the operation on.
* @param overwrite (optional) If true, the target table will be dropped
* before the rename
*/
function renameTable(tblData, tblName, newTblName, db, overwrite) {
if (overwrite) {
dropTable(tblData, newTblName, db);
}
tblData[newTblName] = tblData[tblName];
delete tblData[tblName];
executeSimpleSQL(
db,
// prettier-ignore
`ALTER TABLE ${tblName}` +
` RENAME TO ${newTblName}`
);
}
/**
* Drops the given table.
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to drop.
* @param db (optional) The database to apply the operation on.
*/
function dropTable(tblData, tblName, db) {
delete tblData[tblName];
executeSimpleSQL(db, `DROP TABLE IF EXISTS ${tblName};`);
}
/**
* Creates the given table.
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to add.
* @param def The table definition object.
* @param db (optional) The database to apply the operation on.
*/
function addTable(tblData, tblName, def, db) {
tblData[tblName] = def;
executeSimpleSQL(db, getSql(tblName, tblData));
}
/**
* Migrates the given columns to a single icalString, using the (previously
* created) user function for processing.
*
* @param tblData The table data object to apply the operation on.
* @param tblName The table name to migrate.
* @param userFuncName The name of the user function to call for migration
* @param oldColumns An array of columns to migrate to the new icalString
* column
* @param db (optional) The database to apply the operation on.
*/
function migrateToIcalString(tblData, tblName, userFuncName, oldColumns, db) {
addColumn(tblData, tblName, ["icalString"], "TEXT", db);
// prettier-ignore
let updateSql =
`UPDATE ${tblName} ` +
` SET icalString = ${userFuncName}(${oldColumns.join(",")})`;
executeSimpleSQL(db, updateSql);
deleteColumns(tblData, tblName, oldColumns, db);
// If null was returned, its an invalid attendee. Make sure to remove them,
// they might break things later on.
let cleanupSql = `DELETE FROM ${tblName} WHERE icalString IS NULL`;
executeSimpleSQL(db, cleanupSql);
}
/**
* Maps a mozIStorageValueArray to a JS array, converting types correctly.
*
* @param storArgs The storage value array to convert
* @returns An array with the arguments as js values.
*/
function mapStorageArgs(storArgs) {
const mISVA = Ci.mozIStorageValueArray;
let mappedArgs = [];
for (let i = 0; i < storArgs.numEntries; i++) {
switch (storArgs.getTypeOfIndex(i)) {
case mISVA.VALUE_TYPE_NULL:
mappedArgs.push(null);
break;
case mISVA.VALUE_TYPE_INTEGER:
mappedArgs.push(storArgs.getInt64(i));
break;
case mISVA.VALUE_TYPE_FLOAT:
mappedArgs.push(storArgs.getDouble(i));
break;
case mISVA.VALUE_TYPE_TEXT:
case mISVA.VALUE_TYPE_BLOB:
mappedArgs.push(storArgs.getUTF8String(i));
break;
}
}
return mappedArgs;
}
/** Object holding upgraders */
var upgrade = {};
/**
* Returns the initial storage database schema. Note this is not the current
* schema, it will be modified by the upgrade.vNN() functions. This function
* returns the initial v1 with modifications from v2 applied.
*
* No bug - new recurrence system. exceptions supported now, along with
* everything else ical can throw at us. I hope.
* p=vlad
*/
// eslint-disable-next-line id-length
upgrade.v2 = upgrade.v1 = function (db, version) {
LOGdb(db, "Storage: Upgrading to v1/v2");
let tblData = {
cal_calendar_schema_version: { version: "INTEGER" },
/* While this table is in v1, actually keeping it in the sql object will
* cause problems when migrating from storage.sdb to local.sqlite. There,
* all tables from storage.sdb will be moved to local.sqlite and so starting
* the application again afterwards causes a borked upgrade since its missing
* tables it expects.
*
* cal_calendars: {
* id: "INTEGER PRIMARY KEY",
* name: "STRING"
* },
*/
cal_items: {
cal_id: "INTEGER",
item_type: "INTEGER",
id: "STRING",
time_created: "INTEGER",
last_modified: "INTEGER",
title: "STRING",
priority: "INTEGER",
privacy: "STRING",
ical_status: "STRING",
flags: "INTEGER",
event_start: "INTEGER",
event_end: "INTEGER",
event_stamp: "INTEGER",
todo_entry: "INTEGER",
todo_due: "INTEGER",
todo_completed: "INTEGER",
todo_complete: "INTEGER",
alarm_id: "INTEGER",
},
cal_attendees: {
item_id: "STRING",
attendee_id: "STRING",
common_name: "STRING",
rsvp: "INTEGER",
role: "STRING",
status: "STRING",
type: "STRING",
},
cal_alarms: {
id: "INTEGER PRIMARY KEY",
alarm_data: "BLOB",
},
cal_recurrence: {
item_id: "STRING",
recur_type: "INTEGER",
recur_index: "INTEGER",
is_negative: "BOOLEAN",
dates: "STRING",
end_date: "INTEGER",
count: "INTEGER",
interval: "INTEGER",
second: "STRING",
minute: "STRING",
hour: "STRING",
day: "STRING",
monthday: "STRING",
yearday: "STRING",
weekno: "STRING",
month: "STRING",
setpos: "STRING",
},
cal_properties: {
item_id: "STRING",
key: "STRING",
value: "BLOB",
},
};
for (let tbl in tblData) {
executeSimpleSQL(db, `DROP TABLE IF EXISTS ${tbl}`);
}
return tblData;
};
/**
* Upgrade to version 3.
* Bug 293707, updates to storage provider; calendar manager database locked
* fix, r=shaver, p=vlad
* p=vlad
*/
// eslint-disable-next-line id-length
upgrade.v3 = function (db, version) {
function updateSql(tbl, field) {
executeSimpleSQL(
db,
// prettier-ignore
`UPDATE ${tbl} SET ${field}_tz='UTC'` +
` WHERE ${field} IS NOT NULL`
);
}
let tbl = upgrade.v2(version < 2 && db, version);
LOGdb(db, "Storage: Upgrading to v3");
beginTransaction(db);
try {
copyTable(tbl, "cal_items", "cal_events", db, "item_type = 0");
copyTable(tbl, "cal_items", "cal_todos", db, "item_type = 1");
dropTable(tbl, "cal_items", db);
let removeEventCols = [
"item_type",
"item_type",
"todo_entry",
"todo_due",
"todo_completed",
"todo_complete",
"alarm_id",
];
deleteColumns(tbl, "cal_events", removeEventCols, db);
addColumn(tbl, "cal_events", "event_start_tz", "VARCHAR", db);
addColumn(tbl, "cal_events", "event_end_tz", "VARCHAR", db);
addColumn(tbl, "cal_events", "alarm_time", "INTEGER", db);
addColumn(tbl, "cal_events", "alarm_time_tz", "VARCHAR", db);
let removeTodoCols = ["item_type", "event_start", "event_end", "event_stamp", "alarm_id"];
deleteColumns(tbl, "cal_todos", removeTodoCols, db);
addColumn(tbl, "cal_todos", "todo_entry_tz", "VARCHAR", db);
addColumn(tbl, "cal_todos", "todo_due_tz", "VARCHAR", db);
addColumn(tbl, "cal_todos", "todo_completed_tz", "VARCHAR", db);
addColumn(tbl, "cal_todos", "alarm_time", "INTEGER", db);
addColumn(tbl, "cal_todos", "alarm_time_tz", "VARCHAR", db);
dropTable(tbl, "cal_alarms", db);
// The change between 2 and 3 includes the splitting of cal_items into
// cal_events and cal_todos, and the addition of columns for
// event_start_tz, event_end_tz, todo_entry_tz, todo_due_tz.
// These need to default to "UTC" if their corresponding time is
// given, since that's what the default was for v2 calendars
// Fix up the new timezone columns
updateSql("cal_events", "event_start");
updateSql("cal_events", "event_end");
updateSql("cal_todos", "todo_entry");
updateSql("cal_todos", "todo_due");
updateSql("cal_todos", "todo_completed");
setDbVersionAndCommit(db, 3);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Upgrade to version 4.
* Bug 293183 - implement exception support for recurrence.
* r=shaver,p=vlad
*/
// eslint-disable-next-line id-length
upgrade.v4 = function (db, version) {
let tbl = upgrade.v3(version < 3 && db, version);
LOGdb(db, "Storage: Upgrading to v4");
beginTransaction(db);
try {
for (let tblid of ["events", "todos", "attendees", "properties"]) {
addColumn(tbl, "cal_" + tblid, "recurrence_id", "INTEGER", db);
addColumn(tbl, "cal_" + tblid, "recurrence_id_tz", "VARCHAR", db);
}
setDbVersionAndCommit(db, 4);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 315051 - Switch to storing alarms based on offsets from start/end time
* rather than as absolute times. Ensure that missed alarms are fired.
* r=dmose, p=jminta
*/
// eslint-disable-next-line id-length
upgrade.v5 = function (db, version) {
let tbl = upgrade.v4(version < 4 && db, version);
LOGdb(db, "Storage: Upgrading to v5");
beginTransaction(db);
try {
for (let tblid of ["events", "todos"]) {
addColumn(tbl, "cal_" + tblid, "alarm_offset", "INTEGER", db);
addColumn(tbl, "cal_" + tblid, "alarm_related", "INTEGER", db);
addColumn(tbl, "cal_" + tblid, "alarm_last_ack", "INTEGER", db);
}
setDbVersionAndCommit(db, 5);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 333688 - Converts STRING and VARCHAR columns to TEXT to avoid SQLite's
* auto-conversion of strings to numbers (10e4 to 10000)
* r=ctalbert,jminta p=lilmatt
*/
// eslint-disable-next-line id-length
upgrade.v6 = function (db, version) {
let tbl = upgrade.v5(version < 5 && db, version);
LOGdb(db, "Storage: Upgrading to v6");
beginTransaction(db);
try {
let eventCols = [
"id",
"title",
"privacy",
"ical_status",
"recurrence_id_tz",
"event_start_tz",
"event_end_tz",
"alarm_time_tz",
];
alterTypes(tbl, "cal_events", eventCols, "TEXT", db);
let todoCols = [
"id",
"title",
"privacy",
"ical_status",
"recurrence_id_tz",
"todo_entry_tz",
"todo_due_tz",
"todo_completed_tz",
"alarm_time_tz",
];
alterTypes(tbl, "cal_todos", todoCols, "TEXT", db);
let attendeeCols = [
"item_id",
"recurrence_id_tz",
"attendee_id",
"common_name",
"role",
"status",
"type",
];
alterTypes(tbl, "cal_attendees", attendeeCols, "TEXT", db);
let recurrenceCols = [
"item_id",
"recur_type",
"dates",
"second",
"minute",
"hour",
"day",
"monthday",
"yearday",
"weekno",
"month",
"setpos",
];
alterTypes(tbl, "cal_recurrence", recurrenceCols, "TEXT", db);
let propertyCols = ["item_id", "recurrence_id_tz", "key"];
alterTypes(tbl, "cal_properties", propertyCols, "TEXT", db);
setDbVersionAndCommit(db, 6);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 369010: Migrate all old tzids in storage to new one.
* r=ctalbert,dmose p=lilmatt
*/
// eslint-disable-next-line id-length
upgrade.v7 = function (db, version) {
// No schema changes in v7
let tbl = upgrade.v6(db, version);
LOGdb(db, "Storage: Upgrading to v7");
return tbl;
};
/**
* Bug 410931 - Update internal timezone definitions
* r=ctalbert, p=dbo,nth10sd,hb
*/
// eslint-disable-next-line id-length
upgrade.v8 = function (db, version) {
// No schema changes in v8
let tbl = upgrade.v7(db, version);
LOGdb(db, "Storage: Upgrading to v8");
return tbl;
};
/**
* Bug 363191 - Handle Timezones more efficiently (Timezone Database)
* r=philipp,ctalbert, p=dbo
*/
// eslint-disable-next-line id-length
upgrade.v9 = function (db, version) {
// No schema changes in v9
let tbl = upgrade.v8(db, version);
LOGdb(db, "Storage: Upgrading to v9");
return tbl;
};
/**
* Bug 413908 – Events using internal timezones are no longer updated to
* recent timezone version;
* r=philipp, p=dbo
*/
upgrade.v10 = function (db, version) {
let tbl = upgrade.v9(version < 9 && db, version);
LOGdb(db, "Storage: Upgrading to v10");
beginTransaction(db);
try {
addTable(tbl, "cal_tz_version", { version: "TEXT" }, db);
setDbVersionAndCommit(db, 10);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Fix bug 319909 - Failure to properly serialize/unserialize ics ATTACH
* properties.
* r=philipp,p=fred.jen@web.de
*/
upgrade.v11 = function (db, version) {
let tbl = upgrade.v10(version < 10 && db, version);
LOGdb(db, "Storage: Upgrading to v11");
beginTransaction(db);
try {
addTable(
tbl,
"cal_attachments",
{
item_id: "TEXT",
data: "BLOB",
format_type: "TEXT",
encoding: "TEXT",
},
db
);
setDbVersionAndCommit(db, 11);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 449031 - Add meta data API to memory/storage
* r=philipp, p=dbo
*/
upgrade.v12 = function (db, version) {
let tbl = upgrade.v11(version < 11 && db, version);
LOGdb(db, "Storage: Upgrading to v12");
beginTransaction(db);
try {
addColumn(tbl, "cal_attendees", "is_organizer", "BOOLEAN", db);
addColumn(tbl, "cal_attendees", "properties", "BLOB", db);
addTable(
tbl,
"cal_metadata",
{
cal_id: "INTEGER",
item_id: "TEXT UNIQUE",
value: "BLOB",
},
db
);
setDbVersionAndCommit(db, 12);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 449401 - storage provider doesn't cleanly separate items of the same id
* across different calendars
* r=dbo,philipp, p=wsourdeau@inverse.ca
*/
upgrade.v13 = function (db, version) {
let tbl = upgrade.v12(version < 12 && db, version);
LOGdb(db, "Storage: Upgrading to v13");
beginTransaction(db);
try {
alterTypes(tbl, "cal_metadata", ["item_id"], "TEXT", db);
let calIds = {};
if (db) {
for (let itemTable of ["events", "todos"]) {
let stmt = createStatement(db, `SELECT id, cal_id FROM cal_${itemTable}`);
try {
while (stmt.executeStep()) {
calIds[stmt.row.id] = stmt.row.cal_id;
}
} finally {
stmt.finalize();
}
}
}
let tables = ["attendees", "recurrence", "properties", "attachments"];
for (let tblid of tables) {
addColumn(tbl, "cal_" + tblid, "cal_id", "INTEGER", db);
for (let itemId in calIds) {
executeSimpleSQL(
db,
// prettier-ignore
`UPDATE cal_${tblid}` +
` SET cal_id = ${calIds[itemId]}` +
` WHERE item_id = '${itemId}'`
);
}
}
executeSimpleSQL(db, "DROP INDEX IF EXISTS idx_cal_properies_item_id");
executeSimpleSQL(
db,
// prettier-ignore
"CREATE INDEX IF NOT EXISTS" +
" idx_cal_properies_item_id" +
" ON cal_properties(cal_id, item_id);"
);
setDbVersionAndCommit(db, 13);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 446303 - use the "RELATED-TO" property.
* r=philipp,dbo, p=fred.jen@web.de
*/
upgrade.v14 = function (db, version) {
let tbl = upgrade.v13(version < 13 && db, version);
LOGdb(db, "Storage: Upgrading to v14");
beginTransaction(db);
try {
addTable(
tbl,
"cal_relations",
{
cal_id: "INTEGER",
item_id: "TEXT",
rel_type: "TEXT",
rel_id: "TEXT",
},
db
);
setDbVersionAndCommit(db, 14);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 463282 - Tasks cannot be created or imported (regression).
* r=philipp,berend, p=dbo
*/
upgrade.v15 = function (db, version) {
let tbl = upgrade.v14(version < 14 && db, version);
LOGdb(db, "Storage: Upgrading to v15");
beginTransaction(db);
try {
addColumn(tbl, "cal_todos", "todo_stamp", "INTEGER", db);
setDbVersionAndCommit(db, 15);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 353492 - support multiple alarms per events/task, support
* absolute alarms with fixed date/time - Storage Provider support for multiple
* alarms.
* r=dbo,ssitter, p=philipp
*
* This upgrader is a bit special. To fix bug 494140, we decided to change the
* upgrading code afterwards to make sure no data is lost for people upgrading
* from 0.9 -> 1.0b1 and later. The v17 upgrader will merely take care of the
* upgrade if a user is upgrading from 1.0pre -> 1.0b1 or later.
*/
upgrade.v16 = function (db, version) {
let tbl = upgrade.v15(version < 15 && db, version);
LOGdb(db, "Storage: Upgrading to v16");
beginTransaction(db);
try {
createFunction(db, "translateAlarm", 4, {
onFunctionCall(storArgs) {
try {
let [aOffset, aRelated, aAlarmTime, aTzId] = mapStorageArgs(storArgs);
let alarm = new lazy.CalAlarm();
if (aOffset) {
alarm.related = parseInt(aRelated, 10) + 1;
alarm.offset = cal.createDuration();
alarm.offset.inSeconds = aOffset;
} else if (aAlarmTime) {
alarm.related = Ci.calIAlarm.ALARM_RELATED_ABSOLUTE;
let alarmDate = cal.createDateTime();
alarmDate.nativeTime = aAlarmTime;
if (aTzId == "floating") {
// The current calDateTime code assumes that if a
// date is floating then we can just assign the new
// timezone. I have the feeling this is wrong so I
// filed bug 520463. Since we want to release 1.0b1
// soon, I will just fix this on the "client side"
// and do the conversion here.
alarmDate.timezone = cal.timezoneService.defaultTimezone;
alarmDate = alarmDate.getInTimezone(cal.dtz.UTC);
} else {
alarmDate.timezone = cal.timezoneService.getTimezone(aTzId);
}
alarm.alarmDate = alarmDate;
}
return alarm.icalString;
} catch (e) {
// Errors in this function are not really logged. Do this
// separately.
cal.ERROR("Error converting alarms: " + e);
throw e;
}
},
});
addTable(
tbl,
"cal_alarms",
{
cal_id: "INTEGER",
item_id: "TEXT",
// Note the following two columns were not originally part of the
// v16 upgrade, see note above function.
recurrence_id: "INTEGER",
recurrence_id_tz: "TEXT",
icalString: "TEXT",
},
db
);
let copyDataOver = function (tblName) {
const transAlarm = "translateAlarm(alarm_offset, alarm_related, alarm_time, alarm_time_tz)";
executeSimpleSQL(
db,
// prettier-ignore
"INSERT INTO cal_alarms (cal_id, item_id," +
" recurrence_id, " +
" recurrence_id_tz, " +
" icalString)" +
" SELECT cal_id, id, recurrence_id," +
` recurrence_id_tz, ${transAlarm}` +
` FROM ${tblName}` +
" WHERE alarm_offset IS NOT NULL" +
" OR alarm_time IS NOT NULL;"
);
};
copyDataOver("cal_events");
copyDataOver("cal_todos");
removeFunction(db, "translateAlarm");
// Make sure the alarm flag is set on the item
executeSimpleSQL(
db,
// prettier-ignore
"UPDATE cal_events " +
` SET flags = flags | ${CAL_ITEM_FLAG.HAS_ALARMS}` +
" WHERE id IN" +
" (SELECT item_id " +
" FROM cal_alarms " +
" WHERE cal_alarms.cal_id = cal_events.cal_id)"
);
executeSimpleSQL(
db,
// prettier-ignore
"UPDATE cal_todos " +
` SET flags = flags | ${CAL_ITEM_FLAG.HAS_ALARMS}` +
" WHERE id IN" +
" (SELECT item_id " +
" FROM cal_alarms " +
" WHERE cal_alarms.cal_id = cal_todos.cal_id)"
);
// Remote obsolete columns
let cols = ["alarm_time", "alarm_time_tz", "alarm_offset", "alarm_related"];
for (let tblid of ["events", "todos"]) {
deleteColumns(tbl, "cal_" + tblid, cols, db);
}
setDbVersionAndCommit(db, 16);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 494140 - Multiple reminders,relations,attachments created by modifying
* repeating event.
* r=dbo,ssitter, p=philipp
*
* This upgrader is special. In bug 494140 we decided it would be better to fix
* the v16 upgrader so 0.9 users can update to 1.0b1 and later without dataloss.
* Therefore all this upgrader does is handle users of 1.0pre before the
* mentioned bug.
*/
upgrade.v17 = function (db, version) {
let tbl = upgrade.v16(version < 16 && db, version);
LOGdb(db, "Storage: Upgrading to v17");
beginTransaction(db);
try {
for (let tblName of ["alarms", "relations", "attachments"]) {
let hasColumns = true;
let stmt;
try {
// Stepping this statement will fail if the columns don't exist.
// We don't use the delegate here since it would show an error to
// the user, even through we expect the error. If the db is null,
// then swallowing the error is ok too since the cols will
// already be added in v16.
stmt = db.createStatement(
`SELECT recurrence_id_tz, recurrence_id FROM cal_${tblName} LIMIT 1`
);
stmt.executeStep();
} catch (e) {
// An error happened, which means the cols don't exist
hasColumns = false;
} finally {
if (stmt) {
stmt.finalize();
}
}
// Only add the columns if they are not there yet (i.e added in v16)
// Since relations were broken all along, also make sure and add the
// columns to the javascript object if there is no database.
if (!hasColumns || !db) {
addColumn(tbl, "cal_" + tblName, "recurrence_id", "INTEGER", db);
addColumn(tbl, "cal_" + tblName, "recurrence_id_tz", "TEXT", db);
}
// Clear out entries that are exactly the same. This corrects alarms
// created in 1.0pre and relations and attachments created in 0.9.
copyTable(tbl, "cal_" + tblName, "cal_" + tblName + "_v17", db, null, "DISTINCT");
renameTable(tbl, "cal_" + tblName + "_v17", "cal_" + tblName, db, true);
}
setDbVersionAndCommit(db, 17);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 529326 - Create indexes for the local calendar
* r=mschroeder, p=philipp
*
* This bug adds some indexes to improve performance. If you would like to add
* additional indexes, please read http://www.sqlite.org/optoverview.html first.
*/
upgrade.v18 = function (db, version) {
let tbl = upgrade.v17(version < 17 && db, version);
LOGdb(db, "Storage: Upgrading to v18");
beginTransaction(db);
try {
// These fields are often indexed over
let simpleIds = ["cal_id", "item_id"];
let allIds = simpleIds.concat(["recurrence_id", "recurrence_id_tz"]);
// Alarms, Attachments, Attendees, Relations
for (let tblName of ["alarms", "attachments", "attendees", "relations"]) {
createIndex(tbl, "cal_" + tblName, allIds, db);
}
// Events and Tasks
for (let tblName of ["events", "todos"]) {
createIndex(tbl, "cal_" + tblName, ["flags", "cal_id", "recurrence_id"], db);
createIndex(tbl, "cal_" + tblName, ["id", "cal_id", "recurrence_id"], db);
}
// Metadata
createIndex(tbl, "cal_metadata", simpleIds, db);
// Properties. Remove the index we used to create first, since our index
// is much more complete.
executeSimpleSQL(db, "DROP INDEX IF EXISTS idx_cal_properies_item_id");
createIndex(tbl, "cal_properties", allIds, db);
// Recurrence
createIndex(tbl, "cal_recurrence", simpleIds, db);
setDbVersionAndCommit(db, 18);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 479867 - Cached calendars don't set id correctly, causing duplicate
* events to be shown for multiple cached calendars
* r=simon.at.orcl, p=philipp,dbo
*/
upgrade.v19 = function (db, version) {
let tbl = upgrade.v18(version < 18 && db, version);
LOGdb(db, "Storage: Upgrading to v19");
beginTransaction(db);
try {
let tables = [
"cal_alarms",
"cal_attachments",
"cal_attendees",
"cal_events",
"cal_metadata",
"cal_properties",
"cal_recurrence",
"cal_relations",
"cal_todos",
];
// Change types of column to TEXT.
for (let tblName of tables) {
alterTypes(tbl, tblName, ["cal_id"], "TEXT", db);
}
setDbVersionAndCommit(db, 19);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 380060 - Offline Sync feature for calendar
* Setting a offline_journal column in cal_events tables
* r=philipp, p=redDragon
*/
upgrade.v20 = function (db, version) {
let tbl = upgrade.v19(version < 19 && db, version);
LOGdb(db, "Storage: Upgrading to v20");
beginTransaction(db);
try {
// Adding a offline_journal column
for (let tblName of ["cal_events", "cal_todos"]) {
addColumn(tbl, tblName, ["offline_journal"], "INTEGER", db);
}
setDbVersionAndCommit(db, 20);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 785659 - Get rid of calIRecurrenceDateSet
* Migrate x-dateset to x-date in the storage database
* r=mmecca, p=philipp
*/
upgrade.v21 = function (db, version) {
let tbl = upgrade.v20(version < 20 && db, version);
LOGdb(db, "Storage: Upgrading to v21");
beginTransaction(db);
try {
// The following operation is only important on a live DB, since we are
// changing only the values on the DB, not the schema itself.
if (db) {
// Oh boy, here we go :-)
// Insert a new row with the following columns...
let insertSQL =
"INSERT INTO cal_recurrence " +
" (item_id, cal_id, recur_type, recur_index," +
" is_negative, dates, end_date, count," +
" interval, second, minute, hour, day," +
" monthday, yearday, weekno, month, setpos)" +
// ... by selecting some columns from the existing table ...
' SELECT item_id, cal_id, "x-date" AS recur_type, ' +
// ... like a new recur_index, we need it to be maximum for this item ...
" (SELECT MAX(recur_index)+1" +
" FROM cal_recurrence AS rinner " +
" WHERE rinner.item_id = router.item_id" +
" AND rinner.cal_id = router.cal_id) AS recur_index," +
" is_negative," +
// ... the string until the first comma in the current dates field
' SUBSTR(dates, 0, LENGTH(dates) - LENGTH(LTRIM(dates, REPLACE(dates, ",", ""))) + 1) AS dates,' +
" end_date, count, interval, second, minute," +
" hour, day, monthday, yearday, weekno, month," +
" setpos" +
// ... from the recurrence table ...
" FROM cal_recurrence AS router " +
// ... but only on fields that are x-datesets ...
' WHERE recur_type = "x-dateset" ' +
// ... and are not already empty.
' AND dates != ""';
dump(insertSQL + "\n");
// Now we need to remove the first segment from the dates field
let updateSQL =
"UPDATE cal_recurrence" +
' SET dates = SUBSTR(dates, LENGTH(dates) - LENGTH(LTRIM(dates, REPLACE(dates, ",", ""))) + 2)' +
' WHERE recur_type = "x-dateset"' +
' AND dates != ""';
// Create the statements
let insertStmt = createStatement(db, insertSQL);
let updateStmt = createStatement(db, updateSQL);
// Repeat these two statements until the update affects 0 rows
// (because the dates field on all x-datesets is empty)
do {
insertStmt.execute();
updateStmt.execute();
} while (db.affectedRows > 0);
// Finally we can delete the x-dateset rows. Note this will leave
// gaps in recur_index, but that's ok since its only used for
// ordering anyway and will be overwritten on the next item write.
executeSimpleSQL(db, 'DELETE FROM cal_recurrence WHERE recur_type = "x-dateset"');
}
setDbVersionAndCommit(db, 21);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
/**
* Bug 785733 - Move some properties to use icalString in database.
* Use the full icalString in attendees, attachments, relations and recurrence
* tables.
* r=mmecca, p=philipp
*/
upgrade.v22 = function (db, version) {
let tbl = upgrade.v21(version < 21 && db, version);
LOGdb(db, "Storage: Upgrading to v22");
beginTransaction(db);
try {
// Update attachments to using icalString directly
createFunction(db, "translateAttachment", 3, {
onFunctionCall(storArgs) {
try {
let [aData, aFmtType, aEncoding] = mapStorageArgs(storArgs);
let attach = new lazy.CalAttachment();
attach.uri = Services.io.newURI(aData);
attach.formatType = aFmtType;
attach.encoding = aEncoding;
return attach.icalString;
} catch (e) {
cal.ERROR("Error converting attachment: " + e);
throw e;
}
},
});
migrateToIcalString(
tbl,
"cal_attachments",
"translateAttachment",
["data", "format_type", "encoding"],
db
);
// Update relations to using icalString directly
createFunction(db, "translateRelation", 2, {
onFunctionCall(storArgs) {
try {
let [aRelType, aRelId] = mapStorageArgs(storArgs);
let relation = new lazy.CalRelation();
relation.relType = aRelType;
relation.relId = aRelId;
return relation.icalString;
} catch (e) {
cal.ERROR("Error converting relation: " + e);
throw e;
}
},
});
migrateToIcalString(tbl, "cal_relations", "translateRelation", ["rel_type", "rel_id"], db);
// Update attendees table to using icalString directly
createFunction(db, "translateAttendee", 8, {
onFunctionCall(storArgs) {
try {
let [aAttendeeId, aCommonName, aRsvp, aRole, aStatus, aType, aIsOrganizer, aProperties] =
mapStorageArgs(storArgs);
let attendee = new lazy.CalAttendee();
attendee.id = aAttendeeId;
attendee.commonName = aCommonName;
switch (aRsvp) {
case 0:
attendee.rsvp = "FALSE";
break;
case 1:
attendee.rsvp = "TRUE";
break;
// default: keep undefined
}
attendee.role = aRole;
attendee.participationStatus = aStatus;
attendee.userType = aType;
attendee.isOrganizer = !!aIsOrganizer;
if (aProperties) {
for (let pair of aProperties.split(",")) {
let [key, value] = pair.split(":");
attendee.setProperty(decodeURIComponent(key), decodeURIComponent(value));
}
}
return attendee.icalString;
} catch (e) {
// There are some attendees with a null ID. We are taking
// the opportunity to remove them here.
cal.ERROR("Error converting attendee, removing: " + e);
return null;
}
},
});
migrateToIcalString(
tbl,
"cal_attendees",
"translateAttendee",
[
"attendee_id",
"common_name",
"rsvp",
"role",
"status",
"type",
"is_organizer",
"properties",
],
db
);
// Update recurrence table to using icalString directly
createFunction(db, "translateRecurrence", 17, {
onFunctionCall(storArgs) {
function parseInt10(x) {
return parseInt(x, 10);
}
try {
let [
// eslint-disable-next-line no-unused-vars
aIndex,
aType,
aIsNegative,
aDates,
aCount,
aEndDate,
aInterval,
aSecond,
aMinute,
aHour,
aDay,
aMonthday,
aYearday,
aWeekno,
aMonth,
aSetPos,
aTmpFlags,
] = mapStorageArgs(storArgs);
let ritem;
if (aType == "x-date") {
ritem = cal.createRecurrenceDate();
ritem.date = textToDate(aDates);
ritem.isNegative = !!aIsNegative;
} else {
ritem = cal.createRecurrenceRule();
ritem.type = aType;
ritem.isNegative = !!aIsNegative;
if (aCount) {
try {
ritem.count = aCount;
} catch (exc) {
// Don't fail if setting an invalid count
}
} else if (aEndDate) {
let allday = (aTmpFlags & CAL_ITEM_FLAG.EVENT_ALLDAY) != 0;
let untilDate = newDateTime(aEndDate, allday ? "" : "UTC");
if (allday) {
untilDate.isDate = true;
}
ritem.untilDate = untilDate;
} else {
ritem.untilDate = null;
}
try {
ritem.interval = aInterval;
} catch (exc) {
// Don't fail if setting an invalid interval
}
let rtypes = {
SECOND: aSecond,
MINUTE: aMinute,
HOUR: aHour,
DAY: aDay,
MONTHDAY: aMonthday,
YEARDAY: aYearday,
WEEKNO: aWeekno,
MONTH: aMonth,
SETPOS: aSetPos,
};
for (let rtype in rtypes) {
if (rtypes[rtype]) {
let comp = "BY" + rtype;
let rstr = rtypes[rtype].toString();
let rarray = rstr.split(",").map(parseInt10);
ritem.setComponent(comp, rarray);
}
}
}
return ritem.icalString;
} catch (e) {
cal.ERROR("Error converting recurrence: " + e);
throw e;
}
},
});
// The old code relies on the item allday state, we need to temporarily
// copy this into the rec table so the above function can update easier.
// This column will be deleted during the migrateToIcalString call.
addColumn(tbl, "cal_recurrence", ["tmp_date_tz"], "", db);
executeSimpleSQL(
db,
// prettier-ignore
"UPDATE cal_recurrence SET tmp_date_tz = " +
"(SELECT e.flags FROM cal_events AS e " +
" WHERE e.id = cal_recurrence.item_id " +
" AND e.cal_id = cal_recurrence.cal_id " +
" UNION SELECT t.flags FROM cal_todos AS t " +
" WHERE t.id = cal_recurrence.item_id " +
" AND t.cal_id = cal_recurrence.cal_id)"
);
migrateToIcalString(
tbl,
"cal_recurrence",
"translateRecurrence",
[
"recur_index",
"recur_type",
"is_negative",
"dates",
"count",
"end_date",
"interval",
"second",
"minute",
"hour",
"day",
"monthday",
"yearday",
"weekno",
"month",
"setpos",
"tmp_date_tz",
],
db
);
setDbVersionAndCommit(db, 22);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
upgrade.v23 = function (db, version) {
let tbl = upgrade.v22(version < 22 && db, version);
LOGdb(db, "Storage: Upgrading to v23");
beginTransaction(db);
try {
addTable(
tbl,
"cal_parameters",
{
cal_id: "TEXT",
item_id: "TEXT",
recurrence_id: "INTEGER",
recurrence_id_tz: "TEXT",
key1: "TEXT",
key2: "TEXT",
value: "BLOB",
},
db
);
let allIds = ["cal_id", "item_id", "recurrence_id", "recurrence_id_tz"];
createIndex(tbl, "cal_parameters", allIds, db);
setDbVersionAndCommit(db, 23);
} catch (e) {
throw reportErrorAndRollback(db, e);
}
return tbl;
};
|