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 | 1 7 7 8 8 8 8 8 8 8 7 7 7 7 7 7 8 7 7 7 7 7 7 7 7 7 8 2 2 2 2 2 2 8 8 8 8 8 8 8 8 2 2 2 2 2 2 2 8 1 1 1 2 2 1 1 1 1 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 1 1 1 1 1 1 8 8 8 8 8 8 8 8 16 16 16 16 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 10 8 8 8 8 8 8 8 8 8 8 8 8 8 8 1 1 1 1 1 8 8 7 7 7 7 7 7 8 8 1 1 1 1 1 1 7 7 7 7 8 7 1 2 2 1 7 7 1 7 1 8 | /** * The cache service handles client-side caching (almost about any object can * be cached on the client). The cache mechanism implemented by this service * uses either { indexedDB | webSQL | localStorage | sessionStorage | polyFill } * in the specified order of availability. To ensure better performance, when * used in pagination, only pages navigated by users shoube be cached. For example: in * a page 1 to 10 result; if user navigate page 1, 3 and 7; only the mentioned * three pages (1, 3 & 7) should be cached....however it's still up to you to determine what's cached. */ angular.module("a2o4.storage", []) /** * @param {$window} The window object. * @param {$q} The deferred object. * @param {$q} The timeout object. */ .factory("cacheService", [ "$window", "$q", "$timeout", function($window, $q, $timeout) { var cacheStorage = function() { }; var repository = function() { /** * This POLY_FILL serves as an extension of browser storage capability. It * would automatically be used should any of the following not be available { indexedDB | webSQL | localStorage | sessionStorage } */ var POLY_FILL = {}; // marker for POLY_FILL POLY_FILL.name = "POLY_FILL"; // database name POLY_FILL.dbName = "cacheDB"; // entity name POLY_FILL.entityName = "cacheTable"; // poly fill options POLY_FILL.options = {}; // poly fill storage space POLY_FILL.db = {}; // return reference to poly fill POLY_FILL.open = function() { var deferred = $q.defer(); // update dbName and entityName on DB open POLY_FILL.dbName = POLY_FILL.options.dbName; POLY_FILL.entityName = POLY_FILL.options.entityName; $timeout(function() { deferred.resolve(POLY_FILL); }); return deferred.promise; }; /** * Function for caching a data. * key must be truthy -> not (null | undefined | NaN | "" | 0 | false) * @param {key} the key for data to be cached * @param {value} the actual data to cache */ POLY_FILL.save = POLY_FILL.setItem = function(key, value) { var deferred = $q.defer(), savedStatus = false; Eif (key) { POLY_FILL.db[key] = value; savedStatus = true; // invalidate current cached page after specified max period $timeout(function() { POLY_FILL.removeItem(key); }, POLY_FILL.options.maxAge); } else { console.warn("key should be a valid truthy"); } $timeout(function() { deferred.resolve(savedStatus); }); return deferred.promise; }; /** * Function to retrieve existing cache data * key must be defined * @param {key} the key for data to be retrieved */ POLY_FILL.get = POLY_FILL.getItem = function(key) { var deferred = $q.defer(); var data = POLY_FILL.db[key]; Iif (data) { $timeout(function() { deferred.resolve(data); }); } else { $timeout(function() { deferred.resolve(null); }); } return deferred.promise; }; /** * Function to delete an existing cache data * key must be defined and part of exisiting keys * @param {key} the key for data to be deleted */ POLY_FILL.remove = POLY_FILL.removeItem = function(key) { var deferred = $q.defer(); Eif (POLY_FILL.db.hasOwnProperty(key)) { // delete POLY_FILL.db[key]; POLY_FILL.db[key] = null; $timeout(function() { deferred.resolve(); }); } else { deferred.reject(); } return deferred.promise; }; /** * Function to compute current size of cache, as per number of cache items */ POLY_FILL.length = function() { var deferred = $q.defer(), size = 0, key; for (key in POLY_FILL.db) { // exclude function properties from size counting Eif (POLY_FILL.db.hasOwnProperty(key)) { size++; } } $timeout(function() { deferred.resolve(size); }); return deferred.promise; }; /** * Function to clear entire cache space */ POLY_FILL.clear = function() { var deferred = $q.defer(), key; try { for (key in POLY_FILL.db) { // exclude function properties as keys for data removal Eif (POLY_FILL.db.hasOwnProperty(key)) { delete POLY_FILL.db[key]; } } console.log('POLY_FILL ' + POLY_FILL.dbName + ' data cleared'); $timeout(function() { deferred.resolve(); }); } catch (e) { $timeout(function() { deferred.reject(); }); } return deferred.promise; }; /** * Utiltiy function for verifying whether client storage ($window.localStorage | $window.sessionStorage) space is filled to * capacity * * @param {e} error thrown */ var storeQuotaExceeded = function(e) { var quotaExceeded = false; if (e) { if (e.code) { switch (e.code) { case 22: quotaExceeded = true; break; case 1014: // Firefox if (e.name === 'NS_ERROR_DOM_QUOTA_REACHED') { quotaExceeded = true; } break; } } else if (e.number === -2147024882) { // Internet Explorer 8 quotaExceeded = true; } } return quotaExceeded; }; /** * Handles save request for localStorage and sessionStorage * @param {storeType} the storage type {localStorage | localSessionStorage} * @param {key} the key for caching data * @param {value} the data to cache */ var saveHandle = function(storeType, key, value) { var clearCache; try { storeType.db.setItem(key, value); } catch (e1) { if (storeType.storeQuotaExceeded(e1)) { /* delete first n-cached items as specified by value of deletableCacheItems */ var deletedCacheCount = 0; for (var storeKey in storeType.db) { if (storeType.db.getItem(storeKey)) { if (deletedCacheCount === storeType.options.deletableCacheItems) { break; } // clear timer if previously set if (clearCache) { $timeout.cancel(clearCache); } // delete cache data storeType.removeItem(storeKey).then(incrementDeletedCache); } } var incrementDeletedCache = function(){ deletedCacheCount++; }; } try { // perform a second attempt to cache current page storeType.db.setItem(key, value); } catch (e2) { /* * looks like data might be too big or something weird happened....ignore caching of current page */ console.error("error persisting data: " + e2); return false; } } // invalidate current cached page after specified max period clearCache = $timeout(function() { storeType.removeItem(key); }, storeType.options.maxAge); return true; }; /** * This storage object help abstract the basic functionalities of localStorage. */ var localStorageDB = {}; // marker for localStorage localStorageDB.name = "localStorage"; // database name localStorageDB.dbName = "cacheDB"; // entity name localStorageDB.entityName = "cacheTable"; // db handle localStorageDB.db = $window.localStorage; // storage capacity check localStorageDB.storeQuotaExceeded = storeQuotaExceeded; // database options localStorageDB.options = {}; // return reference to localStorageDB.db localStorageDB.open = function() { var deferred = $q.defer(); // update dbName and entityName on DB open localStorageDB.dbName = localStorageDB.options.dbName; localStorageDB.entityName = localStorageDB.options.entityName; $timeout(function() { deferred.resolve(localStorageDB.db); }); return deferred.promise; }; /** * Function for caching a data. * key must be truthy -> not (null | undefined | NaN | "" | 0 | false) * @param {key} the key for data to be cached * @param {value} the actual data to cache */ localStorageDB.save = localStorageDB.setItem = function(key, value) { var deferred = $q.defer(); Eif (key) { var savedStatus = saveHandle(localStorageDB, key, value); deferred.resolve(savedStatus); } else { deferred.reject(); } return deferred.promise; }; /** * Function to retrieve existing cache data * key must be defined * @param {key} the key for data to be retrieved */ localStorageDB.get = localStorageDB.getItem = function(key) { var deferred = $q.defer(); data = localStorageDB.db.getItem(key); deferred.resolve(data); return deferred.promise; }; /** * Function to delete an existing cache data * key must be defined and part of exisiting keys * @param {key} the key for data to be deleted */ localStorageDB.remove = localStorageDB.removeItem = function(key) { var deferred = $q.defer(); localStorageDB.db.removeItem(key); deferred.resolve(); return deferred.promise; }; /** * Function to compute current size of cache, as per number of cache items */ localStorageDB.length = function() { var deferred = $q.defer(), size = 0; size = localStorageDB.db.length; deferred.resolve(size); return deferred.promise; }; /** * Function to clear entire cache space */ localStorageDB.clear = function() { var deferred = $q.defer(); localStorageDB.db.clear(); deferred.resolve(); console.log("localStorageDB data cleared"); return deferred.promise; }; /** * This storage object help abstract the basic functionalities of sessionStorage. */ var localSessionStorage = {}; // marker for localStorage localSessionStorage.name = "sessionStorage"; // database name localSessionStorage.dbName = "cacheDB"; // entity name localSessionStorage.entityName = "cacheTable"; // db handle localSessionStorage.db = $window.sessionStorage; // storage capacity check localSessionStorage.storeQuotaExceeded = storeQuotaExceeded; // database options localSessionStorage.options = {}; // return reference to localSessionStorage.db localSessionStorage.open = function() { var deferred = $q.defer(); // update dbName and entityName on DB open localSessionStorage.dbName = localSessionStorage.options.dbName; localSessionStorage.entityName = localSessionStorage.options.entityName; $timeout(function() { deferred.resolve(localSessionStorage.db); }); return deferred.promise; }; /** * Function for caching a data. * key must be truthy -> not (null | undefined | NaN | "" | 0 | false) * @param {key} the key for data to be cached * @param {value} the actual data to cache */ localSessionStorage.save = localSessionStorage.setItem = function(key, value) { var deferred = $q.defer(); if (key) { var savedStatus = saveHandle(localSessionStorage, key, value); deferred.resolve(savedStatus); } else { deferred.reject(); } return deferred.promise; }; /** * Function to retrieve existing cache data * key must be defined * @param {key} the key for data to be retrieved */ localSessionStorage.get = localSessionStorage.getItem = function(key) { var deferred = $q.defer(); data = localSessionStorage.db.getItem(key); deferred.resolve(data); return deferred.promise; }; /** * Function to delete an existing cache data * key must be defined and part of exisiting keys * @param {key} the key for data to be deleted */ localSessionStorage.remove = localSessionStorage.removeItem = function(key) { var deferred = $q.defer(); localSessionStorage.db.removeItem(key); deferred.resolve(); console.log("localSessionStorage data cleared"); return deferred.promise; }; /** * Function to compute current size of cache, as per number of cache items */ localSessionStorage.length = function() { var deferred = $q.defer(), size = 0; size = localSessionStorage.db.length; deferred.resolve(size); return deferred.promise; }; /** * Function to clear entire cache space */ localSessionStorage.clear = function() { var deferred = $q.defer(); localSessionStorage.db.clear(); deferred.resolve(); return deferred.promise; }; /** * This storage object help abstract the basic functionalities of IndexDB. */ var localIndexedDB = {}; // database version localIndexedDB.version = 1; // marker for localIndexedDB localIndexedDB.name = "indexedDB"; // database name localIndexedDB.dbName = "cacheDB"; // entity name localIndexedDB.entityName = "cacheTable"; // database options localIndexedDB.options = {}; // open the database and configure it appropraitely localIndexedDB.open = function() { var deferred = $q.defer(); // update dbName and entityName on DB open localIndexedDB.dbName = localIndexedDB.options.dbName; localIndexedDB.entityName = localIndexedDB.options.entityName; if (localIndexedDB.db) { $timeout(function() { deferred.resolve(localIndexedDB.db); }); return deferred.promise; } if (!($window.indexedDB = $window.IndexedDB || $window.mozIndexedDB || $window.webkitIndexedDB || $window.msIndexedDB)) { var errorMessage = "indexedDB not supported on this device"; console.warn(errorMessage); $timeout(function() { deferred.resolve(null); }); return deferred.promise; } // use appropriate browser prefix if ('webkitIndexedDB' in $window) { $window.IDBTransaction = $window.IDBTransaction || $window.webkitIDBTransaction || $window.msIDBTransaction; $window.IDBKeyRange = $window.IDBKeyRange || $window.webkitIDBKeyRange || $window.msIDBKeyRange; } var request = $window.indexedDB.open(localIndexedDB.dbName, localIndexedDB.version); /* this is called once for when creating/upgrading localIndexedDB.db we can only create Object stores in a version-change transaction. */ request.onupgradeneeded = function(e) { var db = e.target.result; // handle for the actual indexedDB database localIndexedDB.db = db; e.target.transaction.onerror = $window.indexedDB.onerror; if (db.objectStoreNames.contains(localIndexedDB.entityName)) { db.deleteObjectStore(localIndexedDB.entityName); } db.createObjectStore(localIndexedDB.entityName); console.log(localIndexedDB.dbName + " indexedDB database created with store: " + localIndexedDB.entityName); }; /* invoked when after localIndexedDB.db has opened and all version-changes completed */ request.onsuccess = function(e) { localIndexedDB.db = e.target.result; $timeout(function() { deferred.resolve(localIndexedDB.db); }); }; request.onerror = function(e) { var errorMessage = "device might be operating incognito. localIndexedDB couldn't be created/opened. error: " + e.message; console.warn(errorMessage); $timeout(function() { deferred.resolve(null); }); }; return deferred.promise; }; /** * Function for caching a data. * key must be truthy -> not (null | undefined | NaN | "" | 0 | false) * @param {key} the key for data to be cached * @param {value} the actual data to cache */ localIndexedDB.save = localIndexedDB.setItem = function(key, value) { var deferred = $q.defer(); if (!key) { deferred.reject("invalid key"); return deferred.promise; } var db = localIndexedDB.db; if (!db) { var errorMessage = "localIndexedDB is not available"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); return deferred.promise; } // use entity object store in read-write manner var trans = db.transaction([localIndexedDB.entityName], "readwrite"); var objectStore = trans.objectStore(localIndexedDB.entityName); var request = objectStore.put(value, key); var savedStatus = false; request.onsuccess = function(e) { if (e.target.result) { savedStatus = true; // invalidate current cached page after specified max period $timeout(function() { localIndexedDB.removeItem(key); }, localIndexedDB.options.maxAge); } $timeout(function() { deferred.resolve(savedStatus); }); }; request.onerror = function(e) { var errorMessage = value + " couldn't be saved. error: " + e.message; console.warn(errorMessage); var storageRequestSuccess = function(used, remaining) { console.log("used quota: " + used + ", remaining quota: " + remaining); }; var storageRequestFailure = function(e) { console.log('error requesting storage space: ' + e.message); }; // check if error is due to quota limit if ($window.navigator.webkitTemporaryStorage) { $window.navigator.queryUsageAndQuota(storageRequestSuccess, storageRequestFailure); } else { $window.webkitStorageInfo.queryUsageAndQuota($window.webkitStorageInfo.TEMPORARY, storageRequestSuccess, storageRequestFailure); } $timeout(function() { deferred.resolve(savedStatus); }); }; return deferred.promise; }; /** * Function to retrieve existing cache data * key must be defined * @param {key} the key for data to be retrieved */ localIndexedDB.get = localIndexedDB.getItem = function(key) { var deferred = $q.defer(); var db = localIndexedDB.db; if (!db) { var errorMessage = "localIndexedDB is not available"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); return deferred.promise; } // use entity object store in read-write manner var trans = db.transaction([localIndexedDB.entityName], "readonly"); var objectStore = trans.objectStore(localIndexedDB.entityName); var request = objectStore.get(key); var data = null; request.onsuccess = function(e) { if (e.target.result) { data = e.target.result; } $timeout(function() { deferred.resolve(data); }); }; request.onerror = function(e) { var errorMessage = "couldn't retrieved value for key: " + key + ". error: " + e.message; console.warn(errorMessage); $timeout(function() { deferred.resolve(data); }); }; return deferred.promise; }; /** * Function to delete an existing cache data * key must be defined and part of exisiting keys * @param {key} the key for data to be deleted */ localIndexedDB.remove = localIndexedDB.removeItem = function(key) { var deferred = $q.defer(); var db = localIndexedDB.db; if (!db) { var errorMessage = "localIndexedDB is not available"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); return deferred.promise; } // use entity object store in read-write manner var trans = db.transaction([localIndexedDB.entityName], "readwrite"); var objectStore = trans.objectStore(localIndexedDB.entityName); // yui compressor is not happy with objectStore.delete.key var request = objectStore["delete"](key); request.onsuccess = function() { $timeout(function() { deferred.resolve(); }); }; request.onerror = function(e) { var errorMessage = "couldn't remove value for key: " + key + ". error: " + e.message; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * Function to clear entire cache space */ localIndexedDB.clear = function() { var deferred = $q.defer(); var db = localIndexedDB.db; if (!db) { var errorMessage = "localIndexedDB is not available"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); return deferred.promise; } // use entity object store in read-write manner var trans = db.transaction([localIndexedDB.entityName], "readwrite"); var objectStore = trans.objectStore(localIndexedDB.entityName); var request = objectStore.clear(); request.onsuccess = function () { console.log(localIndexedDB.dbName + " indexedDB data cleared"); $timeout(function() { deferred.resolve(); }); }; request.onerror = function(e) { var errorMessage = "couldn't clear content of indexedDB: " + localIndexedDB.dbName + ". error: " + e.message; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; request.onblocked = function (e) { var errorMessage = "couldn't clear content of indexedDB: " + localIndexedDB.dbName + " due to operation being blocked. error: " + e.message; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * Function to compute current size of cache, as per number of cache items */ localIndexedDB.length = function() { var deferred = $q.defer(); var db = localIndexedDB.db; if (!db) { var errorMessage = "localIndexedDB is not available"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); } // use entity object store in read-write manner var trans = db.transaction([localIndexedDB.entityName], "readwrite"); var objectStore = trans.objectStore(localIndexedDB.entityName); var request = objectStore.count(); request.onsuccess = function () { $timeout(function() { deferred.resolve(request.result); }); }; request.onerror = function(e) { var errorMessage = "couldn't clear compute size of indexedDB: " + localIndexedDB.dbName + ". error: " + e.message; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * This storage object help abstract the basic functionalities of WebSQL. */ var localWebSQL = {}; // database version localWebSQL.version = "1.0"; // marker for localIndexedDB localWebSQL.name = "webSQL"; // database name localWebSQL.dbName = "cacheDB"; // entity name localWebSQL.entityName = "cacheTable"; // database description localWebSQL.dbDescription = localWebSQL.dbName; // database size localWebSQL.dbSize = 5 * 1024 * 1024; // entity size localWebSQL.entitySize = 0; // database options localWebSQL.options = {}; // open the database and configure it appropraitely localWebSQL.open = function() { var deferred = $q.defer(); // update dbName and entityName on DB open localWebSQL.dbName = localWebSQL.options.dbName; localWebSQL.entityName = localWebSQL.options.entityName; try { if (localWebSQL.db) { $timeout(function() { deferred.resolve(); }); return deferred.promise; } // check for webSQL support if (!$window.openDatabase) { var errorMessage = "webSQL not supported on this device"; console.warn(errorMessage); $timeout(function() { deferred.resolve(null); }); return deferred.promise; } // handle for the actual webSQL database localWebSQL.db = $window.openDatabase(localWebSQL.dbName, localWebSQL.version, localWebSQL.dbDescription, localWebSQL.dbSize); localWebSQL.db.transaction(function (tx) { var createTable = 'CREATE TABLE IF NOT EXISTS ' + localWebSQL.entityName + ' (cacheKey TEXT PRIMARY KEY, cacheValue TEXT)'; tx.executeSql(createTable, [], onsuccess, onfailure); }); var onsuccess = function() { $timeout(function() { deferred.resolve(localWebSQL.db); }); }; var onfailure = function(tx, e) { var errorMessage = ""; switch (e.code) { case e.SYNTAX_ERR: errorMessage = "syntax error has occurred. " + e.message; console.warn(errorMessage); break; default: errorMessage = "error creating webSQL table " + localWebSQL.entityName + ". error: " + e; } console.warn(errorMessage); $timeout(function() { deferred.resolve(null); }); }; } catch (e) { var errorMessage = "error creating webSQL database/table. error: " + e; console.warn(errorMessage); $timeout(function() { deferred.resolve(null); }); } return deferred.promise; }; /** * Function for caching a data. * key must be truthy -> not (null | undefined | NaN | "" | 0 | false) * @param {key} the key for data to be cached * @param {value} the actual data to cache */ localWebSQL.save = localWebSQL.setItem = function(key, value) { var deferred = $q.defer(); var errorMessage = ""; if (!key) { errorMessage = "invalid key"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); } if (!localWebSQL.db) { errorMessage = "localWebSQL.db undefined"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); return deferred.promise; } var db = localWebSQL.db; var savedStatus = false; db.transaction(function (tx) { var insertData = 'INSERT INTO ' + localWebSQL.entityName + ' (cacheKey, cacheValue) VALUES (?, ?)'; tx.executeSql(insertData, [key, value], oninsertsuccess, onfailure); }); var oninsertsuccess = function() { savedStatus = true; // invalidate current cached page after specified max period $timeout(function() { localWebSQL.removeItem(key); }, localWebSQL.options.maxAge); $timeout(function() { deferred.resolve(savedStatus); }); }; var onfailure = function(tx, e) { var errorMessage = ""; switch (e.code) { case e.SYNTAX_ERR: errorMessage = "syntax error has occurred. " + e.message; console.warn(errorMessage); break; default: errorMessage = "error caching data. error: " + e.message; } console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * Function to retrieve existing cache data * key must be defined * @param {key} the key for data to be retrieved */ localWebSQL.get = localWebSQL.getItem = function(key) { var deferred = $q.defer(); var errorMessage = ""; if (!localWebSQL.db) { errorMessage = "localWebSQL.db undefined"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); return deferred.promise; } var db = localWebSQL.db; db.transaction(function (tx) { var selectData = 'SELECT cacheValue FROM ' + localWebSQL.entityName + ' WHERE cacheKey = ?'; tx.executeSql(selectData, [key], onsuccess, onfailure); }); var onsuccess = function(tx, result) { if (result) { var data = null; if (result.rows && result.rows.length) { data = result.rows.item(0).cacheValue; } $timeout(function() { deferred.resolve(data); }); } }; var onfailure = function(tx, e) { var errorMessage = ""; switch (e.code) { case e.SYNTAX_ERR: errorMessage = "syntax error has occurred. " + e.message; console.warn(errorMessage); break; default: errorMessage = "error retrieving data. error: " + e.message; } console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * Function to delete an existing cache data * key must be defined and part of exisiting keys * @param {key} the key for data to be deleted */ localWebSQL.remove = localWebSQL.removeItem = function(key) { var deferred = $q.defer(); var errorMessage = ""; if (!localWebSQL.db) { errorMessage = "localWebSQL.db undefined"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); $timeout.flush(); return deferred.promise; } var db = localWebSQL.db; db.transaction(function (tx) { var deleteData = 'DELETE FROM ' + localWebSQL.entityName + ' WHERE cacheKey = ?'; tx.executeSql(deleteData, [key], onsuccess, onfailure); }); var onsuccess = function() { $timeout(function() { deferred.resolve(); }); }; var onfailure = function(tx, e) { var errorMessage = ""; switch (e.code) { case e.SYNTAX_ERR: errorMessage = "syntax error has occurred. " + e.message; console.warn(errorMessage); break; default: errorMessage = "error removing data. error: " + e.message; } console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * Function to clear entire cache space */ localWebSQL.clear = function() { var deferred = $q.defer(); var errorMessage = ""; if (!localWebSQL.db) { errorMessage = "localWebSQL.db yet to be defined"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); return deferred.promise; } var db = localWebSQL.db; var status = false; db.transaction(function (tx) { var deleteTable = "DELETE FROM " + localWebSQL.entityName; tx.executeSql(deleteTable, [], onsuccess, onfailure); }); var onsuccess = function() { console.log(localWebSQL.entityName + " table in " + localWebSQL.dbName + " webSQL data cleared"); status = true; $timeout(function() { deferred.resolve(status); }); }; var onfailure = function(tx, e) { var errorMessage = ""; switch (e.code) { case e.SYNTAX_ERR: errorMessage = "syntax error has occurred. " + e.message; console.warn(errorMessage); break; default: errorMessage = "couldn't clear content of webSQL: " + localWebSQL.entityName + ". error: " + e.message; } console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * Function to compute current size of cache, as per number of cache items */ localWebSQL.length = function() { var deferred = $q.defer(); var errorMessage = ""; if (!localWebSQL.db) { errorMessage = "localWebSQL.db undefined"; console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); } var db = localWebSQL.db; db.transaction(function (tx) { var tableSize = 'SELECT COUNT(*) AS Size from ' + localWebSQL.entityName; tx.executeSql(tableSize, [], onsuccess, onfailure); }); var onsuccess = function(tx, result) { if (result && result.rows) { $timeout(function() { deferred.resolve(result.rows.item(0).Size); }); } }; var onfailure = function(tx, e) { var errorMessage = ""; switch (e.code) { case e.SYNTAX_ERR: errorMessage = "syntax error has occurred. " + e.message; console.warn(errorMessage); break; default: errorMessage = "error computing current cache size. error: " + e.message; } console.warn(errorMessage); $timeout(function() { deferred.reject(errorMessage); }); }; return deferred.promise; }; /** * Utility function for detecting if specified storage type exist * * @param {storageType} the type of storage to consider */ var storageExist = function(storageType) { var uid = (new Date()).valueOf().toString(); // check if specified storageType allow storage var savePromise = storageType.save(uid, uid); savePromise.then(function() { // delete test data upon successful cache test storageType.remove(uid); }); return savePromise; }; /** * Act as the storage handle based on available storage type. This help predetermine possible storage typeon service load. * It use either { localStorage | sessionStorage | polyFill } in the specified order of * availability. Store can also be configured using the cacheType {LOCAL_STORAGE | SESSION_STORAGE | INDEXED_DB | WEB_SQL | POLY_FILL }; */ var store = (function() { try { storageExist(localStorageDB).then(function(lsdbSavedStatus) { Eif (lsdbSavedStatus) { // use localStorage directly if available return localStorageDB; } else { storageExist(localSessionStorage).then(function(lssdbSavedStatus) { if (lssdbSavedStatus) { // use sessionStorage directly if available console.log("attempting sessionStorage client caching"); return localSessionStorage; } else { // fall back to poly fill data map console.log("attempting POLY_FILL client caching"); return POLY_FILL; } }); } }); } catch (e) { console.error(e.description); /* most likely: localStorage and sessionStorage have been disabled by user */ console.warn("....defaulting to POLY_FILL client caching"); return POLY_FILL; } }()); // supported cache types var cacheType = {LOCAL_STORAGE: 'localStorage', SESSION_STORAGE: 'sessionStorage', INDEXED_DB: 'indexedDB', "WEB_SQL": "webSQL", POLY_FILL: "polyFill"}; // configurable options var options = { /* * default database name. applicable to INDEXED_DB | WEB_SQL */ dbName: "cacheDB", /* * default table name. applicable to INDEXED_DB | WEB_SQL */ entityName: "cacheTable", /* * first n-items (default to first 10 items) to be deleted from the cache. this should be used when client storage is full. applicable to * LOCAL_STORAGE | SESSION_STORAGE */ deletableCacheItems: 10, /* * period (in milliseconds) after which each cached data should be deleted. default to 10 min */ maxAge: 600000, /* * cache type to use: valid options are { localStorage | sessionStorage | indexedDB | webSQL | polyFill }. default to polyFill */ storage: cacheType.POLY_FILL }; return { // POLY_FILL object POLY_FILL: POLY_FILL, // localStorage implementation localStorageDB: localStorageDB, // sessionStorage implementation localSessionStorage: localSessionStorage, // IndexedDB implementation localIndexedDB: localIndexedDB, // webSQL implementation localWebSQL: localWebSQL, // supported cache mechanism cacheType: cacheType, // storage handle getStorage: function(){ return store; }, // storage availability storeQuotaExceeded: storeQuotaExceeded, // check storage availability and usability storageExist: storageExist, // configurable options options: options, // cache service initialization init: function(initData) { var deferred = $q.defer(); /* ensure dbName option exist and that it is a valid truthy */ Eif (initData && initData.hasOwnProperty('dbName') && initData.dbName) { options.dbName = initData.dbName; } /* ensure entityName option exist and that it is a valid truthy */ Eif (initData && initData.hasOwnProperty('entityName') && initData.entityName) { options.entityName = initData.entityName; } /* ensure deletableCacheItems option exist and that it is a valid truthy */ Eif (initData && initData.hasOwnProperty('deletableCacheItems') && initData.deletableCacheItems) { options.deletableCacheItems = initData.deletableCacheItems; } /* ensure maxAge option exist and that it is a valid truthy */ Eif (initData && initData.hasOwnProperty('maxAge') && initData.maxAge) { options.maxAge = initData.maxAge; } /* specify storage to use and that cacheType specified is a valid truthy */ Eif (initData && initData.hasOwnProperty('cacheType') && initData.cacheType) { options.storage = initData.cacheType; // preprocessor handler for localIndexedDB var indexedDBPreprocessor = function (db) { $timeout(function() { deferred.resolve(db); }); store = localIndexedDB; console.info("cacheType overriden as indexedDB"); console.log(localIndexedDB.dbName + " indexedDB database opened"); }; // preprocessor handler for localWebSQL var webSQLPreprocessor = function (db) { $timeout(function() { deferred.resolve(db); }); store = localWebSQL; console.info("cacheType overriden as webSQL"); console.log(localWebSQL.dbName + " webSQL database opened"); }; // preprocessor handler for localStorageDB var localStoragePreprocessor = function (db) { $timeout(function() { deferred.resolve(db); }); store = localStorageDB; console.info("cacheType overriden as localStorage"); console.log(localStorageDB.dbName + " localStorage database opened"); }; // preprocessor handler for localSessionStorage var sessionStoragePreprocessor = function (db) { $timeout(function() { deferred.resolve(db); }); store = localSessionStorage; console.info("cacheType overriden as sessionStorage"); console.log(localSessionStorage.dbName + " sessionStorage database opened"); }; // preprocessor handler for POLY_FILL var polyFillPreprocessor = function () { $timeout(function() { deferred.resolve(); }); store = POLY_FILL; angular.toJson('store: ' + store); console.info("cacheType overriden as POLY_FILL"); console.log(POLY_FILL.dbName + " POLY_FILL database opened"); }; /* finalize storage initialization */ try { switch (options.storage) { case "indexedDB": // fall through if IndexedDB storage is not supported or currently unavailable on client device $window.indexedDB = $window.IndexedDB || $window.mozIndexedDB || $window.webkitIndexedDB || $window.msIndexedDB; if ($window.indexedDB) { // update storage options localIndexedDB.options = options; localIndexedDB.open().then(function(lidb) { if (lidb) { indexedDBPreprocessor(lidb); } else { // update storage options localWebSQL.options = options; localWebSQL.open().then(function(lwdb) { if (lwdb) { webSQLPreprocessor(lwdb); } else { // update storage options localStorageDB.options = options; localStorageDB.open().then(function(lsdb) { if (lsdb) { localStoragePreprocessor(lsdb); } else { // update storage options localSessionStorage.options = options; localSessionStorage.open().then(function(lssdb) { if (lssdb) { sessionStoragePreprocessor(lssdb); } else { // update storage options POLY_FILL.options = options; polyFillPreprocessor(); } }); } }); } }); } }); } break; case "webSQL": // fall through if WebSQL storage is not supported or currently unavailable on client device if ($window.openDatabase) { // update storage options localWebSQL.options = options; localWebSQL.open().then(function(lwdb) { if (lwdb) { webSQLPreprocessor(lwdb); } else { // update storage options localIndexedDB.options = options; localIndexedDB.open().then(function(lidb) { if (lidb) { indexedDBPreprocessor(lidb); } else { // update storage options localStorageDB.options = options; localStorageDB.open().then(function(lsdb) { if (lsdb) { localStoragePreprocessor(lsdb); } else { // update storage options localSessionStorage.options = options; localSessionStorage.open().then(function(lssdb) { if (lssdb) { sessionStoragePreprocessor(lssdb); } else { // update storage options POLY_FILL.options = options; polyFillPreprocessor(); } }); } }); } }); } }); } break; case "localStorage": // fall through if localStorage storage is not supported or currently unavailable on client device Eif ($window.localStorage) { // update storage options localStorageDB.options = options; localStorageDB.open().then(function(lsdb) { Eif (lsdb) { localStoragePreprocessor(lsdb); } else { // update storage options localIndexedDB.options = options; localIndexedDB.open().then(function(lidb) { if (lidb) { indexedDBPreprocessor(lidb); } else { // update storage options localWebSQL.options = options; localWebSQL.open().then(function(lwdb) { if (lwdb) { webSQLPreprocessor(lwdb); } else { // update storage options localSessionStorage.options = options; localSessionStorage.open().then(function(lssdb) { if (lssdb) { sessionStoragePreprocessor(lssdb); } else { // update storage options POLY_FILL.options = options; polyFillPreprocessor(); } }); } }); } }); } }); } break; case "sessionStorage": // fall through if sessionStorage storage is not supported or currently unavailable on client device if ($window.sessionStorage) { // update storage options localSessionStorage.options = options; localSessionStorage.open().then(function(lssdb) { if (lssdb) { sessionStoragePreprocessor(lssdb); } else { // update storage options localIndexedDB.options = options; localIndexedDB.open().then(function(lidb) { if (lidb) { indexedDBPreprocessor(lidb); } else { // update storage options localWebSQL.options = options; localWebSQL.open().then(function(lwdb) { if (lwdb) { webSQLPreprocessor(lwdb); } else { // update storage options localStorageDB.options = options; localStorageDB.open().then(function(lsdb) { if (lsdb) { localStoragePreprocessor(lsdb); } else { // update storage options POLY_FILL.options = options; polyFillPreprocessor(); } }); } }); } }); } }); } break; case "polyFill": // update storage options POLY_FILL.options = options; POLY_FILL.open().then(function() { polyFillPreprocessor(); }); break; } return deferred.promise; } catch(e) { store = POLY_FILL; // update storage options store.options = options; console.warn("chosen cacheType probably not supported...using POLY_FILL as fallback cacheType. error: " + e); } } }, // cache data save: function(key, value) { return store.save(key, value); }, // remove cached data remove: function(key) { return store.remove(key); }, // retrieve cached data get: function(key) { return store.get(key); }, // compute size of cached storage length: function() { return store.length(); }, // clear cache storage clear: function() { return store.clear(); } }; }; // singleton copy var singleton = repository(); // extend cacheStorage cacheStorage.prototype.instance = function(){ return repository(); }; return { getNewInstance : function() { return new cacheStorage().instance(); }, create : function() { return singleton; } }; } ]); |