1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436
|
/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*-
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* eslint-env mozilla/browser-window */
{
// start private scope for Tabbrowser
/**
* A set of known icons to use for internal pages. These are hardcoded so we can
* start loading them faster than FaviconLoader would normally find them.
*/
const FAVICON_DEFAULTS = {
"about:newtab": "chrome://branding/content/icon32.png",
"about:home": "chrome://branding/content/icon32.png",
"about:welcome": "chrome://branding/content/icon32.png",
"about:privatebrowsing":
"chrome://browser/skin/privatebrowsing/favicon.svg",
};
const {
LOAD_FLAGS_NONE,
LOAD_FLAGS_FROM_EXTERNAL,
LOAD_FLAGS_FIRST_LOAD,
LOAD_FLAGS_DISALLOW_INHERIT_PRINCIPAL,
LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP,
LOAD_FLAGS_FIXUP_SCHEME_TYPOS,
LOAD_FLAGS_FORCE_ALLOW_DATA_URI,
LOAD_FLAGS_DISABLE_TRR,
} = Ci.nsIWebNavigation;
const DIRECTION_FORWARD = 1;
const DIRECTION_BACKWARD = -1;
/**
* Updates the User Context UI indicators if the browser is in a non-default context
*/
function updateUserContextUIIndicator() {
function replaceContainerClass(classType, element, value) {
let prefix = "identity-" + classType + "-";
if (value && element.classList.contains(prefix + value)) {
return;
}
for (let className of element.classList) {
if (className.startsWith(prefix)) {
element.classList.remove(className);
}
}
if (value) {
element.classList.add(prefix + value);
}
}
let hbox = document.getElementById("userContext-icons");
let userContextId = gBrowser.selectedBrowser.getAttribute("usercontextid");
if (!userContextId) {
replaceContainerClass("color", hbox, "");
hbox.hidden = true;
return;
}
let identity =
ContextualIdentityService.getPublicIdentityFromId(userContextId);
if (!identity) {
replaceContainerClass("color", hbox, "");
hbox.hidden = true;
return;
}
replaceContainerClass("color", hbox, identity.color);
let label = ContextualIdentityService.getUserContextLabel(userContextId);
document.getElementById("userContext-label").textContent = label;
// Also set the container label as the tooltip so we can only show the icon
// in small windows.
hbox.setAttribute("tooltiptext", label);
let indicator = document.getElementById("userContext-indicator");
replaceContainerClass("icon", indicator, identity.icon);
hbox.hidden = false;
}
async function getTotalMemoryUsage() {
const procInfo = await ChromeUtils.requestProcInfo();
let totalMemoryUsage = procInfo.memory;
for (const child of procInfo.children) {
totalMemoryUsage += child.memory;
}
return totalMemoryUsage;
}
window.Tabbrowser = class {
init() {
this.tabContainer = document.getElementById("tabbrowser-tabs");
this.tabGroupMenu = document.getElementById("tab-group-editor");
this.tabbox = document.getElementById("tabbrowser-tabbox");
this.tabpanels = document.getElementById("tabbrowser-tabpanels");
this.pinnedTabsContainer = document.getElementById(
"pinned-tabs-container"
);
ChromeUtils.defineESModuleGetters(this, {
AsyncTabSwitcher:
"moz-src:///browser/components/tabbrowser/AsyncTabSwitcher.sys.mjs",
PictureInPicture: "resource://gre/modules/PictureInPicture.sys.mjs",
SmartTabGroupingManager:
"moz-src:///browser/components/tabbrowser/SmartTabGrouping.sys.mjs",
TabMetrics:
"moz-src:///browser/components/tabbrowser/TabMetrics.sys.mjs",
TabStateFlusher:
"resource:///modules/sessionstore/TabStateFlusher.sys.mjs",
UrlbarProviderOpenTabs:
"resource:///modules/UrlbarProviderOpenTabs.sys.mjs",
});
ChromeUtils.defineLazyGetter(this, "tabLocalization", () => {
return new Localization(
["browser/tabbrowser.ftl", "branding/brand.ftl"],
true
);
});
XPCOMUtils.defineLazyPreferenceGetter(
this,
"_shouldExposeContentTitle",
"privacy.exposeContentTitleInWindow",
true
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"_shouldExposeContentTitlePbm",
"privacy.exposeContentTitleInWindow.pbm",
true
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"_showTabCardPreview",
"browser.tabs.hoverPreview.enabled",
true
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"_allowTransparentBrowser",
"browser.tabs.allow_transparent_browser",
false
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"_tabGroupsEnabled",
"browser.tabs.groups.enabled",
false
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"showPidAndActiveness",
"browser.tabs.tooltipsShowPidAndActiveness",
false
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"_unloadTabInContextMenu",
"browser.tabs.unloadTabInContextMenu",
false
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"_notificationEnableDelay",
"security.notification_enable_delay",
500
);
if (AppConstants.MOZ_CRASHREPORTER) {
ChromeUtils.defineESModuleGetters(this, {
TabCrashHandler: "resource:///modules/ContentCrashHandlers.sys.mjs",
});
}
Services.obs.addObserver(this, "contextual-identity-updated");
document.addEventListener("keydown", this, { mozSystemGroup: true });
document.addEventListener("keypress", this, { mozSystemGroup: true });
document.addEventListener("visibilitychange", this);
window.addEventListener("framefocusrequested", this);
window.addEventListener("activate", this);
window.addEventListener("deactivate", this);
window.addEventListener("TabGroupCreateByUser", this);
window.addEventListener("TabGrouped", this);
window.addEventListener("TabUngrouped", this);
this.tabContainer.init();
this._setupInitialBrowserAndTab();
if (
Services.prefs.getIntPref("browser.display.document_color_use") == 2
) {
this.tabpanels.style.backgroundColor = Services.prefs.getCharPref(
"browser.display.background_color"
);
}
this._setFindbarData();
// We take over setting the document title, so remove the l10n id to
// avoid it being re-translated and overwriting document content if
// we ever switch languages at runtime. After a language change, the
// window title will update at the next tab or location change.
document.querySelector("title").removeAttribute("data-l10n-id");
this._setupEventListeners();
this._initialized = true;
}
ownerGlobal = window;
ownerDocument = document;
closingTabsEnum = {
ALL: 0,
OTHER: 1,
TO_START: 2,
TO_END: 3,
MULTI_SELECTED: 4,
DUPLICATES: 6,
ALL_DUPLICATES: 7,
};
_lastRelatedTabMap = new WeakMap();
mProgressListeners = [];
mTabsProgressListeners = [];
_tabListeners = new Map();
_tabFilters = new Map();
_isBusy = false;
_awaitingToggleCaretBrowsingPrompt = false;
_previewMode = false;
_lastFindValue = "";
_contentWaitingCount = 0;
_tabLayerCache = [];
tabAnimationsInProgress = 0;
/**
* Binding from browser to tab
*/
_tabForBrowser = new WeakMap();
/**
* `_createLazyBrowser` will define properties on the unbound lazy browser
* which correspond to properties defined in MozBrowser which will be bound to
* the browser when it is inserted into the document. If any of these
* properties are accessed by consumers, `_insertBrowser` is called and
* the browser is inserted to ensure that things don't break. This list
* provides the names of properties that may be called while the browser
* is in its unbound (lazy) state.
*/
_browserBindingProperties = [
"canGoBack",
"canGoForward",
"goBack",
"goForward",
"permitUnload",
"reload",
"reloadWithFlags",
"stop",
"loadURI",
"fixupAndLoadURIString",
"gotoIndex",
"currentURI",
"documentURI",
"remoteType",
"preferences",
"imageDocument",
"isRemoteBrowser",
"messageManager",
"getTabBrowser",
"finder",
"fastFind",
"sessionHistory",
"contentTitle",
"characterSet",
"fullZoom",
"textZoom",
"tabHasCustomZoom",
"webProgress",
"addProgressListener",
"removeProgressListener",
"audioPlaybackStarted",
"audioPlaybackStopped",
"resumeMedia",
"mute",
"unmute",
"blockedPopups",
"lastURI",
"purgeSessionHistory",
"stopScroll",
"startScroll",
"userTypedValue",
"userTypedClear",
"didStartLoadSinceLastUserTyping",
"audioMuted",
];
_removingTabs = new Set();
_multiSelectedTabsSet = new WeakSet();
_lastMultiSelectedTabRef = null;
_clearMultiSelectionLocked = false;
_clearMultiSelectionLockedOnce = false;
_multiSelectChangeStarted = false;
_multiSelectChangeAdditions = new Set();
_multiSelectChangeRemovals = new Set();
_multiSelectChangeSelected = false;
/**
* Tab close requests are ignored if the window is closing anyway,
* e.g. when holding Ctrl+W.
*/
_windowIsClosing = false;
preloadedBrowser = null;
/**
* This defines a proxy which allows us to access browsers by
* index without actually creating a full array of browsers.
*/
browsers = new Proxy([], {
has: (target, name) => {
if (typeof name == "string" && Number.isInteger(parseInt(name))) {
return name in gBrowser.tabs;
}
return false;
},
get: (target, name) => {
if (name == "length") {
return gBrowser.tabs.length;
}
if (typeof name == "string" && Number.isInteger(parseInt(name))) {
if (!(name in gBrowser.tabs)) {
return undefined;
}
return gBrowser.tabs[name].linkedBrowser;
}
return target[name];
},
});
/**
* List of browsers whose docshells must be active in order for print preview
* to work.
*/
_printPreviewBrowsers = new Set();
_switcher = null;
_soundPlayingAttrRemovalTimer = 0;
_hoverTabTimer = null;
get tabs() {
return this.tabContainer.allTabs;
}
get tabGroups() {
return this.tabContainer.allGroups;
}
get tabsInCollapsedTabGroups() {
return this.tabGroups
.filter(tabGroup => tabGroup.collapsed)
.flatMap(tabGroup => tabGroup.tabs)
.filter(tab => !tab.hidden && !tab.closing);
}
addEventListener(...args) {
this.tabpanels.addEventListener(...args);
}
removeEventListener(...args) {
this.tabpanels.removeEventListener(...args);
}
dispatchEvent(...args) {
return this.tabpanels.dispatchEvent(...args);
}
/**
* Returns all tabs in the current window, including hidden tabs and tabs
* in collapsed groups, but excluding closing tabs and the Firefox View tab.
*/
get openTabs() {
return this.tabContainer.openTabs;
}
/**
* Same as `openTabs` but excluding hidden tabs.
*/
get nonHiddenTabs() {
return this.tabContainer.nonHiddenTabs;
}
/**
* Same as `openTabs` but excluding hidden tabs and tabs in collapsed groups.
*/
get visibleTabs() {
return this.tabContainer.visibleTabs;
}
get pinnedTabCount() {
for (var i = 0; i < this.tabs.length; i++) {
if (!this.tabs[i].pinned) {
break;
}
}
return i;
}
set selectedTab(val) {
if (
gSharedTabWarning.willShowSharedTabWarning(val) ||
document.documentElement.hasAttribute("window-modal-open") ||
(gNavToolbox.collapsed && !this._allowTabChange)
) {
return;
}
// Update the tab
this.tabbox.selectedTab = val;
}
get selectedTab() {
return this._selectedTab;
}
get selectedBrowser() {
return this._selectedBrowser;
}
_setupInitialBrowserAndTab() {
// See browser.js for the meaning of window.arguments.
// Bug 1485961 covers making this more sane.
let userContextId = window.arguments && window.arguments[5];
let openWindowInfo = window.docShell.treeOwner
.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsIAppWindow).initialOpenWindowInfo;
if (!openWindowInfo && window.arguments && window.arguments[11]) {
openWindowInfo = window.arguments[11];
}
let extraOptions;
if (window.arguments?.[1] instanceof Ci.nsIPropertyBag2) {
extraOptions = window.arguments[1];
}
// If our opener provided a remoteType which was responsible for creating
// this pop-up window, we'll fall back to using that remote type when no
// other remote type is available.
let triggeringRemoteType;
if (extraOptions?.hasKey("triggeringRemoteType")) {
triggeringRemoteType = extraOptions.getPropertyAsACString(
"triggeringRemoteType"
);
}
let tabArgument = gBrowserInit.getTabToAdopt();
// If we have a tab argument with browser, we use its remoteType. Otherwise,
// if e10s is disabled or there's a parent process opener (e.g. parent
// process about: page) for the content tab, we use a parent
// process remoteType. Otherwise, we check the URI to determine
// what to do - if there isn't one, we default to the default remote type.
//
// When adopting a tab, we'll also use that tab's browsingContextGroupId,
// if available, to ensure we don't spawn a new process.
let remoteType;
let initialBrowsingContextGroupId;
if (tabArgument && tabArgument.hasAttribute("usercontextid")) {
// The window's first argument is a tab if and only if we are swapping tabs.
// We must set the browser's usercontextid so that the newly created remote
// tab child has the correct usercontextid.
userContextId = parseInt(tabArgument.getAttribute("usercontextid"), 10);
}
if (tabArgument && tabArgument.linkedBrowser) {
remoteType = tabArgument.linkedBrowser.remoteType;
initialBrowsingContextGroupId =
tabArgument.linkedBrowser.browsingContext?.group.id;
} else if (openWindowInfo) {
userContextId = openWindowInfo.originAttributes.userContextId;
if (openWindowInfo.isRemote) {
remoteType = triggeringRemoteType ?? E10SUtils.DEFAULT_REMOTE_TYPE;
} else {
remoteType = E10SUtils.NOT_REMOTE;
}
} else {
let uriToLoad = gBrowserInit.uriToLoadPromise;
if (uriToLoad && Array.isArray(uriToLoad)) {
uriToLoad = uriToLoad[0]; // we only care about the first item
}
if (uriToLoad && typeof uriToLoad == "string") {
let oa = E10SUtils.predictOriginAttributes({
window,
userContextId,
});
remoteType = E10SUtils.getRemoteTypeForURI(
uriToLoad,
gMultiProcessBrowser,
gFissionBrowser,
triggeringRemoteType ?? E10SUtils.DEFAULT_REMOTE_TYPE,
null,
oa
);
} else {
// If we reach here, we don't have the url to load. This means that
// `uriToLoad` is most likely a promise which is waiting on SessionStore
// initialization. We can't delay setting up the browser here, as that
// would mean that `gBrowser.selectedBrowser` might not always exist,
// which is the current assumption.
if (Cu.isInAutomation) {
ChromeUtils.releaseAssert(
!triggeringRemoteType,
"Unexpected triggeringRemoteType with no uriToLoad"
);
}
// In this case we default to the privileged about process as that's
// the best guess we can make, and we'll likely need it eventually.
remoteType = E10SUtils.PRIVILEGEDABOUT_REMOTE_TYPE;
}
}
let createOptions = {
uriIsAboutBlank: false,
userContextId,
initialBrowsingContextGroupId,
remoteType,
openWindowInfo,
};
let browser = this.createBrowser(createOptions);
browser.setAttribute("primary", "true");
if (gBrowserAllowScriptsToCloseInitialTabs) {
browser.setAttribute("allowscriptstoclose", "true");
}
browser.droppedLinkHandler = handleDroppedLink;
browser.loadURI = URILoadingWrapper.loadURI.bind(
URILoadingWrapper,
browser
);
browser.fixupAndLoadURIString =
URILoadingWrapper.fixupAndLoadURIString.bind(
URILoadingWrapper,
browser
);
let uniqueId = this._generateUniquePanelID();
let panel = this.getPanel(browser);
panel.id = uniqueId;
this.tabpanels.appendChild(panel);
let tab = this.tabs[0];
tab.linkedPanel = uniqueId;
this._selectedTab = tab;
this._selectedBrowser = browser;
tab.permanentKey = browser.permanentKey;
tab._tPos = 0;
tab._fullyOpen = true;
tab.linkedBrowser = browser;
if (userContextId) {
tab.setAttribute("usercontextid", userContextId);
ContextualIdentityService.setTabStyle(tab);
}
this._tabForBrowser.set(browser, tab);
this._appendStatusPanel();
// This is the initial browser, so it's usually active; the default is false
// so we have to update it:
browser.docShellIsActive = this.shouldActivateDocShell(browser);
// Hook the browser up with a progress listener.
let tabListener = new TabProgressListener(tab, browser, true, false);
let filter = Cc[
"@mozilla.org/appshell/component/browser-status-filter;1"
].createInstance(Ci.nsIWebProgress);
filter.addProgressListener(tabListener, Ci.nsIWebProgress.NOTIFY_ALL);
this._tabListeners.set(tab, tabListener);
this._tabFilters.set(tab, filter);
browser.webProgress.addProgressListener(
filter,
Ci.nsIWebProgress.NOTIFY_ALL
);
}
/**
* BEGIN FORWARDED BROWSER PROPERTIES. IF YOU ADD A PROPERTY TO THE BROWSER ELEMENT
* MAKE SURE TO ADD IT HERE AS WELL.
*/
get canGoBack() {
return this.selectedBrowser.canGoBack;
}
get canGoBackIgnoringUserInteraction() {
return this.selectedBrowser.canGoBackIgnoringUserInteraction;
}
get canGoForward() {
return this.selectedBrowser.canGoForward;
}
goBack(requireUserInteraction) {
return this.selectedBrowser.goBack(requireUserInteraction);
}
goForward(requireUserInteraction) {
return this.selectedBrowser.goForward(requireUserInteraction);
}
reload() {
return this.selectedBrowser.reload();
}
reloadWithFlags(aFlags) {
return this.selectedBrowser.reloadWithFlags(aFlags);
}
stop() {
return this.selectedBrowser.stop();
}
/**
* throws exception for unknown schemes
*/
loadURI(uri, params) {
return this.selectedBrowser.loadURI(uri, params);
}
/**
* throws exception for unknown schemes
*/
fixupAndLoadURIString(uriString, params) {
return this.selectedBrowser.fixupAndLoadURIString(uriString, params);
}
gotoIndex(aIndex) {
return this.selectedBrowser.gotoIndex(aIndex);
}
get currentURI() {
return this.selectedBrowser.currentURI;
}
get finder() {
return this.selectedBrowser.finder;
}
get docShell() {
return this.selectedBrowser.docShell;
}
get webNavigation() {
return this.selectedBrowser.webNavigation;
}
get webProgress() {
return this.selectedBrowser.webProgress;
}
get contentWindow() {
return this.selectedBrowser.contentWindow;
}
get sessionHistory() {
return this.selectedBrowser.sessionHistory;
}
get contentDocument() {
return this.selectedBrowser.contentDocument;
}
get contentTitle() {
return this.selectedBrowser.contentTitle;
}
get contentPrincipal() {
return this.selectedBrowser.contentPrincipal;
}
get securityUI() {
return this.selectedBrowser.securityUI;
}
set fullZoom(val) {
this.selectedBrowser.fullZoom = val;
}
get fullZoom() {
return this.selectedBrowser.fullZoom;
}
set textZoom(val) {
this.selectedBrowser.textZoom = val;
}
get textZoom() {
return this.selectedBrowser.textZoom;
}
get isSyntheticDocument() {
return this.selectedBrowser.isSyntheticDocument;
}
set userTypedValue(val) {
this.selectedBrowser.userTypedValue = val;
}
get userTypedValue() {
return this.selectedBrowser.userTypedValue;
}
_setFindbarData() {
// Ensure we know what the find bar key is in the content process:
let { sharedData } = Services.ppmm;
if (!sharedData.has("Findbar:Shortcut")) {
let keyEl = document.getElementById("key_find");
let mods = keyEl
.getAttribute("modifiers")
.replace(
/accel/i,
AppConstants.platform == "macosx" ? "meta" : "control"
);
sharedData.set("Findbar:Shortcut", {
key: keyEl.getAttribute("key"),
shiftKey: mods.includes("shift"),
ctrlKey: mods.includes("control"),
altKey: mods.includes("alt"),
metaKey: mods.includes("meta"),
});
}
}
isFindBarInitialized(aTab) {
return (aTab || this.selectedTab)._findBar != undefined;
}
/**
* Get the already constructed findbar
*/
getCachedFindBar(aTab = this.selectedTab) {
return aTab._findBar;
}
/**
* Get the findbar, and create it if it doesn't exist.
* @return the find bar (or null if the window or tab is closed/closing in the interim).
*/
async getFindBar(aTab = this.selectedTab) {
let findBar = this.getCachedFindBar(aTab);
if (findBar) {
return findBar;
}
// Avoid re-entrancy by caching the promise we're about to return.
if (!aTab._pendingFindBar) {
aTab._pendingFindBar = this._createFindBar(aTab);
}
return aTab._pendingFindBar;
}
/**
* Create a findbar instance.
* @param aTab the tab to create the find bar for.
* @return the created findbar, or null if the window or tab is closed/closing.
*/
async _createFindBar(aTab) {
let findBar = document.createXULElement("findbar");
let browser = this.getBrowserForTab(aTab);
browser.parentNode.insertAdjacentElement("afterend", findBar);
await new Promise(r => requestAnimationFrame(r));
delete aTab._pendingFindBar;
if (window.closed || aTab.closing) {
return null;
}
findBar.browser = browser;
findBar._findField.value = this._lastFindValue;
aTab._findBar = findBar;
let event = document.createEvent("Events");
event.initEvent("TabFindInitialized", true, false);
aTab.dispatchEvent(event);
return findBar;
}
_appendStatusPanel() {
this.selectedBrowser.insertAdjacentElement("afterend", StatusPanel.panel);
}
_updateTabBarForPinnedTabs() {
this.tabContainer._unlockTabSizing();
this.tabContainer._handleTabSelect(true);
this.tabContainer._updateCloseButtons();
}
#notifyPinnedStatus(
aTab,
{ telemetrySource = this.TabMetrics.METRIC_SOURCE.UNKNOWN } = {}
) {
// browsingContext is expected to not be defined on discarded tabs.
if (aTab.linkedBrowser.browsingContext) {
aTab.linkedBrowser.browsingContext.isAppTab = aTab.pinned;
}
let event = new CustomEvent(aTab.pinned ? "TabPinned" : "TabUnpinned", {
bubbles: true,
cancelable: false,
detail: { telemetrySource },
});
aTab.dispatchEvent(event);
}
/**
* Pin a tab.
*
* @param {MozTabbrowserTab} aTab
* The tab to pin.
* @param {object} [options]
* @property {string} [options.telemetrySource="unknown"]
* The means by which the tab was pinned.
* @see TabMetrics.METRIC_SOURCE for possible values.
* Defaults to "unknown".
*/
pinTab(
aTab,
{ telemetrySource = this.TabMetrics.METRIC_SOURCE.UNKNOWN } = {}
) {
if (aTab.pinned || aTab == FirefoxViewHandler.tab) {
return;
}
this.showTab(aTab);
this.#handleTabMove(aTab, () =>
this.pinnedTabsContainer.appendChild(aTab)
);
aTab.setAttribute("pinned", "true");
this._updateTabBarForPinnedTabs();
this.#notifyPinnedStatus(aTab, { telemetrySource });
}
unpinTab(aTab) {
if (!aTab.pinned) {
return;
}
this.#handleTabMove(aTab, () => {
// we remove this attribute first, so that allTabs represents
// the moving of a tab from the pinned tabs container
// and back into arrowscrollbox.
aTab.removeAttribute("pinned");
this.tabContainer.arrowScrollbox.prepend(aTab);
});
aTab.style.marginInlineStart = "";
aTab._pinnedUnscrollable = false;
this._updateTabBarForPinnedTabs();
this.#notifyPinnedStatus(aTab);
}
previewTab(aTab, aCallback) {
let currentTab = this.selectedTab;
try {
// Suppress focus, ownership and selected tab changes
this._previewMode = true;
this.selectedTab = aTab;
aCallback();
} finally {
this.selectedTab = currentTab;
this._previewMode = false;
}
}
getBrowserAtIndex(aIndex) {
return this.browsers[aIndex];
}
getBrowserForOuterWindowID(aID) {
for (let b of this.browsers) {
if (b.outerWindowID == aID) {
return b;
}
}
return null;
}
getTabForBrowser(aBrowser) {
return this._tabForBrowser.get(aBrowser);
}
getPanel(aBrowser) {
return this.getBrowserContainer(aBrowser).parentNode;
}
getBrowserContainer(aBrowser) {
return (aBrowser || this.selectedBrowser).parentNode.parentNode;
}
getTabNotificationDeck() {
if (!this._tabNotificationDeck) {
let template = document.getElementById(
"tab-notification-deck-template"
);
template.replaceWith(template.content);
this._tabNotificationDeck = document.getElementById(
"tab-notification-deck"
);
}
return this._tabNotificationDeck;
}
_nextNotificationBoxId = 0;
getNotificationBox(aBrowser) {
let browser = aBrowser || this.selectedBrowser;
if (!browser._notificationBox) {
browser._notificationBox = new MozElements.NotificationBox(element => {
element.setAttribute("notificationside", "top");
element.setAttribute(
"name",
`tab-notification-box-${this._nextNotificationBoxId++}`
);
this.getTabNotificationDeck().append(element);
if (browser == this.selectedBrowser) {
this._updateVisibleNotificationBox(browser);
}
}, this._notificationEnableDelay);
}
return browser._notificationBox;
}
readNotificationBox(aBrowser) {
let browser = aBrowser || this.selectedBrowser;
return browser._notificationBox || null;
}
_updateVisibleNotificationBox(aBrowser) {
if (!this._tabNotificationDeck) {
// If the deck hasn't been created we don't need to create it here.
return;
}
let notificationBox = this.readNotificationBox(aBrowser);
this.getTabNotificationDeck().selectedViewName = notificationBox
? notificationBox.stack.getAttribute("name")
: "";
}
getTabDialogBox(aBrowser) {
if (!aBrowser) {
throw new Error("aBrowser is required");
}
if (!aBrowser.tabDialogBox) {
aBrowser.tabDialogBox = new TabDialogBox(aBrowser);
}
return aBrowser.tabDialogBox;
}
getTabFromAudioEvent(aEvent) {
if (!aEvent.isTrusted) {
return null;
}
var browser = aEvent.originalTarget;
var tab = this.getTabForBrowser(browser);
return tab;
}
_callProgressListeners(
aBrowser,
aMethod,
aArguments,
aCallGlobalListeners = true,
aCallTabsListeners = true
) {
var rv = true;
function callListeners(listeners, args) {
for (let p of listeners) {
if (aMethod in p) {
try {
if (!p[aMethod].apply(p, args)) {
rv = false;
}
} catch (e) {
// don't inhibit other listeners
console.error(e);
}
}
}
}
aBrowser = aBrowser || this.selectedBrowser;
if (aCallGlobalListeners && aBrowser == this.selectedBrowser) {
callListeners(this.mProgressListeners, aArguments);
}
if (aCallTabsListeners) {
aArguments.unshift(aBrowser);
callListeners(this.mTabsProgressListeners, aArguments);
}
return rv;
}
/**
* Sets an icon for the tab if the URI is defined in FAVICON_DEFAULTS.
*/
setDefaultIcon(aTab, aURI) {
if (aURI && aURI.spec in FAVICON_DEFAULTS) {
this.setIcon(aTab, FAVICON_DEFAULTS[aURI.spec]);
}
}
setIcon(
aTab,
aIconURL = "",
aOriginalURL = aIconURL,
aLoadingPrincipal = null,
aClearImageFirst = false
) {
let makeString = url => (url instanceof Ci.nsIURI ? url.spec : url);
aIconURL = makeString(aIconURL);
aOriginalURL = makeString(aOriginalURL);
let LOCAL_PROTOCOLS = ["chrome:", "about:", "resource:", "data:"];
if (
aIconURL &&
!aLoadingPrincipal &&
!LOCAL_PROTOCOLS.some(protocol => aIconURL.startsWith(protocol))
) {
console.error(
`Attempt to set a remote URL ${aIconURL} as a tab icon without a loading principal.`
);
return;
}
let browser = this.getBrowserForTab(aTab);
browser.mIconURL = aIconURL;
if (aIconURL != aTab.getAttribute("image")) {
if (aClearImageFirst) {
aTab.removeAttribute("image");
}
if (aIconURL) {
if (aLoadingPrincipal) {
aTab.setAttribute("iconloadingprincipal", aLoadingPrincipal);
} else {
aTab.removeAttribute("iconloadingprincipal");
}
aTab.setAttribute("image", aIconURL);
} else {
aTab.removeAttribute("image");
aTab.removeAttribute("iconloadingprincipal");
}
this._tabAttrModified(aTab, ["image"]);
}
// The aOriginalURL argument is currently only used by tests.
this._callProgressListeners(browser, "onLinkIconAvailable", [
aIconURL,
aOriginalURL,
]);
}
getIcon(aTab) {
let browser = aTab ? this.getBrowserForTab(aTab) : this.selectedBrowser;
return browser.mIconURL;
}
setPageInfo(tab, aURL, aDescription, aPreviewImage) {
if (aURL) {
let pageInfo = {
url: aURL,
description: aDescription,
previewImageURL: aPreviewImage,
};
PlacesUtils.history.update(pageInfo).catch(console.error);
}
if (tab) {
tab.description = aDescription;
}
}
getWindowTitleForBrowser(aBrowser) {
let docElement = document.documentElement;
let title = "";
let dataSuffix =
docElement.getAttribute("privatebrowsingmode") == "temporary"
? "Private"
: "Default";
if (
SelectableProfileService?.isEnabled &&
SelectableProfileService.currentProfile
) {
dataSuffix += "WithProfile";
}
let defaultTitle = docElement.dataset["title" + dataSuffix].replace(
"PROFILENAME",
() => SelectableProfileService.currentProfile.name.replace(/\0/g, "")
);
if (
!this._shouldExposeContentTitle ||
(PrivateBrowsingUtils.isWindowPrivate(window) &&
!this._shouldExposeContentTitlePbm)
) {
return defaultTitle;
}
// If location bar is hidden and the URL type supports a host,
// add the scheme and host to the title to prevent spoofing.
// XXX https://bugzilla.mozilla.org/show_bug.cgi?id=22183#c239
try {
if (docElement.getAttribute("chromehidden").includes("location")) {
const uri = Services.io.createExposableURI(aBrowser.currentURI);
let prefix = uri.prePath;
if (uri.scheme == "about") {
prefix = uri.spec;
} else if (uri.scheme == "moz-extension") {
const ext = WebExtensionPolicy.getByHostname(uri.host);
if (ext && ext.name) {
let extensionLabel = document.getElementById(
"urlbar-label-extension"
);
prefix = `${extensionLabel.value} (${ext.name})`;
}
}
title = prefix + " - ";
}
} catch (e) {
// ignored
}
if (docElement.hasAttribute("titlepreface")) {
title += docElement.getAttribute("titlepreface");
}
let tab = this.getTabForBrowser(aBrowser);
if (tab._labelIsContentTitle) {
// Strip out any null bytes in the content title, since the
// underlying widget implementations of nsWindow::SetTitle pass
// null-terminated strings to system APIs.
title += tab.getAttribute("label").replace(/\0/g, "");
}
if (title) {
// We're using a function rather than just using `title` as the
// new substring to avoid `$$`, `$'` etc. having a special
// meaning to `replace`.
// See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#specifying_a_string_as_a_parameter
// and the documentation for functions for more info about this.
return docElement.dataset["contentTitle" + dataSuffix]
.replace("CONTENTTITLE", () => title)
.replace(
"PROFILENAME",
() =>
SelectableProfileService?.currentProfile?.name.replace(
/\0/g,
""
) ?? ""
);
}
return defaultTitle;
}
updateTitlebar() {
document.title = this.getWindowTitleForBrowser(this.selectedBrowser);
}
updateCurrentBrowser(aForceUpdate) {
let newBrowser = this.getBrowserAtIndex(this.tabContainer.selectedIndex);
if (this.selectedBrowser == newBrowser && !aForceUpdate) {
return;
}
let oldBrowser = this.selectedBrowser;
// Once the async switcher starts, it's unpredictable when it will touch
// the address bar, thus we store its state immediately.
gURLBar?.saveSelectionStateForBrowser(oldBrowser);
let newTab = this.getTabForBrowser(newBrowser);
let timerId;
if (!aForceUpdate) {
timerId = Glean.browserTabswitch.update.start();
if (gMultiProcessBrowser) {
this._asyncTabSwitching = true;
this._getSwitcher().requestTab(newTab);
this._asyncTabSwitching = false;
}
document.commandDispatcher.lock();
}
let oldTab = this.selectedTab;
// Preview mode should not reset the owner
if (!this._previewMode && !oldTab.selected) {
oldTab.owner = null;
}
let lastRelatedTab = this._lastRelatedTabMap.get(oldTab);
if (lastRelatedTab) {
if (!lastRelatedTab.selected) {
lastRelatedTab.owner = null;
}
}
this._lastRelatedTabMap = new WeakMap();
if (!gMultiProcessBrowser) {
oldBrowser.removeAttribute("primary");
oldBrowser.docShellIsActive = false;
newBrowser.setAttribute("primary", "true");
newBrowser.docShellIsActive = !document.hidden;
}
this._selectedBrowser = newBrowser;
this._selectedTab = newTab;
this.showTab(newTab);
this._appendStatusPanel();
this._updateVisibleNotificationBox(newBrowser);
let oldBrowserPopupsBlocked =
oldBrowser.popupBlocker.getBlockedPopupCount();
let newBrowserPopupsBlocked =
newBrowser.popupBlocker.getBlockedPopupCount();
if (oldBrowserPopupsBlocked != newBrowserPopupsBlocked) {
newBrowser.popupBlocker.updateBlockedPopupsUI();
}
// Update the URL bar.
let webProgress = newBrowser.webProgress;
this._callProgressListeners(
null,
"onLocationChange",
[webProgress, null, newBrowser.currentURI, 0, true],
true,
false
);
let securityUI = newBrowser.securityUI;
if (securityUI) {
this._callProgressListeners(
null,
"onSecurityChange",
[webProgress, null, securityUI.state],
true,
false
);
// Include the true final argument to indicate that this event is
// simulated (instead of being observed by the webProgressListener).
this._callProgressListeners(
null,
"onContentBlockingEvent",
[webProgress, null, newBrowser.getContentBlockingEvents(), true],
true,
false
);
}
let listener = this._tabListeners.get(newTab);
if (listener && listener.mStateFlags) {
this._callProgressListeners(
null,
"onUpdateCurrentBrowser",
[
listener.mStateFlags,
listener.mStatus,
listener.mMessage,
listener.mTotalProgress,
],
true,
false
);
}
if (!this._previewMode) {
newTab.recordTimeFromUnloadToReload();
newTab.updateLastAccessed();
oldTab.updateLastAccessed();
// if this is the foreground window, update the last-seen timestamps.
if (this.ownerGlobal == BrowserWindowTracker.getTopWindow()) {
newTab.updateLastSeenActive();
oldTab.updateLastSeenActive();
}
let oldFindBar = oldTab._findBar;
if (
oldFindBar &&
oldFindBar.findMode == oldFindBar.FIND_NORMAL &&
!oldFindBar.hidden
) {
this._lastFindValue = oldFindBar._findField.value;
}
this.updateTitlebar();
newTab.removeAttribute("titlechanged");
newTab.attention = false;
// The tab has been selected, it's not unselected anymore.
// Call the current browser's unselectedTabHover() with false
// to dispatch an event.
newBrowser.unselectedTabHover(false);
}
// If the new tab is busy, and our current state is not busy, then
// we need to fire a start to all progress listeners.
if (newTab.hasAttribute("busy") && !this._isBusy) {
this._isBusy = true;
this._callProgressListeners(
null,
"onStateChange",
[
webProgress,
null,
Ci.nsIWebProgressListener.STATE_START |
Ci.nsIWebProgressListener.STATE_IS_NETWORK,
0,
],
true,
false
);
}
// If the new tab is not busy, and our current state is busy, then
// we need to fire a stop to all progress listeners.
if (!newTab.hasAttribute("busy") && this._isBusy) {
this._isBusy = false;
this._callProgressListeners(
null,
"onStateChange",
[
webProgress,
null,
Ci.nsIWebProgressListener.STATE_STOP |
Ci.nsIWebProgressListener.STATE_IS_NETWORK,
0,
],
true,
false
);
}
// TabSelect events are suppressed during preview mode to avoid confusing extensions and other bits of code
// that might rely upon the other changes suppressed.
// Focus is suppressed in the event that the main browser window is minimized - focusing a tab would restore the window
if (!this._previewMode) {
// We've selected the new tab, so go ahead and notify listeners.
let event = new CustomEvent("TabSelect", {
bubbles: true,
cancelable: false,
detail: {
previousTab: oldTab,
},
});
newTab.dispatchEvent(event);
this._tabAttrModified(oldTab, ["selected"]);
this._tabAttrModified(newTab, ["selected"]);
this._startMultiSelectChange();
this._multiSelectChangeSelected = true;
this.clearMultiSelectedTabs();
if (this._multiSelectChangeAdditions.size) {
// Some tab has been multiselected just before switching tabs.
// The tab that was selected at that point should also be multiselected.
this.addToMultiSelectedTabs(oldTab);
}
if (!gMultiProcessBrowser) {
this._adjustFocusBeforeTabSwitch(oldTab, newTab);
this._adjustFocusAfterTabSwitch(newTab);
}
// Bug 1781806 - A forced update can indicate the tab was already
// selected. To ensure the internal state of the Urlbar is kept in
// sync, notify it as if focus changed. Alternatively, if there is no
// force update but the load context is not using remote tabs, there
// can be a focus change due to the _adjustFocus above.
if (aForceUpdate || !gMultiProcessBrowser) {
gURLBar.afterTabSwitchFocusChange();
}
}
updateUserContextUIIndicator();
gPermissionPanel.updateSharingIndicator();
// Enable touch events to start a native dragging
// session to allow the user to easily drag the selected tab.
// This is currently only supported on Windows.
oldTab.removeAttribute("touchdownstartsdrag");
newTab.setAttribute("touchdownstartsdrag", "true");
if (!gMultiProcessBrowser) {
document.commandDispatcher.unlock();
let event = new CustomEvent("TabSwitchDone", {
bubbles: true,
cancelable: true,
});
this.dispatchEvent(event);
}
if (!aForceUpdate) {
Glean.browserTabswitch.update.stopAndAccumulate(timerId);
}
}
_adjustFocusBeforeTabSwitch(oldTab, newTab) {
if (this._previewMode) {
return;
}
let oldBrowser = oldTab.linkedBrowser;
let newBrowser = newTab.linkedBrowser;
gURLBar.getBrowserState(oldBrowser).urlbarFocused = gURLBar.focused;
if (this._asyncTabSwitching) {
newBrowser._userTypedValueAtBeforeTabSwitch = newBrowser.userTypedValue;
}
if (this.isFindBarInitialized(oldTab)) {
let findBar = this.getCachedFindBar(oldTab);
oldTab._findBarFocused =
!findBar.hidden &&
findBar._findField.getAttribute("focused") == "true";
}
let activeEl = document.activeElement;
// If focus is on the old tab, move it to the new tab.
if (activeEl == oldTab) {
newTab.focus();
} else if (
gMultiProcessBrowser &&
activeEl != newBrowser &&
activeEl != newTab
) {
// In e10s, if focus isn't already in the tabstrip or on the new browser,
// and the new browser's previous focus wasn't in the url bar but focus is
// there now, we need to adjust focus further.
let keepFocusOnUrlBar =
newBrowser &&
gURLBar.getBrowserState(newBrowser).urlbarFocused &&
gURLBar.focused;
if (!keepFocusOnUrlBar) {
// Clear focus so that _adjustFocusAfterTabSwitch can detect if
// some element has been focused and respect that.
document.activeElement.blur();
}
}
}
_adjustFocusAfterTabSwitch(newTab) {
// Don't steal focus from the tab bar.
if (document.activeElement == newTab) {
return;
}
let newBrowser = this.getBrowserForTab(newTab);
if (newBrowser.hasAttribute("tabDialogShowing")) {
newBrowser.tabDialogBox.focus();
return;
}
// Focus the location bar if it was previously focused for that tab.
// In full screen mode, only bother making the location bar visible
// if the tab is a blank one.
if (gURLBar.getBrowserState(newBrowser).urlbarFocused) {
let selectURL = () => {
if (this._asyncTabSwitching) {
// Set _awaitingSetURI flag to suppress popup notification
// explicitly while tab switching asynchronously.
newBrowser._awaitingSetURI = true;
// The onLocationChange event called in updateCurrentBrowser() will
// be captured in browser.js, then it calls gURLBar.setURI(). In case
// of that doing processing of here before doing above processing,
// the selection status that gURLBar.select() does will be releasing
// by gURLBar.setURI(). To resolve it, we call gURLBar.select() after
// finishing gURLBar.setURI().
const currentActiveElement = document.activeElement;
gURLBar.inputField.addEventListener(
"SetURI",
() => {
delete newBrowser._awaitingSetURI;
// If the user happened to type into the URL bar for this browser
// by the time we got here, focusing will cause the text to be
// selected which could cause them to overwrite what they've
// already typed in.
let userTypedValueAtBeforeTabSwitch =
newBrowser._userTypedValueAtBeforeTabSwitch;
delete newBrowser._userTypedValueAtBeforeTabSwitch;
if (
newBrowser.userTypedValue &&
newBrowser.userTypedValue != userTypedValueAtBeforeTabSwitch
) {
return;
}
if (currentActiveElement != document.activeElement) {
return;
}
gURLBar.restoreSelectionStateForBrowser(newBrowser);
},
{ once: true }
);
} else {
gURLBar.restoreSelectionStateForBrowser(newBrowser);
}
};
// This inDOMFullscreen attribute indicates that the page has something
// such as a video in fullscreen mode. Opening a new tab will cancel
// fullscreen mode, so we need to wait for that to happen and then
// select the url field.
if (window.document.documentElement.hasAttribute("inDOMFullscreen")) {
window.addEventListener("MozDOMFullscreen:Exited", selectURL, {
once: true,
wantsUntrusted: false,
});
return;
}
if (!window.fullScreen || newTab.isEmpty) {
selectURL();
return;
}
}
// Focus the find bar if it was previously focused for that tab.
if (
gFindBarInitialized &&
!gFindBar.hidden &&
this.selectedTab._findBarFocused
) {
gFindBar._findField.focus();
return;
}
// Don't focus the content area if something has been focused after the
// tab switch was initiated.
if (gMultiProcessBrowser && document.activeElement != document.body) {
return;
}
// We're now committed to focusing the content area.
let fm = Services.focus;
let focusFlags = fm.FLAG_NOSCROLL;
if (!gMultiProcessBrowser) {
let newFocusedElement = fm.getFocusedElementForWindow(
window.content,
true,
{}
);
// for anchors, use FLAG_SHOWRING so that it is clear what link was
// last clicked when switching back to that tab
if (
newFocusedElement &&
(HTMLAnchorElement.isInstance(newFocusedElement) ||
newFocusedElement.getAttributeNS(
"http://www.w3.org/1999/xlink",
"type"
) == "simple")
) {
focusFlags |= fm.FLAG_SHOWRING;
}
}
fm.setFocus(newBrowser, focusFlags);
}
_tabAttrModified(aTab, aChanged) {
if (aTab.closing) {
return;
}
let event = new CustomEvent("TabAttrModified", {
bubbles: true,
cancelable: false,
detail: {
changed: aChanged,
},
});
aTab.dispatchEvent(event);
}
resetBrowserSharing(aBrowser) {
let tab = this.getTabForBrowser(aBrowser);
if (!tab) {
return;
}
// If WebRTC was used, leave object to enable tracking of grace periods.
tab._sharingState = tab._sharingState?.webRTC ? { webRTC: {} } : {};
tab.removeAttribute("sharing");
this._tabAttrModified(tab, ["sharing"]);
if (aBrowser == this.selectedBrowser) {
gPermissionPanel.updateSharingIndicator();
}
}
updateBrowserSharing(aBrowser, aState) {
let tab = this.getTabForBrowser(aBrowser);
if (!tab) {
return;
}
if (tab._sharingState == null) {
tab._sharingState = {};
}
tab._sharingState = Object.assign(tab._sharingState, aState);
if ("webRTC" in aState) {
if (tab._sharingState.webRTC?.sharing) {
if (tab._sharingState.webRTC.paused) {
tab.removeAttribute("sharing");
} else {
tab.setAttribute("sharing", aState.webRTC.sharing);
}
} else {
tab.removeAttribute("sharing");
}
this._tabAttrModified(tab, ["sharing"]);
}
if (aBrowser == this.selectedBrowser) {
gPermissionPanel.updateSharingIndicator();
}
}
getTabSharingState(aTab) {
// Normalize the state object for consumers (ie.extensions).
let state = Object.assign(
{},
aTab._sharingState && aTab._sharingState.webRTC
);
return {
camera: !!state.camera,
microphone: !!state.microphone,
screen: state.screen && state.screen.replace("Paused", ""),
};
}
setInitialTabTitle(aTab, aTitle, aOptions = {}) {
// Convert some non-content title (actually a url) to human readable title
if (!aOptions.isContentTitle && isBlankPageURL(aTitle)) {
aTitle = this.tabContainer.emptyTabTitle;
}
if (aTitle) {
if (!aTab.getAttribute("label")) {
aTab._labelIsInitialTitle = true;
}
this._setTabLabel(aTab, aTitle, aOptions);
}
}
_dataURLRegEx = /^data:[^,]+;base64,/i;
// Regex to test if a string (potential tab label) consists of only non-
// printable characters. We consider Unicode categories Separator
// (spaces & line-breaks) and Other (control chars, private use, non-
// character codepoints) to be unprintable, along with a few specific
// characters whose expected rendering is blank:
// U+2800 BRAILLE PATTERN BLANK (category So)
// U+115F HANGUL CHOSEONG FILLER (category Lo)
// U+1160 HANGUL JUNGSEONG FILLER (category Lo)
// U+3164 HANGUL FILLER (category Lo)
// U+FFA0 HALFWIDTH HANGUL FILLER (category Lo)
// We also ignore combining marks, as in the absence of a printable base
// character they are unlikely to be usefully rendered, and may well be
// clipped away entirely.
_nonPrintingRegEx =
/^[\p{Z}\p{C}\p{M}\u{115f}\u{1160}\u{2800}\u{3164}\u{ffa0}]*$/u;
setTabTitle(aTab) {
var browser = this.getBrowserForTab(aTab);
var title = browser.contentTitle;
if (aTab.hasAttribute("customizemode")) {
title = this.tabLocalization.formatValueSync(
"tabbrowser-customizemode-tab-title"
);
}
// Don't replace an initially set label with the URL while the tab
// is loading.
if (aTab._labelIsInitialTitle) {
if (!title) {
return false;
}
delete aTab._labelIsInitialTitle;
}
let isURL = false;
// Trim leading and trailing whitespace from the title.
title = title.trim();
// If the title contains only non-printing characters (or only combining
// marks, but no base character for them), we won't use it.
if (this._nonPrintingRegEx.test(title)) {
title = "";
}
let isContentTitle = !!title;
if (!title) {
// See if we can use the URI as the title.
if (browser.currentURI.displaySpec) {
try {
title = Services.io.createExposableURI(
browser.currentURI
).displaySpec;
} catch (ex) {
title = browser.currentURI.displaySpec;
}
}
if (title && !isBlankPageURL(title)) {
isURL = true;
if (title.length <= 500 || !this._dataURLRegEx.test(title)) {
// Try to unescape not-ASCII URIs using the current character set.
try {
let characterSet = browser.characterSet;
title = Services.textToSubURI.unEscapeNonAsciiURI(
characterSet,
title
);
} catch (ex) {
/* Do nothing. */
}
}
} else {
// No suitable URI? Fall back to our untitled string.
title = this.tabContainer.emptyTabTitle;
}
}
return this._setTabLabel(aTab, title, { isContentTitle, isURL });
}
// While an auth prompt from a base domain different than the current sites is open, we do not want to show the tab title of the current site,
// but of the origin that is requesting authentication.
// This is to prevent possible auth spoofing scenarios.
// See bug 791594 for reference.
setTabLabelForAuthPrompts(aTab, aLabel) {
return this._setTabLabel(aTab, aLabel);
}
_setTabLabel(aTab, aLabel, { beforeTabOpen, isContentTitle, isURL } = {}) {
if (!aLabel || aLabel.includes("about:reader?")) {
return false;
}
// If it's a long data: URI that uses base64 encoding, truncate to a
// reasonable length rather than trying to display the entire thing,
// which can hang or crash the browser.
// We can't shorten arbitrary URIs like this, as bidi etc might mean
// we need the trailing characters for display. But a base64-encoded
// data-URI is plain ASCII, so this is OK for tab-title display.
// (See bug 1408854.)
if (isURL && aLabel.length > 500 && this._dataURLRegEx.test(aLabel)) {
aLabel = aLabel.substring(0, 500) + "\u2026";
}
aTab._fullLabel = aLabel;
if (!isContentTitle) {
// Remove protocol and "www."
if (!("_regex_shortenURLForTabLabel" in this)) {
this._regex_shortenURLForTabLabel = /^[^:]+:\/\/(?:www\.)?/;
}
aLabel = aLabel.replace(this._regex_shortenURLForTabLabel, "");
}
aTab._labelIsContentTitle = isContentTitle;
if (aTab.getAttribute("label") == aLabel) {
return false;
}
let dwu = window.windowUtils;
let isRTL =
dwu.getDirectionFromText(aLabel) == Ci.nsIDOMWindowUtils.DIRECTION_RTL;
aTab.setAttribute("label", aLabel);
aTab.setAttribute("labeldirection", isRTL ? "rtl" : "ltr");
aTab.toggleAttribute("labelendaligned", isRTL != (document.dir == "rtl"));
// Dispatch TabAttrModified event unless we're setting the label
// before the TabOpen event was dispatched.
if (!beforeTabOpen) {
this._tabAttrModified(aTab, ["label"]);
}
if (aTab.selected) {
this.updateTitlebar();
}
return true;
}
loadTabs(
aURIs,
{
allowInheritPrincipal,
allowThirdPartyFixup,
inBackground,
newIndex,
elementIndex,
postDatas,
replace,
tabGroup,
targetTab,
triggeringPrincipal,
csp,
userContextId,
fromExternal,
} = {}
) {
if (!aURIs.length) {
return;
}
// The tab selected after this new tab is closed (i.e. the new tab's
// "owner") is the next adjacent tab (i.e. not the previously viewed tab)
// when several urls are opened here (i.e. closing the first should select
// the next of many URLs opened) or if the pref to have UI links opened in
// the background is set (i.e. the link is not being opened modally)
//
// i.e.
// Number of URLs Load UI Links in BG Focus Last Viewed?
// == 1 false YES
// == 1 true NO
// > 1 false/true NO
var multiple = aURIs.length > 1;
var owner = multiple || inBackground ? null : this.selectedTab;
var firstTabAdded = null;
var targetTabIndex = -1;
if (typeof elementIndex == "number") {
newIndex = this.#elementIndexToTabIndex(elementIndex);
}
if (typeof newIndex != "number") {
newIndex = -1;
}
// When bulk opening tabs, such as from a bookmark folder, we want to insertAfterCurrent
// if necessary, but we also will set the bulkOrderedOpen flag so that the bookmarks
// open in the same order they are in the folder.
if (
multiple &&
newIndex < 0 &&
Services.prefs.getBoolPref("browser.tabs.insertAfterCurrent")
) {
newIndex = this.selectedTab._tPos + 1;
}
if (replace) {
if (this.isTabGroupLabel(targetTab)) {
throw new Error(
"Replacing a tab group label with a tab is not supported"
);
}
let browser;
if (targetTab) {
browser = this.getBrowserForTab(targetTab);
targetTabIndex = targetTab._tPos;
} else {
browser = this.selectedBrowser;
targetTabIndex = this.tabContainer.selectedIndex;
}
let loadFlags = LOAD_FLAGS_NONE;
if (allowThirdPartyFixup) {
loadFlags |=
LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP | LOAD_FLAGS_FIXUP_SCHEME_TYPOS;
}
if (!allowInheritPrincipal) {
loadFlags |= LOAD_FLAGS_DISALLOW_INHERIT_PRINCIPAL;
}
if (fromExternal) {
loadFlags |= LOAD_FLAGS_FROM_EXTERNAL;
}
try {
browser.fixupAndLoadURIString(aURIs[0], {
loadFlags,
postData: postDatas && postDatas[0],
triggeringPrincipal,
csp,
});
} catch (e) {
// Ignore failure in case a URI is wrong, so we can continue
// opening the next ones.
}
} else {
let params = {
allowInheritPrincipal,
ownerTab: owner,
skipAnimation: multiple,
allowThirdPartyFixup,
postData: postDatas && postDatas[0],
userContextId,
triggeringPrincipal,
bulkOrderedOpen: multiple,
csp,
fromExternal,
tabGroup,
};
if (newIndex > -1) {
params.tabIndex = newIndex;
}
firstTabAdded = this.addTab(aURIs[0], params);
if (newIndex > -1) {
targetTabIndex = firstTabAdded._tPos;
}
}
let tabNum = targetTabIndex;
for (let i = 1; i < aURIs.length; ++i) {
let params = {
allowInheritPrincipal,
skipAnimation: true,
allowThirdPartyFixup,
postData: postDatas && postDatas[i],
userContextId,
triggeringPrincipal,
bulkOrderedOpen: true,
csp,
fromExternal,
tabGroup,
};
if (targetTabIndex > -1) {
params.tabIndex = ++tabNum;
}
this.addTab(aURIs[i], params);
}
if (firstTabAdded && !inBackground) {
this.selectedTab = firstTabAdded;
}
}
updateBrowserRemoteness(aBrowser, { newFrameloader, remoteType } = {}) {
let isRemote = aBrowser.getAttribute("remote") == "true";
// We have to be careful with this here, as the "no remote type" is null,
// not a string. Make sure to check only for undefined, since null is
// allowed.
if (remoteType === undefined) {
throw new Error("Remote type must be set!");
}
let shouldBeRemote = remoteType !== E10SUtils.NOT_REMOTE;
if (!gMultiProcessBrowser && shouldBeRemote) {
throw new Error(
"Cannot switch to remote browser in a window " +
"without the remote tabs load context."
);
}
// Abort if we're not going to change anything
let oldRemoteType = aBrowser.remoteType;
if (
isRemote == shouldBeRemote &&
!newFrameloader &&
(!isRemote || oldRemoteType == remoteType)
) {
return false;
}
let tab = this.getTabForBrowser(aBrowser);
// aBrowser needs to be inserted now if it hasn't been already.
this._insertBrowser(tab);
let evt = document.createEvent("Events");
evt.initEvent("BeforeTabRemotenessChange", true, false);
tab.dispatchEvent(evt);
// Unhook our progress listener.
let filter = this._tabFilters.get(tab);
let listener = this._tabListeners.get(tab);
aBrowser.webProgress.removeProgressListener(filter);
filter.removeProgressListener(listener);
// We'll be creating a new listener, so destroy the old one.
listener.destroy();
let oldDroppedLinkHandler = aBrowser.droppedLinkHandler;
let oldUserTypedValue = aBrowser.userTypedValue;
let hadStartedLoad = aBrowser.didStartLoadSinceLastUserTyping();
// Change the "remote" attribute.
// Make sure the browser is destroyed so it unregisters from observer notifications
aBrowser.destroy();
if (shouldBeRemote) {
aBrowser.setAttribute("remote", "true");
aBrowser.setAttribute("remoteType", remoteType);
} else {
aBrowser.setAttribute("remote", "false");
aBrowser.removeAttribute("remoteType");
}
// This call actually switches out our frameloaders. Do this as late as
// possible before rebuilding the browser, as we'll need the new browser
// state set up completely first.
aBrowser.changeRemoteness({
remoteType,
});
// Once we have new frameloaders, this call sets the browser back up.
aBrowser.construct();
aBrowser.userTypedValue = oldUserTypedValue;
if (hadStartedLoad) {
aBrowser.urlbarChangeTracker.startedLoad();
}
aBrowser.droppedLinkHandler = oldDroppedLinkHandler;
// This shouldn't really be necessary, however, this has the side effect
// of sending MozLayerTreeReady / MozLayerTreeCleared events for remote
// frames, which the tab switcher depends on.
//
// eslint-disable-next-line no-self-assign
aBrowser.docShellIsActive = aBrowser.docShellIsActive;
// Create a new tab progress listener for the new browser we just injected,
// since tab progress listeners have logic for handling the initial about:blank
// load
listener = new TabProgressListener(tab, aBrowser, true, false);
this._tabListeners.set(tab, listener);
filter.addProgressListener(listener, Ci.nsIWebProgress.NOTIFY_ALL);
// Restore the progress listener.
aBrowser.webProgress.addProgressListener(
filter,
Ci.nsIWebProgress.NOTIFY_ALL
);
// Restore the securityUI state.
let securityUI = aBrowser.securityUI;
let state = securityUI
? securityUI.state
: Ci.nsIWebProgressListener.STATE_IS_INSECURE;
this._callProgressListeners(
aBrowser,
"onSecurityChange",
[aBrowser.webProgress, null, state],
true,
false
);
let event = aBrowser.getContentBlockingEvents();
// Include the true final argument to indicate that this event is
// simulated (instead of being observed by the webProgressListener).
this._callProgressListeners(
aBrowser,
"onContentBlockingEvent",
[aBrowser.webProgress, null, event, true],
true,
false
);
if (shouldBeRemote) {
// Switching the browser to be remote will connect to a new child
// process so the browser can no longer be considered to be
// crashed.
tab.removeAttribute("crashed");
}
// If the findbar has been initialised, reset its browser reference.
if (this.isFindBarInitialized(tab)) {
this.getCachedFindBar(tab).browser = aBrowser;
}
evt = document.createEvent("Events");
evt.initEvent("TabRemotenessChange", true, false);
tab.dispatchEvent(evt);
return true;
}
updateBrowserRemotenessByURL(aBrowser, aURL, aOptions = {}) {
if (!gMultiProcessBrowser) {
return this.updateBrowserRemoteness(aBrowser, {
remoteType: E10SUtils.NOT_REMOTE,
});
}
let oldRemoteType = aBrowser.remoteType;
let oa = E10SUtils.predictOriginAttributes({ browser: aBrowser });
aOptions.remoteType = E10SUtils.getRemoteTypeForURI(
aURL,
gMultiProcessBrowser,
gFissionBrowser,
oldRemoteType,
aBrowser.currentURI,
oa
);
// If this URL can't load in the current browser then flip it to the
// correct type.
if (oldRemoteType != aOptions.remoteType || aOptions.newFrameloader) {
return this.updateBrowserRemoteness(aBrowser, aOptions);
}
return false;
}
createBrowser({
isPreloadBrowser,
name,
openWindowInfo,
remoteType,
initialBrowsingContextGroupId,
uriIsAboutBlank,
userContextId,
skipLoad,
} = {}) {
let b = document.createXULElement("browser");
// Use the JSM global to create the permanentKey, so that if the
// permanentKey is held by something after this window closes, it
// doesn't keep the window alive.
b.permanentKey = new (Cu.getGlobalForObject(Services).Object)();
const defaultBrowserAttributes = {
contextmenu: "contentAreaContextMenu",
message: "true",
messagemanagergroup: "browsers",
tooltip: "aHTMLTooltip",
type: "content",
manualactiveness: "true",
};
for (let attribute in defaultBrowserAttributes) {
b.setAttribute(attribute, defaultBrowserAttributes[attribute]);
}
if (gMultiProcessBrowser || remoteType) {
b.setAttribute("maychangeremoteness", "true");
}
if (userContextId) {
b.setAttribute("usercontextid", userContextId);
}
if (remoteType) {
b.setAttribute("remoteType", remoteType);
b.setAttribute("remote", "true");
}
if (!isPreloadBrowser) {
b.setAttribute("autocompletepopup", "PopupAutoComplete");
}
/*
* This attribute is meant to describe if the browser is the
* preloaded browser. When the preloaded browser is created, the
* 'preloadedState' attribute for that browser is set to "preloaded", and
* when a new tab is opened, and it is time to show that preloaded
* browser, the 'preloadedState' attribute for that browser is removed.
*
* See more details on Bug 1420285.
*/
if (isPreloadBrowser) {
b.setAttribute("preloadedState", "preloaded");
}
// Ensure that the browser will be created in a specific initial
// BrowsingContextGroup. This may change the process selection behaviour
// of the newly created browser, and is often used in combination with
// "remoteType" to ensure that the initial about:blank load occurs
// within the same process as another window.
if (initialBrowsingContextGroupId) {
b.setAttribute(
"initialBrowsingContextGroupId",
initialBrowsingContextGroupId
);
}
// Propagate information about the opening content window to the browser.
if (openWindowInfo) {
b.openWindowInfo = openWindowInfo;
}
// This will be used by gecko to control the name of the opened
// window.
if (name) {
// XXX: The `name` property is special in HTML and XUL. Should
// we use a different attribute name for this?
b.setAttribute("name", name);
}
if (this._allowTransparentBrowser) {
b.setAttribute("transparent", "true");
}
let stack = document.createXULElement("stack");
stack.className = "browserStack";
stack.appendChild(b);
let browserContainer = document.createXULElement("vbox");
browserContainer.className = "browserContainer";
browserContainer.appendChild(stack);
let browserSidebarContainer = document.createXULElement("hbox");
browserSidebarContainer.className = "browserSidebarContainer";
browserSidebarContainer.appendChild(browserContainer);
// Prevent the superfluous initial load of a blank document
// if we're going to load something other than about:blank.
if (!uriIsAboutBlank || skipLoad) {
b.setAttribute("nodefaultsrc", "true");
}
return b;
}
_createLazyBrowser(aTab) {
let browser = aTab.linkedBrowser;
let names = this._browserBindingProperties;
for (let i = 0; i < names.length; i++) {
let name = names[i];
let getter;
let setter;
switch (name) {
case "audioMuted":
getter = () => aTab.hasAttribute("muted");
break;
case "contentTitle":
getter = () => SessionStore.getLazyTabValue(aTab, "title");
break;
case "currentURI":
getter = () => {
// Avoid recreating the same nsIURI object over and over again...
if (browser._cachedCurrentURI) {
return browser._cachedCurrentURI;
}
let url =
SessionStore.getLazyTabValue(aTab, "url") || "about:blank";
return (browser._cachedCurrentURI = Services.io.newURI(url));
};
break;
case "didStartLoadSinceLastUserTyping":
getter = () => () => false;
break;
case "fullZoom":
case "textZoom":
getter = () => 1;
break;
case "tabHasCustomZoom":
getter = () => false;
break;
case "getTabBrowser":
getter = () => () => this;
break;
case "isRemoteBrowser":
getter = () => browser.getAttribute("remote") == "true";
break;
case "permitUnload":
getter = () => () => ({ permitUnload: true });
break;
case "reload":
case "reloadWithFlags":
getter = () => params => {
// Wait for load handler to be instantiated before
// initializing the reload.
aTab.addEventListener(
"SSTabRestoring",
() => {
browser[name](params);
},
{ once: true }
);
gBrowser._insertBrowser(aTab);
};
break;
case "remoteType":
getter = () => {
let url =
SessionStore.getLazyTabValue(aTab, "url") || "about:blank";
// Avoid recreating the same nsIURI object over and over again...
let uri;
if (browser._cachedCurrentURI) {
uri = browser._cachedCurrentURI;
} else {
uri = browser._cachedCurrentURI = Services.io.newURI(url);
}
let oa = E10SUtils.predictOriginAttributes({
browser,
userContextId: aTab.getAttribute("usercontextid"),
});
return E10SUtils.getRemoteTypeForURI(
url,
gMultiProcessBrowser,
gFissionBrowser,
undefined,
uri,
oa
);
};
break;
case "userTypedValue":
case "userTypedClear":
getter = () => SessionStore.getLazyTabValue(aTab, name);
break;
default:
getter = () => {
if (AppConstants.NIGHTLY_BUILD) {
let message = `[bug 1345098] Lazy browser prematurely inserted via '${name}' property access:\n`;
Services.console.logStringMessage(message + new Error().stack);
}
this._insertBrowser(aTab);
return browser[name];
};
setter = value => {
if (AppConstants.NIGHTLY_BUILD) {
let message = `[bug 1345098] Lazy browser prematurely inserted via '${name}' property access:\n`;
Services.console.logStringMessage(message + new Error().stack);
}
this._insertBrowser(aTab);
return (browser[name] = value);
};
}
Object.defineProperty(browser, name, {
get: getter,
set: setter,
configurable: true,
enumerable: true,
});
}
}
_insertBrowser(aTab, aInsertedOnTabCreation) {
"use strict";
// If browser is already inserted or window is closed don't do anything.
if (aTab.linkedPanel || window.closed) {
return;
}
let browser = aTab.linkedBrowser;
// If browser is a lazy browser, delete the substitute properties.
if (this._browserBindingProperties[0] in browser) {
for (let name of this._browserBindingProperties) {
delete browser[name];
}
}
let { uriIsAboutBlank, usingPreloadedContent } = aTab._browserParams;
delete aTab._browserParams;
delete browser._cachedCurrentURI;
let panel = this.getPanel(browser);
let uniqueId = this._generateUniquePanelID();
panel.id = uniqueId;
aTab.linkedPanel = uniqueId;
// Inject the <browser> into the DOM if necessary.
if (!panel.parentNode) {
// NB: this appendChild call causes us to run constructors for the
// browser element, which fires off a bunch of notifications. Some
// of those notifications can cause code to run that inspects our
// state, so it is important that the tab element is fully
// initialized by this point.
this.tabpanels.appendChild(panel);
}
// wire up a progress listener for the new browser object.
let tabListener = new TabProgressListener(
aTab,
browser,
uriIsAboutBlank,
usingPreloadedContent
);
const filter = Cc[
"@mozilla.org/appshell/component/browser-status-filter;1"
].createInstance(Ci.nsIWebProgress);
filter.addProgressListener(tabListener, Ci.nsIWebProgress.NOTIFY_ALL);
browser.webProgress.addProgressListener(
filter,
Ci.nsIWebProgress.NOTIFY_ALL
);
this._tabListeners.set(aTab, tabListener);
this._tabFilters.set(aTab, filter);
browser.droppedLinkHandler = handleDroppedLink;
browser.loadURI = URILoadingWrapper.loadURI.bind(
URILoadingWrapper,
browser
);
browser.fixupAndLoadURIString =
URILoadingWrapper.fixupAndLoadURIString.bind(
URILoadingWrapper,
browser
);
// Most of the time, we start our browser's docShells out as inactive,
// and then maintain activeness in the tab switcher. Preloaded about:newtab's
// are already created with their docShell's as inactive, but then explicitly
// render their layers to ensure that we can switch to them quickly. We avoid
// setting docShellIsActive to false again in this case, since that'd cause
// the layers for the preloaded tab to be dropped, and we'd see a flash
// of empty content instead.
//
// So for all browsers except for the preloaded case, we set the browser
// docShell to inactive.
if (!usingPreloadedContent) {
browser.docShellIsActive = false;
}
// If we transitioned from one browser to two browsers, we need to set
// hasSiblings=false on both the existing browser and the new browser.
if (this.tabs.length == 2) {
this.tabs[0].linkedBrowser.browsingContext.hasSiblings = true;
this.tabs[1].linkedBrowser.browsingContext.hasSiblings = true;
} else {
aTab.linkedBrowser.browsingContext.hasSiblings = this.tabs.length > 1;
}
if (aTab.userContextId) {
browser.setAttribute("usercontextid", aTab.userContextId);
}
browser.browsingContext.isAppTab = aTab.pinned;
// We don't want to update the container icon and identifier if
// this is not the selected browser.
if (aTab.selected) {
updateUserContextUIIndicator();
}
// Only fire this event if the tab is already in the DOM
// and will be handled by a listener.
if (aTab.isConnected) {
var evt = new CustomEvent("TabBrowserInserted", {
bubbles: true,
detail: { insertedOnTabCreation: aInsertedOnTabCreation },
});
aTab.dispatchEvent(evt);
}
}
_mayDiscardBrowser(aTab, aForceDiscard) {
let browser = aTab.linkedBrowser;
let action = aForceDiscard ? "unload" : "dontUnload";
if (
!aTab ||
aTab.selected ||
aTab.closing ||
this._windowIsClosing ||
!browser.isConnected ||
!browser.isRemoteBrowser ||
!browser.permitUnload(action).permitUnload
) {
return false;
}
return true;
}
async prepareDiscardBrowser(aTab) {
let browser = aTab.linkedBrowser;
// This is similar to the checks in _mayDiscardBrowser, but
// doesn't have to be complete (and we want to be sure not to
// fire the beforeunload event). Calling TabStateFlusher.flush()
// and then not unloading the browser is fine.
if (aTab.closing || this._windowIsClosing || !browser.isRemoteBrowser) {
return;
}
// Flush the tab's state so session restore has the latest data.
await this.TabStateFlusher.flush(browser);
}
discardBrowser(aTab, aForceDiscard) {
"use strict";
let browser = aTab.linkedBrowser;
if (!this._mayDiscardBrowser(aTab, aForceDiscard)) {
return false;
}
// Reset sharing state.
if (aTab._sharingState) {
this.resetBrowserSharing(browser);
}
webrtcUI.forgetStreamsFromBrowserContext(browser.browsingContext);
// Set browser parameters for when browser is restored. Also remove
// listeners and set up lazy restore data in SessionStore. This must
// be done before browser is destroyed and removed from the document.
aTab._browserParams = {
uriIsAboutBlank: browser.currentURI.spec == "about:blank",
remoteType: browser.remoteType,
usingPreloadedContent: false,
};
SessionStore.resetBrowserToLazyState(aTab);
// Indicate that this tab was explicitly unloaded (i.e. not
// from a session restore) in case we want to style that
// differently.
if (aForceDiscard) {
aTab.toggleAttribute("discarded", true);
}
// Remove the tab's filter and progress listener.
let filter = this._tabFilters.get(aTab);
let listener = this._tabListeners.get(aTab);
browser.webProgress.removeProgressListener(filter);
filter.removeProgressListener(listener);
listener.destroy();
this._tabListeners.delete(aTab);
this._tabFilters.delete(aTab);
// Reset the findbar and remove it if it is attached to the tab.
if (aTab._findBar) {
aTab._findBar.close(true);
aTab._findBar.remove();
delete aTab._findBar;
}
// Remove potentially stale attributes.
let attributesToRemove = [
"activemedia-blocked",
"busy",
"pendingicon",
"progress",
"soundplaying",
];
let removedAttributes = [];
for (let attr of attributesToRemove) {
if (aTab.hasAttribute(attr)) {
removedAttributes.push(attr);
aTab.removeAttribute(attr);
}
}
if (removedAttributes.length) {
this._tabAttrModified(aTab, removedAttributes);
}
browser.destroy();
this.getPanel(browser).remove();
aTab.removeAttribute("linkedpanel");
this._createLazyBrowser(aTab);
let evt = new CustomEvent("TabBrowserDiscarded", { bubbles: true });
aTab.dispatchEvent(evt);
return true;
}
/**
* Loads a tab with a default null principal unless specified
*/
addWebTab(aURI, params = {}) {
if (!params.triggeringPrincipal) {
params.triggeringPrincipal =
Services.scriptSecurityManager.createNullPrincipal({
userContextId: params.userContextId,
});
}
if (params.triggeringPrincipal.isSystemPrincipal) {
throw new Error(
"System principal should never be passed into addWebTab()"
);
}
return this.addTab(aURI, params);
}
addAdjacentNewTab(tab) {
Services.obs.notifyObservers(
{
wrappedJSObject: new Promise(resolve => {
this.selectedTab = this.addTrustedTab(BROWSER_NEW_TAB_URL, {
tabIndex: tab._tPos + 1,
userContextId: tab.userContextId,
tabGroup: tab.group,
focusUrlBar: true,
});
resolve(this.selectedBrowser);
}),
},
"browser-open-newtab-start"
);
}
/**
* Must only be used sparingly for content that came from Chrome context
* If in doubt use addWebTab
* @param {string} aURI
* @param {object} [options]
* @see this.addTab options
* @returns {MozTabbrowserTab|null}
*/
addTrustedTab(aURI, options = {}) {
options.triggeringPrincipal =
Services.scriptSecurityManager.getSystemPrincipal();
return this.addTab(aURI, options);
}
/**
* @param {string} uriString
* @param {object} options
* @param {MozTabbrowserTabGroup} [options.tabGroup]
* A related tab group where this tab should be added, when applicable.
* When present, the tab is expected to reside in this tab group. When
* absent, the tab is expected to be a standalone tab.
* @returns {MozTabbrowserTab|null}
* The new tab. The return value will be null if the tab couldn't be
* created; this shouldn't normally happen, and an error will be logged
* to the console if it does.
*/
addTab(
uriString,
{
allowInheritPrincipal,
allowThirdPartyFixup,
bulkOrderedOpen,
charset,
createLazyBrowser,
disableTRR,
eventDetail,
focusUrlBar,
forceNotRemote,
forceAllowDataURI,
fromExternal,
inBackground = true,
elementIndex,
tabIndex,
lazyTabTitle,
name,
noInitialLabel,
openWindowInfo,
openerBrowser,
originPrincipal,
originStoragePrincipal,
ownerTab,
pinned,
postData,
preferredRemoteType,
referrerInfo,
relatedToCurrent,
initialBrowsingContextGroupId,
skipAnimation,
skipBackgroundNotify,
tabGroup,
triggeringPrincipal,
userContextId,
csp,
skipLoad = createLazyBrowser,
insertTab = true,
globalHistoryOptions,
triggeringRemoteType,
schemelessInput,
hasValidUserGestureActivation = false,
textDirectiveUserActivation = false,
} = {}
) {
// all callers of addTab that pass a params object need to pass
// a valid triggeringPrincipal.
if (!triggeringPrincipal) {
throw new Error(
"Required argument triggeringPrincipal missing within addTab"
);
}
if (!UserInteraction.running("browser.tabs.opening", window)) {
UserInteraction.start("browser.tabs.opening", "initting", window);
}
// If we're opening a foreground tab, set the owner by default.
ownerTab ??= inBackground ? null : this.selectedTab;
// if we're adding tabs, we're past interrupt mode, ditch the owner
if (this.selectedTab.owner) {
this.selectedTab.owner = null;
}
// Find the tab that opened this one, if any. This is used for
// determining positioning, and inherited attributes such as the
// user context ID.
//
// If we have a browser opener (which is usually the browser
// element from a remote window.open() call), use that.
//
// Otherwise, if the tab is related to the current tab (e.g.,
// because it was opened by a link click), use the selected tab as
// the owner. If referrerInfo is set, and we don't have an
// explicit relatedToCurrent arg, we assume that the tab is
// related to the current tab, since referrerURI is null or
// undefined if the tab is opened from an external application or
// bookmark (i.e. somewhere other than an existing tab).
if (relatedToCurrent == null) {
relatedToCurrent = !!(referrerInfo && referrerInfo.originalReferrer);
}
let openerTab =
(openerBrowser && this.getTabForBrowser(openerBrowser)) ||
(relatedToCurrent && this.selectedTab) ||
null;
// When overflowing, new tabs are scrolled into view smoothly, which
// doesn't go well together with the width transition. So we skip the
// transition in that case.
let animate =
!skipAnimation &&
!pinned &&
!this.tabContainer.verticalMode &&
!this.tabContainer.overflowing &&
!gReduceMotion;
let uriInfo = this._determineURIToLoad(uriString, createLazyBrowser);
let { uri, uriIsAboutBlank, lazyBrowserURI } = uriInfo;
// Have to overwrite this if we're lazy-loading. Should go away
// with bug 1818777.
({ uriString } = uriInfo);
let usingPreloadedContent = false;
let b, t;
try {
t = this._createTab({
uriString,
animate,
userContextId,
openerTab,
pinned,
noInitialLabel,
skipBackgroundNotify,
});
if (insertTab) {
// Insert the tab into the tab container in the correct position.
this.#insertTabAtIndex(t, {
elementIndex,
tabIndex,
ownerTab,
openerTab,
pinned,
bulkOrderedOpen,
tabGroup: tabGroup ?? openerTab?.group,
});
}
({ browser: b, usingPreloadedContent } = this._createBrowserForTab(t, {
uriString,
uri,
preferredRemoteType,
openerBrowser,
uriIsAboutBlank,
referrerInfo,
forceNotRemote,
name,
initialBrowsingContextGroupId,
openWindowInfo,
skipLoad,
triggeringRemoteType,
}));
if (focusUrlBar) {
gURLBar.getBrowserState(b).urlbarFocused = true;
}
// If the caller opts in, create a lazy browser.
if (createLazyBrowser) {
this._createLazyBrowser(t);
if (lazyBrowserURI) {
// Lazy browser must be explicitly registered so tab will appear as
// a switch-to-tab candidate in autocomplete.
this.UrlbarProviderOpenTabs.registerOpenTab(
lazyBrowserURI.spec,
t.userContextId,
tabGroup?.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
b.registeredOpenURI = lazyBrowserURI;
}
// If we're not inserting the tab into the DOM, we can't set the tab
// state meaningfully. Session restore (the only caller who does this)
// will have to do this work itself later, when the tabs have been
// inserted.
if (insertTab) {
SessionStore.setTabState(t, {
entries: [
{
url: lazyBrowserURI?.spec || "about:blank",
title: lazyTabTitle,
triggeringPrincipal_base64:
E10SUtils.serializePrincipal(triggeringPrincipal),
},
],
// Make sure to store the userContextId associated to the lazy tab
// otherwise it would be created as a default tab when recreated on a
// session restore (See Bug 1819794).
userContextId,
});
}
} else {
this._insertBrowser(t, true);
// If we were called by frontend and don't have openWindowInfo,
// but we were opened from another browser, set the cross group
// opener ID:
if (openerBrowser && !openWindowInfo) {
b.browsingContext.crossGroupOpener = openerBrowser.browsingContext;
}
}
} catch (e) {
console.error("Failed to create tab");
console.error(e);
t?.remove();
if (t?.linkedBrowser) {
this._tabFilters.delete(t);
this._tabListeners.delete(t);
this.getPanel(t.linkedBrowser).remove();
}
return null;
}
if (insertTab) {
// Fire a TabOpen event
this._fireTabOpen(t, eventDetail);
this._kickOffBrowserLoad(b, {
uri,
uriString,
usingPreloadedContent,
triggeringPrincipal,
originPrincipal,
originStoragePrincipal,
uriIsAboutBlank,
allowInheritPrincipal,
allowThirdPartyFixup,
fromExternal,
disableTRR,
forceAllowDataURI,
skipLoad,
referrerInfo,
charset,
postData,
csp,
globalHistoryOptions,
triggeringRemoteType,
schemelessInput,
hasValidUserGestureActivation:
hasValidUserGestureActivation ||
!!openWindowInfo?.hasValidUserGestureActivation,
textDirectiveUserActivation:
textDirectiveUserActivation ||
!!openWindowInfo?.textDirectiveUserActivation,
});
}
// This field is updated regardless if we actually animate
// since it's important that we keep this count correct in all cases.
this.tabAnimationsInProgress++;
if (animate) {
// Kick the animation off.
// TODO: we should figure out a better solution here. We use RAF
// to avoid jank of the animation due to synchronous work happening
// on tab open.
// With preloaded content though a single RAF happens too early. and
// both the transition and the transitionend event don't happen.
if (usingPreloadedContent) {
requestAnimationFrame(() => {
requestAnimationFrame(() => {
t.setAttribute("fadein", "true");
});
});
} else {
requestAnimationFrame(() => {
t.setAttribute("fadein", "true");
});
}
}
// Additionally send pinned tab events
if (pinned) {
this.#notifyPinnedStatus(t);
}
gSharedTabWarning.tabAdded(t);
if (!inBackground) {
this.selectedTab = t;
}
return t;
}
#elementIndexToTabIndex(elementIndex) {
if (elementIndex < 0) {
return -1;
}
if (elementIndex >= this.tabContainer.ariaFocusableItems.length) {
return this.tabs.length;
}
let element = this.tabContainer.ariaFocusableItems[elementIndex];
if (this.isTabGroupLabel(element)) {
element = element.group.tabs[0];
}
return element._tPos;
}
/**
* @param {string} id
* @param {string} color
* @param {boolean} collapsed
* @param {string} [label=]
* @param {boolean} [isAdoptingGroup=false]
* @returns {MozTabbrowserTabGroup}
*/
_createTabGroup(id, color, collapsed, label = "", isAdoptingGroup = false) {
let group = document.createXULElement("tab-group", { is: "tab-group" });
group.id = id;
group.collapsed = collapsed;
group.color = color;
group.label = label;
group.wasCreatedByAdoption = isAdoptingGroup;
return group;
}
/**
* Adds a new tab group.
*
* @param {object[]} tabs
* The set of tabs to include in the group.
* @param {object} [options]
* @param {string} [options.id]
* Optionally assign an ID to the tab group. Useful when rebuilding an
* existing group e.g. when restoring. A pseudorandom string will be
* generated if not set.
* @param {string} [options.color]
* Color for the group label. See tabgroup-menu.js for possible values.
* If no color specified, will attempt to assign an unused group color.
* @param {string} [options.label]
* Label for the group.
* @param {MozTabbrowserTab} [options.insertBefore]
* An optional argument that accepts a single tab, which, if passed, will
* cause the group to be inserted just before this tab in the tab strip. By
* default, the group will be created at the end of the tab strip.
* @param {boolean} [options.isAdoptingGroup]
* Whether the tab group was created because a tab group with the same
* properties is being adopted from a different window.
* @param {boolean} [options.isUserTriggered]
* Should be true if this group is being created in response to an
* explicit request from the user (as opposed to a group being created
* for technical reasons, such as when an already existing group
* switches windows).
* Causes the group create UI to be displayed and telemetry events to be fired.
* @param {string} [options.telemetryUserCreateSource]
* The means by which the tab group was created.
* @see TabMetrics.METRIC_SOURCE for possible values.
* Defaults to "unknown".
*/
addTabGroup(
tabs,
{
id = null,
color = null,
label = "",
insertBefore = null,
isAdoptingGroup = false,
isUserTriggered = false,
telemetryUserCreateSource = "unknown",
} = {}
) {
if (!tabs?.length) {
throw new Error("Cannot create tab group with zero tabs");
}
if (!color) {
color = this.tabGroupMenu.nextUnusedColor;
}
if (!id) {
// Note: If this changes, make sure to also update the
// getExtTabGroupIdForInternalTabGroupId implementation in
// browser/components/extensions/parent/ext-browser.js.
// See: Bug 1960104 - Improve tab group ID generation in addTabGroup
id = `${Date.now()}-${Math.round(Math.random() * 100)}`;
}
let group = this._createTabGroup(
id,
color,
false,
label,
isAdoptingGroup
);
this.tabContainer.insertBefore(
group,
insertBefore?.group ?? insertBefore
);
group.addTabs(tabs);
// Bail out if the group is empty at this point. This can happen if all
// provided tabs are pinned and therefore cannot be grouped.
if (!group.tabs.length) {
group.remove();
return null;
}
if (isUserTriggered) {
group.dispatchEvent(
new CustomEvent("TabGroupCreateByUser", {
bubbles: true,
detail: {
telemetryUserCreateSource,
},
})
);
}
// Fixes bug1953801 and bug1954689
// Ensure that the tab state cache is updated immediately after creating
// a group. This is necessary because we consider group creation a
// deliberate user action indicating the tab has importance for the user.
// Without this, it is not possible to save and close a tab group with
// a short lifetime.
group.tabs.forEach(tab => {
this.TabStateFlusher.flush(tab.linkedBrowser);
});
return group;
}
/**
* Removes the tab group. This has the effect of closing all the tabs
* in the group.
*
* @param {MozTabbrowserTabGroup} [group]
* The tab group to remove.
* @param {object} [options]
* Options to use when removing tabs. @see removeTabs for more info.
* @param {boolean} [options.isUserTriggered=false]
* Should be true if this group is being removed by an explicit
* request from the user (as opposed to a group being removed
* for technical reasons, such as when an already existing group
* switches windows). This causes telemetry events to fire.
* @param {string} [options.telemetrySource="unknown"]
* The means by which the tab group was removed.
* @see TabMetrics.METRIC_SOURCE for possible values.
* Defaults to "unknown".
*/
async removeTabGroup(
group,
options = {
isUserTriggered: false,
telemetrySource: this.TabMetrics.METRIC_SOURCE.UNKNOWN,
}
) {
if (this.tabGroupMenu.panel.state != "closed") {
this.tabGroupMenu.panel.hidePopup(options.animate);
}
if (!options.skipPermitUnload) {
// Process permit unload handlers and allow user cancel
let cancel = await this.runBeforeUnloadForTabs(group.tabs);
if (cancel) {
if (SessionStore.getSavedTabGroup(group.id)) {
// If this group is currently saved, it's being removed as part of a
// save & close operation. We need to forget the saved group
// if the close is canceled.
SessionStore.forgetSavedTabGroup(group.id);
}
return;
}
options.skipPermitUnload = true;
}
if (group.tabs.length == this.tabs.length) {
// explicit calls to removeTabGroup are not expected to save groups.
// if removing this group closes a window, we need to tell the window
// not to save the group.
group.saveOnWindowClose = false;
}
// This needs to be fired before tabs are removed because session store
// needs to respond to this while tabs are still part of the group
group.dispatchEvent(
new CustomEvent("TabGroupRemoveRequested", {
bubbles: true,
detail: {
skipSessionStore: options.skipSessionStore,
isUserTriggered: options.isUserTriggered,
telemetrySource: options.telemetrySource,
},
})
);
// Skip session store on a per-tab basis since these tabs will get
// recorded as part of a group
options.skipSessionStore = true;
// tell removeTabs not to subprocess groups since we're removing a group.
options.skipGroupCheck = true;
this.removeTabs(group.tabs, options);
}
/**
* Removes a tab from a group. This has no effect on tabs that are not
* already in a group.
*
* @param tab The tab to ungroup
*/
ungroupTab(tab) {
if (!tab.group) {
return;
}
this.#handleTabMove(tab, () =>
gBrowser.tabContainer.insertBefore(tab, tab.group.nextElementSibling)
);
}
/**
* @param {MozTabbrowserTabGroup} group
* @param {object} [options]
* @param {number} [options.elementIndex]
* @param {number} [options.tabIndex]
* @param {boolean} [options.selectTab]
* @returns {MozTabbrowserTabGroup}
*/
adoptTabGroup(group, { elementIndex, tabIndex, selectTab } = {}) {
if (group.ownerDocument == document) {
return group;
}
group.removedByAdoption = true;
group.saveOnWindowClose = false;
let oldSelectedTab = selectTab && group.ownerGlobal.gBrowser.selectedTab;
let newTabs = [];
// bug1969925 adopting a tab group will cause the window to close if it
// is the only thing on the tab strip
// In this case, the `TabUngrouped` event will not fire, so we have to do it manually
let noOtherTabsInWindow = group.ownerGlobal.gBrowser.nonHiddenTabs.every(
t => t.group == group
);
for (let tab of group.tabs) {
if (noOtherTabsInWindow) {
group.dispatchEvent(
new CustomEvent("TabUngrouped", {
bubbles: true,
detail: tab,
})
);
}
let adoptedTab = this.adoptTab(tab, {
elementIndex,
tabIndex,
selectTab: tab === oldSelectedTab,
});
newTabs.push(adoptedTab);
// Put next tab after current one.
elementIndex = undefined;
tabIndex = adoptedTab._tPos + 1;
}
return this.addTabGroup(newTabs, {
id: group.id,
label: group.label,
color: group.color,
insertBefore: newTabs[0],
isAdoptingGroup: true,
});
}
getAllTabGroups({ sortByLastSeenActive = false } = {}) {
let groups = BrowserWindowTracker.getOrderedWindows({
private: PrivateBrowsingUtils.isWindowPrivate(window),
}).reduce(
(acc, thisWindow) => acc.concat(thisWindow.gBrowser.tabGroups),
[]
);
if (sortByLastSeenActive) {
groups.sort(
(group1, group2) => group2.lastSeenActive - group1.lastSeenActive
);
}
return groups;
}
getTabGroupById(id) {
for (const win of BrowserWindowTracker.getOrderedWindows({
private: PrivateBrowsingUtils.isWindowPrivate(window),
})) {
for (const group of win.gBrowser.tabGroups) {
if (group.id === id) {
return group;
}
}
}
return null;
}
_determineURIToLoad(uriString, createLazyBrowser) {
uriString = uriString || "about:blank";
let aURIObject = null;
try {
aURIObject = Services.io.newURI(uriString);
} catch (ex) {
/* we'll try to fix up this URL later */
}
let lazyBrowserURI;
if (createLazyBrowser && uriString != "about:blank") {
lazyBrowserURI = aURIObject;
uriString = "about:blank";
}
let uriIsAboutBlank = uriString == "about:blank";
return { uri: aURIObject, uriIsAboutBlank, lazyBrowserURI, uriString };
}
/**
* @param {object} options
* @returns {MozTabbrowserTab}
*/
_createTab({
uriString,
userContextId,
openerTab,
pinned,
noInitialLabel,
skipBackgroundNotify,
animate,
}) {
var t = document.createXULElement("tab", { is: "tabbrowser-tab" });
// Tag the tab as being created so extension code can ignore events
// prior to TabOpen.
t.initializingTab = true;
t.openerTab = openerTab;
// Related tab inherits current tab's user context unless a different
// usercontextid is specified
if (userContextId == null && openerTab) {
userContextId = openerTab.getAttribute("usercontextid") || 0;
}
if (!noInitialLabel) {
if (isBlankPageURL(uriString)) {
t.setAttribute("label", this.tabContainer.emptyTabTitle);
} else {
// Set URL as label so that the tab isn't empty initially.
this.setInitialTabTitle(t, uriString, {
beforeTabOpen: true,
isURL: true,
});
}
}
if (userContextId) {
t.setAttribute("usercontextid", userContextId);
ContextualIdentityService.setTabStyle(t);
}
if (skipBackgroundNotify) {
t.setAttribute("skipbackgroundnotify", true);
}
if (pinned) {
t.setAttribute("pinned", "true");
}
t.classList.add("tabbrowser-tab");
this.tabContainer._unlockTabSizing();
if (!animate) {
UserInteraction.update("browser.tabs.opening", "not-animated", window);
t.setAttribute("fadein", "true");
// Call _handleNewTab asynchronously as it needs to know if the
// new tab is selected.
setTimeout(
function (tabContainer) {
tabContainer._handleNewTab(t);
},
0,
this.tabContainer
);
} else {
UserInteraction.update("browser.tabs.opening", "animated", window);
}
return t;
}
_createBrowserForTab(
tab,
{
uriString,
uri,
name,
preferredRemoteType,
openerBrowser,
uriIsAboutBlank,
referrerInfo,
forceNotRemote,
initialBrowsingContextGroupId,
openWindowInfo,
skipLoad,
triggeringRemoteType,
}
) {
// If we don't have a preferred remote type (or it is `NOT_REMOTE`), and
// we have a remote triggering remote type, use that instead.
if (!preferredRemoteType && triggeringRemoteType) {
preferredRemoteType = triggeringRemoteType;
}
// If we don't have a preferred remote type, and we have a remote
// opener, use the opener's remote type.
if (!preferredRemoteType && openerBrowser) {
preferredRemoteType = openerBrowser.remoteType;
}
let { userContextId } = tab;
var oa = E10SUtils.predictOriginAttributes({ window, userContextId });
// If URI is about:blank and we don't have a preferred remote type,
// then we need to use the referrer, if we have one, to get the
// correct remote type for the new tab.
if (
uriIsAboutBlank &&
!preferredRemoteType &&
referrerInfo &&
referrerInfo.originalReferrer
) {
preferredRemoteType = E10SUtils.getRemoteTypeForURI(
referrerInfo.originalReferrer.spec,
gMultiProcessBrowser,
gFissionBrowser,
E10SUtils.DEFAULT_REMOTE_TYPE,
null,
oa
);
}
let remoteType = forceNotRemote
? E10SUtils.NOT_REMOTE
: E10SUtils.getRemoteTypeForURI(
uriString,
gMultiProcessBrowser,
gFissionBrowser,
preferredRemoteType,
null,
oa
);
let b,
usingPreloadedContent = false;
// If we open a new tab with the newtab URL in the default
// userContext, check if there is a preloaded browser ready.
if (uriString == BROWSER_NEW_TAB_URL && !userContextId) {
b = NewTabPagePreloading.getPreloadedBrowser(window);
if (b) {
usingPreloadedContent = true;
}
}
if (!b) {
// No preloaded browser found, create one.
b = this.createBrowser({
remoteType,
uriIsAboutBlank,
userContextId,
initialBrowsingContextGroupId,
openWindowInfo,
name,
skipLoad,
});
}
tab.linkedBrowser = b;
this._tabForBrowser.set(b, tab);
tab.permanentKey = b.permanentKey;
tab._browserParams = {
uriIsAboutBlank,
remoteType,
usingPreloadedContent,
};
// Hack to ensure that the about:newtab, and about:welcome favicon is loaded
// instantaneously, to avoid flickering and improve perceived performance.
this.setDefaultIcon(tab, uri);
return { browser: b, usingPreloadedContent };
}
_kickOffBrowserLoad(
browser,
{
uri,
uriString,
usingPreloadedContent,
triggeringPrincipal,
originPrincipal,
originStoragePrincipal,
uriIsAboutBlank,
allowInheritPrincipal,
allowThirdPartyFixup,
fromExternal,
disableTRR,
forceAllowDataURI,
skipLoad,
referrerInfo,
charset,
postData,
csp,
globalHistoryOptions,
triggeringRemoteType,
schemelessInput,
hasValidUserGestureActivation,
textDirectiveUserActivation,
}
) {
if (
!usingPreloadedContent &&
originPrincipal &&
originStoragePrincipal &&
uriString
) {
let { URI_INHERITS_SECURITY_CONTEXT } = Ci.nsIProtocolHandler;
// Unless we know for sure we're not inheriting principals,
// force the about:blank viewer to have the right principal:
if (!uri || doGetProtocolFlags(uri) & URI_INHERITS_SECURITY_CONTEXT) {
browser.createAboutBlankDocumentViewer(
originPrincipal,
originStoragePrincipal
);
}
}
// If we didn't swap docShells with a preloaded browser
// then let's just continue loading the page normally.
if (
!usingPreloadedContent &&
(!uriIsAboutBlank || !allowInheritPrincipal) &&
!skipLoad
) {
// pretend the user typed this so it'll be available till
// the document successfully loads
if (uriString && !gInitialPages.includes(uriString)) {
browser.userTypedValue = uriString;
}
let loadFlags = LOAD_FLAGS_NONE;
if (allowThirdPartyFixup) {
loadFlags |=
LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP | LOAD_FLAGS_FIXUP_SCHEME_TYPOS;
}
if (fromExternal) {
loadFlags |= LOAD_FLAGS_FROM_EXTERNAL;
} else if (!triggeringPrincipal.isSystemPrincipal) {
// XXX this code must be reviewed and changed when bug 1616353
// lands.
loadFlags |= LOAD_FLAGS_FIRST_LOAD;
}
if (!allowInheritPrincipal) {
loadFlags |= LOAD_FLAGS_DISALLOW_INHERIT_PRINCIPAL;
}
if (disableTRR) {
loadFlags |= LOAD_FLAGS_DISABLE_TRR;
}
if (forceAllowDataURI) {
loadFlags |= LOAD_FLAGS_FORCE_ALLOW_DATA_URI;
}
try {
browser.fixupAndLoadURIString(uriString, {
loadFlags,
triggeringPrincipal,
referrerInfo,
charset,
postData,
csp,
globalHistoryOptions,
triggeringRemoteType,
schemelessInput,
hasValidUserGestureActivation,
textDirectiveUserActivation,
});
} catch (ex) {
console.error(ex);
}
}
}
/**
* @typedef {object} TabGroupWorkingData
* @property {TabGroupStateData} stateData
* @property {MozTabbrowserTabGroup|undefined} node
* @property {DocumentFragment} containingTabsFragment
*/
/**
* @param {boolean} restoreTabsLazily
* @param {number} selectTab see SessionStoreInternal.restoreTabs { aSelectTab }
* @param {TabStateData[]} tabDataList
* @param {TabGroupStateData[]} tabGroupDataList
* @returns {MozTabbrowserTab[]}
*/
createTabsForSessionRestore(
restoreTabsLazily,
selectTab,
tabDataList,
tabGroupDataList
) {
let tabs = [];
let tabsFragment = document.createDocumentFragment();
let tabToSelect = null;
let hiddenTabs = new Map();
/** @type {Map<TabGroupStateData['id'], TabGroupWorkingData>} */
let tabGroupWorkingData = new Map();
for (const tabGroupData of tabGroupDataList) {
tabGroupWorkingData.set(tabGroupData.id, {
stateData: tabGroupData,
node: undefined,
containingTabsFragment: document.createDocumentFragment(),
});
}
// We create each tab and browser, but only insert them
// into a document fragment so that we can insert them all
// together. This prevents synch reflow for each tab
// insertion.
for (var i = 0; i < tabDataList.length; i++) {
let tabData = tabDataList[i];
let userContextId = tabData.userContextId;
let select = i == selectTab - 1;
let tab;
let tabWasReused = false;
// Re-use existing selected tab if possible to avoid the overhead of
// selecting a new tab. For now, we only do this for horizontal tabs;
// we'll let tabs.js handle pinning for vertical tabs until we unify
// the logic for both horizontal and vertical tabs in bug 1910097.
if (
select &&
this.selectedTab.userContextId == userContextId &&
!SessionStore.isTabRestoring(this.selectedTab) &&
!this.tabContainer.verticalMode
) {
tabWasReused = true;
tab = this.selectedTab;
if (!tabData.pinned) {
this.unpinTab(tab);
} else {
this.pinTab(tab);
}
}
// Add a new tab if needed.
if (!tab) {
let createLazyBrowser =
restoreTabsLazily && !select && !tabData.pinned;
let url = "about:blank";
if (tabData.entries?.length) {
let activeIndex = (tabData.index || tabData.entries.length) - 1;
// Ensure the index is in bounds.
activeIndex = Math.min(activeIndex, tabData.entries.length - 1);
activeIndex = Math.max(activeIndex, 0);
url = tabData.entries[activeIndex].url;
}
let preferredRemoteType = E10SUtils.getRemoteTypeForURI(
url,
gMultiProcessBrowser,
gFissionBrowser,
E10SUtils.DEFAULT_REMOTE_TYPE,
null,
E10SUtils.predictOriginAttributes({ window, userContextId })
);
// If we're creating a lazy browser, let tabbrowser know the future
// URI because progress listeners won't get onLocationChange
// notification before the browser is inserted.
//
// Setting noInitialLabel is a perf optimization. Rendering tab labels
// would make resizing the tabs more expensive as we're adding them.
// Each tab will get its initial label set in restoreTab.
tab = this.addTrustedTab(createLazyBrowser ? url : "about:blank", {
createLazyBrowser,
skipAnimation: true,
noInitialLabel: true,
userContextId,
skipBackgroundNotify: true,
bulkOrderedOpen: true,
insertTab: false,
skipLoad: true,
preferredRemoteType,
});
if (select) {
tabToSelect = tab;
}
}
tabs.push(tab);
if (tabData.pinned) {
this.pinTab(tab);
// Then ensure all the tab open/pinning information is sent.
this._fireTabOpen(tab, {});
} else if (tabData.groupId) {
let { groupId } = tabData;
const tabGroup = tabGroupWorkingData.get(groupId);
// if a tab refers to a tab group we don't know, skip any group
// processing
if (tabGroup) {
tabGroup.containingTabsFragment.appendChild(tab);
// if this is the first time encountering a tab group, create its
// DOM node once and place it in the tabs bar fragment
if (!tabGroup.node) {
tabGroup.node = this._createTabGroup(
tabGroup.stateData.id,
tabGroup.stateData.color,
tabGroup.stateData.collapsed,
tabGroup.stateData.name
);
tabsFragment.appendChild(tabGroup.node);
}
}
} else {
if (tab.hidden) {
tab.hidden = true;
hiddenTabs.set(tab, tabData.extData && tabData.extData.hiddenBy);
}
tabsFragment.appendChild(tab);
if (tabWasReused) {
this.tabContainer._invalidateCachedTabs();
}
}
tab.initialize();
}
// inject the top-level tab and tab group DOM nodes
this.tabContainer.appendChild(tabsFragment);
// inject tab DOM nodes into the now-connected tab group DOM nodes
for (const tabGroup of tabGroupWorkingData.values()) {
if (tabGroup.node) {
tabGroup.node.appendChild(tabGroup.containingTabsFragment);
}
}
for (let [tab, hiddenBy] of hiddenTabs) {
let event = document.createEvent("Events");
event.initEvent("TabHide", true, false);
tab.dispatchEvent(event);
if (hiddenBy) {
SessionStore.setCustomTabValue(tab, "hiddenBy", hiddenBy);
}
}
this.tabContainer._invalidateCachedTabs();
// We need to wait until after all tabs have been appended to the DOM
// to remove the old selected tab.
if (tabToSelect) {
let leftoverTab = this.selectedTab;
this.selectedTab = tabToSelect;
this.removeTab(leftoverTab);
}
if (tabs.length > 1 || !tabs[0].selected) {
this._updateTabsAfterInsert();
TabBarVisibility.update();
for (let tab of tabs) {
// If tabToSelect is a tab, we didn't reuse the selected tab.
if (tabToSelect || !tab.selected) {
// Fire a TabOpen event for all unpinned tabs, except reused selected
// tabs.
if (!tab.pinned) {
this._fireTabOpen(tab, {});
}
// Fire a TabBrowserInserted event on all tabs that have a connected,
// real browser, except for reused selected tabs.
if (tab.linkedPanel) {
var evt = new CustomEvent("TabBrowserInserted", {
bubbles: true,
detail: { insertedOnTabCreation: true },
});
tab.dispatchEvent(evt);
}
}
}
}
return tabs;
}
moveTabsToStart(contextTab) {
let tabs = contextTab.multiselected ? this.selectedTabs : [contextTab];
// Walk the array in reverse order so the tabs are kept in order.
for (let i = tabs.length - 1; i >= 0; i--) {
this.moveTabToStart(tabs[i]);
}
}
moveTabsToEnd(contextTab) {
let tabs = contextTab.multiselected ? this.selectedTabs : [contextTab];
for (let tab of tabs) {
this.moveTabToEnd(tab);
}
}
warnAboutClosingTabs(tabsToClose, aCloseTabs) {
// We want to warn about closing duplicates even if there was only a
// single duplicate, so we intentionally place this above the check for
// tabsToClose <= 1.
const shownDupeDialogPref =
"browser.tabs.haveShownCloseAllDuplicateTabsWarning";
var ps = Services.prompt;
if (
aCloseTabs == this.closingTabsEnum.ALL_DUPLICATES &&
!Services.prefs.getBoolPref(shownDupeDialogPref, false)
) {
// The first time a user closes all duplicate tabs, tell them what will
// happen and give them a chance to back away.
Services.prefs.setBoolPref(shownDupeDialogPref, true);
window.focus();
const [title, text, button] = this.tabLocalization.formatValuesSync([
{ id: "tabbrowser-confirm-close-all-duplicate-tabs-title" },
{ id: "tabbrowser-confirm-close-all-duplicate-tabs-text" },
{
id: "tabbrowser-confirm-close-all-duplicate-tabs-button-closetabs",
},
]);
const flags =
ps.BUTTON_POS_0 * ps.BUTTON_TITLE_IS_STRING +
ps.BUTTON_POS_1 * ps.BUTTON_TITLE_CANCEL +
ps.BUTTON_POS_0_DEFAULT;
// buttonPressed will be 0 for close tabs, 1 for cancel.
const buttonPressed = ps.confirmEx(
window,
title,
text,
flags,
button,
null,
null,
null,
{}
);
return buttonPressed == 0;
}
if (tabsToClose <= 1) {
return true;
}
const pref =
aCloseTabs == this.closingTabsEnum.ALL
? "browser.tabs.warnOnClose"
: "browser.tabs.warnOnCloseOtherTabs";
var shouldPrompt = Services.prefs.getBoolPref(pref);
if (!shouldPrompt) {
return true;
}
const maxTabsUndo = Services.prefs.getIntPref(
"browser.sessionstore.max_tabs_undo"
);
if (
aCloseTabs != this.closingTabsEnum.ALL &&
tabsToClose <= maxTabsUndo
) {
return true;
}
// Our prompt to close this window is most important, so replace others.
gDialogBox.replaceDialogIfOpen();
// default to true: if it were false, we wouldn't get this far
var warnOnClose = { value: true };
// focus the window before prompting.
// this will raise any minimized window, which will
// make it obvious which window the prompt is for and will
// solve the problem of windows "obscuring" the prompt.
// see bug #350299 for more details
window.focus();
const [title, button, checkbox] = this.tabLocalization.formatValuesSync([
{
id: "tabbrowser-confirm-close-tabs-title",
args: { tabCount: tabsToClose },
},
{ id: "tabbrowser-confirm-close-tabs-button" },
{ id: "tabbrowser-ask-close-tabs-checkbox" },
]);
let flags =
ps.BUTTON_TITLE_IS_STRING * ps.BUTTON_POS_0 +
ps.BUTTON_TITLE_CANCEL * ps.BUTTON_POS_1;
let checkboxLabel =
aCloseTabs == this.closingTabsEnum.ALL ? checkbox : null;
var buttonPressed = ps.confirmEx(
window,
title,
null,
flags,
button,
null,
null,
checkboxLabel,
warnOnClose
);
var reallyClose = buttonPressed == 0;
// don't set the pref unless they press OK and it's false
if (
aCloseTabs == this.closingTabsEnum.ALL &&
reallyClose &&
!warnOnClose.value
) {
Services.prefs.setBoolPref(pref, false);
}
return reallyClose;
}
/**
* This determines where the tab should be inserted within the tabContainer,
* and inserts it.
*
* @param {MozTabbrowserTab} tab
* @param {object} [options]
* @param {number} [options.elementIndex]
* @param {number} [options.tabIndex]
* @param {MozTabbrowserTabGroup} [options.tabGroup]
* A related tab group where this tab should be added, when applicable.
*/
#insertTabAtIndex(
tab,
{
tabIndex,
elementIndex,
ownerTab,
openerTab,
pinned,
bulkOrderedOpen,
tabGroup,
} = {}
) {
// If this new tab is owned by another, assert that relationship
if (ownerTab) {
tab.owner = ownerTab;
}
// Ensure we have an index if one was not provided.
if (typeof elementIndex != "number" && typeof tabIndex != "number") {
// Move the new tab after another tab if needed, to the end otherwise.
elementIndex = Infinity;
if (
!bulkOrderedOpen &&
((openerTab &&
Services.prefs.getBoolPref(
"browser.tabs.insertRelatedAfterCurrent"
)) ||
Services.prefs.getBoolPref("browser.tabs.insertAfterCurrent"))
) {
let lastRelatedTab =
openerTab && this._lastRelatedTabMap.get(openerTab);
let previousTab = lastRelatedTab || openerTab || this.selectedTab;
if (!tabGroup) {
tabGroup = previousTab.group;
}
if (
Services.prefs.getBoolPref(
"browser.tabs.insertAfterCurrentExceptPinned"
) &&
previousTab.pinned
) {
elementIndex = Infinity;
} else if (previousTab.visible) {
elementIndex = previousTab.elementIndex + 1;
} else if (previousTab == FirefoxViewHandler.tab) {
elementIndex = 0;
}
if (lastRelatedTab) {
lastRelatedTab.owner = null;
} else if (openerTab) {
tab.owner = openerTab;
}
// Always set related map if opener exists.
if (openerTab) {
this._lastRelatedTabMap.set(openerTab, tab);
}
}
}
let allItems;
let index;
if (typeof elementIndex == "number") {
allItems = this.tabContainer.ariaFocusableItems;
index = elementIndex;
} else {
allItems = this.tabs;
index = tabIndex;
}
// Ensure index is within bounds.
if (tab.pinned) {
index = Math.max(index, 0);
index = Math.min(index, this.pinnedTabCount);
} else {
index = Math.max(index, this.pinnedTabCount);
index = Math.min(index, allItems.length);
}
/** @type {MozTabbrowserTab|undefined} */
let itemAfter = allItems.at(index);
// Prevent a flash of unstyled content by setting up the tab content
// and inherited attributes before appending it (see Bug 1592054):
tab.initialize();
this.tabContainer._invalidateCachedTabs();
if (tabGroup) {
if (this.isTab(itemAfter) && itemAfter.group == tabGroup) {
// Place at the front of, or between tabs in, the same tab group
this.tabContainer.insertBefore(tab, itemAfter);
} else {
// Place tab at the end of the contextual tab group because one of:
// 1) no `itemAfter` so `tab` should be the last tab in the tab strip
// 2) `itemAfter` is in a different tab group
tabGroup.appendChild(tab);
}
} else if (
(this.isTab(itemAfter) && itemAfter.group?.tabs[0] == itemAfter) ||
this.isTabGroupLabel(itemAfter)
) {
// If there is ambiguity around whether or not a tab should be inserted
// into a group (i.e. because the new tab is being inserted on the
// edges of the group), prefer not to insert the tab into the group.
//
// We only need to handle the case where the tab is being inserted at
// the starting boundary of a group because `insertBefore` called on
// the tab just after a tab group will not add it to the group by
// default.
this.tabContainer.insertBefore(tab, itemAfter.group);
} else {
// Place ungrouped tab before `itemAfter` by default
this.tabContainer.insertBefore(tab, itemAfter);
}
this._updateTabsAfterInsert();
if (pinned) {
this._updateTabBarForPinnedTabs();
}
TabBarVisibility.update();
}
/**
* Dispatch a new tab event. This should be called when things are in a
* consistent state, such that listeners of this event can again open
* or close tabs.
*/
_fireTabOpen(tab, eventDetail) {
delete tab.initializingTab;
let evt = new CustomEvent("TabOpen", {
bubbles: true,
detail: eventDetail || {},
});
tab.dispatchEvent(evt);
}
/**
* @param {MozTabbrowserTab} aTab
* @returns {MozTabbrowserTab[]}
*/
_getTabsToTheStartFrom(aTab) {
let tabsToStart = [];
if (!aTab.visible) {
return tabsToStart;
}
let tabs = this.openTabs;
for (let i = 0; i < tabs.length; ++i) {
if (tabs[i] == aTab) {
break;
}
// Ignore pinned and hidden tabs.
if (tabs[i].pinned || tabs[i].hidden) {
continue;
}
// In a multi-select context, select all unselected tabs
// starting from the context tab.
if (aTab.multiselected && tabs[i].multiselected) {
continue;
}
tabsToStart.push(tabs[i]);
}
return tabsToStart;
}
/**
* @param {MozTabbrowserTab} aTab
* @returns {MozTabbrowserTab[]}
*/
_getTabsToTheEndFrom(aTab) {
let tabsToEnd = [];
if (!aTab.visible) {
return tabsToEnd;
}
let tabs = this.openTabs;
for (let i = tabs.length - 1; i >= 0; --i) {
if (tabs[i] == aTab) {
break;
}
// Ignore pinned and hidden tabs.
if (tabs[i].pinned || tabs[i].hidden) {
continue;
}
// In a multi-select context, select all unselected tabs
// starting from the context tab.
if (aTab.multiselected && tabs[i].multiselected) {
continue;
}
tabsToEnd.push(tabs[i]);
}
return tabsToEnd;
}
getDuplicateTabsToClose(aTab) {
// One would think that a set is better, but it would need to copy all
// the strings instead of just keeping references to the nsIURI objects,
// and the array is presumed to be small anyways.
let keys = [];
let keyForTab = tab => {
let uri = tab.linkedBrowser?.currentURI;
if (!uri) {
return null;
}
return {
uri,
userContextId: tab.userContextId,
};
};
let keyEquals = (a, b) => {
return a.userContextId == b.userContextId && a.uri.equals(b.uri);
};
if (aTab.multiselected) {
for (let tab of this.selectedTabs) {
let key = keyForTab(tab);
if (key) {
keys.push(key);
}
}
} else {
let key = keyForTab(aTab);
if (key) {
keys.push(key);
}
}
if (!keys.length) {
return [];
}
let duplicateTabs = [];
for (let tab of this.tabs) {
if (tab == aTab || tab.pinned) {
continue;
}
if (aTab.multiselected && tab.multiselected) {
continue;
}
let key = keyForTab(tab);
if (key && keys.some(k => keyEquals(k, key))) {
duplicateTabs.push(tab);
}
}
return duplicateTabs;
}
getAllDuplicateTabsToClose() {
let lastSeenTabs = this.tabs.toSorted(
(a, b) => b.lastSeenActive - a.lastSeenActive
);
let duplicateTabs = [];
let keys = [];
for (let tab of lastSeenTabs) {
const uri = tab.linkedBrowser?.currentURI;
if (!uri) {
// Can't tell if it's a duplicate without a URI.
// Safest to leave it be.
continue;
}
const key = {
uri,
userContextId: tab.userContextId,
};
if (
!tab.pinned &&
keys.some(
k => k.userContextId == key.userContextId && k.uri.equals(key.uri)
)
) {
duplicateTabs.push(tab);
}
keys.push(key);
}
return duplicateTabs;
}
removeDuplicateTabs(aTab, options) {
this._removeDuplicateTabs(
aTab,
this.getDuplicateTabsToClose(aTab),
this.closingTabsEnum.DUPLICATES,
options
);
}
_removeDuplicateTabs(aConfirmationAnchor, tabs, aCloseTabs, options) {
if (!tabs.length) {
return;
}
if (!this.warnAboutClosingTabs(tabs.length, aCloseTabs)) {
return;
}
this.removeTabs(tabs, options);
ConfirmationHint.show(
aConfirmationAnchor,
"confirmation-hint-duplicate-tabs-closed",
{ l10nArgs: { tabCount: tabs.length } }
);
}
removeAllDuplicateTabs() {
// I would like to have the caller provide this target,
// but the caller lives in a different document.
let alltabsButton = document.getElementById("alltabs-button");
this._removeDuplicateTabs(
alltabsButton,
this.getAllDuplicateTabsToClose(),
this.closingTabsEnum.ALL_DUPLICATES
);
}
/**
* In a multi-select context, the tabs (except pinned tabs) that are located to the
* left of the leftmost selected tab will be removed.
*/
removeTabsToTheStartFrom(aTab, options) {
let tabs = this._getTabsToTheStartFrom(aTab);
if (
!this.warnAboutClosingTabs(tabs.length, this.closingTabsEnum.TO_START)
) {
return;
}
this.removeTabs(tabs, options);
}
/**
* In a multi-select context, the tabs (except pinned tabs) that are located to the
* right of the rightmost selected tab will be removed.
*/
removeTabsToTheEndFrom(aTab, options) {
let tabs = this._getTabsToTheEndFrom(aTab);
if (
!this.warnAboutClosingTabs(tabs.length, this.closingTabsEnum.TO_END)
) {
return;
}
this.removeTabs(tabs, options);
}
/**
* Remove all tabs but `aTab`. By default, in a multi-select context, all
* unpinned and unselected tabs are removed. Otherwise all unpinned tabs
* except aTab are removed. This behavior can be changed using the the bool
* flags below.
*
* @param {MozTabbrowserTab} aTab
* The tab we will skip removing
* @param {object} [aParams]
* An optional set of parameters that will be passed to the
* `removeTabs` function.
* @param {boolean} [aParams.skipWarnAboutClosingTabs=false]
* Skip showing the tab close warning prompt.
* @param {boolean} [aParams.skipPinnedOrSelectedTabs=true]
* Skip closing tabs that are selected or pinned.
*/
removeAllTabsBut(aTab, aParams = {}) {
let {
skipWarnAboutClosingTabs = false,
skipPinnedOrSelectedTabs = true,
} = aParams;
/** @type {function(MozTabbrowserTab):boolean} */
let filterFn;
// If enabled also filter by selected or pinned state.
if (skipPinnedOrSelectedTabs) {
if (aTab?.multiselected) {
filterFn = tab => !tab.multiselected && !tab.pinned && !tab.hidden;
} else {
filterFn = tab => tab != aTab && !tab.pinned && !tab.hidden;
}
} else {
// Exclude just aTab from being removed.
filterFn = tab => tab != aTab;
}
let tabsToRemove = this.openTabs.filter(filterFn);
// If enabled show the tab close warning.
if (
!skipWarnAboutClosingTabs &&
!this.warnAboutClosingTabs(
tabsToRemove.length,
this.closingTabsEnum.OTHER
)
) {
return;
}
this.removeTabs(tabsToRemove, aParams);
}
removeMultiSelectedTabs({ isUserTriggered, telemetrySource } = {}) {
let selectedTabs = this.selectedTabs;
if (
!this.warnAboutClosingTabs(
selectedTabs.length,
this.closingTabsEnum.MULTI_SELECTED
)
) {
return;
}
this.removeTabs(selectedTabs, { isUserTriggered, telemetrySource });
}
/**
* @typedef {object} _startRemoveTabsReturnValue
* @property {Promise<void>} beforeUnloadComplete
* A promise that is resolved once all the beforeunload handlers have been
* called.
* @property {object[]} tabsWithBeforeUnloadPrompt
* An array of tabs with unload prompts that need to be handled.
* @property {object} [lastToClose]
* The last tab to be closed, if appropriate.
*/
/**
* Starts to remove tabs from the UI: checking for beforeunload handlers,
* closing tabs where possible and triggering running of the unload handlers.
*
* @param {object[]} tabs
* The set of tabs to remove.
* @param {object} options
* @param {boolean} options.animate
* Whether or not to animate closing.
* @param {boolean} options.suppressWarnAboutClosingWindow
* This will supress the warning about closing a window with the last tab.
* @param {boolean} options.skipPermitUnload
* Skips the before unload checks for the tabs. Only set this to true when
* using it in tandem with `runBeforeUnloadForTabs`.
* @param {boolean} options.skipRemoves
* Skips actually removing the tabs. The beforeunload handlers still run.
* @param {boolean} options.skipSessionStore
* If true, don't record the closed tabs in SessionStore.
* @returns {_startRemoveTabsReturnValue}
*/
_startRemoveTabs(
tabs,
{
animate,
// See bug 1883051
// eslint-disable-next-line no-unused-vars
suppressWarnAboutClosingWindow,
skipPermitUnload,
skipRemoves,
skipSessionStore,
isUserTriggered,
telemetrySource,
}
) {
// Note: if you change any of the unload algorithm, consider also
// changing `runBeforeUnloadForTabs` above.
/** @type {MozTabbrowserTab[]} */
let tabsWithBeforeUnloadPrompt = [];
/** @type {MozTabbrowserTab[]} */
let tabsWithoutBeforeUnload = [];
/** @type {Promise<void>[]} */
let beforeUnloadPromises = [];
/** @type {MozTabbrowserTab|undefined} */
let lastToClose;
for (let tab of tabs) {
if (!skipRemoves) {
tab._closedInMultiselection = true;
}
if (!skipRemoves && tab.selected) {
lastToClose = tab;
let toBlurTo = this._findTabToBlurTo(lastToClose, tabs);
if (toBlurTo) {
this._getSwitcher().warmupTab(toBlurTo);
}
} else if (!skipPermitUnload && this._hasBeforeUnload(tab)) {
let timerId = Glean.browserTabclose.permitUnloadTime.start();
// We need to block while calling permitUnload() because it
// processes the event queue and may lead to another removeTab()
// call before permitUnload() returns.
tab._pendingPermitUnload = true;
beforeUnloadPromises.push(
// To save time, we first run the beforeunload event listeners in all
// content processes in parallel. Tabs that would have shown a prompt
// will be handled again later.
tab.linkedBrowser.asyncPermitUnload("dontUnload").then(
({ permitUnload }) => {
tab._pendingPermitUnload = false;
Glean.browserTabclose.permitUnloadTime.stopAndAccumulate(
timerId
);
if (tab.closing) {
// The tab was closed by the user while we were in permitUnload, don't
// attempt to close it a second time.
} else if (permitUnload) {
if (!skipRemoves) {
// OK to close without prompting, do it immediately.
this.removeTab(tab, {
animate,
prewarmed: true,
skipPermitUnload: true,
skipSessionStore,
});
}
} else {
// We will need to prompt, queue it so it happens sequentially.
tabsWithBeforeUnloadPrompt.push(tab);
}
},
err => {
console.error("error while calling asyncPermitUnload", err);
tab._pendingPermitUnload = false;
Glean.browserTabclose.permitUnloadTime.stopAndAccumulate(
timerId
);
}
)
);
} else {
tabsWithoutBeforeUnload.push(tab);
}
}
// Now that all the beforeunload IPCs have been sent to content processes,
// we can queue unload messages for all the tabs without beforeunload listeners.
// Doing this first would cause content process main threads to be busy and delay
// beforeunload responses, which would be user-visible.
if (!skipRemoves) {
for (let tab of tabsWithoutBeforeUnload) {
this.removeTab(tab, {
animate,
prewarmed: true,
skipPermitUnload,
skipSessionStore,
isUserTriggered,
telemetrySource,
});
}
}
return {
beforeUnloadComplete: Promise.all(beforeUnloadPromises),
tabsWithBeforeUnloadPrompt,
lastToClose,
};
}
/**
* Runs the before unload handler for the provided tabs, waiting for them
* to complete.
*
* This can be used in tandem with removeTabs to allow any before unload
* prompts to happen before any tab closures. This should only be used
* in the case where any prompts need to happen before other items before
* the actual tabs are closed.
*
* When using this function alongside removeTabs, specify the `skipUnload`
* option to removeTabs.
*
* @param {object[]} tabs
* An array of tabs to remove.
* @returns {Promise<boolean>}
* Returns true if the unload has been blocked by the user. False if tabs
* may be subsequently closed.
*/
async runBeforeUnloadForTabs(tabs) {
try {
let { beforeUnloadComplete, tabsWithBeforeUnloadPrompt } =
this._startRemoveTabs(tabs, {
animate: false,
suppressWarnAboutClosingWindow: false,
skipPermitUnload: false,
skipRemoves: true,
});
await beforeUnloadComplete;
// Now run again sequentially the beforeunload listeners that will result in a prompt.
for (let tab of tabsWithBeforeUnloadPrompt) {
tab._pendingPermitUnload = true;
let { permitUnload } = this.getBrowserForTab(tab).permitUnload();
tab._pendingPermitUnload = false;
if (!permitUnload) {
return true;
}
}
} catch (e) {
console.error(e);
}
return false;
}
/**
* Given an array of tabs, returns a tuple [groups, leftoverTabs] such that:
* - groups contains all groups whose tabs are a subset of the initial array
* - leftoverTabs contains the remaining tabs
* @param {Array} tabs list of tabs
* @returns {Array} a tuple where the first element is an array of groups
* and the second is an array of tabs
*/
#separateWholeGroups(tabs) {
/**
* Map of tab group to surviving tabs in the group.
* If any of the `tabs` to be removed belong to a tab group, keep track
* of how many tabs in the tab group will be left after removing `tabs`.
* For any tab group with 0 surviving tabs, we can know that that tab
* group will be removed as a consequence of removing these `tabs`.
* @type {Map<MozTabbrowserTabGroup, Set<MozTabbrowserTab>>}
*/
let tabGroupSurvivingTabs = new Map();
let wholeGroups = [];
for (let tab of tabs) {
if (tab.group) {
if (!tabGroupSurvivingTabs.has(tab.group)) {
tabGroupSurvivingTabs.set(tab.group, new Set(tab.group.tabs));
}
tabGroupSurvivingTabs.get(tab.group).delete(tab);
}
}
for (let [tabGroup, survivingTabs] of tabGroupSurvivingTabs.entries()) {
if (!survivingTabs.size) {
wholeGroups.push(tabGroup);
tabs = tabs.filter(t => !tabGroup.tabs.includes(t));
}
}
return [wholeGroups, tabs];
}
/**
* Removes multiple tabs from the tab browser.
*
* @param {MozTabbrowserTab[]} tabs
* The set of tabs to remove.
* @param {object} [options]
* @param {boolean} [options.animate]
* Whether or not to animate closing, defaults to true.
* @param {boolean} [options.suppressWarnAboutClosingWindow]
* This will supress the warning about closing a window with the last tab.
* @param {boolean} [options.skipPermitUnload]
* Skips the before unload checks for the tabs. Only set this to true when
* using it in tandem with `runBeforeUnloadForTabs`.
* @param {boolean} [options.skipSessionStore]
* If true, don't record the closed tabs in SessionStore.
* @param {boolean} [options.skipGroupCheck]
* Skip separate processing of whole tab groups from the set of tabs.
* Used by removeTabGroup.
* @param {boolean} [options.isUserTriggered]
* Whether or not the removal is the direct result of a user action.
* Used for telemetry.
* @param {string} [options.telemetrySource]
* The system, surface, or control the user used to take this action.
* @see TabMetrics.METRIC_SOURCE for possible values.
*/
removeTabs(
tabs,
{
animate = true,
suppressWarnAboutClosingWindow = false,
skipPermitUnload = false,
skipSessionStore = false,
skipGroupCheck = false,
isUserTriggered = false,
telemetrySource,
} = {}
) {
// When 'closeWindowWithLastTab' pref is enabled, closing all tabs
// can be considered equivalent to closing the window.
if (
this.tabs.length == tabs.length &&
Services.prefs.getBoolPref("browser.tabs.closeWindowWithLastTab")
) {
window.closeWindow(
true,
suppressWarnAboutClosingWindow ? null : window.warnAboutClosingWindow,
"close-last-tab"
);
return;
}
if (!skipSessionStore) {
SessionStore.resetLastClosedTabCount(window);
}
this._clearMultiSelectionLocked = true;
// Guarantee that _clearMultiSelectionLocked lock gets released.
try {
// If selection includes entire groups, we might want to save them
if (!skipGroupCheck) {
let [groups, leftoverTabs] = this.#separateWholeGroups(tabs);
groups.forEach(group => {
if (!skipSessionStore) {
group.save();
}
this.removeTabGroup(group, {
animate,
skipSessionStore,
skipPermitUnload,
isUserTriggered,
telemetrySource,
});
});
tabs = leftoverTabs;
}
let { beforeUnloadComplete, tabsWithBeforeUnloadPrompt, lastToClose } =
this._startRemoveTabs(tabs, {
animate,
suppressWarnAboutClosingWindow,
skipPermitUnload,
skipRemoves: false,
skipSessionStore,
isUserTriggered,
telemetrySource,
});
// Wait for all the beforeunload events to have been processed by content processes.
// The permitUnload() promise will, alas, not call its resolution
// callbacks after the browser window the promise lives in has closed,
// so we have to check for that case explicitly.
let done = false;
beforeUnloadComplete.then(() => {
done = true;
});
Services.tm.spinEventLoopUntilOrQuit(
"tabbrowser.js:removeTabs",
() => done || window.closed
);
if (!done) {
return;
}
let aParams = {
animate,
prewarmed: true,
skipPermitUnload,
skipSessionStore,
isUserTriggered,
telemetrySource,
};
// Now run again sequentially the beforeunload listeners that will result in a prompt.
for (let tab of tabsWithBeforeUnloadPrompt) {
this.removeTab(tab, aParams);
if (!tab.closing) {
// If we abort the closing of the tab.
tab._closedInMultiselection = false;
}
}
// Avoid changing the selected browser several times by removing it,
// if appropriate, lastly.
if (lastToClose) {
this.removeTab(lastToClose, aParams);
}
} catch (e) {
console.error(e);
}
this._clearMultiSelectionLocked = false;
this._avoidSingleSelectedTab();
}
removeCurrentTab(aParams) {
this.removeTab(this.selectedTab, aParams);
}
removeTab(
aTab,
{
animate,
triggeringEvent,
skipPermitUnload,
closeWindowWithLastTab,
prewarmed,
skipSessionStore,
isUserTriggered,
telemetrySource,
} = {}
) {
if (UserInteraction.running("browser.tabs.opening", window)) {
UserInteraction.finish("browser.tabs.opening", window);
}
// Telemetry stopwatches may already be running if removeTab gets
// called again for an already closing tab.
if (!aTab._closeTimeAnimTimerId && !aTab._closeTimeNoAnimTimerId) {
// Speculatevely start both stopwatches now. We'll cancel one of
// the two later depending on whether we're animating.
aTab._closeTimeAnimTimerId = Glean.browserTabclose.timeAnim.start();
aTab._closeTimeNoAnimTimerId = Glean.browserTabclose.timeNoAnim.start();
}
// Handle requests for synchronously removing an already
// asynchronously closing tab.
if (!animate && aTab.closing) {
this._endRemoveTab(aTab);
return;
}
let isVisibleTab = aTab.visible;
// We have to sample the tab width now, since _beginRemoveTab might
// end up modifying the DOM in such a way that aTab gets a new
// frame created for it (for example, by updating the visually selected
// state).
let tabWidth = window.windowUtils.getBoundsWithoutFlushing(aTab).width;
let isLastTab = this.#isLastTabInWindow(aTab);
if (
!this._beginRemoveTab(aTab, {
closeWindowFastpath: true,
skipPermitUnload,
closeWindowWithLastTab,
prewarmed,
skipSessionStore,
isUserTriggered,
telemetrySource,
})
) {
Glean.browserTabclose.timeAnim.cancel(aTab._closeTimeAnimTimerId);
aTab._closeTimeAnimTimerId = null;
Glean.browserTabclose.timeNoAnim.cancel(aTab._closeTimeNoAnimTimerId);
aTab._closeTimeNoAnimTimerId = null;
return;
}
let lockTabSizing =
!this.tabContainer.verticalMode &&
!aTab.pinned &&
isVisibleTab &&
aTab._fullyOpen &&
triggeringEvent?.inputSource == MouseEvent.MOZ_SOURCE_MOUSE &&
triggeringEvent?.target.closest(".tabbrowser-tab");
if (lockTabSizing) {
this.tabContainer._lockTabSizing(aTab, tabWidth);
} else {
this.tabContainer._unlockTabSizing();
}
if (
!animate /* the caller didn't opt in */ ||
gReduceMotion ||
isLastTab ||
aTab.pinned ||
!isVisibleTab ||
this.tabContainer.verticalMode ||
this._removingTabs.size >
3 /* don't want lots of concurrent animations */ ||
!aTab.hasAttribute(
"fadein"
) /* fade-in transition hasn't been triggered yet */ ||
tabWidth == 0 /* fade-in transition hasn't moved yet */
) {
// We're not animating, so we can cancel the animation stopwatch.
Glean.browserTabclose.timeAnim.cancel(aTab._closeTimeAnimTimerId);
aTab._closeTimeAnimTimerId = null;
this._endRemoveTab(aTab);
return;
}
// We're animating, so we can cancel the non-animation stopwatch.
Glean.browserTabclose.timeNoAnim.cancel(aTab._closeTimeNoAnimTimerId);
aTab._closeTimeNoAnimTimerId = null;
aTab.style.maxWidth = ""; // ensure that fade-out transition happens
aTab.removeAttribute("fadein");
aTab.removeAttribute("bursting");
setTimeout(
function (tab, tabbrowser) {
if (
tab.container &&
window.getComputedStyle(tab).maxWidth == "0.1px"
) {
console.assert(
false,
"Giving up waiting for the tab closing animation to finish (bug 608589)"
);
tabbrowser._endRemoveTab(tab);
}
},
3000,
aTab,
this
);
}
/**
* Returns `true` if `tab` is the last tab in this window. This logic is
* intended for cases like determining if a window should close due to `tab`
* being closed, therefore hidden tabs are not considered in this function.
*
* Note: must be called before `tab` is closed/closing.
*
* @param {MozTabbrowserTab} tab
* @returns {boolean}
*/
#isLastTabInWindow(tab) {
for (const otherTab of this.tabs) {
if (otherTab != tab && otherTab.isOpen && !otherTab.hidden) {
return false;
}
}
return true;
}
_hasBeforeUnload(aTab) {
let browser = aTab.linkedBrowser;
if (browser.isRemoteBrowser && browser.frameLoader) {
return browser.hasBeforeUnload;
}
return false;
}
_beginRemoveTab(
aTab,
{
adoptedByTab,
closeWindowWithLastTab,
closeWindowFastpath,
skipPermitUnload,
prewarmed,
skipSessionStore = false,
isUserTriggered,
telemetrySource,
} = {}
) {
if (aTab.closing || this._windowIsClosing) {
return false;
}
var browser = this.getBrowserForTab(aTab);
if (
!skipPermitUnload &&
!adoptedByTab &&
aTab.linkedPanel &&
!aTab._pendingPermitUnload &&
(!browser.isRemoteBrowser || this._hasBeforeUnload(aTab))
) {
if (!prewarmed) {
let blurTab = this._findTabToBlurTo(aTab);
if (blurTab) {
this.warmupTab(blurTab);
}
}
let timerId = Glean.browserTabclose.permitUnloadTime.start();
// We need to block while calling permitUnload() because it
// processes the event queue and may lead to another removeTab()
// call before permitUnload() returns.
aTab._pendingPermitUnload = true;
let { permitUnload } = browser.permitUnload();
aTab._pendingPermitUnload = false;
Glean.browserTabclose.permitUnloadTime.stopAndAccumulate(timerId);
// If we were closed during onbeforeunload, we return false now
// so we don't (try to) close the same tab again. Of course, we
// also stop if the unload was cancelled by the user:
if (aTab.closing || !permitUnload) {
return false;
}
}
this.tabContainer._invalidateCachedVisibleTabs();
// this._switcher would normally cover removing a tab from this
// cache, but we may not have one at this time.
let tabCacheIndex = this._tabLayerCache.indexOf(aTab);
if (tabCacheIndex != -1) {
this._tabLayerCache.splice(tabCacheIndex, 1);
}
// Delay hiding the the active tab if we're screen sharing.
// See Bug 1642747.
let screenShareInActiveTab =
aTab == this.selectedTab && aTab._sharingState?.webRTC?.screen;
if (!screenShareInActiveTab) {
this._blurTab(aTab);
}
var closeWindow = false;
var newTab = false;
if (this.#isLastTabInWindow(aTab)) {
closeWindow =
closeWindowWithLastTab != null
? closeWindowWithLastTab
: !window.toolbar.visible ||
Services.prefs.getBoolPref("browser.tabs.closeWindowWithLastTab");
if (closeWindow) {
// We've already called beforeunload on all the relevant tabs if we get here,
// so avoid calling it again:
window.skipNextCanClose = true;
}
// Closing the tab and replacing it with a blank one is notably slower
// than closing the window right away. If the caller opts in, take
// the fast path.
if (closeWindow && closeWindowFastpath && !this._removingTabs.size) {
// This call actually closes the window, unless the user
// cancels the operation. We are finished here in both cases.
this._windowIsClosing = window.closeWindow(
true,
window.warnAboutClosingWindow,
"close-last-tab"
);
return false;
}
newTab = true;
}
aTab._endRemoveArgs = [closeWindow, newTab];
// swapBrowsersAndCloseOther will take care of closing the window without animation.
if (closeWindow && adoptedByTab) {
// Remove the tab's filter and progress listener to avoid leaking.
if (aTab.linkedPanel) {
const filter = this._tabFilters.get(aTab);
browser.webProgress.removeProgressListener(filter);
const listener = this._tabListeners.get(aTab);
filter.removeProgressListener(listener);
listener.destroy();
this._tabListeners.delete(aTab);
this._tabFilters.delete(aTab);
}
return true;
}
if (!aTab._fullyOpen) {
// If the opening tab animation hasn't finished before we start closing the
// tab, decrement the animation count since _handleNewTab will not get called.
this.tabAnimationsInProgress--;
}
this.tabAnimationsInProgress++;
// Mute audio immediately to improve perceived speed of tab closure.
if (!adoptedByTab && aTab.hasAttribute("soundplaying")) {
// Don't persist the muted state as this wasn't a user action.
// This lets undo-close-tab return it to an unmuted state.
aTab.linkedBrowser.mute(true);
}
aTab.closing = true;
this._removingTabs.add(aTab);
this.tabContainer._invalidateCachedTabs();
// Invalidate hovered tab state tracking for this closing tab.
aTab._mouseleave();
if (newTab) {
this.addTrustedTab(BROWSER_NEW_TAB_URL, {
skipAnimation: true,
});
} else {
TabBarVisibility.update();
}
// Splice this tab out of any lines of succession before any events are
// dispatched.
this.replaceInSuccession(aTab, aTab.successor);
this.setSuccessor(aTab, null);
// We're committed to closing the tab now.
// Dispatch a notification.
// We dispatch it before any teardown so that event listeners can
// inspect the tab that's about to close.
let evt = new CustomEvent("TabClose", {
bubbles: true,
detail: {
adoptedBy: adoptedByTab,
skipSessionStore,
isUserTriggered,
telemetrySource,
},
});
aTab.dispatchEvent(evt);
if (this.tabs.length == 2) {
// We're closing one of our two open tabs, inform the other tab that its
// sibling is going away.
for (let tab of this.tabs) {
let bc = tab.linkedBrowser.browsingContext;
if (bc) {
bc.hasSiblings = false;
}
}
}
let notificationBox = this.readNotificationBox(browser);
notificationBox?._stack?.remove();
if (aTab.linkedPanel) {
if (!adoptedByTab && !gMultiProcessBrowser) {
// Prevent this tab from showing further dialogs, since we're closing it
browser.contentWindow.windowUtils.disableDialogs();
}
// Remove the tab's filter and progress listener.
const filter = this._tabFilters.get(aTab);
browser.webProgress.removeProgressListener(filter);
const listener = this._tabListeners.get(aTab);
filter.removeProgressListener(listener);
listener.destroy();
}
if (browser.registeredOpenURI && !adoptedByTab) {
let userContextId = browser.getAttribute("usercontextid") || 0;
this.UrlbarProviderOpenTabs.unregisterOpenTab(
browser.registeredOpenURI.spec,
userContextId,
aTab.group?.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
delete browser.registeredOpenURI;
}
// We are no longer the primary content area.
browser.removeAttribute("primary");
return true;
}
_endRemoveTab(aTab) {
if (!aTab || !aTab._endRemoveArgs) {
return;
}
var [aCloseWindow, aNewTab] = aTab._endRemoveArgs;
aTab._endRemoveArgs = null;
if (this._windowIsClosing) {
aCloseWindow = false;
aNewTab = false;
}
this.tabAnimationsInProgress--;
this._lastRelatedTabMap = new WeakMap();
// update the UI early for responsiveness
aTab.collapsed = true;
this._blurTab(aTab);
this._removingTabs.delete(aTab);
if (aCloseWindow) {
this._windowIsClosing = true;
for (let tab of this._removingTabs) {
this._endRemoveTab(tab);
}
} else if (!this._windowIsClosing) {
if (aNewTab) {
gURLBar.select();
}
}
// We're going to remove the tab and the browser now.
this._tabFilters.delete(aTab);
this._tabListeners.delete(aTab);
var browser = this.getBrowserForTab(aTab);
if (aTab.linkedPanel) {
// Because of the fact that we are setting JS properties on
// the browser elements, and we have code in place
// to preserve the JS objects for any elements that have
// JS properties set on them, the browser element won't be
// destroyed until the document goes away. So we force a
// cleanup ourselves.
// This has to happen before we remove the child since functions
// like `getBrowserContainer` expect the browser to be parented.
browser.destroy();
}
// Remove the tab ...
aTab.remove();
this.tabContainer._invalidateCachedTabs();
// ... and fix up the _tPos properties immediately.
for (let i = aTab._tPos; i < this.tabs.length; i++) {
this.tabs[i]._tPos = i;
}
if (!this._windowIsClosing) {
// update tab close buttons state
this.tabContainer._updateCloseButtons();
setTimeout(
function (tabs) {
tabs._lastTabClosedByMouse = false;
},
0,
this.tabContainer
);
}
// update tab positional properties and attributes
this.selectedTab._selected = true;
// Removing the panel requires fixing up selectedPanel immediately
// (see below), which would be hindered by the potentially expensive
// browser removal. So we remove the browser and the panel in two
// steps.
var panel = this.getPanel(browser);
// In the multi-process case, it's possible an asynchronous tab switch
// is still underway. If so, then it's possible that the last visible
// browser is the one we're in the process of removing. There's the
// risk of displaying preloaded browsers that are at the end of the
// deck if we remove the browser before the switch is complete, so
// we alert the switcher in order to show a spinner instead.
if (this._switcher) {
this._switcher.onTabRemoved(aTab);
}
// This will unload the document. An unload handler could remove
// dependant tabs, so it's important that the tabbrowser is now in
// a consistent state (tab removed, tab positions updated, etc.).
browser.remove();
// Release the browser in case something is erroneously holding a
// reference to the tab after its removal.
this._tabForBrowser.delete(aTab.linkedBrowser);
aTab.linkedBrowser = null;
panel.remove();
// closeWindow might wait an arbitrary length of time if we're supposed
// to warn about closing the window, so we'll just stop the tab close
// stopwatches here instead.
if (aTab._closeTimeAnimTimerId) {
Glean.browserTabclose.timeAnim.stopAndAccumulate(
aTab._closeTimeAnimTimerId
);
aTab._closeTimeAnimTimerId = null;
}
if (aTab._closeTimeNoAnimTimerId) {
Glean.browserTabclose.timeNoAnim.stopAndAccumulate(
aTab._closeTimeNoAnimTimerId
);
aTab._closeTimeNoAnimTimerId = null;
}
if (aCloseWindow) {
this._windowIsClosing = closeWindow(
true,
window.warnAboutClosingWindow,
"close-last-tab"
);
}
}
/**
* Closes all tabs matching the list of nsURIs.
* This does not close any tabs that have a beforeUnload prompt.
*
* @param {nsURI[]} urisToClose
* The set of uris to remove.
* @returns {number} The count of successfully closed tabs.
*/
async closeTabsByURI(urisToClose) {
let tabsToRemove = [];
for (let tab of this.tabs) {
let currentURI = tab.linkedBrowser.currentURI;
// Find any URI that matches the current tab's URI
const matchedIndex = urisToClose.findIndex(uriToClose =>
uriToClose.equals(currentURI)
);
if (matchedIndex > -1) {
tabsToRemove.push(tab);
}
}
let closedCount = 0;
if (tabsToRemove.length) {
const { beforeUnloadComplete, lastToClose } = this._startRemoveTabs(
tabsToRemove,
{
animate: false,
suppressWarnAboutClosingWindow: true,
skipPermitUnload: false,
skipRemoves: false,
skipSessionStore: false,
}
);
// Wait for the beforeUnload handlers to complete.
await beforeUnloadComplete;
closedCount = tabsToRemove.length - (lastToClose ? 1 : 0);
// _startRemoveTabs doesn't close the last tab in the window
// for this use case, we simply close it
if (lastToClose) {
this.removeTab(lastToClose);
closedCount++;
}
}
return closedCount;
}
async explicitUnloadTabs(tabs) {
let unloadBlocked = await this.runBeforeUnloadForTabs(tabs);
if (unloadBlocked) {
return;
}
let unloadSelectedTab = false;
let allTabsUnloaded = false;
if (tabs.some(tab => tab.selected)) {
// Unloading the currently selected tab.
// Need to select a different one before unloading.
// Avoid selecting any tab we're unloading now or
// any tab that is already unloaded.
unloadSelectedTab = true;
const tabsToExclude = tabs.concat(
this.tabContainer.allTabs.filter(tab => !tab.linkedPanel)
);
let newTab = this._findTabToBlurTo(this.selectedTab, tabsToExclude);
if (newTab) {
this.selectedTab = newTab;
} else {
allTabsUnloaded = true;
// all tabs are unloaded - show Firefox View if it's present, otherwise open a new tab
if (FirefoxViewHandler.tab || FirefoxViewHandler.button) {
FirefoxViewHandler.openTab("opentabs");
} else {
this.selectedTab = this.addTrustedTab(BROWSER_NEW_TAB_URL, {
skipAnimation: true,
});
}
}
}
let memoryUsageBeforeUnload = await getTotalMemoryUsage();
let timeBeforeUnload = performance.now();
let numberOfTabsUnloaded = 0;
await Promise.all(tabs.map(tab => this.prepareDiscardBrowser(tab)));
for (let tab of tabs) {
numberOfTabsUnloaded += this.discardBrowser(tab, true) ? 1 : 0;
}
let timeElapsed = Math.floor(performance.now() - timeBeforeUnload);
Glean.browserEngagement.tabExplicitUnload.record({
unload_selected_tab: unloadSelectedTab,
all_tabs_unloaded: allTabsUnloaded,
tabs_unloaded: numberOfTabsUnloaded,
memory_before: memoryUsageBeforeUnload,
memory_after: await getTotalMemoryUsage(),
time_to_unload_in_ms: timeElapsed,
});
}
/**
* Handles opening a new tab with mouse middleclick.
* @param node
* @param event
* The click event
*/
handleNewTabMiddleClick(node, event) {
// We should be using the disabled property here instead of the attribute,
// but some elements that this function is used with don't support it (e.g.
// menuitem).
if (node.getAttribute("disabled") == "true") {
return;
} // Do nothing
if (event.button == 1) {
BrowserCommands.openTab({ event });
// Stop the propagation of the click event, to prevent the event from being
// handled more than once.
// E.g. see https://bugzilla.mozilla.org/show_bug.cgi?id=1657992#c4
event.stopPropagation();
event.preventDefault();
}
}
/**
* Finds the tab that we will blur to if we blur aTab.
* @param {MozTabbrowserTab} aTab
* The tab we would blur
* @param {MozTabbrowserTab[]} [aExcludeTabs=[]]
* Tabs to exclude from our search (i.e., because they are being
* closed along with aTab)
*/
_findTabToBlurTo(aTab, aExcludeTabs = []) {
if (!aTab.selected) {
return null;
}
if (FirefoxViewHandler.tab) {
aExcludeTabs.push(FirefoxViewHandler.tab);
}
let excludeTabs = new Set(aExcludeTabs);
// If this tab has a successor, it should be selectable, since
// hiding or closing a tab removes that tab as a successor.
if (aTab.successor && !excludeTabs.has(aTab.successor)) {
return aTab.successor;
}
if (
aTab.owner?.visible &&
!excludeTabs.has(aTab.owner) &&
Services.prefs.getBoolPref("browser.tabs.selectOwnerOnClose")
) {
return aTab.owner;
}
// Try to find a remaining tab that comes after the given tab
let remainingTabs = Array.prototype.filter.call(
this.visibleTabs,
tab => !excludeTabs.has(tab)
);
let tab = this.tabContainer.findNextTab(aTab, {
direction: 1,
filter: _tab => remainingTabs.includes(_tab),
});
if (!tab) {
tab = this.tabContainer.findNextTab(aTab, {
direction: -1,
filter: _tab => remainingTabs.includes(_tab),
});
}
if (tab) {
return tab;
}
// If no qualifying visible tab was found, see if there is a tab in
// a collapsed tab group that could be selected.
let eligibleTabs = new Set(this.tabsInCollapsedTabGroups).difference(
excludeTabs
);
tab = this.tabContainer.findNextTab(aTab, {
direction: 1,
filter: _tab => eligibleTabs.has(_tab),
});
if (!tab) {
tab = this.tabContainer.findNextTab(aTab, {
direction: -1,
filter: _tab => eligibleTabs.has(_tab),
});
}
return tab;
}
_blurTab(aTab) {
this.selectedTab = this._findTabToBlurTo(aTab);
}
/**
* @returns {boolean}
* False if swapping isn't permitted, true otherwise.
*/
swapBrowsersAndCloseOther(aOurTab, aOtherTab) {
// Do not allow transfering a private tab to a non-private window
// and vice versa.
if (
PrivateBrowsingUtils.isWindowPrivate(window) !=
PrivateBrowsingUtils.isWindowPrivate(aOtherTab.ownerGlobal)
) {
return false;
}
// Do not allow transfering a useRemoteSubframes tab to a
// non-useRemoteSubframes window and vice versa.
if (gFissionBrowser != aOtherTab.ownerGlobal.gFissionBrowser) {
return false;
}
let ourBrowser = this.getBrowserForTab(aOurTab);
let otherBrowser = aOtherTab.linkedBrowser;
// Can't swap between chrome and content processes.
if (ourBrowser.isRemoteBrowser != otherBrowser.isRemoteBrowser) {
return false;
}
// Keep the userContextId if set on other browser
if (otherBrowser.hasAttribute("usercontextid")) {
ourBrowser.setAttribute(
"usercontextid",
otherBrowser.getAttribute("usercontextid")
);
}
// That's gBrowser for the other window, not the tab's browser!
var remoteBrowser = aOtherTab.ownerGlobal.gBrowser;
var isPending = aOtherTab.hasAttribute("pending");
let otherTabListener = remoteBrowser._tabListeners.get(aOtherTab);
let stateFlags = 0;
if (otherTabListener) {
stateFlags = otherTabListener.mStateFlags;
}
// Expedite the removal of the icon if it was already scheduled.
if (aOtherTab._soundPlayingAttrRemovalTimer) {
clearTimeout(aOtherTab._soundPlayingAttrRemovalTimer);
aOtherTab._soundPlayingAttrRemovalTimer = 0;
aOtherTab.removeAttribute("soundplaying");
remoteBrowser._tabAttrModified(aOtherTab, ["soundplaying"]);
}
// First, start teardown of the other browser. Make sure to not
// fire the beforeunload event in the process. Close the other
// window if this was its last tab.
if (
!remoteBrowser._beginRemoveTab(aOtherTab, {
adoptedByTab: aOurTab,
closeWindowWithLastTab: true,
})
) {
return false;
}
// If this is the last tab of the window, hide the window
// immediately without animation before the docshell swap, to avoid
// about:blank being painted.
let [closeWindow] = aOtherTab._endRemoveArgs;
if (closeWindow) {
let win = aOtherTab.ownerGlobal;
win.windowUtils.suppressAnimation(true);
// Only suppressing window animations isn't enough to avoid
// an empty content area being painted.
let baseWin = win.docShell.treeOwner.QueryInterface(Ci.nsIBaseWindow);
baseWin.visibility = false;
}
let modifiedAttrs = [];
if (aOtherTab.hasAttribute("muted")) {
aOurTab.toggleAttribute("muted", true);
aOurTab.muteReason = aOtherTab.muteReason;
// For non-lazy tabs, mute() must be called.
if (aOurTab.linkedPanel) {
ourBrowser.mute();
}
modifiedAttrs.push("muted");
}
if (aOtherTab.hasAttribute("undiscardable")) {
aOurTab.toggleAttribute("undiscardable", true);
modifiedAttrs.push("undiscardable");
}
if (aOtherTab.hasAttribute("soundplaying")) {
aOurTab.toggleAttribute("soundplaying", true);
modifiedAttrs.push("soundplaying");
}
if (aOtherTab.hasAttribute("usercontextid")) {
aOurTab.setUserContextId(aOtherTab.getAttribute("usercontextid"));
modifiedAttrs.push("usercontextid");
}
if (aOtherTab.hasAttribute("sharing")) {
aOurTab.setAttribute("sharing", aOtherTab.getAttribute("sharing"));
modifiedAttrs.push("sharing");
aOurTab._sharingState = aOtherTab._sharingState;
webrtcUI.swapBrowserForNotification(otherBrowser, ourBrowser);
}
if (aOtherTab.hasAttribute("pictureinpicture")) {
aOurTab.toggleAttribute("pictureinpicture", true);
modifiedAttrs.push("pictureinpicture");
let event = new CustomEvent("TabSwapPictureInPicture", {
detail: aOurTab,
});
aOtherTab.dispatchEvent(event);
}
if (otherBrowser.isDistinctProductPageVisit) {
ourBrowser.isDistinctProductPageVisit = true;
}
SitePermissions.copyTemporaryPermissions(otherBrowser, ourBrowser);
// Add a reference to the original registeredOpenURI to the closing
// tab so that events operating on the tab before close can reference it.
aOtherTab._originalRegisteredOpenURI = otherBrowser.registeredOpenURI;
// If the other tab is pending (i.e. has not been restored, yet)
// then do not switch docShells but retrieve the other tab's state
// and apply it to our tab.
if (isPending) {
// Tag tab so that the extension framework can ignore tab events that
// are triggered amidst the tab/browser restoration process
// (TabHide, TabPinned, TabUnpinned, "muted" attribute changes, etc.).
aOurTab.initializingTab = true;
delete ourBrowser._cachedCurrentURI;
SessionStore.setTabState(aOurTab, SessionStore.getTabState(aOtherTab));
delete aOurTab.initializingTab;
// Make sure to unregister any open URIs.
this._swapRegisteredOpenURIs(ourBrowser, otherBrowser);
} else {
// Workarounds for bug 458697
// Icon might have been set on DOMLinkAdded, don't override that.
if (!ourBrowser.mIconURL && otherBrowser.mIconURL) {
this.setIcon(aOurTab, otherBrowser.mIconURL);
}
var isBusy = aOtherTab.hasAttribute("busy");
if (isBusy) {
aOurTab.setAttribute("busy", "true");
modifiedAttrs.push("busy");
if (aOurTab.selected) {
this._isBusy = true;
}
}
this._swapBrowserDocShells(aOurTab, otherBrowser, stateFlags);
}
// Unregister the previously opened URI
if (otherBrowser.registeredOpenURI) {
let userContextId = otherBrowser.getAttribute("usercontextid") || 0;
this.UrlbarProviderOpenTabs.unregisterOpenTab(
otherBrowser.registeredOpenURI.spec,
userContextId,
aOtherTab.group?.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
delete otherBrowser.registeredOpenURI;
}
// Handle findbar data (if any)
let otherFindBar = aOtherTab._findBar;
if (otherFindBar && otherFindBar.findMode == otherFindBar.FIND_NORMAL) {
let oldValue = otherFindBar._findField.value;
let wasHidden = otherFindBar.hidden;
let ourFindBarPromise = this.getFindBar(aOurTab);
ourFindBarPromise.then(ourFindBar => {
if (!ourFindBar) {
return;
}
ourFindBar._findField.value = oldValue;
if (!wasHidden) {
ourFindBar.onFindCommand();
}
});
}
// Finish tearing down the tab that's going away.
if (closeWindow) {
aOtherTab.ownerGlobal.close();
} else {
remoteBrowser._endRemoveTab(aOtherTab);
}
this.setTabTitle(aOurTab);
// If the tab was already selected (this happens in the scenario
// of replaceTabWithWindow), notify onLocationChange, etc.
if (aOurTab.selected) {
this.updateCurrentBrowser(true);
}
if (modifiedAttrs.length) {
this._tabAttrModified(aOurTab, modifiedAttrs);
}
return true;
}
swapBrowsers(aOurTab, aOtherTab) {
let otherBrowser = aOtherTab.linkedBrowser;
let otherTabBrowser = otherBrowser.getTabBrowser();
// We aren't closing the other tab so, we also need to swap its tablisteners.
let filter = otherTabBrowser._tabFilters.get(aOtherTab);
let tabListener = otherTabBrowser._tabListeners.get(aOtherTab);
otherBrowser.webProgress.removeProgressListener(filter);
filter.removeProgressListener(tabListener);
// Perform the docshell swap through the common mechanism.
this._swapBrowserDocShells(aOurTab, otherBrowser);
// Restore the listeners for the swapped in tab.
tabListener = new otherTabBrowser.ownerGlobal.TabProgressListener(
aOtherTab,
otherBrowser,
false,
false
);
otherTabBrowser._tabListeners.set(aOtherTab, tabListener);
const notifyAll = Ci.nsIWebProgress.NOTIFY_ALL;
filter.addProgressListener(tabListener, notifyAll);
otherBrowser.webProgress.addProgressListener(filter, notifyAll);
}
_swapBrowserDocShells(aOurTab, aOtherBrowser, aStateFlags) {
// aOurTab's browser needs to be inserted now if it hasn't already.
this._insertBrowser(aOurTab);
// Unhook our progress listener
const filter = this._tabFilters.get(aOurTab);
let tabListener = this._tabListeners.get(aOurTab);
let ourBrowser = this.getBrowserForTab(aOurTab);
ourBrowser.webProgress.removeProgressListener(filter);
filter.removeProgressListener(tabListener);
// Make sure to unregister any open URIs.
this._swapRegisteredOpenURIs(ourBrowser, aOtherBrowser);
let remoteBrowser = aOtherBrowser.ownerGlobal.gBrowser;
// If switcher is active, it will intercept swap events and
// react as needed.
if (!this._switcher) {
aOtherBrowser.docShellIsActive =
this.shouldActivateDocShell(ourBrowser);
}
let ourBrowserContainer =
ourBrowser.ownerDocument.getElementById("browser");
let otherBrowserContainer =
aOtherBrowser.ownerDocument.getElementById("browser");
let ourBrowserContainerWasHidden = ourBrowserContainer.hidden;
let otherBrowserContainerWasHidden = otherBrowserContainer.hidden;
// #browser is hidden in Customize Mode; this breaks docshell swapping,
// so we need to toggle 'hidden' to make swapping work in this case.
ourBrowserContainer.hidden = otherBrowserContainer.hidden = false;
// Swap the docshells
ourBrowser.swapDocShells(aOtherBrowser);
ourBrowserContainer.hidden = ourBrowserContainerWasHidden;
otherBrowserContainer.hidden = otherBrowserContainerWasHidden;
// Swap permanentKey properties.
let ourPermanentKey = ourBrowser.permanentKey;
ourBrowser.permanentKey = aOtherBrowser.permanentKey;
aOtherBrowser.permanentKey = ourPermanentKey;
aOurTab.permanentKey = ourBrowser.permanentKey;
if (remoteBrowser) {
let otherTab = remoteBrowser.getTabForBrowser(aOtherBrowser);
if (otherTab) {
otherTab.permanentKey = aOtherBrowser.permanentKey;
}
}
// Restore the progress listener
tabListener = new TabProgressListener(
aOurTab,
ourBrowser,
false,
false,
aStateFlags
);
this._tabListeners.set(aOurTab, tabListener);
const notifyAll = Ci.nsIWebProgress.NOTIFY_ALL;
filter.addProgressListener(tabListener, notifyAll);
ourBrowser.webProgress.addProgressListener(filter, notifyAll);
}
_swapRegisteredOpenURIs(aOurBrowser, aOtherBrowser) {
// Swap the registeredOpenURI properties of the two browsers
let tmp = aOurBrowser.registeredOpenURI;
delete aOurBrowser.registeredOpenURI;
if (aOtherBrowser.registeredOpenURI) {
aOurBrowser.registeredOpenURI = aOtherBrowser.registeredOpenURI;
delete aOtherBrowser.registeredOpenURI;
}
if (tmp) {
aOtherBrowser.registeredOpenURI = tmp;
}
}
reloadMultiSelectedTabs() {
this.reloadTabs(this.selectedTabs);
}
reloadTabs(tabs) {
for (let tab of tabs) {
try {
this.getBrowserForTab(tab).reload();
} catch (e) {
// ignore failure to reload so others will be reloaded
}
}
}
reloadTab(aTab) {
let browser = this.getBrowserForTab(aTab);
// Reset temporary permissions on the current tab. This is done here
// because we only want to reset permissions on user reload.
SitePermissions.clearTemporaryBlockPermissions(browser);
// Also reset DOS mitigations for the basic auth prompt on reload.
delete browser.authPromptAbuseCounter;
gIdentityHandler.hidePopup();
gPermissionPanel.hidePopup();
browser.reload();
}
addProgressListener(aListener) {
if (arguments.length != 1) {
console.error(
"gBrowser.addProgressListener was " +
"called with a second argument, " +
"which is not supported. See bug " +
"608628. Call stack: ",
new Error().stack
);
}
this.mProgressListeners.push(aListener);
}
removeProgressListener(aListener) {
this.mProgressListeners = this.mProgressListeners.filter(
l => l != aListener
);
}
addTabsProgressListener(aListener) {
this.mTabsProgressListeners.push(aListener);
}
removeTabsProgressListener(aListener) {
this.mTabsProgressListeners = this.mTabsProgressListeners.filter(
l => l != aListener
);
}
getBrowserForTab(aTab) {
return aTab.linkedBrowser;
}
showTab(aTab) {
if (!aTab.hidden || aTab == FirefoxViewHandler.tab) {
return;
}
aTab.removeAttribute("hidden");
this.tabContainer._invalidateCachedVisibleTabs();
this.tabContainer._updateCloseButtons();
if (aTab.multiselected) {
this._updateMultiselectedTabCloseButtonTooltip();
}
let event = document.createEvent("Events");
event.initEvent("TabShow", true, false);
aTab.dispatchEvent(event);
SessionStore.deleteCustomTabValue(aTab, "hiddenBy");
}
hideTab(aTab, aSource) {
if (
aTab.hidden ||
aTab.pinned ||
aTab.selected ||
aTab.closing ||
// Tabs that are sharing the screen, microphone or camera cannot be hidden.
aTab._sharingState?.webRTC?.sharing
) {
return;
}
aTab.setAttribute("hidden", "true");
this.tabContainer._invalidateCachedVisibleTabs();
this.tabContainer._updateCloseButtons();
if (aTab.multiselected) {
this._updateMultiselectedTabCloseButtonTooltip();
}
// Splice this tab out of any lines of succession before any events are
// dispatched.
this.replaceInSuccession(aTab, aTab.successor);
this.setSuccessor(aTab, null);
let event = document.createEvent("Events");
event.initEvent("TabHide", true, false);
aTab.dispatchEvent(event);
if (aSource) {
SessionStore.setCustomTabValue(aTab, "hiddenBy", aSource);
}
}
selectTabAtIndex(aIndex, aEvent) {
let tabs = this.visibleTabs;
// count backwards for aIndex < 0
if (aIndex < 0) {
aIndex += tabs.length;
// clamp at index 0 if still negative.
if (aIndex < 0) {
aIndex = 0;
}
} else if (aIndex >= tabs.length) {
// clamp at right-most tab if out of range.
aIndex = tabs.length - 1;
}
this.selectedTab = tabs[aIndex];
if (aEvent) {
aEvent.preventDefault();
aEvent.stopPropagation();
}
}
/**
* Moves a tab to a new browser window, unless it's already the only tab
* in the current window, in which case this will do nothing.
*
* @param {MozTabbrowserTab|MozTabbrowserTabGroup|MozTabbrowserTabGroup.labelElement} aTab
*/
replaceTabWithWindow(aTab, aOptions) {
if (this.tabs.length == 1) {
return null;
}
// TODO bug 1967925: Consider handling the case where aTab is a tab group
// and also the only tab group in its window.
var options = "chrome,dialog=no,all";
for (var name in aOptions) {
options += "," + name + "=" + aOptions[name];
}
if (PrivateBrowsingUtils.isWindowPrivate(window)) {
options += ",private=1";
}
// Play the tab closing animation to give immediate feedback while
// waiting for the new window to appear.
if (!gReduceMotion && this.isTab(aTab)) {
aTab.style.maxWidth = ""; // ensure that fade-out transition happens
aTab.removeAttribute("fadein");
}
// tell a new window to take the "dropped" tab
return window.openDialog(
AppConstants.BROWSER_CHROME_URL,
"_blank",
options,
aTab
);
}
/**
* Move contextTab (or selected tabs in a mutli-select context)
* to a new browser window, unless it is (they are) already the only tab(s)
* in the current window, in which case this will do nothing.
*/
replaceTabsWithWindow(contextTab, aOptions = {}) {
if (this.isTabGroupLabel(contextTab)) {
// TODO bug 1967937: Pass contextTab.group instead.
return this.replaceTabWithWindow(contextTab, aOptions);
}
let tabs;
if (contextTab.multiselected) {
tabs = this.selectedTabs;
} else {
tabs = [contextTab];
}
if (this.tabs.length == tabs.length) {
return null;
}
if (tabs.length == 1) {
return this.replaceTabWithWindow(tabs[0], aOptions);
}
// Play the closing animation for all selected tabs to give
// immediate feedback while waiting for the new window to appear.
if (!gReduceMotion) {
for (let tab of tabs) {
tab.style.maxWidth = ""; // ensure that fade-out transition happens
tab.removeAttribute("fadein");
}
}
// Create a new window and make it adopt the tabs, preserving their relative order.
// The initial tab of the new window will be selected, so it should adopt the
// selected tab of the original window, if applicable, or else the first moving tab.
// This avoids tab-switches in the new window, preserving tab laziness.
// However, to avoid multiple tab-switches in the original window, the other tabs
// should be adopted before the selected one.
let { selectedTab } = gBrowser;
if (!tabs.includes(selectedTab)) {
selectedTab = tabs[0];
}
let win = this.replaceTabWithWindow(selectedTab, aOptions);
win.addEventListener(
"before-initial-tab-adopted",
() => {
let tabIndex = 0;
for (let tab of tabs) {
if (tab !== selectedTab) {
const newTab = win.gBrowser.adoptTab(tab, { tabIndex });
if (!newTab) {
// The adoption failed. Restore "fadein" and don't increase the index.
tab.setAttribute("fadein", "true");
continue;
}
}
++tabIndex;
}
// Restore tab selection
let winVisibleTabs = win.gBrowser.visibleTabs;
let winTabLength = winVisibleTabs.length;
win.gBrowser.addRangeToMultiSelectedTabs(
winVisibleTabs[0],
winVisibleTabs[winTabLength - 1]
);
win.gBrowser.lockClearMultiSelectionOnce();
},
{ once: true }
);
return win;
}
/**
* Moves group to a new window.
*
* @param {MozTabbrowserTabGroup} group
* The tab group to move.
*/
replaceGroupWithWindow(group) {
return this.replaceTabWithWindow(group);
}
/**
* @param {Element} element
* @returns {boolean}
* `true` if element is a `<tab>`
*/
isTab(element) {
return !!(element?.tagName == "tab");
}
/**
* @param {Element} element
* @returns {boolean}
* `true` if element is a `<tab-group>`
*/
isTabGroup(element) {
return !!(element?.tagName == "tab-group");
}
/**
* @param {Element} element
* @returns {boolean}
* `true` if element is the `<label>` in a `<tab-group>`
*/
isTabGroupLabel(element) {
return !!element?.classList?.contains("tab-group-label");
}
_updateTabsAfterInsert() {
for (let i = 0; i < this.tabs.length; i++) {
this.tabs[i]._tPos = i;
this.tabs[i]._selected = false;
}
// If we're in the midst of an async tab switch while calling
// moveTabTo, we can get into a case where _visuallySelected
// is set to true on two different tabs.
//
// What we want to do in moveTabTo is to remove logical selection
// from all tabs, and then re-add logical selection to selectedTab
// (and visual selection as well if we're not running with e10s, which
// setting _selected will do automatically).
//
// If we're running with e10s, then the visual selection will not
// be changed, which is fine, since if we weren't in the midst of a
// tab switch, the previously visually selected tab should still be
// correct, and if we are in the midst of a tab switch, then the async
// tab switcher will set the visually selected tab once the tab switch
// has completed.
this.selectedTab._selected = true;
}
/**
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} element
* The tab or tab group to move. Also accepts a tab group label as a
* stand-in for its group.
* @param {object} [options]
* @param {number} [options.tabIndex]
* The desired position, expressed as the index within the `tabs` array.
* @param {number} [options.elementIndex]
* The desired position, expressed as the index within the
* `MozTabbrowserTabs::ariaFocusableItems` array.
* @param {boolean} [options.forceUngrouped=false]
* Force `element` to move into position as a standalone tab, overriding
* any possibility of entering a tab group. For example, setting `true`
* ensures that a pinned tab will not accidentally be placed inside of
* a tab group, since pinned tabs are presently not allowed in tab groups.
* @property {boolean} [options.isUserTriggered=false]
* Should be true if there was an explicit action/request from the user
* (as opposed to some action being taken internally or for technical
* bookkeeping reasons alone) to move the tab. This causes telemetry
* events to fire.
* @property {string} [options.telemetrySource="unknown"]
* The system, surface, or control the user used to move the tab.
* @see TabMetrics.METRIC_SOURCE for possible values.
* Defaults to "unknown".
*/
moveTabTo(
element,
{
elementIndex,
tabIndex,
forceUngrouped = false,
isUserTriggered = false,
telemetrySource = this.TabMetrics.METRIC_SOURCE.UNKNOWN,
} = {}
) {
if (typeof elementIndex == "number") {
tabIndex = this.#elementIndexToTabIndex(elementIndex);
}
// Don't allow mixing pinned and unpinned tabs.
if (this.isTab(element) && element.pinned) {
tabIndex = Math.min(tabIndex, this.pinnedTabCount - 1);
} else {
tabIndex = Math.max(tabIndex, this.pinnedTabCount);
}
// Return early if the tab is already in the right spot.
if (
this.isTab(element) &&
element._tPos == tabIndex &&
!(element.group && forceUngrouped)
) {
return;
}
// When asked to move a tab group label, we need to move the whole group
// instead.
if (this.isTabGroupLabel(element)) {
element = element.group;
}
if (this.isTabGroup(element)) {
forceUngrouped = true;
}
this.#handleTabMove(
element,
() => {
let neighbor = this.tabs[tabIndex];
if (forceUngrouped && neighbor?.group) {
neighbor = neighbor.group;
}
if (neighbor && this.isTab(element) && tabIndex > element._tPos) {
neighbor.after(element);
} else {
this.tabContainer.insertBefore(element, neighbor);
}
},
{ isUserTriggered, telemetrySource }
);
}
/**
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} element
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} targetElement
* @param {TabMetricsContext} [metricsContext]
*/
moveTabBefore(element, targetElement, metricsContext) {
this.#moveTabNextTo(element, targetElement, true, metricsContext);
}
/**
* @param {MozTabbrowserTab|MozTabbrowserTabGroup[]} elements
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} targetElement
* @param {TabMetricsContext} [metricsContext]
*/
moveTabsBefore(elements, targetElement, metricsContext) {
this.#moveTabsNextTo(elements, targetElement, true, metricsContext);
}
/**
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} element
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} targetElement
* @param {TabMetricsContext} [metricsContext]
*/
moveTabAfter(element, targetElement, metricsContext) {
this.#moveTabNextTo(element, targetElement, false, metricsContext);
}
/**
* @param {MozTabbrowserTab|MozTabbrowserTabGroup[]} elements
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} targetElement
* @param {TabMetricsContext} [metricsContext]
*/
moveTabsAfter(elements, targetElement, metricsContext) {
this.#moveTabsNextTo(elements, targetElement, false, metricsContext);
}
/**
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} element
* The tab or tab group to move. Also accepts a tab group label as a
* stand-in for its group.
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} targetElement
* @param {boolean} [moveBefore=false]
* @param {TabMetricsContext} [metricsContext]
*/
#moveTabNextTo(element, targetElement, moveBefore = false, metricsContext) {
if (this.isTabGroupLabel(targetElement)) {
targetElement = targetElement.group;
if (!moveBefore && !targetElement.collapsed) {
// Right after the tab group label = before the first tab in the tab group
targetElement = targetElement.tabs[0];
moveBefore = true;
}
}
if (this.isTabGroupLabel(element)) {
element = element.group;
if (targetElement?.group) {
targetElement = targetElement.group;
}
}
// Don't allow mixing pinned and unpinned tabs.
if (element.pinned && !targetElement?.pinned) {
targetElement = this.tabs[this.pinnedTabCount - 1];
moveBefore = false;
} else if (!element.pinned && targetElement && targetElement.pinned) {
// If the caller asks to move an unpinned element next to a pinned
// tab, move the unpinned element to be the first unpinned element
// in the tab strip. Potential scenarios:
// 1. Moving an unpinned tab and the first unpinned tab is ungrouped:
// move the unpinned tab right before the first unpinned tab.
// 2. Moving an unpinned tab and the first unpinned tab is grouped:
// move the unpinned tab right before the tab group.
// 3. Moving a tab group and the first unpinned tab is ungrouped:
// move the tab group right before the first unpinned tab.
// 4. Moving a tab group and the first unpinned tab is grouped:
// move the tab group right before the first unpinned tab's tab group.
targetElement = this.tabs[this.pinnedTabCount];
if (targetElement.group) {
targetElement = targetElement.group;
}
moveBefore = true;
}
let getContainer = () =>
element.pinned
? this.tabContainer.pinnedTabsContainer
: this.tabContainer;
this.#handleTabMove(
element,
() => {
if (moveBefore) {
getContainer().insertBefore(element, targetElement);
} else if (targetElement) {
targetElement.after(element);
} else {
getContainer().appendChild(element);
}
},
metricsContext
);
}
/**
* @param {MozTabbrowserTab[]} elements
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} targetElement
* @param {boolean} [moveBefore=false]
* @param {TabMetricsContext} [metricsContext]
*/
#moveTabsNextTo(
elements,
targetElement,
moveBefore = false,
metricsContext
) {
this.#moveTabNextTo(
elements[0],
targetElement,
moveBefore,
metricsContext
);
for (let i = 1; i < elements.length; i++) {
this.#moveTabNextTo(
elements[i],
elements[i - 1],
false,
metricsContext
);
}
}
/**
*
* @param {MozTabbrowserTab} aTab
* @param {MozTabbrowserTabGroup} aGroup
* @param {TabMetricsContext} [metricsContext]
*/
moveTabToGroup(aTab, aGroup, metricsContext) {
if (!this.isTab(aTab)) {
throw new Error("Can only move a tab into a tab group");
}
if (aTab.pinned) {
return;
}
if (aTab.group && aTab.group.id === aGroup.id) {
return;
}
aGroup.collapsed = false;
this.#handleTabMove(aTab, () => aGroup.appendChild(aTab), metricsContext);
this.removeFromMultiSelectedTabs(aTab);
this.tabContainer._notifyBackgroundTab(aTab);
}
/**
* @typedef {object} TabMoveState
* @property {number} tabIndex
* @property {number} [elementIndex]
* @property {string} [tabGroupId]
*/
/**
* @param {MozTabbrowserTab} tab
* @returns {TabMoveState|undefined}
*/
#getTabMoveState(tab) {
if (!this.isTab(tab)) {
return undefined;
}
let state = {
tabIndex: tab._tPos,
};
if (tab.visible) {
state.elementIndex = tab.elementIndex;
}
if (tab.group) {
state.tabGroupId = tab.group.id;
}
return state;
}
/**
* @param {MozTabbrowserTab} tab
* @param {TabMoveState} [previousTabState]
* @param {TabMoveState} [currentTabState]
* @param {TabMetricsContext} [metricsContext]
*/
#notifyOnTabMove(tab, previousTabState, currentTabState, metricsContext) {
if (!this.isTab(tab) || !previousTabState || !currentTabState) {
return;
}
let changedPosition =
previousTabState.tabIndex != currentTabState.tabIndex;
let changedTabGroup =
previousTabState.tabGroupId != currentTabState.tabGroupId;
if (changedPosition || changedTabGroup) {
tab.dispatchEvent(
new CustomEvent("TabMove", {
bubbles: true,
detail: {
previousTabState,
currentTabState,
isUserTriggered: metricsContext?.isUserTriggered ?? false,
telemetrySource:
metricsContext?.telemetrySource ??
this.TabMetrics.METRIC_SOURCE.UNKNOWN,
},
})
);
}
}
/**
* @param {MozTabbrowserTab|MozTabbrowserTabGroup} element
* @param {function():void} moveActionCallback
* @param {TabMetricsContext} [metricsContext]
*/
#handleTabMove(element, moveActionCallback, metricsContext) {
let tabs;
if (this.isTab(element)) {
tabs = [element];
} else if (this.isTabGroup(element)) {
tabs = element.tabs;
} else {
throw new Error("Can only move a tab or tab group within the tab bar");
}
let wasFocused = document.activeElement == this.selectedTab;
let previousTabStates = tabs.map(tab => this.#getTabMoveState(tab));
moveActionCallback();
// Clear tabs cache after moving nodes because the order of tabs may have
// changed.
this.tabContainer._invalidateCachedTabs();
this._lastRelatedTabMap = new WeakMap();
this._updateTabsAfterInsert();
if (wasFocused) {
this.selectedTab.focus();
}
// When a tab group with multiple tabs is moved forwards, emit TabMove in
// the reverse order, so that the index in previousTabState values are
// still accurate until the event is dispatched. If we were to start with
// the front tab, then logically that tab moves, and all following tabs
// would shift, which would invalidate the index in previousTabState.
let reverseEvents =
tabs.length > 1 && tabs[0]._tPos > previousTabStates[0].tabIndex;
for (let i = 0; i < tabs.length; i++) {
let ii = reverseEvents ? tabs.length - i - 1 : i;
let tab = tabs[ii];
if (tab.selected) {
this.tabContainer._handleTabSelect(true);
}
let currentTabState = this.#getTabMoveState(tab);
this.#notifyOnTabMove(
tab,
previousTabStates[ii],
currentTabState,
metricsContext
);
}
let currentFirst = this.#getTabMoveState(tabs[0]);
if (
this.isTabGroup(element) &&
previousTabStates[0].tabIndex != currentFirst.tabIndex
) {
let event = new CustomEvent("TabGroupMoved", { bubbles: true });
element.dispatchEvent(event);
}
}
/**
* Adopts a tab from another browser window, and inserts it at the given index.
*
* @returns {object}
* The new tab in the current window, null if the tab couldn't be adopted.
*/
adoptTab(aTab, { elementIndex, tabIndex, selectTab = false } = {}) {
// Swap the dropped tab with a new one we create and then close
// it in the other window (making it seem to have moved between
// windows). We also ensure that the tab we create to swap into has
// the same remote type and process as the one we're swapping in.
// This makes sure we don't get a short-lived process for the new tab.
let linkedBrowser = aTab.linkedBrowser;
let createLazyBrowser = !aTab.linkedPanel;
let index;
let nextElement;
if (typeof elementIndex == "number") {
index = elementIndex;
nextElement = this.tabContainer.ariaFocusableItems.at(elementIndex);
} else {
index = tabIndex;
nextElement = this.tabs.at(tabIndex);
}
let tabInGroup = !!aTab.group;
let params = {
eventDetail: { adoptedTab: aTab },
preferredRemoteType: linkedBrowser.remoteType,
initialBrowsingContextGroupId: linkedBrowser.browsingContext?.group.id,
skipAnimation: true,
elementIndex,
tabIndex,
tabGroup: this.isTab(nextElement) && nextElement.group,
createLazyBrowser,
};
let numPinned = this.pinnedTabCount;
if (index < numPinned || (aTab.pinned && index == numPinned)) {
params.pinned = true;
}
if (aTab.hasAttribute("usercontextid")) {
// new tab must have the same usercontextid as the old one
params.userContextId = aTab.getAttribute("usercontextid");
}
let newTab = this.addWebTab("about:blank", params);
let newBrowser = this.getBrowserForTab(newTab);
aTab.container.finishAnimateTabMove();
if (!createLazyBrowser) {
// Stop the about:blank load.
newBrowser.stop();
}
if (!this.swapBrowsersAndCloseOther(newTab, aTab)) {
// Swapping wasn't permitted. Bail out.
this.removeTab(newTab);
return null;
}
if (selectTab) {
this.selectedTab = newTab;
}
if (tabInGroup) {
Glean.tabgroup.tabInteractions.remove_other_window.add();
}
return newTab;
}
moveTabForward() {
let { selectedTab } = this;
let nextTab = this.tabContainer.findNextTab(selectedTab, {
direction: DIRECTION_FORWARD,
filter: tab => !tab.hidden && selectedTab.pinned == tab.pinned,
});
if (nextTab) {
this.#handleTabMove(selectedTab, () => {
if (!selectedTab.group && nextTab.group) {
if (nextTab.group.collapsed) {
// Skip over collapsed tab group.
nextTab.group.after(selectedTab);
} else {
// Enter first position of tab group.
nextTab.group.insertBefore(selectedTab, nextTab);
}
} else if (selectedTab.group != nextTab.group) {
// Standalone tab after tab group.
selectedTab.group.after(selectedTab);
} else {
nextTab.after(selectedTab);
}
});
} else if (selectedTab.group) {
// selectedTab is the last tab and is grouped.
// remove it from its group.
selectedTab.group.after(selectedTab);
}
}
moveTabBackward() {
let { selectedTab } = this;
let previousTab = this.tabContainer.findNextTab(selectedTab, {
direction: DIRECTION_BACKWARD,
filter: tab => !tab.hidden && selectedTab.pinned == tab.pinned,
});
if (previousTab) {
this.#handleTabMove(selectedTab, () => {
if (!selectedTab.group && previousTab.group) {
if (previousTab.group.collapsed) {
// Skip over collapsed tab group.
previousTab.group.before(selectedTab);
} else {
// Enter last position of tab group.
previousTab.group.append(selectedTab);
}
} else if (selectedTab.group != previousTab.group) {
// Standalone tab before tab group.
selectedTab.group.before(selectedTab);
} else {
previousTab.before(selectedTab);
}
});
} else if (selectedTab.group) {
// selectedTab is the first tab and is grouped.
// remove it from its group.
selectedTab.group.before(selectedTab);
}
}
moveTabToStart(aTab = this.selectedTab) {
this.moveTabTo(aTab, { tabIndex: 0, forceUngrouped: true });
}
moveTabToEnd(aTab = this.selectedTab) {
this.moveTabTo(aTab, {
tabIndex: this.tabs.length - 1,
forceUngrouped: true,
});
}
/**
* @param aTab
* Can be from a different window as well
* @param aRestoreTabImmediately
* Can defer loading of the tab contents
* @param aOptions
* The new index of the tab
*/
duplicateTab(aTab, aRestoreTabImmediately, aOptions) {
let newTab = SessionStore.duplicateTab(
window,
aTab,
0,
aRestoreTabImmediately,
aOptions
);
if (aTab.group) {
Glean.tabgroup.tabInteractions.duplicate.add();
}
return newTab;
}
/**
* Update accessible names of close buttons in the (multi) selected tabs
* collection with how many tabs they will close
*/
_updateMultiselectedTabCloseButtonTooltip() {
const tabCount = gBrowser.selectedTabs.length;
gBrowser.selectedTabs.forEach(selectedTab => {
document.l10n.setArgs(selectedTab.querySelector(".tab-close-button"), {
tabCount,
});
});
}
addToMultiSelectedTabs(aTab) {
if (aTab.multiselected) {
return;
}
aTab.setAttribute("multiselected", "true");
aTab.setAttribute("aria-selected", "true");
this._multiSelectedTabsSet.add(aTab);
this._startMultiSelectChange();
if (this._multiSelectChangeRemovals.has(aTab)) {
this._multiSelectChangeRemovals.delete(aTab);
} else {
this._multiSelectChangeAdditions.add(aTab);
}
this._updateMultiselectedTabCloseButtonTooltip();
}
/**
* Adds two given tabs and all tabs between them into the (multi) selected tabs collection
*/
addRangeToMultiSelectedTabs(aTab1, aTab2) {
if (aTab1 == aTab2) {
return;
}
const tabs = this.visibleTabs;
const indexOfTab1 = tabs.indexOf(aTab1);
const indexOfTab2 = tabs.indexOf(aTab2);
const [lowerIndex, higherIndex] =
indexOfTab1 < indexOfTab2
? [Math.max(0, indexOfTab1), indexOfTab2]
: [Math.max(0, indexOfTab2), indexOfTab1];
for (let i = lowerIndex; i <= higherIndex; i++) {
this.addToMultiSelectedTabs(tabs[i]);
}
this._updateMultiselectedTabCloseButtonTooltip();
}
removeFromMultiSelectedTabs(aTab) {
if (!aTab.multiselected) {
return;
}
aTab.removeAttribute("multiselected");
aTab.removeAttribute("aria-selected");
this._multiSelectedTabsSet.delete(aTab);
this._startMultiSelectChange();
if (this._multiSelectChangeAdditions.has(aTab)) {
this._multiSelectChangeAdditions.delete(aTab);
} else {
this._multiSelectChangeRemovals.add(aTab);
}
// Update labels for Close buttons of the remaining multiselected tabs:
this._updateMultiselectedTabCloseButtonTooltip();
// Update the label for the Close button of the tab being removed
// from the multiselection:
document.l10n.setArgs(aTab.querySelector(".tab-close-button"), {
tabCount: 1,
});
}
clearMultiSelectedTabs() {
if (this._clearMultiSelectionLocked) {
if (this._clearMultiSelectionLockedOnce) {
this._clearMultiSelectionLockedOnce = false;
this._clearMultiSelectionLocked = false;
}
return;
}
if (this.multiSelectedTabsCount < 1) {
return;
}
for (let tab of this.selectedTabs) {
this.removeFromMultiSelectedTabs(tab);
}
this._lastMultiSelectedTabRef = null;
}
selectAllTabs() {
let visibleTabs = this.visibleTabs;
gBrowser.addRangeToMultiSelectedTabs(
visibleTabs[0],
visibleTabs[visibleTabs.length - 1]
);
}
allTabsSelected() {
return (
this.visibleTabs.length == 1 ||
this.visibleTabs.every(t => t.multiselected)
);
}
lockClearMultiSelectionOnce() {
this._clearMultiSelectionLockedOnce = true;
this._clearMultiSelectionLocked = true;
}
unlockClearMultiSelection() {
this._clearMultiSelectionLockedOnce = false;
this._clearMultiSelectionLocked = false;
}
/**
* Remove a tab from the multiselection if it's the only one left there.
*
* In fact, some scenario may lead to only one single tab multi-selected,
* this is something to avoid (Chrome does the same)
* Consider 4 tabs A,B,C,D with A having the focus
* 1. select C with Ctrl
* 2. Right-click on B and "Close Tabs to The Right"
*
* Expected result
* C and D closing
* A being the only multi-selected tab, selection should be cleared
*
*
* Single selected tab could even happen with a none-focused tab.
* For exemple with the menu "Close other tabs", it could happen
* with a multi-selected pinned tab.
* For illustration, consider 4 tabs A,B,C,D with B active
* 1. pin A and Ctrl-select it
* 2. Ctrl-select C
* 3. right-click on D and click "Close Other Tabs"
*
* Expected result
* B and C closing
* A[pinned] being the only multi-selected tab, selection should be cleared.
*/
_avoidSingleSelectedTab() {
if (this.multiSelectedTabsCount == 1) {
this.clearMultiSelectedTabs();
}
}
_switchToNextMultiSelectedTab() {
this._clearMultiSelectionLocked = true;
// Guarantee that _clearMultiSelectionLocked lock gets released.
try {
let lastMultiSelectedTab = this.lastMultiSelectedTab;
if (!lastMultiSelectedTab.selected) {
this.selectedTab = lastMultiSelectedTab;
} else {
let selectedTabs = ChromeUtils.nondeterministicGetWeakSetKeys(
this._multiSelectedTabsSet
).filter(this._mayTabBeMultiselected);
this.selectedTab = selectedTabs.at(-1);
}
} catch (e) {
console.error(e);
}
this._clearMultiSelectionLocked = false;
}
set selectedTabs(tabs) {
this.clearMultiSelectedTabs();
this.selectedTab = tabs[0];
if (tabs.length > 1) {
for (let tab of tabs) {
this.addToMultiSelectedTabs(tab);
}
}
}
get selectedTabs() {
let { selectedTab, _multiSelectedTabsSet } = this;
let tabs = ChromeUtils.nondeterministicGetWeakSetKeys(
_multiSelectedTabsSet
).filter(this._mayTabBeMultiselected);
if (
(!_multiSelectedTabsSet.has(selectedTab) &&
this._mayTabBeMultiselected(selectedTab)) ||
!tabs.length
) {
tabs.push(selectedTab);
}
return tabs.sort((a, b) => a._tPos > b._tPos);
}
get multiSelectedTabsCount() {
return ChromeUtils.nondeterministicGetWeakSetKeys(
this._multiSelectedTabsSet
).filter(this._mayTabBeMultiselected).length;
}
get lastMultiSelectedTab() {
let tab = this._lastMultiSelectedTabRef
? this._lastMultiSelectedTabRef.get()
: null;
if (tab && tab.isConnected && this._multiSelectedTabsSet.has(tab)) {
return tab;
}
let selectedTab = this.selectedTab;
this.lastMultiSelectedTab = selectedTab;
return selectedTab;
}
set lastMultiSelectedTab(aTab) {
this._lastMultiSelectedTabRef = Cu.getWeakReference(aTab);
}
_mayTabBeMultiselected(aTab) {
return aTab.visible;
}
_startMultiSelectChange() {
if (!this._multiSelectChangeStarted) {
this._multiSelectChangeStarted = true;
Promise.resolve().then(() => this._endMultiSelectChange());
}
}
_endMultiSelectChange() {
let noticeable = false;
let { selectedTab } = this;
if (this._multiSelectChangeAdditions.size) {
if (!selectedTab.multiselected) {
this.addToMultiSelectedTabs(selectedTab);
}
noticeable = true;
}
if (this._multiSelectChangeRemovals.size) {
if (this._multiSelectChangeRemovals.has(selectedTab)) {
this._switchToNextMultiSelectedTab();
}
this._avoidSingleSelectedTab();
noticeable = true;
}
this._multiSelectChangeStarted = false;
if (noticeable || this._multiSelectChangeSelected) {
this._multiSelectChangeSelected = false;
this._multiSelectChangeAdditions.clear();
this._multiSelectChangeRemovals.clear();
this.dispatchEvent(
new CustomEvent("TabMultiSelect", { bubbles: true })
);
}
}
toggleMuteAudioOnMultiSelectedTabs(aTab) {
let tabMuted = aTab.linkedBrowser.audioMuted;
let tabsToToggle = this.selectedTabs.filter(
tab => tab.linkedBrowser.audioMuted == tabMuted
);
for (let tab of tabsToToggle) {
tab.toggleMuteAudio();
}
}
resumeDelayedMediaOnMultiSelectedTabs() {
for (let tab of this.selectedTabs) {
tab.resumeDelayedMedia();
}
}
pinMultiSelectedTabs() {
for (let tab of this.selectedTabs) {
this.pinTab(tab);
}
}
unpinMultiSelectedTabs() {
// The selectedTabs getter returns the tabs
// in visual order. We need to unpin in reverse
// order to maintain visual order.
let selectedTabs = this.selectedTabs;
for (let i = selectedTabs.length - 1; i >= 0; i--) {
let tab = selectedTabs[i];
this.unpinTab(tab);
}
}
activateBrowserForPrintPreview(aBrowser) {
this._printPreviewBrowsers.add(aBrowser);
if (this._switcher) {
this._switcher.activateBrowserForPrintPreview(aBrowser);
}
aBrowser.docShellIsActive = true;
}
deactivatePrintPreviewBrowsers() {
let browsers = this._printPreviewBrowsers;
this._printPreviewBrowsers = new Set();
for (let browser of browsers) {
browser.docShellIsActive = this.shouldActivateDocShell(browser);
}
}
/**
* Returns true if a given browser's docshell should be active.
*/
shouldActivateDocShell(aBrowser) {
if (this._switcher) {
return this._switcher.shouldActivateDocShell(aBrowser);
}
return (
(aBrowser == this.selectedBrowser && !document.hidden) ||
this._printPreviewBrowsers.has(aBrowser) ||
this.PictureInPicture.isOriginatingBrowser(aBrowser)
);
}
_getSwitcher() {
if (!this._switcher) {
this._switcher = new this.AsyncTabSwitcher(this);
}
return this._switcher;
}
warmupTab(aTab) {
if (gMultiProcessBrowser) {
this._getSwitcher().warmupTab(aTab);
}
}
/**
* _maybeRequestReplyFromRemoteContent may call
* aEvent.requestReplyFromRemoteContent if necessary.
*
* @param aEvent The handling event.
* @return true if the handler should wait a reply event.
* false if the handle can handle the immediately.
*/
_maybeRequestReplyFromRemoteContent(aEvent) {
if (aEvent.defaultPrevented) {
return false;
}
// If the event target is a remote browser, and the event has not been
// handled by the remote content yet, we should wait a reply event
// from the content.
if (aEvent.isWaitingReplyFromRemoteContent) {
return true; // Somebody called requestReplyFromRemoteContent already.
}
if (
!aEvent.isReplyEventFromRemoteContent &&
aEvent.target?.isRemoteBrowser === true
) {
aEvent.requestReplyFromRemoteContent();
return true;
}
return false;
}
_handleKeyDownEvent(aEvent) {
if (!aEvent.isTrusted) {
// Don't let untrusted events mess with tabs.
return;
}
// Skip this only if something has explicitly cancelled it.
if (aEvent.defaultCancelled) {
return;
}
// Skip if chrome code has cancelled this:
if (aEvent.defaultPreventedByChrome) {
return;
}
// Don't check if the event was already consumed because tab
// navigation should always work for better user experience.
switch (ShortcutUtils.getSystemActionForEvent(aEvent)) {
case ShortcutUtils.TOGGLE_CARET_BROWSING:
this._maybeRequestReplyFromRemoteContent(aEvent);
return;
case ShortcutUtils.MOVE_TAB_BACKWARD:
this.moveTabBackward();
aEvent.preventDefault();
return;
case ShortcutUtils.MOVE_TAB_FORWARD:
this.moveTabForward();
aEvent.preventDefault();
return;
case ShortcutUtils.CLOSE_TAB:
if (gBrowser.multiSelectedTabsCount) {
gBrowser.removeMultiSelectedTabs();
} else if (!this.selectedTab.pinned) {
this.removeCurrentTab({ animate: true });
}
aEvent.preventDefault();
}
}
toggleCaretBrowsing() {
const kPrefShortcutEnabled =
"accessibility.browsewithcaret_shortcut.enabled";
const kPrefWarnOnEnable = "accessibility.warn_on_browsewithcaret";
const kPrefCaretBrowsingOn = "accessibility.browsewithcaret";
var isEnabled = Services.prefs.getBoolPref(kPrefShortcutEnabled);
if (!isEnabled || this._awaitingToggleCaretBrowsingPrompt) {
return;
}
// Toggle browse with caret mode
var browseWithCaretOn = Services.prefs.getBoolPref(
kPrefCaretBrowsingOn,
false
);
var warn = Services.prefs.getBoolPref(kPrefWarnOnEnable, true);
if (warn && !browseWithCaretOn) {
var checkValue = { value: false };
var promptService = Services.prompt;
try {
this._awaitingToggleCaretBrowsingPrompt = true;
const [title, message, checkbox] =
this.tabLocalization.formatValuesSync([
"tabbrowser-confirm-caretbrowsing-title",
"tabbrowser-confirm-caretbrowsing-message",
"tabbrowser-confirm-caretbrowsing-checkbox",
]);
var buttonPressed = promptService.confirmEx(
window,
title,
message,
// Make "No" the default:
promptService.STD_YES_NO_BUTTONS |
promptService.BUTTON_POS_1_DEFAULT,
null,
null,
null,
checkbox,
checkValue
);
} catch (ex) {
return;
} finally {
this._awaitingToggleCaretBrowsingPrompt = false;
}
if (buttonPressed != 0) {
if (checkValue.value) {
try {
Services.prefs.setBoolPref(kPrefShortcutEnabled, false);
} catch (ex) {}
}
return;
}
if (checkValue.value) {
try {
Services.prefs.setBoolPref(kPrefWarnOnEnable, false);
} catch (ex) {}
}
}
// Toggle the pref
try {
Services.prefs.setBoolPref(kPrefCaretBrowsingOn, !browseWithCaretOn);
} catch (ex) {}
}
_handleKeyPressEvent(aEvent) {
if (!aEvent.isTrusted) {
// Don't let untrusted events mess with tabs.
return;
}
// Skip this only if something has explicitly cancelled it.
if (aEvent.defaultCancelled) {
return;
}
// Skip if chrome code has cancelled this:
if (aEvent.defaultPreventedByChrome) {
return;
}
switch (ShortcutUtils.getSystemActionForEvent(aEvent, { rtl: RTL_UI })) {
case ShortcutUtils.TOGGLE_CARET_BROWSING:
if (
aEvent.defaultPrevented ||
this._maybeRequestReplyFromRemoteContent(aEvent)
) {
break;
}
this.toggleCaretBrowsing();
break;
case ShortcutUtils.NEXT_TAB:
if (AppConstants.platform == "macosx") {
this.tabContainer.advanceSelectedTab(DIRECTION_FORWARD, true);
aEvent.preventDefault();
}
break;
case ShortcutUtils.PREVIOUS_TAB:
if (AppConstants.platform == "macosx") {
this.tabContainer.advanceSelectedTab(DIRECTION_BACKWARD, true);
aEvent.preventDefault();
}
break;
}
}
/**
*
* @param {MozTabbrowserTab} tab
*/
#isFirstOrLastInTabGroup(tab) {
if (tab.group) {
let groupTabs = tab.group.tabs;
if (groupTabs.at(0) == tab || groupTabs.at(-1) == tab) {
return true;
}
}
return false;
}
getTabPids(tab) {
if (!tab.linkedBrowser) {
return [];
}
// Get the PIDs of the content process and remote subframe processes
let [contentPid, ...framePids] = E10SUtils.getBrowserPids(
tab.linkedBrowser,
gFissionBrowser
);
let pids = contentPid ? [contentPid] : [];
return pids.concat(framePids.sort());
}
/**
* @param {MozTabbrowserTab} tab
* @param {boolean} [includeLabel=true]
* Include the tab's title/full label in the tooltip. Defaults to true,
* Can be disabled for contexts where including the title in the tooltip
* string would be duplicative would already available information,
* e.g. accessibility descriptions.
* @returns {string}
*/
getTabTooltip(tab, includeLabel = true) {
let labelArray = [];
if (includeLabel) {
labelArray.push(tab._fullLabel || tab.getAttribute("label"));
}
if (this.showPidAndActiveness) {
const pids = this.getTabPids(tab);
let debugStringArray = [];
if (pids.length) {
let pidLabel = pids.length > 1 ? "pids" : "pid";
debugStringArray.push(`(${pidLabel} ${pids.join(", ")})`);
}
if (tab.linkedBrowser.docShellIsActive) {
debugStringArray.push("[A]");
}
if (debugStringArray.length) {
labelArray.push(debugStringArray.join(" "));
}
}
// Add a line to the tooltip with additional tab context (e.g. container
// membership, tab group membership) when applicable.
let containerName = tab.userContextId
? ContextualIdentityService.getUserContextLabel(tab.userContextId)
: "";
let tabGroupName = this.#isFirstOrLastInTabGroup(tab)
? tab.group.name ||
this.tabLocalization.formatValueSync("tab-group-name-default")
: "";
if (containerName || tabGroupName) {
let tabContextString;
if (containerName && tabGroupName) {
tabContextString = this.tabLocalization.formatValueSync(
"tabbrowser-tab-tooltip-tab-group-container",
{
tabGroupName,
containerName,
}
);
} else if (tabGroupName) {
tabContextString = this.tabLocalization.formatValueSync(
"tabbrowser-tab-tooltip-tab-group",
{
tabGroupName,
}
);
} else {
tabContextString = this.tabLocalization.formatValueSync(
"tabbrowser-tab-tooltip-container",
{
containerName,
}
);
}
labelArray.push(tabContextString);
}
if (tab.soundPlaying) {
let audioPlayingString = this.tabLocalization.formatValueSync(
"tabbrowser-tab-audio-playing-description"
);
labelArray.push(audioPlayingString);
}
return labelArray.join("\n");
}
createTooltip(event) {
event.stopPropagation();
let tab = event.target.triggerNode?.closest("tab");
if (!tab) {
if (event.target.triggerNode?.getRootNode()?.host?.closest("tab")) {
// Check if triggerNode is within shadowRoot of moz-button
tab = event.target.triggerNode?.getRootNode().host.closest("tab");
} else {
event.preventDefault();
return;
}
}
const tooltip = event.target;
tooltip.removeAttribute("data-l10n-id");
const tabCount = this.selectedTabs.includes(tab)
? this.selectedTabs.length
: 1;
if (tab._overPlayingIcon || tab._overAudioButton) {
let l10nId;
const l10nArgs = { tabCount };
if (tab.selected) {
l10nId = tab.linkedBrowser.audioMuted
? "tabbrowser-unmute-tab-audio-tooltip"
: "tabbrowser-mute-tab-audio-tooltip";
const keyElem = document.getElementById("key_toggleMute");
l10nArgs.shortcut = ShortcutUtils.prettifyShortcut(keyElem);
} else if (tab.hasAttribute("activemedia-blocked")) {
l10nId = "tabbrowser-unblock-tab-audio-tooltip";
} else {
l10nId = tab.linkedBrowser.audioMuted
? "tabbrowser-unmute-tab-audio-background-tooltip"
: "tabbrowser-mute-tab-audio-background-tooltip";
}
tooltip.label = "";
document.l10n.setAttributes(tooltip, l10nId, l10nArgs);
} else {
// Prevent the tooltip from appearing if card preview is enabled, but
// only if the user is not hovering over the media play icon or the
// close button
if (this._showTabCardPreview) {
event.preventDefault();
return;
}
tooltip.label = this.getTabTooltip(tab, true);
}
}
handleEvent(aEvent) {
switch (aEvent.type) {
case "keydown":
this._handleKeyDownEvent(aEvent);
break;
case "keypress":
this._handleKeyPressEvent(aEvent);
break;
case "framefocusrequested": {
let tab = this.getTabForBrowser(aEvent.target);
if (!tab || tab == this.selectedTab) {
// Let the focus manager try to do its thing by not calling
// preventDefault(). It will still raise the window if appropriate.
break;
}
this.selectedTab = tab;
window.focus();
aEvent.preventDefault();
break;
}
case "visibilitychange": {
const inactive = document.hidden;
if (!this._switcher) {
this.selectedBrowser.preserveLayers(inactive);
this.selectedBrowser.docShellIsActive = !inactive;
}
break;
}
case "TabGroupCreateByUser":
this.tabGroupMenu.openCreateModal(aEvent.target);
break;
case "TabGrouped": {
let tab = aEvent.detail;
let uri =
tab.linkedBrowser?.registeredOpenURI ||
tab._originalRegisteredOpenURI;
if (uri) {
this.UrlbarProviderOpenTabs.unregisterOpenTab(
uri.spec,
tab.userContextId,
null,
PrivateBrowsingUtils.isWindowPrivate(window)
);
this.UrlbarProviderOpenTabs.registerOpenTab(
uri.spec,
tab.userContextId,
tab.group?.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
}
break;
}
case "TabUngrouped": {
let tab = aEvent.detail;
let uri =
tab.linkedBrowser?.registeredOpenURI ||
tab._originalRegisteredOpenURI;
if (uri) {
// By the time the tab makes it to us it is already ungrouped, but
// the original group is preserved in the event target.
let originalGroup = aEvent.target;
this.UrlbarProviderOpenTabs.unregisterOpenTab(
uri.spec,
tab.userContextId,
originalGroup.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
this.UrlbarProviderOpenTabs.registerOpenTab(
uri.spec,
tab.userContextId,
null,
PrivateBrowsingUtils.isWindowPrivate(window)
);
}
break;
}
case "activate":
// Intentional fallthrough
case "deactivate":
this.selectedTab.updateLastSeenActive();
break;
}
}
observe(aSubject, aTopic) {
switch (aTopic) {
case "contextual-identity-updated": {
let identity = aSubject.wrappedJSObject;
for (let tab of this.tabs) {
if (tab.getAttribute("usercontextid") == identity.userContextId) {
ContextualIdentityService.setTabStyle(tab);
}
}
break;
}
}
}
refreshBlocked(actor, browser, data) {
// The data object is expected to contain the following properties:
// - URI (string)
// The URI that a page is attempting to refresh or redirect to.
// - delay (int)
// The delay (in milliseconds) before the page was going to
// reload or redirect.
// - sameURI (bool)
// true if we're refreshing the page. false if we're redirecting.
let notificationBox = this.getNotificationBox(browser);
let notification =
notificationBox.getNotificationWithValue("refresh-blocked");
let l10nId = data.sameURI
? "refresh-blocked-refresh-label"
: "refresh-blocked-redirect-label";
if (notification) {
notification.label = { "l10n-id": l10nId };
} else {
const buttons = [
{
"l10n-id": "refresh-blocked-allow",
callback() {
actor.sendAsyncMessage("RefreshBlocker:Refresh", data);
},
},
];
notificationBox.appendNotification(
"refresh-blocked",
{
label: { "l10n-id": l10nId },
image: "chrome://browser/skin/notification-icons/popup.svg",
priority: notificationBox.PRIORITY_INFO_MEDIUM,
},
buttons
);
}
}
_generateUniquePanelID() {
if (!this._uniquePanelIDCounter) {
this._uniquePanelIDCounter = 0;
}
let outerID = window.docShell.outerWindowID;
// We want panel IDs to be globally unique, that's why we include the
// window ID. We switched to a monotonic counter as Date.now() lead
// to random failures because of colliding IDs.
return "panel-" + outerID + "-" + ++this._uniquePanelIDCounter;
}
destroy() {
this.tabContainer.destroy();
Services.obs.removeObserver(this, "contextual-identity-updated");
for (let tab of this.tabs) {
let browser = tab.linkedBrowser;
if (browser.registeredOpenURI) {
let userContextId = browser.getAttribute("usercontextid") || 0;
this.UrlbarProviderOpenTabs.unregisterOpenTab(
browser.registeredOpenURI.spec,
userContextId,
tab.group?.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
delete browser.registeredOpenURI;
}
let filter = this._tabFilters.get(tab);
if (filter) {
browser.webProgress.removeProgressListener(filter);
let listener = this._tabListeners.get(tab);
if (listener) {
filter.removeProgressListener(listener);
listener.destroy();
}
this._tabFilters.delete(tab);
this._tabListeners.delete(tab);
}
}
document.removeEventListener("keydown", this, { mozSystemGroup: true });
if (AppConstants.platform == "macosx") {
document.removeEventListener("keypress", this, {
mozSystemGroup: true,
});
}
document.removeEventListener("visibilitychange", this);
window.removeEventListener("framefocusrequested", this);
window.removeEventListener("activate", this);
window.removeEventListener("deactivate", this);
if (gMultiProcessBrowser) {
if (this._switcher) {
this._switcher.destroy();
}
}
}
_setupEventListeners() {
this.tabpanels.addEventListener("select", event => {
if (event.target == this.tabpanels) {
this.updateCurrentBrowser();
}
});
this.addEventListener("DOMWindowClose", event => {
let browser = event.target;
if (!browser.isRemoteBrowser) {
if (!event.isTrusted) {
// If the browser is not remote, then we expect the event to be trusted.
// In the remote case, the DOMWindowClose event is captured in content,
// a message is sent to the parent, and another DOMWindowClose event
// is re-dispatched on the actual browser node. In that case, the event
// won't be marked as trusted, since it's synthesized by JavaScript.
return;
}
// In the parent-process browser case, it's possible that the browser
// that fired DOMWindowClose is actually a child of another browser. We
// want to find the top-most browser to determine whether or not this is
// for a tab or not. The chromeEventHandler will be the top-most browser.
browser = event.target.docShell.chromeEventHandler;
}
if (this.tabs.length == 1) {
// We already did PermitUnload in the content process
// for this tab (the only one in the window). So we don't
// need to do it again for any tabs.
window.skipNextCanClose = true;
// In the parent-process browser case, the nsCloseEvent will actually take
// care of tearing down the window, but we need to do this ourselves in the
// content-process browser case. Doing so in both cases doesn't appear to
// hurt.
window.close();
return;
}
let tab = this.getTabForBrowser(browser);
if (tab) {
// Skip running PermitUnload since it already happened in
// the content process.
this.removeTab(tab, { skipPermitUnload: true });
// If we don't preventDefault on the DOMWindowClose event, then
// in the parent-process browser case, we're telling the platform
// to close the entire window. Calling preventDefault is our way of
// saying we took care of this close request by closing the tab.
event.preventDefault();
}
});
this.addEventListener("pagetitlechanged", event => {
let browser = event.target;
let tab = this.getTabForBrowser(browser);
if (!tab || tab.hasAttribute("pending")) {
return;
}
// Ignore empty title changes on internal pages. This prevents the title
// from changing while Fluent is populating the (initially-empty) title
// element.
if (
!browser.contentTitle &&
browser.contentPrincipal.isSystemPrincipal
) {
return;
}
let titleChanged = this.setTabTitle(tab);
if (titleChanged && !tab.selected && !tab.hasAttribute("busy")) {
tab.setAttribute("titlechanged", "true");
}
});
this.addEventListener(
"DOMWillOpenModalDialog",
event => {
if (!event.isTrusted) {
return;
}
let targetIsWindow = Window.isInstance(event.target);
// We're about to open a modal dialog, so figure out for which tab:
// If this is a same-process modal dialog, then we're given its DOM
// window as the event's target. For remote dialogs, we're given the
// browser, but that's in the originalTarget and not the target,
// because it's across the tabbrowser's XBL boundary.
let tabForEvent = targetIsWindow
? this.getTabForBrowser(event.target.docShell.chromeEventHandler)
: this.getTabForBrowser(event.originalTarget);
// Focus window for beforeunload dialog so it is seen but don't
// steal focus from other applications.
if (
event.detail &&
event.detail.tabPrompt &&
event.detail.inPermitUnload &&
Services.focus.activeWindow
) {
window.focus();
}
// Don't need to act if the tab is already selected or if there isn't
// a tab for the event (e.g. for the webextensions options_ui remote
// browsers embedded in the "about:addons" page):
if (!tabForEvent || tabForEvent.selected) {
return;
}
// We always switch tabs for beforeunload tab-modal prompts.
if (
event.detail &&
event.detail.tabPrompt &&
!event.detail.inPermitUnload
) {
let docPrincipal = targetIsWindow
? event.target.document.nodePrincipal
: null;
// At least one of these should/will be non-null:
let promptPrincipal =
event.detail.promptPrincipal ||
docPrincipal ||
tabForEvent.linkedBrowser.contentPrincipal;
// For null principals, we bail immediately and don't show the checkbox:
if (!promptPrincipal || promptPrincipal.isNullPrincipal) {
tabForEvent.attention = true;
return;
}
// For non-system/expanded principals without permission, we bail and show the checkbox.
if (promptPrincipal.URI && !promptPrincipal.isSystemPrincipal) {
let permission = Services.perms.testPermissionFromPrincipal(
promptPrincipal,
"focus-tab-by-prompt"
);
if (permission != Services.perms.ALLOW_ACTION) {
// Tell the prompt box we want to show the user a checkbox:
let tabPrompt = this.getTabDialogBox(tabForEvent.linkedBrowser);
tabPrompt.onNextPromptShowAllowFocusCheckboxFor(
promptPrincipal
);
tabForEvent.attention = true;
return;
}
}
// ... so system and expanded principals, as well as permitted "normal"
// URI-based principals, always get to steal focus for the tab when prompting.
}
// If permissions/origins dictate so, bring tab to the front.
this.selectedTab = tabForEvent;
},
true
);
// When cancelling beforeunload tabmodal dialogs, reset the URL bar to
// avoid spoofing risks.
this.addEventListener(
"DOMModalDialogClosed",
event => {
if (
event.detail?.promptType != "beforeunload" ||
event.detail.areLeaving ||
event.target.nodeName != "browser"
) {
return;
}
event.target.userTypedValue = null;
if (event.target == this.selectedBrowser) {
gURLBar.setURI();
}
},
true
);
let onTabCrashed = event => {
if (!event.isTrusted) {
return;
}
let browser = event.originalTarget;
if (!event.isTopFrame) {
TabCrashHandler.onSubFrameCrash(browser, event.childID);
return;
}
// Preloaded browsers do not actually have any tabs. If one crashes,
// it should be released and removed.
if (browser === this.preloadedBrowser) {
NewTabPagePreloading.removePreloadedBrowser(window);
return;
}
let isRestartRequiredCrash =
event.type == "oop-browser-buildid-mismatch";
let icon = browser.mIconURL;
let tab = this.getTabForBrowser(browser);
if (this.selectedBrowser == browser) {
TabCrashHandler.onSelectedBrowserCrash(
browser,
isRestartRequiredCrash
);
} else {
TabCrashHandler.onBackgroundBrowserCrash(
browser,
isRestartRequiredCrash
);
}
tab.removeAttribute("soundplaying");
this.setIcon(tab, icon);
};
this.addEventListener("oop-browser-crashed", onTabCrashed);
this.addEventListener("oop-browser-buildid-mismatch", onTabCrashed);
this.addEventListener("DOMAudioPlaybackStarted", event => {
var tab = this.getTabFromAudioEvent(event);
if (!tab) {
return;
}
clearTimeout(tab._soundPlayingAttrRemovalTimer);
tab._soundPlayingAttrRemovalTimer = 0;
let modifiedAttrs = [];
if (tab.hasAttribute("soundplaying-scheduledremoval")) {
tab.removeAttribute("soundplaying-scheduledremoval");
modifiedAttrs.push("soundplaying-scheduledremoval");
}
if (!tab.hasAttribute("soundplaying")) {
tab.toggleAttribute("soundplaying", true);
modifiedAttrs.push("soundplaying");
}
if (modifiedAttrs.length) {
// Flush style so that the opacity takes effect immediately, in
// case the media is stopped before the style flushes naturally.
getComputedStyle(tab).opacity;
}
this._tabAttrModified(tab, modifiedAttrs);
});
this.addEventListener("DOMAudioPlaybackStopped", event => {
var tab = this.getTabFromAudioEvent(event);
if (!tab) {
return;
}
if (tab.hasAttribute("soundplaying")) {
let removalDelay = Services.prefs.getIntPref(
"browser.tabs.delayHidingAudioPlayingIconMS"
);
tab.style.setProperty(
"--soundplaying-removal-delay",
`${removalDelay - 300}ms`
);
tab.toggleAttribute("soundplaying-scheduledremoval", true);
this._tabAttrModified(tab, ["soundplaying-scheduledremoval"]);
tab._soundPlayingAttrRemovalTimer = setTimeout(() => {
tab.removeAttribute("soundplaying-scheduledremoval");
tab.removeAttribute("soundplaying");
this._tabAttrModified(tab, [
"soundplaying",
"soundplaying-scheduledremoval",
]);
}, removalDelay);
}
});
this.addEventListener("DOMAudioPlaybackBlockStarted", event => {
var tab = this.getTabFromAudioEvent(event);
if (!tab) {
return;
}
if (!tab.hasAttribute("activemedia-blocked")) {
tab.setAttribute("activemedia-blocked", true);
this._tabAttrModified(tab, ["activemedia-blocked"]);
}
});
this.addEventListener("DOMAudioPlaybackBlockStopped", event => {
var tab = this.getTabFromAudioEvent(event);
if (!tab) {
return;
}
if (tab.hasAttribute("activemedia-blocked")) {
tab.removeAttribute("activemedia-blocked");
this._tabAttrModified(tab, ["activemedia-blocked"]);
}
});
this.addEventListener("GloballyAutoplayBlocked", event => {
let browser = event.originalTarget;
let tab = this.getTabForBrowser(browser);
if (!tab) {
return;
}
SitePermissions.setForPrincipal(
browser.contentPrincipal,
"autoplay-media",
SitePermissions.BLOCK,
SitePermissions.SCOPE_GLOBAL,
browser
);
});
let tabContextFTLInserter = () => {
this.translateTabContextMenu();
this.tabContainer.removeEventListener(
"contextmenu",
tabContextFTLInserter,
true
);
this.tabContainer.removeEventListener(
"mouseover",
tabContextFTLInserter
);
this.tabContainer.removeEventListener(
"focus",
tabContextFTLInserter,
true
);
};
this.tabContainer.addEventListener(
"contextmenu",
tabContextFTLInserter,
true
);
this.tabContainer.addEventListener("mouseover", tabContextFTLInserter);
this.tabContainer.addEventListener("focus", tabContextFTLInserter, true);
// Fired when Gecko has decided a <browser> element will change
// remoteness. This allows persisting some state on this element across
// process switches.
this.addEventListener("WillChangeBrowserRemoteness", event => {
let browser = event.originalTarget;
let tab = this.getTabForBrowser(browser);
if (!tab) {
return;
}
// Dispatch the `BeforeTabRemotenessChange` event, allowing other code
// to react to this tab's process switch.
let evt = document.createEvent("Events");
evt.initEvent("BeforeTabRemotenessChange", true, false);
tab.dispatchEvent(evt);
// Unhook our progress listener.
let filter = this._tabFilters.get(tab);
let oldListener = this._tabListeners.get(tab);
browser.webProgress.removeProgressListener(filter);
filter.removeProgressListener(oldListener);
let stateFlags = oldListener.mStateFlags;
let requestCount = oldListener.mRequestCount;
// We'll be creating a new listener, so destroy the old one.
oldListener.destroy();
let oldDroppedLinkHandler = browser.droppedLinkHandler;
let oldUserTypedValue = browser.userTypedValue;
let hadStartedLoad = browser.didStartLoadSinceLastUserTyping();
let didChange = () => {
browser.userTypedValue = oldUserTypedValue;
if (hadStartedLoad) {
browser.urlbarChangeTracker.startedLoad();
}
browser.droppedLinkHandler = oldDroppedLinkHandler;
// This shouldn't really be necessary, however, this has the side effect
// of sending MozLayerTreeReady / MozLayerTreeCleared events for remote
// frames, which the tab switcher depends on.
//
// eslint-disable-next-line no-self-assign
browser.docShellIsActive = browser.docShellIsActive;
// Create a new tab progress listener for the new browser we just
// injected, since tab progress listeners have logic for handling the
// initial about:blank load
let listener = new TabProgressListener(
tab,
browser,
false,
false,
stateFlags,
requestCount
);
this._tabListeners.set(tab, listener);
filter.addProgressListener(listener, Ci.nsIWebProgress.NOTIFY_ALL);
// Restore the progress listener.
browser.webProgress.addProgressListener(
filter,
Ci.nsIWebProgress.NOTIFY_ALL
);
let cbEvent = browser.getContentBlockingEvents();
// Include the true final argument to indicate that this event is
// simulated (instead of being observed by the webProgressListener).
this._callProgressListeners(
browser,
"onContentBlockingEvent",
[browser.webProgress, null, cbEvent, true],
true,
false
);
if (browser.isRemoteBrowser) {
// Switching the browser to be remote will connect to a new child
// process so the browser can no longer be considered to be
// crashed.
tab.removeAttribute("crashed");
}
if (this.isFindBarInitialized(tab)) {
this.getCachedFindBar(tab).browser = browser;
}
evt = document.createEvent("Events");
evt.initEvent("TabRemotenessChange", true, false);
tab.dispatchEvent(evt);
};
browser.addEventListener("DidChangeBrowserRemoteness", didChange, {
once: true,
});
});
this.addEventListener("pageinfo", event => {
let browser = event.originalTarget;
let tab = this.getTabForBrowser(browser);
if (!tab) {
return;
}
const { url, description, previewImageURL } = event.detail;
this.setPageInfo(tab, url, description, previewImageURL);
});
}
translateTabContextMenu() {
if (this._tabContextMenuTranslated) {
return;
}
MozXULElement.insertFTLIfNeeded("browser/tabContextMenu.ftl");
// Un-lazify the l10n-ids now that the FTL file has been inserted.
document
.getElementById("tabContextMenu")
.querySelectorAll("[data-lazy-l10n-id]")
.forEach(el => {
el.setAttribute("data-l10n-id", el.getAttribute("data-lazy-l10n-id"));
el.removeAttribute("data-lazy-l10n-id");
});
this._tabContextMenuTranslated = true;
}
setSuccessor(aTab, successorTab) {
if (aTab.ownerGlobal != window) {
throw new Error("Cannot set the successor of another window's tab");
}
if (successorTab == aTab) {
successorTab = null;
}
if (successorTab && successorTab.ownerGlobal != window) {
throw new Error("Cannot set the successor to another window's tab");
}
if (aTab.successor) {
aTab.successor.predecessors.delete(aTab);
}
aTab.successor = successorTab;
if (successorTab) {
if (!successorTab.predecessors) {
successorTab.predecessors = new Set();
}
successorTab.predecessors.add(aTab);
}
}
/**
* For all tabs with aTab as a successor, set the successor to aOtherTab
* instead.
*/
replaceInSuccession(aTab, aOtherTab) {
if (aTab.predecessors) {
for (const predecessor of Array.from(aTab.predecessors)) {
this.setSuccessor(predecessor, aOtherTab);
}
}
}
/**
* Get the triggering principal for the last navigation in the session history.
*/
_getTriggeringPrincipalFromHistory(aBrowser) {
let sessionHistory = aBrowser?.browsingContext?.sessionHistory;
if (
!sessionHistory ||
!sessionHistory.index ||
sessionHistory.count == 0
) {
return undefined;
}
let currentEntry = sessionHistory.getEntryAtIndex(sessionHistory.index);
let triggeringPrincipal = currentEntry?.triggeringPrincipal;
return triggeringPrincipal;
}
clearRelatedTabs() {
this._lastRelatedTabMap = new WeakMap();
}
};
/**
* A web progress listener object definition for a given tab.
*/
class TabProgressListener {
constructor(
aTab,
aBrowser,
aStartsBlank,
aWasPreloadedBrowser,
aOrigStateFlags,
aOrigRequestCount
) {
let stateFlags = aOrigStateFlags || 0;
// Initialize mStateFlags to non-zero e.g. when creating a progress
// listener for preloaded browsers as there was no progress listener
// around when the content started loading. If the content didn't
// quite finish loading yet, mStateFlags will very soon be overridden
// with the correct value and end up at STATE_STOP again.
if (aWasPreloadedBrowser) {
stateFlags =
Ci.nsIWebProgressListener.STATE_STOP |
Ci.nsIWebProgressListener.STATE_IS_REQUEST;
}
this.mTab = aTab;
this.mBrowser = aBrowser;
this.mBlank = aStartsBlank;
// cache flags for correct status UI update after tab switching
this.mStateFlags = stateFlags;
this.mStatus = 0;
this.mMessage = "";
this.mTotalProgress = 0;
// count of open requests (should always be 0 or 1)
this.mRequestCount = aOrigRequestCount || 0;
}
destroy() {
delete this.mTab;
delete this.mBrowser;
}
_callProgressListeners(...args) {
args.unshift(this.mBrowser);
return gBrowser._callProgressListeners.apply(gBrowser, args);
}
_shouldShowProgress(aRequest) {
if (this.mBlank) {
return false;
}
// Don't show progress indicators in tabs for about: URIs
// pointing to local resources.
if (
aRequest instanceof Ci.nsIChannel &&
aRequest.originalURI.schemeIs("about")
) {
return false;
}
return true;
}
_isForInitialAboutBlank(aWebProgress, aStateFlags, aLocation) {
if (!this.mBlank || !aWebProgress.isTopLevel) {
return false;
}
// If the state has STATE_STOP, and no requests were in flight, then this
// must be the initial "stop" for the initial about:blank document.
if (
aStateFlags & Ci.nsIWebProgressListener.STATE_STOP &&
this.mRequestCount == 0 &&
!aLocation
) {
return true;
}
let location = aLocation ? aLocation.spec : "";
return location == "about:blank";
}
onProgressChange(
aWebProgress,
aRequest,
aCurSelfProgress,
aMaxSelfProgress,
aCurTotalProgress,
aMaxTotalProgress
) {
this.mTotalProgress = aMaxTotalProgress
? aCurTotalProgress / aMaxTotalProgress
: 0;
if (!this._shouldShowProgress(aRequest)) {
return;
}
if (this.mTotalProgress && this.mTab.hasAttribute("busy")) {
this.mTab.setAttribute("progress", "true");
gBrowser._tabAttrModified(this.mTab, ["progress"]);
}
this._callProgressListeners("onProgressChange", [
aWebProgress,
aRequest,
aCurSelfProgress,
aMaxSelfProgress,
aCurTotalProgress,
aMaxTotalProgress,
]);
}
onProgressChange64(
aWebProgress,
aRequest,
aCurSelfProgress,
aMaxSelfProgress,
aCurTotalProgress,
aMaxTotalProgress
) {
return this.onProgressChange(
aWebProgress,
aRequest,
aCurSelfProgress,
aMaxSelfProgress,
aCurTotalProgress,
aMaxTotalProgress
);
}
/* eslint-disable complexity */
onStateChange(aWebProgress, aRequest, aStateFlags, aStatus) {
if (!aRequest) {
return;
}
let location, originalLocation;
try {
aRequest.QueryInterface(Ci.nsIChannel);
location = aRequest.URI;
originalLocation = aRequest.originalURI;
} catch (ex) {}
let ignoreBlank = this._isForInitialAboutBlank(
aWebProgress,
aStateFlags,
location
);
const { STATE_START, STATE_STOP, STATE_IS_NETWORK } =
Ci.nsIWebProgressListener;
// If we were ignoring some messages about the initial about:blank, and we
// got the STATE_STOP for it, we'll want to pay attention to those messages
// from here forward. Similarly, if we conclude that this state change
// is one that we shouldn't be ignoring, then stop ignoring.
if (
(ignoreBlank &&
aStateFlags & STATE_STOP &&
aStateFlags & STATE_IS_NETWORK) ||
(!ignoreBlank && this.mBlank)
) {
this.mBlank = false;
}
if (aStateFlags & STATE_START && aStateFlags & STATE_IS_NETWORK) {
this.mRequestCount++;
if (aWebProgress.isTopLevel) {
// Need to use originalLocation rather than location because things
// like about:home and about:privatebrowsing arrive with nsIRequest
// pointing to their resolved jar: or file: URIs.
if (
!(
originalLocation &&
gInitialPages.includes(originalLocation.spec) &&
originalLocation != "about:blank" &&
this.mBrowser.initialPageLoadedFromUserAction !=
originalLocation.spec &&
this.mBrowser.currentURI &&
this.mBrowser.currentURI.spec == "about:blank"
)
) {
// Indicating that we started a load will allow the location
// bar to be cleared when the load finishes.
// In order to not overwrite user-typed content, we avoid it
// (see if condition above) in a very specific case:
// If the load is of an 'initial' page (e.g. about:privatebrowsing,
// about:newtab, etc.), was not explicitly typed in the location
// bar by the user, is not about:blank (because about:blank can be
// loaded by websites under their principal), and the current
// page in the browser is about:blank (indicating it is a newly
// created or re-created browser, e.g. because it just switched
// remoteness or is a new tab/window).
this.mBrowser.urlbarChangeTracker.startedLoad();
// To improve the user experience and perceived performance when
// opening links in new tabs, we show the url and tab title sooner,
// but only if it's safe (from a phishing point of view) to do so,
// thus there's no session history and the load starts from a
// non-web-controlled blank page.
if (
this.mBrowser.browsingContext.sessionHistory?.count === 0 &&
BrowserUIUtils.checkEmptyPageOrigin(
this.mBrowser,
originalLocation
)
) {
gBrowser.setInitialTabTitle(this.mTab, originalLocation.spec, {
isURL: true,
});
this.mBrowser.browsingContext.nonWebControlledBlankURI =
originalLocation;
if (this.mTab.selected && !gBrowser.userTypedValue) {
gURLBar.setURI();
}
}
}
delete this.mBrowser.initialPageLoadedFromUserAction;
// If the browser is loading it must not be crashed anymore
this.mTab.removeAttribute("crashed");
}
if (this._shouldShowProgress(aRequest)) {
if (
!(aStateFlags & Ci.nsIWebProgressListener.STATE_RESTORING) &&
aWebProgress &&
aWebProgress.isTopLevel
) {
this.mTab.setAttribute("busy", "true");
gBrowser._tabAttrModified(this.mTab, ["busy"]);
this.mTab._notselectedsinceload = !this.mTab.selected;
}
if (this.mTab.selected) {
gBrowser._isBusy = true;
}
}
} else if (aStateFlags & STATE_STOP && aStateFlags & STATE_IS_NETWORK) {
// since we (try to) only handle STATE_STOP of the last request,
// the count of open requests should now be 0
this.mRequestCount = 0;
let modifiedAttrs = [];
if (this.mTab.hasAttribute("busy")) {
this.mTab.removeAttribute("busy");
modifiedAttrs.push("busy");
// Only animate the "burst" indicating the page has loaded if
// the top-level page is the one that finished loading.
if (
aWebProgress.isTopLevel &&
!aWebProgress.isLoadingDocument &&
Components.isSuccessCode(aStatus) &&
!gBrowser.tabAnimationsInProgress &&
!gReduceMotion
) {
if (this.mTab._notselectedsinceload) {
this.mTab.setAttribute("notselectedsinceload", "true");
} else {
this.mTab.removeAttribute("notselectedsinceload");
}
this.mTab.setAttribute("bursting", "true");
}
}
if (this.mTab.hasAttribute("progress")) {
this.mTab.removeAttribute("progress");
modifiedAttrs.push("progress");
}
if (modifiedAttrs.length) {
gBrowser._tabAttrModified(this.mTab, modifiedAttrs);
}
if (aWebProgress.isTopLevel) {
let isSuccessful = Components.isSuccessCode(aStatus);
if (!isSuccessful && !this.mTab.isEmpty) {
// Restore the current document's location in case the
// request was stopped (possibly from a content script)
// before the location changed.
this.mBrowser.userTypedValue = null;
// When browser.tabs.documentchannel.parent-controlled pref and SHIP
// are enabled and a load gets cancelled due to another one
// starting, the error is NS_BINDING_CANCELLED_OLD_LOAD.
// When these prefs are not enabled, the error is different and
// that's why we still want to look at the isNavigating flag.
// We could add a workaround and make sure that in the alternative
// codepaths we would also omit the same error, but considering
// how we will be enabling fission by default soon, we can keep
// using isNavigating for now, and remove it when the
// parent-controlled pref and SHIP are enabled by default.
// Bug 1725716 has been filed to consider removing isNavigating
// field alltogether.
let isNavigating = this.mBrowser.isNavigating;
if (
this.mTab.selected &&
aStatus != Cr.NS_BINDING_CANCELLED_OLD_LOAD &&
!isNavigating
) {
gURLBar.setURI();
}
} else if (isSuccessful) {
this.mBrowser.urlbarChangeTracker.finishedLoad();
}
}
// If we don't already have an icon for this tab then clear the tab's
// icon. Don't do this on the initial about:blank load to prevent
// flickering. Don't clear the icon if we already set it from one of the
// known defaults. Note we use the original URL since about:newtab
// redirects to a prerendered page.
if (
!this.mBrowser.mIconURL &&
!ignoreBlank &&
!(originalLocation.spec in FAVICON_DEFAULTS)
) {
this.mTab.removeAttribute("image");
} else {
// Bug 1804166: Allow new tabs to set the favicon correctly if the
// new tabs behavior is set to open a blank page
// This is a no-op unless this.mBrowser._documentURI is in
// FAVICON_DEFAULTS.
gBrowser.setDefaultIcon(this.mTab, this.mBrowser._documentURI);
}
// For keyword URIs clear the user typed value since they will be changed into real URIs
if (location.scheme == "keyword") {
this.mBrowser.userTypedValue = null;
}
if (this.mTab.selected) {
gBrowser._isBusy = false;
}
}
if (ignoreBlank) {
this._callProgressListeners(
"onUpdateCurrentBrowser",
[aStateFlags, aStatus, "", 0],
true,
false
);
} else {
this._callProgressListeners(
"onStateChange",
[aWebProgress, aRequest, aStateFlags, aStatus],
true,
false
);
}
this._callProgressListeners(
"onStateChange",
[aWebProgress, aRequest, aStateFlags, aStatus],
false
);
if (aStateFlags & (STATE_START | STATE_STOP)) {
// reset cached temporary values at beginning and end
this.mMessage = "";
this.mTotalProgress = 0;
}
this.mStateFlags = aStateFlags;
this.mStatus = aStatus;
}
/* eslint-enable complexity */
onLocationChange(aWebProgress, aRequest, aLocation, aFlags) {
// OnLocationChange is called for both the top-level content
// and the subframes.
let topLevel = aWebProgress.isTopLevel;
let isSameDocument = !!(
aFlags & Ci.nsIWebProgressListener.LOCATION_CHANGE_SAME_DOCUMENT
);
if (topLevel) {
let isReload = !!(
aFlags & Ci.nsIWebProgressListener.LOCATION_CHANGE_RELOAD
);
let isErrorPage = !!(
aFlags & Ci.nsIWebProgressListener.LOCATION_CHANGE_ERROR_PAGE
);
// We need to clear the typed value
// if the document failed to load, to make sure the urlbar reflects the
// failed URI (particularly for SSL errors). However, don't clear the value
// if the error page's URI is about:blank, because that causes complete
// loss of urlbar contents for invalid URI errors (see bug 867957).
// Another reason to clear the userTypedValue is if this was an anchor
// navigation initiated by the user.
// Finally, we do insert the URL if this is a same-document navigation
// and the user cleared the URL manually.
if (
this.mBrowser.didStartLoadSinceLastUserTyping() ||
(isErrorPage && aLocation.spec != "about:blank") ||
(isSameDocument && this.mBrowser.isNavigating) ||
(isSameDocument && !this.mBrowser.userTypedValue)
) {
this.mBrowser.userTypedValue = null;
}
// If the tab has been set to "busy" outside the stateChange
// handler below (e.g. by sessionStore.navigateAndRestore), and
// the load results in an error page, it's possible that there
// isn't any (STATE_IS_NETWORK & STATE_STOP) state to cause busy
// attribute being removed. In this case we should remove the
// attribute here.
if (isErrorPage && this.mTab.hasAttribute("busy")) {
this.mTab.removeAttribute("busy");
gBrowser._tabAttrModified(this.mTab, ["busy"]);
}
if (!isSameDocument) {
// If the browser was playing audio, we should remove the playing state.
if (this.mTab.hasAttribute("soundplaying")) {
clearTimeout(this.mTab._soundPlayingAttrRemovalTimer);
this.mTab._soundPlayingAttrRemovalTimer = 0;
this.mTab.removeAttribute("soundplaying");
gBrowser._tabAttrModified(this.mTab, ["soundplaying"]);
}
// If the browser was previously muted, we should restore the muted state.
if (this.mTab.hasAttribute("muted")) {
this.mTab.linkedBrowser.mute();
}
if (gBrowser.isFindBarInitialized(this.mTab)) {
let findBar = gBrowser.getCachedFindBar(this.mTab);
// Close the Find toolbar if we're in old-style TAF mode
if (findBar.findMode != findBar.FIND_NORMAL) {
findBar.close();
}
}
// Note that we're not updating for same-document loads, despite
// the `title` argument to `history.pushState/replaceState`. For
// context, see https://bugzilla.mozilla.org/show_bug.cgi?id=585653
// and https://github.com/whatwg/html/issues/2174
if (!isReload) {
gBrowser.setTabTitle(this.mTab);
}
// Don't clear the favicon if this tab is in the pending
// state, as SessionStore will have set the icon for us even
// though we're pointed at an about:blank. Also don't clear it
// if the tab is in customize mode, to keep the one set by
// gCustomizeMode.setTab (bug 1551239). Also don't clear it
// if onLocationChange was triggered by a pushState or a
// replaceState (bug 550565) or a hash change (bug 408415).
if (
!this.mTab.hasAttribute("pending") &&
!this.mTab.hasAttribute("customizemode") &&
aWebProgress.isLoadingDocument
) {
// Removing the tab's image here causes flickering, wait until the
// load is complete.
this.mBrowser.mIconURL = null;
}
if (!isReload && aWebProgress.isLoadingDocument) {
let triggerer = gBrowser._getTriggeringPrincipalFromHistory(
this.mBrowser
);
// Typing a url, searching or clicking a bookmark will load a new
// document that is no longer tied to a navigation from the previous
// content and will have a system principal as the triggerer.
if (triggerer && triggerer.isSystemPrincipal) {
// Reset the related tab map so that the next tab opened will be related
// to this new document and not to tabs opened by the previous one.
gBrowser.clearRelatedTabs();
}
}
if (
aRequest instanceof Ci.nsIChannel &&
!isBlankPageURL(aRequest.originalURI.spec)
) {
this.mBrowser.originalURI = aRequest.originalURI;
}
}
let userContextId = this.mBrowser.getAttribute("usercontextid") || 0;
if (this.mBrowser.registeredOpenURI) {
let uri = this.mBrowser.registeredOpenURI;
gBrowser.UrlbarProviderOpenTabs.unregisterOpenTab(
uri.spec,
userContextId,
this.mTab.group?.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
delete this.mBrowser.registeredOpenURI;
}
if (!isBlankPageURL(aLocation.spec)) {
gBrowser.UrlbarProviderOpenTabs.registerOpenTab(
aLocation.spec,
userContextId,
this.mTab.group?.id,
PrivateBrowsingUtils.isWindowPrivate(window)
);
this.mBrowser.registeredOpenURI = aLocation;
}
if (this.mTab != gBrowser.selectedTab) {
let tabCacheIndex = gBrowser._tabLayerCache.indexOf(this.mTab);
if (tabCacheIndex != -1) {
gBrowser._tabLayerCache.splice(tabCacheIndex, 1);
gBrowser._getSwitcher().cleanUpTabAfterEviction(this.mTab);
}
}
}
if (!this.mBlank || this.mBrowser.hasContentOpener) {
this._callProgressListeners("onLocationChange", [
aWebProgress,
aRequest,
aLocation,
aFlags,
]);
if (topLevel && !isSameDocument) {
// Include the true final argument to indicate that this event is
// simulated (instead of being observed by the webProgressListener).
this._callProgressListeners("onContentBlockingEvent", [
aWebProgress,
null,
0,
true,
]);
}
}
if (topLevel) {
this.mBrowser.lastURI = aLocation;
this.mBrowser.lastLocationChange = Date.now();
}
}
onStatusChange(aWebProgress, aRequest, aStatus, aMessage) {
if (this.mBlank) {
return;
}
this._callProgressListeners("onStatusChange", [
aWebProgress,
aRequest,
aStatus,
aMessage,
]);
this.mMessage = aMessage;
}
onSecurityChange(aWebProgress, aRequest, aState) {
this._callProgressListeners("onSecurityChange", [
aWebProgress,
aRequest,
aState,
]);
}
onContentBlockingEvent(aWebProgress, aRequest, aEvent) {
this._callProgressListeners("onContentBlockingEvent", [
aWebProgress,
aRequest,
aEvent,
]);
}
onRefreshAttempted(aWebProgress, aURI, aDelay, aSameURI) {
return this._callProgressListeners("onRefreshAttempted", [
aWebProgress,
aURI,
aDelay,
aSameURI,
]);
}
}
TabProgressListener.prototype.QueryInterface = ChromeUtils.generateQI([
"nsIWebProgressListener",
"nsIWebProgressListener2",
"nsISupportsWeakReference",
]);
let URILoadingWrapper = {
_normalizeLoadURIOptions(browser, loadURIOptions) {
if (!loadURIOptions.triggeringPrincipal) {
throw new Error("Must load with a triggering Principal");
}
if (
loadURIOptions.userContextId &&
loadURIOptions.userContextId != browser.getAttribute("usercontextid")
) {
throw new Error("Cannot load with mismatched userContextId");
}
loadURIOptions.loadFlags |= loadURIOptions.flags | LOAD_FLAGS_NONE;
delete loadURIOptions.flags;
loadURIOptions.hasValidUserGestureActivation ??=
document.hasValidTransientUserGestureActivation;
},
_loadFlagsToFixupFlags(browser, loadFlags) {
// Attempt to perform URI fixup to see if we can handle this URI in chrome.
let fixupFlags = Ci.nsIURIFixup.FIXUP_FLAG_NONE;
if (loadFlags & LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP) {
fixupFlags |= Ci.nsIURIFixup.FIXUP_FLAG_ALLOW_KEYWORD_LOOKUP;
}
if (loadFlags & LOAD_FLAGS_FIXUP_SCHEME_TYPOS) {
fixupFlags |= Ci.nsIURIFixup.FIXUP_FLAG_FIX_SCHEME_TYPOS;
}
if (PrivateBrowsingUtils.isBrowserPrivate(browser)) {
fixupFlags |= Ci.nsIURIFixup.FIXUP_FLAG_PRIVATE_CONTEXT;
}
return fixupFlags;
},
_fixupURIString(browser, uriString, loadURIOptions) {
let fixupFlags = this._loadFlagsToFixupFlags(
browser,
loadURIOptions.loadFlags
);
// XXXgijs: If we switch to loading the URI we return from this method,
// rather than redoing fixup in docshell (see bug 1815509), we need to
// ensure that the loadURIOptions have the fixup flag removed here for
// loads where `uriString` already parses if just passed immediately
// to `newURI`.
// Right now this happens in nsDocShellLoadState code.
try {
let fixupInfo = Services.uriFixup.getFixupURIInfo(
uriString,
fixupFlags
);
return fixupInfo.preferredURI;
} catch (e) {
// getFixupURIInfo may throw. Just return null, our caller will deal.
}
return null;
},
/**
* Handles URIs when we want to deal with them in chrome code rather than pass
* them down to a content browser. This can avoid unnecessary process switching
* for the browser.
* @param aBrowser the browser that is attempting to load the URI
* @param aUri the nsIURI that is being loaded
* @returns true if the URI is handled, otherwise false
*/
_handleUriInChrome(aBrowser, aUri) {
if (aUri.scheme == "file") {
try {
let mimeType = Cc["@mozilla.org/mime;1"]
.getService(Ci.nsIMIMEService)
.getTypeFromURI(aUri);
if (mimeType == "application/x-xpinstall") {
let systemPrincipal =
Services.scriptSecurityManager.getSystemPrincipal();
AddonManager.getInstallForURL(aUri.spec, {
telemetryInfo: { source: "file-url" },
}).then(install => {
AddonManager.installAddonFromWebpage(
mimeType,
aBrowser,
systemPrincipal,
install
);
});
return true;
}
} catch (e) {
return false;
}
}
return false;
},
_updateTriggerMetadataForLoad(
browser,
uriString,
{ loadFlags, globalHistoryOptions }
) {
if (globalHistoryOptions?.triggeringSponsoredURL) {
try {
// Browser may access URL after fixing it up, then store the URL into DB.
// To match with it, fix the link up explicitly.
const triggeringSponsoredURL = Services.uriFixup.getFixupURIInfo(
globalHistoryOptions.triggeringSponsoredURL,
this._loadFlagsToFixupFlags(browser, loadFlags)
).fixedURI.spec;
browser.setAttribute(
"triggeringSponsoredURL",
triggeringSponsoredURL
);
const time =
globalHistoryOptions.triggeringSponsoredURLVisitTimeMS ||
Date.now();
browser.setAttribute("triggeringSponsoredURLVisitTimeMS", time);
} catch (e) {}
}
if (globalHistoryOptions?.triggeringSearchEngine) {
browser.setAttribute(
"triggeringSearchEngine",
globalHistoryOptions.triggeringSearchEngine
);
browser.setAttribute("triggeringSearchEngineURL", uriString);
} else {
browser.removeAttribute("triggeringSearchEngine");
browser.removeAttribute("triggeringSearchEngineURL");
}
},
// Both of these are used to override functions on browser-custom-element.
fixupAndLoadURIString(browser, uriString, loadURIOptions = {}) {
this._internalMaybeFixupLoadURI(browser, uriString, null, loadURIOptions);
},
loadURI(browser, uri, loadURIOptions = {}) {
this._internalMaybeFixupLoadURI(browser, "", uri, loadURIOptions);
},
// A shared function used by both remote and non-remote browsers to
// load a string URI or redirect it to the correct process.
_internalMaybeFixupLoadURI(browser, uriString, uri, loadURIOptions) {
this._normalizeLoadURIOptions(browser, loadURIOptions);
// Some callers pass undefined/null when calling
// loadURI/fixupAndLoadURIString. Just load about:blank instead:
if (!uriString && !uri) {
uri = Services.io.newURI("about:blank");
}
// We need a URI in frontend code for checking various things. Ideally
// we would then also pass that URI to webnav/browsingcontext code
// for loading, but we historically haven't. Changing this would alter
// fixup scenarios in some non-obvious cases.
let startedWithURI = !!uri;
if (!uri) {
// Note: this may return null if we can't make a URI out of the input.
uri = this._fixupURIString(browser, uriString, loadURIOptions);
}
if (uri && this._handleUriInChrome(browser, uri)) {
// If we've handled the URI in chrome, then just return here.
return;
}
this._updateTriggerMetadataForLoad(
browser,
uriString || uri.spec,
loadURIOptions
);
// XXX(nika): Is `browser.isNavigating` necessary anymore?
// XXX(gijs): Unsure. But it mirrors docShell.isNavigating, but in the parent process
// (and therefore imperfectly so).
browser.isNavigating = true;
try {
// Should more generally prefer loadURI here - see bug 1815509.
if (startedWithURI) {
browser.webNavigation.loadURI(uri, loadURIOptions);
} else {
browser.webNavigation.fixupAndLoadURIString(
uriString,
loadURIOptions
);
}
} finally {
browser.isNavigating = false;
}
},
};
} // end private scope for gBrowser
var StatusPanel = {
// This is useful for debugging (set to `true` in the interesting state for
// the panel to remain in that state).
_frozen: false,
get panel() {
delete this.panel;
this.panel = document.getElementById("statuspanel");
this.panel.addEventListener(
"transitionend",
this._onTransitionEnd.bind(this)
);
this.panel.addEventListener(
"transitioncancel",
this._onTransitionEnd.bind(this)
);
return this.panel;
},
get isVisible() {
return !this.panel.hasAttribute("inactive");
},
update() {
if (BrowserHandler.kiosk || this._frozen) {
return;
}
let text;
let type;
let types = ["overLink"];
if (XULBrowserWindow.busyUI) {
types.push("status");
}
types.push("defaultStatus");
for (type of types) {
if ((text = XULBrowserWindow[type])) {
break;
}
}
// If it's a long data: URI that uses base64 encoding, truncate to
// a reasonable length rather than trying to display the entire thing.
// We can't shorten arbitrary URIs like this, as bidi etc might mean
// we need the trailing characters for display. But a base64-encoded
// data-URI is plain ASCII, so this is OK for status panel display.
// (See bug 1484071.)
let textCropped = false;
if (text.length > 500 && text.match(/^data:[^,]+;base64,/)) {
text = text.substring(0, 500) + "\u2026";
textCropped = true;
}
if (this._labelElement.value != text || (text && !this.isVisible)) {
this.panel.setAttribute("previoustype", this.panel.getAttribute("type"));
this.panel.setAttribute("type", type);
this._label = text;
this._labelElement.setAttribute(
"crop",
type == "overLink" && !textCropped ? "center" : "end"
);
}
},
get _labelElement() {
delete this._labelElement;
return (this._labelElement = document.getElementById("statuspanel-label"));
},
set _label(val) {
if (!this.isVisible) {
this.panel.removeAttribute("mirror");
this.panel.removeAttribute("sizelimit");
}
if (
this.panel.getAttribute("type") == "status" &&
this.panel.getAttribute("previoustype") == "status"
) {
// Before updating the label, set the panel's current width as its
// min-width to let the panel grow but not shrink and prevent
// unnecessary flicker while loading pages. We only care about the
// panel's width once it has been painted, so we can do this
// without flushing layout.
this.panel.style.minWidth =
window.windowUtils.getBoundsWithoutFlushing(this.panel).width + "px";
} else {
this.panel.style.minWidth = "";
}
if (val) {
this._labelElement.value = val;
if (this.panel.hidden) {
this.panel.hidden = false;
// This ensures that the "inactive" attribute removal triggers a
// transition.
getComputedStyle(this.panel).display;
}
this.panel.removeAttribute("inactive");
MousePosTracker.addListener(this);
} else {
this.panel.setAttribute("inactive", "true");
MousePosTracker.removeListener(this);
}
},
_onTransitionEnd() {
if (!this.isVisible) {
this.panel.hidden = true;
}
},
getMouseTargetRect() {
let container = this.panel.parentNode;
let panelRect = window.windowUtils.getBoundsWithoutFlushing(this.panel);
let containerRect = window.windowUtils.getBoundsWithoutFlushing(container);
return {
top: panelRect.top,
bottom: panelRect.bottom,
left: RTL_UI ? containerRect.right - panelRect.width : containerRect.left,
right: RTL_UI
? containerRect.right
: containerRect.left + panelRect.width,
};
},
onMouseEnter() {
this._mirror();
},
onMouseLeave() {
this._mirror();
},
_mirror() {
if (this._frozen) {
return;
}
if (this.panel.hasAttribute("mirror")) {
this.panel.removeAttribute("mirror");
} else {
this.panel.setAttribute("mirror", "true");
}
if (!this.panel.hasAttribute("sizelimit")) {
this.panel.setAttribute("sizelimit", "true");
}
},
};
var TabBarVisibility = {
_initialUpdateDone: false,
update(force = false) {
let isPopup = !window.toolbar.visible;
let isTaskbarTab = document.documentElement.hasAttribute("taskbartab");
let isSingleTabWindow = isPopup || isTaskbarTab;
let hasVerticalTabs =
!isSingleTabWindow &&
Services.prefs.getBoolPref("sidebar.verticalTabs", false);
// When `gBrowser` has not been initialized, we're opening a new window and
// assume only a single tab is loading.
let hasSingleTab = !gBrowser || gBrowser.visibleTabs.length == 1;
// To prevent tabs being lost, hiding the tabs toolbar should only work
// when only a single tab is visible or tabs are displayed elsewhere.
let hideTabsToolbar =
(isSingleTabWindow && hasSingleTab) || hasVerticalTabs;
// We only want a non-customized titlebar for popups. It should not be the
// case, but if a popup window contains more than one tab we re-enable
// titlebar customization and display tabs.
CustomTitlebar.allowedBy("non-popup", !(isPopup && hasSingleTab));
// Update the browser chrome.
let tabsToolbar = document.getElementById("TabsToolbar");
let navbar = document.getElementById("nav-bar");
gNavToolbox.toggleAttribute("tabs-hidden", hideTabsToolbar);
// Should the nav-bar look and function like a titlebar?
navbar.classList.toggle(
"browser-titlebar",
CustomTitlebar.enabled && hideTabsToolbar
);
document
.getElementById("browser")
.classList.toggle(
"browser-toolbox-background",
CustomTitlebar.enabled && hasVerticalTabs
);
if (
hideTabsToolbar == tabsToolbar.collapsed &&
!force &&
this._initialUpdateDone
) {
// No further updates needed, `TabsToolbar` already matches the expected
// visibilty.
return;
}
this._initialUpdateDone = true;
tabsToolbar.collapsed = hideTabsToolbar;
// Stylize close menu items based on tab visibility. When a window will only
// ever have a single tab, only show the option to close the tab, and
// simplify the text since we don't need to disambiguate from closing the window.
document.getElementById("menu_closeWindow").hidden = hideTabsToolbar;
document.l10n.setAttributes(
document.getElementById("menu_close"),
hideTabsToolbar
? "tabbrowser-menuitem-close"
: "tabbrowser-menuitem-close-tab"
);
},
};
var TabContextMenu = {
contextTab: null,
_updateToggleMuteMenuItems(aTab, aConditionFn) {
["muted", "soundplaying"].forEach(attr => {
if (!aConditionFn || aConditionFn(attr)) {
if (aTab.hasAttribute(attr)) {
aTab.toggleMuteMenuItem.setAttribute(attr, "true");
aTab.toggleMultiSelectMuteMenuItem.setAttribute(attr, "true");
} else {
aTab.toggleMuteMenuItem.removeAttribute(attr);
aTab.toggleMultiSelectMuteMenuItem.removeAttribute(attr);
}
}
});
},
updateContextMenu(aPopupMenu) {
let triggerTab =
aPopupMenu.triggerNode &&
(aPopupMenu.triggerNode.tab || aPopupMenu.triggerNode.closest("tab"));
this.contextTab = triggerTab || gBrowser.selectedTab;
this.contextTab.addEventListener("TabAttrModified", this);
aPopupMenu.addEventListener("popuphidden", this);
this.multiselected = this.contextTab.multiselected;
this.contextTabs = this.multiselected
? gBrowser.selectedTabs
: [this.contextTab];
let disabled = gBrowser.tabs.length == 1;
let tabCountInfo = JSON.stringify({
tabCount: this.contextTabs.length,
});
var menuItems = aPopupMenu.getElementsByAttribute(
"tbattr",
"tabbrowser-multiple"
);
for (let menuItem of menuItems) {
menuItem.disabled = disabled;
}
disabled = gBrowser.visibleTabs.length == 1;
menuItems = aPopupMenu.getElementsByAttribute(
"tbattr",
"tabbrowser-multiple-visible"
);
for (let menuItem of menuItems) {
menuItem.disabled = disabled;
}
let contextNewTabButton = document.getElementById("context_openANewTab");
// update context menu item strings for vertical tabs
document.l10n.setAttributes(
contextNewTabButton,
gBrowser.tabContainer?.verticalMode
? "tab-context-new-tab-open-vertical"
: "tab-context-new-tab-open"
);
// Session store
let closedCount = SessionStore.getLastClosedTabCount(window);
document
.getElementById("History:UndoCloseTab")
.setAttribute("disabled", closedCount == 0);
document.l10n.setArgs(document.getElementById("context_undoCloseTab"), {
tabCount: closedCount,
});
// Show/hide fullscreen context menu items and set the
// autohide item's checked state to mirror the autohide pref.
showFullScreenViewContextMenuItems(aPopupMenu);
// #context_moveTabToNewGroup is a simplified context menu item that only
// appears if there are no existing tab groups available to move the tab to.
let contextMoveTabToNewGroup = document.getElementById(
"context_moveTabToNewGroup"
);
let contextMoveTabToGroup = document.getElementById(
"context_moveTabToGroup"
);
let contextUngroupTab = document.getElementById("context_ungroupTab");
if (gBrowser._tabGroupsEnabled) {
let selectedGroupCount = new Set(
// The filter removes the "null" group for ungrouped tabs.
this.contextTabs.map(t => t.group).filter(g => g)
).size;
let availableGroupsToMoveTo = gBrowser.getAllTabGroups({
sortByLastSeenActive: true,
});
// Determine whether or not the "current" tab group should appear in the
// "move tab to group" context menu.
if (selectedGroupCount == 1) {
let groupToFilter = this.contextTabs[0].group;
if (groupToFilter && this.contextTabs.every(t => t.group)) {
availableGroupsToMoveTo = availableGroupsToMoveTo.filter(
group => group !== groupToFilter
);
}
}
if (!availableGroupsToMoveTo.length) {
contextMoveTabToGroup.hidden = true;
contextMoveTabToNewGroup.hidden = false;
contextMoveTabToNewGroup.setAttribute("data-l10n-args", tabCountInfo);
} else {
contextMoveTabToNewGroup.hidden = true;
contextMoveTabToGroup.hidden = false;
contextMoveTabToGroup.setAttribute("data-l10n-args", tabCountInfo);
const submenu = contextMoveTabToGroup.querySelector("menupopup");
submenu.querySelectorAll("[tab-group-id]").forEach(el => el.remove());
availableGroupsToMoveTo.forEach(group => {
let item = document.createXULElement("menuitem");
item.setAttribute("tab-group-id", group.id);
if (group.label) {
item.setAttribute("label", group.label);
} else {
document.l10n.setAttributes(item, "tab-context-unnamed-group");
}
item.classList.add("menuitem-iconic");
item.classList.add("tab-group-icon");
item.style.setProperty(
"--tab-group-color",
group.style.getPropertyValue("--tab-group-color")
);
item.style.setProperty(
"--tab-group-color-invert",
group.style.getPropertyValue("--tab-group-color-invert")
);
item.style.setProperty(
"--tab-group-color-pale",
group.style.getPropertyValue("--tab-group-color-pale")
);
submenu.appendChild(item);
});
}
contextUngroupTab.hidden = !selectedGroupCount;
let groupInfo = JSON.stringify({
groupCount: selectedGroupCount,
});
contextUngroupTab.setAttribute("data-l10n-args", groupInfo);
} else {
contextMoveTabToNewGroup.hidden = true;
contextMoveTabToGroup.hidden = true;
contextUngroupTab.hidden = true;
}
// Only one of Reload_Tab/Reload_Selected_Tabs should be visible.
document.getElementById("context_reloadTab").hidden = this.multiselected;
document.getElementById("context_reloadSelectedTabs").hidden =
!this.multiselected;
let unloadTabItem = document.getElementById("context_unloadTab");
if (gBrowser._unloadTabInContextMenu) {
// linkedPanel is false if the tab is already unloaded
// Cannot unload about: pages, etc., so skip browsers that are not remote
let unloadableTabs = this.contextTabs.filter(
t => t.linkedPanel && t.linkedBrowser?.isRemoteBrowser
);
unloadTabItem.hidden = unloadableTabs.length === 0;
unloadTabItem.setAttribute(
"data-l10n-args",
JSON.stringify({ tabCount: unloadableTabs.length })
);
} else {
unloadTabItem.hidden = true;
}
// Show Play Tab menu item if the tab has attribute activemedia-blocked
document.getElementById("context_playTab").hidden = !(
this.contextTab.activeMediaBlocked && !this.multiselected
);
document.getElementById("context_playSelectedTabs").hidden = !(
this.contextTab.activeMediaBlocked && this.multiselected
);
// Only one of pin/unpin/multiselect-pin/multiselect-unpin should be visible
let contextPinTab = document.getElementById("context_pinTab");
contextPinTab.hidden = this.contextTab.pinned || this.multiselected;
let contextUnpinTab = document.getElementById("context_unpinTab");
contextUnpinTab.hidden = !this.contextTab.pinned || this.multiselected;
let contextPinSelectedTabs = document.getElementById(
"context_pinSelectedTabs"
);
contextPinSelectedTabs.hidden =
this.contextTab.pinned || !this.multiselected;
let contextUnpinSelectedTabs = document.getElementById(
"context_unpinSelectedTabs"
);
contextUnpinSelectedTabs.hidden =
!this.contextTab.pinned || !this.multiselected;
// Move Tab items
let contextMoveTabOptions = document.getElementById(
"context_moveTabOptions"
);
// gBrowser.visibleTabs excludes tabs in collapsed groups,
// which we want to include in calculations for Move Tab items
let visibleOrCollapsedTabs = gBrowser.tabs.filter(
t => t.isOpen && !t.hidden
);
let allTabsSelected = visibleOrCollapsedTabs.every(t => t.multiselected);
contextMoveTabOptions.setAttribute("data-l10n-args", tabCountInfo);
contextMoveTabOptions.disabled = this.contextTab.hidden || allTabsSelected;
let selectedTabs = gBrowser.selectedTabs;
let contextMoveTabToEnd = document.getElementById("context_moveToEnd");
let allSelectedTabsAdjacent = selectedTabs.every(
(element, index, array) => {
return array.length > index + 1
? element._tPos + 1 == array[index + 1]._tPos
: true;
}
);
let lastVisibleTab = visibleOrCollapsedTabs.at(-1);
let lastTabToMove = this.contextTabs.at(-1);
let isLastPinnedTab = false;
if (lastTabToMove.pinned) {
let sibling = gBrowser.tabContainer.findNextTab(lastTabToMove);
isLastPinnedTab = !sibling || !sibling.pinned;
}
contextMoveTabToEnd.disabled =
(lastTabToMove == lastVisibleTab || isLastPinnedTab) &&
!lastTabToMove.group &&
allSelectedTabsAdjacent;
let contextMoveTabToStart = document.getElementById("context_moveToStart");
let isFirstTab =
!this.contextTabs[0].group &&
(this.contextTabs[0] == visibleOrCollapsedTabs[0] ||
this.contextTabs[0] == visibleOrCollapsedTabs[gBrowser.pinnedTabCount]);
contextMoveTabToStart.disabled = isFirstTab && allSelectedTabsAdjacent;
document.getElementById("context_openTabInWindow").disabled =
this.contextTab.hasAttribute("customizemode");
// Only one of "Duplicate Tab"/"Duplicate Tabs" should be visible.
document.getElementById("context_duplicateTab").hidden = this.multiselected;
document.getElementById("context_duplicateTabs").hidden =
!this.multiselected;
let closeTabsToTheStartItem = document.getElementById(
"context_closeTabsToTheStart"
);
// update context menu item strings for vertical tabs
document.l10n.setAttributes(
closeTabsToTheStartItem,
gBrowser.tabContainer?.verticalMode
? "close-tabs-to-the-start-vertical"
: "close-tabs-to-the-start"
);
let closeTabsToTheEndItem = document.getElementById(
"context_closeTabsToTheEnd"
);
// update context menu item strings for vertical tabs
document.l10n.setAttributes(
closeTabsToTheEndItem,
gBrowser.tabContainer?.verticalMode
? "close-tabs-to-the-end-vertical"
: "close-tabs-to-the-end"
);
// Disable "Close Tabs to the Left/Right" if there are no tabs
// preceding/following it.
let noTabsToStart = !gBrowser._getTabsToTheStartFrom(this.contextTab)
.length;
closeTabsToTheStartItem.disabled = noTabsToStart;
let noTabsToEnd = !gBrowser._getTabsToTheEndFrom(this.contextTab).length;
closeTabsToTheEndItem.disabled = noTabsToEnd;
// Disable "Close other Tabs" if there are no unpinned tabs.
let unpinnedTabsToClose = this.multiselected
? gBrowser.openTabs.filter(
t => !t.multiselected && !t.pinned && !t.hidden
).length
: gBrowser.openTabs.filter(
t => t != this.contextTab && !t.pinned && !t.hidden
).length;
let closeOtherTabsItem = document.getElementById("context_closeOtherTabs");
closeOtherTabsItem.disabled = unpinnedTabsToClose < 1;
// Update the close item with how many tabs will close.
document
.getElementById("context_closeTab")
.setAttribute("data-l10n-args", tabCountInfo);
let closeDuplicateEnabled = Services.prefs.getBoolPref(
"browser.tabs.context.close-duplicate.enabled"
);
let closeDuplicateTabsItem = document.getElementById(
"context_closeDuplicateTabs"
);
closeDuplicateTabsItem.hidden = !closeDuplicateEnabled;
closeDuplicateTabsItem.disabled =
!closeDuplicateEnabled ||
!gBrowser.getDuplicateTabsToClose(this.contextTab).length;
// Disable "Close Multiple Tabs" if all sub menuitems are disabled
document.getElementById("context_closeTabOptions").disabled =
closeTabsToTheStartItem.disabled &&
closeTabsToTheEndItem.disabled &&
closeOtherTabsItem.disabled;
// Hide "Bookmark Tab…" for multiselection.
// Update its state if visible.
let bookmarkTab = document.getElementById("context_bookmarkTab");
bookmarkTab.hidden = this.multiselected;
// Show "Bookmark Selected Tabs" in a multiselect context and hide it otherwise.
let bookmarkMultiSelectedTabs = document.getElementById(
"context_bookmarkSelectedTabs"
);
bookmarkMultiSelectedTabs.hidden = !this.multiselected;
let toggleMute = document.getElementById("context_toggleMuteTab");
let toggleMultiSelectMute = document.getElementById(
"context_toggleMuteSelectedTabs"
);
// Only one of mute_unmute_tab/mute_unmute_selected_tabs should be visible
toggleMute.hidden = this.multiselected;
toggleMultiSelectMute.hidden = !this.multiselected;
const isMuted = this.contextTab.hasAttribute("muted");
document.l10n.setAttributes(
toggleMute,
isMuted ? "tabbrowser-context-unmute-tab" : "tabbrowser-context-mute-tab"
);
document.l10n.setAttributes(
toggleMultiSelectMute,
isMuted
? "tabbrowser-context-unmute-selected-tabs"
: "tabbrowser-context-mute-selected-tabs"
);
this.contextTab.toggleMuteMenuItem = toggleMute;
this.contextTab.toggleMultiSelectMuteMenuItem = toggleMultiSelectMute;
this._updateToggleMuteMenuItems(this.contextTab);
let selectAllTabs = document.getElementById("context_selectAllTabs");
selectAllTabs.disabled = gBrowser.allTabsSelected();
gSync.updateTabContextMenu(aPopupMenu, this.contextTab);
let reopenInContainer = document.getElementById(
"context_reopenInContainer"
);
reopenInContainer.hidden =
!Services.prefs.getBoolPref("privacy.userContext.enabled", false) ||
PrivateBrowsingUtils.isWindowPrivate(window);
reopenInContainer.disabled = this.contextTab.hidden;
SharingUtils.updateShareURLMenuItem(
this.contextTab.linkedBrowser,
document.getElementById("context_sendTabToDevice")
);
},
handleEvent(aEvent) {
switch (aEvent.type) {
case "popuphidden":
if (aEvent.target.id == "tabContextMenu") {
this.contextTab.removeEventListener("TabAttrModified", this);
this.contextTab = null;
this.contextTabs = null;
}
break;
case "TabAttrModified": {
let tab = aEvent.target;
this._updateToggleMuteMenuItems(tab, attr =>
aEvent.detail.changed.includes(attr)
);
break;
}
}
},
createReopenInContainerMenu(event) {
createUserContextMenu(event, {
isContextMenu: true,
excludeUserContextId: this.contextTab.getAttribute("usercontextid"),
});
},
duplicateSelectedTabs() {
let newIndex = this.contextTabs.at(-1)._tPos + 1;
for (let tab of this.contextTabs) {
let newTab = SessionStore.duplicateTab(window, tab);
if (tab.group) {
Glean.tabgroup.tabInteractions.duplicate.add();
}
gBrowser.moveTabTo(newTab, { tabIndex: newIndex++ });
}
},
reopenInContainer(event) {
let userContextId = parseInt(
event.target.getAttribute("data-usercontextid")
);
for (let tab of this.contextTabs) {
if (tab.getAttribute("usercontextid") == userContextId) {
continue;
}
/* Create a triggering principal that is able to load the new tab
For content principals that are about: chrome: or resource: we need system to load them.
Anything other than system principal needs to have the new userContextId.
*/
let triggeringPrincipal;
if (tab.linkedPanel) {
triggeringPrincipal = tab.linkedBrowser.contentPrincipal;
} else {
// For lazy tab browsers, get the original principal
// from SessionStore
let tabState = JSON.parse(SessionStore.getTabState(tab));
try {
triggeringPrincipal = E10SUtils.deserializePrincipal(
tabState.triggeringPrincipal_base64
);
} catch (ex) {
continue;
}
}
if (!triggeringPrincipal || triggeringPrincipal.isNullPrincipal) {
// Ensure that we have a null principal if we couldn't
// deserialize it (for lazy tab browsers) ...
// This won't always work however is safe to use.
triggeringPrincipal =
Services.scriptSecurityManager.createNullPrincipal({ userContextId });
} else if (triggeringPrincipal.isContentPrincipal) {
triggeringPrincipal = Services.scriptSecurityManager.principalWithOA(
triggeringPrincipal,
{
userContextId,
}
);
}
let newTab = gBrowser.addTab(tab.linkedBrowser.currentURI.spec, {
userContextId,
pinned: tab.pinned,
tabIndex: tab._tPos + 1,
triggeringPrincipal,
});
if (gBrowser.selectedTab == tab) {
gBrowser.selectedTab = newTab;
}
if (tab.muted && !newTab.muted) {
newTab.toggleMuteAudio(tab.muteReason);
}
}
},
closeContextTabs() {
if (this.contextTab.multiselected) {
gBrowser.removeMultiSelectedTabs(
gBrowser.TabMetrics.userTriggeredContext(
gBrowser.TabMetrics.METRIC_SOURCE.TAB_STRIP
)
);
} else {
gBrowser.removeTab(this.contextTab, {
animate: true,
...gBrowser.TabMetrics.userTriggeredContext(
gBrowser.TabMetrics.METRIC_SOURCE.TAB_STRIP
),
});
}
},
explicitUnloadTabs() {
gBrowser.explicitUnloadTabs(this.contextTabs);
},
moveTabsToNewGroup() {
let insertBefore = this.contextTab;
if (insertBefore._tPos < gBrowser.pinnedTabCount) {
insertBefore = gBrowser.tabs[gBrowser.pinnedTabCount];
}
gBrowser.addTabGroup(this.contextTabs, {
insertBefore,
isUserTriggered: true,
telemetryUserCreateSource: "tab_menu",
});
gBrowser.selectedTab = this.contextTabs[0];
// When using the tab context menu to create a group from the all tabs
// panel, make sure we close that panel so that it doesn't obscure the tab
// group creation panel.
gTabsPanel.hideAllTabsPanel();
},
/**
* @param {MozTabbrowserTabGroup} group
*/
moveTabsToGroup(group) {
group.addTabs(
this.contextTabs,
gBrowser.TabMetrics.userTriggeredContext(
gBrowser.TabMetrics.METRIC_SOURCE.TAB_MENU
)
);
group.ownerGlobal.focus();
},
ungroupTabs() {
for (let i = this.contextTabs.length - 1; i >= 0; i--) {
gBrowser.ungroupTab(this.contextTabs[i]);
}
},
};
|