| 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 | 123x 123x 123x 123x 304x 304x 304x 123x 14289x 123x 442096x 5095x 123x 280810x 280810x 280810x 501261x 44814x 456447x 1546057x 1545991x 350231x 456381x 134x 456381x 235930x 123x 62x 123x 12x 62x 123x 268397x 123x 88x 123x 268547x 12x 12x 12x 12x 12x 12x 12x 10x 12x 268535x 123x 123x 20378x 20378x 19382x 20378x 20378x 20378x 140221x 140221x 139839x 6929x 132910x 382x 132528x 127474x 382x 382x 242x 20378x 19382x 20378x 123x 123x 16472x 16472x 16472x 16472x 18106x 18106x 18106x 16472x 123x 21511x 21511x 117217x 117217x 30x 117217x 21511x 123x 238x 123x 21273x 13981x 21273x 123x 8004x 8004x 10807x 8004x 123x 102x 70x 32x 70x 18x 14x 123x 123x 123x 123x 123x 123x 123x 4827x 4827x 6343x 5219x 4827x 123x 6339x 6339x 6339x 6339x 6339x 6339x 6339x 2450x 1120x 1120x 1330x 1102x 6339x 5239x 5239x 6339x 6339x 6339x 5239x 123x 4969x 4965x 123x 6533x 123x 10523x 10523x 10523x 6221x 6221x 10523x 123x 138x 138x 138x 123x 123x 10388x 84392x 25280x 59112x 5467x 123x 4787x 6219x 6219x 6219x 6272x 6254x 6254x 4806x 6219x 6219x 4266x 6219x 4266x 6219x 123x 123x 4787x 4787x 4787x 6219x 6219x 6219x 4787x 4787x 6215x 4787x 4787x 4787x 4787x 5159x 6215x 4787x 1440x 4787x 6219x 6219x 6219x 1248x 4971x 2529x 2525x 6215x 6215x 6213x 4783x 123x 4969x 4969x 4969x 4969x 4969x 4969x 6407x 4969x 4787x 4787x 4x 4x 4783x 123x 3297x 3297x 3297x 123x 6103x 4x 4x 6103x 4x 6103x 6099x 3297x 3297x 3297x 863x 863x 2434x 2434x 2434x 2802x 4x 4x 6103x 3297x 3297x 3297x 2806x 6103x 5240x 2x 5238x 4x 5238x 2x 6099x 6099x 6099x 2802x 6099x 123x 62783x 62783x 62783x 3734x 59049x 59049x 6646x 59049x 123x 8557x 8557x 123x 4929x 4929x 4929x 4929x 4929x 123x 123x 3956x 3956x 3956x 3956x 3956x 3956x 21474x 21474x 21474x 642x 21474x 21474x 21474x 21474x 21474x 21474x 2x 21472x 4929x 21472x 3310x 18162x 3989x 18162x 11720x 3956x 3956x 8x 3956x 3956x 3956x 2636x 123x 2774x 5548x 5548x 1526x 1526x 1500x 2774x 2774x 2774x 2774x 1592x 1088x 504x 1182x 1182x 123x 3545x 3545x 3545x 123x 14175x 5840x 8335x 8335x 12144x 467x 12144x 6x 8335x 123x 3310x 3244x 123x 4442x 4442x 4442x 3244x 470x 3244x 123x 718x 718x 3698x 3698x 752x 752x 744x 744x 8x 718x 2516x 1759x 2516x 718x 718x 1221x 1221x 718x 718x 718x 718x 214x 214x 794x 214x 718x 718x 718x 718x 718x 718x 718x 718x 718x 718x 123x 716x 716x 123x 123x 1436x 1436x 4x 1436x 1400x 36x 20x 20x 16x 1436x 123x 718x 718x 718x 718x 718x 718x 718x 718x 212x 506x 2x 504x 123x 12035x 2925x 2921x 863x 2058x 2058x 9110x 3772x 5338x 142x 5196x 5196x 8786x 8786x 8786x 6716x 8786x 12031x 123x 6642x 6642x 6642x 4126x 4126x 4126x 4122x 6642x 123x 6642x 6642x 40670x 11786x 11786x 123x 17733x 17733x 17733x 17733x 47409x 1221x 1221x 1221x 1221x 17733x 123x 4975x 4975x 4975x 4975x 4975x 4975x 530x 718x 4973x 2531x 4969x 4969x 16949x 16949x 6642x 13497x 6642x 6642x 4969x 4969x 4969x 4969x 123x 123x 3983x 123x 3983x 1870x 3983x 123x 1965x 3983x 3983x 3983x 3983x 3983x 3983x 3858x 3983x 1965x 1965x 123x 1965x 1965x 1965x 1965x 1965x 1965x 156x 136x 136x 136x 1965x 156x 156x 123x 4975x 1791x 1791x 1791x 1965x 1965x 1965x 1973x 1973x 1965x 1965x 123x 4319x 3631x 123x 57198x 113642x 25165x 88477x 44472x 32033x 123x 28599x 32033x 32033x 32033x 28599x 12516x 12516x 28599x 19517x 19517x 123x 16615x 53695x 53695x 53695x 123x 65522x 42209x 23313x 18236x 5077x 5077x 123x 78581x 78581x 78581x 78581x 78581x 61966x 20987x 20987x 16615x 4913x 78581x 25900x 25900x 25896x 78581x 16615x 123x 18847x 12277x 2x 12275x 12275x 12275x 376x 18847x 123x 36549x 36549x 36549x 36549x 123x 29644x 29644x 29644x 29644x 29644x 29644x 10797x 18847x 264x 264x 18847x 29644x 24886x 24886x 24886x 4758x 4758x 2063x 2063x 2063x 29644x 123x 6758x 6758x 6758x 6758x 3514x 3244x 667x 2577x 2577x 2577x 2577x 2577x 2577x 6758x 3399x 3399x 3359x 1283x 6758x 123x 16x 22x 123x 86521x 86521x 86521x 86521x 86521x 86521x 86521x 110686x 110686x 16x 16x 110670x 110670x 110670x 110670x 86521x 27003x 16x 4x 12x 8x 4x 26987x 86521x 123x 4136x 4136x 4136x 4136x 123x 33355x 10864x 22491x 22491x 86471x 86471x 86471x 86521x 86521x 27009x 27009x 27009x 27009x 27009x 5535x 5535x 942x 4593x 4593x 451x 25616x 4136x 21480x 123x 6905x 12401x 6905x 6938x 123x 1384x 123x 123x 24396x 5114x 24396x 123x 25172x 5182x 5182x 123x 11528x 123x 11528x 11528x 6542x 123x 123x 6905x 6905x 6905x 6905x 6905x 6905x 1261x 1261x 1261x 6905x 6065x 30x 6035x 6065x 6065x 6065x 6065x 6065x 6065x 2613x 6065x 4100x 144x 4100x 4100x 6065x 2109x 2109x 2117x 2109x 6065x 6065x 6065x 6905x 5341x 5341x 6905x 2611x 2611x 2611x 6905x 14031x 14031x 14031x 27038x 27038x 27038x 27038x 27038x 20673x 20673x 7575x 7575x 7575x 20673x 14523x 24396x 24396x 24396x 24396x 2x 14031x 14031x 11528x 11528x 11528x 11528x 14031x 14031x 14031x 6905x 6905x 6905x 123x 222x 222x 222x 222x 222x 222x 123x 252x 12x 240x 4x 236x 236x 258x 258x 216x 42x 12x 30x 30x | /* Copyright 2008-2010 University of Cambridge Copyright 2008-2009 University of Toronto Copyright 2010-2011 Lucendo Development Ltd. Copyright 2010-2014 OCAD University Copyright 2012-2014 Raising the Floor - US Copyright 2014-2017 Raising the Floor - International Licensed under the Educational Community License (ECL), Version 2.0 or the New BSD license. You may not use this file except in compliance with one these Licenses. You may obtain a copy of the ECL 2.0 License and BSD License at https://github.com/fluid-project/infusion/raw/master/Infusion-LICENSE.txt */ var fluid_3_0_0 = fluid_3_0_0 || {}; (function ($, fluid) { "use strict"; /** NOTE: The contents of this file are by default NOT PART OF THE PUBLIC FLUID API unless explicitly annotated before the function **/ /** MODEL ACCESSOR ENGINE **/ /** Standard strategies for resolving path segments **/ fluid.model.makeEnvironmentStrategy = function (environment) { return function (root, segment, index) { return index === 0 && environment[segment] ? environment[segment] : undefined; }; }; fluid.model.defaultCreatorStrategy = function (root, segment) { Eif (root[segment] === undefined) { root[segment] = {}; return root[segment]; } }; fluid.model.defaultFetchStrategy = function (root, segment) { return root[segment]; }; fluid.model.funcResolverStrategy = function (root, segment) { if (root.resolvePathSegment) { return root.resolvePathSegment(segment); } }; fluid.model.traverseWithStrategy = function (root, segs, initPos, config, uncess) { var strategies = config.strategies; var limit = segs.length - uncess; for (var i = initPos; i < limit; ++i) { if (!root) { return root; } var accepted; for (var j = 0; j < strategies.length; ++j) { accepted = strategies[j](root, segs[i], i + 1, segs); if (accepted !== undefined) { break; // May now short-circuit with stateless strategies } } if (accepted === fluid.NO_VALUE) { accepted = undefined; } root = accepted; } return root; }; /* Returns both the value and the path of the value held at the supplied EL path */ fluid.model.getValueAndSegments = function (root, EL, config, initSegs) { return fluid.model.accessWithStrategy(root, EL, fluid.NO_VALUE, config, initSegs, true); }; // Very lightweight remnant of trundler, only used in resolvers fluid.model.makeTrundler = function (config) { return function (valueSeg, EL) { return fluid.model.getValueAndSegments(valueSeg.root, EL, config, valueSeg.segs); }; }; fluid.model.getWithStrategy = function (root, EL, config, initSegs) { return fluid.model.accessWithStrategy(root, EL, fluid.NO_VALUE, config, initSegs); }; fluid.model.setWithStrategy = function (root, EL, newValue, config, initSegs) { fluid.model.accessWithStrategy(root, EL, newValue, config, initSegs); }; fluid.model.accessWithStrategy = function (root, EL, newValue, config, initSegs, returnSegs) { // This function is written in this unfortunate style largely for efficiency reasons. In many cases // it should be capable of running with 0 allocations (EL is preparsed, initSegs is empty) if (!fluid.isPrimitive(EL) && !fluid.isArrayable(EL)) { var key = EL.type || "default"; var resolver = config.resolvers[key]; Iif (!resolver) { fluid.fail("Unable to find resolver of type " + key); } var trundler = fluid.model.makeTrundler(config); // very lightweight trundler for resolvers var valueSeg = {root: root, segs: initSegs}; valueSeg = resolver(valueSeg, EL, trundler); if (EL.path && valueSeg) { // every resolver supports this piece of output resolution valueSeg = trundler(valueSeg, EL.path); } return returnSegs ? valueSeg : (valueSeg ? valueSeg.root : undefined); } else { return fluid.model.accessImpl(root, EL, newValue, config, initSegs, returnSegs, fluid.model.traverseWithStrategy); } }; // Implementation notes: The EL path manipulation utilities here are equivalents of the simpler ones // that are provided in Fluid.js and elsewhere - they apply escaping rules to parse characters . // as \. and \ as \\ - allowing us to process member names containing periods. These versions are mostly // in use within model machinery, whereas the cheaper versions based on String.split(".") are mostly used // within the IoC machinery. // Performance testing in early 2015 suggests that modern browsers now allow these to execute slightly faster // than the equivalent machinery written using complex regexps - therefore they will continue to be maintained // here. However, there is still a significant performance gap with respect to the performance of String.split(".") // especially on Chrome, so we will continue to insist that component member names do not contain a "." character // for the time being. // See http://jsperf.com/parsing-escaped-el for some experiments fluid.registerNamespace("fluid.pathUtil"); fluid.pathUtil.getPathSegmentImpl = function (accept, path, i) { var segment = null; if (accept) { segment = ""; } var escaped = false; var limit = path.length; for (; i < limit; ++i) { var c = path.charAt(i); if (!escaped) { if (c === ".") { break; } else if (c === "\\") { escaped = true; } else if (segment !== null) { segment += c; } } else { escaped = false; if (segment !== null) { segment += c; } } } if (segment !== null) { accept[0] = segment; } return i; }; var globalAccept = []; // TODO: reentrancy risk here. This holder is here to allow parseEL to make two returns without an allocation. /* A version of fluid.model.parseEL that apples escaping rules - this allows path segments * to contain period characters . - characters "\" and "}" will also be escaped. WARNING - * this current implementation is EXTREMELY slow compared to fluid.model.parseEL and should * not be used in performance-sensitive applications */ // supported, PUBLIC API function fluid.pathUtil.parseEL = function (path) { var togo = []; var index = 0; var limit = path.length; while (index < limit) { var firstdot = fluid.pathUtil.getPathSegmentImpl(globalAccept, path, index); togo.push(globalAccept[0]); index = firstdot + 1; } return togo; }; // supported, PUBLIC API function fluid.pathUtil.composeSegment = function (prefix, toappend) { toappend = toappend.toString(); for (var i = 0; i < toappend.length; ++i) { var c = toappend.charAt(i); if (c === "." || c === "\\" || c === "}") { prefix += "\\"; } prefix += c; } return prefix; }; /* Escapes a single path segment by replacing any character ".", "\" or "}" with itself prepended by \ */ // supported, PUBLIC API function fluid.pathUtil.escapeSegment = function (segment) { return fluid.pathUtil.composeSegment("", segment); }; /* * Compose a prefix and suffix EL path, where the prefix is already escaped. * Prefix may be empty, but not null. The suffix will become escaped. */ // supported, PUBLIC API function fluid.pathUtil.composePath = function (prefix, suffix) { if (prefix.length !== 0) { prefix += "."; } return fluid.pathUtil.composeSegment(prefix, suffix); }; /* * Compose a set of path segments supplied as arguments into an escaped EL expression. Escaped version * of fluid.model.composeSegments */ // supported, PUBLIC API function fluid.pathUtil.composeSegments = function () { var path = ""; for (var i = 0; i < arguments.length; ++i) { path = fluid.pathUtil.composePath(path, arguments[i]); } return path; }; /* Helpful utility for use in resolvers - matches a path which has already been parsed into segments */ fluid.pathUtil.matchSegments = function (toMatch, segs, start, end) { if (end - start !== toMatch.length) { return false; } for (var i = start; i < end; ++i) { if (segs[i] !== toMatch[i - start]) { return false; } } return true; }; fluid.model.unescapedParser = { parse: fluid.model.parseEL, compose: fluid.model.composeSegments }; // supported, PUBLIC API record fluid.model.defaultGetConfig = { parser: fluid.model.unescapedParser, strategies: [fluid.model.funcResolverStrategy, fluid.model.defaultFetchStrategy] }; // supported, PUBLIC API record fluid.model.defaultSetConfig = { parser: fluid.model.unescapedParser, strategies: [fluid.model.funcResolverStrategy, fluid.model.defaultFetchStrategy, fluid.model.defaultCreatorStrategy] }; fluid.model.escapedParser = { parse: fluid.pathUtil.parseEL, compose: fluid.pathUtil.composeSegments }; // supported, PUBLIC API record fluid.model.escapedGetConfig = { parser: fluid.model.escapedParser, strategies: [fluid.model.defaultFetchStrategy] }; // supported, PUBLIC API record fluid.model.escapedSetConfig = { parser: fluid.model.escapedParser, strategies: [fluid.model.defaultFetchStrategy, fluid.model.defaultCreatorStrategy] }; /** CONNECTED COMPONENTS AND TOPOLOGICAL SORTING **/ // Following "tarjan" at https://en.wikipedia.org/wiki/Tarjan%27s_strongly_connected_components_algorithm /** Compute the strongly connected components of a graph, specified as a list of vertices and an accessor function. * Returns an array of arrays of strongly connected vertices, with each component in topologically sorted order. * @param {Vertex[]} vertices - An array of vertices of the graph to be processed. Each vertex object will be polluted * with three extra fields: `tarjanIndex`, `lowIndex` and `onStack`. * @param {Function} accessor - A function that returns the accessor vertex or vertices. * @return {Array.<Vertex[]>} - An array of arrays of vertices. */ fluid.stronglyConnected = function (vertices, accessor) { var that = { stack: [], accessor: accessor, components: [], index: 0 }; vertices.forEach(function (vertex) { if (vertex.tarjanIndex === undefined) { fluid.stronglyConnectedOne(vertex, that); } }); return that.components; }; // Perform one round of the Tarjan search algorithm using the state structure generated in fluid.stronglyConnected fluid.stronglyConnectedOne = function (vertex, that) { vertex.tarjanIndex = that.index; vertex.lowIndex = that.index; ++that.index; that.stack.push(vertex); vertex.onStack = true; var outEdges = that.accessor(vertex); outEdges.forEach(function (outVertex) { if (outVertex.tarjanIndex === undefined) { // Successor has not yet been visited; recurse on it fluid.stronglyConnectedOne(outVertex, that); vertex.lowIndex = Math.min(vertex.lowIndex, outVertex.lowIndex); } else if (outVertex.onStack) { // Successor is on the stack and hence in the current component vertex.lowIndex = Math.min(vertex.lowIndex, outVertex.tarjanIndex); } }); // If vertex is a root node, pop the stack back as far as it and generate a component if (vertex.lowIndex === vertex.tarjanIndex) { var component = [], outVertex; do { outVertex = that.stack.pop(); outVertex.onStack = false; component.push(outVertex); } while (outVertex !== vertex); that.components.push(component); } }; /** MODEL COMPONENT HIERARCHY AND RELAY SYSTEM **/ fluid.initRelayModel = function (that) { fluid.deenlistModelComponent(that); return that.model; }; // TODO: This utility compensates for our lack of control over "wave of explosions" initialisation - we may // catch a model when it is apparently "completely initialised" and that's the best we can do, since we have // missed its own initial transaction fluid.isModelComplete = function (that) { return "model" in that && that.model !== fluid.inEvaluationMarker; }; // Enlist this model component as part of the "initial transaction" wave - note that "special transaction" init // is indexed by component, not by applier, and has special record type (complete + initModel), not transaction fluid.enlistModelComponent = function (that) { var instantiator = fluid.getInstantiator(that); var enlist = instantiator.modelTransactions.init[that.id]; if (!enlist) { enlist = { that: that, applier: fluid.getForComponent(that, "applier"), // required for FLUID-5504 even though currently unused complete: fluid.isModelComplete(that) }; instantiator.modelTransactions.init[that.id] = enlist; } return enlist; }; fluid.clearTransactions = function () { var instantiator = fluid.globalInstantiator; fluid.clear(instantiator.modelTransactions); instantiator.modelTransactions.init = {}; }; fluid.failureEvent.addListener(fluid.clearTransactions, "clearTransactions", "before:fail"); // Utility to coordinate with our crude "oscillation prevention system" which limits each link to 2 updates (presumably // in opposite directions). In the case of the initial transaction, we need to reset the count given that genuine // changes are arising in the system with each new enlisted model. TODO: if we ever get users operating their own // transactions, think of a way to incorporate this into that workflow fluid.clearLinkCounts = function (transRec, relaysAlso) { // TODO: Separate this record out into different types of records (relays are already in their own area) fluid.each(transRec, function (value, key) { if (typeof(value) === "number") { transRec[key] = 0; } else if (relaysAlso && value.options && typeof(value.relayCount) === "number") { value.relayCount = 0; } }); }; /** Compute relay dependency out arcs for a group of initialising components. * @param {Object} transacs - Hash of component id to local ChangeApplier transaction. * @param {Object} mrec - Hash of component id to enlisted component record. * @return {Object} - Hash of component id to list of enlisted component record. */ fluid.computeInitialOutArcs = function (transacs, mrec) { return fluid.transform(mrec, function (recel, id) { var oneOutArcs = {}; var listeners = recel.that.applier.listeners.sortedListeners; fluid.each(listeners, function (listener) { if (listener.isRelay && !fluid.isExcludedChangeSource(transacs[id], listener.cond)) { var targetId = listener.targetId; if (targetId !== id) { oneOutArcs[targetId] = true; } } }); var oneOutArcList = Object.keys(oneOutArcs); var togo = oneOutArcList.map(function (id) { return mrec[id]; }); // No edge if the component is not enlisted - it will sort to the end via "completeOnInit" fluid.remove_if(togo, function (rec) { return rec === undefined; }); return togo; }); }; fluid.sortCompleteLast = function (reca, recb) { return (reca.completeOnInit ? 1 : 0) - (recb.completeOnInit ? 1 : 0); }; /** Operate all coordinated transactions by bringing models to their respective initial values, and then commit them all * @param {Component} that - A representative component of the collection for which the initial transaction is to be operated * @param {Object} mrec - The global model transaction record for the init transaction. This is a hash indexed by component id * to a model transaction record, as registered in `fluid.enlistModelComponent`. This has members `that`, `applier`, `complete`. */ fluid.operateInitialTransaction = function (that, mrec) { var transId = fluid.allocateGuid(); var transRec = fluid.getModelTransactionRec(that, transId); var transac; var transacs = fluid.transform(mrec, function (recel) { transac = recel.that.applier.initiate(null, "init", transId); transRec[recel.that.applier.applierId] = {transaction: transac}; return transac; }); // TODO: This sort has very little effect in any current test (can be replaced by no-op - see FLUID-5339) - but // at least can't be performed in reverse order ("FLUID-3674 event coordination test" will fail) - need more cases // Compute the graph of init transaction relays for FLUID-6234 - one day we will have to do better than this, since there // may be finer structure than per-component - it may be that each piece of model area participates in this relation // differently. But this will require even more ambitious work such as fragmenting all the initial model values along // these boundaries. var outArcs = fluid.computeInitialOutArcs(transacs, mrec); var arcAccessor = function (mrec) { return outArcs[mrec.that.id]; }; var recs = fluid.values(mrec); var components = fluid.stronglyConnected(recs, arcAccessor); var priorityIndex = 0; components.forEach(function (component) { component.forEach(function (recel) { recel.initPriority = recel.completeOnInit ? Math.Infinity : priorityIndex++; }); }); recs.sort(function (reca, recb) { return reca.initPriority - recb.initPriority; }); recs.forEach(function (recel) { var that = recel.that; var transac = transacs[that.id]; if (recel.completeOnInit) { fluid.initModelEvent(that, that.applier, transac, that.applier.listeners.sortedListeners); } else { fluid.each(recel.initModels, function (initModel) { transac.fireChangeRequest({type: "ADD", segs: [], value: initModel}); fluid.clearLinkCounts(transRec, true); }); } var shadow = fluid.shadowForComponent(that); if (shadow) { // Fix for FLUID-5869 - the component may have been destroyed during its own init transaction shadow.modelComplete = true; // technically this is a little early, but this flag is only read in fluid.connectModelRelay } }); transac.commit(); // committing one representative transaction will commit them all }; // This modelComponent has now concluded initialisation - commit its initialisation transaction if it is the last such in the wave fluid.deenlistModelComponent = function (that) { var instantiator = fluid.getInstantiator(that); var mrec = instantiator.modelTransactions.init; Iif (!mrec[that.id]) { // avoid double evaluation through currently hacked "members" implementation return; } that.model = undefined; // Abuse of the ginger system - in fact it is "currently in evaluation" - we need to return a proper initial model value even if no init occurred yet mrec[that.id].complete = true; // flag means - "complete as in ready to participate in this transaction" var incomplete = fluid.find_if(mrec, function (recel) { return recel.complete !== true; }); if (!incomplete) { try { // For FLUID-6195 ensure that exceptions during init relay don't leave the framework unusable fluid.operateInitialTransaction(that, mrec); } catch (e) { fluid.clearTransactions(); throw e; } // NB: Don't call fluid.concludeTransaction since "init" is not a standard record - this occurs in commitRelays for the corresponding genuine record as usual instantiator.modelTransactions.init = {}; } }; fluid.parseModelReference = function (that, ref) { var parsed = fluid.parseContextReference(ref); parsed.segs = that.applier.parseEL(parsed.path); return parsed; }; /** Given a string which may represent a reference into a model, parses it into a structure holding the coordinates for resolving the reference. It specially * detects "references into model material" by looking for the first path segment in the path reference which holds the value "model". Some of its workflow is bypassed * in the special case of a reference representing an implicit model relay. In this case, ref will definitely be a String, and if it does not refer to model material, rather than * raising an error, the return structure will include a field <code>nonModel: true</code> * @param {Component} that - The component holding the reference * @param {String} name - A human-readable string representing the type of block holding the reference - e.g. "modelListeners" * @param {String|ModelReference} ref - The model reference to be parsed. This may have already been partially parsed at the original site - that is, a ModelReference is a * structure containing * segs: {String[]} An array of model path segments to be dereferenced in the target component (will become `modelSegs` in the final return) * context: {String} An IoC reference to the component holding the model * @param {Boolean} implicitRelay - <code>true</code> if the reference was being resolved for an implicit model relay - that is, * whether it occured within the `model` block itself. In this case, references to non-model material are not a failure and will simply be resolved * (by the caller) onto their targets (as constants). Otherwise, this function will issue a failure on discovering a reference to non-model material. * @return {Object} - A structure holding: * that {Component} The component whose model is the target of the reference. This may end up being constructed as part of the act of resolving the reference * applier {Component} The changeApplier for the component <code>that</code>. This may end up being constructed as part of the act of resolving the reference * modelSegs {String[]} An array of path segments into the model of the component * path {String} the value of <code>modelSegs</code> encoded as an EL path (remove client uses of this in time) * nonModel {Boolean} Set if <code>implicitRelay</code> was true and the reference was not into a model (modelSegs/path will not be set in this case) * segs {String[]} Holds the full array of path segments found by parsing the original reference - only useful in <code>nonModel</code> case */ fluid.parseValidModelReference = function (that, name, ref, implicitRelay) { var reject = function () { var failArgs = ["Error in " + name + ": ", ref].concat(fluid.makeArray(arguments)); fluid.fail.apply(null, failArgs); }; var rejectNonModel = function (value) { reject(" must be a reference to a component with a ChangeApplier (descended from fluid.modelComponent), instead got ", value); }; var parsed; // resolve ref into context and modelSegs if (typeof(ref) === "string") { if (fluid.isIoCReference(ref)) { parsed = fluid.parseModelReference(that, ref); var modelPoint = parsed.segs.indexOf("model"); if (modelPoint === -1) { Eif (implicitRelay) { parsed.nonModel = true; } else { reject(" must be a reference into a component model via a path including the segment \"model\""); } } else { parsed.modelSegs = parsed.segs.slice(modelPoint + 1); parsed.contextSegs = parsed.segs.slice(0, modelPoint); delete parsed.path; } } else { parsed = { path: ref, modelSegs: that.applier.parseEL(ref) }; } } else { Iif (!fluid.isArrayable(ref.segs)) { reject(" must contain an entry \"segs\" holding path segments referring a model path within a component"); } parsed = { context: ref.context, modelSegs: fluid.expandOptions(ref.segs, that) }; } var contextTarget, target; // resolve target component, which defaults to "that" if (parsed.context) { contextTarget = fluid.resolveContext(parsed.context, that); Iif (!contextTarget) { reject(" context must be a reference to an existing component"); } target = parsed.contextSegs ? fluid.getForComponent(contextTarget, parsed.contextSegs) : contextTarget; } else { target = that; } if (!parsed.nonModel) { if (!fluid.isComponent(target)) { rejectNonModel(target); } if (!target.applier) { fluid.getForComponent(target, ["applier"]); } if (!target.applier) { rejectNonModel(target); } } parsed.that = target; parsed.applier = target && target.applier; if (!parsed.path) { // ChangeToApplicable amongst others rely on this parsed.path = target && target.applier.composeSegments.apply(null, parsed.modelSegs); } return parsed; }; // Gets global record for a particular transaction id, allocating if necessary - looks up applier id to transaction, // as well as looking up source id (linkId in below) to count/true // Through poor implementation quality, not every access passes through this function - some look up instantiator.modelTransactions directly fluid.getModelTransactionRec = function (that, transId) { var instantiator = fluid.getInstantiator(that); Iif (!transId) { fluid.fail("Cannot get transaction record without transaction id"); } if (!instantiator) { return null; } var transRec = instantiator.modelTransactions[transId]; if (!transRec) { transRec = instantiator.modelTransactions[transId] = { relays: [], // sorted array of relay elements (also appear at top level index by transaction id) sources: {}, // hash of the global transaction sources (includes "init" but excludes "relay" and "local") externalChanges: {} // index by applierId to changePath to listener record }; } return transRec; }; fluid.recordChangeListener = function (component, applier, sourceListener, listenerId) { var shadow = fluid.shadowForComponent(component); fluid.recordListener(applier.modelChanged, sourceListener, shadow, listenerId); }; /** Called when a relay listener registered using `fluid.registerDirectChangeRelay` enlists in a transaction. Opens a local * representative of this transaction on `targetApplier`, creates and stores a "transaction element" within the global transaction * record keyed by the target applier's id. The transaction element is also pushed onto the `relays` member of the global transaction record - they * will be sorted by priority here when changes are fired. * @param {TransactionRecord} transRec - The global record for the current ChangeApplier transaction as retrieved from `fluid.getModelTransactionRec` * @param {ChangeApplier} targetApplier - The ChangeApplier to which outgoing changes will be applied. A local representative of the transaction will be opened on this applier and returned. * @param {String} transId - The global id of this transaction * @param {Object} options - The `options` argument supplied to `fluid.registerDirectChangeRelay`. This will be stored in the returned transaction element * - note that only the member `update` is ever used in `fluid.model.updateRelays` - TODO: We should thin this out * @param {Object} npOptions - Namespace and priority options * namespace {String} [optional] The namespace attached to this relay definition * priority {String} [optional] The (unparsed) priority attached to this relay definition * @return {Object} A "transaction element" holding information relevant to this relay's enlistment in the current transaction. This includes fields: * transaction {Transaction} The local representative of this transaction created on `targetApplier` * relayCount {Integer} The number of times this relay has been activated in this transaction * namespace {String} [optional] Namespace for this relay definition * priority {Priority} The parsed priority definition for this relay */ fluid.registerRelayTransaction = function (transRec, targetApplier, transId, options, npOptions) { var newTrans = targetApplier.initiate("relay", null, transId); // non-top-level transaction will defeat postCommit var transEl = transRec[targetApplier.applierId] = {transaction: newTrans, relayCount: 0, namespace: npOptions.namespace, priority: npOptions.priority, options: options}; transEl.priority = fluid.parsePriority(transEl.priority, transRec.relays.length, false, "model relay"); transRec.relays.push(transEl); return transEl; }; // Configure this parameter to tweak the number of relays the model will attempt per transaction before bailing out with an error fluid.relayRecursionBailout = 100; // Used with various arg combinations from different sources. For standard "implicit relay" or fully lensed relay, // the first 4 args will be set, and "options" will be empty // For a model-dependent relay, this will be used in two halves - firstly, all of the model // sources will bind to the relay transform document itself. In this case the argument "targetApplier" within "options" will be set. // In this case, the component known as "target" is really the source - it is a component reference discovered by parsing the // relay document. // Secondly, the relay itself will schedule an invalidation (as if receiving change to "*" of its source - which may in most // cases actually be empty) and play through its transducer. "Source" component itself is never empty, since it is used for listener // degistration on destruction (check this is correct for external model relay). However, "sourceSegs" may be empty in the case // there is no "source" component registered for the link. This change is played in a "half-transactional" way - that is, we wait // for all other changes in the system to settle before playing the relay document, in order to minimise the chances of multiple // firing and corruption. This is done via the "preCommit" hook registered at top level in establishModelRelay. This listener // is transactional but it does not require the transaction to conclude in order to fire - it may be reused as many times as // required within the "overall" transaction whilst genuine (external) changes continue to arrive. // TODO: Vast overcomplication and generation of closure garbage. SURELY we should be able to convert this into an externalised, arg-ist form /** Registers a listener operating one leg of a model relay relation, connecting the source and target. Called once or twice from `fluid.connectModelRelay` - * see the comment there for the three cases involved. Note that in its case iii)B) the applier to bind to is not the one attached to `target` but is instead * held in `options.targetApplier`. * @param {Object} target - The target component at the end of the relay. * @param {String[]} targetSegs - String segments representing the path in the target where outgoing changes are to be fired * @param {Component|null} source - The source component from where changes will be listened to. May be null if the change source is a relay document. * @param {String[]} sourceSegs - String segments representing the path in the source component's model at which changes will be listened to * @param {String} linkId - The unique id of this relay arc. This will be used as a key within the active transaction record to look up dynamic information about * activation of the link within that transaction (currently just an activation count) * @param {Function|null} transducer - A function which will be invoked when a change is to be relayed. This is one of the adapters constructed in "makeTransformPackage" * and is set in all cases other than iii)B) (collecting changes to contextualised relay). Note that this will have a member `cond` as returned from * `fluid.model.parseRelayCondition` encoding the condition whereby changes should be excluded from the transaction. The rule encoded by the condition * will be applied by the function within `transducer`. * @param {Object} options - * transactional {Boolean} `true` in case iii) - although this only represents `half-transactions`, `false` in others since these are resolved immediately with no granularity * targetApplier {ChangeApplier} [optional] in case iii)B) holds the applier for the contextualised relay document which outgoing changes should be applied to * sourceApplier {ChangeApplier} [optional] in case ii) holds the applier for the contextualised relay document on which we listen for outgoing changes * @param {Object} npOptions - Namespace and priority options * namespace {String} [optional] The namespace attached to this relay definition * priority {String} [optional] The (unparsed) priority attached to this relay definition */ fluid.registerDirectChangeRelay = function (target, targetSegs, source, sourceSegs, linkId, transducer, options, npOptions) { var targetApplier = options.targetApplier || target.applier; // first branch implies the target is a relay document var sourceApplier = options.sourceApplier || source.applier; // first branch implies the source is a relay document - listener will be transactional var applierId = targetApplier.applierId; targetSegs = fluid.makeArray(targetSegs); sourceSegs = fluid.makeArray(sourceSegs); // take copies since originals will be trashed var sourceListener = function (newValue, oldValue, path, changeRequest, trans, applier) { var transId = trans.id; var transRec = fluid.getModelTransactionRec(target, transId); if (applier && trans && !transRec[applier.applierId]) { // don't trash existing record which may contain "options" (FLUID-5397) transRec[applier.applierId] = {transaction: trans}; // enlist the outer user's original transaction } var existing = transRec[applierId]; transRec[linkId] = transRec[linkId] || 0; // Crude "oscillation prevention" system limits each link to maximum of 2 operations per cycle (presumably in opposite directions) var relay = true; // TODO: See FLUID-5303 - we currently disable this check entirely to solve FLUID-5293 - perhaps we might remove link counts entirely Eif (relay) { ++transRec[linkId]; if (transRec[linkId] > fluid.relayRecursionBailout) { fluid.fail("Error in model relay specification at component ", target, " - operated more than " + fluid.relayRecursionBailout + " relays without model value settling - current model contents are ", trans.newHolder.model); } if (!existing) { existing = fluid.registerRelayTransaction(transRec, targetApplier, transId, options, npOptions); } if (transducer && !options.targetApplier) { // TODO: This is just for safety but is still unusual and now abused. The transducer doesn't need the "newValue" since all the transform information // has been baked into the transform document itself. However, we now rely on this special signalling value to make sure we regenerate transforms in // the "forwardAdapter" transducer(existing.transaction, options.sourceApplier ? undefined : newValue, sourceSegs, targetSegs, changeRequest); } else { if (changeRequest && changeRequest.type === "DELETE") { existing.transaction.fireChangeRequest({type: "DELETE", segs: targetSegs}); } if (newValue !== undefined) { existing.transaction.fireChangeRequest({type: "ADD", segs: targetSegs, value: newValue}); } } } }; var spec = sourceApplier.modelChanged.addListener({ isRelay: true, cond: transducer && transducer.cond, targetId: target.id, // these two fields for debuggability targetApplierId: targetApplier.id, segs: sourceSegs, transactional: options.transactional }, sourceListener); if (fluid.passLogLevel(fluid.logLevel.TRACE)) { fluid.log(fluid.logLevel.TRACE, "Adding relay listener with listenerId " + spec.listenerId + " to source applier with id " + sourceApplier.applierId + " from target applier with id " + applierId + " for target component with id " + target.id); } Eif (source) { // TODO - we actually may require to register on THREE sources in the case modelRelay is attached to a // component which is neither source nor target. Note there will be problems if source, say, is destroyed and recreated, // and holder is not - relay will in that case be lost. Need to integrate relay expressions with IoCSS. fluid.recordChangeListener(source, sourceApplier, sourceListener, spec.listenerId); if (target !== source) { fluid.recordChangeListener(target, sourceApplier, sourceListener, spec.listenerId); } } }; /** Connect a model relay relation between model material. This is called in three scenarios: * i) from `fluid.parseModelRelay` when parsing an uncontextualised model relay (one with a static transform document), to * directly connect the source and target of the relay * ii) from `fluid.parseModelRelay` when parsing a contextualised model relay (one whose transform document depends on other model * material), to connect updates emitted from the transform document's applier onto the relay ends (both source and target) * iii) from `fluid.parseImplicitRelay` when parsing model references found within contextualised model relay to bind changes emitted * from the target of the reference onto the transform document's applier. These may apply directly to another component's model (in its case * A) or apply to a relay document (in its case B) * * This function will make one or two calls to `fluid.registerDirectChangeRelay` in order to set up each leg of any required relay. * Note that in case iii)B) the component referred to as our argument `target` is actually the "source" of the changes (that is, the one encountered * while traversing the transform document), and our argument `source` is the component holding the transform, and so * the call to `fluid.registerDirectChangeRelay` will have `source` and `target` reversed (`fluid.registerDirectChangeRelay` will bind to the `targetApplier` * in the options rather than source's applier). * @param {Component} source - The component holding the material giving rise to the relay, or the one referred to by the `source` member * of the configuration in case ii), if there is one * @param {Array|null} sourceSegs - An array of parsed string segments of the `source` relay reference in case i), or the offset into the transform * document of the reference component in case iii), otherwise `null` (case ii)) * @param {Component} target - The component holding the model relay `target` in cases i) and ii), or the component at the other end of * the model reference in case iii) (in this case in fact a "source" for the changes. * @param {Array} targetSegs - An array of parsed string segments of the `target` reference in cases i) and ii), or of the model reference in * case iii) * @param {Object} options - A structure describing the relay, allowing discrimination of the various cases above. This is derived from the return from * `fluid.makeTransformPackage` but will have some members filtered in different cases. This contains members: * update {Function} A function to be called at the end of a "half-transaction" when all pending updates have been applied to the document's applier. * This discriminates case iii) * targetApplier {ChangeApplier} The ChangeApplier for the relay document, in case iii)B) * forwardApplier (ChangeApplier} The ChangeApplier for the relay document, in cases ii) and iii)B) (only used in latter case) * forwardAdapter {Adapter} A function accepting (transaction, newValue) to pass through the forward leg of the relay. Contains a member `cond` holding the parsed relay condition. * backwardAdapter {Adapter} A function accepting (transaction, newValue) to pass through the backward leg of the relay. Contains a member `cond` holding the parsed relay condition. * namespace {String} Namespace for any relay definition * priority {String} Priority for any relay definition or synthetic "first" for iii)A) */ fluid.connectModelRelay = function (source, sourceSegs, target, targetSegs, options) { var linkId = fluid.allocateGuid(); function enlistComponent(component) { var enlist = fluid.enlistModelComponent(component); if (enlist.complete) { var shadow = fluid.shadowForComponent(component); if (shadow.modelComplete) { enlist.completeOnInit = true; } } } enlistComponent(target); enlistComponent(source); // role of "source" and "target" are swapped in case iii)B) var npOptions = fluid.filterKeys(options, ["namespace", "priority"]); if (options.update) { // it is a call for a relay document - ii) or iii)B) if (options.targetApplier) { // case iii)B) // We are in the middle of parsing a contextualised relay, and this call has arrived via its parseImplicitRelay. // register changes from the target model onto changes to the model relay document fluid.registerDirectChangeRelay(source, sourceSegs, target, targetSegs, linkId, null, { transactional: false, targetApplier: options.targetApplier, update: options.update }, npOptions); } else { // case ii), contextualised relay overall output // Rather than bind source-source, instead register the "half-transactional" listener which binds changes // from the relay document itself onto the target fluid.registerDirectChangeRelay(target, targetSegs, source, [], linkId + "-transform", options.forwardAdapter, {transactional: true, sourceApplier: options.forwardApplier}, npOptions); } } else { // case i) or iii)A): more efficient, old-fashioned branch where relay is uncontextualised fluid.registerDirectChangeRelay(target, targetSegs, source, sourceSegs, linkId, options.forwardAdapter, {transactional: false}, npOptions); fluid.registerDirectChangeRelay(source, sourceSegs, target, targetSegs, linkId, options.backwardAdapter, {transactional: false}, npOptions); } }; fluid.parseSourceExclusionSpec = function (targetSpec, sourceSpec) { targetSpec.excludeSource = fluid.arrayToHash(fluid.makeArray(sourceSpec.excludeSource || (sourceSpec.includeSource ? "*" : undefined))); targetSpec.includeSource = fluid.arrayToHash(fluid.makeArray(sourceSpec.includeSource)); return targetSpec; }; /** Determines whether the supplied transaction should have changes not propagated into it as a result of being excluded by a * condition specification. * @param {Transaction} transaction - A local ChangeApplier transaction, with member `fullSources` holding all currently active sources * @param {ConditionSpec} spec - A parsed relay condition specification, as returned from `fluid.model.parseRelayCondition`. * @return {Boolean} `true` if changes should be excluded from the supplied transaction according to the supplied specification */ fluid.isExcludedChangeSource = function (transaction, spec) { if (!spec || !spec.excludeSource) { // mergeModelListeners initModelEvent fabricates a fake spec that bypasses processing return false; } var excluded = spec.excludeSource["*"]; for (var source in transaction.fullSources) { if (spec.excludeSource[source]) { excluded = true; } if (spec.includeSource[source]) { excluded = false; } } return excluded; }; fluid.model.guardedAdapter = function (transaction, cond, func, args) { if (!fluid.isExcludedChangeSource(transaction, cond) && func !== fluid.model.transform.uninvertibleTransform) { func.apply(null, args); } }; // TODO: This rather crummy function is the only site with a hard use of "path" as String fluid.transformToAdapter = function (transform, targetPath) { var basedTransform = {}; basedTransform[targetPath] = transform; // TODO: Faulty with respect to escaping rules return function (trans, newValue, sourceSegs, targetSegs, changeRequest) { if (changeRequest && changeRequest.type === "DELETE") { trans.fireChangeRequest({type: "DELETE", path: targetPath}); // avoid mouse droppings in target document for FLUID-5585 } // TODO: More efficient model that can only run invalidated portion of transform (need to access changeMap of source transaction) fluid.model.transformWithRules(newValue, basedTransform, {finalApplier: trans}); }; }; // TODO: sourcePath and targetPath should really be converted to segs to avoid excess work in parseValidModelReference fluid.makeTransformPackage = function (componentThat, transform, sourcePath, targetPath, forwardCond, backwardCond, namespace, priority) { var that = { forwardHolder: {model: transform}, backwardHolder: {model: null} }; that.generateAdapters = function (trans) { // can't commit "half-transaction" or events will fire - violate encapsulation in this way that.forwardAdapterImpl = fluid.transformToAdapter(trans ? trans.newHolder.model : that.forwardHolder.model, targetPath); if (sourcePath !== null) { var inverted = fluid.model.transform.invertConfiguration(transform); if (inverted !== fluid.model.transform.uninvertibleTransform) { that.backwardHolder.model = inverted; that.backwardAdapterImpl = fluid.transformToAdapter(that.backwardHolder.model, sourcePath); } else { that.backwardAdapterImpl = inverted; } } }; that.forwardAdapter = function (transaction, newValue) { // create a stable function reference for this possibly changing adapter if (newValue === undefined) { that.generateAdapters(); // TODO: Quick fix for incorrect scheduling of invalidation/transducing // "it so happens" that fluid.registerDirectChangeRelay invokes us with empty newValue in the case of invalidation -> transduction } fluid.model.guardedAdapter(transaction, forwardCond, that.forwardAdapterImpl, arguments); }; that.forwardAdapter.cond = forwardCond; // Used when parsing graph in init transaction // fired from fluid.model.updateRelays via invalidator event that.runTransform = function (trans) { trans.commit(); // this will reach the special "half-transactional listener" registered in fluid.connectModelRelay, // branch with options.targetApplier - by committing the transaction, we update the relay document in bulk and then cause // it to execute (via "transducer") trans.reset(); }; that.forwardApplier = fluid.makeHolderChangeApplier(that.forwardHolder); that.forwardApplier.isRelayApplier = true; // special annotation so these can be discovered in the transaction record that.invalidator = fluid.makeEventFirer({name: "Invalidator for model relay with applier " + that.forwardApplier.applierId}); if (sourcePath !== null) { // TODO: backwardApplier is unused that.backwardApplier = fluid.makeHolderChangeApplier(that.backwardHolder); that.backwardAdapter = function (transaction) { fluid.model.guardedAdapter(transaction, backwardCond, that.backwardAdapterImpl, arguments); }; that.backwardAdapter.cond = backwardCond; } that.update = that.invalidator.fire; // necessary so that both routes to fluid.connectModelRelay from here hit the first branch var implicitOptions = { targetApplier: that.forwardApplier, // this special field identifies us to fluid.connectModelRelay update: that.update, namespace: namespace, priority: priority, refCount: 0 }; that.forwardHolder.model = fluid.parseImplicitRelay(componentThat, transform, [], implicitOptions); that.refCount = implicitOptions.refCount; that.namespace = namespace; that.priority = priority; that.generateAdapters(); that.invalidator.addListener(that.generateAdapters); that.invalidator.addListener(that.runTransform); return that; }; fluid.singleTransformToFull = function (singleTransform) { var withPath = $.extend(true, {inputPath: ""}, singleTransform); return { "": { transform: withPath } }; }; // Convert old-style "relay conditions" to source includes/excludes as used in model listeners fluid.model.relayConditions = { initOnly: {includeSource: "init"}, liveOnly: {excludeSource: "init"}, never: {includeSource: []}, always: {} }; /** Parse a relay condition specification, e.g. of the form `{includeSource: "init"}` or `never` into a hash representation * suitable for rapid querying. * @param {String|Object} condition - A relay condition specification, appearing in the section `forward` or `backward` of a * relay definition * @return {RelayCondition} The parsed condition, holding members `includeSource` and `excludeSource` each with a hash to `true` * of referenced sources */ fluid.model.parseRelayCondition = function (condition) { Iif (condition === "initOnly") { fluid.log(fluid.logLevel.WARN, "The relay condition \"initOnly\" is deprecated: Please use the form 'includeSource: \"init\"' instead"); } else if (condition === "liveOnly") { fluid.log(fluid.logLevel.WARN, "The relay condition \"liveOnly\" is deprecated: Please use the form 'excludeSource: \"init\"' instead"); } var exclusionRec; if (!condition) { exclusionRec = {}; } else if (typeof(condition) === "string") { exclusionRec = fluid.model.relayConditions[condition]; Iif (!exclusionRec) { fluid.fail("Unrecognised model relay condition string \"" + condition + "\": the supported values are \"never\" or a record with members \"includeSource\" and/or \"excludeSource\""); } } else { exclusionRec = condition; } return fluid.parseSourceExclusionSpec({}, exclusionRec); }; /** Parse a single model relay record as appearing nested within the `modelRelay` block in a model component's * options. By various calls to `fluid.connectModelRelay` this will set up the structure operating the live * relay during the component#s lifetime. * @param {Component} that - The component holding the record, currently instantiating * @param {Object} mrrec - The model relay record. This must contain either a member `singleTransform` or `transform` and may also contain * members `namespace`, `path`, `priority`, `forward` and `backward` * @param {String} key - */ fluid.parseModelRelay = function (that, mrrec, key) { var parsedSource = mrrec.source !== undefined ? fluid.parseValidModelReference(that, "modelRelay record member \"source\"", mrrec.source) : {path: null, modelSegs: null}; var parsedTarget = fluid.parseValidModelReference(that, "modelRelay record member \"target\"", mrrec.target); var namespace = mrrec.namespace || key; var transform = mrrec.singleTransform ? fluid.singleTransformToFull(mrrec.singleTransform) : mrrec.transform; Iif (!transform) { fluid.fail("Cannot parse modelRelay record without element \"singleTransform\" or \"transform\":", mrrec); } var forwardCond = fluid.model.parseRelayCondition(mrrec.forward), backwardCond = fluid.model.parseRelayCondition(mrrec.backward); var transformPackage = fluid.makeTransformPackage(that, transform, parsedSource.path, parsedTarget.path, forwardCond, backwardCond, namespace, mrrec.priority); if (transformPackage.refCount === 0) { // There were no implicit relay elements found in the relay document - it can be relayed directly // Case i): Bind changes emitted from the relay ends to each other, synchronously fluid.connectModelRelay(parsedSource.that || that, parsedSource.modelSegs, parsedTarget.that, parsedTarget.modelSegs, // Primarily, here, we want to get rid of "update" which is what signals to connectModelRelay that this is a invalidatable relay fluid.filterKeys(transformPackage, ["forwardAdapter", "backwardAdapter", "namespace", "priority"])); } else { if (parsedSource.modelSegs) { fluid.fail("Error in model relay definition: If a relay transform has a model dependency, you can not specify a \"source\" entry - please instead enter this as \"input\" in the transform specification. Definition was ", mrrec, " for component ", that); } // Case ii): Binds changes emitted from the relay document itself onto the relay ends (using the "half-transactional system") fluid.connectModelRelay(that, null, parsedTarget.that, parsedTarget.modelSegs, transformPackage); } }; /** Traverses a model document written within a component's options, parsing any IoC references looking for * i) references to general material, which will be fetched and interpolated now, and ii) "implicit relay" references to the * model areas of other components, which will be used to set up live synchronisation between the area in this component where * they appear and their target, as well as setting up initial synchronisation to compute the initial contents. * This is called in two situations: A) parsing the `model` configuration option for a model component, and B) parsing the * `transform` member (perhaps derived from `singleTransform`) of a `modelRelay` block for a model component. It calls itself * recursively as it progresses through the model document material with updated `segs` * @param {Component} that - The component holding the model document * @param {Any} modelRec - The model document specification to be parsed * @param {String[]} segs - The array of string path segments from the root of the entire model document to the point of current parsing * @param {Object} options - Configuration options (mutable) governing this parse. This is primarily used to hand as the 5th argument to * `fluid.connectModelRelay` for any model references found, and contains members * refCount {Integer} An count incremented for every call to `fluid.connectModelRelay` setting up a synchronizing relay for every * reference to model material encountered * priority {String} The unparsed priority member attached to this record, or `first` for a parse of `model` (case A) * namespace {String} [optional] A namespace attached to this transform, if we are parsing a transform * targetApplier {ChangeApplier} [optional] The ChangeApplier for this transform document, if it is a transform, empty otherwise * update {Function} [optional] A function to be called on conclusion of a "half-transaction" where all currently pending updates have been applied * to this transform document. This function will update/regenerate the relay transform functions used to relay changes between the transform * ends based on the updated document. * @return {Any} - The resulting model value. */ fluid.parseImplicitRelay = function (that, modelRec, segs, options) { var value; if (fluid.isIoCReference(modelRec)) { var parsed = fluid.parseValidModelReference(that, "model reference from model (implicit relay)", modelRec, true); if (parsed.nonModel) { value = fluid.getForComponent(parsed.that, parsed.segs); } else { ++options.refCount; // This count is used from within fluid.makeTransformPackage fluid.connectModelRelay(that, segs, parsed.that, parsed.modelSegs, options); } } else if (fluid.isPrimitive(modelRec) || !fluid.isPlainObject(modelRec)) { value = modelRec; } else if (modelRec.expander && fluid.isPlainObject(modelRec.expander)) { value = fluid.expandOptions(modelRec, that); } else { value = fluid.freshContainer(modelRec); fluid.each(modelRec, function (innerValue, key) { segs.push(key); var innerTrans = fluid.parseImplicitRelay(that, innerValue, segs, options); if (innerTrans !== undefined) { value[key] = innerTrans; } segs.pop(); }); } return value; }; // Conclude the transaction by firing to all external listeners in priority order fluid.model.notifyExternal = function (transRec) { var allChanges = transRec ? fluid.values(transRec.externalChanges) : []; fluid.sortByPriority(allChanges); for (var i = 0; i < allChanges.length; ++i) { var change = allChanges[i]; var targetApplier = change.args[5]; // NOTE: This argument gets here via fluid.model.storeExternalChange from fluid.notifyModelChanges if (!targetApplier.destroyed) { // 3rd point of guarding for FLUID-5592 change.listener.apply(null, change.args); } } fluid.clearLinkCounts(transRec, true); // "options" structures for relayCount are aliased }; fluid.model.commitRelays = function (instantiator, transactionId) { var transRec = instantiator.modelTransactions[transactionId]; fluid.each(transRec, function (transEl) { // EXPLAIN: This must commit ALL current transactions, not just those for relays - why? if (transEl.transaction) { // some entries are links transEl.transaction.commit("relay"); transEl.transaction.reset(); } }); }; // Listens to all invalidation to relays, and reruns/applies them if they have been invalidated fluid.model.updateRelays = function (instantiator, transactionId) { var transRec = instantiator.modelTransactions[transactionId]; var updates = 0; fluid.sortByPriority(transRec.relays); fluid.each(transRec.relays, function (transEl) { // TODO: We have a bit of a problem here in that we only process updatable relays by priority - plain relays get to act non-transactionally if (transEl.transaction.changeRecord.changes > 0 && transEl.relayCount < 2 && transEl.options.update) { transEl.relayCount++; fluid.clearLinkCounts(transRec); transEl.options.update(transEl.transaction, transRec); ++updates; } }); return updates; }; fluid.establishModelRelay = function (that, optionsModel, optionsML, optionsMR, applier) { var shadow = fluid.shadowForComponent(that); Eif (!shadow.modelRelayEstablished) { shadow.modelRelayEstablished = true; } else { fluid.fail("FLUID-5887 failure: Model relay initialised twice on component", that); } fluid.mergeModelListeners(that, optionsML); var enlist = fluid.enlistModelComponent(that); fluid.each(optionsMR, function (mrrec, key) { for (var i = 0; i < mrrec.length; ++i) { fluid.parseModelRelay(that, mrrec[i], key); } }); // Note: this particular instance of "refCount" is disused. We only use the count made within fluid.makeTransformPackge var initModels = fluid.transform(optionsModel, function (modelRec) { return fluid.parseImplicitRelay(that, modelRec, [], {refCount: 0, priority: "first"}); }); enlist.initModels = initModels; var instantiator = fluid.getInstantiator(that); function updateRelays(transaction) { while (fluid.model.updateRelays(instantiator, transaction.id) > 0) {} // eslint-disable-line no-empty } function commitRelays(transaction, applier, code) { if (code !== "relay") { // don't commit relays if this commit is already a relay commit fluid.model.commitRelays(instantiator, transaction.id); } } function concludeTransaction(transaction, applier, code) { if (code !== "relay") { fluid.model.notifyExternal(instantiator.modelTransactions[transaction.id]); delete instantiator.modelTransactions[transaction.id]; } } applier.preCommit.addListener(updateRelays); applier.preCommit.addListener(commitRelays); applier.postCommit.addListener(concludeTransaction); return null; }; // supported, PUBLIC API grade fluid.defaults("fluid.modelComponent", { gradeNames: ["fluid.component"], changeApplierOptions: { relayStyle: true, cullUnchanged: true }, members: { model: "@expand:fluid.initRelayModel({that}, {that}.modelRelay)", applier: "@expand:fluid.makeHolderChangeApplier({that}, {that}.options.changeApplierOptions)", modelRelay: "@expand:fluid.establishModelRelay({that}, {that}.options.model, {that}.options.modelListeners, {that}.options.modelRelay, {that}.applier)" }, mergePolicy: { model: { noexpand: true, func: fluid.arrayConcatPolicy // TODO: bug here in case a model consists of an array }, modelListeners: fluid.makeMergeListenersPolicy(fluid.arrayConcatPolicy), modelRelay: fluid.makeMergeListenersPolicy(fluid.arrayConcatPolicy, true) } }); fluid.modelChangedToChange = function (args) { return { value: args[0], oldValue: args[1], path: args[2], transaction: args[4] }; }; // Note - has only one call, from resolveModelListener fluid.event.invokeListener = function (listener, args, localRecord, mergeRecord) { if (typeof(listener) === "string") { listener = fluid.event.resolveListener(listener); // just resolves globals } return listener.apply(null, args, localRecord, mergeRecord); // can be "false apply" that requires extra context for expansion }; fluid.resolveModelListener = function (that, record) { var togo = function () { Iif (fluid.isDestroyed(that)) { // first guarding point to resolve FLUID-5592 return; } var change = fluid.modelChangedToChange(arguments); var args = arguments; var localRecord = {change: change, "arguments": args}; var mergeRecord = {source: Object.keys(change.transaction.sources)}; // cascade for FLUID-5490 if (record.args) { args = fluid.expandOptions(record.args, that, {}, localRecord); } fluid.event.invokeListener(record.listener, fluid.makeArray(args), localRecord, mergeRecord); }; fluid.event.impersonateListener(record.listener, togo); return togo; }; fluid.registerModelListeners = function (that, record, paths, namespace) { var func = fluid.resolveModelListener(that, record); fluid.each(record.byTarget, function (parsedArray) { var parsed = parsedArray[0]; // that, applier are common across all these elements var spec = { listener: func, // for initModelEvent listenerId: fluid.allocateGuid(), // external declarative listeners may often share listener handle, identify here segsArray: fluid.getMembers(parsedArray, "modelSegs"), pathArray: fluid.getMembers(parsedArray, "path"), includeSource: record.includeSource, excludeSource: record.excludeSource, priority: fluid.expandOptions(record.priority, that), transactional: true }; // update "spec" so that we parse priority information just once spec = parsed.applier.modelChanged.addListener(spec, func, namespace, record.softNamespace); fluid.recordChangeListener(that, parsed.applier, func, spec.listenerId); function initModelEvent() { if (fluid.isModelComplete(parsed.that)) { var trans = parsed.applier.initiate(null, "init"); fluid.initModelEvent(that, parsed.applier, trans, [spec]); trans.commit(); } } if (that !== parsed.that && !fluid.isModelComplete(that)) { // TODO: Use FLUID-4883 "latched events" when available // Don't confuse the end user by firing their listener before the component is constructed // TODO: Better detection than this is requred - we assume that the target component will not be discovered as part // of the initial transaction wave, but if it is, it will get a double notification - we really need "wave of explosions" // since we are currently too early in initialisation of THIS component in order to tell if other will be found // independently. var onCreate = fluid.getForComponent(that, ["events", "onCreate"]); onCreate.addListener(initModelEvent); } }); }; fluid.mergeModelListeners = function (that, listeners) { fluid.each(listeners, function (value, key) { Iif (typeof(value) === "string") { value = { funcName: value }; } // Bypass fluid.event.dispatchListener by means of "standard = false" and enter our custom workflow including expanding "change": var records = fluid.event.resolveListenerRecord(value, that, "modelListeners", null, false).records; fluid.each(records, function (record) { // Aggregate model listeners into groups referring to the same component target. // We do this so that a single entry will appear in its modelListeners so that they may // be notified just once per transaction, and also displaced by namespace record.byTarget = {}; var paths = fluid.makeArray(record.path === undefined ? key : record.path); fluid.each(paths, function (path) { var parsed = fluid.parseValidModelReference(that, "modelListeners entry", path); fluid.pushArray(record.byTarget, parsed.that.id, parsed); }); var namespace = (record.namespace && !record.softNamespace ? record.namespace : null) || (record.path !== undefined ? key : null); fluid.registerModelListeners(that, record, paths, namespace); }); }); }; /** CHANGE APPLIER **/ /* Dispatches a list of changes to the supplied applier */ fluid.fireChanges = function (applier, changes) { for (var i = 0; i < changes.length; ++i) { applier.fireChangeRequest(changes[i]); } }; fluid.model.isChangedPath = function (changeMap, segs) { for (var i = 0; i <= segs.length; ++i) { if (typeof(changeMap) === "string") { return true; } if (i < segs.length && changeMap) { changeMap = changeMap[segs[i]]; } } return false; }; fluid.model.setChangedPath = function (options, segs, value) { var notePath = function (record) { segs.unshift(record); fluid.model.setSimple(options, segs, value); segs.shift(); }; if (!fluid.model.isChangedPath(options.changeMap, segs)) { ++options.changes; notePath("changeMap"); } if (!fluid.model.isChangedPath(options.deltaMap, segs)) { ++options.deltas; notePath("deltaMap"); } }; fluid.model.fetchChangeChildren = function (target, i, segs, source, options) { fluid.each(source, function (value, key) { segs[i] = key; fluid.model.applyChangeStrategy(target, key, i, segs, value, options); segs.length = i; }); }; // Called with two primitives which are compared for equality. This takes account of "floating point slop" to avoid // continuing to propagate inverted values as changes // TODO: replace with a pluggable implementation fluid.model.isSameValue = function (a, b) { if (typeof(a) !== "number" || typeof(b) !== "number") { return a === b; } else { // Don't use isNaN because of https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/isNaN#Confusing_special-case_behavior if (a === b || a !== a && b !== b) { // Either the same concrete number or both NaN return true; } else { var relError = Math.abs((a - b) / b); return relError < 1e-12; // 64-bit floats have approx 16 digits accuracy, this should deal with most reasonable transforms } } }; fluid.model.applyChangeStrategy = function (target, name, i, segs, source, options) { var targetSlot = target[name]; var sourceCode = fluid.typeCode(source); var targetCode = fluid.typeCode(targetSlot); var changedValue = fluid.NO_VALUE; if (sourceCode === "primitive") { if (!fluid.model.isSameValue(targetSlot, source)) { changedValue = source; ++options.unchanged; } } else if (targetCode !== sourceCode || sourceCode === "array" && source.length !== targetSlot.length) { // RH is not primitive - array or object and mismatching or any array rewrite changedValue = fluid.freshContainer(source); } if (changedValue !== fluid.NO_VALUE) { target[name] = changedValue; if (options.changeMap) { fluid.model.setChangedPath(options, segs, options.inverse ? "DELETE" : "ADD"); } } if (sourceCode !== "primitive") { fluid.model.fetchChangeChildren(target[name], i + 1, segs, source, options); } }; fluid.model.stepTargetAccess = function (target, type, segs, startpos, endpos, options) { for (var i = startpos; i < endpos; ++i) { if (!target) { continue; } var oldTrunk = target[segs[i]]; target = fluid.model.traverseWithStrategy(target, segs, i, options[type === "ADD" ? "resolverSetConfig" : "resolverGetConfig"], segs.length - i - 1); if (oldTrunk !== target && options.changeMap) { fluid.model.setChangedPath(options, segs.slice(0, i + 1), "ADD"); } } return {root: target, last: segs[endpos]}; }; fluid.model.defaultAccessorConfig = function (options) { options = options || {}; options.resolverSetConfig = options.resolverSetConfig || fluid.model.escapedSetConfig; options.resolverGetConfig = options.resolverGetConfig || fluid.model.escapedGetConfig; return options; }; // Changes: "MERGE" action abolished // ADD/DELETE at root can be destructive // changes tracked in optional final argument holding "changeMap: {}, changes: 0, unchanged: 0" fluid.model.applyHolderChangeRequest = function (holder, request, options) { options = fluid.model.defaultAccessorConfig(options); options.deltaMap = options.changeMap ? {} : null; options.deltas = 0; var length = request.segs.length; var pen, atRoot = length === 0; if (atRoot) { pen = {root: holder, last: "model"}; } else { if (!holder.model) { holder.model = {}; fluid.model.setChangedPath(options, [], options.inverse ? "DELETE" : "ADD"); } pen = fluid.model.stepTargetAccess(holder.model, request.type, request.segs, 0, length - 1, options); } if (request.type === "ADD") { var value = request.value; var segs = fluid.makeArray(request.segs); fluid.model.applyChangeStrategy(pen.root, pen.last, length - 1, segs, value, options, atRoot); } else Eif (request.type === "DELETE") { if (pen.root && pen.root[pen.last] !== undefined) { delete pen.root[pen.last]; Eif (options.changeMap) { fluid.model.setChangedPath(options, request.segs, "DELETE"); } } } else { fluid.fail("Unrecognised change type of " + request.type); } return options.deltas ? options.deltaMap : null; }; /** Compare two models for equality using a deep algorithm. It is assumed that both models are JSON-equivalent and do * not contain circular links. * @param modela The first model to be compared * @param modelb The second model to be compared * @param {Object} options - If supplied, will receive a map and summary of the change content between the objects. Structure is: * changeMap: {Object/String} An isomorphic map of the object structures to values "ADD" or "DELETE" indicating * that values have been added/removed at that location. Note that in the case the object structure differs at the root, <code>changeMap</code> will hold * the plain String value "ADD" or "DELETE" * changes: {Integer} Counts the number of changes between the objects - The two objects are identical iff <code>changes === 0</code>. * unchanged: {Integer} Counts the number of leaf (primitive) values at which the two objects are identical. Note that the current implementation will * double-count, this summary should be considered indicative rather than precise. * @return <code>true</code> if the models are identical */ // TODO: This algorithm is quite inefficient in that both models will be copied once each // supported, PUBLIC API function fluid.model.diff = function (modela, modelb, options) { options = options || {changes: 0, unchanged: 0, changeMap: {}}; // current algorithm can't avoid the expense of changeMap var typea = fluid.typeCode(modela); var typeb = fluid.typeCode(modelb); var togo; if (typea === "primitive" && typeb === "primitive") { togo = fluid.model.isSameValue(modela, modelb); } else if (typea === "primitive" ^ typeb === "primitive") { togo = false; } else { // Apply both forward and reverse changes - if no changes either way, models are identical // "ADD" reported in the reverse direction must be accounted as a "DELETE" var holdera = { model: fluid.copy(modela) }; fluid.model.applyHolderChangeRequest(holdera, {value: modelb, segs: [], type: "ADD"}, options); var holderb = { model: fluid.copy(modelb) }; options.inverse = true; fluid.model.applyHolderChangeRequest(holderb, {value: modela, segs: [], type: "ADD"}, options); togo = options.changes === 0; } if (togo === false && options.changes === 0) { // catch all primitive cases options.changes = 1; options.changeMap = modelb === undefined ? "DELETE" : "ADD"; } else if (togo === true && options.unchanged === 0) { options.unchanged = 1; } return togo; }; fluid.outputMatches = function (matches, outSegs, root) { fluid.each(root, function (value, key) { matches.push(outSegs.concat(key)); }); }; // Here we only support for now very simple expressions which have at most one // wildcard which must appear in the final segment fluid.matchChanges = function (changeMap, specSegs, newHolder, oldHolder) { var newRoot = newHolder.model; var oldRoot = oldHolder.model; var map = changeMap; var outSegs = ["model"]; var wildcard = false; var togo = []; for (var i = 0; i < specSegs.length; ++i) { var seg = specSegs[i]; if (seg === "*") { Eif (i === specSegs.length - 1) { wildcard = true; } else { fluid.fail("Wildcard specification in modelChanged listener is only supported for the final path segment: " + specSegs.join(".")); } } else { outSegs.push(seg); map = fluid.isPrimitive(map) ? map : map[seg]; newRoot = newRoot ? newRoot[seg] : undefined; oldRoot = oldRoot ? oldRoot[seg] : undefined; } } if (map) { if (wildcard) { if (map === "DELETE") { fluid.outputMatches(togo, outSegs, oldRoot); } else if (map === "ADD") { fluid.outputMatches(togo, outSegs, newRoot); } else { fluid.outputMatches(togo, outSegs, map); } } else { togo.push(outSegs); } } return togo; }; fluid.storeExternalChange = function (transRec, applier, invalidPath, spec, args) { var pathString = applier.composeSegments.apply(null, invalidPath); var keySegs = [applier.holder.id, spec.listenerId, (spec.wildcard ? pathString : "")]; var keyString = keySegs.join("|"); // TODO: We think we probably have a bug in that notifications destined for end of transaction are actually continuously emitted during the transaction // These are unbottled in fluid.concludeTransaction transRec.externalChanges[keyString] = {listener: spec.listener, namespace: spec.namespace, priority: spec.priority, args: args}; }; fluid.notifyModelChanges = function (listeners, changeMap, newHolder, oldHolder, changeRequest, transaction, applier, that) { if (!listeners) { return; } var transRec = transaction && fluid.getModelTransactionRec(that, transaction.id); for (var i = 0; i < listeners.length; ++i) { var spec = listeners[i]; var multiplePaths = spec.segsArray.length > 1; // does this spec listen on multiple paths? If so, don't rebase arguments and just report once per transaction for (var j = 0; j < spec.segsArray.length; ++j) { var invalidPaths = fluid.matchChanges(changeMap, spec.segsArray[j], newHolder, oldHolder); // We only have multiple invalidPaths here if there is a wildcard for (var k = 0; k < invalidPaths.length; ++k) { Iif (applier.destroyed) { // 2nd guarding point for FLUID-5592 return; } var invalidPath = invalidPaths[k]; spec.listener = fluid.event.resolveListener(spec.listener); var args = [multiplePaths ? newHolder.model : fluid.model.getSimple(newHolder, invalidPath), multiplePaths ? oldHolder.model : fluid.model.getSimple(oldHolder, invalidPath), multiplePaths ? [] : invalidPath.slice(1), changeRequest, transaction, applier]; // FLUID-5489: Do not notify of null changes which were reported as a result of invalidating a higher path // TODO: We can improve greatly on efficiency by i) reporting a special code from fluid.matchChanges which signals the difference between invalidating a higher and lower path, // ii) improving fluid.model.diff to create fewer intermediate structures and no copies // TODO: The relay invalidation system is broken and must always be notified (branch 1) - since our old/new value detection is based on the wrong (global) timepoints in the transaction here, // rather than the "last received model" by the holder of the transform document if (!spec.isRelay) { var isNull = fluid.model.diff(args[0], args[1]); if (isNull) { continue; } var sourceExcluded = fluid.isExcludedChangeSource(transaction, spec); if (sourceExcluded) { continue; } } if (transRec && !spec.isRelay && spec.transactional) { // bottle up genuine external changes so we can sort and dedupe them later fluid.storeExternalChange(transRec, applier, invalidPath, spec, args); } else { spec.listener.apply(null, args); } } } } }; fluid.bindELMethods = function (applier) { applier.parseEL = function (EL) { return fluid.model.pathToSegments(EL, applier.options.resolverSetConfig); }; applier.composeSegments = function () { return applier.options.resolverSetConfig.parser.compose.apply(null, arguments); }; }; fluid.initModelEvent = function (that, applier, trans, listeners) { fluid.notifyModelChanges(listeners, "ADD", trans.oldHolder, fluid.emptyHolder, null, trans, applier, that); }; // A standard "empty model" for the purposes of comparing initial state during the primordial transaction fluid.emptyHolder = fluid.freezeRecursive({ model: undefined }); fluid.preFireChangeRequest = function (applier, changeRequest) { if (!changeRequest.type) { changeRequest.type = "ADD"; } changeRequest.segs = changeRequest.segs || applier.parseEL(changeRequest.path); }; // Automatically adapts change onto fireChangeRequest fluid.bindRequestChange = function (that) { that.change = function (path, value, type, source) { var changeRequest = { path: path, value: value, type: type, source: source }; that.fireChangeRequest(changeRequest); }; }; // Quick n dirty test to cheaply detect Object versus other JSON types fluid.isObjectSimple = function (totest) { return Object.prototype.toString.call(totest) === "[object Object]"; }; fluid.mergeChangeSources = function (target, globalSources) { Iif (fluid.isObjectSimple(globalSources)) { // TODO: No test for this branch! fluid.extend(target, globalSources); } else { fluid.each(fluid.makeArray(globalSources), function (globalSource) { target[globalSource] = true; }); } }; fluid.ChangeApplier = function () {}; fluid.makeHolderChangeApplier = function (holder, options) { options = fluid.model.defaultAccessorConfig(options); var applierId = fluid.allocateGuid(); var that = new fluid.ChangeApplier(); var name = fluid.isComponent(holder) ? "ChangeApplier for component " + fluid.dumpThat(holder) : "ChangeApplier with id " + applierId; $.extend(that, { applierId: applierId, holder: holder, listeners: fluid.makeEventFirer({name: "Internal change listeners for " + name}), transListeners: fluid.makeEventFirer({name: "External change listeners for " + name}), options: options, modelChanged: {}, preCommit: fluid.makeEventFirer({name: "preCommit event for " + name}), postCommit: fluid.makeEventFirer({name: "postCommit event for " + name}) }); that.destroy = function () { that.preCommit.destroy(); that.postCommit.destroy(); that.destroyed = true; }; that.modelChanged.addListener = function (spec, listener, namespace, softNamespace) { if (typeof(spec) === "string") { spec = { path: spec }; } else { spec = fluid.copy(spec); } spec.listenerId = spec.listenerId || fluid.allocateGuid(); // FLUID-5151: don't use identifyListener since event.addListener will use this as a namespace spec.namespace = namespace; spec.softNamespace = softNamespace; Iif (typeof(listener) === "string") { // The reason for "globalName" is so that listener names can be resolved on first use and not on registration listener = {globalName: listener}; } spec.listener = listener; if (spec.transactional !== false) { spec.transactional = true; } if (!spec.segsArray) { // It's a manual registration if (spec.path !== undefined) { spec.segs = spec.segs || that.parseEL(spec.path); } Eif (!spec.segsArray) { spec.segsArray = [spec.segs]; } } if (!spec.isRelay) { // This acts for listeners registered externally. For relays, the exclusion spec is stored in "cond" fluid.parseSourceExclusionSpec(spec, spec); spec.wildcard = fluid.accumulate(fluid.transform(spec.segsArray, function (segs) { return fluid.contains(segs, "*"); }), fluid.add, 0); Iif (spec.wildcard && spec.segsArray.length > 1) { fluid.fail("Error in model listener specification ", spec, " - you may not supply a wildcard pattern as one of a set of multiple paths to be matched"); } } var firer = that[spec.transactional ? "transListeners" : "listeners"]; firer.addListener(spec); return spec; // return is used in registerModelListeners }; that.modelChanged.removeListener = function (listener) { that.listeners.removeListener(listener); that.transListeners.removeListener(listener); }; that.fireChangeRequest = function (changeRequest) { var ation = that.initiate("local", changeRequest.source); ation.fireChangeRequest(changeRequest); ation.commit(); }; /** * Initiate a fresh transaction on this applier, perhaps coordinated with other transactions sharing the same id across the component tree * Arguments all optional * @param {String} localSource - "local", "relay" or null Local source identifiers only good for transaction's representative on this applier * @param {String|Array|Object} globalSources - Global source identifiers common across this transaction, expressed as a single string, an array of strings, or an object with a "toString" method. * @param {String} transactionId - Global transaction id to enlist with. * @return {Object} - The component initiating the change. */ that.initiate = function (localSource, globalSources, transactionId) { localSource = globalSources === "init" ? null : (localSource || "local"); // supported values for localSource are "local" and "relay" - globalSource of "init" defeats defaulting of localSource to "local" var defeatPost = localSource === "relay"; // defeatPost is supplied for all non-top-level transactions var trans = { instanceId: fluid.allocateGuid(), // for debugging only - the representative of this transction on this applier id: transactionId || fluid.allocateGuid(), // The global transaction id across all appliers - allocate here if this is the starting point changeRecord: { resolverSetConfig: options.resolverSetConfig, // here to act as "options" in applyHolderChangeRequest resolverGetConfig: options.resolverGetConfig }, reset: function () { trans.oldHolder = holder; trans.newHolder = { model: fluid.copy(holder.model) }; trans.changeRecord.changes = 0; trans.changeRecord.unchanged = 0; // just for type consistency - we don't use these values in the ChangeApplier trans.changeRecord.changeMap = {}; }, commit: function (code) { that.preCommit.fire(trans, that, code); if (trans.changeRecord.changes > 0) { var oldHolder = {model: holder.model}; holder.model = trans.newHolder.model; fluid.notifyModelChanges(that.transListeners.sortedListeners, trans.changeRecord.changeMap, holder, oldHolder, null, trans, that, holder); } if (!defeatPost) { that.postCommit.fire(trans, that, code); } }, fireChangeRequest: function (changeRequest) { fluid.preFireChangeRequest(that, changeRequest); changeRequest.transactionId = trans.id; var deltaMap = fluid.model.applyHolderChangeRequest(trans.newHolder, changeRequest, trans.changeRecord); fluid.notifyModelChanges(that.listeners.sortedListeners, deltaMap, trans.newHolder, holder, changeRequest, trans, that, holder); }, hasChangeSource: function (source) { return trans.fullSources[source]; } }; var transRec = fluid.getModelTransactionRec(holder, trans.id); if (transRec) { fluid.mergeChangeSources(transRec.sources, globalSources); trans.sources = transRec.sources; trans.fullSources = Object.create(transRec.sources); trans.fullSources[localSource] = true; } trans.reset(); fluid.bindRequestChange(trans); return trans; }; fluid.bindRequestChange(that); fluid.bindELMethods(that); return that; }; /** * Calculates the changes between the model values 'value' and * 'oldValue' and returns an array of change records. The optional * argument 'changePathPrefix' is prepended to the change path of * each record (this is useful for generating change records to be * applied at a non-root path in a model). The returned array of * change records may be used with fluid.fireChanges(). * * @param {Any} value - Model value to compare. * @param {Any} oldValue - Model value to compare. * @param {String|Array} [changePathPrefix] - [optional] Path prefix to prepend to change record paths, expressed as a string or an array of string segments. * @return {Array} - An array of change record objects. */ fluid.modelPairToChanges = function (value, oldValue, changePathPrefix) { changePathPrefix = changePathPrefix || ""; // Calculate the diff between value and oldValue var diffOptions = {changes: 0, unchanged: 0, changeMap: {}}; fluid.model.diff(oldValue, value, diffOptions); var changes = []; // Recursively process the diff to generate an array of change // records, stored in 'changes' fluid.modelPairToChangesImpl(value, fluid.pathUtil.parseEL(changePathPrefix), diffOptions.changeMap, [], changes); return changes; }; /** * This function implements recursive processing for * fluid.modelPairToChanges(). It builds an array of change * records, accumulated in the 'changes' argument, by walking the * 'changeMap' structure and 'value' model value. As we walk down * the model, our path from the root of the model is recorded in * the 'changeSegs' argument. * * @param {Any} value - Model value * @param {String[]} changePathPrefixSegs - Path prefix to prepend to change record paths, expressed as an array of string segments. * @param {String|Object} changeMap - The changeMap structure from fluid.model.diff(). * @param {String[]} changeSegs - Our path relative to the model value root, expressed as an array of string segments. * @param {Object[]} changes - The accumulated change record objects. */ fluid.modelPairToChangesImpl = function (value, changePathPrefixSegs, changeMap, changeSegs, changes) { if (changeMap === "ADD") { // The whole model value is new changes.push({ path: changePathPrefixSegs, value: value, type: "ADD" }); } else if (changeMap === "DELETE") { // The whole model value has been deleted changes.push({ path: changePathPrefixSegs, value: null, type: "DELETE" }); } else Eif (fluid.isPlainObject(changeMap, true)) { // Something within the model value has changed fluid.each(changeMap, function (change, seg) { var currentChangeSegs = changeSegs.concat([seg]); if (change === "ADD") { changes.push({ path: changePathPrefixSegs.concat(currentChangeSegs), value: fluid.get(value, currentChangeSegs), type: "ADD" }); } else if (change === "DELETE") { changes.push({ path: changePathPrefixSegs.concat(currentChangeSegs), value: null, type: "DELETE" }); } else Eif (fluid.isPlainObject(change, true)) { // Recurse down the tree of changes fluid.modelPairToChangesImpl(value, changePathPrefixSegs, change, currentChangeSegs, changes); } }); } }; })(jQuery, fluid_3_0_0); |