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
// Copyright 2020 Damir Jelić
// Copyright 2020 The Matrix.org Foundation C.I.C.
// Copyright 2022 Famedly GmbH
//
// 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.
use std::{
fmt::{self, Debug},
future::Future,
pin::Pin,
sync::Arc,
};
#[cfg(target_arch = "wasm32")]
use async_once_cell::OnceCell;
use dashmap::DashMap;
use futures_core::stream::Stream;
use futures_signals::signal::Signal;
use matrix_sdk_base::{
deserialized_responses::SyncResponse, BaseClient, SendOutsideWasm, Session, SessionMeta,
SessionTokens, StateStore, SyncOutsideWasm,
};
use matrix_sdk_common::{
instant::Instant,
locks::{Mutex, RwLock, RwLockReadGuard},
};
#[cfg(feature = "appservice")]
use ruma::TransactionId;
use ruma::{
api::{
client::{
account::{register, whoami},
alias::get_alias,
device::{delete_devices, get_devices},
directory::{get_public_rooms, get_public_rooms_filtered},
discovery::{
get_capabilities::{self, Capabilities},
get_supported_versions,
},
error::ErrorKind,
filter::{create_filter::v3::Request as FilterUploadRequest, FilterDefinition},
membership::{join_room_by_id, join_room_by_id_or_alias},
push::get_notifications::v3::Notification,
room::create_room,
session::{
get_login_types, login, logout, refresh_token, sso_login, sso_login_with_provider,
},
sync::sync_events,
uiaa::{AuthData, UserIdentifier},
},
error::{FromHttpResponseError, ServerError},
MatrixVersion, OutgoingRequest, SendAccessToken,
},
assign,
presence::PresenceState,
DeviceId, OwnedDeviceId, OwnedRoomId, OwnedServerName, RoomAliasId, RoomId, RoomOrAliasId,
ServerName, UInt, UserId,
};
use serde::de::DeserializeOwned;
#[cfg(not(target_arch = "wasm32"))]
use tokio::sync::OnceCell;
#[cfg(feature = "e2e-encryption")]
use tracing::error;
use tracing::{debug, info, instrument};
use url::Url;
#[cfg(feature = "e2e-encryption")]
use crate::encryption::Encryption;
use crate::{
config::RequestConfig,
error::{HttpError, HttpResult},
event_handler::{
EventHandler, EventHandlerDropGuard, EventHandlerHandle, EventHandlerResult,
EventHandlerStore, SyncEvent,
},
http_client::HttpClient,
room, Account, Error, Media, RefreshTokenError, Result, RumaApiError,
};
mod builder;
mod login_builder;
#[cfg(feature = "sso-login")]
pub use self::login_builder::SsoLoginBuilder;
pub use self::{
builder::{ClientBuildError, ClientBuilder},
login_builder::LoginBuilder,
};
#[cfg(not(target_arch = "wasm32"))]
type NotificationHandlerFut = Pin<Box<dyn Future<Output = ()> + Send>>;
#[cfg(target_arch = "wasm32")]
type NotificationHandlerFut = Pin<Box<dyn Future<Output = ()>>>;
#[cfg(not(target_arch = "wasm32"))]
type NotificationHandlerFn =
Box<dyn Fn(Notification, room::Room, Client) -> NotificationHandlerFut + Send + Sync>;
#[cfg(target_arch = "wasm32")]
type NotificationHandlerFn =
Box<dyn Fn(Notification, room::Room, Client) -> NotificationHandlerFut>;
/// Enum controlling if a loop running callbacks should continue or abort.
///
/// This is mainly used in the [`sync_with_callback`] method, the return value
/// of the provided callback controls if the sync loop should be exited.
///
/// [`sync_with_callback`]: #method.sync_with_callback
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LoopCtrl {
/// Continue running the loop.
Continue,
/// Break out of the loop.
Break,
}
/// An async/await enabled Matrix client.
///
/// All of the state is held in an `Arc` so the `Client` can be cloned freely.
#[derive(Clone)]
pub struct Client {
pub(crate) inner: Arc<ClientInner>,
}
pub(crate) struct ClientInner {
/// The URL of the homeserver to connect to.
homeserver: RwLock<Url>,
/// The OIDC Provider that is trusted by the homeserver.
authentication_issuer: Option<RwLock<Url>>,
/// The underlying HTTP client.
http_client: HttpClient,
/// User session data.
base_client: BaseClient,
/// The Matrix versions the server supports (well-known ones only)
server_versions: OnceCell<Box<[MatrixVersion]>>,
/// Locks making sure we only have one group session sharing request in
/// flight per room.
#[cfg(feature = "e2e-encryption")]
pub(crate) group_session_locks: DashMap<OwnedRoomId, Arc<Mutex<()>>>,
/// Lock making sure we're only doing one key claim request at a time.
#[cfg(feature = "e2e-encryption")]
pub(crate) key_claim_lock: Mutex<()>,
pub(crate) members_request_locks: DashMap<OwnedRoomId, Arc<Mutex<()>>>,
pub(crate) typing_notice_times: DashMap<OwnedRoomId, Instant>,
/// Event handlers. See `add_event_handler`.
pub(crate) event_handlers: EventHandlerStore,
/// Notification handlers. See `register_notification_handler`.
notification_handlers: RwLock<Vec<NotificationHandlerFn>>,
/// Whether the client should operate in application service style mode.
/// This is low-level functionality. For an high-level API check the
/// `matrix_sdk_appservice` crate.
appservice_mode: bool,
/// Whether the client should update its homeserver URL with the discovery
/// information present in the login response.
respect_login_well_known: bool,
/// Whether to try to refresh the access token automatically when an
/// `M_UNKNOWN_TOKEN` error is encountered.
handle_refresh_tokens: bool,
/// Lock making sure we're only doing one token refresh at a time.
refresh_token_lock: Mutex<Result<(), RefreshTokenError>>,
/// An event that can be listened on to wait for a successful sync. The
/// event will only be fired if a sync loop is running. Can be used for
/// synchronization, e.g. if we send out a request to create a room, we can
/// wait for the sync to get the data to fetch a room object from the state
/// store.
pub(crate) sync_beat: event_listener::Event,
}
#[cfg(not(tarpaulin_include))]
impl Debug for Client {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
write!(fmt, "Client")
}
}
impl Client {
/// Create a new [`Client`] that will use the given homeserver.
///
/// # Arguments
///
/// * `homeserver_url` - The homeserver that the client should connect to.
pub async fn new(homeserver_url: Url) -> Result<Self, HttpError> {
Self::builder()
.homeserver_url(homeserver_url)
.build()
.await
.map_err(ClientBuildError::assert_valid_builder_args)
}
/// Create a new [`ClientBuilder`].
pub fn builder() -> ClientBuilder {
ClientBuilder::new()
}
pub(crate) fn base_client(&self) -> &BaseClient {
&self.inner.base_client
}
/// Change the homeserver URL used by this client.
///
/// # Arguments
///
/// * `homeserver_url` - The new URL to use.
async fn set_homeserver(&self, homeserver_url: Url) {
let mut homeserver = self.inner.homeserver.write().await;
*homeserver = homeserver_url;
}
/// Get the capabilities of the homeserver.
///
/// This method should be used to check what features are supported by the
/// homeserver.
///
/// # Example
/// ```no_run
/// # use futures::executor::block_on;
/// # use matrix_sdk::Client;
/// # use url::Url;
/// # block_on(async {
/// # let homeserver = Url::parse("http://example.com")?;
/// let client = Client::new(homeserver).await?;
///
/// let capabilities = client.get_capabilities().await?;
///
/// if capabilities.change_password.enabled {
/// // Change password
/// }
///
/// # anyhow::Ok(()) });
/// ```
pub async fn get_capabilities(&self) -> HttpResult<Capabilities> {
let res = self.send(get_capabilities::v3::Request::new(), None).await?;
Ok(res.capabilities)
}
/// Process a [transaction] received from the homeserver which has been
/// converted into a sync response.
///
/// # Arguments
///
/// * `transaction_id` - The id of the transaction, used to guard against
/// the same transaction being sent twice. This guarding currently isn't
/// implemented.
/// * `sync_response` - The sync response converted from a transaction
/// received from the homeserver.
///
/// [transaction]: https://matrix.org/docs/spec/application_service/r0.1.2#put-matrix-app-v1-transactions-txnid
#[cfg(feature = "appservice")]
pub async fn receive_transaction(
&self,
transaction_id: &TransactionId,
sync_response: sync_events::v3::Response,
) -> Result<()> {
const TXN_ID_KEY: &[u8] = b"appservice.txn_id";
let store = self.store();
let store_tokens = store.get_custom_value(TXN_ID_KEY).await?;
let mut txn_id_bytes = transaction_id.as_bytes().to_vec();
if let Some(mut store_tokens) = store_tokens {
// The data is separated by a NULL byte.
let mut store_tokens_split = store_tokens.split(|x| *x == b'\0');
if store_tokens_split.any(|x| x == transaction_id.as_bytes()) {
// We already encountered this transaction id before, so we exit early instead
// of processing further.
//
// Spec: https://spec.matrix.org/v1.3/application-service-api/#pushing-events
return Ok(());
}
store_tokens.push(b'\0');
store_tokens.append(&mut txn_id_bytes);
self.store().set_custom_value(TXN_ID_KEY, store_tokens).await?;
} else {
self.store().set_custom_value(TXN_ID_KEY, txn_id_bytes).await?;
}
self.process_sync(sync_response).await?;
Ok(())
}
/// Get a copy of the default request config.
///
/// The default request config is what's used when sending requests if no
/// `RequestConfig` is explicitly passed to [`send`][Self::send] or another
/// function with such a parameter.
///
/// If the default request config was not customized through
/// [`ClientBuilder`] when creating this `Client`, the returned value will
/// be equivalent to [`RequestConfig::default()`].
pub fn request_config(&self) -> RequestConfig {
self.inner.http_client.request_config
}
/// Is the client logged in.
pub fn logged_in(&self) -> bool {
self.inner.base_client.logged_in()
}
/// The Homeserver of the client.
pub async fn homeserver(&self) -> Url {
self.inner.homeserver.read().await.clone()
}
/// The OIDC Provider that is trusted by the homeserver.
pub async fn authentication_issuer(&self) -> Option<Url> {
if let Some(server) = &self.inner.authentication_issuer {
Some(server.read().await.clone())
} else {
None
}
}
fn session_meta(&self) -> Option<&SessionMeta> {
self.base_client().session_meta()
}
/// Get the user id of the current owner of the client.
pub fn user_id(&self) -> Option<&UserId> {
self.session_meta().map(|s| s.user_id.as_ref())
}
/// Get the device ID that identifies the current session.
pub fn device_id(&self) -> Option<&DeviceId> {
self.session_meta().map(|s| s.device_id.as_ref())
}
/// Get the current access token and optional refresh token for this
/// session.
///
/// Will be `None` if the client has not been logged in.
///
/// After login, the tokens should only change if support for [refreshing
/// access tokens] has been enabled.
///
/// [refreshing access tokens]: https://spec.matrix.org/v1.3/client-server-api/#refreshing-access-tokens
pub fn session_tokens(&self) -> Option<SessionTokens> {
self.base_client().session_tokens().get_cloned()
}
/// Get the current access token for this session.
///
/// Will be `None` if the client has not been logged in.
///
/// After login, this token should only change if support for [refreshing
/// access tokens] has been enabled.
///
/// [refreshing access tokens]: https://spec.matrix.org/v1.3/client-server-api/#refreshing-access-tokens
pub fn access_token(&self) -> Option<String> {
self.session_tokens().map(|tokens| tokens.access_token)
}
/// Get the current refresh token for this session.
///
/// Will be `None` if the client has not been logged in, or if the access
/// token doesn't expire.
///
/// After login, this token should only change if support for [refreshing
/// access tokens] has been enabled.
///
/// [refreshing access tokens]: https://spec.matrix.org/v1.3/client-server-api/#refreshing-access-tokens
pub fn refresh_token(&self) -> Option<String> {
self.session_tokens().and_then(|tokens| tokens.refresh_token)
}
/// [`Signal`] to get notified when the current access token and optional
/// refresh token for this session change.
///
/// This can be used with [`Client::session()`] to persist the [`Session`]
/// when the tokens change.
///
/// After login, the tokens should only change if support for [refreshing
/// access tokens] has been enabled.
///
/// # Example
///
/// ```no_run
/// use futures_signals::signal::SignalExt;
/// use matrix_sdk::Client;
/// # use matrix_sdk::Session;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # fn persist_session(_: Option<Session>) {};
///
/// let homeserver = "http://example.com";
/// let client = Client::builder()
/// .homeserver_url(homeserver)
/// .handle_refresh_tokens()
/// .build()
/// .await?;
///
/// let response = client
/// .login_username("user", "wordpass")
/// .initial_device_display_name("My App")
/// .request_refresh_token()
/// .send()
/// .await?;
///
/// persist_session(client.session());
///
/// // Handle when at least one of the tokens changed.
/// let future = client.session_tokens_changed_signal().for_each(move |_| {
/// let client = client.clone();
/// async move {
/// persist_session(client.session());
/// }
/// });
///
/// tokio::spawn(future);
///
/// # anyhow::Ok(()) });
/// ```
///
/// [refreshing access tokens]: https://spec.matrix.org/v1.3/client-server-api/#refreshing-access-tokens
pub fn session_tokens_changed_signal(&self) -> impl Signal<Item = ()> {
self.base_client().session_tokens().signal_ref(|_| ())
}
/// Get the current access token and optional refresh token for this
/// session as a [`Signal`].
///
/// This can be used to watch changes of the tokens by calling methods like
/// `for_each()` or `to_stream()`.
///
/// The value will be `None` if the client has not been logged in.
///
/// After login, the tokens should only change if support for [refreshing
/// access tokens] has been enabled.
///
/// # Example
///
/// ```no_run
/// use futures::StreamExt;
/// use futures_signals::signal::SignalExt;
/// use matrix_sdk::Client;
/// # use matrix_sdk::Session;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # fn persist_session(_: &Session) {};
///
/// let homeserver = "http://example.com";
/// let client = Client::builder()
/// .homeserver_url(homeserver)
/// .handle_refresh_tokens()
/// .build()
/// .await?;
///
/// client
/// .login_username("user", "wordpass")
/// .initial_device_display_name("My App")
/// .request_refresh_token()
/// .send()
/// .await?;
///
/// let mut session = client.session().expect("Client should be logged in");
/// persist_session(&session);
///
/// // Handle when at least one of the tokens changed.
/// let mut tokens_stream = client.session_tokens_signal().to_stream();
/// loop {
/// if let Some(tokens) = tokens_stream.next().await.flatten() {
/// session.access_token = tokens.access_token;
///
/// if let Some(refresh_token) = tokens.refresh_token {
/// session.refresh_token = Some(refresh_token);
/// }
///
/// persist_session(&session);
/// }
/// }
///
/// # anyhow::Ok(()) });
/// ```
///
/// [refreshing access tokens]: https://spec.matrix.org/v1.3/client-server-api/#refreshing-access-tokens
pub fn session_tokens_signal(&self) -> impl Signal<Item = Option<SessionTokens>> {
self.base_client().session_tokens().signal_cloned()
}
/// Get the whole session info of this client.
///
/// Will be `None` if the client has not been logged in.
///
/// Can be used with [`Client::restore_login`] to restore a previously
/// logged-in session.
pub fn session(&self) -> Option<Session> {
self.base_client().session()
}
/// Get a reference to the state store.
pub fn store(&self) -> &dyn StateStore {
self.base_client().store()
}
/// Get the account of the current owner of the client.
pub fn account(&self) -> Account {
Account::new(self.clone())
}
/// Get the encryption manager of the client.
#[cfg(feature = "e2e-encryption")]
pub fn encryption(&self) -> Encryption {
Encryption::new(self.clone())
}
/// Get the media manager of the client.
pub fn media(&self) -> Media {
Media::new(self.clone())
}
/// Register a handler for a specific event type.
///
/// The handler is a function or closure with one or more arguments. The
/// first argument is the event itself. All additional arguments are
/// "context" arguments: They have to implement [`EventHandlerContext`].
/// This trait is named that way because most of the types implementing it
/// give additional context about an event: The room it was in, its raw form
/// and other similar things. As two exceptions to this,
/// [`Client`] and [`EventHandlerHandle`] also implement the
/// `EventHandlerContext` trait so you don't have to clone your client
/// into the event handler manually and a handler can decide to remove
/// itself.
///
/// Some context arguments are not universally applicable. A context
/// argument that isn't available for the given event type will result in
/// the event handler being skipped and an error being logged. The following
/// context argument types are only available for a subset of event types:
///
/// * [`Room`][room::Room] is only available for room-specific events, i.e.
/// not for events like global account data events or presence events
///
/// [`EventHandlerContext`]: crate::event_handler::EventHandlerContext
///
/// # Examples
///
/// ```
/// # use futures::executor::block_on;
/// # use url::Url;
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
/// use matrix_sdk::{
/// deserialized_responses::EncryptionInfo,
/// room::Room,
/// ruma::{
/// events::{
/// macros::EventContent,
/// push_rules::PushRulesEvent,
/// room::{message::SyncRoomMessageEvent, topic::SyncRoomTopicEvent},
/// },
/// Int, MilliSecondsSinceUnixEpoch,
/// },
/// Client,
/// };
/// use serde::{Deserialize, Serialize};
///
/// # block_on(async {
/// # let client = matrix_sdk::Client::builder()
/// # .homeserver_url(homeserver)
/// # .server_versions([ruma::api::MatrixVersion::V1_0])
/// # .build()
/// # .await
/// # .unwrap();
///
/// client.add_event_handler(
/// |ev: SyncRoomMessageEvent, room: Room, client: Client| async move {
/// // Common usage: Room event plus room and client.
/// },
/// );
/// client.add_event_handler(
/// |ev: SyncRoomMessageEvent, room: Room, encryption_info: Option<EncryptionInfo>| {
/// async move {
/// // An `Option<EncryptionInfo>` parameter lets you distinguish between
/// // unencrypted events and events that were decrypted by the SDK.
/// }
/// },
/// );
/// client.add_event_handler(|ev: SyncRoomTopicEvent| async move {
/// // You can omit any or all arguments after the first.
/// });
///
/// // Registering a temporary event handler:
/// let handle = client.add_event_handler(|ev: SyncRoomMessageEvent| async move {
/// /* Event handler */
/// });
/// client.remove_event_handler(handle);
///
/// // Custom events work exactly the same way, you just need to declare
/// // the content struct and use the EventContent derive macro on it.
/// #[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,
/// }
///
/// client.add_event_handler(|ev: SyncTokenEvent, room: Room| async move {
/// todo!("Display the token");
/// });
///
/// // Adding your custom data to the handler can be done as well
/// let data = "MyCustomIdentifier".to_owned();
///
/// client.add_event_handler({
/// let data = data.clone();
/// move |ev: SyncRoomMessageEvent | {
/// let data = data.clone();
/// async move {
/// println!("Calling the handler with identifier {data}");
/// }
/// }
/// });
/// # });
/// ```
pub fn add_event_handler<Ev, Ctx, H>(&self, handler: H) -> EventHandlerHandle
where
Ev: SyncEvent + DeserializeOwned + Send + 'static,
H: EventHandler<Ev, Ctx>,
<H::Future as Future>::Output: EventHandlerResult,
{
self.add_event_handler_impl(handler, None)
}
/// Register a handler for a specific room, and event type.
///
/// This method works the same way as
/// [`add_event_handler`][Self::add_event_handler], except that the handler
/// will only be called for events in the room with the specified ID. See
/// that method for more details on event handler functions.
///
/// `client.add_room_event_handler(room_id, hdl)` is equivalent to
/// `room.add_event_handler(hdl)`. Use whichever one is more convenient in
/// your use case.
pub fn add_room_event_handler<Ev, Ctx, H>(
&self,
room_id: &RoomId,
handler: H,
) -> EventHandlerHandle
where
Ev: SyncEvent + DeserializeOwned + Send + 'static,
H: EventHandler<Ev, Ctx>,
<H::Future as Future>::Output: EventHandlerResult,
{
self.add_event_handler_impl(handler, Some(room_id.to_owned()))
}
#[allow(missing_docs)]
#[deprecated = "Use [`Client::add_event_handler`](#method.add_event_handler) instead"]
pub async fn register_event_handler<Ev, Ctx, H>(&self, handler: H) -> &Self
where
Ev: SyncEvent + DeserializeOwned + Send + 'static,
H: EventHandler<Ev, Ctx>,
<H::Future as Future>::Output: EventHandlerResult,
{
self.add_event_handler(handler);
self
}
/// Remove the event handler associated with the handle.
///
/// Note that you **must not** call `remove_event_handler` from the
/// non-async part of an event handler, that is:
///
/// ```ignore
/// client.add_event_handler(|ev: SomeEvent, client: Client, handle: EventHandlerHandle| {
/// // ⚠ this will cause a deadlock ⚠
/// client.remove_event_handler(handle);
///
/// async move {
/// // removing the event handler here is fine
/// client.remove_event_handler(handle);
/// }
/// })
/// ```
///
/// Note also that handlers that remove themselves will still execute with
/// events received in the same sync cycle.
///
/// # Arguments
///
/// `handle` - The [`EventHandlerHandle`] that is returned when
/// registering the event handler with [`Client::add_event_handler`].
///
/// # Examples
///
/// ```
/// # use futures::executor::block_on;
/// # use url::Url;
/// # use tokio::sync::mpsc;
/// #
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
/// #
/// use matrix_sdk::{
/// event_handler::EventHandlerHandle,
/// ruma::events::room::member::SyncRoomMemberEvent, Client,
/// };
/// #
/// # block_on(async {
/// # let client = matrix_sdk::Client::builder()
/// # .homeserver_url(homeserver)
/// # .server_versions([ruma::api::MatrixVersion::V1_0])
/// # .build()
/// # .await
/// # .unwrap();
///
/// client.add_event_handler(
/// |ev: SyncRoomMemberEvent,
/// client: Client,
/// handle: EventHandlerHandle| async move {
/// // Common usage: Check arriving Event is the expected one
/// println!("Expected RoomMemberEvent received!");
/// client.remove_event_handler(handle);
/// },
/// );
/// # });
/// ```
pub fn remove_event_handler(&self, handle: EventHandlerHandle) {
self.inner.event_handlers.remove(handle);
}
/// Create an [`EventHandlerDropGuard`] for the event handler identified by
/// the given handle.
///
/// When the returned value is dropped, the event handler will be removed.
pub fn event_handler_drop_guard(&self, handle: EventHandlerHandle) -> EventHandlerDropGuard {
EventHandlerDropGuard::new(handle, self.clone())
}
/// Add an arbitrary value for use as event handler context.
///
/// The value can be obtained in an event handler by adding an argument of
/// the type [`Ctx<T>`][crate::event_handler::Ctx].
///
/// If a value of the same type has been added before, it will be
/// overwritten.
///
/// # Example
///
/// ```
/// # use futures::executor::block_on;
/// use matrix_sdk::{
/// event_handler::Ctx, room::Room,
/// ruma::events::room::message::SyncRoomMessageEvent,
/// };
/// # #[derive(Clone)]
/// # struct SomeType;
/// # fn obtain_gui_handle() -> SomeType { SomeType }
/// # let homeserver = url::Url::parse("http://localhost:8080").unwrap();
/// # block_on(async {
/// # let client = matrix_sdk::Client::builder()
/// # .homeserver_url(homeserver)
/// # .server_versions([ruma::api::MatrixVersion::V1_0])
/// # .build()
/// # .await
/// # .unwrap();
///
/// // Handle used to send messages to the UI part of the app
/// let my_gui_handle: SomeType = obtain_gui_handle();
///
/// client.add_event_handler_context(my_gui_handle.clone());
/// client.add_event_handler(
/// |ev: SyncRoomMessageEvent, room: Room, gui_handle: Ctx<SomeType>| {
/// async move {
/// // gui_handle.send(DisplayMessage { message: ev });
/// }
/// },
/// );
/// # });
/// ```
pub fn add_event_handler_context<T>(&self, ctx: T)
where
T: Clone + Send + Sync + 'static,
{
self.inner.event_handlers.add_context(ctx);
}
#[allow(missing_docs)]
#[deprecated = "Use [`Client::add_event_handler_context`](#method.add_event_handler_context) instead"]
pub fn register_event_handler_context<T>(&self, ctx: T) -> &Self
where
T: Clone + Send + Sync + 'static,
{
self.add_event_handler_context(ctx);
self
}
/// Register a handler for a notification.
///
/// Similar to [`Client::add_event_handler`], but only allows functions
/// or closures with exactly the three arguments [`Notification`],
/// [`room::Room`], [`Client`] for now.
pub async fn register_notification_handler<H, Fut>(&self, handler: H) -> &Self
where
H: Fn(Notification, room::Room, Client) -> Fut
+ SendOutsideWasm
+ SyncOutsideWasm
+ 'static,
Fut: Future<Output = ()> + SendOutsideWasm + 'static,
{
self.inner.notification_handlers.write().await.push(Box::new(
move |notification, room, client| Box::pin((handler)(notification, room, client)),
));
self
}
pub(crate) async fn notification_handlers(
&self,
) -> RwLockReadGuard<'_, Vec<NotificationHandlerFn>> {
self.inner.notification_handlers.read().await
}
/// Get all the rooms the client knows about.
///
/// This will return the list of joined, invited, and left rooms.
pub fn rooms(&self) -> Vec<room::Room> {
self.base_client()
.get_rooms()
.into_iter()
.map(|room| room::Common::new(self.clone(), room).into())
.collect()
}
/// Returns the joined rooms this client knows about.
pub fn joined_rooms(&self) -> Vec<room::Joined> {
self.base_client()
.get_rooms()
.into_iter()
.filter_map(|room| room::Joined::new(self, room))
.collect()
}
/// Returns the invited rooms this client knows about.
pub fn invited_rooms(&self) -> Vec<room::Invited> {
self.base_client()
.get_stripped_rooms()
.into_iter()
.filter_map(|room| room::Invited::new(self, room))
.collect()
}
/// Returns the left rooms this client knows about.
pub fn left_rooms(&self) -> Vec<room::Left> {
self.base_client()
.get_rooms()
.into_iter()
.filter_map(|room| room::Left::new(self, room))
.collect()
}
/// Get a room with the given room id.
///
/// # Arguments
///
/// `room_id` - The unique id of the room that should be fetched.
pub fn get_room(&self, room_id: &RoomId) -> Option<room::Room> {
self.base_client()
.get_room(room_id)
.map(|room| room::Common::new(self.clone(), room).into())
}
/// Get a joined room with the given room id.
///
/// # Arguments
///
/// `room_id` - The unique id of the room that should be fetched.
pub fn get_joined_room(&self, room_id: &RoomId) -> Option<room::Joined> {
self.base_client().get_room(room_id).and_then(|room| room::Joined::new(self, room))
}
/// Get an invited room with the given room id.
///
/// # Arguments
///
/// `room_id` - The unique id of the room that should be fetched.
pub fn get_invited_room(&self, room_id: &RoomId) -> Option<room::Invited> {
self.base_client().get_room(room_id).and_then(|room| room::Invited::new(self, room))
}
/// Get a left room with the given room id.
///
/// # Arguments
///
/// `room_id` - The unique id of the room that should be fetched.
pub fn get_left_room(&self, room_id: &RoomId) -> Option<room::Left> {
self.base_client().get_room(room_id).and_then(|room| room::Left::new(self, room))
}
/// Resolve a room alias to a room id and a list of servers which know
/// about it.
///
/// # Arguments
///
/// `room_alias` - The room alias to be resolved.
pub async fn resolve_room_alias(
&self,
room_alias: &RoomAliasId,
) -> HttpResult<get_alias::v3::Response> {
let request = get_alias::v3::Request::new(room_alias);
self.send(request, None).await
}
/// Gets the homeserver’s supported login types.
///
/// This should be the first step when trying to login so you can call the
/// appropriate method for the next step.
pub async fn get_login_types(&self) -> HttpResult<get_login_types::v3::Response> {
let request = get_login_types::v3::Request::new();
self.send(request, None).await
}
/// Get the URL to use to login via Single Sign-On.
///
/// Returns a URL that should be opened in a web browser to let the user
/// login.
///
/// After a successful login, the loginToken received at the redirect URL
/// should be used to login with [`login_with_token`].
///
/// # Arguments
///
/// * `redirect_url` - The URL that will receive a `loginToken` after a
/// successful SSO login.
///
/// * `idp_id` - The optional ID of the identity provider to login with.
///
/// [`login_with_token`]: #method.login_with_token
pub async fn get_sso_login_url(
&self,
redirect_url: &str,
idp_id: Option<&str>,
) -> Result<String> {
let homeserver = self.homeserver().await;
let server_versions = self.server_versions().await?;
let request = if let Some(id) = idp_id {
sso_login_with_provider::v3::Request::new(id, redirect_url)
.try_into_http_request::<Vec<u8>>(
homeserver.as_str(),
SendAccessToken::None,
server_versions,
)
} else {
sso_login::v3::Request::new(redirect_url).try_into_http_request::<Vec<u8>>(
homeserver.as_str(),
SendAccessToken::None,
server_versions,
)
};
match request {
Ok(req) => Ok(req.uri().to_string()),
Err(err) => Err(Error::from(HttpError::from(err))),
}
}
/// Login to the server with a username and password.
///
/// This can be used for the first login as well as for subsequent logins,
/// note that if the device ID isn't provided a new device will be created.
///
/// If this isn't the first login, a device ID should be provided through
/// [`LoginBuilder::device_id`] to restore the correct stores.
///
/// Alternatively the [`restore_login`] method can be used to restore a
/// logged-in client without the password.
///
/// # Arguments
///
/// * `user` - The user ID or user ID localpart of the user that should be
/// logged into the homeserver.
///
/// * `password` - The password of the user.
///
/// # Example
///
/// ```no_run
/// # use futures::executor::block_on;
/// # use url::Url;
/// # let homeserver = Url::parse("http://example.com").unwrap();
/// # block_on(async {
/// use matrix_sdk::Client;
///
/// let client = Client::new(homeserver).await?;
/// let user = "example";
///
/// let response = client
/// .login_username(user, "wordpass")
/// .initial_device_display_name("My bot")
/// .send()
/// .await?;
///
/// println!(
/// "Logged in as {user}, got device_id {} and access_token {}",
/// response.device_id, response.access_token,
/// );
/// # anyhow::Ok(()) });
/// ```
///
/// [`restore_login`]: #method.restore_login
pub fn login_username<'a>(
&self,
id: &'a (impl AsRef<str> + ?Sized),
password: &'a str,
) -> LoginBuilder<'a> {
self.login_identifier(UserIdentifier::UserIdOrLocalpart(id.as_ref()), password)
}
/// Login to the server with a user identifier and password.
///
/// This is more general form of [`login_username`][Self::login_username]
/// that also accepts third-party identifiers instead of just the user ID or
/// its localpart.
pub fn login_identifier<'a>(
&self,
id: UserIdentifier<'a>,
password: &'a str,
) -> LoginBuilder<'a> {
LoginBuilder::new_password(self.clone(), id, password)
}
/// Login to the server with a token.
///
/// This token is usually received in the SSO flow after following the URL
/// provided by [`get_sso_login_url`], note that this is not the access
/// token of a session.
///
/// This should only be used for the first login.
///
/// The [`restore_login`] method should be used to restore a logged-in
/// client after the first login.
///
/// A device ID should be provided through [`LoginBuilder::device_id`] to
/// restore the correct stores, if the device ID isn't provided a new
/// device will be created.
///
/// # Arguments
///
/// * `token` - A login token.
///
/// # Example
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use matrix_sdk::ruma::{assign, DeviceId};
/// # use futures::executor::block_on;
/// # use url::Url;
/// # let homeserver = Url::parse("https://example.com").unwrap();
/// # let redirect_url = "http://localhost:1234";
/// # let login_token = "token";
/// # block_on(async {
/// let client = Client::new(homeserver).await.unwrap();
/// let sso_url = client.get_sso_login_url(redirect_url, None);
///
/// // Let the user authenticate at the SSO URL
/// // Receive the loginToken param at redirect_url
///
/// let response = client
/// .login_token(login_token)
/// .initial_device_display_name("My app")
/// .send()
/// .await
/// .unwrap();
///
/// println!(
/// "Logged in as {}, got device_id {} and access_token {}",
/// response.user_id, response.device_id, response.access_token,
/// );
/// # })
/// ```
///
/// [`get_sso_login_url`]: #method.get_sso_login_url
/// [`restore_login`]: #method.restore_login
pub fn login_token<'a>(&self, token: &'a str) -> LoginBuilder<'a> {
LoginBuilder::new_token(self.clone(), token)
}
/// Login to the server via Single Sign-On.
///
/// This takes care of the whole SSO flow:
/// * Spawn a local http server
/// * Provide a callback to open the SSO login URL in a web browser
/// * Wait for the local http server to get the loginToken
/// * Call [`login_token`]
///
/// If cancellation is needed the method should be wrapped in a cancellable
/// task. **Note** that users with root access to the system have the
/// ability to snoop in on the data/token that is passed to the local
/// HTTP server that will be spawned.
///
/// If you need more control over the SSO login process, you should use
/// [`get_sso_login_url`] and [`login_token`] directly.
///
/// This should only be used for the first login.
///
/// The [`restore_login`] method should be used to restore a logged-in
/// client after the first login.
///
/// # Arguments
///
/// * `use_sso_login_url` - A callback that will receive the SSO Login URL.
/// It should usually be used to open the SSO URL in a browser and must
/// return `Ok(())` if the URL was successfully opened. If it returns
/// `Err`, the error will be forwarded.
///
/// # Example
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use futures::executor::block_on;
/// # use url::Url;
/// # let homeserver = Url::parse("https://example.com").unwrap();
/// # block_on(async {
/// let client = Client::new(homeserver).await.unwrap();
///
/// let response = client
/// .login_sso(|sso_url| async move {
/// // Open sso_url
/// Ok(())
/// })
/// .initial_device_display_name("My app")
/// .send()
/// .await
/// .unwrap();
///
/// println!(
/// "Logged in as {}, got device_id {} and access_token {}",
/// response.user_id, response.device_id, response.access_token
/// );
/// # })
/// ```
///
/// [`get_sso_login_url`]: #method.get_sso_login_url
/// [`login_token`]: #method.login_token
/// [`restore_login`]: #method.restore_login
#[cfg(feature = "sso-login")]
pub fn login_sso<'a, F, Fut>(&self, use_sso_login_url: F) -> SsoLoginBuilder<'a, F>
where
F: FnOnce(String) -> Fut + Send,
Fut: Future<Output = Result<()>> + Send,
{
SsoLoginBuilder::new(self.clone(), use_sso_login_url)
}
/// Login to the server with a username and password.
#[deprecated = "Replaced by [`Client::login_username`](#method.login_username)"]
#[instrument(skip(self, user, password))]
pub async fn login(
&self,
user: impl AsRef<str>,
password: &str,
device_id: Option<&str>,
initial_device_display_name: Option<&str>,
) -> Result<login::v3::Response> {
let mut builder = self.login_username(&user, password);
if let Some(value) = device_id {
builder = builder.device_id(value);
}
if let Some(value) = initial_device_display_name {
builder = builder.initial_device_display_name(value);
}
builder.send().await
}
/// Login to the server via Single Sign-On.
#[deprecated = "Replaced by [`Client::login_sso`](#method.login_sso)"]
#[cfg(feature = "sso-login")]
#[deny(clippy::future_not_send)]
pub async fn login_with_sso<C>(
&self,
use_sso_login_url: impl FnOnce(String) -> C + Send,
server_url: Option<&str>,
server_response: Option<&str>,
device_id: Option<&str>,
initial_device_display_name: Option<&str>,
idp_id: Option<&str>,
) -> Result<login::v3::Response>
where
C: Future<Output = Result<()>> + Send,
{
let mut builder = self.login_sso(use_sso_login_url);
if let Some(value) = server_url {
builder = builder.server_url(value);
}
if let Some(value) = server_response {
builder = builder.server_response(value);
}
if let Some(value) = device_id {
builder = builder.device_id(value);
}
if let Some(value) = initial_device_display_name {
builder = builder.initial_device_display_name(value);
}
if let Some(value) = idp_id {
builder = builder.identity_provider_id(value);
}
builder.send().await
}
/// Login to the server with a token.
#[deprecated = "Replaced by [`Client::login_token`](#method.login_token)"]
#[instrument(skip(self, token))]
#[cfg_attr(not(target_arch = "wasm32"), deny(clippy::future_not_send))]
pub async fn login_with_token(
&self,
token: &str,
device_id: Option<&str>,
initial_device_display_name: Option<&str>,
) -> Result<login::v3::Response> {
let mut builder = self.login_token(token);
if let Some(value) = device_id {
builder = builder.device_id(value);
}
if let Some(value) = initial_device_display_name {
builder = builder.initial_device_display_name(value);
}
builder.send().await
}
/// Receive a login response and update the homeserver and the base client
/// if needed.
///
/// # Arguments
///
/// * `response` - A successful login response.
async fn receive_login_response(&self, response: &login::v3::Response) -> Result<()> {
if self.inner.respect_login_well_known {
if let Some(well_known) = &response.well_known {
if let Ok(homeserver) = Url::parse(&well_known.homeserver.base_url) {
self.set_homeserver(homeserver).await;
}
}
}
self.inner.base_client.receive_login_response(response).await?;
Ok(())
}
/// Restore a previously logged in session.
///
/// This can be used to restore the client to a logged in state, loading all
/// the stored state and encryption keys.
///
/// Alternatively, if the whole session isn't stored the [`login`] method
/// can be used with a device ID.
///
/// # Arguments
///
/// * `session` - A session that the user already has from a
/// previous login call.
///
/// # Examples
///
/// ```no_run
/// use matrix_sdk::{
/// ruma::{device_id, user_id},
/// Client, Session,
/// };
/// # use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
///
/// let homeserver = Url::parse("http://example.com")?;
/// let client = Client::new(homeserver).await?;
///
/// let session = Session {
/// access_token: "My-Token".to_owned(),
/// refresh_token: None,
/// user_id: user_id!("@example:localhost").to_owned(),
/// device_id: device_id!("MYDEVICEID").to_owned(),
/// };
///
/// client.restore_login(session).await?;
/// # anyhow::Ok(()) });
/// ```
///
/// The `Session` object can also be created from the response the
/// [`Client::login()`] method returns:
///
/// ```no_run
/// use matrix_sdk::{Client, Session};
/// # use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
///
/// let homeserver = Url::parse("http://example.com")?;
/// let client = Client::new(homeserver).await?;
///
/// let session: Session =
/// client.login("example", "my-password", None, None).await?.into();
///
/// // Persist the `Session` so it can later be used to restore the login.
/// client.restore_login(session).await?;
/// # anyhow::Ok(()) });
/// ```
///
/// [`login`]: #method.login
pub async fn restore_login(&self, session: Session) -> Result<()> {
Ok(self.inner.base_client.restore_login(session).await?)
}
/// Refresh the access token.
///
/// When support for [refreshing access tokens] is activated on both the
/// homeserver and the client, access tokens have an expiration date and
/// need to be refreshed periodically. To activate support for refresh
/// tokens in the [`Client`], it needs to be done at login with the
/// [`LoginBuilder::request_refresh_token()`] method, or during account
/// registration.
///
/// This method doesn't need to be called if
/// [`ClientBuilder::handle_refresh_tokens()`] is called during construction
/// of the `Client`. Otherwise, it should be called once when a refresh
/// token is available and an [`UnknownToken`] error is received.
/// If this call fails with another [`UnknownToken`] error, it means that
/// the session needs to be logged in again.
///
/// It can also be called at any time when a refresh token is available, it
/// will invalidate the previous access token.
///
/// The new tokens in the response will be used by the `Client` and should
/// be persisted to be able to [restore the session]. The response will
/// always contain an access token that replaces the previous one. It
/// can also contain a refresh token, in which case it will also replace
/// the previous one.
///
/// This method is protected behind a lock, so calling this method several
/// times at once will only call the endpoint once and all subsequent calls
/// will wait for the result of the first call. The first call will
/// return `Ok(Some(response))` or the [`HttpError`] returned by the
/// endpoint, while the others will return `Ok(None)` if the token was
/// refreshed by the first call or a [`RefreshTokenError`] error, if it
/// failed.
///
/// # Example
///
/// ```no_run
/// use matrix_sdk::{Client, Error, Session};
/// use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # fn get_credentials() -> (&'static str, &'static str) { ("", "") };
/// # fn persist_session(_: Option<Session>) {};
///
/// let homeserver = Url::parse("http://example.com")?;
/// let client = Client::new(homeserver).await?;
///
/// let (user, password) = get_credentials();
/// let response = client
/// .login_username(user, password)
/// .initial_device_display_name("My App")
/// .request_refresh_token()
/// .send()
/// .await?;
///
/// persist_session(client.session());
///
/// // Handle when an `M_UNKNOWN_TOKEN` error is encountered.
/// async fn on_unknown_token_err(client: &Client) -> Result<(), Error> {
/// if client.refresh_token().is_some()
/// && client.refresh_access_token().await.is_ok()
/// {
/// persist_session(client.session());
/// return Ok(());
/// }
///
/// let (user, password) = get_credentials();
/// client
/// .login_username(user, password)
/// .request_refresh_token()
/// .send()
/// .await?;
///
/// persist_session(client.session());
///
/// Ok(())
/// }
///
/// # anyhow::Ok(()) });
/// ```
///
/// [refreshing access tokens]: https://spec.matrix.org/v1.3/client-server-api/#refreshing-access-tokens
/// [`UnknownToken`]: ruma::api::client::error::ErrorKind::UnknownToken
/// [restore the session]: Client::restore_login
pub async fn refresh_access_token(&self) -> HttpResult<Option<refresh_token::v3::Response>> {
#[cfg(not(target_arch = "wasm32"))]
let lock = self.inner.refresh_token_lock.try_lock().ok();
#[cfg(target_arch = "wasm32")]
let lock = self.inner.refresh_token_lock.try_lock();
if let Some(mut guard) = lock {
let mut session_tokens = if let Some(tokens) = self.session_tokens() {
tokens
} else {
*guard = Err(RefreshTokenError::RefreshTokenRequired);
return Err(RefreshTokenError::RefreshTokenRequired.into());
};
let refresh_token = session_tokens
.refresh_token
.as_ref()
.ok_or(RefreshTokenError::RefreshTokenRequired)?
.clone();
let request = refresh_token::v3::Request::new(&refresh_token);
let res = self
.inner
.http_client
.send(
request,
None,
self.homeserver().await.to_string(),
self.access_token().as_deref(),
self.user_id(),
self.server_versions().await?,
)
.await;
match res {
Ok(res) => {
*guard = Ok(());
session_tokens.update_with_refresh_response(&res);
self.base_client().set_session_tokens(session_tokens);
// TODO: Let ffi client to know that tokens have changed
Ok(Some(res))
}
Err(error) => {
*guard = if let HttpError::Api(FromHttpResponseError::Server(
ServerError::Known(RumaApiError::ClientApi(api_error)),
)) = &error
{
Err(RefreshTokenError::ClientApi(api_error.to_owned()))
} else {
Err(RefreshTokenError::UnableToRefreshToken)
};
Err(error)
}
}
} else {
match *self.inner.refresh_token_lock.lock().await {
Ok(_) => Ok(None),
Err(_) => Err(RefreshTokenError::UnableToRefreshToken.into()),
}
}
}
/// Register a user to the server.
///
/// # Arguments
///
/// * `registration` - The easiest way to create this request is using the
/// [`register::v3::Request`] itself.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::Client;
/// # use matrix_sdk::ruma::{
/// # api::client::{
/// # account::register::{v3::Request as RegistrationRequest, RegistrationKind},
/// # uiaa,
/// # },
/// # DeviceId,
/// # };
/// # use futures::executor::block_on;
/// # use url::Url;
/// # let homeserver = Url::parse("http://example.com").unwrap();
/// # block_on(async {
///
/// let mut request = RegistrationRequest::new();
/// request.username = Some("user");
/// request.password = Some("password");
/// request.auth = Some(uiaa::AuthData::FallbackAcknowledgement(
/// uiaa::FallbackAcknowledgement::new("foobar"),
/// ));
///
/// let client = Client::new(homeserver).await.unwrap();
/// client.register(request).await;
/// # })
/// ```
#[instrument(skip_all)]
pub async fn register(
&self,
registration: impl Into<register::v3::Request<'_>>,
) -> HttpResult<register::v3::Response> {
let homeserver = self.homeserver().await;
info!("Registering to {homeserver}");
let config = if self.inner.appservice_mode {
Some(RequestConfig::short_retry().force_auth())
} else {
None
};
let request = registration.into();
self.send(request, config).await
}
/// Get or upload a sync filter.
///
/// This method will either get a filter ID from the store or upload the
/// filter definition to the homeserver and return the new filter ID.
///
/// # Arguments
///
/// * `filter_name` - The unique name of the filter, this name will be used
/// locally to store and identify the filter ID returned by the server.
///
/// * `definition` - The filter definition that should be uploaded to the
/// server if no filter ID can be found in the store.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{
/// # Client, config::SyncSettings,
/// # ruma::api::client::{
/// # filter::{
/// # FilterDefinition, LazyLoadOptions, RoomEventFilter, RoomFilter,
/// # },
/// # sync::sync_events::v3::Filter,
/// # }
/// # };
/// # use futures::executor::block_on;
/// # use url::Url;
/// # block_on(async {
/// # let homeserver = Url::parse("http://example.com").unwrap();
/// # let client = Client::new(homeserver).await.unwrap();
/// let mut filter = FilterDefinition::default();
///
/// // Let's enable member lazy loading.
/// filter.room.state.lazy_load_options =
/// LazyLoadOptions::Enabled { include_redundant_members: false };
///
/// let filter_id = client
/// .get_or_upload_filter("sync", filter)
/// .await
/// .unwrap();
///
/// let sync_settings = SyncSettings::new()
/// .filter(Filter::FilterId(&filter_id));
///
/// let response = client.sync_once(sync_settings).await.unwrap();
/// # });
#[instrument(skip(self, definition))]
pub async fn get_or_upload_filter(
&self,
filter_name: &str,
definition: FilterDefinition<'_>,
) -> Result<String> {
if let Some(filter) = self.inner.base_client.get_filter(filter_name).await? {
debug!("Found filter locally");
Ok(filter)
} else {
debug!("Didn't find filter locally");
let user_id = self.user_id().ok_or(Error::AuthenticationRequired)?;
let request = FilterUploadRequest::new(user_id, definition);
let response = self.send(request, None).await?;
self.inner.base_client.receive_filter_upload(filter_name, &response).await?;
Ok(response.filter_id)
}
}
/// Join a room by `RoomId`.
///
/// Returns a `join_room_by_id::Response` consisting of the
/// joined rooms `RoomId`.
///
/// # Arguments
///
/// * `room_id` - The `RoomId` of the room to be joined.
pub async fn join_room_by_id(
&self,
room_id: &RoomId,
) -> HttpResult<join_room_by_id::v3::Response> {
let request = join_room_by_id::v3::Request::new(room_id);
self.send(request, None).await
}
/// Join a room by `RoomId`.
///
/// Returns a `join_room_by_id_or_alias::Response` consisting of the
/// joined rooms `RoomId`.
///
/// # Arguments
///
/// * `alias` - The `RoomId` or `RoomAliasId` of the room to be joined.
/// An alias looks like `#name:example.com`.
pub async fn join_room_by_id_or_alias(
&self,
alias: &RoomOrAliasId,
server_names: &[OwnedServerName],
) -> HttpResult<join_room_by_id_or_alias::v3::Response> {
let request = assign!(join_room_by_id_or_alias::v3::Request::new(alias), {
server_name: server_names,
});
self.send(request, None).await
}
/// Search the homeserver's directory of public rooms.
///
/// Sends a request to "_matrix/client/r0/publicRooms", returns
/// a `get_public_rooms::Response`.
///
/// # Arguments
///
/// * `limit` - The number of `PublicRoomsChunk`s in each response.
///
/// * `since` - Pagination token from a previous request.
///
/// * `server` - The name of the server, if `None` the requested server is
/// used.
///
/// # Examples
/// ```no_run
/// use matrix_sdk::Client;
/// # use url::Url;
/// # let homeserver = Url::parse("http://example.com").unwrap();
/// # let limit = Some(10);
/// # let since = Some("since token");
/// # let server = Some("servername.com".try_into().unwrap());
/// # use futures::executor::block_on;
/// # block_on(async {
///
/// let mut client = Client::new(homeserver).await.unwrap();
///
/// client.public_rooms(limit, since, server).await;
/// # });
/// ```
#[cfg_attr(not(target_arch = "wasm32"), deny(clippy::future_not_send))]
pub async fn public_rooms(
&self,
limit: Option<u32>,
since: Option<&str>,
server: Option<&ServerName>,
) -> HttpResult<get_public_rooms::v3::Response> {
let limit = limit.map(UInt::from);
let request = assign!(get_public_rooms::v3::Request::new(), {
limit,
since,
server,
});
self.send(request, None).await
}
/// Create a room using the `RoomBuilder` and send the request.
///
/// Sends a request to `/_matrix/client/r0/createRoom`, returns a
/// `create_room::Response`, this is an empty response.
///
/// # Arguments
///
/// * `room` - The easiest way to create this request is using the
/// `create_room::Request` itself.
///
/// # Examples
/// ```no_run
/// use matrix_sdk::Client;
/// # use matrix_sdk::ruma::api::client::room::{
/// # create_room::v3::Request as CreateRoomRequest,
/// # Visibility,
/// # };
/// # use url::Url;
///
/// # use futures::executor::block_on;
/// # block_on(async {
/// # let homeserver = Url::parse("http://example.com").unwrap();
/// let request = CreateRoomRequest::new();
/// let client = Client::new(homeserver).await.unwrap();
/// assert!(client.create_room(request).await.is_ok());
/// # });
/// ```
pub async fn create_room(
&self,
room: impl Into<create_room::v3::Request<'_>>,
) -> HttpResult<create_room::v3::Response> {
let request = room.into();
self.send(request, None).await
}
/// Search the homeserver's directory for public rooms with a filter.
///
/// # Arguments
///
/// * `room_search` - The easiest way to create this request is using the
/// `get_public_rooms_filtered::Request` itself.
///
/// # Examples
///
/// ```no_run
/// # use url::Url;
/// # use matrix_sdk::Client;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # let homeserver = Url::parse("http://example.com")?;
/// use matrix_sdk::ruma::{
/// api::client::directory::get_public_rooms_filtered, directory::Filter,
/// };
/// # let mut client = Client::new(homeserver).await?;
///
/// let mut filter = Filter::new();
/// filter.generic_search_term = Some("rust");
/// let mut request = get_public_rooms_filtered::v3::Request::new();
/// request.filter = filter;
///
/// let response = client.public_rooms_filtered(request).await?;
///
/// for room in response.chunk {
/// println!("Found room {:?}", room);
/// }
/// # anyhow::Ok(()) });
/// ```
pub async fn public_rooms_filtered(
&self,
room_search: impl Into<get_public_rooms_filtered::v3::Request<'_>>,
) -> HttpResult<get_public_rooms_filtered::v3::Response> {
let request = room_search.into();
self.send(request, None).await
}
/// Send an arbitrary request to the server, without updating client state.
///
/// **Warning:** Because this method *does not* update the client state, it
/// is important to make sure that you account for this yourself, and
/// use wrapper methods where available. This method should *only* be
/// used if a wrapper method for the endpoint you'd like to use is not
/// available.
///
/// # Arguments
///
/// * `request` - A filled out and valid request for the endpoint to be hit
///
/// * `timeout` - An optional request timeout setting, this overrides the
/// default request setting if one was set.
///
/// # Example
///
/// ```no_run
/// # use matrix_sdk::{Client, config::SyncSettings};
/// # use futures::executor::block_on;
/// # use url::Url;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// use matrix_sdk::ruma::{api::client::profile, user_id};
///
/// // First construct the request you want to make
/// // See https://docs.rs/ruma-client-api/latest/ruma_client_api/index.html
/// // for all available Endpoints
/// let user_id = user_id!("@example:localhost");
/// let request = profile::get_profile::v3::Request::new(&user_id);
///
/// // Start the request using Client::send()
/// let response = client.send(request, None).await?;
///
/// // Check the corresponding Response struct to find out what types are
/// // returned
/// # anyhow::Ok(()) });
/// ```
pub async fn send<Request>(
&self,
request: Request,
config: Option<RequestConfig>,
) -> HttpResult<Request::IncomingResponse>
where
Request: OutgoingRequest + Clone + Debug,
HttpError: From<FromHttpResponseError<Request::EndpointError>>,
{
let res = self.send_inner(request.clone(), config, None).await;
// If this is an `M_UNKNOWN_TOKEN` error and refresh token handling is active,
// try to refresh the token and retry the request.
if self.inner.handle_refresh_tokens {
if let Err(HttpError::Api(FromHttpResponseError::Server(ServerError::Known(
RumaApiError::ClientApi(error),
)))) = &res
{
if matches!(error.kind, ErrorKind::UnknownToken { .. }) {
let refresh_res = self.refresh_access_token().await;
if let Err(refresh_error) = refresh_res {
match &refresh_error {
HttpError::RefreshToken(RefreshTokenError::RefreshTokenRequired) => {
// Refreshing access tokens is not supported by
// this `Session`, ignore.
}
_ => {
return Err(refresh_error);
}
}
} else {
return self.send_inner(request, config, None).await;
}
}
}
}
res
}
#[cfg(feature = "sliding-sync")]
// FIXME: remove this as soon as Sliding-Sync isn't needing an external server
// anymore
pub(crate) async fn send_with_homeserver<Request>(
&self,
request: Request,
config: Option<RequestConfig>,
homeserver: Option<String>,
) -> HttpResult<Request::IncomingResponse>
where
Request: OutgoingRequest + Clone + Debug,
HttpError: From<FromHttpResponseError<Request::EndpointError>>,
{
let res = self.send_inner(request.clone(), config, homeserver.clone()).await;
// If this is an `M_UNKNOWN_TOKEN` error and refresh token handling is active,
// try to refresh the token and retry the request.
if self.inner.handle_refresh_tokens {
if let Err(HttpError::Api(FromHttpResponseError::Server(ServerError::Known(
RumaApiError::ClientApi(error),
)))) = &res
{
if matches!(error.kind, ErrorKind::UnknownToken { .. }) {
let refresh_res = self.refresh_access_token().await;
if let Err(refresh_error) = refresh_res {
match &refresh_error {
HttpError::RefreshToken(RefreshTokenError::RefreshTokenRequired) => {
// Refreshing access tokens is not supported by
// this `Session`, ignore.
}
_ => {
return Err(refresh_error);
}
}
} else {
return self.send_inner(request, config, homeserver).await;
}
}
}
}
res
}
#[tracing::instrument(skip(self))]
async fn send_inner<Request>(
&self,
request: Request,
config: Option<RequestConfig>,
homeserver: Option<String>,
) -> HttpResult<Request::IncomingResponse>
where
Request: OutgoingRequest + Debug,
HttpError: From<FromHttpResponseError<Request::EndpointError>>,
{
let homeserver =
if let Some(h) = homeserver { h } else { self.homeserver().await.to_string() };
self.inner
.http_client
.send(
request,
config,
homeserver,
self.access_token().as_deref(),
self.user_id(),
self.server_versions().await?,
)
.await
}
async fn request_server_versions(&self) -> HttpResult<Box<[MatrixVersion]>> {
let server_versions: Box<[MatrixVersion]> = self
.inner
.http_client
.send(
get_supported_versions::Request::new(),
None,
self.homeserver().await.to_string(),
None,
None,
&[MatrixVersion::V1_0],
)
.await?
.known_versions()
.into_iter()
.collect();
if server_versions.is_empty() {
Ok(vec![MatrixVersion::V1_0].into())
} else {
Ok(server_versions)
}
}
pub(crate) async fn server_versions(&self) -> HttpResult<&[MatrixVersion]> {
#[cfg(target_arch = "wasm32")]
let server_versions =
self.inner.server_versions.get_or_try_init(self.request_server_versions()).await?;
#[cfg(not(target_arch = "wasm32"))]
let server_versions =
self.inner.server_versions.get_or_try_init(|| self.request_server_versions()).await?;
Ok(server_versions)
}
/// Get information of all our own devices.
///
/// # Examples
///
/// ```no_run
/// # use matrix_sdk::{Client, config::SyncSettings};
/// # use futures::executor::block_on;
/// # use url::Url;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// let response = client.devices().await?;
///
/// for device in response.devices {
/// println!(
/// "Device: {} {}",
/// device.device_id,
/// device.display_name.as_deref().unwrap_or("")
/// );
/// }
/// # anyhow::Ok(()) });
/// ```
pub async fn devices(&self) -> HttpResult<get_devices::v3::Response> {
let request = get_devices::v3::Request::new();
self.send(request, None).await
}
/// Delete the given devices from the server.
///
/// # Arguments
///
/// * `devices` - The list of devices that should be deleted from the
/// server.
///
/// * `auth_data` - This request requires user interactive auth, the first
/// request needs to set this to `None` and will always fail with an
/// `UiaaResponse`. The response will contain information for the
/// interactive auth and the same request needs to be made but this time
/// with some `auth_data` provided.
///
/// ```no_run
/// # use matrix_sdk::{
/// # ruma::{
/// # api::{
/// # client::uiaa,
/// # error::{FromHttpResponseError, ServerError},
/// # },
/// # device_id,
/// # },
/// # Client, Error, config::SyncSettings,
/// # };
/// # use futures::executor::block_on;
/// # use serde_json::json;
/// # use url::Url;
/// # use std::collections::BTreeMap;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let mut client = Client::new(homeserver).await?;
/// let devices = &[device_id!("DEVICEID").to_owned()];
///
/// if let Err(e) = client.delete_devices(devices, None).await {
/// if let Some(info) = e.uiaa_response() {
/// let mut password = uiaa::Password::new(
/// uiaa::UserIdentifier::UserIdOrLocalpart("example"),
/// "wordpass",
/// );
/// password.session = info.session.as_deref();
///
/// client
/// .delete_devices(devices, Some(uiaa::AuthData::Password(password)))
/// .await?;
/// }
/// }
/// # anyhow::Ok(()) });
pub async fn delete_devices(
&self,
devices: &[OwnedDeviceId],
auth_data: Option<AuthData<'_>>,
) -> HttpResult<delete_devices::v3::Response> {
let mut request = delete_devices::v3::Request::new(devices);
request.auth = auth_data;
self.send(request, None).await
}
/// Synchronize the client's state with the latest state on the server.
///
/// ## Syncing Events
///
/// Messages or any other type of event need to be periodically fetched from
/// the server, this is achieved by sending a `/sync` request to the server.
///
/// The first sync is sent out without a [`token`]. The response of the
/// first sync will contain a [`next_batch`] field which should then be
/// used in the subsequent sync calls as the [`token`]. This ensures that we
/// don't receive the same events multiple times.
///
/// ## Long Polling
///
/// A sync should in the usual case always be in flight. The
/// [`SyncSettings`] have a [`timeout`] option, which controls how
/// long the server will wait for new events before it will respond.
/// The server will respond immediately if some new events arrive before the
/// timeout has expired. If no changes arrive and the timeout expires an
/// empty sync response will be sent to the client.
///
/// This method of sending a request that may not receive a response
/// immediately is called long polling.
///
/// ## Filtering Events
///
/// The number or type of messages and events that the client should receive
/// from the server can be altered using a [`Filter`].
///
/// Filters can be non-trivial and, since they will be sent with every sync
/// request, they may take up a bunch of unnecessary bandwidth.
///
/// Luckily filters can be uploaded to the server and reused using an unique
/// identifier, this can be achieved using the [`get_or_upload_filter()`]
/// method.
///
/// # Arguments
///
/// * `sync_settings` - Settings for the sync call, this allows us to set
/// various options to configure the sync:
/// * [`filter`] - To configure which events we receive and which get
/// [filtered] by the server
/// * [`timeout`] - To configure our [long polling] setup.
/// * [`token`] - To tell the server which events we already received
/// and where we wish to continue syncing.
/// * [`full_state`] - To tell the server that we wish to receive all
/// state events, regardless of our configured [`token`].
///
/// # Examples
///
/// ```no_run
/// # use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let username = "";
/// # let password = "";
/// use matrix_sdk::{
/// config::SyncSettings,
/// ruma::events::room::message::OriginalSyncRoomMessageEvent, Client,
/// };
///
/// let client = Client::new(homeserver).await?;
/// client.login_username(username, password).send().await?;
///
/// // Sync once so we receive the client state and old messages.
/// client.sync_once(SyncSettings::default()).await?;
///
/// // Register our handler so we start responding once we receive a new
/// // event.
/// client.add_event_handler(|ev: OriginalSyncRoomMessageEvent| async move {
/// println!("Received event {}: {:?}", ev.sender, ev.content);
/// });
///
/// // Now keep on syncing forever. `sync()` will use the stored sync token
/// // from our `sync_once()` call automatically.
/// client.sync(SyncSettings::default()).await;
/// # anyhow::Ok(()) });
/// ```
///
/// [`sync`]: #method.sync
/// [`SyncSettings`]: crate::config::SyncSettings
/// [`token`]: crate::config::SyncSettings#method.token
/// [`timeout`]: crate::config::SyncSettings#method.timeout
/// [`full_state`]: crate::config::SyncSettings#method.full_state
/// [`filter`]: crate::config::SyncSettings#method.filter
/// [`Filter`]: ruma::api::client::sync::sync_events::v3::Filter
/// [`next_batch`]: SyncResponse#structfield.next_batch
/// [`get_or_upload_filter()`]: #method.get_or_upload_filter
/// [long polling]: #long-polling
/// [filtered]: #filtering-events
#[instrument(skip(self))]
pub async fn sync_once(
&self,
sync_settings: crate::config::SyncSettings<'_>,
) -> Result<SyncResponse> {
// The sync might not return for quite a while due to the timeout.
// We'll see if there's anything crypto related to send out before we
// sync, i.e. if we closed our client after a sync but before the
// crypto requests were sent out.
//
// This will mostly be a no-op.
#[cfg(feature = "e2e-encryption")]
if let Err(e) = self.send_outgoing_requests().await {
error!(error = ?e, "Error while sending outgoing E2EE requests");
}
let request = assign!(sync_events::v3::Request::new(), {
filter: sync_settings.filter.as_ref(),
since: sync_settings.token.as_deref(),
full_state: sync_settings.full_state,
set_presence: &PresenceState::Online,
timeout: sync_settings.timeout,
});
let mut request_config = self.request_config();
if let Some(timeout) = sync_settings.timeout {
request_config.timeout += timeout;
}
let response = self.send(request, Some(request_config)).await?;
let response = self.process_sync(response).await?;
#[cfg(feature = "e2e-encryption")]
if let Err(e) = self.send_outgoing_requests().await {
error!(error = ?e, "Error while sending outgoing E2EE requests");
}
self.inner.sync_beat.notify(usize::MAX);
Ok(response)
}
/// Repeatedly synchronize the client state with the server.
///
/// This method will only return on error, if cancellation is needed
/// the method should be wrapped in a cancelable task or the
/// [`Client::sync_with_callback`] method can be used or
/// [`Client::sync_with_result_callback`] if you want to handle error
/// cases in the loop, too.
///
/// This method will internally call [`Client::sync_once`] in a loop.
///
/// This method can be used with the [`Client::add_event_handler`]
/// method to react to individual events. If you instead wish to handle
/// events in a bulk manner the [`Client::sync_with_callback`],
/// [`Client::sync_with_result_callback`] and
/// [`Client::sync_stream`] methods can be used instead. Those methods
/// repeatedly return the whole sync response.
///
/// # Arguments
///
/// * `sync_settings` - Settings for the sync call. *Note* that those
/// settings will be only used for the first sync call. See the argument
/// docs for [`Client::sync_once`] for more info.
///
/// # Return
/// The sync runs until an error occurs, returning with `Err(Error)`. It is
/// up to the user of the API to check the error and decide whether the sync
/// should continue or not.
///
/// # Examples
///
/// ```no_run
/// # use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let username = "";
/// # let password = "";
/// use matrix_sdk::{
/// config::SyncSettings,
/// ruma::events::room::message::OriginalSyncRoomMessageEvent, Client,
/// };
///
/// let client = Client::new(homeserver).await?;
/// client.login(&username, &password, None, None).await?;
///
/// // Register our handler so we start responding once we receive a new
/// // event.
/// client.add_event_handler(|ev: OriginalSyncRoomMessageEvent| async move {
/// println!("Received event {}: {:?}", ev.sender, ev.content);
/// });
///
/// // Now keep on syncing forever. `sync()` will use the latest sync token
/// // automatically.
/// client.sync(SyncSettings::default()).await?;
/// # anyhow::Ok(()) });
/// ```
///
/// [argument docs]: #method.sync_once
/// [`sync_with_callback`]: #method.sync_with_callback
pub async fn sync(&self, sync_settings: crate::config::SyncSettings<'_>) -> Result<(), Error> {
self.sync_with_callback(sync_settings, |_| async { LoopCtrl::Continue }).await
}
/// Repeatedly call sync to synchronize the client state with the server.
///
/// # Arguments
///
/// * `sync_settings` - Settings for the sync call. *Note* that those
/// settings will be only used for the first sync call. See the argument
/// docs for [`Client::sync_once`] for more info.
///
/// * `callback` - A callback that will be called every time a successful
/// response has been fetched from the server. The callback must return a
/// boolean which signalizes if the method should stop syncing. If the
/// callback returns `LoopCtrl::Continue` the sync will continue, if the
/// callback returns `LoopCtrl::Break` the sync will be stopped.
///
/// # Return
/// The sync runs until an error occurs or the
/// callback indicates that the Loop should stop. If the callback asked for
/// a regular stop, the result will be `Ok(())` otherwise the
/// `Err(Error)` is returned.
///
/// # Examples
///
/// The following example demonstrates how to sync forever while sending all
/// the interesting events through a mpsc channel to another thread e.g. a
/// UI thread.
///
/// ```no_run
/// # use std::time::Duration;
/// # use matrix_sdk::{Client, config::SyncSettings, LoopCtrl};
/// # use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
/// # let mut client = Client::new(homeserver).await.unwrap();
///
/// use tokio::sync::mpsc::channel;
///
/// let (tx, rx) = channel(100);
///
/// let sync_channel = &tx;
/// let sync_settings = SyncSettings::new()
/// .timeout(Duration::from_secs(30));
///
/// client
/// .sync_with_callback(sync_settings, |response| async move {
/// let channel = sync_channel;
/// for (room_id, room) in response.rooms.join {
/// for event in room.timeline.events {
/// channel.send(event).await.unwrap();
/// }
/// }
///
/// LoopCtrl::Continue
/// })
/// .await;
/// })
/// ```
#[instrument(skip(self, callback))]
pub async fn sync_with_callback<C>(
&self,
sync_settings: crate::config::SyncSettings<'_>,
callback: impl Fn(SyncResponse) -> C,
) -> Result<(), Error>
where
C: Future<Output = LoopCtrl>,
{
self.sync_with_result_callback(sync_settings, |result| async {
Ok(callback(result?).await)
})
.await
}
/// Repeatedly call sync to synchronize the client state with the server.
///
/// # Arguments
///
/// * `sync_settings` - Settings for the sync call. *Note* that those
/// settings will be only used for the first sync call. See the argument
/// docs for [`Client::sync_once`] for more info.
///
/// * `callback` - A callback that will be called every time after a
/// response has been received, failure or not. The callback returns a
/// `Result<LoopCtrl, Error>, too. When returning `Ok(LoopCtrl::Continue)`
/// the sync will continue, if the callback returns `Ok(LoopCtrl::Break)`
/// the sync will be stopped and the function returns `Ok(())`. In case
/// the callback can't handle the `Error` or has a different malfunction,
/// it can return an `Err(Error)`, which results in the sync ending and
/// the `Err(Error)` being returned.
///
/// # Return
/// The sync runs until an error occurs that the callback can't handle or
/// the callback indicates that the Loop should stop. If the callback
/// asked for a regular stop, the result will be `Ok(())` otherwise the
/// `Err(Error)` is returned.
///
/// _Note_: Lower-level configuration (e.g. for retries) are not changed by
/// this, and are handled first without sending the result to the
/// callback. Only after they have exceeded is the `Result` handed to
/// the callback.
///
/// # Examples
///
/// The following example demonstrates how to sync forever while sending all
/// the interesting events through a mpsc channel to another thread e.g. a
/// UI thread.
///
/// ```no_run
/// # use std::time::Duration;
/// # use matrix_sdk::{Client, config::SyncSettings, LoopCtrl};
/// # use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
/// # let mut client = Client::new(homeserver).await.unwrap();
///
/// use tokio::sync::mpsc::channel;
///
/// let (tx, rx) = channel(100);
///
/// let sync_channel = &tx;
/// let sync_settings = SyncSettings::new()
/// .timeout(Duration::from_secs(30));
///
/// client
/// .sync_with_result_callback(sync_settings, |response| async move {
/// let channel = sync_channel;
/// let sync_response = response?;
/// for (room_id, room) in sync_response.rooms.join {
/// for event in room.timeline.events {
/// channel.send(event).await.unwrap();
/// }
/// }
///
/// Ok(LoopCtrl::Continue)
/// })
/// .await;
/// })
/// ```
#[instrument(skip(self, callback))]
pub async fn sync_with_result_callback<C>(
&self,
mut sync_settings: crate::config::SyncSettings<'_>,
callback: impl Fn(Result<SyncResponse, Error>) -> C,
) -> Result<(), Error>
where
C: Future<Output = Result<LoopCtrl, Error>>,
{
let mut last_sync_time: Option<Instant> = None;
if sync_settings.token.is_none() {
sync_settings.token = self.sync_token().await;
}
loop {
let result = self.sync_loop_helper(&mut sync_settings).await;
if callback(result).await? == LoopCtrl::Break {
break;
}
Client::delay_sync(&mut last_sync_time).await
}
Ok(())
}
//// Repeatedly synchronize the client state with the server.
///
/// This method will internally call [`Client::sync_once`] in a loop and is
/// equivalent to the [`Client::sync`] method but the responses are provided
/// as an async stream.
///
/// # Arguments
///
/// * `sync_settings` - Settings for the sync call. *Note* that those
/// settings will be only used for the first sync call. See the argument
/// docs for [`Client::sync_once`] for more info.
///
/// # Examples
///
/// ```no_run
/// # use url::Url;
/// # use futures::executor::block_on;
/// # block_on(async {
/// # let homeserver = Url::parse("http://localhost:8080")?;
/// # let username = "";
/// # let password = "";
/// use futures::StreamExt;
/// use matrix_sdk::{config::SyncSettings, Client};
///
/// let client = Client::new(homeserver).await?;
/// client.login(&username, &password, None, None).await?;
///
/// let mut sync_stream =
/// Box::pin(client.sync_stream(SyncSettings::default()).await);
///
/// while let Some(Ok(response)) = sync_stream.next().await {
/// for room in response.rooms.join.values() {
/// for e in &room.timeline.events {
/// if let Ok(event) = e.event.deserialize() {
/// println!("Received event {:?}", event);
/// }
/// }
/// }
/// }
///
/// # anyhow::Ok(()) });
/// ```
#[instrument(skip(self))]
pub async fn sync_stream<'a>(
&'a self,
mut sync_settings: crate::config::SyncSettings<'a>,
) -> impl Stream<Item = Result<SyncResponse>> + 'a {
let mut last_sync_time: Option<Instant> = None;
if sync_settings.token.is_none() {
sync_settings.token = self.sync_token().await;
}
async_stream::stream! {
loop {
yield self.sync_loop_helper(&mut sync_settings).await;
Client::delay_sync(&mut last_sync_time).await
}
}
}
/// Get the current, if any, sync token of the client.
/// This will be None if the client didn't sync at least once.
pub async fn sync_token(&self) -> Option<String> {
self.inner.base_client.sync_token().await
}
/// Gets information about the owner of a given access token.
pub async fn whoami(&self) -> HttpResult<whoami::v3::Response> {
let request = whoami::v3::Request::new();
self.send(request, None).await
}
/// Log out the current user
pub async fn logout(&self) -> HttpResult<logout::v3::Response> {
let request = logout::v3::Request::new();
self.send(request, None).await
}
}
// The http mocking library is not supported for wasm32
#[cfg(all(test, not(target_arch = "wasm32")))]
pub(crate) mod tests {
use std::time::Duration;
use matrix_sdk_test::{async_test, test_json, EventBuilder, JoinedRoomBuilder, StateTestEvent};
#[cfg(target_arch = "wasm32")]
wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
use ruma::{events::ignored_user_list::IgnoredUserListEventContent, UserId};
use url::Url;
use wiremock::{
matchers::{header, method, path},
Mock, MockServer, ResponseTemplate,
};
use super::Client;
use crate::{
config::{RequestConfig, SyncSettings},
test_utils::{logged_in_client, no_retry_test_client, test_client_builder},
};
#[async_test]
async fn account_data() {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
Mock::given(method("GET"))
.and(path("/_matrix/client/r0/sync".to_owned()))
.and(header("authorization", "Bearer 1234"))
.respond_with(ResponseTemplate::new(200).set_body_json(&*test_json::SYNC))
.mount(&server)
.await;
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
let _response = client.sync_once(sync_settings).await.unwrap();
let content = client
.account()
.account_data::<IgnoredUserListEventContent>()
.await
.unwrap()
.unwrap()
.deserialize()
.unwrap();
assert_eq!(content.ignored_users.len(), 1);
}
#[async_test]
async fn successful_discovery() {
let server = MockServer::start().await;
let server_url = server.uri();
let domain = server_url.strip_prefix("http://").unwrap();
let alice = UserId::parse("@alice:".to_owned() + domain).unwrap();
Mock::given(method("GET"))
.and(path("/.well-known/matrix/client"))
.respond_with(ResponseTemplate::new(200).set_body_raw(
test_json::WELL_KNOWN.to_string().replace("HOMESERVER_URL", server_url.as_ref()),
"application/json",
))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/_matrix/client/versions"))
.respond_with(ResponseTemplate::new(200).set_body_json(&*test_json::VERSIONS))
.mount(&server)
.await;
let client = Client::builder().server_name(alice.server_name()).build().await.unwrap();
assert_eq!(client.homeserver().await, Url::parse(server_url.as_ref()).unwrap());
}
#[async_test]
async fn discovery_broken_server() {
let server = MockServer::start().await;
let server_url = server.uri();
let domain = server_url.strip_prefix("http://").unwrap();
let alice = UserId::parse("@alice:".to_owned() + domain).unwrap();
Mock::given(method("GET"))
.and(path("/.well-known/matrix/client"))
.respond_with(ResponseTemplate::new(404))
.mount(&server)
.await;
assert!(
Client::builder().server_name(alice.server_name()).build().await.is_err(),
"Creating a client from a user ID should fail when the .well-known request fails."
);
}
#[async_test]
async fn room_creation() {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let response = EventBuilder::default()
.add_joined_room(
JoinedRoomBuilder::default()
.add_state_event(StateTestEvent::Member)
.add_state_event(StateTestEvent::PowerLevels),
)
.build_sync_response();
client.inner.base_client.receive_sync_response(response).await.unwrap();
let room_id = &test_json::DEFAULT_SYNC_ROOM_ID;
assert_eq!(client.homeserver().await, Url::parse(&server.uri()).unwrap());
let room = client.get_joined_room(room_id);
assert!(room.is_some());
}
#[async_test]
async fn retry_limit_http_requests() {
let server = MockServer::start().await;
let client = test_client_builder(Some(server.uri()))
.request_config(RequestConfig::new().retry_limit(3))
.build()
.await
.unwrap();
assert!(client.request_config().retry_limit.unwrap() == 3);
Mock::given(method("POST"))
.and(path("/_matrix/client/r0/login"))
.respond_with(ResponseTemplate::new(501))
.expect(3)
.mount(&server)
.await;
client.login_username("example", "wordpass").send().await.unwrap_err();
}
#[async_test]
async fn retry_timeout_http_requests() {
// Keep this timeout small so that the test doesn't take long
let retry_timeout = Duration::from_secs(5);
let server = MockServer::start().await;
let client = test_client_builder(Some(server.uri()))
.request_config(RequestConfig::new().retry_timeout(retry_timeout))
.build()
.await
.unwrap();
assert!(client.request_config().retry_timeout.unwrap() == retry_timeout);
Mock::given(method("POST"))
.and(path("/_matrix/client/r0/login"))
.respond_with(ResponseTemplate::new(501))
.expect(2..)
.mount(&server)
.await;
client.login_username("example", "wordpass").send().await.unwrap_err();
}
#[async_test]
async fn short_retry_initial_http_requests() {
let server = MockServer::start().await;
let client = test_client_builder(Some(server.uri())).build().await.unwrap();
Mock::given(method("POST"))
.and(path("/_matrix/client/r0/login"))
.respond_with(ResponseTemplate::new(501))
.expect(3..)
.mount(&server)
.await;
client.login_username("example", "wordpass").send().await.unwrap_err();
}
#[async_test]
async fn no_retry_http_requests() {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
Mock::given(method("GET"))
.and(path("/_matrix/client/r0/devices"))
.respond_with(ResponseTemplate::new(501))
.expect(1)
.mount(&server)
.await;
client.devices().await.unwrap_err();
}
#[async_test]
async fn set_homeserver() {
let client = no_retry_test_client(Some("http://localhost".to_owned())).await;
assert_eq!(client.homeserver().await.as_ref(), "http://localhost/");
let homeserver = Url::parse("http://example.com/").unwrap();
client.set_homeserver(homeserver.clone()).await;
assert_eq!(client.homeserver().await, homeserver);
}
}