1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654
// Copyright 2024 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! High-level room API
use std::{
borrow::Borrow,
collections::{BTreeMap, HashMap},
ops::Deref,
sync::Arc,
time::Duration,
};
#[cfg(all(feature = "e2e-encryption", not(target_arch = "wasm32")))]
use async_trait::async_trait;
use eyeball::SharedObservable;
use futures_core::Stream;
use futures_util::{
future::{try_join, try_join_all},
stream::FuturesUnordered,
};
use http::StatusCode;
#[cfg(all(feature = "e2e-encryption", not(target_arch = "wasm32")))]
pub use identity_status_changes::IdentityStatusChanges;
#[cfg(feature = "e2e-encryption")]
use matrix_sdk_base::crypto::{DecryptionSettings, RoomEventDecryptionResult};
#[cfg(all(feature = "e2e-encryption", not(target_arch = "wasm32")))]
use matrix_sdk_base::crypto::{IdentityStatusChange, RoomIdentityProvider, UserIdentity};
use matrix_sdk_base::{
deserialized_responses::{
RawAnySyncOrStrippedState, RawSyncOrStrippedState, SyncOrStrippedState, TimelineEvent,
},
media::MediaThumbnailSettings,
store::StateStoreExt,
ComposerDraft, RoomInfoNotableUpdateReasons, RoomMemberships, StateChanges, StateStoreDataKey,
StateStoreDataValue,
};
use matrix_sdk_common::{deserialized_responses::SyncTimelineEvent, timeout::timeout};
use mime::Mime;
#[cfg(feature = "e2e-encryption")]
use ruma::events::{
room::encrypted::OriginalSyncRoomEncryptedEvent, AnySyncMessageLikeEvent, AnySyncTimelineEvent,
SyncMessageLikeEvent,
};
use ruma::{
api::client::{
config::{set_global_account_data, set_room_account_data},
context,
error::ErrorKind,
filter::LazyLoadOptions,
membership::{
ban_user, forget_room, get_member_events,
invite_user::{self, v3::InvitationRecipient},
kick_user, leave_room, unban_user, Invite3pid,
},
message::send_message_event,
read_marker::set_read_marker,
receipt::create_receipt,
redact::redact_event,
room::{get_room_event, report_content},
state::{get_state_events_for_key, send_state_event},
tag::{create_tag, delete_tag},
typing::create_typing_event::{self, v3::Typing},
},
assign,
events::{
beacon::BeaconEventContent,
beacon_info::BeaconInfoEventContent,
call::notify::{ApplicationType, CallNotifyEventContent, NotifyType},
direct::DirectEventContent,
marked_unread::{MarkedUnreadEventContent, UnstableMarkedUnreadEventContent},
receipt::{Receipt, ReceiptThread, ReceiptType},
room::{
avatar::{self, RoomAvatarEventContent},
encryption::RoomEncryptionEventContent,
history_visibility::HistoryVisibility,
message::{
AudioInfo, AudioMessageEventContent, FileInfo, FileMessageEventContent,
FormattedBody, ImageMessageEventContent, MessageType, RoomMessageEventContent,
UnstableAudioDetailsContentBlock, UnstableVoiceContentBlock, VideoInfo,
VideoMessageEventContent,
},
name::RoomNameEventContent,
pinned_events::RoomPinnedEventsEventContent,
power_levels::{RoomPowerLevels, RoomPowerLevelsEventContent},
server_acl::RoomServerAclEventContent,
topic::RoomTopicEventContent,
ImageInfo, MediaSource, ThumbnailInfo,
},
space::{child::SpaceChildEventContent, parent::SpaceParentEventContent},
tag::{TagInfo, TagName},
typing::SyncTypingEvent,
AnyRoomAccountDataEvent, AnyRoomAccountDataEventContent, AnyTimelineEvent, EmptyStateKey,
Mentions, MessageLikeEventContent, MessageLikeEventType, OriginalSyncStateEvent,
RedactContent, RedactedStateEventContent, RoomAccountDataEvent,
RoomAccountDataEventContent, RoomAccountDataEventType, StateEventContent, StateEventType,
StaticEventContent, StaticStateEventContent, SyncStateEvent,
},
push::{Action, PushConditionRoomCtx},
serde::Raw,
time::Instant,
EventId, Int, MatrixToUri, MatrixUri, MxcUri, OwnedEventId, OwnedRoomId, OwnedServerName,
OwnedTransactionId, OwnedUserId, RoomId, TransactionId, UInt, UserId,
};
use serde::de::DeserializeOwned;
use thiserror::Error;
use tokio::sync::broadcast;
use tracing::{debug, info, instrument, warn};
use self::futures::{SendAttachment, SendMessageLikeEvent, SendRawMessageLikeEvent};
pub use self::{
member::{RoomMember, RoomMemberRole},
messages::{EventWithContextResponse, Messages, MessagesOptions},
};
#[cfg(doc)]
use crate::event_cache::EventCache;
use crate::{
attachment::{AttachmentConfig, AttachmentInfo},
client::WeakClient,
config::RequestConfig,
error::{BeaconError, WrongRoomState},
event_cache::{self, EventCacheDropHandles, RoomEventCache},
event_handler::{EventHandler, EventHandlerDropGuard, EventHandlerHandle, SyncEvent},
media::{MediaFormat, MediaRequestParameters},
notification_settings::{IsEncrypted, IsOneToOne, RoomNotificationMode},
room::power_levels::{RoomPowerLevelChanges, RoomPowerLevelsExt},
sync::RoomUpdate,
utils::{IntoRawMessageLikeEventContent, IntoRawStateEventContent},
BaseRoom, Client, Error, HttpResult, Result, RoomState, TransmissionProgress,
};
pub mod edit;
pub mod futures;
pub mod identity_status_changes;
mod member;
mod messages;
pub mod power_levels;
/// A struct containing methods that are common for Joined, Invited and Left
/// Rooms
#[derive(Debug, Clone)]
pub struct Room {
inner: BaseRoom,
pub(crate) client: Client,
}
impl Deref for Room {
type Target = BaseRoom;
fn deref(&self) -> &Self::Target {
&self.inner
}
}
const TYPING_NOTICE_TIMEOUT: Duration = Duration::from_secs(4);
const TYPING_NOTICE_RESEND_TIMEOUT: Duration = Duration::from_secs(3);
impl Room {
/// Create a new `Room`
///
/// # Arguments
/// * `client` - The client used to make requests.
///
/// * `room` - The underlying room.
pub(crate) fn new(client: Client, room: BaseRoom) -> Self {
Self { inner: room, client }
}
/// Leave this room.
///
/// Only invited and joined rooms can be left.
#[doc(alias = "reject_invitation")]
pub async fn leave(&self) -> Result<()> {
let state = self.state();
if state == RoomState::Left {
return Err(Error::WrongRoomState(WrongRoomState::new("Joined or Invited", state)));
}
let request = leave_room::v3::Request::new(self.inner.room_id().to_owned());
self.client.send(request, None).await?;
self.client.base_client().room_left(self.room_id()).await?;
Ok(())
}
/// Join this room.
///
/// Only invited and left rooms can be joined via this method.
#[doc(alias = "accept_invitation")]
pub async fn join(&self) -> Result<()> {
let state = self.state();
if state == RoomState::Joined {
return Err(Error::WrongRoomState(WrongRoomState::new("Invited or Left", state)));
}
let prev_room_state = self.inner.state();
let mark_as_direct = prev_room_state == RoomState::Invited
&& self.inner.is_direct().await.unwrap_or_else(|e| {
warn!(room_id = ?self.room_id(), "is_direct() failed: {e}");
false
});
self.client.join_room_by_id(self.room_id()).await?;
if mark_as_direct {
self.set_is_direct(true).await?;
}
Ok(())
}
/// Get the inner client saved in this room instance.
///
/// Returns the client this room is part of.
pub fn client(&self) -> Client {
self.client.clone()
}
/// Get the sync state of this room, i.e. whether it was fully synced with
/// the server.
pub fn is_synced(&self) -> bool {
self.inner.is_state_fully_synced()
}
/// Gets the avatar of this room, if set.
///
/// Returns the avatar.
/// If a thumbnail is requested no guarantee on the size of the image is
/// given.
///
/// # Arguments
///
/// * `format` - The desired format of the avatar.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use matrix_sdk::ruma::room_id;
/// # use matrix_sdk::media::MediaFormat;
/// # use url::Url;
/// # let homeserver = Url::parse("http://example.com").unwrap();
/// # async {
/// # let user = "example";
/// let client = Client::new(homeserver).await.unwrap();
/// client.matrix_auth().login_username(user, "password").send().await.unwrap();
/// let room_id = room_id!("!roomid:example.com");
/// let room = client.get_room(&room_id).unwrap();
/// if let Some(avatar) = room.avatar(MediaFormat::File).await.unwrap() {
/// std::fs::write("avatar.png", avatar);
/// }
/// # };
/// ```
pub async fn avatar(&self, format: MediaFormat) -> Result<Option<Vec<u8>>> {
let Some(url) = self.avatar_url() else { return Ok(None) };
let request = MediaRequestParameters { source: MediaSource::Plain(url.to_owned()), format };
Ok(Some(self.client.media().get_media_content(&request, true).await?))
}
/// Sends a request to `/_matrix/client/r0/rooms/{room_id}/messages` and
/// returns a `Messages` struct that contains a chunk of room and state
/// events (`RoomEvent` and `AnyStateEvent`).
///
/// With the encryption feature, messages are decrypted if possible. If
/// decryption fails for an individual message, that message is returned
/// undecrypted.
///
/// # Examples
///
/// ```no_run
/// use matrix_sdk::{room::MessagesOptions, Client};
/// # use matrix_sdk::ruma::{
/// # api::client::filter::RoomEventFilter,
/// # room_id,
/// # };
/// # use url::Url;
///
/// # let homeserver = Url::parse("http://example.com").unwrap();
/// # async {
/// let options =
/// MessagesOptions::backward().from("t47429-4392820_219380_26003_2265");
///
/// let mut client = Client::new(homeserver).await.unwrap();
/// let room = client.get_room(room_id!("!roomid:example.com")).unwrap();
/// assert!(room.messages(options).await.is_ok());
/// # };
/// ```
#[instrument(skip_all, fields(room_id = ?self.inner.room_id(), ?options))]
pub async fn messages(&self, options: MessagesOptions) -> Result<Messages> {
let room_id = self.inner.room_id();
let request = options.into_request(room_id);
let http_response = self.client.send(request, None).await?;
#[allow(unused_mut)]
let mut response = Messages {
start: http_response.start,
end: http_response.end,
#[cfg(not(feature = "e2e-encryption"))]
chunk: http_response.chunk.into_iter().map(TimelineEvent::new).collect(),
#[cfg(feature = "e2e-encryption")]
chunk: Vec::with_capacity(http_response.chunk.len()),
state: http_response.state,
};
#[cfg(feature = "e2e-encryption")]
for event in http_response.chunk {
let decrypted_event = if let Ok(AnySyncTimelineEvent::MessageLike(
AnySyncMessageLikeEvent::RoomEncrypted(SyncMessageLikeEvent::Original(_)),
)) = event.deserialize_as::<AnySyncTimelineEvent>()
{
if let Ok(event) = self.decrypt_event(event.cast_ref()).await {
event
} else {
TimelineEvent::new(event)
}
} else {
TimelineEvent::new(event)
};
response.chunk.push(decrypted_event);
}
if let Some(push_context) = self.push_context().await? {
let push_rules = self.client().account().push_rules().await?;
for event in &mut response.chunk {
event.push_actions =
Some(push_rules.get_actions(event.raw(), &push_context).to_owned());
}
}
Ok(response)
}
/// Register a handler for events of a specific type, within this room.
///
/// This method works the same way as [`Client::add_event_handler`], except
/// that the handler will only be called for events within this room. See
/// that method for more details on event handler functions.
///
/// `room.add_event_handler(hdl)` is equivalent to
/// `client.add_room_event_handler(room_id, hdl)`. Use whichever one is more
/// convenient in your use case.
pub fn add_event_handler<Ev, Ctx, H>(&self, handler: H) -> EventHandlerHandle
where
Ev: SyncEvent + DeserializeOwned + Send + 'static,
H: EventHandler<Ev, Ctx>,
{
self.client.add_room_event_handler(self.room_id(), handler)
}
/// Subscribe to all updates for this room.
///
/// The returned receiver will receive a new message for each sync response
/// that contains updates for this room.
pub fn subscribe_to_updates(&self) -> broadcast::Receiver<RoomUpdate> {
self.client.subscribe_to_room_updates(self.room_id())
}
/// Subscribe to typing notifications for this room.
///
/// The returned receiver will receive a new vector of user IDs for each
/// sync response that contains 'm.typing' event. The current user ID will
/// be filtered out.
pub fn subscribe_to_typing_notifications(
&self,
) -> (EventHandlerDropGuard, broadcast::Receiver<Vec<OwnedUserId>>) {
let (sender, receiver) = broadcast::channel(16);
let typing_event_handler_handle = self.client.add_room_event_handler(self.room_id(), {
let own_user_id = self.own_user_id().to_owned();
move |event: SyncTypingEvent| async move {
// Ignore typing notifications from own user.
let typing_user_ids = event
.content
.user_ids
.into_iter()
.filter(|user_id| *user_id != own_user_id)
.collect();
// Ignore the result. It can only fail if there are no listeners.
let _ = sender.send(typing_user_ids);
}
});
let drop_guard = self.client().event_handler_drop_guard(typing_event_handler_handle);
(drop_guard, receiver)
}
/// Subscribe to updates about users who are in "pin violation" i.e. their
/// identity has changed and the user has not yet acknowledged this.
///
/// The returned receiver will receive a new vector of
/// [`IdentityStatusChange`] each time a /keys/query response shows a
/// changed identity for a member of this room, or a sync shows a change
/// to the membership of an affected user. (Changes to the current user are
/// not directly included, but some changes to the current user's identity
/// can trigger changes to how we see other users' identities, which
/// will be included.)
///
/// The first item in the stream provides the current state of the room:
/// each member of the room who is not in "pinned" or "verified" state will
/// be included (except the current user).
///
/// If the `changed_to` property of an [`IdentityStatusChange`] is set to
/// `PinViolation` then a warning should be displayed to the user. If it is
/// set to `Pinned` then no warning should be displayed.
///
/// Note that if a user who is in pin violation leaves the room, a `Pinned`
/// update is sent, to indicate that the warning should be removed, even
/// though the user's identity is not necessarily pinned.
#[cfg(all(feature = "e2e-encryption", not(target_arch = "wasm32")))]
pub async fn subscribe_to_identity_status_changes(
&self,
) -> Result<impl Stream<Item = Vec<IdentityStatusChange>>> {
IdentityStatusChanges::create_stream(self.clone()).await
}
/// Returns a wrapping `TimelineEvent` for the input `AnyTimelineEvent`,
/// decrypted if needs be.
///
/// Doesn't return an error `Result` when decryption failed; only logs from
/// the crypto crate will indicate so.
async fn try_decrypt_event(&self, event: Raw<AnyTimelineEvent>) -> Result<TimelineEvent> {
#[cfg(feature = "e2e-encryption")]
if let Ok(AnySyncTimelineEvent::MessageLike(AnySyncMessageLikeEvent::RoomEncrypted(
SyncMessageLikeEvent::Original(_),
))) = event.deserialize_as::<AnySyncTimelineEvent>()
{
if let Ok(event) = self.decrypt_event(event.cast_ref()).await {
return Ok(event);
}
}
let mut event = TimelineEvent::new(event);
event.push_actions = self.event_push_actions(event.raw()).await?;
Ok(event)
}
/// Fetch the event with the given `EventId` in this room.
///
/// It uses the given [`RequestConfig`] if provided, or the client's default
/// one otherwise.
pub async fn event(
&self,
event_id: &EventId,
request_config: Option<RequestConfig>,
) -> Result<TimelineEvent> {
let request =
get_room_event::v3::Request::new(self.room_id().to_owned(), event_id.to_owned());
let raw_event = self.client.send(request, request_config).await?.event;
let event = self.try_decrypt_event(raw_event).await?;
// Save the event into the event cache, if it's set up.
if let Ok((cache, _handles)) = self.event_cache().await {
cache.save_event(event.clone().into()).await;
}
Ok(event)
}
/// Fetch the event with the given `EventId` in this room, using the
/// `/context` endpoint to get more information.
pub async fn event_with_context(
&self,
event_id: &EventId,
lazy_load_members: bool,
context_size: UInt,
request_config: Option<RequestConfig>,
) -> Result<EventWithContextResponse> {
let mut request =
context::get_context::v3::Request::new(self.room_id().to_owned(), event_id.to_owned());
request.limit = context_size;
if lazy_load_members {
request.filter.lazy_load_options =
LazyLoadOptions::Enabled { include_redundant_members: false };
}
let response = self.client.send(request, request_config).await?;
let target_event = if let Some(event) = response.event {
Some(self.try_decrypt_event(event).await?)
} else {
None
};
// Note: the joined future will fail if any future failed, but
// [`Self::try_decrypt_event`] doesn't hard-fail when there's a
// decryption error, so we should prevent against most bad cases here.
let (events_before, events_after) = try_join(
try_join_all(response.events_before.into_iter().map(|ev| self.try_decrypt_event(ev))),
try_join_all(response.events_after.into_iter().map(|ev| self.try_decrypt_event(ev))),
)
.await?;
// Save the loaded events into the event cache, if it's set up.
if let Ok((cache, _handles)) = self.event_cache().await {
let mut events_to_save: Vec<SyncTimelineEvent> = Vec::new();
if let Some(event) = &target_event {
events_to_save.push(event.clone().into());
}
for event in &events_before {
events_to_save.push(event.clone().into());
}
for event in &events_after {
events_to_save.push(event.clone().into());
}
cache.save_events(events_to_save).await;
}
Ok(EventWithContextResponse {
event: target_event,
events_before,
events_after,
state: response.state,
prev_batch_token: response.start,
next_batch_token: response.end,
})
}
pub(crate) async fn request_members(&self) -> Result<()> {
self.client
.locks()
.members_request_deduplicated_handler
.run(self.room_id().to_owned(), async move {
let request = get_member_events::v3::Request::new(self.inner.room_id().to_owned());
let response = self
.client
.send(
request.clone(),
// In some cases it can take longer than 30s to load:
// https://github.com/element-hq/synapse/issues/16872
Some(RequestConfig::new().timeout(Duration::from_secs(60)).retry_limit(3)),
)
.await?;
// That's a large `Future`. Let's `Box::pin` to reduce its size on the stack.
Box::pin(self.client.base_client().receive_all_members(
self.room_id(),
&request,
&response,
))
.await?;
Ok(())
})
.await
}
async fn request_encryption_state(&self) -> Result<()> {
self.client
.locks()
.encryption_state_deduplicated_handler
.run(self.room_id().to_owned(), async move {
// Request the event from the server.
let request = get_state_events_for_key::v3::Request::new(
self.room_id().to_owned(),
StateEventType::RoomEncryption,
"".to_owned(),
);
let response = match self.client.send(request, None).await {
Ok(response) => {
Some(response.content.deserialize_as::<RoomEncryptionEventContent>()?)
}
Err(err) if err.client_api_error_kind() == Some(&ErrorKind::NotFound) => None,
Err(err) => return Err(err.into()),
};
let _sync_lock = self.client.base_client().sync_lock().lock().await;
// Persist the event and the fact that we requested it from the server in
// `RoomInfo`.
let mut room_info = self.clone_info();
room_info.mark_encryption_state_synced();
room_info.set_encryption_event(response.clone());
let mut changes = StateChanges::default();
changes.add_room(room_info.clone());
self.client.store().save_changes(&changes).await?;
self.set_room_info(room_info, RoomInfoNotableUpdateReasons::empty());
Ok(())
})
.await
}
/// Check whether this room is encrypted. If the room encryption state is
/// not synced yet, it will send a request to fetch it.
///
/// Returns true if the room is encrypted, otherwise false.
pub async fn is_encrypted(&self) -> Result<bool> {
if !self.is_encryption_state_synced() {
self.request_encryption_state().await?;
}
Ok(self.inner.is_encrypted())
}
fn are_events_visible(&self) -> bool {
if let RoomState::Invited = self.inner.state() {
return matches!(
self.inner.history_visibility(),
HistoryVisibility::WorldReadable | HistoryVisibility::Invited
);
}
true
}
/// Sync the member list with the server.
///
/// This method will de-duplicate requests if it is called multiple times in
/// quick succession, in that case the return value will be `None`. This
/// method does nothing if the members are already synced.
pub async fn sync_members(&self) -> Result<()> {
if !self.are_events_visible() {
return Ok(());
}
if !self.are_members_synced() {
self.request_members().await
} else {
Ok(())
}
}
/// Get a specific member of this room.
///
/// *Note*: This method will fetch the members from the homeserver if the
/// member list isn't synchronized due to member lazy loading. Because of
/// that it might panic if it isn't run on a tokio thread.
///
/// Use [get_member_no_sync()](#method.get_member_no_sync) if you want a
/// method that doesn't do any requests.
///
/// # Arguments
///
/// * `user_id` - The ID of the user that should be fetched out of the
/// store.
pub async fn get_member(&self, user_id: &UserId) -> Result<Option<RoomMember>> {
self.sync_members().await?;
self.get_member_no_sync(user_id).await
}
/// Get a specific member of this room.
///
/// *Note*: This method will not fetch the members from the homeserver if
/// the member list isn't synchronized due to member lazy loading. Thus,
/// members could be missing.
///
/// Use [get_member()](#method.get_member) if you want to ensure to always
/// have the full member list to chose from.
///
/// # Arguments
///
/// * `user_id` - The ID of the user that should be fetched out of the
/// store.
pub async fn get_member_no_sync(&self, user_id: &UserId) -> Result<Option<RoomMember>> {
Ok(self
.inner
.get_member(user_id)
.await?
.map(|member| RoomMember::new(self.client.clone(), member)))
}
/// Get members for this room, with the given memberships.
///
/// *Note*: This method will fetch the members from the homeserver if the
/// member list isn't synchronized due to member lazy loading. Because of
/// that it might panic if it isn't run on a tokio thread.
///
/// Use [members_no_sync()](#method.members_no_sync) if you want a
/// method that doesn't do any requests.
pub async fn members(&self, memberships: RoomMemberships) -> Result<Vec<RoomMember>> {
self.sync_members().await?;
self.members_no_sync(memberships).await
}
/// Get members for this room, with the given memberships.
///
/// *Note*: This method will not fetch the members from the homeserver if
/// the member list isn't synchronized due to member lazy loading. Thus,
/// members could be missing.
///
/// Use [members()](#method.members) if you want to ensure to always get
/// the full member list.
pub async fn members_no_sync(&self, memberships: RoomMemberships) -> Result<Vec<RoomMember>> {
Ok(self
.inner
.members(memberships)
.await?
.into_iter()
.map(|member| RoomMember::new(self.client.clone(), member))
.collect())
}
/// Get all state events of a given type in this room.
pub async fn get_state_events(
&self,
event_type: StateEventType,
) -> Result<Vec<RawAnySyncOrStrippedState>> {
self.client.store().get_state_events(self.room_id(), event_type).await.map_err(Into::into)
}
/// Get all state events of a given statically-known type in this room.
///
/// # Examples
///
/// ```no_run
/// # async {
/// # let room: matrix_sdk::Room = todo!();
/// use matrix_sdk::ruma::{
/// events::room::member::RoomMemberEventContent, serde::Raw,
/// };
///
/// let room_members =
/// room.get_state_events_static::<RoomMemberEventContent>().await?;
/// # anyhow::Ok(())
/// # };
/// ```
pub async fn get_state_events_static<C>(&self) -> Result<Vec<RawSyncOrStrippedState<C>>>
where
C: StaticEventContent + StaticStateEventContent + RedactContent,
C::Redacted: RedactedStateEventContent,
{
Ok(self.client.store().get_state_events_static(self.room_id()).await?)
}
/// Get the state events of a given type with the given state keys in this
/// room.
pub async fn get_state_events_for_keys(
&self,
event_type: StateEventType,
state_keys: &[&str],
) -> Result<Vec<RawAnySyncOrStrippedState>> {
self.client
.store()
.get_state_events_for_keys(self.room_id(), event_type, state_keys)
.await
.map_err(Into::into)
}
/// Get the state events of a given statically-known type with the given
/// state keys in this room.
///
/// # Examples
///
/// ```no_run
/// # async {
/// # let room: matrix_sdk::Room = todo!();
/// # let user_ids: &[matrix_sdk::ruma::OwnedUserId] = &[];
/// use matrix_sdk::ruma::events::room::member::RoomMemberEventContent;
///
/// let room_members = room
/// .get_state_events_for_keys_static::<RoomMemberEventContent, _, _>(
/// user_ids,
/// )
/// .await?;
/// # anyhow::Ok(())
/// # };
/// ```
pub async fn get_state_events_for_keys_static<'a, C, K, I>(
&self,
state_keys: I,
) -> Result<Vec<RawSyncOrStrippedState<C>>>
where
C: StaticEventContent + StaticStateEventContent + RedactContent,
C::StateKey: Borrow<K>,
C::Redacted: RedactedStateEventContent,
K: AsRef<str> + Sized + Sync + 'a,
I: IntoIterator<Item = &'a K> + Send,
I::IntoIter: Send,
{
Ok(self.client.store().get_state_events_for_keys_static(self.room_id(), state_keys).await?)
}
/// Get a specific state event in this room.
pub async fn get_state_event(
&self,
event_type: StateEventType,
state_key: &str,
) -> Result<Option<RawAnySyncOrStrippedState>> {
self.client
.store()
.get_state_event(self.room_id(), event_type, state_key)
.await
.map_err(Into::into)
}
/// Get a specific state event of statically-known type with an empty state
/// key in this room.
///
/// # Examples
///
/// ```no_run
/// # async {
/// # let room: matrix_sdk::Room = todo!();
/// use matrix_sdk::ruma::events::room::power_levels::RoomPowerLevelsEventContent;
///
/// let power_levels = room
/// .get_state_event_static::<RoomPowerLevelsEventContent>()
/// .await?
/// .expect("every room has a power_levels event")
/// .deserialize()?;
/// # anyhow::Ok(())
/// # };
/// ```
pub async fn get_state_event_static<C>(&self) -> Result<Option<RawSyncOrStrippedState<C>>>
where
C: StaticEventContent + StaticStateEventContent<StateKey = EmptyStateKey> + RedactContent,
C::Redacted: RedactedStateEventContent,
{
self.get_state_event_static_for_key(&EmptyStateKey).await
}
/// Get a specific state event of statically-known type in this room.
///
/// # Examples
///
/// ```no_run
/// # async {
/// # let room: matrix_sdk::Room = todo!();
/// use matrix_sdk::ruma::{
/// events::room::member::RoomMemberEventContent, serde::Raw, user_id,
/// };
///
/// let member_event = room
/// .get_state_event_static_for_key::<RoomMemberEventContent, _>(user_id!(
/// "@alice:example.org"
/// ))
/// .await?;
/// # anyhow::Ok(())
/// # };
/// ```
pub async fn get_state_event_static_for_key<C, K>(
&self,
state_key: &K,
) -> Result<Option<RawSyncOrStrippedState<C>>>
where
C: StaticEventContent + StaticStateEventContent + RedactContent,
C::StateKey: Borrow<K>,
C::Redacted: RedactedStateEventContent,
K: AsRef<str> + ?Sized + Sync,
{
Ok(self.client.store().get_state_event_static_for_key(self.room_id(), state_key).await?)
}
/// Returns the parents this room advertises as its parents.
///
/// Results are in no particular order.
pub async fn parent_spaces(&self) -> Result<impl Stream<Item = Result<ParentSpace>> + '_> {
// Implements this algorithm:
// https://spec.matrix.org/v1.8/client-server-api/#mspaceparent-relationships
// Get all m.room.parent events for this room
Ok(self
.get_state_events_static::<SpaceParentEventContent>()
.await?
.into_iter()
// Extract state key (ie. the parent's id) and sender
.flat_map(|parent_event| match parent_event.deserialize() {
Ok(SyncOrStrippedState::Sync(SyncStateEvent::Original(e))) => {
Some((e.state_key.to_owned(), e.sender))
}
Ok(SyncOrStrippedState::Sync(SyncStateEvent::Redacted(_))) => None,
Ok(SyncOrStrippedState::Stripped(e)) => Some((e.state_key.to_owned(), e.sender)),
Err(e) => {
info!(room_id = ?self.room_id(), "Could not deserialize m.room.parent: {e}");
None
}
})
// Check whether the parent recognizes this room as its child
.map(|(state_key, sender): (OwnedRoomId, OwnedUserId)| async move {
let Some(parent_room) = self.client.get_room(&state_key) else {
// We are not in the room, cannot check if the relationship is reciprocal
// TODO: try peeking into the room
return Ok(ParentSpace::Unverifiable(state_key));
};
// Get the m.room.child state of the parent with this room's id
// as state key.
if let Some(child_event) = parent_room
.get_state_event_static_for_key::<SpaceChildEventContent, _>(self.room_id())
.await?
{
match child_event.deserialize() {
Ok(SyncOrStrippedState::Sync(SyncStateEvent::Original(_))) => {
// There is a valid m.room.child in the parent pointing to
// this room
return Ok(ParentSpace::Reciprocal(parent_room));
}
Ok(SyncOrStrippedState::Sync(SyncStateEvent::Redacted(_))) => {}
Ok(SyncOrStrippedState::Stripped(_)) => {}
Err(e) => {
info!(
room_id = ?self.room_id(), parent_room_id = ?state_key,
"Could not deserialize m.room.child: {e}"
);
}
}
// Otherwise the event is either invalid or redacted. If
// redacted it would be missing the
// `via` key, thereby invalidating that end of the
// relationship: https://spec.matrix.org/v1.8/client-server-api/#mspacechild
}
// No reciprocal m.room.child found, let's check if the sender has the
// power to set it
let Some(member) = parent_room.get_member(&sender).await? else {
// Sender is not even in the parent room
return Ok(ParentSpace::Illegitimate(parent_room));
};
if member.can_send_state(StateEventType::SpaceChild) {
// Sender does have the power to set m.room.child
Ok(ParentSpace::WithPowerlevel(parent_room))
} else {
Ok(ParentSpace::Illegitimate(parent_room))
}
})
.collect::<FuturesUnordered<_>>())
}
/// Read account data in this room, from storage.
pub async fn account_data(
&self,
data_type: RoomAccountDataEventType,
) -> Result<Option<Raw<AnyRoomAccountDataEvent>>> {
self.client
.store()
.get_room_account_data_event(self.room_id(), data_type)
.await
.map_err(Into::into)
}
/// Get account data of a statically-known type in this room, from storage.
///
/// # Examples
///
/// ```no_run
/// # async {
/// # let room: matrix_sdk::Room = todo!();
/// use matrix_sdk::ruma::events::fully_read::FullyReadEventContent;
///
/// match room.account_data_static::<FullyReadEventContent>().await? {
/// Some(fully_read) => {
/// println!("Found read marker: {:?}", fully_read.deserialize()?)
/// }
/// None => println!("No read marker for this room"),
/// }
/// # anyhow::Ok(())
/// # };
/// ```
pub async fn account_data_static<C>(&self) -> Result<Option<Raw<RoomAccountDataEvent<C>>>>
where
C: StaticEventContent + RoomAccountDataEventContent,
{
Ok(self.account_data(C::TYPE.into()).await?.map(Raw::cast))
}
/// Check if all members of this room are verified and all their devices are
/// verified.
///
/// Returns true if all devices in the room are verified, otherwise false.
#[cfg(feature = "e2e-encryption")]
pub async fn contains_only_verified_devices(&self) -> Result<bool> {
let user_ids =
self.client.store().get_user_ids(self.room_id(), RoomMemberships::empty()).await?;
for user_id in user_ids {
let devices = self.client.encryption().get_user_devices(&user_id).await?;
let any_unverified = devices.devices().any(|d| !d.is_verified());
if any_unverified {
return Ok(false);
}
}
Ok(true)
}
/// Set the given account data event for this room.
///
/// # Example
/// ```
/// # async {
/// # let room: matrix_sdk::Room = todo!();
/// # let event_id: ruma::OwnedEventId = todo!();
/// use matrix_sdk::ruma::events::fully_read::FullyReadEventContent;
/// let content = FullyReadEventContent::new(event_id);
///
/// room.set_account_data(content).await?;
/// # anyhow::Ok(())
/// # };
/// ```
pub async fn set_account_data<T>(
&self,
content: T,
) -> Result<set_room_account_data::v3::Response>
where
T: RoomAccountDataEventContent,
{
let own_user = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
let request = set_room_account_data::v3::Request::new(
own_user.to_owned(),
self.room_id().to_owned(),
&content,
)?;
Ok(self.client.send(request, None).await?)
}
/// Set the given raw account data event in this room.
///
/// # Example
/// ```
/// # async {
/// # let room: matrix_sdk::Room = todo!();
/// use matrix_sdk::ruma::{
/// events::{
/// marked_unread::MarkedUnreadEventContent,
/// AnyRoomAccountDataEventContent, EventContent,
/// },
/// serde::Raw,
/// };
/// let marked_unread_content = MarkedUnreadEventContent::new(true);
/// let full_event: AnyRoomAccountDataEventContent =
/// marked_unread_content.clone().into();
/// room.set_account_data_raw(
/// marked_unread_content.event_type(),
/// Raw::new(&full_event).unwrap(),
/// )
/// .await?;
/// # anyhow::Ok(())
/// # };
/// ```
pub async fn set_account_data_raw(
&self,
event_type: RoomAccountDataEventType,
content: Raw<AnyRoomAccountDataEventContent>,
) -> Result<set_room_account_data::v3::Response> {
let own_user = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
let request = set_room_account_data::v3::Request::new_raw(
own_user.to_owned(),
self.room_id().to_owned(),
event_type,
content,
);
Ok(self.client.send(request, None).await?)
}
/// Adds a tag to the room, or updates it if it already exists.
///
/// Returns the [`create_tag::v3::Response`] from the server.
///
/// # Arguments
/// * `tag` - The tag to add or update.
///
/// * `tag_info` - Information about the tag, generally containing the
/// `order` parameter.
///
/// # Examples
///
/// ```no_run
/// # use std::str::FromStr;
/// # use ruma::events::tag::{TagInfo, TagName, UserTagName};
/// # async {
/// # let homeserver = url::Url::parse("http://localhost:8080")?;
/// # let mut client = matrix_sdk::Client::new(homeserver).await?;
/// # let room_id = matrix_sdk::ruma::room_id!("!test:localhost");
/// use matrix_sdk::ruma::events::tag::TagInfo;
///
/// if let Some(room) = client.get_room(&room_id) {
/// let mut tag_info = TagInfo::new();
/// tag_info.order = Some(0.9);
/// let user_tag = UserTagName::from_str("u.work")?;
///
/// room.set_tag(TagName::User(user_tag), tag_info).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn set_tag(
&self,
tag: TagName,
tag_info: TagInfo,
) -> Result<create_tag::v3::Response> {
let user_id = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
let request = create_tag::v3::Request::new(
user_id.to_owned(),
self.inner.room_id().to_owned(),
tag.to_string(),
tag_info,
);
Ok(self.client.send(request, None).await?)
}
/// Removes a tag from the room.
///
/// Returns the [`delete_tag::v3::Response`] from the server.
///
/// # Arguments
/// * `tag` - The tag to remove.
pub async fn remove_tag(&self, tag: TagName) -> Result<delete_tag::v3::Response> {
let user_id = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
let request = delete_tag::v3::Request::new(
user_id.to_owned(),
self.inner.room_id().to_owned(),
tag.to_string(),
);
Ok(self.client.send(request, None).await?)
}
/// Add or remove the `m.favourite` flag for this room.
///
/// If `is_favourite` is `true`, and the `m.low_priority` tag is set on the
/// room, the tag will be removed too.
///
/// # Arguments
///
/// * `is_favourite` - Whether to mark this room as favourite.
/// * `tag_order` - The order of the tag if any.
pub async fn set_is_favourite(&self, is_favourite: bool, tag_order: Option<f64>) -> Result<()> {
if is_favourite {
let tag_info = assign!(TagInfo::new(), { order: tag_order });
self.set_tag(TagName::Favorite, tag_info).await?;
if self.is_low_priority() {
self.remove_tag(TagName::LowPriority).await?;
}
} else {
self.remove_tag(TagName::Favorite).await?;
}
Ok(())
}
/// Add or remove the `m.lowpriority` flag for this room.
///
/// If `is_low_priority` is `true`, and the `m.favourite` tag is set on the
/// room, the tag will be removed too.
///
/// # Arguments
///
/// * `is_low_priority` - Whether to mark this room as low_priority or not.
/// * `tag_order` - The order of the tag if any.
pub async fn set_is_low_priority(
&self,
is_low_priority: bool,
tag_order: Option<f64>,
) -> Result<()> {
if is_low_priority {
let tag_info = assign!(TagInfo::new(), { order: tag_order });
self.set_tag(TagName::LowPriority, tag_info).await?;
if self.is_favourite() {
self.remove_tag(TagName::Favorite).await?;
}
} else {
self.remove_tag(TagName::LowPriority).await?;
}
Ok(())
}
/// Sets whether this room is a DM.
///
/// When setting this room as DM, it will be marked as DM for all active
/// members of the room. When unsetting this room as DM, it will be
/// unmarked as DM for all users, not just the members.
///
/// # Arguments
/// * `is_direct` - Whether to mark this room as direct.
pub async fn set_is_direct(&self, is_direct: bool) -> Result<()> {
let user_id = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
let mut content = self
.client
.account()
.account_data::<DirectEventContent>()
.await?
.map(|c| c.deserialize())
.transpose()?
.unwrap_or_default();
let this_room_id = self.inner.room_id();
if is_direct {
let mut room_members = self.members(RoomMemberships::ACTIVE).await?;
room_members.retain(|member| member.user_id() != self.own_user_id());
for member in room_members {
let entry = content.entry(member.user_id().to_owned()).or_default();
if !entry.iter().any(|room_id| room_id == this_room_id) {
entry.push(this_room_id.to_owned());
}
}
} else {
for (_, list) in content.iter_mut() {
list.retain(|room_id| *room_id != this_room_id);
}
// Remove user ids that don't have any room marked as DM
content.retain(|_, list| !list.is_empty());
}
let request = set_global_account_data::v3::Request::new(user_id.to_owned(), &content)?;
self.client.send(request, None).await?;
Ok(())
}
/// Tries to decrypt a room event.
///
/// # Arguments
/// * `event` - The room event to be decrypted.
///
/// Returns the decrypted event. In the case of a decryption error, returns
/// a `TimelineEvent` representing the decryption error.
#[cfg(feature = "e2e-encryption")]
pub async fn decrypt_event(
&self,
event: &Raw<OriginalSyncRoomEncryptedEvent>,
) -> Result<TimelineEvent> {
let machine = self.client.olm_machine().await;
let machine = machine.as_ref().ok_or(Error::NoOlmMachine)?;
let decryption_settings = DecryptionSettings {
sender_device_trust_requirement: self.client.base_client().decryption_trust_requirement,
};
let mut event: TimelineEvent = match machine
.try_decrypt_room_event(event.cast_ref(), self.inner.room_id(), &decryption_settings)
.await?
{
RoomEventDecryptionResult::Decrypted(decrypted) => decrypted.into(),
RoomEventDecryptionResult::UnableToDecrypt(utd_info) => {
self.client
.encryption()
.backups()
.maybe_download_room_key(self.room_id().to_owned(), event.clone());
TimelineEvent::new_utd_event(event.clone().cast(), utd_info)
}
};
event.push_actions = self.event_push_actions(event.raw()).await?;
Ok(event)
}
/// Forces the currently active room key, which is used to encrypt messages,
/// to be rotated.
///
/// A new room key will be crated and shared with all the room members the
/// next time a message will be sent. You don't have to call this method,
/// room keys will be rotated automatically when necessary. This method is
/// still useful for debugging purposes.
///
/// For more info please take a look a the [`encryption`] module
/// documentation.
///
/// [`encryption`]: crate::encryption
#[cfg(feature = "e2e-encryption")]
pub async fn discard_room_key(&self) -> Result<()> {
let machine = self.client.olm_machine().await;
if let Some(machine) = machine.as_ref() {
machine.discard_room_key(self.inner.room_id()).await?;
Ok(())
} else {
Err(Error::NoOlmMachine)
}
}
/// Ban the user with `UserId` from this room.
///
/// # Arguments
///
/// * `user_id` - The user to ban with `UserId`.
///
/// * `reason` - The reason for banning this user.
#[instrument(skip_all)]
pub async fn ban_user(&self, user_id: &UserId, reason: Option<&str>) -> Result<()> {
let request = assign!(
ban_user::v3::Request::new(self.room_id().to_owned(), user_id.to_owned()),
{ reason: reason.map(ToOwned::to_owned) }
);
self.client.send(request, None).await?;
Ok(())
}
/// Unban the user with `UserId` from this room.
///
/// # Arguments
///
/// * `user_id` - The user to unban with `UserId`.
///
/// * `reason` - The reason for unbanning this user.
#[instrument(skip_all)]
pub async fn unban_user(&self, user_id: &UserId, reason: Option<&str>) -> Result<()> {
let request = assign!(
unban_user::v3::Request::new(self.room_id().to_owned(), user_id.to_owned()),
{ reason: reason.map(ToOwned::to_owned) }
);
self.client.send(request, None).await?;
Ok(())
}
/// Kick a user out of this room.
///
/// # Arguments
///
/// * `user_id` - The `UserId` of the user that should be kicked out of the
/// room.
///
/// * `reason` - Optional reason why the room member is being kicked out.
#[instrument(skip_all)]
pub async fn kick_user(&self, user_id: &UserId, reason: Option<&str>) -> Result<()> {
let request = assign!(
kick_user::v3::Request::new(self.room_id().to_owned(), user_id.to_owned()),
{ reason: reason.map(ToOwned::to_owned) }
);
self.client.send(request, None).await?;
Ok(())
}
/// Invite the specified user by `UserId` to this room.
///
/// # Arguments
///
/// * `user_id` - The `UserId` of the user to invite to the room.
#[instrument(skip_all)]
pub async fn invite_user_by_id(&self, user_id: &UserId) -> Result<()> {
let recipient = InvitationRecipient::UserId { user_id: user_id.to_owned() };
let request = invite_user::v3::Request::new(self.room_id().to_owned(), recipient);
self.client.send(request, None).await?;
// Force a future room members reload before sending any event to prevent UTDs
// that can happen when some event is sent after a room member has been invited
// but before the /sync request could fetch the membership change event.
self.mark_members_missing();
Ok(())
}
/// Invite the specified user by third party id to this room.
///
/// # Arguments
///
/// * `invite_id` - A third party id of a user to invite to the room.
#[instrument(skip_all)]
pub async fn invite_user_by_3pid(&self, invite_id: Invite3pid) -> Result<()> {
let recipient = InvitationRecipient::ThirdPartyId(invite_id);
let request = invite_user::v3::Request::new(self.room_id().to_owned(), recipient);
self.client.send(request, None).await?;
// Force a future room members reload before sending any event to prevent UTDs
// that can happen when some event is sent after a room member has been invited
// but before the /sync request could fetch the membership change event.
self.mark_members_missing();
Ok(())
}
/// Activate typing notice for this room.
///
/// The typing notice remains active for 4s. It can be deactivate at any
/// point by setting typing to `false`. If this method is called while
/// the typing notice is active nothing will happen. This method can be
/// called on every key stroke, since it will do nothing while typing is
/// active.
///
/// # Arguments
///
/// * `typing` - Whether the user is typing or has stopped typing.
///
/// # Examples
///
/// ```no_run
/// use std::time::Duration;
///
/// use matrix_sdk::ruma::api::client::typing::create_typing_event::v3::Typing;
/// # use matrix_sdk::{
/// # Client, config::SyncSettings,
/// # ruma::room_id,
/// # };
/// # use url::Url;
///
/// # async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let client = Client::new(homeserver).await?;
/// let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
///
/// if let Some(room) = client.get_room(&room_id) {
/// room.typing_notice(true).await?
/// }
/// # anyhow::Ok(()) };
/// ```
pub async fn typing_notice(&self, typing: bool) -> Result<()> {
self.ensure_room_joined()?;
// Only send a request to the homeserver if the old timeout has elapsed
// or the typing notice changed state within the `TYPING_NOTICE_TIMEOUT`
let send = if let Some(typing_time) =
self.client.inner.typing_notice_times.read().unwrap().get(self.room_id())
{
if typing_time.elapsed() > TYPING_NOTICE_RESEND_TIMEOUT {
// We always reactivate the typing notice if typing is true or
// we may need to deactivate it if it's
// currently active if typing is false
typing || typing_time.elapsed() <= TYPING_NOTICE_TIMEOUT
} else {
// Only send a request when we need to deactivate typing
!typing
}
} else {
// Typing notice is currently deactivated, therefore, send a request
// only when it's about to be activated
typing
};
if send {
self.send_typing_notice(typing).await?;
}
Ok(())
}
#[instrument(name = "typing_notice", skip(self))]
async fn send_typing_notice(&self, typing: bool) -> Result<()> {
let typing = if typing {
self.client
.inner
.typing_notice_times
.write()
.unwrap()
.insert(self.room_id().to_owned(), Instant::now());
Typing::Yes(TYPING_NOTICE_TIMEOUT)
} else {
self.client.inner.typing_notice_times.write().unwrap().remove(self.room_id());
Typing::No
};
let request = create_typing_event::v3::Request::new(
self.own_user_id().to_owned(),
self.room_id().to_owned(),
typing,
);
self.client.send(request, None).await?;
Ok(())
}
/// Send a request to set a single receipt.
///
/// # Arguments
///
/// * `receipt_type` - The type of the receipt to set. Note that it is
/// possible to set the fully-read marker although it is technically not a
/// receipt.
///
/// * `thread` - The thread where this receipt should apply, if any. Note
/// that this must be [`ReceiptThread::Unthreaded`] when sending a
/// [`ReceiptType::FullyRead`][create_receipt::v3::ReceiptType::FullyRead].
///
/// * `event_id` - The `EventId` of the event to set the receipt on.
#[instrument(skip_all)]
pub async fn send_single_receipt(
&self,
receipt_type: create_receipt::v3::ReceiptType,
thread: ReceiptThread,
event_id: OwnedEventId,
) -> Result<()> {
// Since the receipt type and the thread aren't Hash/Ord, flatten then as a
// string key.
let request_key = format!("{}|{}", receipt_type, thread.as_str().unwrap_or("<unthreaded>"));
self.client
.inner
.locks
.read_receipt_deduplicated_handler
.run((request_key, event_id.clone()), async {
let mut request = create_receipt::v3::Request::new(
self.room_id().to_owned(),
receipt_type,
event_id,
);
request.thread = thread;
self.client.send(request, None).await?;
Ok(())
})
.await
}
/// Send a request to set multiple receipts at once.
///
/// # Arguments
///
/// * `receipts` - The `Receipts` to send.
///
/// If `receipts` is empty, this is a no-op.
#[instrument(skip_all)]
pub async fn send_multiple_receipts(&self, receipts: Receipts) -> Result<()> {
if receipts.is_empty() {
return Ok(());
}
let Receipts { fully_read, public_read_receipt, private_read_receipt } = receipts;
let request = assign!(set_read_marker::v3::Request::new(self.room_id().to_owned()), {
fully_read,
read_receipt: public_read_receipt,
private_read_receipt,
});
self.client.send(request, None).await?;
Ok(())
}
/// Enable End-to-end encryption in this room.
///
/// This method will be a noop if encryption is already enabled, otherwise
/// sends a `m.room.encryption` state event to the room. This might fail if
/// you don't have the appropriate power level to enable end-to-end
/// encryption.
///
/// A sync needs to be received to update the local room state. This method
/// will wait for a sync to be received, this might time out if no
/// sync loop is running or if the server is slow.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{
/// # Client, config::SyncSettings,
/// # ruma::room_id,
/// # };
/// # use url::Url;
/// #
/// # async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let client = Client::new(homeserver).await?;
/// # let room_id = room_id!("!test:localhost");
/// let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
///
/// if let Some(room) = client.get_room(&room_id) {
/// room.enable_encryption().await?
/// }
/// # anyhow::Ok(()) };
/// ```
#[instrument(skip_all)]
pub async fn enable_encryption(&self) -> Result<()> {
use ruma::{
events::room::encryption::RoomEncryptionEventContent, EventEncryptionAlgorithm,
};
const SYNC_WAIT_TIME: Duration = Duration::from_secs(3);
if !self.is_encrypted().await? {
let content =
RoomEncryptionEventContent::new(EventEncryptionAlgorithm::MegolmV1AesSha2);
self.send_state_event(content).await?;
// TODO do we want to return an error here if we time out? This
// could be quite useful if someone wants to enable encryption and
// send a message right after it's enabled.
_ = timeout(self.client.inner.sync_beat.listen(), SYNC_WAIT_TIME).await;
// If after waiting for a sync, we don't have the encryption state we expect,
// assume the local encryption state is incorrect; this will cause
// the SDK to re-request it later for confirmation, instead of
// assuming it's sync'd and correct (and not encrypted).
let _sync_lock = self.client.base_client().sync_lock().lock().await;
if !self.inner.is_encrypted() {
debug!("still not marked as encrypted, marking encryption state as missing");
let mut room_info = self.clone_info();
room_info.mark_encryption_state_missing();
let mut changes = StateChanges::default();
changes.add_room(room_info.clone());
self.client.store().save_changes(&changes).await?;
self.set_room_info(room_info, RoomInfoNotableUpdateReasons::empty());
} else {
debug!("room successfully marked as encrypted");
}
}
Ok(())
}
/// Share a room key with users in the given room.
///
/// This will create Olm sessions with all the users/device pairs in the
/// room if necessary and share a room key that can be shared with them.
///
/// Does nothing if no room key needs to be shared.
// TODO: expose this publicly so people can pre-share a group session if
// e.g. a user starts to type a message for a room.
#[cfg(feature = "e2e-encryption")]
#[instrument(skip_all, fields(room_id = ?self.room_id(), store_generation))]
async fn preshare_room_key(&self) -> Result<()> {
self.ensure_room_joined()?;
// Take and release the lock on the store, if needs be.
let guard = self.client.encryption().spin_lock_store(Some(60000)).await?;
tracing::Span::current().record("store_generation", guard.map(|guard| guard.generation()));
self.client
.locks()
.group_session_deduplicated_handler
.run(self.room_id().to_owned(), async move {
{
let members = self
.client
.store()
.get_user_ids(self.room_id(), RoomMemberships::ACTIVE)
.await?;
self.client.claim_one_time_keys(members.iter().map(Deref::deref)).await?;
};
let response = self.share_room_key().await;
// If one of the responses failed invalidate the group
// session as using it would end up in undecryptable
// messages.
if let Err(r) = response {
let machine = self.client.olm_machine().await;
if let Some(machine) = machine.as_ref() {
machine.discard_room_key(self.room_id()).await?;
}
return Err(r);
}
Ok(())
})
.await
}
/// Share a group session for a room.
///
/// # Panics
///
/// Panics if the client isn't logged in.
#[cfg(feature = "e2e-encryption")]
#[instrument(skip_all)]
async fn share_room_key(&self) -> Result<()> {
self.ensure_room_joined()?;
let requests = self.client.base_client().share_room_key(self.room_id()).await?;
for request in requests {
let response = self.client.send_to_device(&request).await?;
self.client.mark_request_as_sent(&request.txn_id, &response).await?;
}
Ok(())
}
/// Wait for the room to be fully synced.
///
/// This method makes sure the room that was returned when joining a room
/// has been echoed back in the sync.
///
/// Warning: This waits until a sync happens and does not return if no sync
/// is happening. It can also return early when the room is not a joined
/// room anymore.
#[instrument(skip_all)]
pub async fn sync_up(&self) {
while !self.is_synced() && self.state() == RoomState::Joined {
let wait_for_beat = self.client.inner.sync_beat.listen();
// We don't care whether it's a timeout or a sync beat.
let _ = timeout(wait_for_beat, Duration::from_millis(1000)).await;
}
}
/// Send a message-like event to this room.
///
/// Returns the parsed response from the server.
///
/// If the encryption feature is enabled this method will transparently
/// encrypt the event if this room is encrypted (except for `m.reaction`
/// events, which are never encrypted).
///
/// **Note**: If you just want to send an event with custom JSON content to
/// a room, you can use the [`send_raw()`][Self::send_raw] method for that.
///
/// If you want to set a transaction ID for the event, use
/// [`.with_transaction_id()`][SendMessageLikeEvent::with_transaction_id]
/// on the returned value before `.await`ing it.
///
/// # Arguments
///
/// * `content` - The content of the message event.
///
/// # Examples
///
/// ```no_run
/// # use std::sync::{Arc, RwLock};
/// # use matrix_sdk::{Client, config::SyncSettings};
/// # use url::Url;
/// # use matrix_sdk::ruma::room_id;
/// # use serde::{Deserialize, Serialize};
/// use matrix_sdk::ruma::{
/// events::{
/// macros::EventContent,
/// room::message::{RoomMessageEventContent, TextMessageEventContent},
/// },
/// uint, MilliSecondsSinceUnixEpoch, TransactionId,
/// };
///
/// # async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// # let room_id = room_id!("!test:localhost");
/// let content = RoomMessageEventContent::text_plain("Hello world");
/// let txn_id = TransactionId::new();
///
/// if let Some(room) = client.get_room(&room_id) {
/// room.send(content).with_transaction_id(txn_id).await?;
/// }
///
/// // Custom events work too:
/// #[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
/// #[ruma_event(type = "org.shiny_new_2fa.token", kind = MessageLike)]
/// struct TokenEventContent {
/// token: String,
/// #[serde(rename = "exp")]
/// expires_at: MilliSecondsSinceUnixEpoch,
/// }
///
/// # fn generate_token() -> String { todo!() }
/// let content = TokenEventContent {
/// token: generate_token(),
/// expires_at: {
/// let now = MilliSecondsSinceUnixEpoch::now();
/// MilliSecondsSinceUnixEpoch(now.0 + uint!(30_000))
/// },
/// };
///
/// if let Some(room) = client.get_room(&room_id) {
/// room.send(content).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
pub fn send(&self, content: impl MessageLikeEventContent) -> SendMessageLikeEvent<'_> {
SendMessageLikeEvent::new(self, content)
}
/// Run /keys/query requests for all the non-tracked users.
#[cfg(feature = "e2e-encryption")]
async fn query_keys_for_untracked_users(&self) -> Result<()> {
let olm = self.client.olm_machine().await;
let olm = olm.as_ref().expect("Olm machine wasn't started");
let members =
self.client.store().get_user_ids(self.room_id(), RoomMemberships::ACTIVE).await?;
let tracked: HashMap<_, _> = olm
.store()
.load_tracked_users()
.await?
.into_iter()
.map(|tracked| (tracked.user_id, tracked.dirty))
.collect();
// A member has no unknown devices iff it was tracked *and* the tracking is
// not considered dirty.
let members_with_unknown_devices =
members.iter().filter(|member| tracked.get(*member).map_or(true, |dirty| *dirty));
let (req_id, request) =
olm.query_keys_for_users(members_with_unknown_devices.map(|owned| owned.borrow()));
if !request.device_keys.is_empty() {
self.client.keys_query(&req_id, request.device_keys).await?;
}
Ok(())
}
/// Send a message-like event with custom JSON content to this room.
///
/// Returns the parsed response from the server.
///
/// If the encryption feature is enabled this method will transparently
/// encrypt the event if this room is encrypted (except for `m.reaction`
/// events, which are never encrypted).
///
/// This method is equivalent to the [`send()`][Self::send] method but
/// allows sending custom JSON payloads, e.g. constructed using the
/// [`serde_json::json!()`] macro.
///
/// If you want to set a transaction ID for the event, use
/// [`.with_transaction_id()`][SendRawMessageLikeEvent::with_transaction_id]
/// on the returned value before `.await`ing it.
///
/// # Arguments
///
/// * `event_type` - The type of the event.
///
/// * `content` - The content of the event as a raw JSON value. The argument
/// type can be `serde_json::Value`, but also other raw JSON types; for
/// the full list check the documentation of
/// [`IntoRawMessageLikeEventContent`].
///
/// # Examples
///
/// ```no_run
/// # use std::sync::{Arc, RwLock};
/// # use matrix_sdk::{Client, config::SyncSettings};
/// # use url::Url;
/// # use matrix_sdk::ruma::room_id;
/// # async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// # let room_id = room_id!("!test:localhost");
/// use serde_json::json;
///
/// if let Some(room) = client.get_room(&room_id) {
/// room.send_raw("m.room.message", json!({ "body": "Hello world" })).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
#[instrument(skip_all, fields(event_type, room_id = ?self.room_id(), transaction_id, is_room_encrypted, event_id))]
pub fn send_raw<'a>(
&'a self,
event_type: &'a str,
content: impl IntoRawMessageLikeEventContent,
) -> SendRawMessageLikeEvent<'a> {
// Note: the recorded instrument fields are saved in
// `SendRawMessageLikeEvent::into_future`.
SendRawMessageLikeEvent::new(self, event_type, content)
}
/// Send an attachment to this room.
///
/// This will upload the given data that the reader produces using the
/// [`upload()`] method and post an event to the given room.
/// If the room is encrypted and the encryption feature is enabled the
/// upload will be encrypted.
///
/// This is a convenience method that calls the
/// [`upload()`] and afterwards the [`send()`].
///
/// # Arguments
/// * `filename` - The file name.
///
/// * `content_type` - The type of the media, this will be used as the
/// content-type header.
///
/// * `reader` - A `Reader` that will be used to fetch the raw bytes of the
/// media.
///
/// * `config` - Metadata and configuration for the attachment.
///
/// # Examples
///
/// ```no_run
/// # use std::fs;
/// # use matrix_sdk::{Client, ruma::room_id, attachment::AttachmentConfig};
/// # use url::Url;
/// # use mime;
/// # async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// # let room_id = room_id!("!test:localhost");
/// let mut image = fs::read("/home/example/my-cat.jpg")?;
///
/// if let Some(room) = client.get_room(&room_id) {
/// room.send_attachment(
/// "my_favorite_cat.jpg",
/// &mime::IMAGE_JPEG,
/// image,
/// AttachmentConfig::new(),
/// ).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
///
/// [`upload()`]: crate::Media::upload
/// [`send()`]: Self::send
#[instrument(skip_all)]
pub fn send_attachment<'a>(
&'a self,
filename: &'a str,
content_type: &'a Mime,
data: Vec<u8>,
config: AttachmentConfig,
) -> SendAttachment<'a> {
SendAttachment::new(self, filename, content_type, data, config)
}
/// Prepare and send an attachment to this room.
///
/// This will upload the given data that the reader produces using the
/// [`upload()`](#method.upload) method and post an event to the given room.
/// If the room is encrypted and the encryption feature is enabled the
/// upload will be encrypted.
///
/// This is a convenience method that calls the
/// [`Client::upload()`](#Client::method.upload) and afterwards the
/// [`send()`](#method.send).
///
/// # Arguments
/// * `filename` - The file name.
///
/// * `content_type` - The type of the media, this will be used as the
/// content-type header.
///
/// * `reader` - A `Reader` that will be used to fetch the raw bytes of the
/// media.
///
/// * `config` - Metadata and configuration for the attachment.
///
/// * `send_progress` - An observable to transmit forward progress about the
/// upload.
///
/// * `store_in_cache` - A boolean defining whether the uploaded media will
/// be stored in the cache immediately after a successful upload.
#[instrument(skip_all)]
pub(super) async fn prepare_and_send_attachment<'a>(
&'a self,
filename: &'a str,
content_type: &'a Mime,
data: Vec<u8>,
mut config: AttachmentConfig,
send_progress: SharedObservable<TransmissionProgress>,
store_in_cache: bool,
) -> Result<send_message_event::v3::Response> {
self.ensure_room_joined()?;
let txn_id = config.txn_id.take();
let mentions = config.mentions.take();
let thumbnail = config.thumbnail.take();
// If necessary, store caching data for the thumbnail ahead of time.
let thumbnail_cache_info = if store_in_cache {
// Use a small closure returning Option to avoid an unnecessary complicated
// chain of map/and_then.
let get_info = || {
let thumbnail = thumbnail.as_ref()?;
let info = thumbnail.info.as_ref()?;
Some((thumbnail.data.clone(), info.height?, info.width?))
};
get_info()
} else {
None
};
#[cfg(feature = "e2e-encryption")]
let (media_source, thumbnail) = if self.is_encrypted().await? {
self.client
.upload_encrypted_media_and_thumbnail(content_type, &data, thumbnail, send_progress)
.await?
} else {
self.client
.media()
.upload_plain_media_and_thumbnail(
content_type,
// TODO: get rid of this clone; wait for Ruma to use `Bytes` or something
// similar.
data.clone(),
thumbnail,
send_progress,
)
.await?
};
#[cfg(not(feature = "e2e-encryption"))]
let (media_source, thumbnail) = self
.client
.media()
.upload_plain_media_and_thumbnail(content_type, data.clone(), thumbnail, send_progress)
.await?;
if store_in_cache {
let cache_store_lock_guard = self.client.event_cache_store().lock().await?;
// A failure to cache shouldn't prevent the whole upload from finishing
// properly, so only log errors during caching.
debug!("caching the media");
let request =
MediaRequestParameters { source: media_source.clone(), format: MediaFormat::File };
if let Err(err) = cache_store_lock_guard.add_media_content(&request, data).await {
warn!("unable to cache the media after uploading it: {err}");
}
if let Some(((data, height, width), source)) =
thumbnail_cache_info.zip(thumbnail.as_ref().map(|tuple| &tuple.0))
{
debug!("caching the thumbnail");
let request = MediaRequestParameters {
source: source.clone(),
format: MediaFormat::Thumbnail(MediaThumbnailSettings::new(width, height)),
};
if let Err(err) = cache_store_lock_guard.add_media_content(&request, data).await {
warn!("unable to cache the media after uploading it: {err}");
}
}
}
let content = Self::make_attachment_event(
self.make_attachment_type(
content_type,
filename,
media_source,
config.caption,
config.formatted_caption,
config.info,
thumbnail,
),
mentions,
);
let mut fut = self.send(content);
if let Some(txn_id) = txn_id {
fut = fut.with_transaction_id(txn_id);
}
fut.await
}
/// Creates the inner [`MessageType`] for an already-uploaded media file
/// provided by its source.
#[allow(clippy::too_many_arguments)]
pub(crate) fn make_attachment_type(
&self,
content_type: &Mime,
filename: &str,
source: MediaSource,
caption: Option<String>,
formatted_caption: Option<FormattedBody>,
info: Option<AttachmentInfo>,
thumbnail: Option<(MediaSource, Box<ThumbnailInfo>)>,
) -> MessageType {
// If caption is set, use it as body, and filename as the file name; otherwise,
// body is the filename, and the filename is not set.
// https://github.com/matrix-org/matrix-spec-proposals/blob/main/proposals/2530-body-as-caption.md
let (body, filename) = match caption {
Some(caption) => (caption, Some(filename.to_owned())),
None => (filename.to_owned(), None),
};
let (thumbnail_source, thumbnail_info) = thumbnail.unzip();
match content_type.type_() {
mime::IMAGE => {
let info = assign!(info.map(ImageInfo::from).unwrap_or_default(), {
mimetype: Some(content_type.as_ref().to_owned()),
thumbnail_source,
thumbnail_info
});
let content = assign!(ImageMessageEventContent::new(body, source), {
info: Some(Box::new(info)),
formatted: formatted_caption,
filename
});
MessageType::Image(content)
}
mime::AUDIO => {
let mut content = assign!(AudioMessageEventContent::new(body, source), {
formatted: formatted_caption,
filename
});
if let Some(AttachmentInfo::Voice { audio_info, waveform: Some(waveform_vec) }) =
&info
{
if let Some(duration) = audio_info.duration {
let waveform = waveform_vec.iter().map(|v| (*v).into()).collect();
content.audio =
Some(UnstableAudioDetailsContentBlock::new(duration, waveform));
}
content.voice = Some(UnstableVoiceContentBlock::new());
}
let mut audio_info = info.map(AudioInfo::from).unwrap_or_default();
audio_info.mimetype = Some(content_type.as_ref().to_owned());
let content = content.info(Box::new(audio_info));
MessageType::Audio(content)
}
mime::VIDEO => {
let info = assign!(info.map(VideoInfo::from).unwrap_or_default(), {
mimetype: Some(content_type.as_ref().to_owned()),
thumbnail_source,
thumbnail_info
});
let content = assign!(VideoMessageEventContent::new(body, source), {
info: Some(Box::new(info)),
formatted: formatted_caption,
filename
});
MessageType::Video(content)
}
_ => {
let info = assign!(info.map(FileInfo::from).unwrap_or_default(), {
mimetype: Some(content_type.as_ref().to_owned()),
thumbnail_source,
thumbnail_info
});
let content = assign!(FileMessageEventContent::new(body, source), {
info: Some(Box::new(info)),
formatted: formatted_caption,
filename,
});
MessageType::File(content)
}
}
}
/// Creates the [`RoomMessageEventContent`] based on the message type and
/// mentions.
pub(crate) fn make_attachment_event(
msg_type: MessageType,
mentions: Option<Mentions>,
) -> RoomMessageEventContent {
let mut content = RoomMessageEventContent::new(msg_type);
if let Some(mentions) = mentions {
content = content.add_mentions(mentions);
}
content
}
/// Update the power levels of a select set of users of this room.
///
/// Issue a `power_levels` state event request to the server, changing the
/// given UserId -> Int levels. May fail if the `power_levels` aren't
/// locally known yet or the server rejects the state event update, e.g.
/// because of insufficient permissions. Neither permissions to update
/// nor whether the data might be stale is checked prior to issuing the
/// request.
pub async fn update_power_levels(
&self,
updates: Vec<(&UserId, Int)>,
) -> Result<send_state_event::v3::Response> {
let mut power_levels = self.power_levels().await?;
for (user_id, new_level) in updates {
if new_level == power_levels.users_default {
power_levels.users.remove(user_id);
} else {
power_levels.users.insert(user_id.to_owned(), new_level);
}
}
self.send_state_event(RoomPowerLevelsEventContent::from(power_levels)).await
}
/// Applies a set of power level changes to this room.
///
/// Any values that are `None` in the given `RoomPowerLevelChanges` will
/// remain unchanged.
pub async fn apply_power_level_changes(&self, changes: RoomPowerLevelChanges) -> Result<()> {
let mut power_levels = self.power_levels().await?;
power_levels.apply(changes)?;
self.send_state_event(RoomPowerLevelsEventContent::from(power_levels)).await?;
Ok(())
}
/// Resets the room's power levels to the default values
///
/// [spec]: https://spec.matrix.org/v1.9/client-server-api/#mroompower_levels
pub async fn reset_power_levels(&self) -> Result<RoomPowerLevels> {
let default_power_levels = RoomPowerLevels::from(RoomPowerLevelsEventContent::new());
let changes = RoomPowerLevelChanges::from(default_power_levels);
self.apply_power_level_changes(changes).await?;
Ok(self.power_levels().await?)
}
/// Gets the suggested role for the user with the provided `user_id`.
///
/// This method checks the `RoomPowerLevels` events instead of loading the
/// member list and looking for the member.
pub async fn get_suggested_user_role(&self, user_id: &UserId) -> Result<RoomMemberRole> {
let power_level = self.get_user_power_level(user_id).await?;
Ok(RoomMemberRole::suggested_role_for_power_level(power_level))
}
/// Gets the power level the user with the provided `user_id`.
///
/// This method checks the `RoomPowerLevels` events instead of loading the
/// member list and looking for the member.
pub async fn get_user_power_level(&self, user_id: &UserId) -> Result<i64> {
let event = self.power_levels().await?;
Ok(event.for_user(user_id).into())
}
/// Gets a map with the `UserId` of users with power levels other than `0`
/// and this power level.
pub async fn users_with_power_levels(&self) -> HashMap<OwnedUserId, i64> {
let power_levels = self.power_levels().await.ok();
let mut user_power_levels = HashMap::<OwnedUserId, i64>::new();
if let Some(power_levels) = power_levels {
for (id, level) in power_levels.users.into_iter() {
user_power_levels.insert(id, level.into());
}
}
user_power_levels
}
/// Sets the name of this room.
pub async fn set_name(&self, name: String) -> Result<send_state_event::v3::Response> {
self.send_state_event(RoomNameEventContent::new(name)).await
}
/// Sets a new topic for this room.
pub async fn set_room_topic(&self, topic: &str) -> Result<send_state_event::v3::Response> {
self.send_state_event(RoomTopicEventContent::new(topic.into())).await
}
/// Sets the new avatar url for this room.
///
/// # Arguments
/// * `avatar_url` - The owned matrix uri that represents the avatar
/// * `info` - The optional image info that can be provided for the avatar
pub async fn set_avatar_url(
&self,
url: &MxcUri,
info: Option<avatar::ImageInfo>,
) -> Result<send_state_event::v3::Response> {
self.ensure_room_joined()?;
let mut room_avatar_event = RoomAvatarEventContent::new();
room_avatar_event.url = Some(url.to_owned());
room_avatar_event.info = info.map(Box::new);
self.send_state_event(room_avatar_event).await
}
/// Removes the avatar from the room
pub async fn remove_avatar(&self) -> Result<send_state_event::v3::Response> {
self.send_state_event(RoomAvatarEventContent::new()).await
}
/// Uploads a new avatar for this room.
///
/// # Arguments
/// * `mime` - The mime type describing the data
/// * `data` - The data representation of the avatar
/// * `info` - The optional image info provided for the avatar, the blurhash
/// and the mimetype will always be updated
pub async fn upload_avatar(
&self,
mime: &Mime,
data: Vec<u8>,
info: Option<avatar::ImageInfo>,
) -> Result<send_state_event::v3::Response> {
self.ensure_room_joined()?;
let upload_response = self.client.media().upload(mime, data, None).await?;
let mut info = info.unwrap_or_default();
info.blurhash = upload_response.blurhash;
info.mimetype = Some(mime.to_string());
self.set_avatar_url(&upload_response.content_uri, Some(info)).await
}
/// Send a state event with an empty state key to the homeserver.
///
/// For state events with a non-empty state key, see
/// [`send_state_event_for_key`][Self::send_state_event_for_key].
///
/// Returns the parsed response from the server.
///
/// # Arguments
///
/// * `content` - The content of the state event.
///
/// # Examples
///
/// ```no_run
/// # use serde::{Deserialize, Serialize};
/// # async {
/// # let joined_room: matrix_sdk::Room = todo!();
/// use matrix_sdk::ruma::{
/// events::{
/// macros::EventContent, room::encryption::RoomEncryptionEventContent,
/// EmptyStateKey,
/// },
/// EventEncryptionAlgorithm,
/// };
///
/// let encryption_event_content = RoomEncryptionEventContent::new(
/// EventEncryptionAlgorithm::MegolmV1AesSha2,
/// );
/// joined_room.send_state_event(encryption_event_content).await?;
///
/// // Custom event:
/// #[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
/// #[ruma_event(
/// type = "org.matrix.msc_9000.xxx",
/// kind = State,
/// state_key_type = EmptyStateKey,
/// )]
/// struct XxxStateEventContent {/* fields... */}
///
/// let content: XxxStateEventContent = todo!();
/// joined_room.send_state_event(content).await?;
/// # anyhow::Ok(()) };
/// ```
#[instrument(skip_all)]
pub async fn send_state_event(
&self,
content: impl StateEventContent<StateKey = EmptyStateKey>,
) -> Result<send_state_event::v3::Response> {
self.send_state_event_for_key(&EmptyStateKey, content).await
}
/// Send a state event to the homeserver.
///
/// Returns the parsed response from the server.
///
/// # Arguments
///
/// * `content` - The content of the state event.
///
/// * `state_key` - A unique key which defines the overwriting semantics for
/// this piece of room state.
///
/// # Examples
///
/// ```no_run
/// # use serde::{Deserialize, Serialize};
/// # async {
/// # let joined_room: matrix_sdk::Room = todo!();
/// use matrix_sdk::ruma::{
/// events::{
/// macros::EventContent,
/// room::member::{RoomMemberEventContent, MembershipState},
/// },
/// mxc_uri,
/// };
///
/// let avatar_url = mxc_uri!("mxc://example.org/avatar").to_owned();
/// let mut content = RoomMemberEventContent::new(MembershipState::Join);
/// content.avatar_url = Some(avatar_url);
///
/// joined_room.send_state_event_for_key(ruma::user_id!("@foo:bar.com"), content).await?;
///
/// // Custom event:
/// #[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
/// #[ruma_event(type = "org.matrix.msc_9000.xxx", kind = State, state_key_type = String)]
/// struct XxxStateEventContent { /* fields... */ }
///
/// let content: XxxStateEventContent = todo!();
/// joined_room.send_state_event_for_key("foo", content).await?;
/// # anyhow::Ok(()) };
/// ```
pub async fn send_state_event_for_key<C, K>(
&self,
state_key: &K,
content: C,
) -> Result<send_state_event::v3::Response>
where
C: StateEventContent,
C::StateKey: Borrow<K>,
K: AsRef<str> + ?Sized,
{
self.ensure_room_joined()?;
let request =
send_state_event::v3::Request::new(self.room_id().to_owned(), state_key, &content)?;
let response = self.client.send(request, None).await?;
Ok(response)
}
/// Send a raw room state event to the homeserver.
///
/// Returns the parsed response from the server.
///
/// # Arguments
///
/// * `event_type` - The type of the event that we're sending out.
///
/// * `state_key` - A unique key which defines the overwriting semantics for
/// this piece of room state. This value is often a zero-length string.
///
/// * `content` - The content of the event as a raw JSON value. The argument
/// type can be `serde_json::Value`, but also other raw JSON types; for
/// the full list check the documentation of [`IntoRawStateEventContent`].
///
/// # Examples
///
/// ```no_run
/// use serde_json::json;
///
/// # async {
/// # let homeserver = url::Url::parse("http://localhost:8080")?;
/// # let mut client = matrix_sdk::Client::new(homeserver).await?;
/// # let room_id = matrix_sdk::ruma::room_id!("!test:localhost");
///
/// if let Some(room) = client.get_room(&room_id) {
/// room.send_state_event_raw("m.room.member", "", json!({
/// "avatar_url": "mxc://example.org/SEsfnsuifSDFSSEF",
/// "displayname": "Alice Margatroid",
/// "membership": "join",
/// })).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
#[instrument(skip_all)]
pub async fn send_state_event_raw(
&self,
event_type: &str,
state_key: &str,
content: impl IntoRawStateEventContent,
) -> Result<send_state_event::v3::Response> {
self.ensure_room_joined()?;
let request = send_state_event::v3::Request::new_raw(
self.room_id().to_owned(),
event_type.into(),
state_key.to_owned(),
content.into_raw_state_event_content(),
);
Ok(self.client.send(request, None).await?)
}
/// Strips all information out of an event of the room.
///
/// Returns the [`redact_event::v3::Response`] from the server.
///
/// This cannot be undone. Users may redact their own events, and any user
/// with a power level greater than or equal to the redact power level of
/// the room may redact events there.
///
/// # Arguments
///
/// * `event_id` - The ID of the event to redact
///
/// * `reason` - The reason for the event being redacted.
///
/// * `txn_id` - A unique ID that can be attached to this event as
/// its transaction ID. If not given one is created for the message.
///
/// # Examples
///
/// ```no_run
/// use matrix_sdk::ruma::event_id;
///
/// # async {
/// # let homeserver = url::Url::parse("http://localhost:8080")?;
/// # let mut client = matrix_sdk::Client::new(homeserver).await?;
/// # let room_id = matrix_sdk::ruma::room_id!("!test:localhost");
/// #
/// if let Some(room) = client.get_room(&room_id) {
/// let event_id = event_id!("$xxxxxx:example.org");
/// let reason = Some("Indecent material");
/// room.redact(&event_id, reason, None).await?;
/// }
/// # anyhow::Ok(()) };
/// ```
#[instrument(skip_all)]
pub async fn redact(
&self,
event_id: &EventId,
reason: Option<&str>,
txn_id: Option<OwnedTransactionId>,
) -> HttpResult<redact_event::v3::Response> {
let txn_id = txn_id.unwrap_or_else(TransactionId::new);
let request = assign!(
redact_event::v3::Request::new(self.room_id().to_owned(), event_id.to_owned(), txn_id),
{ reason: reason.map(ToOwned::to_owned) }
);
self.client.send(request, None).await
}
/// Returns true if the user with the given user_id is able to redact
/// their own messages in the room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_redact_own(&self, user_id: &UserId) -> Result<bool> {
Ok(self.power_levels().await?.user_can_redact_own_event(user_id))
}
/// Returns true if the user with the given user_id is able to redact
/// messages of other users in the room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_redact_other(&self, user_id: &UserId) -> Result<bool> {
Ok(self.power_levels().await?.user_can_redact_event_of_other(user_id))
}
/// Returns true if the user with the given user_id is able to ban in the
/// room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_ban(&self, user_id: &UserId) -> Result<bool> {
Ok(self.power_levels().await?.user_can_ban(user_id))
}
/// Returns true if the user with the given user_id is able to kick in the
/// room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_invite(&self, user_id: &UserId) -> Result<bool> {
Ok(self.power_levels().await?.user_can_invite(user_id))
}
/// Returns true if the user with the given user_id is able to kick in the
/// room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_kick(&self, user_id: &UserId) -> Result<bool> {
Ok(self.power_levels().await?.user_can_kick(user_id))
}
/// Returns true if the user with the given user_id is able to send a
/// specific state event type in the room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_send_state(
&self,
user_id: &UserId,
state_event: StateEventType,
) -> Result<bool> {
Ok(self.power_levels().await?.user_can_send_state(user_id, state_event))
}
/// Returns true if the user with the given user_id is able to send a
/// specific message type in the room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_send_message(
&self,
user_id: &UserId,
message: MessageLikeEventType,
) -> Result<bool> {
Ok(self.power_levels().await?.user_can_send_message(user_id, message))
}
/// Returns true if the user with the given user_id is able to pin or unpin
/// events in the room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_pin_unpin(&self, user_id: &UserId) -> Result<bool> {
Ok(self
.power_levels()
.await?
.user_can_send_state(user_id, StateEventType::RoomPinnedEvents))
}
/// Returns true if the user with the given user_id is able to trigger a
/// notification in the room.
///
/// The call may fail if there is an error in getting the power levels.
pub async fn can_user_trigger_room_notification(&self, user_id: &UserId) -> Result<bool> {
Ok(self.power_levels().await?.user_can_trigger_room_notification(user_id))
}
/// Get a list of servers that should know this room.
///
/// Uses the synced members of the room and the suggested [routing
/// algorithm] from the Matrix spec.
///
/// Returns at most three servers.
///
/// [routing algorithm]: https://spec.matrix.org/v1.3/appendices/#routing
pub async fn route(&self) -> Result<Vec<OwnedServerName>> {
let acl_ev = self
.get_state_event_static::<RoomServerAclEventContent>()
.await?
.and_then(|ev| ev.deserialize().ok());
let acl = acl_ev.as_ref().and_then(|ev| match ev {
SyncOrStrippedState::Sync(ev) => ev.as_original().map(|ev| &ev.content),
SyncOrStrippedState::Stripped(ev) => Some(&ev.content),
});
// Filter out server names that:
// - Are blocked due to server ACLs
// - Are IP addresses
let members: Vec<_> = self
.members_no_sync(RoomMemberships::JOIN)
.await?
.into_iter()
.filter(|member| {
let server = member.user_id().server_name();
acl.filter(|acl| !acl.is_allowed(server)).is_none() && !server.is_ip_literal()
})
.collect();
// Get the server of the highest power level user in the room, provided
// they are at least power level 50.
let max = members
.iter()
.max_by_key(|member| member.power_level())
.filter(|max| max.power_level() >= 50)
.map(|member| member.user_id().server_name());
// Sort the servers by population.
let servers = members
.iter()
.map(|member| member.user_id().server_name())
.filter(|server| max.filter(|max| max == server).is_none())
.fold(BTreeMap::<_, u32>::new(), |mut servers, server| {
*servers.entry(server).or_default() += 1;
servers
});
let mut servers: Vec<_> = servers.into_iter().collect();
servers.sort_unstable_by(|(_, count_a), (_, count_b)| count_b.cmp(count_a));
Ok(max
.into_iter()
.chain(servers.into_iter().map(|(name, _)| name))
.take(3)
.map(ToOwned::to_owned)
.collect())
}
/// Get a `matrix.to` permalink to this room.
///
/// If this room has an alias, we use it. Otherwise, we try to use the
/// synced members in the room for [routing] the room ID.
///
/// [routing]: https://spec.matrix.org/v1.3/appendices/#routing
pub async fn matrix_to_permalink(&self) -> Result<MatrixToUri> {
if let Some(alias) = self.canonical_alias().or_else(|| self.alt_aliases().pop()) {
return Ok(alias.matrix_to_uri());
}
let via = self.route().await?;
Ok(self.room_id().matrix_to_uri_via(via))
}
/// Get a `matrix:` permalink to this room.
///
/// If this room has an alias, we use it. Otherwise, we try to use the
/// synced members in the room for [routing] the room ID.
///
/// # Arguments
///
/// * `join` - Whether the user should join the room.
///
/// [routing]: https://spec.matrix.org/v1.3/appendices/#routing
pub async fn matrix_permalink(&self, join: bool) -> Result<MatrixUri> {
if let Some(alias) = self.canonical_alias().or_else(|| self.alt_aliases().pop()) {
return Ok(alias.matrix_uri(join));
}
let via = self.route().await?;
Ok(self.room_id().matrix_uri_via(via, join))
}
/// Get a `matrix.to` permalink to an event in this room.
///
/// We try to use the synced members in the room for [routing] the room ID.
///
/// *Note*: This method does not check if the given event ID is actually
/// part of this room. It needs to be checked before calling this method
/// otherwise the permalink won't work.
///
/// # Arguments
///
/// * `event_id` - The ID of the event.
///
/// [routing]: https://spec.matrix.org/v1.3/appendices/#routing
pub async fn matrix_to_event_permalink(
&self,
event_id: impl Into<OwnedEventId>,
) -> Result<MatrixToUri> {
// Don't use the alias because an event is tied to a room ID, but an
// alias might point to another room, e.g. after a room upgrade.
let via = self.route().await?;
Ok(self.room_id().matrix_to_event_uri_via(event_id, via))
}
/// Get a `matrix:` permalink to an event in this room.
///
/// We try to use the synced members in the room for [routing] the room ID.
///
/// *Note*: This method does not check if the given event ID is actually
/// part of this room. It needs to be checked before calling this method
/// otherwise the permalink won't work.
///
/// # Arguments
///
/// * `event_id` - The ID of the event.
///
/// [routing]: https://spec.matrix.org/v1.3/appendices/#routing
pub async fn matrix_event_permalink(
&self,
event_id: impl Into<OwnedEventId>,
) -> Result<MatrixUri> {
// Don't use the alias because an event is tied to a room ID, but an
// alias might point to another room, e.g. after a room upgrade.
let via = self.route().await?;
Ok(self.room_id().matrix_event_uri_via(event_id, via))
}
/// Get the latest receipt of a user in this room.
///
/// # Arguments
///
/// * `receipt_type` - The type of receipt to get.
///
/// * `thread` - The thread containing the event of the receipt, if any.
///
/// * `user_id` - The ID of the user.
///
/// Returns the ID of the event on which the receipt applies and the
/// receipt.
pub async fn load_user_receipt(
&self,
receipt_type: ReceiptType,
thread: ReceiptThread,
user_id: &UserId,
) -> Result<Option<(OwnedEventId, Receipt)>> {
self.inner.load_user_receipt(receipt_type, thread, user_id).await.map_err(Into::into)
}
/// Load the receipts for an event in this room from storage.
///
/// # Arguments
///
/// * `receipt_type` - The type of receipt to get.
///
/// * `thread` - The thread containing the event of the receipt, if any.
///
/// * `event_id` - The ID of the event.
///
/// Returns a list of IDs of users who have sent a receipt for the event and
/// the corresponding receipts.
pub async fn load_event_receipts(
&self,
receipt_type: ReceiptType,
thread: ReceiptThread,
event_id: &EventId,
) -> Result<Vec<(OwnedUserId, Receipt)>> {
self.inner.load_event_receipts(receipt_type, thread, event_id).await.map_err(Into::into)
}
/// Get the push context for this room.
///
/// Returns `None` if some data couldn't be found. This should only happen
/// in brand new rooms, while we process its state.
pub async fn push_context(&self) -> Result<Option<PushConditionRoomCtx>> {
let room_id = self.room_id();
let user_id = self.own_user_id();
let room_info = self.clone_info();
let member_count = room_info.active_members_count();
let user_display_name = if let Some(member) = self.get_member_no_sync(user_id).await? {
member.name().to_owned()
} else {
return Ok(None);
};
let power_levels = self
.get_state_event_static::<RoomPowerLevelsEventContent>()
.await?
.and_then(|e| e.deserialize().ok())
.map(|e| e.power_levels().into());
Ok(Some(PushConditionRoomCtx {
user_id: user_id.to_owned(),
room_id: room_id.to_owned(),
member_count: UInt::new(member_count).unwrap_or(UInt::MAX),
user_display_name,
power_levels,
}))
}
/// Get the push actions for the given event with the current room state.
///
/// Note that it is possible that no push action is returned because the
/// current room state does not have all the required state events.
pub async fn event_push_actions<T>(&self, event: &Raw<T>) -> Result<Option<Vec<Action>>> {
let Some(push_context) = self.push_context().await? else {
debug!("Could not aggregate push context");
return Ok(None);
};
let push_rules = self.client().account().push_rules().await?;
Ok(Some(push_rules.get_actions(event, &push_context).to_owned()))
}
/// The membership details of the (latest) invite for the logged-in user in
/// this room.
pub async fn invite_details(&self) -> Result<Invite> {
let state = self.state();
if state != RoomState::Invited {
return Err(Error::WrongRoomState(WrongRoomState::new("Invited", state)));
}
let invitee = self
.get_member_no_sync(self.own_user_id())
.await?
.ok_or_else(|| Error::UnknownError(Box::new(InvitationError::EventMissing)))?;
let event = invitee.event();
let inviter_id = event.sender();
let inviter = self.get_member_no_sync(inviter_id).await?;
Ok(Invite { invitee, inviter })
}
/// Forget this room.
///
/// This communicates to the homeserver that it should forget the room.
///
/// Only left rooms can be forgotten.
pub async fn forget(&self) -> Result<()> {
let state = self.state();
if state != RoomState::Left {
return Err(Error::WrongRoomState(WrongRoomState::new("Left", state)));
}
let request = forget_room::v3::Request::new(self.inner.room_id().to_owned());
let _response = self.client.send(request, None).await?;
// If it was a DM, remove the room from the `m.direct` global account data.
if self.inner.direct_targets_length() != 0 {
if let Err(e) = self.set_is_direct(false).await {
// It is not important whether we managed to remove the room, it will not have
// any consequences, so just log the error.
warn!(room_id = ?self.room_id(), "failed to remove room from m.direct account data: {e}");
}
}
self.client.base_client().forget_room(self.inner.room_id()).await?;
Ok(())
}
fn ensure_room_joined(&self) -> Result<()> {
let state = self.state();
if state == RoomState::Joined {
Ok(())
} else {
Err(Error::WrongRoomState(WrongRoomState::new("Joined", state)))
}
}
/// Get the notification mode.
pub async fn notification_mode(&self) -> Option<RoomNotificationMode> {
if !matches!(self.state(), RoomState::Joined) {
return None;
}
let notification_settings = self.client().notification_settings().await;
// Get the user-defined mode if available
let notification_mode =
notification_settings.get_user_defined_room_notification_mode(self.room_id()).await;
if notification_mode.is_some() {
notification_mode
} else if let Ok(is_encrypted) = self.is_encrypted().await {
// Otherwise, if encrypted status is available, get the default mode for this
// type of room.
// From the point of view of notification settings, a `one-to-one` room is one
// that involves exactly two people.
let is_one_to_one = IsOneToOne::from(self.active_members_count() == 2);
let default_mode = notification_settings
.get_default_room_notification_mode(IsEncrypted::from(is_encrypted), is_one_to_one)
.await;
Some(default_mode)
} else {
None
}
}
/// Get the user-defined notification mode.
///
/// The result is cached for fast and non-async call. To read the cached
/// result, use
/// [`matrix_sdk_base::Room::cached_user_defined_notification_mode`].
//
// Note for maintainers:
//
// The fact the result is cached is an important property. If you change that in
// the future, please review all calls to this method.
pub async fn user_defined_notification_mode(&self) -> Option<RoomNotificationMode> {
if !matches!(self.state(), RoomState::Joined) {
return None;
}
let notification_settings = self.client().notification_settings().await;
// Get the user-defined mode if available
let mode =
notification_settings.get_user_defined_room_notification_mode(self.room_id()).await;
if let Some(mode) = mode {
self.update_cached_user_defined_notification_mode(mode);
}
mode
}
/// Report an event as inappropriate to the homeserver's administrator.
///
/// # Arguments
///
/// * `event_id` - The ID of the event to report.
/// * `score` - The score to rate this content.
/// * `reason` - The reason the content is being reported.
///
/// # Errors
///
/// Returns an error if the room is not joined or if an error occurs with
/// the request.
pub async fn report_content(
&self,
event_id: OwnedEventId,
score: Option<ReportedContentScore>,
reason: Option<String>,
) -> Result<report_content::v3::Response> {
let state = self.state();
if state != RoomState::Joined {
return Err(Error::WrongRoomState(WrongRoomState::new("Joined", state)));
}
let request = report_content::v3::Request::new(
self.inner.room_id().to_owned(),
event_id,
score.map(Into::into),
reason,
);
Ok(self.client.send(request, None).await?)
}
/// Set a flag on the room to indicate that the user has explicitly marked
/// it as (un)read.
pub async fn set_unread_flag(&self, unread: bool) -> Result<()> {
let user_id = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
let content = UnstableMarkedUnreadEventContent::from(MarkedUnreadEventContent::new(unread));
let request = set_room_account_data::v3::Request::new(
user_id.to_owned(),
self.inner.room_id().to_owned(),
&content,
)?;
self.client.send(request, None).await?;
Ok(())
}
/// Returns the [`RoomEventCache`] associated to this room, assuming the
/// global [`EventCache`] has been enabled for subscription.
pub async fn event_cache(
&self,
) -> event_cache::Result<(RoomEventCache, Arc<EventCacheDropHandles>)> {
self.client.event_cache().for_room(self.room_id()).await
}
/// This will only send a call notification event if appropriate.
///
/// This function is supposed to be called whenever the user creates a room
/// call. It will send a `m.call.notify` event if:
/// - there is not yet a running call.
///
/// It will configure the notify type: ring or notify based on:
/// - is this a DM room -> ring
/// - is this a group with more than one other member -> notify
pub async fn send_call_notification_if_needed(&self) -> Result<()> {
if self.has_active_room_call() {
return Ok(());
}
if !self.can_user_trigger_room_notification(self.own_user_id()).await? {
return Ok(());
}
self.send_call_notification(
self.room_id().to_string().to_owned(),
ApplicationType::Call,
if self.is_direct().await.unwrap_or(false) {
NotifyType::Ring
} else {
NotifyType::Notify
},
Mentions::with_room_mention(),
)
.await?;
Ok(())
}
/// Get the beacon information event in the room for the current user.
///
/// # Errors
///
/// Returns an error if the event is redacted, stripped, not found or could
/// not be deserialized.
async fn get_user_beacon_info(
&self,
) -> Result<OriginalSyncStateEvent<BeaconInfoEventContent>, BeaconError> {
let raw_event = self
.get_state_event_static_for_key::<BeaconInfoEventContent, _>(self.own_user_id())
.await?
.ok_or(BeaconError::NotFound)?;
match raw_event.deserialize()? {
SyncOrStrippedState::Sync(SyncStateEvent::Original(beacon_info)) => Ok(beacon_info),
SyncOrStrippedState::Sync(SyncStateEvent::Redacted(_)) => Err(BeaconError::Redacted),
SyncOrStrippedState::Stripped(_) => Err(BeaconError::Stripped),
}
}
/// Start sharing live location in the room.
///
/// # Arguments
///
/// * `duration_millis` - The duration for which the live location is
/// shared, in milliseconds.
/// * `description` - An optional description for the live location share.
///
/// # Errors
///
/// Returns an error if the room is not joined or if the state event could
/// not be sent.
pub async fn start_live_location_share(
&self,
duration_millis: u64,
description: Option<String>,
) -> Result<send_state_event::v3::Response> {
self.ensure_room_joined()?;
self.send_state_event_for_key(
self.own_user_id(),
BeaconInfoEventContent::new(
description,
Duration::from_millis(duration_millis),
true,
None,
),
)
.await
}
/// Stop sharing live location in the room.
///
/// # Errors
///
/// Returns an error if the room is not joined, if the beacon information
/// is redacted or stripped, or if the state event is not found.
pub async fn stop_live_location_share(
&self,
) -> Result<send_state_event::v3::Response, BeaconError> {
self.ensure_room_joined()?;
let mut beacon_info_event = self.get_user_beacon_info().await?;
beacon_info_event.content.stop();
Ok(self.send_state_event_for_key(self.own_user_id(), beacon_info_event.content).await?)
}
/// Send a location beacon event in the current room.
///
/// # Arguments
///
/// * `geo_uri` - The geo URI of the location beacon.
///
/// # Errors
///
/// Returns an error if the room is not joined, if the beacon information
/// is redacted or stripped, if the location share is no longer live,
/// or if the state event is not found.
pub async fn send_location_beacon(
&self,
geo_uri: String,
) -> Result<send_message_event::v3::Response, BeaconError> {
self.ensure_room_joined()?;
let beacon_info_event = self.get_user_beacon_info().await?;
if beacon_info_event.content.is_live() {
let content = BeaconEventContent::new(beacon_info_event.event_id, geo_uri, None);
Ok(self.send(content).await?)
} else {
Err(BeaconError::NotLive)
}
}
/// Send a call notification event in the current room.
///
/// This is only supposed to be used in **custom** situations where the user
/// explicitly chooses to send a `m.call.notify` event to invite/notify
/// someone explicitly in unusual conditions. The default should be to
/// use `send_call_notification_if_needed` just before a new room call is
/// created/joined.
///
/// One example could be that the UI allows to start a call with a subset of
/// users of the room members first. And then later on the user can
/// invite more users to the call.
pub async fn send_call_notification(
&self,
call_id: String,
application: ApplicationType,
notify_type: NotifyType,
mentions: Mentions,
) -> Result<()> {
let call_notify_event_content =
CallNotifyEventContent::new(call_id, application, notify_type, mentions);
self.send(call_notify_event_content).await?;
Ok(())
}
/// Store the given `ComposerDraft` in the state store using the current
/// room id, as identifier.
pub async fn save_composer_draft(&self, draft: ComposerDraft) -> Result<()> {
self.client
.store()
.set_kv_data(
StateStoreDataKey::ComposerDraft(self.room_id()),
StateStoreDataValue::ComposerDraft(draft),
)
.await?;
Ok(())
}
/// Retrieve the `ComposerDraft` stored in the state store for this room.
pub async fn load_composer_draft(&self) -> Result<Option<ComposerDraft>> {
let data = self
.client
.store()
.get_kv_data(StateStoreDataKey::ComposerDraft(self.room_id()))
.await?;
Ok(data.and_then(|d| d.into_composer_draft()))
}
/// Remove the `ComposerDraft` stored in the state store for this room.
pub async fn clear_composer_draft(&self) -> Result<()> {
self.client
.store()
.remove_kv_data(StateStoreDataKey::ComposerDraft(self.room_id()))
.await?;
Ok(())
}
/// Load pinned state events for a room from the `/state` endpoint in the
/// home server.
pub async fn load_pinned_events(&self) -> Result<Option<Vec<OwnedEventId>>> {
let response = self
.client
.send(
get_state_events_for_key::v3::Request::new(
self.room_id().to_owned(),
StateEventType::RoomPinnedEvents,
"".to_owned(),
),
None,
)
.await;
match response {
Ok(response) => {
Ok(Some(response.content.deserialize_as::<RoomPinnedEventsEventContent>()?.pinned))
}
Err(http_error) => match http_error.as_client_api_error() {
Some(error) if error.status_code == StatusCode::NOT_FOUND => Ok(None),
_ => Err(http_error.into()),
},
}
}
}
#[cfg(all(feature = "e2e-encryption", not(target_arch = "wasm32")))]
#[async_trait]
impl RoomIdentityProvider for Room {
async fn is_member(&self, user_id: &UserId) -> bool {
self.get_member(user_id).await.unwrap_or(None).is_some()
}
async fn member_identities(&self) -> Vec<UserIdentity> {
let members = self
.members(RoomMemberships::JOIN | RoomMemberships::INVITE)
.await
.unwrap_or_else(|_| Default::default());
let mut ret: Vec<UserIdentity> = Vec::new();
for member in members {
if let Some(i) = self.user_identity(member.user_id()).await {
ret.push(i);
}
}
ret
}
async fn user_identity(&self, user_id: &UserId) -> Option<UserIdentity> {
self.client
.encryption()
.get_user_identity(user_id)
.await
.unwrap_or(None)
.map(|u| u.underlying_identity())
}
}
/// A wrapper for a weak client and a room id that allows to lazily retrieve a
/// room, only when needed.
#[derive(Clone)]
pub(crate) struct WeakRoom {
client: WeakClient,
room_id: OwnedRoomId,
}
impl WeakRoom {
/// Create a new `WeakRoom` given its weak components.
pub fn new(client: WeakClient, room_id: OwnedRoomId) -> Self {
Self { client, room_id }
}
/// Attempts to reconstruct the room.
pub fn get(&self) -> Option<Room> {
self.client.get().and_then(|client| client.get_room(&self.room_id))
}
/// The room id for that room.
pub fn room_id(&self) -> &RoomId {
&self.room_id
}
}
/// Details of the (latest) invite.
#[derive(Debug, Clone)]
pub struct Invite {
/// Who has been invited.
pub invitee: RoomMember,
/// Who sent the invite.
pub inviter: Option<RoomMember>,
}
#[derive(Error, Debug)]
enum InvitationError {
#[error("No membership event found")]
EventMissing,
}
/// Receipts to send all at once.
#[derive(Debug, Clone, Default)]
#[non_exhaustive]
pub struct Receipts {
/// Fully-read marker (room account data).
pub fully_read: Option<OwnedEventId>,
/// Read receipt (public ephemeral room event).
pub public_read_receipt: Option<OwnedEventId>,
/// Read receipt (private ephemeral room event).
pub private_read_receipt: Option<OwnedEventId>,
}
impl Receipts {
/// Create an empty `Receipts`.
pub fn new() -> Self {
Self::default()
}
/// Set the last event the user has read.
///
/// It means that the user has read all the events before this event.
///
/// This is a private marker only visible by the user.
///
/// Note that this is technically not a receipt as it is persisted in the
/// room account data.
pub fn fully_read_marker(mut self, event_id: impl Into<Option<OwnedEventId>>) -> Self {
self.fully_read = event_id.into();
self
}
/// Set the last event presented to the user and forward it to the other
/// users in the room.
///
/// This is used to reset the unread messages/notification count and
/// advertise to other users the last event that the user has likely seen.
pub fn public_read_receipt(mut self, event_id: impl Into<Option<OwnedEventId>>) -> Self {
self.public_read_receipt = event_id.into();
self
}
/// Set the last event presented to the user and don't forward it.
///
/// This is used to reset the unread messages/notification count.
pub fn private_read_receipt(mut self, event_id: impl Into<Option<OwnedEventId>>) -> Self {
self.private_read_receipt = event_id.into();
self
}
/// Whether this `Receipts` is empty.
pub fn is_empty(&self) -> bool {
self.fully_read.is_none()
&& self.public_read_receipt.is_none()
&& self.private_read_receipt.is_none()
}
}
/// [Parent space](https://spec.matrix.org/v1.8/client-server-api/#mspaceparent-relationships)
/// listed by a room, possibly validated by checking the space's state.
#[derive(Debug)]
pub enum ParentSpace {
/// The room recognizes the given room as its parent, and the parent
/// recognizes it as its child.
Reciprocal(Room),
/// The room recognizes the given room as its parent, but the parent does
/// not recognizes it as its child. However, the author of the
/// `m.room.parent` event in the room has a sufficient power level in the
/// parent to create the child event.
WithPowerlevel(Room),
/// The room recognizes the given room as its parent, but the parent does
/// not recognizes it as its child.
Illegitimate(Room),
/// The room recognizes the given id as its parent room, but we cannot check
/// whether the parent recognizes it as its child.
Unverifiable(OwnedRoomId),
}
/// The score to rate an inappropriate content.
///
/// Must be a value between `0`, inoffensive, and `-100`, very offensive.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub struct ReportedContentScore(i8);
impl ReportedContentScore {
/// The smallest value that can be represented by this type.
///
/// This is for very offensive content.
pub const MIN: Self = Self(-100);
/// The largest value that can be represented by this type.
///
/// This is for inoffensive content.
pub const MAX: Self = Self(0);
/// Try to create a `ReportedContentScore` from the provided `i8`.
///
/// Returns `None` if it is smaller than [`ReportedContentScore::MIN`] or
/// larger than [`ReportedContentScore::MAX`] .
///
/// This is the same as the `TryFrom<i8>` implementation for
/// `ReportedContentScore`, except that it returns an `Option` instead
/// of a `Result`.
pub fn new(value: i8) -> Option<Self> {
value.try_into().ok()
}
/// Create a `ReportedContentScore` from the provided `i8` clamped to the
/// acceptable interval.
///
/// The given value gets clamped into the closed interval between
/// [`ReportedContentScore::MIN`] and [`ReportedContentScore::MAX`].
pub fn new_saturating(value: i8) -> Self {
if value > Self::MAX {
Self::MAX
} else if value < Self::MIN {
Self::MIN
} else {
Self(value)
}
}
/// The value of this score.
pub fn value(&self) -> i8 {
self.0
}
}
impl PartialEq<i8> for ReportedContentScore {
fn eq(&self, other: &i8) -> bool {
self.0.eq(other)
}
}
impl PartialEq<ReportedContentScore> for i8 {
fn eq(&self, other: &ReportedContentScore) -> bool {
self.eq(&other.0)
}
}
impl PartialOrd<i8> for ReportedContentScore {
fn partial_cmp(&self, other: &i8) -> Option<std::cmp::Ordering> {
self.0.partial_cmp(other)
}
}
impl PartialOrd<ReportedContentScore> for i8 {
fn partial_cmp(&self, other: &ReportedContentScore) -> Option<std::cmp::Ordering> {
self.partial_cmp(&other.0)
}
}
impl From<ReportedContentScore> for Int {
fn from(value: ReportedContentScore) -> Self {
value.0.into()
}
}
impl TryFrom<i8> for ReportedContentScore {
type Error = TryFromReportedContentScoreError;
fn try_from(value: i8) -> std::prelude::v1::Result<Self, Self::Error> {
if value > Self::MAX || value < Self::MIN {
Err(TryFromReportedContentScoreError(()))
} else {
Ok(Self(value))
}
}
}
impl TryFrom<i16> for ReportedContentScore {
type Error = TryFromReportedContentScoreError;
fn try_from(value: i16) -> std::prelude::v1::Result<Self, Self::Error> {
let value = i8::try_from(value).map_err(|_| TryFromReportedContentScoreError(()))?;
value.try_into()
}
}
impl TryFrom<i32> for ReportedContentScore {
type Error = TryFromReportedContentScoreError;
fn try_from(value: i32) -> std::prelude::v1::Result<Self, Self::Error> {
let value = i8::try_from(value).map_err(|_| TryFromReportedContentScoreError(()))?;
value.try_into()
}
}
impl TryFrom<i64> for ReportedContentScore {
type Error = TryFromReportedContentScoreError;
fn try_from(value: i64) -> std::prelude::v1::Result<Self, Self::Error> {
let value = i8::try_from(value).map_err(|_| TryFromReportedContentScoreError(()))?;
value.try_into()
}
}
impl TryFrom<Int> for ReportedContentScore {
type Error = TryFromReportedContentScoreError;
fn try_from(value: Int) -> std::prelude::v1::Result<Self, Self::Error> {
let value = i8::try_from(value).map_err(|_| TryFromReportedContentScoreError(()))?;
value.try_into()
}
}
/// The error type returned when a checked `ReportedContentScore` conversion
/// fails.
#[derive(Debug, Clone, Error)]
#[error("out of range conversion attempted")]
pub struct TryFromReportedContentScoreError(());
#[cfg(all(test, not(target_arch = "wasm32")))]
mod tests {
use matrix_sdk_base::{store::ComposerDraftType, ComposerDraft, SessionMeta};
use matrix_sdk_test::{
async_test, test_json, JoinedRoomBuilder, StateTestEvent, SyncResponseBuilder,
};
use ruma::{device_id, int, user_id};
use wiremock::{
matchers::{header, method, path_regex},
Mock, MockServer, ResponseTemplate,
};
use super::ReportedContentScore;
use crate::{
config::RequestConfig,
matrix_auth::{MatrixSession, MatrixSessionTokens},
test_utils::logged_in_client,
Client,
};
#[cfg(all(feature = "sqlite", feature = "e2e-encryption"))]
#[async_test]
async fn test_cache_invalidation_while_encrypt() {
use matrix_sdk_test::{message_like_event_content, DEFAULT_TEST_ROOM_ID};
let sqlite_path = std::env::temp_dir().join("cache_invalidation_while_encrypt.db");
let session = MatrixSession {
meta: SessionMeta {
user_id: user_id!("@example:localhost").to_owned(),
device_id: device_id!("DEVICEID").to_owned(),
},
tokens: MatrixSessionTokens { access_token: "1234".to_owned(), refresh_token: None },
};
let client = Client::builder()
.homeserver_url("http://localhost:1234")
.request_config(RequestConfig::new().disable_retry())
.sqlite_store(&sqlite_path, None)
.build()
.await
.unwrap();
client.matrix_auth().restore_session(session.clone()).await.unwrap();
client.encryption().enable_cross_process_store_lock("client1".to_owned()).await.unwrap();
// Mock receiving an event to create an internal room.
let server = MockServer::start().await;
{
Mock::given(method("GET"))
.and(path_regex(r"^/_matrix/client/r0/rooms/.*/state/m.*room.*encryption.?"))
.and(header("authorization", "Bearer 1234"))
.respond_with(
ResponseTemplate::new(200)
.set_body_json(&*test_json::sync_events::ENCRYPTION_CONTENT),
)
.mount(&server)
.await;
let response = SyncResponseBuilder::default()
.add_joined_room(
JoinedRoomBuilder::default()
.add_state_event(StateTestEvent::Member)
.add_state_event(StateTestEvent::PowerLevels)
.add_state_event(StateTestEvent::Encryption),
)
.build_sync_response();
client.base_client().receive_sync_response(response).await.unwrap();
}
let room = client.get_room(&DEFAULT_TEST_ROOM_ID).expect("Room should exist");
// Step 1, preshare the room keys.
room.preshare_room_key().await.unwrap();
// Step 2, force lock invalidation by pretending another client obtained the
// lock.
{
let client = Client::builder()
.homeserver_url("http://localhost:1234")
.request_config(RequestConfig::new().disable_retry())
.sqlite_store(&sqlite_path, None)
.build()
.await
.unwrap();
client.matrix_auth().restore_session(session.clone()).await.unwrap();
client
.encryption()
.enable_cross_process_store_lock("client2".to_owned())
.await
.unwrap();
let guard = client.encryption().spin_lock_store(None).await.unwrap();
assert!(guard.is_some());
}
// Step 3, take the crypto-store lock.
let guard = client.encryption().spin_lock_store(None).await.unwrap();
assert!(guard.is_some());
// Step 4, try to encrypt a message.
let olm = client.olm_machine().await;
let olm = olm.as_ref().expect("Olm machine wasn't started");
// Now pretend we're encrypting an event; the olm machine shouldn't rely on
// caching the outgoing session before.
let _encrypted_content = olm
.encrypt_room_event_raw(room.room_id(), "test-event", &message_like_event_content!({}))
.await
.unwrap();
}
#[test]
fn reported_content_score() {
// i8
let score = ReportedContentScore::new(0).unwrap();
assert_eq!(score.value(), 0);
let score = ReportedContentScore::new(-50).unwrap();
assert_eq!(score.value(), -50);
let score = ReportedContentScore::new(-100).unwrap();
assert_eq!(score.value(), -100);
assert_eq!(ReportedContentScore::new(10), None);
assert_eq!(ReportedContentScore::new(-110), None);
let score = ReportedContentScore::new_saturating(0);
assert_eq!(score.value(), 0);
let score = ReportedContentScore::new_saturating(-50);
assert_eq!(score.value(), -50);
let score = ReportedContentScore::new_saturating(-100);
assert_eq!(score.value(), -100);
let score = ReportedContentScore::new_saturating(10);
assert_eq!(score, ReportedContentScore::MAX);
let score = ReportedContentScore::new_saturating(-110);
assert_eq!(score, ReportedContentScore::MIN);
// i16
let score = ReportedContentScore::try_from(0i16).unwrap();
assert_eq!(score.value(), 0);
let score = ReportedContentScore::try_from(-100i16).unwrap();
assert_eq!(score.value(), -100);
ReportedContentScore::try_from(10i16).unwrap_err();
ReportedContentScore::try_from(-110i16).unwrap_err();
// i32
let score = ReportedContentScore::try_from(0i32).unwrap();
assert_eq!(score.value(), 0);
let score = ReportedContentScore::try_from(-100i32).unwrap();
assert_eq!(score.value(), -100);
ReportedContentScore::try_from(10i32).unwrap_err();
ReportedContentScore::try_from(-110i32).unwrap_err();
// i64
let score = ReportedContentScore::try_from(0i64).unwrap();
assert_eq!(score.value(), 0);
let score = ReportedContentScore::try_from(-100i64).unwrap();
assert_eq!(score.value(), -100);
ReportedContentScore::try_from(10i64).unwrap_err();
ReportedContentScore::try_from(-110i64).unwrap_err();
// Int
let score = ReportedContentScore::try_from(int!(0)).unwrap();
assert_eq!(score.value(), 0);
let score = ReportedContentScore::try_from(int!(-100)).unwrap();
assert_eq!(score.value(), -100);
ReportedContentScore::try_from(int!(10)).unwrap_err();
ReportedContentScore::try_from(int!(-110)).unwrap_err();
}
#[async_test]
async fn test_composer_draft() {
use matrix_sdk_test::DEFAULT_TEST_ROOM_ID;
let client = logged_in_client(None).await;
let response = SyncResponseBuilder::default()
.add_joined_room(JoinedRoomBuilder::default())
.build_sync_response();
client.base_client().receive_sync_response(response).await.unwrap();
let room = client.get_room(&DEFAULT_TEST_ROOM_ID).expect("Room should exist");
assert_eq!(room.load_composer_draft().await.unwrap(), None);
let draft = ComposerDraft {
plain_text: "Hello, world!".to_owned(),
html_text: Some("<strong>Hello</strong>, world!".to_owned()),
draft_type: ComposerDraftType::NewMessage,
};
room.save_composer_draft(draft.clone()).await.unwrap();
assert_eq!(room.load_composer_draft().await.unwrap(), Some(draft));
room.clear_composer_draft().await.unwrap();
assert_eq!(room.load_composer_draft().await.unwrap(), None);
}
}