Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 5x 8x 3x 3x 9x 2x 4x 3x 5x 2x 2x 8x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 12x 1x 1x 230x 230x 230x 230x 230x 230x 230x 230x 6x 6x 1x 5x 4x 229x 169x 169x 169x 3x 1x 3x 169x 169x 169x 169x 169x 169x 2x 167x 169x 169x 169x 229x 60x 60x 13x 13x 13x 13x 5x 5x 25x 13x 13x 7x 5x 1x 1x 4x 4x 30x 30x 30x 14x 16x 16x 16x 16x 1x 1x 15x 15x 15x 15x 38x 38x 38x 56x 20x 18x 2x 2x 2x 4x 1x 1x 16x 16x 16x 1x 1x 1x 2x 42x 42x 42x 42x 42x 42x 42x 94x 42x 4x 4x 4x 4x 4x 4x 4x 8x 4x 4x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 8x 8x 8x 8x 7x 7x 7x 7x 7x 7x 149x 149x 149x 149x 615x 2x 147x 147x 25x 25x 122x 122x 122x 63x 63x 63x 63x 63x 245x 245x 245x 245x 85x 85x 85x 160x 72x 72x 71x 71x 1x 25x 25x 25x 25x 25x 1x 1x 22x 22x 22x 22x 16x 4x 5x 5x 5x 7x 5x 5x 5x 5x 5x 5x 1x 1x 4x 4x 4x 4x 1x 3x 12x 12x 12x 12x 12x 12x 12x 6x 6x 12x 3x 510x 510x 510x 4x 506x 506x 387x 387x 281x 106x 106x 119x 119x 5x 5x 5x 5x 5x 5x 3x 3x 3x 3x 3x 3x 97x 1x 97x 97x 97x 97x 53x 53x 53x 1x 52x 75x 75x 75x 70x 70x 70x 5x 5x 3x 3x 3x 3x 3x 3x 1x 1x 2x 2x 1x 1x 3x 3x 3x 3x 3x 3x 1x 1x 2x 2x 1x 1x 2x 2x 2x 2x 2x 1x 1x 1x 3x 3x 1x 1x 18x 18x 18x 1x 17x 17x 17x 8x 8x 8x 8x 3x 3x 1x 3x 1x 3x 3x 3x 3x 3x 6x 3x 8x 8x 8x 8x 8x 8x 8x 8x 8x 7x 6x 5x 1x 5x 4x 1x 4x 3x 1x 1x 3x 2x 1x 2x 1x 1x 1x 1x 1x 4x 4x 4x 4x 1x 3x 1x 29x 29x 27x 27x 17x 27x 29x 29x 29x 29x 29x 25x 29x 2x 1x 1x 28x 2x 1x 1x 27x 25x 27x 27x 27x 27x 27x 26x 26x 17x 27x 24x 24x 14x 10x 4x 4x 4x 4x 4x 4x 4x 4x 1x 3x 2x 2x 4x 3x 5x 5x 5x 5x 5x 5x 5x 5x 1x 4x 3x 3x 1x 4x 18x 18x 18x 18x 18x 18x 1x 17x 14x 3x 23x 23x 23x 23x 23x 23x 8x 15x 1x 47x 47x 47x 47x 47x 46x 47x 4x 1x 3x 46x 2x 1x 1x 45x 44x 45x 45x 45x 45x 45x 44x 44x 43x 45x 72x 72x 72x 72x 72x 72x 72x 1x 71x 71x 71x 35x 36x 35x 36x 36x 1x 36x 1x 71x 4x 4x 4x 4x 4x 4x 4x 2x 2x 5x 5x 5x 5x 5x 5x 5x 3x 2x 36x 36x 36x 36x 36x 36x 36x 18x 18x 41x 41x 41x 35x 6x 23x 23x 23x 4x 3x 1x 22x 19x 22x 22x 22x 22x 22x 1x 21x 21x 18x 3x 51x 51x 51x 51x 51x 51x 51x 51x 1x 50x 32x 18x 3x 18x 5x 5x 5x 5x 5x 5x 5x 1x 4x 2x 2x 16x 16x 16x 16x 16x 16x 16x 16x 9x 6x 1x 5x 1x 4x 1x 3x 14x 14x 14x 14x 14x 14x 12x 12x 7x 5x 1x 4x 1x 3x 1x 2x 13x 13x 13x 13x 13x 13x 13x 13x 8x 5x 1x 4x 1x 3x 1x 2x 10x 10x 10x 10x 10x 10x 10x 10x 4x 6x 1x 5x 12x 12x 18x 18x 18x 2x 2x 1x 1x 1x 1x 16x 17x 17x 17x 17x 7x 3x 3x 2x 1x 7x 2x 2x 1x 1x 17x 6x 3x 3x 2x 1x 6x 2x 2x 1x 1x 17x 8x 8x 8x 4x 2x 1x 13x 10x 8x 8x 8x 8x 8x 5x 5x 2x 2x 6x 6x 1x 1x 8x 5x 5x 2x 2x 8x 3x 5x 5x 17x 8x 8x 10x 8x 8x 8x 8x 7x 7x 2x 2x 1x 1x 6x 6x 1x 1x 8x 4x 4x 1x 1x 8x 3x 5x 17x 6x 6x 6x 6x 4x 4x 3x 1x 1x 1x 1x 17x 6x 6x 6x 6x 3x 3x 2x 1x 1x 1x 1x 17x 5x 5x 5x 5x 3x 3x 1x 2x 2x 2x 2x 17x 5x 5x 5x 5x 3x 3x 1x 2x 2x 2x 2x 17x 6x 6x 6x 6x 3x 3x 2x 1x 1x 1x 1x 17x 6x 6x 6x 6x 4x 4x 3x 1x 1x 1x 1x 17x 5x 5x 5x 5x 5x 3x 2x 2x 2x 2x 17x 6x 6x 6x 6x 3x 3x 2x 1x 1x 1x 1x 17x 6x 6x 6x 6x 3x 3x 2x 1x 1x 1x 1x 17x 5x 5x 5x 5x 3x 3x 1x 2x 2x 2x 2x 17x 6x 6x 6x 6x 2x 2x 1x 1x 1x 1x 1x 17x 1x 17x 12x 3x 3x 3x 3x 3x 3x 3x 3x 3x 2x 3x 4x 4x 4x 4x 11x 11x 11x 11x 1x 1x 1x 3x 3x 3x 1x 2x 2x 2x 1x 1x 1x 1x 533x 533x 1x 532x 1x 531x 531x 1x 530x 530x 530x 2x 528x 196x 528x 528x 1275x 1x 1274x 1x 1273x 1273x 352x 1273x 2194x 1x 2193x 1225x 1x 1224x 1224x 1224x 524x 1413x 381x 1413x 109x 8x 8x 8x 8x 8x 5x 3x 8x 8x 8x 8x 697x 4x 697x 697x 7x 697x 109x 207x 207x 207x 207x 207x 113x 113x 581x 581x 581x 581x 581x 123x 123x 458x 458x 458x 1038x 1038x 182x 856x 1038x 181x 458x 1x 1x 457x 397x 397x 396x 396x 334x 396x 1x 408x 374x 53x 53x 53x 53x 53x 53x 53x | /* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access */
import { config } from "dotenv";
config();
import Joi from "joi";
import UploadFilesCommand, { UploadFilesCommandOptions, SourceTargetFileNames } from "./command/uploadFilesCommand";
import UploadFolderCommand, { UploadFolderCommandOptions } from "./command/uploadFolderCommand";
import GetFilesRecursivelyCommand, { GetFilesRecursivelyCommandOptions } from "./command/getFilesRecursivelyCommand";
import DownloadFolderCommand, { DownloadFolderCommandOptions } from "./command/downloadFolderCommand";
import { CommandStatus, CommandResultMetaData } from "./command/command";
import parser from "fast-xml-parser";
import { Headers, RequestInit, Response } from "node-fetch";
import path, { basename } from "path";
import Environment from "./environment";
import EnvironmentVcapServices from "./environmentVcapServices";
import ClientError, {
CommandAlreadyExecutedError,
QueryLimitError,
QueryOffsetError,
InsufficientPrivilegesError,
InvalidServiceResponseFormatError,
OperationFailedError,
UserGroupAlreadyExistsError,
UserGroupDeletionFailedError,
UserResendWelcomeEmailError,
UserGroupDoesNotExistError,
UserNotFoundError,
UserAlreadyExistsError,
UserCreateError,
UserUpdateError,
} from "./error";
import FakeServer from "./fakeServer";
import File from "./file";
import FileSystemElement from "./fileSystemElement";
import FileSystemFolder, { IFileNameFormats } from "./fileSystemFolder";
import Folder, { FolderGetFilesOptions } from "./folder";
import { HttpClient, IHttpClientOptions, IProxy, IRequestContext } from "./httpClient";
import RequestResponseLog from "./requestResponseLog";
import RequestResponseLogEntry from "./requestResponseLogEntry";
import Server, { IServerOptions } from "./server";
import Share, { ICreateShare, SharePermission, ShareItemType } from "./share";
import Tag from "./tag";
import UserGroup from "./userGroup";
import User, { IUserOptions, IUserOptionsQuota, IUserQuotaUserFriendly, UserProperty } from "./user";
import Logger from "./logger";
import { isNumber } from "util";
const log: Logger = new Logger();
export {
FolderGetFilesOptions,
CommandAlreadyExecutedError,
InvalidServiceResponseFormatError,
InsufficientPrivilegesError,
OperationFailedError,
QueryLimitError,
QueryOffsetError,
UserNotFoundError,
UserAlreadyExistsError,
UserCreateError,
UserResendWelcomeEmailError,
UserUpdateError,
UserGroupAlreadyExistsError,
UserGroupDeletionFailedError,
UserGroupDoesNotExistError,
};
export {
Client,
ClientError,
Environment,
Folder,
File,
FileSystemElement,
ICreateShare,
IServerOptions,
Tag,
FakeServer,
Server,
Share,
SharePermission,
RequestResponseLog,
RequestResponseLogEntry,
User,
UserGroup,
UserProperty,
IUserOptionsQuota,
IUserQuotaUserFriendly,
ShareItemType,
};
// command object for upload
export {
CommandResultMetaData,
DownloadFolderCommand,
DownloadFolderCommandOptions,
GetFilesRecursivelyCommand,
GetFilesRecursivelyCommandOptions,
UploadFilesCommand,
UploadFilesCommandOptions,
UploadFolderCommand,
UploadFolderCommandOptions,
SourceTargetFileNames,
FileSystemFolder,
IFileNameFormats,
CommandStatus,
};
interface IStat {
type: string;
filename: string;
basename: string;
lastmod: string;
size?: number;
mime?: string;
fileid?: number;
}
export interface IUpsertUserOptions {
id: string;
enabled?: boolean;
subadminGroups?: string[];
memberGroups?: string[];
quota?: string;
email?: string;
displayName?: string;
password?: string;
phone?: string;
address?: string;
website?: string;
twitter?: string;
language?: string;
locale?: string;
superAdmin?: boolean;
resendWelcomeEmail?: boolean;
}
export interface IUserPropertyChange {
property: string;
previousValue: string;
newValue: string;
error?: string;
}
export interface IUpsertUserReport {
id: string;
message: string;
changes: IUserPropertyChange[];
}
export interface ISysInfoNextcloudClient {
version: string;
}
// @todo refactoring of type
export interface ISysInfoNextcloud {
system: any;
storage: any;
shares: any;
}
export interface ISysBasicData {
serverTimeString: string;
uptimeString: string;
timeServersString: string;
}
// @todo refactoring of type
export interface ISystemInfo {
nextcloud: ISysInfoNextcloud;
// @todo change object to something strongly typed
server: any;
// @todo change object to something strongly typed
activeUsers: any;
nextcloudClient: ISysInfoNextcloudClient;
}
export interface IQuota {
used: number;
available: number | string;
}
/**
* The nextcloud client is the root object to access the remote api of the nextcloud server.<br>
*/
export default class Client {
public static webDavUrlPath: string = "/remote.php/webdav";
private nextcloudOrigin: string;
private nextcloudAuthHeader: string;
private nextcloudRequestToken: string;
private webDAVUrl: string;
private proxy?: IProxy;
private fakeServer?: FakeServer;
private logRequestResponse: boolean = false;
private httpClient?: HttpClient;
private userId: string;
/**
* Creates a new instance of a nextcloud client.<br/>
* Use the server to provide server connectivity information to the client.<br/>
* (The FakeServer is only used for testing and code coverage)<br/><br/>
* If the server is not provided the client tries to find the connectivity information
* in the environment.<br/>
* If a <b>VCAP_SERVICES</b> environment variable is available, the client tries to find
* a service with the name <b>"nextcloud"</b> in the user-provides-services section.<br/>
* If no VCAP_SERVICES are available, the client uses the following variables
* from the envirnonment for the connectivity:<br/>
* <ul>
* <li>NEXTCLOUD_URL - the url of the nextcloud server</li>
* <li>NEXTCLOUD_USERNAME - the user name</li>
* <li>NEXTCLOUD_PASSWORD - the application password</li>
* </ul>
* @param server optional server information to connection to a nextcloud server
* @constructor
*/
public constructor(server?: Server | FakeServer) {
log.debug("constructor");
this.nextcloudOrigin = "";
this.nextcloudAuthHeader = "";
this.nextcloudRequestToken = "";
this.webDAVUrl = "";
this.userId = "";
// if no server is provided, try to get a server from VCAP_S environment "nextcloud" instance
// If no VCAP_S environment exists try from environment
if (!server) {
try {
const env: EnvironmentVcapServices = new EnvironmentVcapServices("nextcloud");
server = env.getServer();
} catch (e) {
const serverOptions: IServerOptions = {
url: Environment.getNextcloudUrl(),
basicAuth: {
username: Environment.getUserName(),
password: Environment.getPassword(),
},
logRequestResponse: Environment.getRecordingActiveIndicator(),
};
server = new Server(serverOptions);
}
}
if (server instanceof Server) {
this.proxy = server.proxy;
log.debug("constructor: url ", server.url);
if (server.url.indexOf(Client.webDavUrlPath) === -1) {
if (server.url.slice(-1) === "/") {
server.url = server.url.slice(0, -1);
}
server.url = server.url + Client.webDavUrlPath;
}
this.nextcloudOrigin = server.url.substr(0, server.url.indexOf(Client.webDavUrlPath));
log.debug("constructor: nextcloud url ", this.nextcloudOrigin);
this.userId = server.basicAuth.username;
this.nextcloudAuthHeader = "Basic " + Buffer.from(server.basicAuth.username + ":" + server.basicAuth.password).toString("base64");
this.nextcloudRequestToken = "";
if (server.url.slice(-1) === "/") {
this.webDAVUrl = server.url.slice(0, -1);
} else {
this.webDAVUrl = server.url;
}
this.logRequestResponse = server.logRequestResponse;
const options: IHttpClientOptions = {
authorizationHeader: this.nextcloudAuthHeader,
logRequestResponse: this.logRequestResponse,
origin: this.nextcloudOrigin,
proxy: this.proxy,
};
this.httpClient = new HttpClient(options);
}
if (server instanceof FakeServer) {
this.fakeServer = server;
this.webDAVUrl = "https://fake.server" + Client.webDavUrlPath;
}
}
/**
* returns the used and free quota of the nextcloud account
*/
public async getQuota(): Promise<IQuota> {
log.debug("getQuota");
const requestInit: RequestInit = {
method: "PROPFIND",
};
const response: Response = await this.getHttpResponse(this.webDAVUrl + "/", requestInit, [207], { description: "Client get quota" });
const properties: any[] = await this.getPropertiesFromWebDAVMultistatusResponse(response, Client.webDavUrlPath + "/");
let quota: IQuota | null = null;
for (const prop of properties) {
if (prop["quota-available-bytes"]) {
quota = {
available: "unlimited",
used: prop["quota-used-bytes"],
};
if (prop["quota-available-bytes"] > 0) {
quota.available = prop["quota-available-bytes"];
}
}
}
if (!quota) {
log.debug("Error, quota not available: ", JSON.stringify(properties, null, 4));
throw new ClientError(`Error, quota not available`, "ERR_QUOTA_NOT_AVAILABLE");
}
log.debug("getQuota =", quota);
return quota;
}
// ***************************************************************************************
// tags
// ***************************************************************************************
/**
* creates a new tag, if not already existing
* this function will fail with http 403 if the user does not have admin privileges
* @param tagName the name of the tag
* @returns tagId
*/
public async createTag(tagName: string): Promise<Tag> {
log.debug("createTag");
let tag: Tag | null;
// is the tag already existing?
tag = await this.getTagByName(tagName);
if (tag) {
return tag;
}
// tag does not exist, create tag
const requestInit: RequestInit = {
body: `{ "name": "${tagName}", "userVisible": true, "userAssignable": true, "canAssign": true }`,
// eslint-disable-next-line @typescript-eslint/naming-convention
headers: new Headers({ "Content-Type": "application/json" }),
method: "POST",
};
const response: Response = await this.getHttpResponse(this.nextcloudOrigin + "/remote.php/dav/systemtags/", requestInit, [201], { description: "Tag create" });
const tagString: string | null = response.headers.get("Content-Location");
if (tagString === "" || tagString === null) {
log.error(`createTag 'tagName' ${tagName}`);
throw new ClientError(`Error, tag with name '${tagName}' could not be created`, "ERR_TAG_CREATE_FAILED");
}
log.debug(`createTag new tagId ${tagString} tagName ${tagName}`);
// the number id of the tag is the last element in the id (path)
const tagId: number = this.getTagIdFromHref(tagString);
tag = new Tag(this, tagId, tagName, true, true, true);
return tag;
}
/**
* returns a tag identified by the name or null if not found
* @param tagName the name of the tag
* @returns tag or null
*/
public async getTagByName(tagName: string): Promise<Tag | null> {
log.debug("getTag");
const tags: Tag[] = await this.getTags();
for (const tag of tags) {
if (tag.name === tagName) {
return tag;
}
}
return null;
}
/**
* returns a tag identified by the id or null if not found
* @param tagId the id of the tag
* @returns tag or null
*/
public async getTagById(tagId: number): Promise<Tag | null> {
log.debug("getTagById");
const tags: Tag[] = await this.getTags();
for (const tag of tags) {
if (tag.id === tagId) {
return tag;
}
}
return null;
}
/**
* deletes the tag by id
* this function will fail with http 403 if the user does not have admin privileges
* @param tagId the id of the tag like "/remote.php/dav/systemtags/234"
*/
public async deleteTag(tagId: number): Promise<void> {
log.debug("deleteTag tagId: ", tagId);
const requestInit: RequestInit = {
method: "DELETE",
};
const response: Response = await this.getHttpResponse(`${this.nextcloudOrigin}/remote.php/dav/systemtags/${tagId}`, requestInit, [204, 404], { description: "Tag delete" });
}
/**
* deletes all visible assignable tags
* @throws Error
*/
public async deleteAllTags(): Promise<void> {
log.debug("deleteAllTags");
const tags: Tag[] = await this.getTags();
for (const tag of tags) {
// log.debug("deleteAllTags tag: ", tag);
await tag.delete();
}
}
/**
* returns a list of tags
* @returns array of tags
*/
public async getTags(): Promise<Tag[]> {
log.debug("getTags PROPFIND " + this.nextcloudOrigin + "/remote.php/dav/systemtags/");
const requestInit: RequestInit = {
body: `<?xml version="1.0"?>
<d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
<d:prop>
<oc:id />
<oc:display-name />
<oc:user-visible />
<oc:user-assignable />
<oc:can-assign />
</d:prop>
</d:propfind>`,
method: "PROPFIND",
};
const relUrl = `/remote.php/dav/systemtags/`;
const response: Response = await this.getHttpResponse(this.nextcloudOrigin + relUrl, requestInit, [207], { description: "Tags get" });
const properties: any[] = await this.getPropertiesFromWebDAVMultistatusResponse(response, relUrl + "/*");
const tags: Tag[] = [];
for (const prop of properties) {
// eslint-disable-next-line no-underscore-dangle
tags.push(new Tag(this, this.getTagIdFromHref(prop._href), prop["display-name"], prop["user-visible"], prop["user-assignable"], prop["can-assign"]));
}
return tags;
}
/**
* returns the list of tag names and the tag ids
* @param fileId the id of the file
*/
public async getTagsOfFile(fileId: number): Promise<Map<string, number>> {
log.debug("getTagsOfFile");
const requestInit: RequestInit = {
body: `<?xml version="1.0"?>
<d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
<d:prop>
<oc:id />
<oc:display-name />
<oc:user-visible />
<oc:user-assignable />
<oc:can-assign />
</d:prop>
</d:propfind>`,
method: "PROPFIND",
};
const relUrl = `/remote.php/dav/systemtags-relations/files/${fileId}`;
const response: Response = await this.getHttpResponse(`${this.nextcloudOrigin}${relUrl}`, requestInit, [207], { description: "File get tags" });
const properties: any[] = await this.getPropertiesFromWebDAVMultistatusResponse(response, relUrl + "/*");
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const tagMap: Map<string, number> = new Map();
for (const prop of properties) {
tagMap.set(prop["display-name"], prop.id);
}
log.debug("tags of file ", tagMap);
return tagMap;
}
/**
* removes the tag from the file
* @param fileId the file id
* @param tagId the tag id
*/
public async removeTagOfFile(fileId: number, tagId: number): Promise<void> {
log.debug(`removeTagOfFile tagId: ${tagId} fileId:${fileId}`);
const requestInit: RequestInit = {
method: "DELETE",
};
await this.getHttpResponse(`${this.nextcloudOrigin}/remote.php/dav/systemtags-relations/files/${fileId}/${tagId}`, requestInit, [204, 404], { description: "File remove tag" });
return;
}
/**
* returns the id of the file or -1 of not found
* @returns id of the file or -1 if not found
*/
public async getFileId(fileUrl: string): Promise<number> {
log.debug("getFileId");
const requestInit: RequestInit = {
body: `
<d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
<d:prop>
<oc:fileid />
</d:prop>
</d:propfind>`,
method: "PROPFIND",
};
const response: Response = await this.getHttpResponse(fileUrl, requestInit, [207], { description: "File get id" });
const properties: any[] = await this.getPropertiesFromWebDAVMultistatusResponse(response, "");
for (const prop of properties) {
if (prop.fileid !== undefined) {
Eif (typeof prop.fileid === "number") {
return prop.fileid as number;
} else {
return -1;
}
}
}
log.debug("getFileId no file id found for " + fileUrl);
return -1;
}
public async getFolderContents(folderName: string): Promise<any[]> {
log.debug("getFolderContents");
const requestInit: RequestInit = {
body: `<?xml version="1.0"?>
<d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns" xmlns:ocs="http://open-collaboration-services.org/ns">
<d:prop>
<d:getlastmodified />
<d:getetag />
<d:getcontenttype />
<d:resourcetype />
<oc:fileid />
<oc:permissions />
<oc:size />
<d:getcontentlength />
<nc:has-preview />
<nc:mount-type />
<nc:is-encrypted />
<ocs:share-permissions />
<oc:tags />
<oc:favorite />
<oc:comments-unread />
<oc:owner-id />
<oc:owner-display-name />
<oc:share-types />
</d:prop>
</d:propfind>`,
method: "PROPFIND",
};
const url = `${this.webDAVUrl}${folderName}`;
const response: Response = await this.getHttpResponse(url, requestInit, [207], { description: "Folder get contents" });
const folderContents: any[] = [];
const schema: Joi.ObjectSchema = Joi.object({
_href: Joi.string().required(),
getlastmodified: Joi.string().required(),
fileid: Joi.number().integer().required(),
getcontenttype: Joi.string(),
getcontentlength: Joi.number().integer(),
});
const properties: any[] = await this.getPropertiesFromWebDAVMultistatusResponse(response, "");
// validate the properties
const { error, value } = schema.validate(properties);
Eif (error) {
throw new ClientError(`Error get folder contents - folder name "${folderName}" error ${error.message};`, "INVALID");
}
for (const prop of properties) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, no-underscore-dangle, @typescript-eslint/restrict-plus-operands
let fileName = decodeURI(prop._href.substr(prop._href.indexOf(Client.webDavUrlPath) + 18));
if (fileName.endsWith("/")) {
fileName = fileName.slice(0, -1);
}
// eslint-disable-next-line no-underscore-dangle
if ((url + "/").endsWith(decodeURI(prop._href))) {
continue;
}
const folderContentsEntry: any = {};
folderContentsEntry.lastmod = prop.getlastmodified;
folderContentsEntry.fileid = prop.fileid;
folderContentsEntry.basename = fileName.split("/").reverse()[0];
folderContentsEntry.filename = fileName;
if (prop.getcontenttype) {
folderContentsEntry.mime = prop.getcontenttype;
folderContentsEntry.size = prop.getcontentlength;
folderContentsEntry.type = "file";
} else {
folderContentsEntry.type = "directory";
}
// if (folderContentsEntry.basename !== "") {
folderContents.push(folderContentsEntry);
// }
}
// log.debug("folderContentsEntry ", JSON.stringify(folderContents, null, 4));
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
return folderContents;
}
/**
* creates a folder and all parent folders in the path if they do not exist
* @param folderName name of the folder /folder/subfolder/subfolder
* @returns a folder object
*/
public async createFolder(folderName: string): Promise<Folder> {
folderName = this.sanitizeFolderName(folderName);
log.debug("createFolder: folderName=", folderName);
const parts1: string[] = folderName.split("/");
for (const p of parts1) {
if (p === "." || p === "..") {
throw new ClientError(`Error creating folder, folder name "${folderName}" invalid`, "ERR_CREATE_FOLDER_INVALID_FOLDER_NAME");
}
}
let folder: Folder | null;
folder = await this.getFolder(folderName);
if (folder) {
log.debug("createFolder: folder already available ", folder.name);
return folder;
} else {
// try to do a simple create with the complete path
try {
log.debug("createFolder: folder = ", folderName);
await this.createFolderInternal(folderName);
} catch (e) {
// create all folders in the path
const parts: string[] = folderName.split("/");
parts.shift();
let folderPath: string = "";
log.debug("createFolder: parts = ", parts);
for (const part of parts) {
log.debug("createFolder: part = ", part);
folderPath += "/" + part;
folder = await this.getFolder(folderPath);
if (folder === null) {
log.debug("createFolder: folder not available");
// folder not available
log.debug("createFolder: folder = ", folderPath);
await this.createFolderInternal(folderPath);
} else {
log.debug("createFolder: folder already available ", folderPath);
}
}
}
}
folder = await this.getFolder(folderName);
if (folder) {
log.debug("createFolder: new folder ", folder.name);
return folder;
} else {
throw new ClientError(
`Error creating folder, folder name "${folderName}"
`,
"ERR_CREATE_FOLDER_FAILED"
);
}
}
/**
* deletes a file
* @param fileName name of folder "/f1/f2/f3/x.txt"
*/
public async deleteFile(fileName: string): Promise<void> {
const url: string = this.webDAVUrl + fileName;
log.debug("deleteFile ", url);
const requestInit: RequestInit = {
method: "DELETE",
};
try {
await this.getHttpResponse(url, requestInit, [204], { description: "File delete" });
} catch (err) {
log.debug("Error in deleteFile ", err.message, requestInit.method, url);
throw err;
}
}
/**
* deletes a folder
* @param folderName name of folder "/f1/f2/f3"
*/
public async deleteFolder(folderName: string): Promise<void> {
folderName = this.sanitizeFolderName(folderName);
log.debug("deleteFolder:");
const folder: Folder | null = await this.getFolder(folderName);
if (folder) {
await this.deleteFile(folderName);
}
}
/**
* get the root folder object
* @returns {Promise<Folder>} the root folder
*/
public getRootFolder(): Folder {
return new Folder(this, "/", "", "");
}
/**
* returns an array of file system objects that have all given tags assigned (AND)
* @param {Tag[]} tags array of tags
* @async
* @returns {Promise<FileSystemElement[]>} returns an array of file system objects
*/
public async getFileSystemElementByTags(tags: Tag[]): Promise<FileSystemElement[]> {
log.debug("getFileSystemElementByTags ", tags.join(", "));
let filterRule: string = "";
for (const tag of tags) {
filterRule += `<oc:systemtag>${tag.id}</oc:systemtag>`;
}
const urlSuffix = `/remote.php/dav/files/`;
const url = `${this.nextcloudOrigin}${urlSuffix}${this.userId}`;
const body = `<?xml version="1.0"?>
<oc:filter-files xmlns:d=\"DAV:\" xmlns:oc=\"http://owncloud.org/ns\" xmlns:nc=\"http://nextcloud.org/ns\" xmlns:ocs=\"http://open-collaboration-services.org/ns\">
<d:prop>
<d:getcontenttype />
<oc:fileid />
</d:prop>
<oc:filter-rules>
${filterRule}
</oc:filter-rules>
</oc:filter-files>`;
const requestInit: RequestInit = {
body,
// headers: new Headers({ Depth: "0" }),
method: "REPORT",
};
let response: Response;
try {
response = await this.getHttpResponse(url, requestInit, [207], { description: "Get FileSystemElements by tags" });
} catch (err) {
log.debug("Error in stat ", err.message, requestInit.method, url);
throw err;
}
const result: FileSystemElement[] = [];
let properties: any[] = [];
try {
properties = await this.getPropertiesFromWebDAVMultistatusResponse(response, "");
} catch (e) {
return result;
}
for (const prop of properties) {
let fse: FileSystemElement | null = null;
// eslint-disable-next-line no-underscore-dangle
let name: string = prop._href;
// remove the first two elements from the path
name = name.replace(urlSuffix, "");
const a: string[] = name.split("/");
a.shift();
name = "/" + a.join("/");
// console.log(name);
if (prop.getcontenttype) {
fse = await this.getFile(name);
} else {
fse = await this.getFolder(name);
}
result.push(fse!);
}
return result;
}
/**
* get a folder object from a path string
* @param {string} folderName Name of the folder like "/company/branches/germany"
* @returns {Promise<Folder | null>} null if the folder does not exist or an folder object
*/
public async getFolder(folderName: string): Promise<Folder | null> {
folderName = this.sanitizeFolderName(folderName);
log.debug("getFolder", folderName);
// return root folder
if (folderName === "/" || folderName === "") {
return this.getRootFolder();
}
try {
const stat: IStat = await this.stat(folderName);
log.debug(": SUCCESS!!");
if (stat.type !== "file") {
return new Folder(this, stat.filename.replace(/\\/g, "/"), stat.basename, stat.lastmod, stat.fileid);
} else {
log.debug("getFolder: found object is file not a folder");
return null;
}
} catch (e) {
log.debug("getFolder: exception occurred calling stat ", e.message);
return null;
}
}
/**
* get a array of folders from a folder path string
* @param folderName Name of the folder like "/company/branches/germany"
* @returns array of folder objects
*/
public async getSubFolders(folderName: string): Promise<Folder[]> {
log.debug("getSubFolders: folder ", folderName);
const folders: Folder[] = [];
folderName = this.sanitizeFolderName(folderName);
const folderElements: any[] = await this.contents(folderName, true);
for (const folderElement of folderElements) {
log.debug("getSubFolders: adding subfolders ", folderElement.filename);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
folders.push(new Folder(this, folderElement.filename.replace(/\\/g, "/"), folderElement.basename, folderElement.lastmod, folderElement.fileid));
}
return folders;
}
/**
* get files of a folder
* @param {string} folderName Name of the folder like "/company/branches/germany"
* @param {FolderGetFilesOptions} options options for filtering and paging
* @returns array of file objects
*/
public async getFiles(folderName: string, options?: FolderGetFilesOptions): Promise<File[]> {
log.debug("getFiles: folder ", folderName);
const files: File[] = [];
folderName = this.sanitizeFolderName(folderName);
const fileElements: any[] = await this.contents(folderName, false);
for (const folderElement of fileElements) {
log.debug("getFiles: adding file ", folderElement.filename);
// log.debug("getFiles: adding file ", folderElement);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
let file: File | null = new File(this, folderElement.filename.replace(/\\/g, "/"), folderElement.basename, folderElement.lastmod, folderElement.size, folderElement.mime, folderElement.fileid);
if (options && options.filterFile) {
file = options.filterFile(file);
}
if (file) {
files.push(file);
}
}
return files;
}
/**
* create a new file of overwrites an existing file
* @param fileName the file name /folder1/folder2/filename.txt
* @param data the buffer object
*/
public async createFile(fileName: string, data: Buffer | NodeJS.ReadableStream): Promise<File> {
if (fileName.startsWith("./")) {
fileName = fileName.replace("./", "/");
}
const baseName: string = path.basename(fileName);
const folderName: string = path.dirname(fileName);
log.debug(`createFile folder name ${folderName} base name ${baseName}`);
// ensure that we have a folder
await this.createFolder(folderName);
await this.putFileContents(fileName, data);
const file: File | null = await this.getFile(fileName);
if (!file) {
throw new ClientError(`Error creating file, file name "${fileName}"`, "ERR_CREATE_FILE_FAILED");
}
return file;
}
/**
* returns a nextcloud file object
* @param fileName the full file name /folder1/folder2/file.pdf
*/
public async getFile(fileName: string): Promise<File | null> {
log.debug("getFile fileName = ", fileName);
try {
const stat: IStat = await this.stat(fileName);
log.debug(": SUCCESS!!");
Eif (stat.type === "file") {
return new File(this, stat.filename.replace(/\\/g, "/"), stat.basename, stat.lastmod, stat.size!, stat.mime || "", stat.fileid || -1);
} else {
log.debug("getFile: found object is a folder not a file");
return null;
}
} catch (e) {
log.debug("getFile: exception occurred calling stat ", e.message);
return null;
}
}
/**
* renames the file or moves it to an other location
* @param sourceFileName source file name
* @param targetFileName target file name
*/
public async moveFile(sourceFileName: string, targetFileName: string): Promise<File> {
const url: string = this.webDAVUrl + sourceFileName;
const destinationUrl: string = this.webDAVUrl + targetFileName;
log.debug("moveFile from '" + url + "' to '" + destinationUrl + "'");
const requestInit: RequestInit = {
// eslint-disable-next-line @typescript-eslint/naming-convention
headers: new Headers({ Destination: destinationUrl }),
method: "MOVE",
};
try {
await this.getHttpResponse(url, requestInit, [201], { description: "File move" });
} catch (err) {
log.debug(`Error in move file ${err.message as string} ${requestInit.method || ""} source: ${url} destination: ${destinationUrl}`);
throw new ClientError(`Error: moving file failed: source=" ${sourceFileName} target= ${targetFileName} - ${err.message as string}`, "ERR_FILE_MOVE_FAILED");
}
const targetFile: File | null = await this.getFile(targetFileName);
if (!targetFile) {
throw new ClientError("Error: moving file failed: source=" + sourceFileName + " target=" + targetFileName, "ERR_FILE_MOVE_FAILED");
}
return targetFile;
}
/**
* renames the folder or moves it to an other location
* @param sourceFolderName source folder name
* @param tarName target folder name
*/
public async moveFolder(sourceFolderName: string, tarName: string): Promise<Folder> {
const url: string = this.webDAVUrl + sourceFolderName;
const destinationUrl: string = this.webDAVUrl + tarName;
log.debug(`moveFolder from '${url}' to '${destinationUrl}'`);
const requestInit: RequestInit = {
// eslint-disable-next-line @typescript-eslint/naming-convention
headers: new Headers({ Destination: destinationUrl }),
method: "MOVE",
};
try {
await this.getHttpResponse(url, requestInit, [201], { description: "Folder move" });
} catch (err) {
log.debug(`Error in move folder ${err.message as string} ${requestInit.method || ""} source: ${url} destination: ${destinationUrl}`);
throw new ClientError(`Error: moving folder failed: source=${sourceFolderName} target=${tarName} - ${err.message as string}`, "ERR_FOLDER_MOVE_FAILED");
}
const tar: Folder | null = await this.getFolder(tarName);
if (!tar) {
throw new ClientError("Error: moving folder failed: source=" + sourceFolderName + " target=" + tarName, "ERR_FOLDER_MOVE_FAILED");
}
return tar;
}
/**
* returns the content of a file
* @param fileName name of the file /d1/file1.txt
* @returns Buffer with file content
*/
public async getContent(fileName: string): Promise<Buffer> {
const url = this.webDAVUrl + fileName;
log.debug("getContent GET ", url);
const requestInit: RequestInit = {
method: "GET",
};
let response: Response;
try {
response = await this.getHttpResponse(url, requestInit, [200], { description: "File get content" });
} catch (err) {
log.debug(`Error getContent ${url} - error ${err.message as string}`);
throw err;
}
return Buffer.from(await response.buffer());
}
/**
* returns the content of a file
* @param fileName name of the file /d1/file1.txt
* @returns Buffer with file content
*/
public async pipeContentStream(fileName: string, destination: NodeJS.WritableStream): Promise<void> {
const url = this.webDAVUrl + fileName;
log.debug("getContent GET ", url);
const requestInit: RequestInit = {
method: "GET",
};
let response: Response;
try {
response = await this.getHttpResponse(url, requestInit, [200], { description: "File pipe content stream" });
} catch (err) {
log.debug(`Error getContent ${url} - error ${err.message as string}`);
throw err;
}
response.body.pipe(destination);
}
/**
* returns the link to a file for downloading
* @param fileName name of the file /folder1/folder1.txt
* @returns url
*/
public getLink(fileName: string): string {
log.debug("getLink of ", fileName);
return this.webDAVUrl + fileName;
}
/**
* returns the url to the file in the nextcloud UI
* @param fileId the id of the file
*/
public getUILink(fileId: number): string {
log.debug("getUILink of ", fileId);
return `${this.nextcloudOrigin}/apps/files/?fileid=${fileId}`;
}
/**
* adds a tag to a file or folder
* if the tag does not exist, it is automatically created
* if the tag is created, the user must have damin privileges
* @param fileId the id of the file
* @param tagName the name of the tag
* @returns nothing
* @throws Error
*/
public async addTagToFile(fileId: number, tagName: string): Promise<void> {
log.debug(`addTagToFile file: "${fileId}" tag: "${tagName}"`);
const tag: Tag = await this.createTag(tagName);
if (!tag.canAssign) {
throw new ClientError(`Error: No permission to assign tag "${tagName}" to file. Tag is not assignable`, "ERR_TAG_NOT_ASSIGNABLE");
}
const addTagBody: any = {
canAssign: tag.canAssign,
id: tag.id,
name: tag.name,
userAssignable: tag.assignable,
userVisible: tag.visible,
};
const requestInit: RequestInit = {
body: JSON.stringify(addTagBody, null, 4),
// eslint-disable-next-line @typescript-eslint/naming-convention
headers: new Headers({ "Content-Type": "application/json" }),
method: "PUT",
};
await this.getHttpResponse(`${this.nextcloudOrigin}/remote.php/dav/systemtags-relations/files/${fileId}/${tag.id}`, requestInit, [201, 409], { description: "File add tag" }); // created or conflict
}
// ***************************************************************************************
// activity
// ***************************************************************************************
/*
@todo to be refactored to eventing
public async getActivities(): Promise<string[]> {
const result: string[] = [];
const requestInit: RequestInit = {
headers: new Headers({ "ocs-apirequest": "true" }),
method: "GET",
};
const response: Response = await this.getHttpResponse(
this.nextcloudOrigin + "/ocs/v2.php/apps/activity/api/v2/activity/files?format=json&previews=false&since=97533",
requestInit,
[200],
{ description: "Activities get" });
const responseObject: any = await response.json();
// @todo
for (const res of responseObject.ocs.data) {
log.debug(JSON.stringify({
acivityId: res.activity_id,
objects: res.objects,
type: res.type,
}, null, 4));
}
// log.debug("getActivities: responseObject ", JSON.stringify(responseObject, null, 4));
return result;
}
*/
// ***************************************************************************************
// comments
// ***************************************************************************************
/**
* adds a comment to a file
* @param fileId the id of the file
* @param comment the comment to be added to the file
*/
public async addCommentToFile(fileId: number, comment: string): Promise<void> {
log.debug(`addCommentToFile file:"${fileId}" comment:"${comment}"`);
const addCommentBody: any = {
actorType: "users",
message: comment,
objectType: "files",
verb: "comment",
};
const requestInit: RequestInit = {
body: JSON.stringify(addCommentBody, null, 4),
// eslint-disable-next-line @typescript-eslint/naming-convention
headers: new Headers({ "Content-Type": "application/json" }),
method: "POST",
};
await this.getHttpResponse(`${this.nextcloudOrigin}/remote.php/dav/comments/files/${fileId}`, requestInit, [201], { description: "File add comment" }); // created
}
/**
* returns comments of a file / folder
* @param fileId the id of the file / folder
* @param top number of comments to return
* @param skip the offset
* @returns array of comment strings
* @throws Exception
*/
public async getFileComments(fileId: number, top?: number, skip?: number): Promise<string[]> {
log.debug("getFileComments fileId: ", fileId);
if (!top) {
top = 30;
}
if (!skip) {
skip = 0;
}
const requestInit: RequestInit = {
body: `<?xml version="1.0" encoding="utf-8" ?>
<oc:filter-comments xmlns:D="DAV:" xmlns:oc="http://owncloud.org/ns">
<oc:limit>${top}</oc:limit>
<oc:offset>${skip}</oc:offset>
</oc:filter-comments>`,
method: "REPORT",
};
const response: Response = await this.getHttpResponse(`${this.nextcloudOrigin}/remote.php/dav/comments/files/${fileId}`, requestInit, [207], { description: "File get comments" });
const properties: any[] = await this.getPropertiesFromWebDAVMultistatusResponse(response, "");
const comments: string[] = [];
for (const prop of properties) {
comments.push(prop.message);
}
return comments;
}
/**
* returns system information about the nextcloud server and the nextcloud client
*/
public async getSystemInfo(): Promise<ISystemInfo> {
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const response: Response = await this.getHttpResponse(this.nextcloudOrigin + "/ocs/v2.php/apps/serverinfo/api/v1/info", requestInit, [200], { description: "SystemInfo get" });
const rawResult: any = await response.json();
// validate the raw result
let system = {};
let storage = {};
let shares = {};
let server = {};
let activeUsers = {};
if (rawResult && rawResult.ocs && rawResult.ocs.data) {
if (rawResult.ocs.data.nextcloud) {
if (rawResult.ocs.data.nextcloud.system) {
system = rawResult.ocs.data.nextcloud.system;
} else {
throw new ClientError("Fatal Error: nextcloud data.nextcloud.system missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
if (rawResult.ocs.data.nextcloud.storage) {
storage = rawResult.ocs.data.nextcloud.storage;
} else {
throw new ClientError("Fatal Error: nextcloud data.nextcloud.storage missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
if (rawResult.ocs.data.nextcloud.shares) {
shares = rawResult.ocs.data.nextcloud.shares;
} else {
throw new ClientError("Fatal Error: nextcloud data.nextcloud.shares missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
} else {
throw new ClientError("Fatal Error: nextcloud data.nextcloud missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
if (rawResult.ocs.data.server) {
server = rawResult.ocs.data.server;
} else {
throw new ClientError("Fatal Error: nextcloud data.server missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
if (rawResult.ocs.data.activeUsers) {
activeUsers = rawResult.ocs.data.activeUsers;
} else {
throw new ClientError("Fatal Error: nextcloud data.activeUsers missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
} else {
throw new ClientError("Fatal Error: nextcloud system data missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
const result: ISystemInfo = {
activeUsers,
nextcloud: {
shares,
storage,
system,
},
nextcloudClient: {
// eslint-disable-next-line @typescript-eslint/no-var-requires
version: require("../package.json").version,
},
server,
};
return result;
}
public async getSystemBasicData(): Promise<ISysBasicData> {
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const response: Response = await this.getHttpResponse(this.nextcloudOrigin + "/ocs/v2.php/apps/serverinfo/api/v1/basicdata", requestInit, [200], { description: "System Basic Data get" });
const rawResult: any = await response.json();
// console.log("Basic Data\n", JSON.stringify(rawResult));
let result: ISysBasicData;
if (rawResult && rawResult.ocs && rawResult.ocs.data && rawResult.ocs.data.servertime && rawResult.ocs.data.uptime && rawResult.ocs.data.timeservers) {
result = {
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
serverTimeString: rawResult.ocs.data.servertime.replace("\n", ""),
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
uptimeString: rawResult.ocs.data.uptime.replace("\n", ""),
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
timeServersString: rawResult.ocs.data.timeservers.trim(),
};
} else {
throw new ClientError("Fatal Error: nextcloud basic data missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
return result;
}
// ***************************************************************************************
// user management
// ***************************************************************************************
// ***************************************************************************************
// user group
// spec: https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/instruction_set_for_groups.html
// ***************************************************************************************
/**
* returns a list of user groups
* @param search string
* @param limit number
* @param offset number
* @returns list of user groups
* @throws QueryLimitError
* @throws QueryOffsetError
*/
public async getUserGroups(search?: string, limit?: number, offset?: number): Promise<UserGroup[]> {
log.debug("getUserGroups");
const userGroupIds: string[] = await this.getUserGroupIds(search, limit, offset);
const userGroups: UserGroup[] = [];
for (const userGroupId of userGroupIds) {
userGroups.push(new UserGroup(this, userGroupId));
}
return userGroups;
}
/**
* returns a list of user groups
* @param search string
* @param limit number
* @param offset number
* @returns list of user groups
* @throws QueryLimitError
* @throws QueryOffsetError
*/
public async getUserGroupIds(search?: string, limit?: number, offset?: number): Promise<string[]> {
log.debug("getUserGroupIds");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
let url = this.getOcsUrl(`/groups`);
const queryParameter: string[] = [];
if (search) {
queryParameter.push(`search=${search}`);
}
if (limit) {
if (limit < 1) {
throw new QueryLimitError("The limit must be larger than 0");
}
queryParameter.push(`limit=${limit}`);
}
if (offset) {
if (offset < 1) {
throw new QueryOffsetError("The offset must be larger than 0");
}
queryParameter.push(`offset=${offset}`);
}
if (queryParameter.join("&").length > 1) {
url += "?" + queryParameter.join("&");
}
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: "User Groups get" });
const rawResult: any = await response.json();
/*
{
ocs: {
meta: {
status: 'ok',
statuscode: 100,
message: 'OK',
totalitems: '',
itemsperpage: ''
},
data: { groups: ["g1", "g2"] }
}
}
*/
const userGroups: string[] = [];
if (rawResult.ocs && rawResult.ocs.data && rawResult.ocs.data.groups) {
log.debug("groups", rawResult.ocs.data.groups);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
rawResult.ocs.data.groups.forEach((value: string) => {
// userGroups.push(new UserGroup(this, value));
userGroups.push(value);
});
}
return userGroups;
}
/**
* get user group
* @param id string
* @returns Promise<UserGroup|null>
*/
public async getUserGroup(id: string): Promise<UserGroup | null> {
const userGroups: UserGroup[] = await this.getUserGroups(id);
if (userGroups[0]) {
return userGroups[0];
}
return null;
}
/**
* returns a list of user ids that are members of the user group
* @param id string
* @returns list of member user ids
* @throws [UserGroupDoesNotExistError}
*/
public async getUserGroupMembers(id: string): Promise<string[]> {
log.debug("getUserGroupMembers");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const url = this.getOcsUrl(`/groups/${id}`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: "User group get members" });
const rawResult: any = await response.json();
const userIds: string[] = [];
if (this.getOcsMetaStatus(rawResult).code === 404) {
throw new UserGroupDoesNotExistError(`User Group ${id} does not exist`);
}
if (rawResult.ocs && rawResult.ocs.data && rawResult.ocs.data.users) {
log.debug("members", rawResult.ocs.data.users);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
rawResult.ocs.data.users.forEach((value: string) => {
userIds.push(value);
});
}
return userIds;
}
/**
* returns a list of user ids that are subadmins of the user group
* @param id string
* @returns list of subadmin user ids
* @throws [UserGroupDoesNotExistError}
*/
public async getUserGroupSubadmins(id: string): Promise<string[]> {
log.debug("getUserGroupsubadmins");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const url = this.getOcsUrl(`/groups/${id}/subadmins`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: "User group get subadmins" });
const rawResult: any = await response.json();
const userIds: string[] = [];
if (this.getOcsMetaStatus(rawResult).code === 101) {
throw new UserGroupDoesNotExistError(`User Group ${id} does not exist`);
}
if (rawResult.ocs && rawResult.ocs.data) {
log.debug("subadmins", rawResult.ocs.data);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
rawResult.ocs.data.forEach((value: string) => {
userIds.push(value);
});
}
return userIds;
}
/**
* create a new user group
* @async
* @param {string} id user group id
* @returns {Promise<UserGroup>}
* @throws {UserGroupAlreadyExistsError}
*/
public async createUserGroup(id: string): Promise<UserGroup> {
log.debug("createUserGroup id=", id);
const requestInit: RequestInit = {
body: JSON.stringify({ groupid: id }),
headers: this.getOcsHeaders(),
method: "POST",
};
log.debug("request body: ", requestInit.body);
const response: Response = await this.getHttpResponse(this.getOcsUrl(`/groups`), requestInit, [200], { description: "UserGroup create" });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 102) {
throw new UserGroupAlreadyExistsError(`User Group ${id} already exists`);
}
if (this.getOcsMetaStatus(rawResult).code === 100) {
return new UserGroup(this, id);
}
throw new OperationFailedError(`User group ${id} could not be created: ${this.getOcsMetaStatus(rawResult).message}`);
}
/**
* deletes an existing user group
* @param id string
* @returns {Promise<void>}
* @throws {UserGroupDowsNotExistError}
* @throws {UserGroupDeletionFailedError}
*/
public async deleteUserGroup(id: string): Promise<void> {
log.debug("deleteUserGroup id=", id);
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "DELETE",
};
log.debug("request body: ", requestInit.body);
const response: Response = await this.getHttpResponse(this.getOcsUrl(`/groups/${id}`), requestInit, [200], { description: "UserGroup delete" });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 101) {
throw new UserGroupDoesNotExistError(`User Group ${id} does not exists`);
}
if (this.getOcsMetaStatus(rawResult).code === 102) {
throw new UserGroupDeletionFailedError(`User Group ${id} could not be deleted`);
}
}
// ***************************************************************************************
// user
// spec: https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/instruction_set_for_users.html
// ***************************************************************************************
/**
* returns a list of users
* https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/instruction_set_for_users.html#search-get-users
* @param search string
* @param limit number
* @param offset number
*/
public async getUsers(search?: string, limit?: number, offset?: number): Promise<User[]> {
log.debug("getUsers");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
let url = this.getOcsUrl(`/users`);
const queryParameter: string[] = [];
if (search) {
queryParameter.push(`search=${search}`);
}
if (limit) {
if (limit < 1) {
throw new QueryLimitError("The limit must be larger than 0");
}
queryParameter.push(`limit=${limit}`);
}
if (offset) {
if (offset < 1) {
throw new QueryOffsetError("The offset must be larger than 0");
}
queryParameter.push(`offset=${offset}`);
}
if (queryParameter.join("&").length > 1) {
url += "?" + queryParameter.join("&");
}
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: "Users get" });
const rawResult: any = await response.json();
/*
{
ocs: {
meta: {
status: 'ok',
statuscode: 100,
message: 'OK',
totalitems: '',
itemsperpage: ''
},
data: { users: ["u1", "u2"] }
}
}
*/
const users: User[] = [];
if (rawResult.ocs && rawResult.ocs.data && rawResult.ocs.data.users) {
log.debug("user ids", rawResult.ocs.data.users);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
rawResult.ocs.data.users.forEach((value: string) => {
users.push(new User(this, value));
});
}
return users;
}
/**
* returns user data
* @param id string the user id
* @returns Promise<IUserOptions> user data
* @throws {UserNotFoundError}
*/
public async getUserData(id: string): Promise<IUserOptions> {
log.debug("getUserData");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const url = this.getOcsUrl(`/users/${id}`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `User ${id} get` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 404) {
throw new UserNotFoundError(`User '${id}' not found`);
}
/*
{
ocs: {
meta: {
status: 'ok',
statuscode: 100,
message: 'OK',
totalitems: '',
itemsperpage: ''
},
data: { ... }
}
}
*/
log.debug("user data", rawResult.ocs.data);
const userData: IUserOptions = {
enabled: rawResult.ocs.data.enabled,
lastLogin: rawResult.ocs.data.lastLogin === 0 ? undefined : new Date(rawResult.ocs.data.lastLogin),
subadminGroups: rawResult.ocs.data.subadmin,
memberGroups: rawResult.ocs.data.groups,
quota: {
free: 0,
used: 0,
total: 0,
relative: 0,
quota: 0,
},
email: rawResult.ocs.data.email,
displayName: rawResult.ocs.data.displayname,
phone: rawResult.ocs.data.phone,
address: rawResult.ocs.data.address,
website: rawResult.ocs.data.website,
twitter: rawResult.ocs.data.twitter,
language: rawResult.ocs.data.language,
locale: rawResult.ocs.data.locale,
};
if (rawResult.ocs.data.quota.quota === "none") {
userData.quota = { quota: 0, relative: 0, used: 0 };
} else {
if (!rawResult.ocs.data.quota.relative) {
rawResult.ocs.data.quota.relative = 0;
}
userData.quota = { quota: rawResult.ocs.data.quota.quota, relative: rawResult.ocs.data.quota.relative, used: rawResult.ocs.data.quota.used };
if (rawResult.ocs.data.quota.free) {
userData.quota.free = rawResult.ocs.data.quota.free;
}
if (rawResult.ocs.data.quota.total) {
userData.quota.total = rawResult.ocs.data.quota.total;
}
}
return userData;
}
/**
* enables the user
* @param id string the user id
* @returns {Promise<void>}
* @throws {UserNotFoundError}
*/
public async enableUser(id: string): Promise<void> {
log.debug("enableUser");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "PUT",
};
const url = this.getOcsUrl(`/users/${id}/enable`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `User ${id} enable` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
throw new UserNotFoundError(`User '${id}' not found`);
}
/**
* disables the user
* @param id string the user id
* @returns {Promise<void>}
* @throws {UserNotFoundError}
*/
public async disableUser(id: string): Promise<void> {
log.debug("disableUser");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "PUT",
};
const url = this.getOcsUrl(`/users/${id}/disable`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `User ${id} disable` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
throw new UserNotFoundError(`User '${id}' not found`);
}
/**
* deletes the user
* @param id string the user id
* @returns {Promise<void>}
* @throws {UserNotFoundError}
*/
public async deleteUser(id: string): Promise<void> {
log.debug("deleteUser");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "DELETE",
};
const url = this.getOcsUrl(`/users/${id}`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `User ${id} delete` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
throw new UserNotFoundError(`User '${id}' not found`);
}
/**
* returns a user or null if not found
* @param id string
* @returns User | null
*/
public async getUser(id: string): Promise<User | null> {
log.debug("getUser");
const users: User[] = await this.getUsers(id);
if (users[0]) {
return users[0];
}
return null;
}
/**
* creates a new user with email or password
* @param options
* @returns User
* @throws UserAlreadyExistsError
* @throws {UserNotFoundError}
* @throws UserUpdateError
*/
public async createUser(options: { id: string; email?: string; password?: string }): Promise<User> {
log.debug("createUser");
const createUserBody: { userid: string; password?: string; email?: string } = { userid: options.id };
if (options.email) {
if (/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(options.email)) {
createUserBody.email = options.email;
} else {
throw new UserCreateError(`Error creating user '${options.id}' - invalid email address '${options.email}'`);
}
}
if (options.password) {
createUserBody.password = options.password;
}
const requestInit: RequestInit = {
body: JSON.stringify(createUserBody, null, 4),
headers: this.getOcsHeaders(),
method: "POST",
};
log.debug("request body: ", requestInit.body);
const response: Response = await this.getHttpResponse(this.getOcsUrl(`/users`), requestInit, [200], { description: `User ${options.id} create` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 102) {
throw new UserAlreadyExistsError(`User with id '${options.id}' already exists`);
}
const user: User | null = await this.getUser(options.id);
if (user) {
return user;
}
throw new UserCreateError(`Error creating user '${options.id}' - ${this.getOcsMetaStatus(rawResult).message} (${this.getOcsMetaStatus(rawResult).code})`);
}
/**
* updates a user property
* @async
* @param {string} id user id
* @param {UserProperty} property property name
* @param {string} value property value
* @returns {Promise<void>}
* @throws {UserNotFoundError}
* @throws {UserUpdateError}
*/
public async updateUserProperty(id: string, property: UserProperty, value: string): Promise<void> {
log.debug("updateUserProperty");
const body: { key: string; value: string } = { key: property, value };
const requestInit: RequestInit = {
body: JSON.stringify(body, null, 4),
headers: this.getOcsHeaders(),
method: "PUT",
};
const url = this.getOcsUrl(`/users/${id}`);
log.debug("request body: ", requestInit.body);
const response: Response = await this.getHttpResponse(url, requestInit, [200, 401], { description: `User ${id} update ${property}=${value}` });
const rawResult: any = await response.json();
// This service operation returns a 401, if the user does not exist - very strange...
// spec says to return 200 and status code 101
/*
if (this.getOcsMetaStatus(rawResult).code === 101) {
throw new UserNotFoundError(`User with id '${id}' not found`);
}
*/
// maybe this is due to a nextcloud api error
// it is not possible to distiguish beteen authentication error and user not found :-(
if (response.status === 401) {
throw new UserNotFoundError(`User with id '${id}' not found`);
}
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
if (property === UserProperty.password) {
value = "********";
}
// code 102 or 103
throw new UserUpdateError(`User with id '${id}' could not be updated - ${property}=${value}. ${rawResult.ocs.meta.message as string}`);
}
/**
* resend the welcome email
* @param id user id
* @throws {UserResendWelcomeEmailError}
*/
public async resendWelcomeEmail(id: string): Promise<void> {
log.debug("resendWelcomeEmail");
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "POST",
};
const url = this.getOcsUrl(`/users/${id}/welcome`);
log.debug("request body: ", requestInit.body);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `Resend welcome email for user ${id}` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 101) {
throw new UserResendWelcomeEmailError(`Error sending welcome email for '${id}': Email address not available`);
}
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
throw new UserResendWelcomeEmailError(`Error sending welcome email for '${id}' failed`);
}
/**
* adds a user to a group as member
* @param id string the user id
* @param userGroupId string the user group id
* @returns {Promise<void>}
* @throws {UserNotFoundError}
* @throws {UserGroupDoesNotExistError}
* @throws {InsufficientPrivilegesError}
* @throws {OperationFailedError}
*/
public async addUserToMemberUserGroup(id: string, userGroupId: string): Promise<void> {
log.debug("addUserToUserGroup");
const body: { groupid: string } = { groupid: userGroupId };
const requestInit: RequestInit = {
body: JSON.stringify(body, null, 4),
headers: this.getOcsHeaders(),
method: "POST",
};
const url = this.getOcsUrl(`/users/${id}/groups`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `Add user ${id} to user group ${userGroupId}` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
if (this.getOcsMetaStatus(rawResult).code === 102) {
throw new UserGroupDoesNotExistError(`User group ${userGroupId} does not exist`);
}
if (this.getOcsMetaStatus(rawResult).code === 103) {
throw new UserNotFoundError(`User ${id} does not exist`);
}
if (this.getOcsMetaStatus(rawResult).code === 104) {
throw new InsufficientPrivilegesError(`Insufficient privileges to add a user to a group`);
}
throw new OperationFailedError(`User ${id} could not be added to user group ${userGroupId}: ${this.getOcsMetaStatus(rawResult).message}`);
}
/**
* removes a user from a group as member
* @param id string the user id
* @param userGroupId string the user group id
* @returns {Promise<void>}
* @throws {UserNotFoundError}
* @throws {UserGroupDoesNotExistError}
* @throws {InsufficientPrivilegesError}
* @throws {OperationFailedError}
*/
public async removeUserFromMemberUserGroup(id: string, userGroupId: string): Promise<void> {
log.debug("removeUserFromMemberUserGroup");
const body: { groupid: string } = { groupid: userGroupId };
const requestInit: RequestInit = {
body: JSON.stringify(body, null, 4),
headers: this.getOcsHeaders(),
method: "DELETE",
};
const url = this.getOcsUrl(`/users/${id}/groups`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `Remove user ${id} from user group ${userGroupId}` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
if (this.getOcsMetaStatus(rawResult).code === 102) {
throw new UserGroupDoesNotExistError(`User group ${userGroupId} does not exist`);
}
if (this.getOcsMetaStatus(rawResult).code === 103) {
throw new UserNotFoundError(`User ${id} does not exist`);
}
if (this.getOcsMetaStatus(rawResult).code === 104) {
throw new InsufficientPrivilegesError(`Insufficient privileges to add a user to a group`);
}
throw new OperationFailedError(`User ${id} could not be added to user group ${userGroupId}: ${this.getOcsMetaStatus(rawResult).message}`);
}
/**
* promotes a user to a user group subadmin
* @param id string the user id
* @param userGroupId string the user group id
* @returns {Promise<void>}
* @throws {UserNotFoundError}
* @throws {UserGroupDoesNotExistError}
* @throws {InsufficientPrivilegesError}
* @throws {OperationFailedError}
*/
public async promoteUserToUserGroupSubadmin(id: string, userGroupId: string): Promise<void> {
log.debug("promoteUserToUserGroupSubadmin");
const body: { groupid: string } = { groupid: userGroupId };
const requestInit: RequestInit = {
body: JSON.stringify(body, null, 4),
headers: this.getOcsHeaders(),
method: "POST",
};
const url = this.getOcsUrl(`/users/${id}/subadmins`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `Promote User ${id} to user group subadmin ${userGroupId}` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
if (this.getOcsMetaStatus(rawResult).code === 102) {
throw new UserGroupDoesNotExistError(`User group ${userGroupId} does not exist`);
}
if (this.getOcsMetaStatus(rawResult).code === 101) {
throw new UserNotFoundError(`User ${id} does not exist`);
}
if (this.getOcsMetaStatus(rawResult).code === 104) {
throw new InsufficientPrivilegesError(`Insufficient privileges to add a user to a group`);
}
throw new OperationFailedError(`User ${id} could not be removed from user group ${userGroupId}: ${this.getOcsMetaStatus(rawResult).message}`);
}
/**
* Removes the subadmin rights for the user specified from the group specified
* @param id string the user id
* @param userGroupId string the user group id
* @returns {Promise<void>}
* @throws {InsufficientPrivilegesError}
* @throws {OperationFailedError}
*/
public async demoteUserFromSubadminUserGroup(id: string, userGroupId: string): Promise<void> {
log.debug("demoteUserFromSubadminUserGroup");
const body: { groupid: string } = { groupid: userGroupId };
const requestInit: RequestInit = {
body: JSON.stringify(body, null, 4),
headers: this.getOcsHeaders(),
method: "DELETE",
};
const url = this.getOcsUrl(`/users/${id}/subadmins`);
log.debug("url ", url);
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: `Demotes user ${id} from subadmin user group ${userGroupId}` });
const rawResult: any = await response.json();
if (this.getOcsMetaStatus(rawResult).code === 100) {
return;
}
// this API does not work like remove from group :-(
// 101 is for user group not found and user not found
/*
if (this.getOcsMetaStatus(rawResult).code === 101) {
throw new UserGroupDoesNotExistError(`User group ${userGroupId} does not exist`)
}
if (this.getOcsMetaStatus(rawResult).code === 101) {
throw new UserNotFoundError(`User ${id} does not exist`)
}
*/
if (this.getOcsMetaStatus(rawResult).code === 104) {
throw new InsufficientPrivilegesError(`Insufficient privileges to add a user to a group`);
}
throw new OperationFailedError(`User ${id} could not be demoted from subadmin user group ${userGroupId}: ${this.getOcsMetaStatus(rawResult).message}`);
}
/**
* insert or update complete user data
* @param options IUpsertUserOptions[]
* @returns Promise<IUpsertUserReport[]
*/
public async upsertUsers(options: IUpsertUserOptions[]): Promise<IUpsertUserReport[]> {
const report: IUpsertUserReport[] = [];
for (const option of options) {
const userReport: IUpsertUserReport = { id: option.id, message: "", changes: [] };
let user: User | null = await this.getUser(option.id);
// create or update user?
if (!user) {
try {
user = await this.createUser({ id: option.id, email: option.email, password: option.password });
userReport.message = `User ${option.id} created`;
} catch (e) {
userReport.message = `Create user ${option.id} failed ${e.message as string}`;
report.push(userReport);
continue;
}
} else {
userReport.message = `User ${option.id} changed`;
}
let previousValue: string = "";
let newValue: string = "";
let property: string = "";
// ************************
// enabled
// ************************
if (option.enabled !== undefined) {
if ((await user.isEnabled()) && option.enabled === false) {
try {
await user.disable();
userReport.changes.push({ property: "enabled", previousValue: "true", newValue: "false" });
} catch (e) {
userReport.changes.push({ property: "enabled", previousValue: "true", newValue: "true", error: e.message });
}
}
if ((await user.isEnabled()) === false && option.enabled === true) {
try {
await user.enable();
userReport.changes.push({ property: "enabled", previousValue: "false", newValue: "true" });
} catch (e) {
userReport.changes.push({ property: "enabled", previousValue: "false", newValue: "false", error: e.message });
}
}
}
// ************************
// super admin
// ************************
if (option.superAdmin !== undefined) {
if ((await user.isSuperAdmin()) && option.superAdmin === false) {
try {
await user.demoteFromSuperAdmin();
userReport.changes.push({ property: "superAdmin", previousValue: "true", newValue: "false" });
} catch (e) {
userReport.changes.push({ property: "superAdmin", previousValue: "true", newValue: "true", error: e.message });
}
}
if ((await user.isSuperAdmin()) === false && option.superAdmin === true) {
try {
await user.promoteToSuperAdmin();
userReport.changes.push({ property: "superAdmin", previousValue: "false", newValue: "true" });
} catch (e) {
userReport.changes.push({ property: "superAdmin", previousValue: "false", newValue: "false", error: e.message });
}
}
}
// ************************
// member groups
// ************************
if (option.memberGroups !== undefined) {
const previousGroups: string[] = await user.getMemberUserGroupIds();
const newGroups: string[] = option.memberGroups;
if (option.superAdmin !== undefined) {
if (option.superAdmin === true) {
if (newGroups.indexOf("admin") === -1) {
newGroups.push("admin");
}
}
}
const groupsToAdd: string[] = newGroups.filter((x) => !previousGroups.includes(x));
const groupsToRemove: string[] = previousGroups.filter((x) => !newGroups.includes(x));
let userGroup: UserGroup | null;
property = "memberGroups";
let error: Error | null = null;
for (const groupId of groupsToAdd) {
userGroup = await this.getUserGroup(groupId);
if (!userGroup) {
try {
userGroup = await this.createUserGroup(groupId);
} catch (e) {
error = e as Error;
break;
}
}
try {
await user.addToMemberUserGroup(userGroup);
} catch (e) {
error = e as Error;
break;
}
}
for (const groupId of groupsToRemove) {
try {
await user.removeFromMemberUserGroup(new UserGroup(this, groupId));
} catch (e) {
error = e as Error;
break;
}
}
if (error) {
userReport.changes.push({ property, previousValue: previousGroups.join(", "), newValue: previousGroups.join(", "), error: error.message });
} else {
Eif (groupsToAdd.length > 0 || groupsToRemove.length > 0) {
userReport.changes.push({ property, previousValue: previousGroups.join(", "), newValue: newGroups.join(", ") });
}
}
}
// ************************
// subadmin groups
// ************************
if (option.subadminGroups !== undefined) {
const previousGroups: string[] = await user.getSubadminUserGroupIds();
const newGroups: string[] = option.subadminGroups;
const groupsToAdd: string[] = newGroups.filter((x) => !previousGroups.includes(x));
const groupsToRemove: string[] = previousGroups.filter((x) => !newGroups.includes(x));
let userGroup: UserGroup | null;
property = "subadminGroups";
let error: Error | null = null;
for (const groupId of groupsToAdd) {
userGroup = await this.getUserGroup(groupId);
if (!userGroup) {
try {
userGroup = await this.createUserGroup(groupId);
} catch (e) {
error = e as Error;
break;
}
}
try {
await user.promoteToUserGroupSubadmin(userGroup);
} catch (e) {
error = e as Error;
break;
}
}
for (const groupId of groupsToRemove) {
try {
await user.demoteFromSubadminUserGroup(new UserGroup(this, groupId));
} catch (e) {
error = e as Error;
break;
}
}
if (error) {
userReport.changes.push({ property, previousValue: previousGroups.join(", "), newValue: previousGroups.join(", "), error: error.message });
} else {
userReport.changes.push({ property, previousValue: previousGroups.join(", "), newValue: newGroups.join(", ") });
}
}
// ************************
// display name
// ************************
if (option.displayName !== undefined) {
previousValue = await user.getDisplayName();
newValue = option.displayName;
property = "displayName";
if (previousValue !== newValue) {
try {
await user.setDisplayName(option.displayName);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// email
// ************************
if (option.email !== undefined) {
previousValue = await user.getEmail();
newValue = option.email;
property = "email";
if (previousValue !== newValue) {
try {
await user.setEmail(option.email);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// language
// ************************
if (option.language !== undefined) {
previousValue = await user.getLanguage();
newValue = option.language;
property = "language";
if (previousValue !== newValue) {
try {
await user.setLanguage(option.language);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// locale
// ************************
if (option.locale !== undefined) {
previousValue = await user.getLocale();
newValue = option.locale;
property = "locale";
if (previousValue !== newValue) {
try {
await user.setLocale(option.locale);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// twitter
// ************************
if (option.twitter !== undefined) {
previousValue = await user.getTwitter();
newValue = option.twitter;
property = "twitter";
if (previousValue !== newValue) {
try {
await user.setTwitter(option.twitter);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// phone
// ************************
if (option.phone !== undefined) {
previousValue = await user.getPhone();
newValue = option.phone;
property = "phone";
if (previousValue !== newValue) {
try {
await user.setPhone(option.phone);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// password
// ************************
if (option.password !== undefined) {
previousValue = "********";
newValue = option.password;
property = "password";
try {
await user.setPassword(option.password);
userReport.changes.push({ property, previousValue, newValue: previousValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
// ************************
// address
// ************************
if (option.address !== undefined) {
previousValue = await user.getAddress();
newValue = option.address;
property = "address";
if (previousValue !== newValue) {
try {
await user.setAddress(option.address);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// website
// ************************
if (option.website !== undefined) {
previousValue = await user.getWebsite();
newValue = option.website;
property = "website";
if (previousValue !== newValue) {
try {
await user.setWebsite(option.website);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// quota
// ************************
if (option.quota !== undefined) {
previousValue = (await user.getQuotaUserFriendly()).quota;
newValue = option.quota;
property = "quota";
if (previousValue !== newValue) {
try {
await user.setQuota(option.quota);
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
// ************************
// resend welcome email
// ************************
if (option.resendWelcomeEmail !== undefined) {
previousValue = "not sent";
newValue = "sent";
property = "resendWelcomeEmail";
if (option.resendWelcomeEmail) {
try {
await user.resendWelcomeEmail();
userReport.changes.push({ property, previousValue, newValue });
} catch (e) {
let message = "";
Eif (e instanceof Error) {
message = e.message;
}
userReport.changes.push({ property, previousValue, newValue: previousValue, error: message });
}
}
}
if (userReport.changes.length === 0) {
userReport.message = `User ${option.id} not changed`;
}
report.push(userReport);
}
return report;
}
// ***************************************************************************************
// shares
// https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-share-api.html
// ***************************************************************************************
/**
* create a new share
*/
public async createShare(options: ICreateShare): Promise<Share> {
const shareRequest = Share.createShareRequestBody(options);
log.debug(shareRequest);
const requestInit: RequestInit = {
body: shareRequest,
headers: this.getOcsHeaders(),
method: "POST",
};
const url = this.nextcloudOrigin + "/ocs/v2.php/apps/files_sharing/api/v1/shares";
// try {
const response: Response = await this.getHttpResponse(url, requestInit, [200, 204], { description: "Share create" });
const rawResult: { ocs: { data: { id: string } } } = (await response.json()) as { ocs: { data: { id: string } } };
log.debug(rawResult);
const share: Share = await Share.getShare(this, rawResult.ocs.data.id);
if (options.publicUpload) {
await share.setPublicUpload();
}
return share;
/* } catch (e) {
log.debug("result " + e.message);
log.debug("requestInit ", JSON.stringify(requestInit, null, 4));
log.debug("headers " + JSON.stringify(headers, null, 4));
log.debug("url ", url);
throw e;
} */
}
/**
* update a new share
*/
public async updateShare(shareId: string, body: { password: string } | { expireDate: string } | { note: string } | { permissions: number }): Promise<void> {
log.debug("updateShare body ", body);
const requestInit: RequestInit = {
body: JSON.stringify(body, null, 4),
headers: this.getOcsHeaders(),
method: "PUT",
};
const url = this.nextcloudOrigin + "/ocs/v2.php/apps/files_sharing/api/v1/shares/" + shareId;
await this.getHttpResponse(url, requestInit, [200], { description: "Share update" });
}
/**
* get share information
* @param shareId
*/
public async getShare(shareId: string): Promise<any> {
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const url = this.nextcloudOrigin + "/ocs/v2.php/apps/files_sharing/api/v1/shares/" + shareId;
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: "Share get" });
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
return await response.json();
/*
} catch (e) {
log.debug("result " + e.message);
log.debug("requestInit ", JSON.stringify(requestInit, null, 4));
log.debug("headers " + JSON.stringify(headers, null, 4));
log.debug("url ", url);
throw e;
}
*/
}
/**
* get share information
* @param shareId
*/
public async deleteShare(shareId: string): Promise<any> {
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "DELETE",
};
const url = this.nextcloudOrigin + "/ocs/v2.php/apps/files_sharing/api/v1/shares/" + shareId;
const response: Response = await this.getHttpResponse(url, requestInit, [200], { description: "Share delete" });
}
// ***************************************************************************************
// notfication management
// ***************************************************************************************
/**
* @returns array of notification objects
*/
// eslint-disable-next-line @typescript-eslint/ban-types
public async getNotifications(): Promise<object[]> {
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const response: Response = await this.getHttpResponse(this.nextcloudOrigin + "/ocs/v2.php/apps/notifications/api/v2/notifications", requestInit, [200, 404], { description: "Notifications get" });
// no notification found
if (response.status === 404) {
return [];
}
const rawResult: any = await response.json();
let notifications = [];
if (rawResult && rawResult.ocs && rawResult.ocs.data) {
notifications = rawResult.ocs.data;
} else {
throw new ClientError("Fatal Error: nextcloud notifications data missing", "ERR_SYSTEM_INFO_MISSING_DATA"); // @todo wrong error message
}
// eslint-disable-next-line @typescript-eslint/ban-types
const result: object[] = notifications;
return result;
}
// eslint-disable-next-line @typescript-eslint/ban-types
public async getUpdateNotifications(version: string): Promise<object> {
// @todo refactoring... /ocs/v2.php/apps/notifications/api/v2/notifications/<id> (GET/DELETE)
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const response: Response = await this.getHttpResponse(this.nextcloudOrigin + `/ocs/v2.php/apps/updatenotification/api/v1/applist/${version}`, requestInit, [200], { description: "UpdateNotifications get" });
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const rawResult: any = await response.json();
let updateNotification = {};
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
if (rawResult && rawResult.ocs && rawResult.ocs.data) {
updateNotification = rawResult.ocs.data;
} else {
throw new ClientError("Fatal Error: nextcloud notifications data missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
// eslint-disable-next-line @typescript-eslint/ban-types
const result: object = updateNotification;
return result;
}
// @todo to be refactored to user
public async sendNotificationToUser(userId: string, shortMessage: string, longMessage?: string): Promise<void> {
const requestInit: RequestInit = {
headers: new Headers({
// eslint-disable-next-line @typescript-eslint/naming-convention
Accept: "application/json",
// eslint-disable-next-line @typescript-eslint/naming-convention
"Content-Type": "application/x-www-form-urlencoded",
// eslint-disable-next-line @typescript-eslint/naming-convention
"OCS-APIRequest": "true",
}),
method: "POST",
};
if (!longMessage) {
longMessage = "";
}
longMessage = `&longMessage=${encodeURIComponent(longMessage)}`;
const queryString = `${encodeURIComponent(userId)}?shortMessage=${encodeURIComponent(shortMessage)}${longMessage}`;
await this.getHttpResponse(this.nextcloudOrigin + `/ocs/v2.php/apps/admin_notifications/api/v1/notifications/${queryString}`, requestInit, [200], { description: "User create" });
// const response: Response = await this.getHttpResponse(this.nextcloudOrigin + `/ocs/v2.php/apps/admin_notifications/api/v1/notifications/${queryString}`, requestInit, [200], { description: "User create" });
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
// const rawResult: any = await response.json();
// console.log(rawResult);
}
// ***************************************************************************************
// apps management
// ***************************************************************************************
/**
* returns apps
*/
public async getApps(): Promise<string[]> {
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const response: Response = await this.getHttpResponse(this.getOcsUrl(`/apps`), requestInit, [200], { description: "Apps get" });
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const rawResult: any = await response.json();
let apps = [];
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
if (rawResult && rawResult.ocs && rawResult.ocs.data) {
apps = rawResult.ocs.data;
} else {
throw new ClientError("Fatal Error: nextcloud apps data missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
const result: string[] = apps;
return result;
}
// eslint-disable-next-line @typescript-eslint/ban-types
public async getAppInfos(appName: string): Promise<object> {
const requestInit: RequestInit = {
headers: this.getOcsHeaders(),
method: "GET",
};
const response: Response = await this.getHttpResponse(this.getOcsUrl(`/apps/${appName}`), requestInit, [200], { description: "App Infos get" });
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const rawResult: any = await response.json();
let appInfo = {};
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
if (rawResult && rawResult.ocs && rawResult.ocs.data) {
appInfo = rawResult.ocs.data;
} else {
throw new ClientError("Fatal Error: nextcloud apps data missing", "ERR_SYSTEM_INFO_MISSING_DATA");
}
// eslint-disable-next-line @typescript-eslint/ban-types
const result: object = appInfo;
return result;
}
// ***************************************************************************************
// private methods
// ***************************************************************************************
/**
* asserts valid xml
* asserts multistatus response
* asserts that a href is available in the multistatus response
* asserts propstats and prop
* @param response the http response
* @param href get only properties that match the href
* @returns array of properties
* @throws GeneralError
*/
private async getPropertiesFromWebDAVMultistatusResponse(response: Response, href: string): Promise<any[]> {
const responseContentType: string | null = response.headers.get("Content-Type");
if (!responseContentType) {
throw new ClientError("Response content type expected", "ERR_RESPONSE_WITHOUT_CONTENT_TYPE_HEADER");
}
if (responseContentType.indexOf("application/xml") === -1) {
throw new ClientError("XML response content type expected", "ERR_XML_RESPONSE_CONTENT_TYPE_EXPECTED");
}
const xmlBody: string = await response.text();
if (parser.validate(xmlBody) !== true) {
throw new ClientError(`The response is not valid XML: ${xmlBody}`, "ERR_RESPONSE_NOT_INVALID_XML");
}
const options: any = {
ignoreNameSpace: true,
};
const body: any = parser.parse(xmlBody, options);
// ensure that we have a multistatus response
if (!body.multistatus || !body.multistatus.response) {
throw new ClientError(`The response is is not a WebDAV multistatus response`, "ERR_RESPONSE_NO_MULTISTATUS_XML");
}
// ensure that response is always an array
if (body.multistatus.response.href || body.multistatus.response.propstat) {
body.multistatus.response = new Array(body.multistatus.response);
}
/*
if (body.multistatus.response.propstat) {
body.multistatus.response = [body.multistatus.response];
}
*/
const responseProperties: any[] = [];
for (const res of body.multistatus.response) {
if (!res.href) {
throw new ClientError(`The mulitstatus response must have a href`, "ERR_RESPONSE_MISSING_HREF_MULTISTATUS");
}
if (!res.propstat) {
throw new ClientError(`The mulitstatus response must have a "propstat" container`, "ERR_RESPONSE_MISSING_PROPSTAT");
}
let propStats = res.propstat;
// ensure an array
if (res.propstat.status || res.propstat.prop) {
propStats = [res.propstat];
}
for (const propStat of propStats) {
if (!propStat.status) {
throw new ClientError(`The propstat must have a "status"`, "ERR_RESPONSE_MISSING_PROPSTAT_STATUS");
}
if (propStat.status === "HTTP/1.1 200 OK") {
if (!propStat.prop) {
throw new ClientError(`The propstat must have a "prop"`, "ERR_RESPONSE_MISSING_PROPSTAT_PROP");
}
const property: any = propStat.prop;
// eslint-disable-next-line no-underscore-dangle
property._href = res.href;
responseProperties.push(property);
}
}
// }
}
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
return responseProperties;
}
/**
* nextcloud creates a csrf token and stores it in the html header attribute
* data-requesttoken
* this function is currently not used
* @returns the csrf token / requesttoken
*/
/*
private async getCSRFToken(): Promise<string> {
const requestInit: RequestInit = {
method: "GET",
};
const response: Response = await this.getHttpResponse(
this.nextcloudOrigin,
requestInit,
[200],
{ description: "CSER token get" });
const html = await response.text();
const requestToken: string = html.substr(html.indexOf("data-requesttoken=") + 19, 89);
log.debug("getCSRFToken ", requestToken);
return requestToken;
}
*/
private async getHttpResponse(url: string, requestInit: RequestInit, expectedHttpStatusCode: number[], context: IRequestContext): Promise<Response> {
if (!requestInit.headers) {
requestInit.headers = new Headers();
}
/* istanbul ignore else */
if (this.fakeServer) {
return await this.fakeServer.getFakeHttpResponse(url, requestInit, expectedHttpStatusCode, context);
} else {
return await this.httpClient!.getHttpResponse(url, requestInit, expectedHttpStatusCode, context);
}
}
/**
* get contents array of a folder
* @param folderName Name of the folder like "/company/branches/germany"
* @param folderIndicator true if folders are requested otherwise files
* @returns array of folder contents meta data
*/
private async contents(folderName: string, folderIndicator: boolean): Promise<any[]> {
log.debug("Contents: folder ", folderName);
const folders: Folder[] = [];
folderName = this.sanitizeFolderName(folderName);
const resultArray: any[] = [];
if (folderIndicator === true) {
log.debug("Contents: get folders");
} else {
log.debug("Contents: get files");
}
try {
const folderContentsArray = await this.getFolderContents(folderName);
// log.debug("###########################");
// log.debug("$s", JSON.stringify(folderContentsArray, null, 4));
// log.debug("###########################");
for (const folderElement of folderContentsArray) {
if (folderElement.type === "directory") {
if (folderIndicator === true) {
resultArray.push(folderElement);
}
} else {
if (folderIndicator === false) {
log.debug("Contents folder element file ", folderElement);
resultArray.push(folderElement);
}
}
}
} catch (e) {
log.debug("Contents: exception occurred ", e.message);
}
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
return resultArray;
}
private sanitizeFolderName(folderName: string): string {
if (folderName[0] !== "/") {
folderName = "/" + folderName;
}
// remove trailing "/" es
folderName = folderName.replace(/\/+$/, "");
if (folderName === "") {
folderName = "/";
}
return folderName;
}
private getTagIdFromHref(href: string): number {
return parseInt(href.split("/")[href.split("/").length - 1], 10);
}
private async createFolderInternal(folderName: string): Promise<void> {
const url: string = this.webDAVUrl + folderName;
log.debug("createFolderInternal ", url);
const requestInit: RequestInit = {
method: "MKCOL",
};
try {
await this.getHttpResponse(url, requestInit, [201], { description: "Folder create" });
} catch (err) {
log.debug(`Error in createFolderInternal ${err.message as string} ${requestInit.method || ""} ${url}`);
throw err;
}
}
private async stat(fileName: string): Promise<IStat> {
const url: string = this.webDAVUrl + fileName;
log.debug("stat ", url);
const requestInit: RequestInit = {
body: `<?xml version="1.0"?>
<d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
<d:prop>
<d:getlastmodified />
<d:getetag />
<d:getcontenttype />
<d:resourcetype />
<oc:fileid />
<oc:permissions />
<oc:size />
<d:getcontentlength />
<nc:has-preview />
<oc:favorite />
<oc:comments-unread />
<oc:owner-display-name />
<oc:share-types />
</d:prop>
</d:propfind>`,
// headers: new Headers({ Depth: "0" }),
headers: new Headers(),
method: "PROPFIND",
};
let response: Response;
try {
response = await this.getHttpResponse(url, requestInit, [207], { description: "File/Folder get details" });
} catch (err) {
log.debug(`Error in stat ${err.message as string} ${requestInit.method || ""} ${url}`);
throw err;
}
const properties: any[] = await this.getPropertiesFromWebDAVMultistatusResponse(response, "");
let resultStat: IStat | null = null;
for (const prop of properties) {
resultStat = {
basename: basename(fileName),
fileid: prop.fileid,
filename: fileName,
lastmod: prop.getlastmodified,
type: "file",
};
if (prop.getcontentlength) {
resultStat.size = prop.getcontentlength;
} else {
resultStat.type = "directory";
}
if (prop.getcontenttype) {
resultStat.mime = prop.getcontenttype;
}
}
if (!resultStat) {
log.debug("Error: response ", JSON.stringify(properties, null, 4));
throw new ClientError("Error getting status information from : " + url, "ERR_STAT");
}
return resultStat;
}
private getOcsMetaStatus(input: any): { code: number; message: string } {
let code: number;
let message: string = "";
if (input.ocs && input.ocs.meta && input.ocs.meta.statuscode) {
code = input.ocs.meta.statuscode;
if (input.ocs.meta.message) {
message = input.ocs.meta.message;
}
return { code, message };
}
throw new InvalidServiceResponseFormatError("Fatal Error: The OCS meta status could not be retrieved from OCS response");
}
private getOcsHeaders(): Headers {
return new Headers({
// eslint-disable-next-line @typescript-eslint/naming-convention
"OCS-APIRequest": "true",
// eslint-disable-next-line @typescript-eslint/naming-convention
"Content-Type": "application/json",
// eslint-disable-next-line @typescript-eslint/naming-convention
Accept: "application/json",
});
}
private getOcsUrl(suffix: string): string {
/*
if (!suffix) {
suffix = "";
}
if (!suffix.startsWith("/")) {
suffix = `/${suffix}`
}
*/
return `${this.nextcloudOrigin}/ocs/v1.php/cloud${suffix}`;
}
private async putFileContents(fileName: string, data: Buffer | NodeJS.ReadableStream): Promise<Response> {
const url: string = this.webDAVUrl + fileName;
log.debug("putFileContents ", url);
const requestInit: RequestInit = {
body: data,
method: "PUT",
};
let description = "File save content ";
Eif (data instanceof Buffer) {
description += "from buffer";
} else {
description += "from stream";
}
return await this.getHttpResponse(url, requestInit, [201, 204], { description });
}
}
|