1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
|
// SPDX-FileCopyrightText: 2016 Kitsune Ral <Kitsune-Ral@users.sf.net>
// SPDX-FileCopyrightText: 2017 Roman Plášil <me@rplasil.name>
// SPDX-FileCopyrightText: 2017 Marius Gripsgard <marius@ubports.com>
// SPDX-FileCopyrightText: 2018 Josip Delic <delijati@googlemail.com>
// SPDX-FileCopyrightText: 2018 Black Hat <bhat@encom.eu.org>
// SPDX-FileCopyrightText: 2019 Alexey Andreyev <aa13q@ya.ru>
// SPDX-FileCopyrightText: 2020 Ram Nad <ramnad1999@gmail.com>
// SPDX-License-Identifier: LGPL-2.1-or-later
#include "room.h"
#include "avatar.h"
#include "connection.h"
#include "converters.h"
#include "syncdata.h"
#include "user.h"
#include "eventstats.h"
#include "roomstateview.h"
#include "qt_connection_util.h"
// NB: since Qt 6, moc_room.cpp needs User fully defined
#include "moc_room.cpp"
#include "csapi/account-data.h"
#include "csapi/banning.h"
#include "csapi/inviting.h"
#include "csapi/kicking.h"
#include "csapi/leaving.h"
#include "csapi/receipts.h"
#include "csapi/redaction.h"
#include "csapi/room_send.h"
#include "csapi/room_state.h"
#include "csapi/room_upgrades.h"
#include "csapi/rooms.h"
#include "csapi/read_markers.h"
#include "csapi/tags.h"
#include "events/callanswerevent.h"
#include "events/callcandidatesevent.h"
#include "events/callhangupevent.h"
#include "events/callinviteevent.h"
#include "events/encryptionevent.h"
#include "events/reactionevent.h"
#include "events/receiptevent.h"
#include "events/redactionevent.h"
#include "events/roomavatarevent.h"
#include "events/roomcreateevent.h"
#include "events/roommemberevent.h"
#include "events/roomtombstoneevent.h"
#include "events/simplestateevents.h"
#include "events/typingevent.h"
#include "events/roompowerlevelsevent.h"
#include "jobs/downloadfilejob.h"
#include "jobs/mediathumbnailjob.h"
#include "events/roomcanonicalaliasevent.h"
#include <QtCore/QDir>
#include <QtCore/QHash>
#include <QtCore/QPointer>
#include <QtCore/QRegularExpression>
#include <QtCore/QStringBuilder> // for efficient string concats (operator%)
#include <QtCore/QTemporaryFile>
#include <array>
#include <cmath>
#include <functional>
#ifdef Quotient_E2EE_ENABLED
#include "e2ee/e2ee.h"
#include "e2ee/qolmaccount.h"
#include "e2ee/qolmerrors.h"
#include "e2ee/qolminboundsession.h"
#include "e2ee/qolmoutboundsession.h"
#include "e2ee/qolmutility.h"
#include "database.h"
#endif // Quotient_E2EE_ENABLED
using namespace Quotient;
using namespace std::placeholders;
using std::move;
#if !(defined __GLIBCXX__ && __GLIBCXX__ <= 20150123)
using std::llround;
#endif
enum EventsPlacement : int { Older = -1, Newer = 1 };
class Room::Private {
public:
/// Map of user names to users
/** User names potentially duplicate, hence QMultiHash. */
using members_map_t = QMultiHash<QString, User*>;
Private(Connection* c, QString id_, JoinState initialJoinState)
: q(nullptr), connection(c), id(move(id_)), joinState(initialJoinState)
{}
Room* q;
Connection* connection;
QString id;
JoinState joinState;
RoomSummary summary = { none, 0, none };
/// The state of the room at timeline position before-0
/// \sa timelineBase
UnorderedMap<StateEventKey, StateEventPtr> baseState;
/// State event stubs - events without content, just type and state key
static decltype(baseState) stubbedState;
/// The state of the room at syncEdge()
/// \sa syncEdge
RoomStateView currentState;
/// Servers with aliases for this room except the one of the local user
/// \sa Room::remoteAliases
QSet<QString> aliasServers;
Timeline timeline;
PendingEvents unsyncedEvents;
QHash<QString, TimelineItem::index_t> eventsIndex;
// A map from evtId to a map of relation type to a vector of event
// pointers. Not using QMultiHash, because we want to quickly return
// a number of relations for a given event without enumerating them.
QHash<std::pair<QString, QString>, RelatedEvents> relations;
QString displayname;
Avatar avatar;
QHash<QString, Notification> notifications;
qsizetype serverHighlightCount = 0;
// Starting up with estimate event statistics as there's zero knowledge
// about the timeline.
EventStats partiallyReadStats {}, unreadStats {};
members_map_t membersMap;
QList<User*> usersTyping;
QHash<QString, QSet<QString>> eventIdReadUsers;
QList<User*> usersInvited;
QList<User*> membersLeft;
bool displayed = false;
QString firstDisplayedEventId;
QString lastDisplayedEventId;
QHash<QString, ReadReceipt> lastReadReceipts;
QString fullyReadUntilEventId;
TagsMap tags;
UnorderedMap<QString, EventPtr> accountData;
QString prevBatch;
QPointer<GetRoomEventsJob> eventsHistoryJob;
QPointer<GetMembersByRoomJob> allMembersJob;
// Map from megolm sessionId to set of eventIds
UnorderedMap<QString, QSet<QString>> undecryptedEvents;
struct FileTransferPrivateInfo {
FileTransferPrivateInfo() = default;
FileTransferPrivateInfo(BaseJob* j, const QString& fileName,
bool isUploading = false)
: status(FileTransferInfo::Started)
, job(j)
, localFileInfo(fileName)
, isUpload(isUploading)
{}
FileTransferInfo::Status status = FileTransferInfo::None;
QPointer<BaseJob> job = nullptr;
QFileInfo localFileInfo {};
bool isUpload = false;
qint64 progress = 0;
qint64 total = -1;
void update(qint64 p, qint64 t)
{
if (t == 0) {
t = -1;
if (p == 0)
p = -1;
}
if (p != -1)
qCDebug(PROFILER) << "Transfer progress:" << p << "/" << t
<< "=" << llround(double(p) / t * 100) << "%";
progress = p;
total = t;
}
};
void failedTransfer(const QString& tid, const QString& errorMessage = {})
{
qCWarning(MAIN) << "File transfer failed for id" << tid;
if (!errorMessage.isEmpty())
qCWarning(MAIN) << "Message:" << errorMessage;
fileTransfers[tid].status = FileTransferInfo::Failed;
emit q->fileTransferFailed(tid, errorMessage);
}
/// A map from event/txn ids to information about the long operation;
/// used for both download and upload operations
QHash<QString, FileTransferPrivateInfo> fileTransfers;
const RoomMessageEvent* getEventWithFile(const QString& eventId) const;
QString fileNameToDownload(const RoomMessageEvent* event) const;
Changes setSummary(RoomSummary&& newSummary);
// void inviteUser(User* u); // We might get it at some point in time.
void insertMemberIntoMap(User* u);
void removeMemberFromMap(User* u);
// This updates the room displayname field (which is the way a room
// should be shown in the room list); called whenever the list of
// members, the room name (m.room.name) or canonical alias change.
void updateDisplayname();
// This is used by updateDisplayname() but only calculates the new name
// without any updates.
QString calculateDisplayname() const;
/// A point in the timeline corresponding to baseState
rev_iter_t timelineBase() const { return q->findInTimeline(-1); }
rev_iter_t historyEdge() const { return timeline.crend(); }
Timeline::const_iterator syncEdge() const { return timeline.cend(); }
void getPreviousContent(int limit = 10, const QString &filter = {});
const StateEventBase* getCurrentState(const StateEventKey& evtKey) const
{
const auto* evt = currentState.value(evtKey, nullptr);
if (!evt) {
if (stubbedState.find(evtKey) == stubbedState.end()) {
// In the absence of a real event, make a stub as-if an event
// with empty content has been received. Event classes should be
// prepared for empty/invalid/malicious content anyway.
stubbedState.emplace(evtKey,
loadEvent<StateEventBase>(evtKey.first,
evtKey.second));
qCDebug(STATE) << "A new stub event created for key {"
<< evtKey.first << evtKey.second << "}";
qCDebug(STATE) << "Stubbed state size:" << stubbedState.size();
}
evt = stubbedState[evtKey].get();
Q_ASSERT(evt);
}
Q_ASSERT(evt->matrixType() == evtKey.first
&& evt->stateKey() == evtKey.second);
return evt;
}
template <typename EventArrayT>
Changes updateStateFrom(EventArrayT&& events)
{
Changes changes {};
if (!events.empty()) {
QElapsedTimer et;
et.start();
for (auto&& eptr : events) {
const auto& evt = *eptr;
Q_ASSERT(evt.isStateEvent());
if (auto change = q->processStateEvent(evt); change) {
changes |= change;
baseState[{ evt.matrixType(), evt.stateKey() }] = move(eptr);
}
}
if (events.size() > 9 || et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER)
<< "Updated" << q->objectName() << "room state from"
<< events.size() << "event(s) in" << et;
}
return changes;
}
Changes addNewMessageEvents(RoomEvents&& events);
void addHistoricalMessageEvents(RoomEvents&& events);
Changes updateStatsFromSyncData(const SyncRoomData &data, bool fromCache);
void postprocessChanges(Changes changes, bool saveState = true);
/** Move events into the timeline
*
* Insert events into the timeline, either new or historical.
* Pointers in the original container become empty, the ownership
* is passed to the timeline container.
* @param events - the range of events to be inserted
* @param placement - position and direction of insertion: Older for
* historical messages, Newer for new ones
*/
Timeline::size_type moveEventsToTimeline(RoomEventsRange events,
EventsPlacement placement);
/**
* Remove events from the passed container that are already in the timeline
*/
void dropDuplicateEvents(RoomEvents& events) const;
void decryptIncomingEvents(RoomEvents& events);
//! \brief update last receipt record for a given user
//!
//! \return previous event id of the receipt if the new receipt changed
//! it, or `none` if no change took place
Omittable<QString> setLastReadReceipt(const QString& userId, rev_iter_t newMarker,
ReadReceipt newReceipt = {});
Changes setLocalLastReadReceipt(const rev_iter_t& newMarker,
ReadReceipt newReceipt = {},
bool deferStatsUpdate = false);
Changes setFullyReadMarker(const QString &eventId);
Changes updateStats(const rev_iter_t& from, const rev_iter_t& to);
bool markMessagesAsRead(const rev_iter_t& upToMarker);
void getAllMembers();
QString sendEvent(RoomEventPtr&& event);
template <typename EventT, typename... ArgTs>
QString sendEvent(ArgTs&&... eventArgs)
{
return sendEvent(makeEvent<EventT>(std::forward<ArgTs>(eventArgs)...));
}
QString doPostFile(RoomEventPtr &&msgEvent, const QUrl &localUrl);
RoomEvent* addAsPending(RoomEventPtr&& event);
QString doSendEvent(const RoomEvent* pEvent);
void onEventSendingFailure(const QString& txnId, BaseJob* call = nullptr);
SetRoomStateWithKeyJob* requestSetState(const QString& evtType,
const QString& stateKey,
const QJsonObject& contentJson)
{
// if (event.roomId().isEmpty())
// event.setRoomId(id);
// if (event.senderId().isEmpty())
// event.setSender(connection->userId());
// TODO: Queue up state events sending (see #133).
// TODO: Maybe addAsPending() as well, despite having no txnId
return connection->callApi<SetRoomStateWithKeyJob>(id, evtType, stateKey,
contentJson);
}
/*! Apply redaction to the timeline
*
* Tries to find an event in the timeline and redact it; deletes the
* redaction event whether the redacted event was found or not.
* \return true if the event has been found and redacted; false otherwise
*/
bool processRedaction(const RedactionEvent& redaction);
/*! Apply a new revision of the event to the timeline
*
* Tries to find an event in the timeline and replace it with the new
* content passed in \p newMessage.
* \return true if the event has been found and replaced; false otherwise
*/
bool processReplacement(const RoomMessageEvent& newEvent);
void setTags(TagsMap&& newTags);
QJsonObject toJson() const;
bool isLocalUser(const User* u) const { return u == q->localUser(); }
#ifdef Quotient_E2EE_ENABLED
UnorderedMap<QString, QOlmInboundGroupSessionPtr> groupSessions;
int currentMegolmSessionMessageCount = 0;
//TODO save this to database
unsigned long long currentMegolmSessionCreationTimestamp = 0;
QOlmOutboundGroupSessionPtr currentOutboundMegolmSession = nullptr;
bool addInboundGroupSession(QString sessionId, QByteArray sessionKey,
const QString& senderId,
const QString& olmSessionId)
{
if (groupSessions.contains(sessionId)) {
qCWarning(E2EE) << "Inbound Megolm session" << sessionId << "already exists";
return false;
}
auto megolmSession = QOlmInboundGroupSession::create(sessionKey);
if (megolmSession->sessionId() != sessionId) {
qCWarning(E2EE) << "Session ID mismatch in m.room_key event";
return false;
}
megolmSession->setSenderId(senderId);
megolmSession->setOlmSessionId(olmSessionId);
qCWarning(E2EE) << "Adding inbound session";
connection->saveMegolmSession(q, *megolmSession);
groupSessions[sessionId] = std::move(megolmSession);
return true;
}
QString groupSessionDecryptMessage(QByteArray cipher,
const QString& sessionId,
const QString& eventId,
QDateTime timestamp,
const QString& senderId)
{
auto groupSessionIt = groupSessions.find(sessionId);
if (groupSessionIt == groupSessions.end()) {
// qCWarning(E2EE) << "Unable to decrypt event" << eventId
// << "The sender's device has not sent us the keys for "
// "this message";
return {};
}
auto& senderSession = groupSessionIt->second;
if (senderSession->senderId() != senderId) {
qCWarning(E2EE) << "Sender from event does not match sender from session";
return {};
}
auto decryptResult = senderSession->decrypt(cipher);
if(!decryptResult) {
qCWarning(E2EE) << "Unable to decrypt event" << eventId
<< "with matching megolm session:" << decryptResult.error();
return {};
}
const auto& [content, index] = *decryptResult;
const auto& [recordEventId, ts] =
q->connection()->database()->groupSessionIndexRecord(
q->id(), senderSession->sessionId(), index);
if (recordEventId.isEmpty()) {
q->connection()->database()->addGroupSessionIndexRecord(
q->id(), senderSession->sessionId(), index, eventId,
timestamp.toMSecsSinceEpoch());
} else {
if ((eventId != recordEventId)
|| (ts != timestamp.toMSecsSinceEpoch())) {
qCWarning(E2EE) << "Detected a replay attack on event" << eventId;
return {};
}
}
return content;
}
bool shouldRotateMegolmSession() const
{
const auto* encryptionConfig = currentState.get<EncryptionEvent>();
if (!encryptionConfig || !encryptionConfig->useEncryption())
return false;
const auto rotationInterval = encryptionConfig->rotationPeriodMs();
const auto rotationMessageCount = encryptionConfig->rotationPeriodMsgs();
return currentOutboundMegolmSession->messageCount()
>= rotationMessageCount
|| currentOutboundMegolmSession->creationTime().addMSecs(
rotationInterval)
< QDateTime::currentDateTime();
}
bool hasValidMegolmSession() const
{
if (!q->usesEncryption()) {
return false;
}
return currentOutboundMegolmSession != nullptr;
}
void createMegolmSession() {
qCDebug(E2EE) << "Creating new outbound megolm session for room "
<< q->objectName();
currentOutboundMegolmSession = QOlmOutboundGroupSession::create();
connection->saveCurrentOutboundMegolmSession(
id, *currentOutboundMegolmSession);
const auto sessionKey = currentOutboundMegolmSession->sessionKey();
if(!sessionKey) {
qCWarning(E2EE) << "Failed to load key for new megolm session";
return;
}
addInboundGroupSession(currentOutboundMegolmSession->sessionId(), *sessionKey, q->localUser()->id(), "SELF"_ls);
}
QMultiHash<QString, QString> getDevicesWithoutKey() const
{
QMultiHash<QString, QString> devices;
for (const auto& user : q->users())
for (const auto& deviceId : connection->devicesForUser(user->id()))
devices.insert(user->id(), deviceId);
return connection->database()->devicesWithoutKey(
id, devices, currentOutboundMegolmSession->sessionId());
}
void sendMegolmSession(const QMultiHash<QString, QString>& devices) const {
// Save the session to this device
const auto sessionId = currentOutboundMegolmSession->sessionId();
const auto sessionKey = currentOutboundMegolmSession->sessionKey();
if(!sessionKey) {
qCWarning(E2EE) << "Error loading session key";
return;
}
// Send the session to other people
connection->sendSessionKeyToDevices(
id, sessionId, *sessionKey, devices,
currentOutboundMegolmSession->sessionMessageIndex());
}
#endif // Quotient_E2EE_ENABLED
private:
using users_shortlist_t = std::array<User*, 3>;
template <typename ContT>
users_shortlist_t buildShortlist(const ContT& users) const;
users_shortlist_t buildShortlist(const QStringList& userIds) const;
};
decltype(Room::Private::baseState) Room::Private::stubbedState {};
Room::Room(Connection* connection, QString id, JoinState initialJoinState)
: QObject(connection), d(new Private(connection, id, initialJoinState))
{
setObjectName(id);
// See "Accessing the Public Class" section in
// https://marcmutz.wordpress.com/translated-articles/pimp-my-pimpl-%E2%80%94-reloaded/
d->q = this;
d->displayname = d->calculateDisplayname(); // Set initial "Empty room" name
#ifdef Quotient_E2EE_ENABLED
connectSingleShot(this, &Room::encryption, this, [this, connection](){
connection->encryptionUpdate(this);
});
connect(this, &Room::userAdded, this, [this, connection](){
if(usesEncryption()) {
connection->encryptionUpdate(this);
}
});
d->groupSessions = connection->loadRoomMegolmSessions(this);
d->currentOutboundMegolmSession =
connection->loadCurrentOutboundMegolmSession(this->id());
if (d->shouldRotateMegolmSession()) {
d->currentOutboundMegolmSession = nullptr;
}
connect(this, &Room::userRemoved, this, [this](){
if (!usesEncryption()) {
return;
}
if (d->hasValidMegolmSession()) {
d->createMegolmSession();
}
qCDebug(E2EE) << "Invalidating current megolm session because user left";
});
connect(this, &Room::beforeDestruction, this, [=](){
connection->database()->clearRoomData(id);
});
#endif
qCDebug(STATE) << "New" << terse << initialJoinState << "Room:" << id;
}
Room::~Room() { delete d; }
const QString& Room::id() const { return d->id; }
QString Room::version() const
{
const auto v = currentState().query(&RoomCreateEvent::version);
return v && !v->isEmpty() ? *v : QStringLiteral("1");
}
bool Room::isUnstable() const
{
return !connection()->loadingCapabilities()
&& !connection()->stableRoomVersions().contains(version());
}
QString Room::predecessorId() const
{
if (const auto* evt = currentState().get<RoomCreateEvent>())
return evt->predecessor().roomId;
return {};
}
Room* Room::predecessor(JoinStates statesFilter) const
{
if (const auto& predId = predecessorId(); !predId.isEmpty())
if (auto* r = connection()->room(predId, statesFilter);
r && r->successorId() == id())
return r;
return nullptr;
}
QString Room::successorId() const
{
return currentState().queryOr(&RoomTombstoneEvent::successorRoomId,
QString());
}
Room* Room::successor(JoinStates statesFilter) const
{
if (const auto& succId = successorId(); !succId.isEmpty())
if (auto* r = connection()->room(succId, statesFilter);
r && r->predecessorId() == id())
return r;
return nullptr;
}
const Room::Timeline& Room::messageEvents() const { return d->timeline; }
const Room::PendingEvents& Room::pendingEvents() const
{
return d->unsyncedEvents;
}
bool Room::allHistoryLoaded() const
{
return !d->timeline.empty() && is<RoomCreateEvent>(*d->timeline.front());
}
QString Room::name() const
{
return currentState().queryOr(&RoomNameEvent::name, QString());
}
QStringList Room::aliases() const
{
if (const auto* evt = currentState().get<RoomCanonicalAliasEvent>()) {
auto result = evt->altAliases();
if (!evt->alias().isEmpty())
result << evt->alias();
return result;
}
return {};
}
QStringList Room::altAliases() const
{
return currentState().queryOr(&RoomCanonicalAliasEvent::altAliases,
QStringList());
}
QString Room::canonicalAlias() const
{
return currentState().queryOr(&RoomCanonicalAliasEvent::alias, QString());
}
QString Room::displayName() const { return d->displayname; }
QStringList Room::pinnedEventIds() const {
return currentState().queryOr(&RoomPinnedEvent::pinnedEvents, QStringList());
}
QVector<const Quotient::RoomEvent*> Quotient::Room::pinnedEvents() const
{
QVector<const RoomEvent*> pinnedEvents;
for (const auto& evtId : pinnedEventIds())
if (const auto& it = findInTimeline(evtId); it != historyEdge())
pinnedEvents.append(it->event());
return pinnedEvents;
}
QString Room::displayNameForHtml() const
{
return displayName().toHtmlEscaped();
}
void Room::refreshDisplayName() { d->updateDisplayname(); }
QString Room::topic() const
{
return currentState().queryOr(&RoomTopicEvent::topic, QString());
}
QString Room::avatarMediaId() const { return d->avatar.mediaId(); }
QUrl Room::avatarUrl() const { return d->avatar.url(); }
const Avatar& Room::avatarObject() const { return d->avatar; }
QImage Room::avatar(int dimension) { return avatar(dimension, dimension); }
QImage Room::avatar(int width, int height)
{
if (!d->avatar.url().isEmpty())
return d->avatar.get(connection(), width, height,
[this] { emit avatarChanged(); });
// Use the first (excluding self) user's avatar for direct chats
const auto dcUsers = directChatUsers();
for (auto* u : dcUsers)
if (u != localUser())
return u->avatar(width, height, this, [this] { emit avatarChanged(); });
return {};
}
User* Room::user(const QString& userId) const
{
return connection()->user(userId);
}
JoinState Room::memberJoinState(User* user) const
{
return d->membersMap.contains(user->name(this), user) ? JoinState::Join
: JoinState::Leave;
}
Membership Room::memberState(const QString& userId) const
{
return currentState().queryOr(userId, &RoomMemberEvent::membership,
Membership::Leave);
}
bool Room::isMember(const QString& userId) const
{
return memberState(userId) == Membership::Join;
}
JoinState Room::joinState() const { return d->joinState; }
void Room::setJoinState(JoinState state)
{
JoinState oldState = d->joinState;
if (state == oldState)
return;
d->joinState = state;
qCDebug(STATE) << "Room" << id() << "changed state: " << terse << oldState
<< "->" << state;
emit joinStateChanged(oldState, state);
}
Omittable<QString> Room::Private::setLastReadReceipt(const QString& userId,
rev_iter_t newMarker,
ReadReceipt newReceipt)
{
if (newMarker == historyEdge() && !newReceipt.eventId.isEmpty())
newMarker = q->findInTimeline(newReceipt.eventId);
if (newMarker != historyEdge()) {
// Try to auto-promote the read marker over the user's own messages
// (switch to direct iterators for that).
const auto eagerMarker = find_if(newMarker.base(), syncEdge(),
[=](const TimelineItem& ti) {
return ti->senderId() != userId;
});
// eagerMarker is now just after the desired event for newMarker
if (eagerMarker != newMarker.base()) {
newMarker = rev_iter_t(eagerMarker);
qDebug(EPHEMERAL) << "Auto-promoted read receipt for" << userId
<< "to" << *newMarker;
}
// Fill newReceipt with the event (and, if needed, timestamp) from
// eagerMarker
newReceipt.eventId = (eagerMarker - 1)->event()->id();
if (newReceipt.timestamp.isNull())
newReceipt.timestamp = QDateTime::currentDateTime();
}
auto& storedReceipt =
lastReadReceipts[userId]; // clazy:exclude=detaching-member
const auto prevEventId = storedReceipt.eventId;
// Check that either the new marker is actually "newer" than the current one
// or, if both markers are at historyEdge(), event ids are different.
// This logic tackles, in particular, the case when the new event is not
// found (most likely, because it's too old and hasn't been fetched from
// the server yet) but there is a previous marker for a user; in that case,
// the previous marker is kept because read receipts are not supposed
// to move backwards. If neither new nor old event is found, the new receipt
// is blindly stored, in a hope it's also "newer" in the timeline.
// NB: with reverse iterators, timeline history edge >= sync edge
if (prevEventId == newReceipt.eventId
|| newMarker > q->findInTimeline(prevEventId))
return {};
// Finally make the change
auto oldEventReadUsersIt =
eventIdReadUsers.find(prevEventId); // clazy:exclude=detaching-member
if (oldEventReadUsersIt != eventIdReadUsers.end()) {
oldEventReadUsersIt->remove(userId);
if (oldEventReadUsersIt->isEmpty())
eventIdReadUsers.erase(oldEventReadUsersIt);
}
eventIdReadUsers[newReceipt.eventId].insert(userId);
storedReceipt = move(newReceipt);
{
auto dbg = qDebug(EPHEMERAL); // NB: qCDebug can't be used like that
dbg << "The new read receipt for" << userId << "is now at";
if (newMarker == historyEdge())
dbg << storedReceipt.eventId;
else
dbg << *newMarker;
}
// NB: This method, unlike setLocalLastReadReceipt, doesn't emit
// lastReadEventChanged() to avoid numerous emissions when many read
// receipts arrive. It can be called thousands of times during an initial
// sync, e.g.
// TODO: remove in 0.8
if (const auto member = q->user(userId); !isLocalUser(member))
emit q->readMarkerForUserMoved(member, prevEventId,
storedReceipt.eventId);
return prevEventId;
}
Room::Changes Room::Private::setLocalLastReadReceipt(const rev_iter_t& newMarker,
ReadReceipt newReceipt,
bool deferStatsUpdate)
{
auto prevEventId =
setLastReadReceipt(connection->userId(), newMarker, move(newReceipt));
if (!prevEventId)
return Change::None;
Changes changes = Change::Other;
if (!deferStatsUpdate) {
if (unreadStats.updateOnMarkerMove(q, q->findInTimeline(*prevEventId),
newMarker)) {
qDebug(MESSAGES)
<< "Updated unread event statistics in" << q->objectName()
<< "after moving the local read receipt:" << unreadStats;
changes |= Change::UnreadStats;
}
Q_ASSERT(unreadStats.isValidFor(q, newMarker)); // post-check
}
emit q->lastReadEventChanged({ connection->userId() });
return changes;
}
Room::Changes Room::Private::updateStats(const rev_iter_t& from,
const rev_iter_t& to)
{
Q_ASSERT(from >= timeline.crbegin() && from <= timeline.crend());
Q_ASSERT(to >= from && to <= timeline.crend());
const auto fullyReadMarker = q->fullyReadMarker();
auto readReceiptMarker = q->localReadReceiptMarker();
Changes changes = Change::None;
// Correct the read receipt to never be behind the fully read marker
if (readReceiptMarker > fullyReadMarker
&& setLocalLastReadReceipt(fullyReadMarker, {}, true)) {
changes |= Change::Other;
readReceiptMarker = q->localReadReceiptMarker();
qCInfo(MESSAGES) << "The local m.read receipt was behind m.fully_read "
"marker - it's now corrected to be at index"
<< readReceiptMarker->index();
}
if (fullyReadMarker < from)
return Change::None; // What's arrived is already fully read
// If there's no read marker in the whole room, initialise it
if (fullyReadMarker == historyEdge() && q->allHistoryLoaded())
return setFullyReadMarker(timeline.front()->id());
// Catch a case when the id in the last fully read marker or the local read
// receipt refers to an event that has just arrived. In this case either
// one (unreadStats) or both statistics should be recalculated to get
// an exact number instead of an estimation (see documentation on
// EventStats::isEstimate). For the same reason (switching from the
// estimate to the exact number) this branch forces returning
// Change::UnreadStats and also possibly Change::PartiallyReadStats, even if
// the estimation luckily matched the exact result.
if (readReceiptMarker < to || changes /*i.e. read receipt was corrected*/) {
unreadStats = EventStats::fromMarker(q, readReceiptMarker);
Q_ASSERT(!unreadStats.isEstimate);
qCDebug(MESSAGES).nospace() << "Recalculated unread event statistics in"
<< q->objectName() << ": " << unreadStats;
changes |= Change::UnreadStats;
if (fullyReadMarker < to) {
// Add up to unreadStats instead of counting same events again
partiallyReadStats = EventStats::fromRange(q, readReceiptMarker,
q->fullyReadMarker(),
unreadStats);
Q_ASSERT(!partiallyReadStats.isEstimate);
qCDebug(MESSAGES).nospace()
<< "Recalculated partially read event statistics in "
<< q->objectName() << ": " << partiallyReadStats;
return changes | Change::PartiallyReadStats;
}
}
// As of here, at least the fully read marker (but maybe also read receipt)
// points to somewhere beyond the "oldest" message from the arrived batch -
// add up newly arrived messages to the current stats, instead of a complete
// recalculation.
Q_ASSERT(fullyReadMarker >= to);
const auto newStats = EventStats::fromRange(q, from, to);
Q_ASSERT(!newStats.isEstimate);
if (newStats.empty())
return changes;
const auto doAddStats = [this, &changes, newStats](EventStats& s,
const rev_iter_t& marker,
Change c) {
s.notableCount += newStats.notableCount;
s.highlightCount += newStats.highlightCount;
if (!s.isEstimate)
s.isEstimate = marker == historyEdge();
changes |= c;
};
doAddStats(partiallyReadStats, fullyReadMarker, Change::PartiallyReadStats);
if (readReceiptMarker >= to) {
// readReceiptMarker < to branch shouldn't have been entered
Q_ASSERT(!changes.testFlag(Change::UnreadStats));
doAddStats(unreadStats, readReceiptMarker, Change::UnreadStats);
}
qCDebug(MESSAGES) << "Room" << q->objectName() << "has gained" << newStats
<< "notable/highlighted event(s); total statistics:"
<< partiallyReadStats << "since the fully read marker,"
<< unreadStats << "since read receipt";
// Check invariants
Q_ASSERT(partiallyReadStats.isValidFor(q, fullyReadMarker));
Q_ASSERT(unreadStats.isValidFor(q, readReceiptMarker));
return changes;
}
Room::Changes Room::Private::setFullyReadMarker(const QString& eventId)
{
if (fullyReadUntilEventId == eventId)
return Change::None;
const auto prevReadMarker = q->fullyReadMarker();
const auto newReadMarker = q->findInTimeline(eventId);
if (newReadMarker > prevReadMarker)
return Change::None;
const auto prevFullyReadId = std::exchange(fullyReadUntilEventId, eventId);
qCDebug(MESSAGES) << "Fully read marker in" << q->objectName() //
<< "set to" << fullyReadUntilEventId;
QT_IGNORE_DEPRECATIONS(Changes changes = Change::ReadMarker|Change::Other;)
if (const auto rm = q->fullyReadMarker(); rm != historyEdge()) {
// Pull read receipt if it's behind, and update statistics
changes |= setLocalLastReadReceipt(rm);
if (partiallyReadStats.updateOnMarkerMove(q, prevReadMarker, rm)) {
changes |= Change::PartiallyReadStats;
qCDebug(MESSAGES)
<< "Updated partially read event statistics in"
<< q->objectName()
<< "after moving m.fully_read marker: " << partiallyReadStats;
}
Q_ASSERT(partiallyReadStats.isValidFor(q, rm)); // post-check
}
emit q->fullyReadMarkerMoved(prevFullyReadId, fullyReadUntilEventId);
// TODO: Remove in 0.8
emit q->readMarkerMoved(prevFullyReadId, fullyReadUntilEventId);
return changes;
}
void Room::setReadReceipt(const QString& atEventId)
{
if (const auto changes =
d->setLocalLastReadReceipt(historyEdge(), { atEventId })) {
connection()->callApi<PostReceiptJob>(BackgroundRequest, id(),
QStringLiteral("m.read"),
QUrl::toPercentEncoding(atEventId));
d->postprocessChanges(changes);
} else
qCDebug(EPHEMERAL) << "The new read receipt for" << localUser()->id()
<< "in" << objectName()
<< "is at or behind the old one, skipping";
}
bool Room::Private::markMessagesAsRead(const rev_iter_t &upToMarker)
{
if (upToMarker == q->historyEdge())
qCWarning(MESSAGES) << "Cannot mark an unknown event in"
<< q->objectName() << "as fully read";
else if (const auto changes = setFullyReadMarker(upToMarker->event()->id())) {
// The assumption below is that if a read receipt was sent on a newer
// event, the homeserver will keep it there instead of reverting to
// m.fully_read
connection->callApi<SetReadMarkerJob>(BackgroundRequest, id,
fullyReadUntilEventId,
fullyReadUntilEventId);
postprocessChanges(changes);
return true;
} else
qCDebug(MESSAGES) << "Event" << *upToMarker << "in" << q->objectName()
<< "is behind the current fully read marker at"
<< *q->fullyReadMarker()
<< "- won't move fully read marker back in timeline";
return false;
}
void Room::markMessagesAsRead(const QString& uptoEventId)
{
d->markMessagesAsRead(findInTimeline(uptoEventId));
}
void Room::markAllMessagesAsRead()
{
d->markMessagesAsRead(d->timeline.crbegin());
}
bool Room::canSwitchVersions() const
{
if (!successorId().isEmpty())
return false; // No one can upgrade a room that's already upgraded
if (const auto* plEvt = currentState().get<RoomPowerLevelsEvent>()) {
const auto currentUserLevel =
plEvt->powerLevelForUser(localUser()->id());
const auto tombstonePowerLevel =
plEvt->powerLevelForState("m.room.tombstone"_ls);
return currentUserLevel >= tombstonePowerLevel;
}
return true;
}
bool Room::isEventNotable(const TimelineItem &ti) const
{
const auto& evt = *ti;
const auto* rme = ti.viewAs<RoomMessageEvent>();
return !evt.isRedacted()
&& (is<RoomTopicEvent>(evt) || is<RoomNameEvent>(evt)
|| is<RoomAvatarEvent>(evt) || is<RoomTombstoneEvent>(evt)
|| (rme && rme->msgtype() != MessageEventType::Notice
&& rme->replacedEvent().isEmpty()))
&& evt.senderId() != localUser()->id();
}
Notification Room::notificationFor(const TimelineItem &ti) const
{
return d->notifications.value(ti->id());
}
Notification Room::checkForNotifications(const TimelineItem &ti)
{
return { Notification::None };
}
bool Room::hasUnreadMessages() const { return !d->partiallyReadStats.empty(); }
int countFromStats(const EventStats& s)
{
return s.empty() ? -1 : int(s.notableCount);
}
int Room::unreadCount() const { return countFromStats(partiallyReadStats()); }
EventStats Room::partiallyReadStats() const { return d->partiallyReadStats; }
EventStats Room::unreadStats() const { return d->unreadStats; }
Room::rev_iter_t Room::historyEdge() const { return d->historyEdge(); }
Room::Timeline::const_iterator Room::syncEdge() const { return d->syncEdge(); }
TimelineItem::index_t Room::minTimelineIndex() const
{
return d->timeline.empty() ? 0 : d->timeline.front().index();
}
TimelineItem::index_t Room::maxTimelineIndex() const
{
return d->timeline.empty() ? 0 : d->timeline.back().index();
}
bool Room::isValidIndex(TimelineItem::index_t timelineIndex) const
{
return !d->timeline.empty() && timelineIndex >= minTimelineIndex()
&& timelineIndex <= maxTimelineIndex();
}
Room::rev_iter_t Room::findInTimeline(TimelineItem::index_t index) const
{
return historyEdge()
- (isValidIndex(index) ? index - minTimelineIndex() + 1 : 0);
}
Room::rev_iter_t Room::findInTimeline(const QString& evtId) const
{
if (!d->timeline.empty() && d->eventsIndex.contains(evtId)) {
auto it = findInTimeline(d->eventsIndex.value(evtId));
Q_ASSERT(it != historyEdge() && (*it)->id() == evtId);
return it;
}
return historyEdge();
}
Room::PendingEvents::iterator Room::findPendingEvent(const QString& txnId)
{
return std::find_if(d->unsyncedEvents.begin(), d->unsyncedEvents.end(),
[txnId](const auto& item) {
return item->transactionId() == txnId;
});
}
Room::PendingEvents::const_iterator
Room::findPendingEvent(const QString& txnId) const
{
return std::find_if(d->unsyncedEvents.cbegin(), d->unsyncedEvents.cend(),
[txnId](const auto& item) {
return item->transactionId() == txnId;
});
}
const Room::RelatedEvents Room::relatedEvents(
const QString& evtId, EventRelation::reltypeid_t relType) const
{
return d->relations.value({ evtId, relType });
}
const Room::RelatedEvents Room::relatedEvents(
const RoomEvent& evt, EventRelation::reltypeid_t relType) const
{
return relatedEvents(evt.id(), relType);
}
const RoomCreateEvent* Room::creation() const
{
return currentState().get<RoomCreateEvent>();
}
const RoomTombstoneEvent *Room::tombstone() const
{
return currentState().get<RoomTombstoneEvent>();
}
void Room::Private::getAllMembers()
{
// If already loaded or already loading, there's nothing to do here.
if (q->joinedCount() <= membersMap.size() || isJobPending(allMembersJob))
return;
allMembersJob = connection->callApi<GetMembersByRoomJob>(
id, connection->nextBatchToken(), "join");
auto nextIndex = timeline.empty() ? 0 : timeline.back().index() + 1;
connect(allMembersJob, &BaseJob::success, q, [this, nextIndex] {
Q_ASSERT(timeline.empty() || nextIndex <= q->maxTimelineIndex() + 1);
auto roomChanges = updateStateFrom(allMembersJob->chunk());
// Replay member events that arrived after the point for which
// the full members list was requested.
if (!timeline.empty())
for (auto it = q->findInTimeline(nextIndex).base();
it != syncEdge(); ++it)
if (is<RoomMemberEvent>(**it))
roomChanges |= q->processStateEvent(**it);
postprocessChanges(roomChanges);
emit q->allMembersLoaded();
});
}
bool Room::displayed() const { return d->displayed; }
void Room::setDisplayed(bool displayed)
{
if (d->displayed == displayed)
return;
d->displayed = displayed;
emit displayedChanged(displayed);
if (displayed)
d->getAllMembers();
}
QString Room::firstDisplayedEventId() const { return d->firstDisplayedEventId; }
Room::rev_iter_t Room::firstDisplayedMarker() const
{
return findInTimeline(firstDisplayedEventId());
}
void Room::setFirstDisplayedEventId(const QString& eventId)
{
if (d->firstDisplayedEventId == eventId)
return;
if (!eventId.isEmpty() && findInTimeline(eventId) == historyEdge())
qCWarning(MESSAGES)
<< eventId
<< "is marked as first displayed but doesn't seem to be loaded";
d->firstDisplayedEventId = eventId;
emit firstDisplayedEventChanged();
}
void Room::setFirstDisplayedEvent(TimelineItem::index_t index)
{
Q_ASSERT(isValidIndex(index));
setFirstDisplayedEventId(findInTimeline(index)->event()->id());
}
QString Room::lastDisplayedEventId() const { return d->lastDisplayedEventId; }
Room::rev_iter_t Room::lastDisplayedMarker() const
{
return findInTimeline(lastDisplayedEventId());
}
void Room::setLastDisplayedEventId(const QString& eventId)
{
if (d->lastDisplayedEventId == eventId)
return;
const auto marker = findInTimeline(eventId);
if (!eventId.isEmpty() && marker == historyEdge())
qCWarning(MESSAGES)
<< eventId
<< "is marked as last displayed but doesn't seem to be loaded";
d->lastDisplayedEventId = eventId;
emit lastDisplayedEventChanged();
}
void Room::setLastDisplayedEvent(TimelineItem::index_t index)
{
Q_ASSERT(isValidIndex(index));
setLastDisplayedEventId(findInTimeline(index)->event()->id());
}
Room::rev_iter_t Room::readMarker(const User* user) const
{
Q_ASSERT(user);
return findInTimeline(lastReadReceipt(user->id()).eventId);
}
Room::rev_iter_t Room::readMarker() const { return fullyReadMarker(); }
QString Room::readMarkerEventId() const { return lastFullyReadEventId(); }
ReadReceipt Room::lastReadReceipt(const QString& userId) const
{
return d->lastReadReceipts.value(userId);
}
ReadReceipt Room::lastLocalReadReceipt() const
{
return d->lastReadReceipts.value(localUser()->id());
}
Room::rev_iter_t Room::localReadReceiptMarker() const
{
return findInTimeline(lastLocalReadReceipt().eventId);
}
QString Room::lastFullyReadEventId() const { return d->fullyReadUntilEventId; }
Room::rev_iter_t Room::fullyReadMarker() const
{
return findInTimeline(d->fullyReadUntilEventId);
}
QSet<QString> Room::userIdsAtEvent(const QString& eventId)
{
return d->eventIdReadUsers.value(eventId);
}
QSet<User*> Room::usersAtEventId(const QString& eventId)
{
const auto& userIds = d->eventIdReadUsers.value(eventId);
QSet<User*> users;
users.reserve(userIds.size());
for (const auto& uId : userIds)
users.insert(user(uId));
return users;
}
qsizetype Room::notificationCount() const
{
return d->unreadStats.notableCount;
}
void Room::resetNotificationCount()
{
if (d->unreadStats.notableCount == 0)
return;
d->unreadStats.notableCount = 0;
emit notificationCountChanged();
}
qsizetype Room::highlightCount() const { return d->serverHighlightCount; }
void Room::resetHighlightCount()
{
if (d->serverHighlightCount == 0)
return;
d->serverHighlightCount = 0;
emit highlightCountChanged();
}
void Room::switchVersion(QString newVersion)
{
if (!successorId().isEmpty()) {
Q_ASSERT(!successorId().isEmpty());
emit upgradeFailed(tr("The room is already upgraded"));
}
if (auto* job = connection()->callApi<UpgradeRoomJob>(id(), newVersion))
connect(job, &BaseJob::failure, this,
[this, job] { emit upgradeFailed(job->errorString()); });
else
emit upgradeFailed(tr("Couldn't initiate upgrade"));
}
bool Room::hasAccountData(const QString& type) const
{
return d->accountData.find(type) != d->accountData.end();
}
const EventPtr& Room::accountData(const QString& type) const
{
static EventPtr NoEventPtr {};
const auto it = d->accountData.find(type);
return it != d->accountData.end() ? it->second : NoEventPtr;
}
QStringList Room::tagNames() const { return d->tags.keys(); }
TagsMap Room::tags() const { return d->tags; }
TagRecord Room::tag(const QString& name) const { return d->tags.value(name); }
std::pair<bool, QString> validatedTag(QString name)
{
if (name.isEmpty() || name.indexOf('.', 1) != -1)
return { false, name };
qCWarning(MAIN) << "The tag" << name
<< "doesn't follow the CS API conventions";
name.prepend("u.");
qCWarning(MAIN) << "Using " << name << "instead";
return { true, name };
}
void Room::addTag(const QString& name, const TagRecord& record)
{
const auto& checkRes = validatedTag(name);
if (d->tags.contains(name)
|| (checkRes.first && d->tags.contains(checkRes.second)))
return;
emit tagsAboutToChange();
d->tags.insert(checkRes.second, record);
emit tagsChanged();
connection()->callApi<SetRoomTagJob>(localUser()->id(), id(),
checkRes.second, record.order);
}
void Room::addTag(const QString& name, float order)
{
addTag(name, TagRecord { order });
}
void Room::removeTag(const QString& name)
{
if (d->tags.contains(name)) {
emit tagsAboutToChange();
d->tags.remove(name);
emit tagsChanged();
connection()->callApi<DeleteRoomTagJob>(localUser()->id(), id(), name);
} else if (!name.startsWith("u."))
removeTag("u." + name);
else
qCWarning(MAIN) << "Tag" << name << "on room" << objectName()
<< "not found, nothing to remove";
}
void Room::setTags(TagsMap newTags, ActionScope applyOn)
{
bool propagate = applyOn != ActionScope::ThisRoomOnly;
auto joinStates =
applyOn == ActionScope::WithinSameState ? joinState() :
applyOn == ActionScope::OmitLeftState ? JoinState::Join|JoinState::Invite :
JoinState::Join|JoinState::Invite|JoinState::Leave;
if (propagate) {
for (auto* r = this; (r = r->predecessor(joinStates));)
r->setTags(newTags, ActionScope::ThisRoomOnly);
}
d->setTags(move(newTags));
connection()->callApi<SetAccountDataPerRoomJob>(
localUser()->id(), id(), TagEvent::matrixTypeId(),
TagEvent(d->tags).contentJson());
if (propagate) {
for (auto* r = this; (r = r->successor(joinStates));)
r->setTags(d->tags, ActionScope::ThisRoomOnly);
}
}
void Room::Private::setTags(TagsMap&& newTags)
{
emit q->tagsAboutToChange();
const auto keys = newTags.keys();
for (const auto& k : keys)
if (const auto& [adjusted, adjustedTag] = validatedTag(k); adjusted) {
if (newTags.contains(adjustedTag))
newTags.remove(k);
else
newTags.insert(adjustedTag, newTags.take(k));
}
tags = move(newTags);
qCDebug(STATE) << "Room" << q->objectName() << "is tagged with"
<< q->tagNames().join(QStringLiteral(", "));
emit q->tagsChanged();
}
bool Room::isFavourite() const { return d->tags.contains(FavouriteTag); }
bool Room::isLowPriority() const { return d->tags.contains(LowPriorityTag); }
bool Room::isServerNoticeRoom() const
{
return d->tags.contains(ServerNoticeTag);
}
bool Room::isDirectChat() const { return connection()->isDirectChat(id()); }
QList<User*> Room::directChatUsers() const
{
return connection()->directChatUsers(this);
}
QUrl Room::makeMediaUrl(const QString& eventId, const QUrl& mxcUrl) const
{
auto url = connection()->makeMediaUrl(mxcUrl);
QUrlQuery q(url.query());
Q_ASSERT(q.hasQueryItem("user_id"));
q.addQueryItem("room_id", id());
q.addQueryItem("event_id", eventId);
url.setQuery(q);
return url;
}
QString safeFileName(QString rawName)
{
return rawName.replace(QRegularExpression("[/\\<>|\"*?:]"), "_");
}
const RoomMessageEvent*
Room::Private::getEventWithFile(const QString& eventId) const
{
auto evtIt = q->findInTimeline(eventId);
if (evtIt != timeline.rend() && is<RoomMessageEvent>(**evtIt)) {
auto* event = evtIt->viewAs<RoomMessageEvent>();
if (event->hasFileContent())
return event;
}
qCWarning(MAIN) << "No files to download in event" << eventId;
return nullptr;
}
QString Room::Private::fileNameToDownload(const RoomMessageEvent* event) const
{
Q_ASSERT(event && event->hasFileContent());
const auto* fileInfo = event->content()->fileInfo();
QString fileName;
if (!fileInfo->originalName.isEmpty())
fileName = QFileInfo(safeFileName(fileInfo->originalName)).fileName();
else if (QUrl u { event->plainBody() }; u.isValid()) {
qDebug(MAIN) << event->id()
<< "has no file name supplied but the event body "
"looks like a URL - using the file name from it";
fileName = u.fileName();
}
if (fileName.isEmpty())
return safeFileName(fileInfo->mediaId()).replace('.', '-') % '.'
% fileInfo->mimeType.preferredSuffix();
if (QSysInfo::productType() == "windows") {
if (const auto& suffixes = fileInfo->mimeType.suffixes();
!suffixes.isEmpty()
&& std::none_of(suffixes.begin(), suffixes.end(),
[&fileName](const QString& s) {
return fileName.endsWith(s);
}))
return fileName % '.' % fileInfo->mimeType.preferredSuffix();
}
return fileName;
}
QUrl Room::urlToThumbnail(const QString& eventId) const
{
if (auto* event = d->getEventWithFile(eventId))
if (event->hasThumbnail()) {
auto* thumbnail = event->content()->thumbnailInfo();
Q_ASSERT(thumbnail != nullptr);
return connection()->getUrlForApi<MediaThumbnailJob>(
thumbnail->url(), thumbnail->imageSize);
}
qCDebug(MAIN) << "Event" << eventId << "has no thumbnail";
return {};
}
QUrl Room::urlToDownload(const QString& eventId) const
{
if (auto* event = d->getEventWithFile(eventId)) {
auto* fileInfo = event->content()->fileInfo();
Q_ASSERT(fileInfo != nullptr);
return connection()->getUrlForApi<DownloadFileJob>(fileInfo->url());
}
return {};
}
QString Room::fileNameToDownload(const QString& eventId) const
{
if (auto* event = d->getEventWithFile(eventId))
return d->fileNameToDownload(event);
return {};
}
FileTransferInfo Room::fileTransferInfo(const QString& id) const
{
const auto infoIt = d->fileTransfers.constFind(id);
if (infoIt == d->fileTransfers.cend())
return {};
// FIXME: Add lib tests to make sure FileTransferInfo::status stays
// consistent with FileTransferInfo::job
qint64 progress = infoIt->progress;
qint64 total = infoIt->total;
if (total > INT_MAX) {
// JavaScript doesn't deal with 64-bit integers; scale down if necessary
progress = llround(double(progress) / total * INT_MAX);
total = INT_MAX;
}
return { infoIt->status,
infoIt->isUpload,
int(progress),
int(total),
QUrl::fromLocalFile(infoIt->localFileInfo.absolutePath()),
QUrl::fromLocalFile(infoIt->localFileInfo.absoluteFilePath()) };
}
QUrl Room::fileSource(const QString& id) const
{
auto url = urlToDownload(id);
if (url.isValid())
return url;
// No urlToDownload means it's a pending or completed upload.
auto infoIt = d->fileTransfers.constFind(id);
if (infoIt != d->fileTransfers.cend())
return QUrl::fromLocalFile(infoIt->localFileInfo.absoluteFilePath());
qCWarning(MAIN) << "File source for identifier" << id << "not found";
return {};
}
QString Room::prettyPrint(const QString& plainText) const
{
return Quotient::prettyPrint(plainText);
}
QList<User*> Room::usersTyping() const { return d->usersTyping; }
QList<User*> Room::membersLeft() const { return d->membersLeft; }
QList<User*> Room::users() const { return d->membersMap.values(); }
QStringList Room::memberNames() const
{
return safeMemberNames();
}
QStringList Room::safeMemberNames() const
{
QStringList res;
res.reserve(d->membersMap.size());
for (const auto* u: std::as_const(d->membersMap))
res.append(safeMemberName(u->id()));
return res;
}
QStringList Room::htmlSafeMemberNames() const
{
QStringList res;
res.reserve(d->membersMap.size());
for (const auto* u: std::as_const(d->membersMap))
res.append(htmlSafeMemberName(u->id()));
return res;
}
int Room::timelineSize() const { return int(d->timeline.size()); }
bool Room::usesEncryption() const
{
return !currentState()
.queryOr(&EncryptionEvent::algorithm, QString())
.isEmpty();
}
const StateEventBase* Room::getCurrentState(const QString& evtType,
const QString& stateKey) const
{
return d->getCurrentState({ evtType, stateKey });
}
RoomStateView Room::currentState() const
{
return d->currentState;
}
RoomEventPtr Room::decryptMessage(const EncryptedEvent& encryptedEvent)
{
#ifndef Quotient_E2EE_ENABLED
Q_UNUSED(encryptedEvent)
qCWarning(E2EE) << "End-to-end encryption (E2EE) support is turned off.";
return {};
#else // Quotient_E2EE_ENABLED
if (encryptedEvent.algorithm() != MegolmV1AesSha2AlgoKey) {
qWarning(E2EE) << "Algorithm of the encrypted event with id"
<< encryptedEvent.id() << "is not decryptable by the current device";
return {};
}
QString decrypted = d->groupSessionDecryptMessage(
encryptedEvent.ciphertext(), encryptedEvent.sessionId(),
encryptedEvent.id(), encryptedEvent.originTimestamp(),
encryptedEvent.senderId());
if (decrypted.isEmpty()) {
// qCWarning(E2EE) << "Encrypted message is empty";
return {};
}
auto decryptedEvent = encryptedEvent.createDecrypted(decrypted);
if (decryptedEvent->roomId() == id()) {
return decryptedEvent;
}
qCWarning(E2EE) << "Decrypted event" << encryptedEvent.id() << "not for this room; discarding.";
return {};
#endif // Quotient_E2EE_ENABLED
}
void Room::handleRoomKeyEvent(const RoomKeyEvent& roomKeyEvent,
const QString& senderId,
const QString& olmSessionId)
{
#ifndef Quotient_E2EE_ENABLED
Q_UNUSED(roomKeyEvent)
Q_UNUSED(senderId)
Q_UNUSED(olmSessionId)
qCWarning(E2EE) << "End-to-end encryption (E2EE) support is turned off.";
#else // Quotient_E2EE_ENABLED
if (roomKeyEvent.algorithm() != MegolmV1AesSha2AlgoKey) {
qCWarning(E2EE) << "Ignoring unsupported algorithm"
<< roomKeyEvent.algorithm() << "in m.room_key event";
}
if (d->addInboundGroupSession(roomKeyEvent.sessionId(),
roomKeyEvent.sessionKey(), senderId,
olmSessionId)) {
qCWarning(E2EE) << "added new inboundGroupSession:"
<< d->groupSessions.size();
auto undecryptedEvents = d->undecryptedEvents[roomKeyEvent.sessionId()];
for (const auto& eventId : undecryptedEvents) {
const auto pIdx = d->eventsIndex.constFind(eventId);
if (pIdx == d->eventsIndex.cend())
continue;
auto& ti = d->timeline[Timeline::size_type(*pIdx - minTimelineIndex())];
if (auto encryptedEvent = ti.viewAs<EncryptedEvent>()) {
if (auto decrypted = decryptMessage(*encryptedEvent)) {
// The reference will survive the pointer being moved
auto& decryptedEvent = *decrypted;
auto oldEvent = ti.replaceEvent(std::move(decrypted));
decryptedEvent.setOriginalEvent(std::move(oldEvent));
emit replacedEvent(ti.event(), decryptedEvent.originalEvent());
d->undecryptedEvents[roomKeyEvent.sessionId()] -= eventId;
}
}
}
}
#endif // Quotient_E2EE_ENABLED
}
int Room::joinedCount() const
{
return d->summary.joinedMemberCount.value_or(d->membersMap.size());
}
int Room::invitedCount() const
{
// TODO: Store invited users in Room too
Q_ASSERT(d->summary.invitedMemberCount.has_value());
return d->summary.invitedMemberCount.value_or(0);
}
int Room::totalMemberCount() const { return joinedCount() + invitedCount(); }
GetRoomEventsJob* Room::eventsHistoryJob() const { return d->eventsHistoryJob; }
Room::Changes Room::Private::setSummary(RoomSummary&& newSummary)
{
if (!summary.merge(newSummary))
return Change::None;
qCDebug(STATE).nospace().noquote()
<< "Updated room summary for " << q->objectName() << ": " << summary;
return Change::Summary;
}
void Room::Private::insertMemberIntoMap(User* u)
{
const auto maybeUserName =
currentState.query(u->id(), &RoomMemberEvent::newDisplayName);
if (!maybeUserName)
qCWarning(MEMBERS) << "insertMemberIntoMap():" << u->id()
<< "has no name (even empty)";
const auto userName = maybeUserName.value_or(QString());
const auto namesakes = membersMap.values(userName);
qCDebug(MEMBERS) << "insertMemberIntoMap(), user" << u->id()
<< "with name" << userName << '-'
<< namesakes.size() << "namesake(s) found";
// Callers should make sure they are not adding an existing user once more
Q_ASSERT(!namesakes.contains(u));
if (namesakes.contains(u)) { // Release version whines but continues
qCCritical(MEMBERS) << "Trying to add a user" << u->id() << "to room"
<< q->objectName() << "but that's already in it";
return;
}
// If there is exactly one namesake of the added user, signal member
// renaming for that other one because the two should be disambiguated now
if (namesakes.size() == 1)
emit q->memberAboutToRename(namesakes.front(),
namesakes.front()->fullName(q));
membersMap.insert(userName, u);
if (namesakes.size() == 1)
emit q->memberRenamed(namesakes.front());
}
void Room::Private::removeMemberFromMap(User* u)
{
const auto userName = currentState.queryOr(u->id(),
&RoomMemberEvent::newDisplayName,
QString());
qCDebug(MEMBERS) << "removeMemberFromMap(), username" << userName
<< "for user" << u->id();
User* namesake = nullptr;
auto namesakes = membersMap.values(userName);
// If there was one namesake besides the removed user, signal member
// renaming for it because it doesn't need to be disambiguated any more.
if (namesakes.size() == 2) {
namesake =
namesakes.front() == u ? namesakes.back() : namesakes.front();
Q_ASSERT_X(namesake != u, __FUNCTION__, "Room members list is broken");
emit q->memberAboutToRename(namesake, userName);
}
if (membersMap.remove(userName, u) == 0) {
qCDebug(MEMBERS) << "No entries removed; checking the whole list";
// Unless at the stage of initial filling, this no removed entries
// is suspicious; double-check that this user is not found in
// the whole map, and stop (for debug builds) or shout in the logs
// (for release builds) if there's one. That search is O(n), which
// may come rather expensive for larger rooms.
QElapsedTimer et;
auto it = std::find(membersMap.cbegin(), membersMap.cend(), u);
if (et.nsecsElapsed() > profilerMinNsecs() / 10)
qCDebug(MEMBERS) << "...done in" << et;
if (it != membersMap.cend()) {
// The assert (still) does more harm than good, it seems
// Q_ASSERT_X(false, __FUNCTION__,
// "Mismatched name in the room members list");
qCCritical(MEMBERS) << "Mismatched name in the room members list;"
" avoiding the list corruption";
membersMap.remove(it.key(), u);
}
}
if (namesake)
emit q->memberRenamed(namesake);
}
inline auto makeErrorStr(const Event& e, QByteArray msg)
{
return msg.append("; event dump follows:\n")
.append(QJsonDocument(e.fullJson()).toJson());
}
Room::Timeline::size_type
Room::Private::moveEventsToTimeline(RoomEventsRange events,
EventsPlacement placement)
{
Q_ASSERT(!events.empty());
// Historical messages arrive in newest-to-oldest order, so the process for
// them is almost symmetric to the one for new messages. New messages get
// appended from index 0; old messages go backwards from index -1.
auto index = timeline.empty()
? -((placement + 1) / 2) /* 1 -> -1; -1 -> 0 */
: placement == Older ? timeline.front().index()
: timeline.back().index();
auto baseIndex = index;
for (auto&& e : events) {
const auto eId = e->id();
Q_ASSERT_X(e, __FUNCTION__, "Attempt to add nullptr to timeline");
Q_ASSERT_X(
!eId.isEmpty(), __FUNCTION__,
makeErrorStr(*e, "Event with empty id cannot be in the timeline"));
Q_ASSERT_X(
!eventsIndex.contains(eId), __FUNCTION__,
makeErrorStr(*e, "Event is already in the timeline; "
"incoming events were not properly deduplicated"));
const auto& ti = placement == Older
? timeline.emplace_front(move(e), --index)
: timeline.emplace_back(move(e), ++index);
eventsIndex.insert(eId, index);
if (auto n = q->checkForNotifications(ti); n.type != Notification::None)
notifications.insert(e->id(), n);
Q_ASSERT(q->findInTimeline(eId)->event()->id() == eId);
}
const auto insertedSize = (index - baseIndex) * placement;
Q_ASSERT(insertedSize == int(events.size()));
return Timeline::size_type(insertedSize);
}
QString Room::memberName(const QString& mxId) const
{
// See https://github.com/matrix-org/matrix-doc/issues/1375
if (const auto rme = currentState().get<RoomMemberEvent>(mxId)) {
if (rme->newDisplayName())
return *rme->newDisplayName();
if (rme->prevContent() && rme->prevContent()->displayName)
return *rme->prevContent()->displayName;
}
return {};
}
QString Room::roomMembername(const User* u) const
{
Q_ASSERT(u != nullptr);
return disambiguatedMemberName(u->id());
}
QString Room::roomMembername(const QString& userId) const
{
return disambiguatedMemberName(userId);
}
inline QString makeFullUserName(const QString& displayName, const QString& mxId)
{
return displayName % " (" % mxId % ')';
}
QString Room::disambiguatedMemberName(const QString& mxId) const
{
// See the CS spec, section 11.2.2.3
const auto username = memberName(mxId);
if (username.isEmpty())
return mxId;
auto namesakesIt = qAsConst(d->membersMap).find(username);
// We expect a user to be a member of the room - but technically it is
// possible to invoke this function even for non-members. In such case
// we return the full name, just in case.
if (namesakesIt == d->membersMap.cend())
return makeFullUserName(username, mxId);
auto nextUserIt = namesakesIt;
if (++nextUserIt == d->membersMap.cend() || nextUserIt.key() != username)
return username; // No disambiguation necessary
return makeFullUserName(username, mxId); // Disambiguate fully
}
QString Room::safeMemberName(const QString& userId) const
{
return sanitized(disambiguatedMemberName(userId));
}
QString Room::htmlSafeMemberName(const QString& userId) const
{
return safeMemberName(userId).toHtmlEscaped();
}
QUrl Room::memberAvatarUrl(const QString &mxId) const
{
// See https://github.com/matrix-org/matrix-doc/issues/1375
if (const auto rme = currentState().get<RoomMemberEvent>(mxId)) {
if (rme->newAvatarUrl())
return *rme->newAvatarUrl();
if (rme->prevContent() && rme->prevContent()->avatarUrl)
return *rme->prevContent()->avatarUrl;
}
return {};
}
Room::Changes Room::Private::updateStatsFromSyncData(const SyncRoomData& data,
bool fromCache)
{
Changes changes {};
if (fromCache) {
// Initial load of cached statistics
partiallyReadStats =
EventStats::fromCachedCounters(data.partiallyReadCount);
unreadStats = EventStats::fromCachedCounters(data.unreadCount,
data.highlightCount);
// Migrate from lib 0.6: -1 in the old unread counter overrides 0
// (which loads to an estimate) in notification_count. Next caching will
// save -1 in both places, completing the migration.
if (data.unreadCount == 0 && data.partiallyReadCount == -1)
unreadStats.isEstimate = false;
changes |= Change::PartiallyReadStats | Change::UnreadStats;
qCDebug(MESSAGES) << "Loaded" << q->objectName()
<< "event statistics from cache:" << partiallyReadStats
<< "since m.fully_read," << unreadStats
<< "since m.read";
} else if (timeline.empty()) {
// In absence of actual events use statistics from the homeserver
if (merge(unreadStats.notableCount, data.unreadCount))
changes |= Change::PartiallyReadStats;
if (merge(unreadStats.highlightCount, data.highlightCount))
changes |= Change::UnreadStats;
unreadStats.isEstimate = !data.unreadCount.has_value()
|| *data.unreadCount > 0;
qCDebug(MESSAGES)
<< "Using server-side unread event statistics while the"
<< q->objectName() << "timeline is empty:" << unreadStats;
}
bool correctedStats = false;
if (unreadStats.highlightCount > partiallyReadStats.highlightCount) {
correctedStats = true;
partiallyReadStats.highlightCount = unreadStats.highlightCount;
partiallyReadStats.isEstimate |= unreadStats.isEstimate;
}
if (unreadStats.notableCount > partiallyReadStats.notableCount) {
correctedStats = true;
partiallyReadStats.notableCount = unreadStats.notableCount;
partiallyReadStats.isEstimate |= unreadStats.isEstimate;
}
if (!unreadStats.isEstimate && partiallyReadStats.isEstimate) {
correctedStats = true;
partiallyReadStats.isEstimate = true;
}
if (correctedStats)
qCDebug(MESSAGES) << "Partially read event statistics in"
<< q->objectName() << "were adjusted to"
<< partiallyReadStats
<< "to be consistent with the m.read receipt";
Q_ASSERT(partiallyReadStats.isValidFor(q, q->fullyReadMarker()));
Q_ASSERT(unreadStats.isValidFor(q, q->localReadReceiptMarker()));
// TODO: Once the library learns to count highlights, drop
// serverHighlightCount and only use the server-side counter when
// the timeline is empty (see the code above).
if (merge(serverHighlightCount, data.highlightCount)) {
qCDebug(MESSAGES) << "Updated highlights number in" << q->objectName()
<< "to" << serverHighlightCount;
changes |= Change::Highlights;
}
return changes;
}
void Room::updateData(SyncRoomData&& data, bool fromCache)
{
qCDebug(MAIN) << "--- Updating room" << id() << "/" << objectName();
bool firstUpdate = d->baseState.empty();
if (d->prevBatch.isEmpty())
d->prevBatch = data.timelinePrevBatch;
setJoinState(data.joinState);
Changes roomChanges {};
// The order of calculation is important - don't merge the lines!
roomChanges |= d->updateStateFrom(data.state);
roomChanges |= d->setSummary(move(data.summary));
roomChanges |= d->addNewMessageEvents(move(data.timeline));
for (auto&& ephemeralEvent : data.ephemeral)
roomChanges |= processEphemeralEvent(move(ephemeralEvent));
for (auto&& event : data.accountData)
roomChanges |= processAccountDataEvent(move(event));
roomChanges |= d->updateStatsFromSyncData(data, fromCache);
if (roomChanges & Change::Topic)
emit topicChanged();
if (roomChanges & (Change::Name | Change::Aliases))
emit namesChanged(this);
d->postprocessChanges(roomChanges, !fromCache);
if (firstUpdate)
emit baseStateLoaded();
qCDebug(MAIN) << "--- Finished updating room" << id() << "/" << objectName();
}
void Room::Private::postprocessChanges(Changes changes, bool saveState)
{
if (!changes)
return;
if (changes & Change::Members)
emit q->memberListChanged();
if (changes
& (Change::Name | Change::Aliases | Change::Members | Change::Summary))
updateDisplayname();
if (changes & Change::PartiallyReadStats) {
emit q->unreadMessagesChanged(q); // TODO: remove in 0.8
emit q->partiallyReadStatsChanged();
}
if (changes & Change::UnreadStats)
emit q->unreadStatsChanged();
if (changes & Change::Highlights)
emit q->highlightCountChanged();
qCDebug(MAIN) << terse << changes << "= hex" << Qt::hex << uint(changes)
<< "in" << q->objectName();
emit q->changed(changes);
if (saveState)
connection->saveRoomState(q);
}
RoomEvent* Room::Private::addAsPending(RoomEventPtr&& event)
{
if (event->transactionId().isEmpty())
event->setTransactionId(connection->generateTxnId());
if (event->roomId().isEmpty())
event->setRoomId(id);
if (event->senderId().isEmpty())
event->setSender(connection->userId());
auto* pEvent = rawPtr(event);
emit q->pendingEventAboutToAdd(pEvent);
unsyncedEvents.emplace_back(move(event));
emit q->pendingEventAdded();
return pEvent;
}
QString Room::Private::sendEvent(RoomEventPtr&& event)
{
if (!q->successorId().isEmpty()) {
qCWarning(MAIN) << q << "has been upgraded, event won't be sent";
return {};
}
return doSendEvent(addAsPending(std::move(event)));
}
QString Room::Private::doSendEvent(const RoomEvent* pEvent)
{
const auto txnId = pEvent->transactionId();
// TODO, #133: Enqueue the job rather than immediately trigger it.
const RoomEvent* _event = pEvent;
std::unique_ptr<EncryptedEvent> encryptedEvent;
if (q->usesEncryption()) {
#ifndef Quotient_E2EE_ENABLED
qWarning() << "This build of libQuotient does not support E2EE.";
return {};
#else
if (!hasValidMegolmSession() || shouldRotateMegolmSession()) {
createMegolmSession();
}
sendMegolmSession(getDevicesWithoutKey());
const auto encrypted = currentOutboundMegolmSession->encrypt(QJsonDocument(pEvent->fullJson()).toJson());
currentOutboundMegolmSession->setMessageCount(currentOutboundMegolmSession->messageCount() + 1);
connection->saveCurrentOutboundMegolmSession(
id, *currentOutboundMegolmSession);
if(!encrypted) {
qWarning(E2EE) << "Error encrypting message" << encrypted.error();
return {};
}
encryptedEvent = makeEvent<EncryptedEvent>(*encrypted, q->connection()->olmAccount()->identityKeys().curve25519, q->connection()->deviceId(), currentOutboundMegolmSession->sessionId());
encryptedEvent->setTransactionId(connection->generateTxnId());
encryptedEvent->setRoomId(id);
encryptedEvent->setSender(connection->userId());
if(pEvent->contentJson().contains("m.relates_to"_ls)) {
encryptedEvent->setRelation(pEvent->contentJson()["m.relates_to"_ls].toObject());
}
// We show the unencrypted event locally while pending. The echo check will throw the encrypted version out
_event = encryptedEvent.get();
#endif
}
if (auto call =
connection->callApi<SendMessageJob>(BackgroundRequest, id,
_event->matrixType(), txnId,
_event->contentJson())) {
Room::connect(call, &BaseJob::sentRequest, q, [this, txnId] {
auto it = q->findPendingEvent(txnId);
if (it == unsyncedEvents.end()) {
qWarning(EVENTS) << "Pending event for transaction" << txnId
<< "not found - got synced so soon?";
return;
}
it->setDeparted();
emit q->pendingEventChanged(int(it - unsyncedEvents.begin()));
});
Room::connect(call, &BaseJob::result, q, [this, txnId, call] {
if (!call->status().good()) {
onEventSendingFailure(txnId, call);
return;
}
auto it = q->findPendingEvent(txnId);
if (it != unsyncedEvents.end()) {
if (it->deliveryStatus() != EventStatus::ReachedServer) {
it->setReachedServer(call->eventId());
emit q->pendingEventChanged(int(it - unsyncedEvents.begin()));
}
} else
qDebug(EVENTS) << "Pending event for transaction" << txnId
<< "already merged";
emit q->messageSent(txnId, call->eventId());
});
} else
onEventSendingFailure(txnId);
return txnId;
}
void Room::Private::onEventSendingFailure(const QString& txnId, BaseJob* call)
{
auto it = q->findPendingEvent(txnId);
if (it == unsyncedEvents.end()) {
qCritical(EVENTS) << "Pending event for transaction" << txnId
<< "could not be sent";
return;
}
it->setSendingFailed(call ? call->statusCaption() % ": " % call->errorString()
: tr("The call could not be started"));
emit q->pendingEventChanged(int(it - unsyncedEvents.begin()));
}
QString Room::retryMessage(const QString& txnId)
{
const auto it = findPendingEvent(txnId);
Q_ASSERT(it != d->unsyncedEvents.end());
qCDebug(EVENTS) << "Retrying transaction" << txnId;
const auto& transferIt = d->fileTransfers.constFind(txnId);
if (transferIt != d->fileTransfers.cend()) {
Q_ASSERT(transferIt->isUpload);
if (transferIt->status == FileTransferInfo::Completed) {
qCDebug(MESSAGES)
<< "File for transaction" << txnId
<< "has already been uploaded, bypassing re-upload";
} else {
if (isJobPending(transferIt->job)) {
qCDebug(MESSAGES) << "Abandoning the upload job for transaction"
<< txnId << "and starting again";
transferIt->job->abandon();
emit fileTransferFailed(txnId,
tr("File upload will be retried"));
}
uploadFile(txnId, QUrl::fromLocalFile(
transferIt->localFileInfo.absoluteFilePath()));
// FIXME: Content type is no more passed here but it should
}
}
if (it->deliveryStatus() == EventStatus::ReachedServer) {
qCWarning(MAIN)
<< "The previous attempt has reached the server; two"
" events are likely to be in the timeline after retry";
}
it->resetStatus();
emit pendingEventChanged(int(it - d->unsyncedEvents.begin()));
return d->doSendEvent(it->event());
}
// Using a function defers actual tr() invocation to the moment when
// translations are initialised
auto FileTransferCancelledMsg() { return Room::tr("File transfer cancelled"); }
void Room::discardMessage(const QString& txnId)
{
auto it = std::find_if(d->unsyncedEvents.begin(), d->unsyncedEvents.end(),
[txnId](const auto& evt) {
return evt->transactionId() == txnId;
});
Q_ASSERT(it != d->unsyncedEvents.end());
qCDebug(EVENTS) << "Discarding transaction" << txnId;
const auto& transferIt = d->fileTransfers.find(txnId);
if (transferIt != d->fileTransfers.end()) {
Q_ASSERT(transferIt->isUpload);
if (isJobPending(transferIt->job)) {
transferIt->status = FileTransferInfo::Cancelled;
transferIt->job->abandon();
emit fileTransferFailed(txnId, FileTransferCancelledMsg());
} else if (transferIt->status == FileTransferInfo::Completed) {
qCWarning(MAIN)
<< "File for transaction" << txnId
<< "has been uploaded but the message was discarded";
}
}
emit pendingEventAboutToDiscard(int(it - d->unsyncedEvents.begin()));
d->unsyncedEvents.erase(it);
emit pendingEventDiscarded();
}
QString Room::postMessage(const QString& plainText, MessageEventType type)
{
return d->sendEvent<RoomMessageEvent>(plainText, type);
}
QString Room::postPlainText(const QString& plainText)
{
return postMessage(plainText, MessageEventType::Text);
}
QString Room::postHtmlMessage(const QString& plainText, const QString& html,
MessageEventType type)
{
return d->sendEvent<RoomMessageEvent>(
plainText, type,
new EventContent::TextContent(html, QStringLiteral("text/html")));
}
QString Room::postHtmlText(const QString& plainText, const QString& html)
{
return postHtmlMessage(plainText, html);
}
QString Room::postReaction(const QString& eventId, const QString& key)
{
return d->sendEvent<ReactionEvent>(EventRelation::annotate(eventId, key));
}
QString Room::Private::doPostFile(RoomEventPtr&& msgEvent, const QUrl& localUrl)
{
const auto txnId = addAsPending(move(msgEvent))->transactionId();
// Remote URL will only be known after upload; fill in the local path
// to enable the preview while the event is pending.
q->uploadFile(txnId, localUrl);
// Below, the upload job is used as a context object to clean up connections
const auto& transferJob = fileTransfers.value(txnId).job;
connect(q, &Room::fileTransferCompleted, transferJob,
[this, txnId](const QString& tId, const QUrl&,
const FileSourceInfo& fileMetadata) {
if (tId != txnId)
return;
const auto it = q->findPendingEvent(txnId);
if (it != unsyncedEvents.end()) {
it->setFileUploaded(fileMetadata);
emit q->pendingEventChanged(int(it - unsyncedEvents.begin()));
doSendEvent(it->get());
} else {
// Normally in this situation we should instruct
// the media server to delete the file; alas, there's no
// API specced for that.
qCWarning(MAIN)
<< "File uploaded to" << getUrlFromSourceInfo(fileMetadata)
<< "but the event referring to it was "
"cancelled";
}
});
connect(q, &Room::fileTransferFailed, transferJob,
[this, txnId](const QString& tId) {
if (tId != txnId)
return;
const auto it = q->findPendingEvent(txnId);
if (it == unsyncedEvents.end())
return;
const auto idx = int(it - unsyncedEvents.begin());
emit q->pendingEventAboutToDiscard(idx);
// See #286 on why `it` may not be valid here.
unsyncedEvents.erase(unsyncedEvents.begin() + idx);
emit q->pendingEventDiscarded();
});
return txnId;
}
QString Room::postFile(const QString& plainText,
EventContent::TypedBase* content)
{
Q_ASSERT(content != nullptr && content->fileInfo() != nullptr);
const auto* const fileInfo = content->fileInfo();
Q_ASSERT(fileInfo != nullptr);
QFileInfo localFile { fileInfo->url().toLocalFile() };
Q_ASSERT(localFile.isFile());
return d->doPostFile(
makeEvent<RoomMessageEvent>(
plainText, RoomMessageEvent::rawMsgTypeForFile(localFile), content),
fileInfo->url());
}
#if QT_VERSION_MAJOR < 6
QString Room::postFile(const QString& plainText, const QUrl& localPath,
bool asGenericFile)
{
QFileInfo localFile { localPath.toLocalFile() };
Q_ASSERT(localFile.isFile());
return d->doPostFile(makeEvent<RoomMessageEvent>(plainText, localFile,
asGenericFile),
localPath);
}
#endif
QString Room::postEvent(RoomEvent* event)
{
return d->sendEvent(RoomEventPtr(event));
}
QString Room::postJson(const QString& matrixType,
const QJsonObject& eventContent)
{
return d->sendEvent(loadEvent<RoomEvent>(matrixType, eventContent));
}
SetRoomStateWithKeyJob* Room::setState(const StateEventBase& evt)
{
return setState(evt.matrixType(), evt.stateKey(), evt.contentJson());
}
SetRoomStateWithKeyJob* Room::setState(const QString& evtType,
const QString& stateKey,
const QJsonObject& contentJson)
{
return d->requestSetState(evtType, stateKey, contentJson);
}
void Room::setName(const QString& newName)
{
setState<RoomNameEvent>(newName);
}
void Room::setCanonicalAlias(const QString& newAlias)
{
setState<RoomCanonicalAliasEvent>(newAlias, altAliases());
}
void Room::setPinnedEvents(const QStringList& events)
{
setState<RoomPinnedEvent>(events);
}
void Room::setLocalAliases(const QStringList& aliases)
{
setState<RoomCanonicalAliasEvent>(canonicalAlias(), aliases);
}
void Room::setTopic(const QString& newTopic)
{
setState<RoomTopicEvent>(newTopic);
}
bool isEchoEvent(const RoomEventPtr& le, const PendingEventItem& re)
{
if (le->type() != re->type())
return false;
if (!re->id().isEmpty())
return le->id() == re->id();
if (!re->transactionId().isEmpty())
return le->transactionId() == re->transactionId();
// This one is not reliable (there can be two unsynced
// events with the same type, sender and state key) but
// it's the best we have for state events.
if (re->isStateEvent())
return le->stateKey() == re->stateKey();
// Empty id and no state key, hmm... (shrug)
return le->contentJson() == re->contentJson();
}
bool Room::supportsCalls() const { return joinedCount() == 2; }
void Room::checkVersion()
{
const auto defaultVersion = connection()->defaultRoomVersion();
const auto stableVersions = connection()->stableRoomVersions();
Q_ASSERT(!defaultVersion.isEmpty());
// This method is only called after the base state has been loaded
// or the server capabilities have been loaded.
emit stabilityUpdated(defaultVersion, stableVersions);
if (!stableVersions.contains(version())) {
qCDebug(STATE) << this << "version is" << version()
<< "which the server doesn't count as stable";
if (canSwitchVersions())
qCDebug(STATE)
<< "The current user has enough privileges to fix it";
}
}
void Room::inviteCall(const QString& callId, const int lifetime,
const QString& sdp)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallInviteEvent>(callId, lifetime, sdp);
}
void Room::sendCallCandidates(const QString& callId,
const QJsonArray& candidates)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallCandidatesEvent>(callId, candidates);
}
void Room::answerCall(const QString& callId, [[maybe_unused]] int lifetime,
const QString& sdp)
{
qCWarning(MAIN) << "To client developer: drop lifetime parameter from "
"Room::answerCall(), it is no more accepted";
answerCall(callId, sdp);
}
void Room::answerCall(const QString& callId, const QString& sdp)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallAnswerEvent>(callId, sdp);
}
void Room::hangupCall(const QString& callId)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallHangupEvent>(callId);
}
void Room::getPreviousContent(int limit, const QString& filter)
{
d->getPreviousContent(limit, filter);
}
void Room::Private::getPreviousContent(int limit, const QString &filter)
{
if (isJobPending(eventsHistoryJob))
return;
eventsHistoryJob = connection->callApi<GetRoomEventsJob>(id, "b", prevBatch,
"", limit, filter);
emit q->eventsHistoryJobChanged();
connect(eventsHistoryJob, &BaseJob::success, q, [this] {
prevBatch = eventsHistoryJob->end();
addHistoricalMessageEvents(eventsHistoryJob->chunk());
});
connect(eventsHistoryJob, &QObject::destroyed, q,
&Room::eventsHistoryJobChanged);
}
void Room::inviteToRoom(const QString& memberId)
{
connection()->callApi<InviteUserJob>(id(), memberId);
}
LeaveRoomJob* Room::leaveRoom()
{
// FIXME, #63: It should be RoomManager, not Connection
return connection()->leaveRoom(this);
}
void Room::kickMember(const QString& memberId, const QString& reason)
{
connection()->callApi<KickJob>(id(), memberId, reason);
}
void Room::ban(const QString& userId, const QString& reason)
{
connection()->callApi<BanJob>(id(), userId, reason);
}
void Room::unban(const QString& userId)
{
connection()->callApi<UnbanJob>(id(), userId);
}
void Room::redactEvent(const QString& eventId, const QString& reason)
{
connection()->callApi<RedactEventJob>(id(), QUrl::toPercentEncoding(eventId),
connection()->generateTxnId(), reason);
}
void Room::uploadFile(const QString& id, const QUrl& localFilename,
const QString& overrideContentType)
{
Q_ASSERT_X(localFilename.isLocalFile(), __FUNCTION__,
"localFilename should point at a local file");
auto fileName = localFilename.toLocalFile();
FileSourceInfo fileMetadata;
#ifdef Quotient_E2EE_ENABLED
QTemporaryFile tempFile;
if (usesEncryption()) {
tempFile.open();
QFile file(localFilename.toLocalFile());
file.open(QFile::ReadOnly);
QByteArray data;
std::tie(fileMetadata, data) = encryptFile(file.readAll());
tempFile.write(data);
tempFile.close();
fileName = QFileInfo(tempFile).absoluteFilePath();
}
#endif
auto job = connection()->uploadFile(fileName, overrideContentType);
if (isJobPending(job)) {
d->fileTransfers[id] = { job, fileName, true };
connect(job, &BaseJob::uploadProgress, this,
[this, id](qint64 sent, qint64 total) {
d->fileTransfers[id].update(sent, total);
emit fileTransferProgress(id, sent, total);
});
connect(job, &BaseJob::success, this,
[this, id, localFilename, job, fileMetadata]() mutable {
// The lambda is mutable to change encryptedFileMetadata
d->fileTransfers[id].status = FileTransferInfo::Completed;
setUrlInSourceInfo(fileMetadata, QUrl(job->contentUri()));
emit fileTransferCompleted(id, localFilename, fileMetadata);
});
connect(job, &BaseJob::failure, this,
std::bind(&Private::failedTransfer, d, id, job->errorString()));
emit newFileTransfer(id, localFilename);
} else
d->failedTransfer(id);
}
void Room::downloadFile(const QString& eventId, const QUrl& localFilename)
{
if (auto ongoingTransfer = d->fileTransfers.constFind(eventId);
ongoingTransfer != d->fileTransfers.cend()
&& ongoingTransfer->status == FileTransferInfo::Started) {
qCWarning(MAIN) << "Transfer for" << eventId
<< "is ongoing; download won't start";
return;
}
Q_ASSERT_X(localFilename.isEmpty() || localFilename.isLocalFile(),
__FUNCTION__, "localFilename should point at a local file");
const auto* event = d->getEventWithFile(eventId);
if (!event) {
qCCritical(MAIN)
<< eventId << "is not in the local timeline or has no file content";
Q_ASSERT(false);
return;
}
const auto* const fileInfo = event->content()->fileInfo();
if (!fileInfo->isValid()) {
qCWarning(MAIN) << "Event" << eventId
<< "has an empty or malformed mxc URL; won't download";
return;
}
const auto fileUrl = fileInfo->url();
auto filePath = localFilename.toLocalFile();
if (filePath.isEmpty()) { // Setup default file path
filePath =
fileInfo->url().path().mid(1) % '_' % d->fileNameToDownload(event);
if (filePath.size() > 200) // If too long, elide in the middle
filePath.replace(128, filePath.size() - 192, "---");
filePath = QDir::tempPath() % '/' % filePath;
qDebug(MAIN) << "File path:" << filePath;
}
DownloadFileJob *job = nullptr;
#ifdef Quotient_E2EE_ENABLED
if (auto* fileMetadata =
std::get_if<EncryptedFileMetadata>(&fileInfo->source)) {
job = connection()->downloadFile(fileUrl, *fileMetadata, filePath);
} else {
#endif
job = connection()->downloadFile(fileUrl, filePath);
#ifdef Quotient_E2EE_ENABLED
}
#endif
if (isJobPending(job)) {
// If there was a previous transfer (completed or failed), overwrite it.
d->fileTransfers[eventId] = { job, job->targetFileName() };
connect(job, &BaseJob::downloadProgress, this,
[this, eventId](qint64 received, qint64 total) {
d->fileTransfers[eventId].update(received, total);
emit fileTransferProgress(eventId, received, total);
});
connect(job, &BaseJob::success, this, [this, eventId, fileUrl, job] {
d->fileTransfers[eventId].status = FileTransferInfo::Completed;
emit fileTransferCompleted(
eventId, fileUrl, QUrl::fromLocalFile(job->targetFileName()));
});
connect(job, &BaseJob::failure, this,
std::bind(&Private::failedTransfer, d, eventId,
job->errorString()));
emit newFileTransfer(eventId, localFilename);
} else
d->failedTransfer(eventId);
}
void Room::cancelFileTransfer(const QString& id)
{
const auto it = d->fileTransfers.find(id);
if (it == d->fileTransfers.end()) {
qCWarning(MAIN) << "No information on file transfer" << id << "in room"
<< d->id;
return;
}
if (isJobPending(it->job))
it->job->abandon();
it->status = FileTransferInfo::Cancelled;
emit fileTransferFailed(id, FileTransferCancelledMsg());
}
void Room::Private::dropDuplicateEvents(RoomEvents& events) const
{
if (events.empty())
return;
// Multiple-remove (by different criteria), single-erase
// 1. Check for duplicates against the timeline.
auto dupsBegin =
remove_if(events.begin(), events.end(), [&](const RoomEventPtr& e) {
return eventsIndex.contains(e->id());
});
// 2. Check for duplicates within the batch if there are still events.
for (auto eIt = events.begin(); distance(eIt, dupsBegin) > 1; ++eIt)
dupsBegin = remove_if(eIt + 1, dupsBegin, [&](const RoomEventPtr& e) {
return e->id() == (*eIt)->id();
});
if (dupsBegin == events.end())
return;
qCDebug(EVENTS) << "Dropping" << distance(dupsBegin, events.end())
<< "duplicate event(s)";
events.erase(dupsBegin, events.end());
}
void Room::Private::decryptIncomingEvents(RoomEvents& events)
{
#ifdef Quotient_E2EE_ENABLED
QElapsedTimer et;
et.start();
size_t totalDecrypted = 0;
for (auto& eptr : events)
if (const auto& eeptr = eventCast<EncryptedEvent>(eptr)) {
if (auto decrypted = q->decryptMessage(*eeptr)) {
++totalDecrypted;
auto&& oldEvent = exchange(eptr, move(decrypted));
eptr->setOriginalEvent(::move(oldEvent));
} else
undecryptedEvents[eeptr->sessionId()] += eeptr->id();
}
if (totalDecrypted > 5 || et.nsecsElapsed() >= profilerMinNsecs())
qDebug(PROFILER) << "Decrypted" << totalDecrypted << "events in" << et;
#endif
}
/** Make a redacted event
*
* This applies the redaction procedure as defined by the CS API specification
* to the event's JSON and returns the resulting new event. It is
* the responsibility of the caller to dispose of the original event after that.
*/
RoomEventPtr makeRedacted(const RoomEvent& target,
const RedactionEvent& redaction)
{
auto originalJson = target.fullJson();
// clang-format off
static const QStringList keepKeys {
EventIdKey, TypeKey, RoomIdKey, SenderKey, StateKeyKey,
QStringLiteral("hashes"), QStringLiteral("signatures"),
QStringLiteral("depth"), QStringLiteral("prev_events"),
QStringLiteral("prev_state"), QStringLiteral("auth_events"),
QStringLiteral("origin"), QStringLiteral("origin_server_ts"),
QStringLiteral("membership") };
// clang-format on
static const std::pair<event_type_t, QStringList> keepContentKeysMap[] {
{ RoomMemberEvent::typeId(), { QStringLiteral("membership") } },
{ RoomCreateEvent::typeId(), { QStringLiteral("creator") } },
{ RoomPowerLevelsEvent::typeId(),
{ QStringLiteral("ban"), QStringLiteral("events"),
QStringLiteral("events_default"), QStringLiteral("kick"),
QStringLiteral("redact"), QStringLiteral("state_default"),
QStringLiteral("users"), QStringLiteral("users_default") } },
// TODO: Replace with RoomJoinRules::TypeId etc. once available
{ "m.room.join_rules"_ls, { QStringLiteral("join_rule") } },
{ "m.room.history_visibility"_ls,
{ QStringLiteral("history_visibility") } }
};
for (auto it = originalJson.begin(); it != originalJson.end();) {
if (!keepKeys.contains(it.key()))
it = originalJson.erase(it); // TODO: shred the value
else
++it;
}
auto keepContentKeys =
find_if(begin(keepContentKeysMap), end(keepContentKeysMap),
[&target](const auto& t) { return target.type() == t.first; });
if (keepContentKeys == end(keepContentKeysMap)) {
originalJson.remove(ContentKeyL);
originalJson.remove(PrevContentKeyL);
} else {
auto content = originalJson.take(ContentKeyL).toObject();
for (auto it = content.begin(); it != content.end();) {
if (!keepContentKeys->second.contains(it.key()))
it = content.erase(it);
else
++it;
}
originalJson.insert(ContentKey, content);
}
auto unsignedData = originalJson.take(UnsignedKeyL).toObject();
unsignedData[RedactedCauseKeyL] = redaction.fullJson();
originalJson.insert(QStringLiteral("unsigned"), unsignedData);
return loadEvent<RoomEvent>(originalJson);
}
bool Room::Private::processRedaction(const RedactionEvent& redaction)
{
// Can't use findInTimeline because it returns a const iterator, and
// we need to change the underlying TimelineItem.
const auto pIdx = eventsIndex.constFind(redaction.redactedEvent());
if (pIdx == eventsIndex.cend())
return false;
Q_ASSERT(q->isValidIndex(*pIdx));
auto& ti = timeline[Timeline::size_type(*pIdx - q->minTimelineIndex())];
if (ti->isRedacted() && ti->redactedBecause()->id() == redaction.id()) {
qCDebug(EVENTS) << "Redaction" << redaction.id() << "of event"
<< ti->id() << "already done, skipping";
return true;
}
// Make a new event from the redacted JSON and put it in the timeline
// instead of the redacted one. oldEvent will be deleted on return.
auto oldEvent = ti.replaceEvent(makeRedacted(*ti, redaction));
qCDebug(EVENTS) << "Redacted" << oldEvent->id() << "with" << redaction.id();
if (oldEvent->isStateEvent()) {
// Check whether the old event was a part of current state; if it was,
// update the current state to the redacted event object.
const auto currentStateEvt =
currentState.get(oldEvent->matrixType(), oldEvent->stateKey());
Q_ASSERT(currentStateEvt);
if (currentStateEvt == oldEvent.get()) {
// Historical states can't be in currentState
Q_ASSERT(ti.index() >= 0);
qCDebug(STATE).nospace()
<< "Redacting state " << oldEvent->matrixType() << "/"
<< oldEvent->stateKey();
// Retarget the current state to the newly made event.
if (q->processStateEvent(*ti))
emit q->namesChanged(q);
updateDisplayname();
}
}
if (const auto* reaction = eventCast<ReactionEvent>(oldEvent)) {
const auto& targetEvtId = reaction->relation().eventId;
const std::pair lookupKey { targetEvtId, EventRelation::AnnotationType };
if (relations.contains(lookupKey)) {
relations[lookupKey].removeOne(reaction);
emit q->updatedEvent(targetEvtId);
}
}
q->onRedaction(*oldEvent, *ti);
emit q->replacedEvent(ti.event(), rawPtr(oldEvent));
// By now, all references to oldEvent must have been updated to ti.event()
return true;
}
/** Make a replaced event
*
* Takes \p target and returns a copy of it with content taken from
* \p replacement. Disposal of the original event after that is on the caller.
*/
RoomEventPtr makeReplaced(const RoomEvent& target,
const RoomMessageEvent& replacement)
{
const auto& targetReply = target.contentPart<QJsonObject>("m.relates_to");
auto newContent = replacement.contentPart<QJsonObject>("m.new_content"_ls);
if (!targetReply.empty()) {
newContent["m.relates_to"] = targetReply;
}
auto originalJson = target.fullJson();
originalJson[ContentKeyL] = newContent;
auto unsignedData = originalJson.take(UnsignedKeyL).toObject();
auto relations = unsignedData.take("m.relations"_ls).toObject();
relations["m.replace"_ls] = replacement.id();
unsignedData.insert(QStringLiteral("m.relations"), relations);
originalJson.insert(UnsignedKey, unsignedData);
return loadEvent<RoomEvent>(originalJson);
}
bool Room::Private::processReplacement(const RoomMessageEvent& newEvent)
{
// Can't use findInTimeline because it returns a const iterator, and
// we need to change the underlying TimelineItem.
const auto pIdx = eventsIndex.constFind(newEvent.replacedEvent());
if (pIdx == eventsIndex.cend())
return false;
Q_ASSERT(q->isValidIndex(*pIdx));
auto& ti = timeline[Timeline::size_type(*pIdx - q->minTimelineIndex())];
if (ti->replacedBy() == newEvent.id()) {
qCDebug(STATE) << "Event" << ti->id() << "is already replaced with"
<< newEvent.id();
return true;
}
// Make a new event from the redacted JSON and put it in the timeline
// instead of the redacted one. oldEvent will be deleted on return.
auto oldEvent = ti.replaceEvent(makeReplaced(*ti, newEvent));
qCDebug(STATE) << "Replaced" << oldEvent->id() << "with" << newEvent.id();
emit q->replacedEvent(ti.event(), rawPtr(oldEvent));
return true;
}
Connection* Room::connection() const
{
Q_ASSERT(d->connection);
return d->connection;
}
User* Room::localUser() const { return connection()->user(); }
/// Whether the event is a redaction or a replacement
inline bool isEditing(const RoomEventPtr& ep)
{
Q_ASSERT(ep);
if (is<RedactionEvent>(*ep))
return true;
if (auto* msgEvent = eventCast<RoomMessageEvent>(ep))
return !msgEvent->replacedEvent().isEmpty();
return false;
}
Room::Changes Room::Private::addNewMessageEvents(RoomEvents&& events)
{
dropDuplicateEvents(events);
if (events.empty())
return Change::None;
decryptIncomingEvents(events);
QElapsedTimer et;
et.start();
{
// Pre-process redactions and edits so that events that get
// redacted/replaced in the same batch landed in the timeline already
// treated.
// NB: We have to store redacting/replacing events to the timeline too -
// see #220.
auto it = std::find_if(events.begin(), events.end(), isEditing);
for (const auto& eptr : RoomEventsRange(it, events.end())) {
if (auto* r = eventCast<RedactionEvent>(eptr)) {
// Try to find the target in the timeline, then in the batch.
if (processRedaction(*r))
continue;
if (auto targetIt = std::find_if(events.begin(), events.end(),
[id = r->redactedEvent()](const RoomEventPtr& ep) {
return ep->id() == id;
}); targetIt != events.end())
*targetIt = makeRedacted(**targetIt, *r);
else
qCDebug(STATE)
<< "Redaction" << r->id() << "ignored: target event"
<< r->redactedEvent() << "is not found";
// If the target event comes later, it comes already redacted.
}
if (auto* msg = eventCast<RoomMessageEvent>(eptr);
msg && !msg->replacedEvent().isEmpty()) {
if (processReplacement(*msg))
continue;
auto targetIt = std::find_if(events.begin(), it,
[id = msg->replacedEvent()](const RoomEventPtr& ep) {
return ep->id() == id;
});
if (targetIt != it)
*targetIt = makeReplaced(**targetIt, *msg);
else // FIXME: hide the replacing event when target arrives later
qCDebug(EVENTS)
<< "Replacing event" << msg->id()
<< "ignored: target event" << msg->replacedEvent()
<< "is not found";
// Same as with redactions above, the replaced event coming
// later will come already with the new content.
}
}
}
// State changes arrive as a part of timeline; the current room state gets
// updated before merging events to the timeline because that's what
// clients historically expect. This may eventually change though if we
// postulate that the current state is only current between syncs but not
// within a sync.
Changes roomChanges {};
for (const auto& eptr : events)
roomChanges |= q->processStateEvent(*eptr);
auto timelineSize = timeline.size();
size_t totalInserted = 0;
for (auto it = events.begin(); it != events.end();) {
auto nextPendingPair =
findFirstOf(it, events.end(), unsyncedEvents.begin(),
unsyncedEvents.end(), isEchoEvent);
const auto& remoteEcho = nextPendingPair.first;
const auto& localEcho = nextPendingPair.second;
if (it != remoteEcho) {
RoomEventsRange eventsSpan { it, remoteEcho };
emit q->aboutToAddNewMessages(eventsSpan);
auto insertedSize = moveEventsToTimeline(eventsSpan, Newer);
totalInserted += insertedSize;
auto firstInserted = syncEdge() - insertedSize;
q->onAddNewTimelineEvents(firstInserted);
emit q->addedMessages(firstInserted->index(),
timeline.back().index());
}
if (remoteEcho == events.end())
break;
it = remoteEcho + 1;
auto* nextPendingEvt = remoteEcho->get();
const auto pendingEvtIdx = int(localEcho - unsyncedEvents.begin());
if (localEcho->deliveryStatus() != EventStatus::ReachedServer) {
localEcho->setReachedServer(nextPendingEvt->id());
emit q->pendingEventChanged(pendingEvtIdx);
}
emit q->pendingEventAboutToMerge(nextPendingEvt, pendingEvtIdx);
qCDebug(MESSAGES) << "Merging pending event from transaction"
<< nextPendingEvt->transactionId() << "into"
<< nextPendingEvt->id();
auto transfer = fileTransfers.take(nextPendingEvt->transactionId());
if (transfer.status != FileTransferInfo::None)
fileTransfers.insert(nextPendingEvt->id(), transfer);
// After emitting pendingEventAboutToMerge() above we cannot rely
// on the previously obtained localEcho staying valid
// because a signal handler may send another message, thereby altering
// unsyncedEvents (see #286). Fortunately, unsyncedEvents only grows at
// its back so we can rely on the index staying valid at least.
unsyncedEvents.erase(unsyncedEvents.begin() + pendingEvtIdx);
if (auto insertedSize = moveEventsToTimeline({ remoteEcho, it }, Newer)) {
totalInserted += insertedSize;
q->onAddNewTimelineEvents(syncEdge() - insertedSize);
}
emit q->pendingEventMerged();
}
// Events merged and transferred from `events` to `timeline` now.
const auto from = syncEdge() - totalInserted;
if (q->supportsCalls())
for (auto it = from; it != syncEdge(); ++it)
if (const auto* evt = it->viewAs<CallEventBase>())
emit q->callEvent(q, evt);
if (totalInserted > 0) {
for (auto it = from; it != syncEdge(); ++it) {
if (const auto* reaction = it->viewAs<ReactionEvent>()) {
const auto& relation = reaction->relation();
relations[{ relation.eventId, relation.type }] << reaction;
emit q->updatedEvent(relation.eventId);
}
}
qCDebug(MESSAGES) << "Room" << q->objectName() << "received"
<< totalInserted << "new events; the last event is now"
<< timeline.back();
roomChanges |= updateStats(timeline.crbegin(), rev_iter_t(from));
// If the local user's message(s) is/are first in the batch
// and the fully read marker was right before it, promote
// the fully read marker to the same event as the read receipt.
const auto& firstWriterId = (*from)->senderId();
if (firstWriterId == connection->userId()
&& q->fullyReadMarker().base() == from)
roomChanges |=
setFullyReadMarker(q->lastReadReceipt(firstWriterId).eventId);
}
Q_ASSERT(timeline.size() == timelineSize + totalInserted);
if (totalInserted > 9 || et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER) << "Added" << totalInserted << "new event(s) to"
<< q->objectName() << "in" << et;
return roomChanges;
}
void Room::Private::addHistoricalMessageEvents(RoomEvents&& events)
{
const auto timelineSize = timeline.size();
dropDuplicateEvents(events);
if (events.empty())
return;
decryptIncomingEvents(events);
QElapsedTimer et;
et.start();
Changes changes {};
// In case of lazy-loading new members may be loaded with historical
// messages. Also, the cache doesn't store events with empty content;
// so when such events show up in the timeline they should be properly
// incorporated.
for (const auto& eptr : events) {
const auto& e = *eptr;
if (e.isStateEvent()
&& !currentState.contains(e.matrixType(), e.stateKey())) {
changes |= q->processStateEvent(e);
}
}
emit q->aboutToAddHistoricalMessages(events);
const auto insertedSize = moveEventsToTimeline(events, Older);
const auto from = historyEdge() - insertedSize;
qCDebug(STATE) << "Room" << displayname << "received" << insertedSize
<< "past events; the oldest event is now" << timeline.front();
q->onAddHistoricalTimelineEvents(from);
emit q->addedMessages(timeline.front().index(), from->index());
for (auto it = from; it != historyEdge(); ++it) {
if (const auto* reaction = it->viewAs<ReactionEvent>()) {
const auto& relation = reaction->relation();
relations[{ relation.eventId, relation.type }] << reaction;
emit q->updatedEvent(relation.eventId);
}
}
Q_ASSERT(timeline.size() == timelineSize + insertedSize);
if (insertedSize > 9 || et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER) << "Added" << insertedSize << "historical event(s) to"
<< q->objectName() << "in" << et;
changes |= updateStats(from, historyEdge());
if (changes)
postprocessChanges(changes);
}
Room::Changes Room::processStateEvent(const RoomEvent& e)
{
if (!e.isStateEvent())
return Change::None;
// Find a value (create an empty one if necessary) and get a reference
// to it, anticipating a change further in the function.
auto& curStateEvent = d->currentState[{ e.matrixType(), e.stateKey() }];
// Prepare for the state change
// clang-format off
const bool proceed = switchOnType(e
, [this, curStateEvent](const RoomMemberEvent& rme) {
// clang-format on
auto* oldRme = static_cast<const RoomMemberEvent*>(curStateEvent);
auto* u = user(rme.userId());
if (!u) { // Some terribly malformed user id?
qCCritical(MAIN) << "Could not get a user object for"
<< rme.userId();
return false; // Stay low and hope for the best...
}
const auto prevMembership = oldRme ? oldRme->membership()
: Membership::Leave;
switch (prevMembership) {
case Membership::Invite:
if (rme.membership() != prevMembership) {
d->usersInvited.removeOne(u);
Q_ASSERT(!d->usersInvited.contains(u));
}
break;
case Membership::Join:
if (rme.membership() == Membership::Join) {
// rename/avatar change or no-op
if (rme.newDisplayName()) {
emit memberAboutToRename(u, *rme.newDisplayName());
d->removeMemberFromMap(u);
}
if (!rme.newDisplayName() && !rme.newAvatarUrl()) {
qCWarning(MEMBERS)
<< "No-op membership event for" << rme.userId()
<< "- retaining the state";
qCWarning(MEMBERS) << "The event dump:" << rme;
return false;
}
} else {
if (rme.membership() == Membership::Invite)
qCWarning(MAIN)
<< "Membership change from Join to Invite:" << rme;
// whatever the new membership, it's no more Join
d->removeMemberFromMap(u);
emit userRemoved(u);
}
break;
case Membership::Ban:
case Membership::Knock:
case Membership::Leave:
if (rme.membership() == Membership::Invite
|| rme.membership() == Membership::Join) {
d->membersLeft.removeOne(u);
Q_ASSERT(!d->membersLeft.contains(u));
}
break;
case Membership::Undefined:
; // A warning will be dropped in the post-processing block below
}
return true;
// clang-format off
}
, [this, curStateEvent]( const EncryptionEvent& ee) {
// clang-format on
auto* oldEncEvt =
static_cast<const EncryptionEvent*>(curStateEvent);
if (ee.algorithm().isEmpty()) {
qWarning(STATE)
<< "The encryption event for room" << objectName()
<< "doesn't have 'algorithm' specified - ignoring";
return false;
}
if (oldEncEvt
&& oldEncEvt->encryption() != EncryptionType::Undefined) {
qCWarning(STATE) << "The room is already encrypted but a new"
" room encryption event arrived - ignoring";
return false;
}
return true;
// clang-format off
}
, true); // By default, go forward with the state change
// clang-format on
if (!proceed) {
if (!curStateEvent) // Remove the empty placeholder if one was created
d->currentState.remove({ e.matrixType(), e.stateKey() });
return Change::None;
}
// Change the state
const auto* const oldStateEvent =
std::exchange(curStateEvent, static_cast<const StateEventBase*>(&e));
Q_ASSERT(!oldStateEvent
|| (oldStateEvent->matrixType() == e.matrixType()
&& oldStateEvent->stateKey() == e.stateKey()));
if (is<RoomMemberEvent>(e))
qCDebug(MEMBERS) << "Updated room member state:" << e;
else
qCDebug(STATE) << "Updated room state:" << e;
// Update internal structures as per the change and work out the return value
// clang-format off
const auto result = switchOnType(e
, [] (const RoomNameEvent&) {
return Change::Name;
}
, [this, oldStateEvent] (const RoomCanonicalAliasEvent& cae) {
// clang-format on
setObjectName(cae.alias().isEmpty() ? d->id : cae.alias());
const auto* oldCae =
static_cast<const RoomCanonicalAliasEvent*>(oldStateEvent);
QStringList previousAltAliases {};
if (oldCae) {
previousAltAliases = oldCae->altAliases();
if (!oldCae->alias().isEmpty())
previousAltAliases.push_back(oldCae->alias());
}
auto newAliases = cae.altAliases();
if (!cae.alias().isEmpty())
newAliases.push_front(cae.alias());
connection()->updateRoomAliases(id(), previousAltAliases,
newAliases);
return Change::Aliases;
// clang-format off
}
, [this] (const RoomPinnedEvent&) {
emit pinnedEventsChanged();
return Change::Other;
}
, [] (const RoomTopicEvent&) {
return Change::Topic;
}
, [this] (const RoomAvatarEvent& evt) {
if (d->avatar.updateUrl(evt.url()))
emit avatarChanged();
return Change::Avatar;
}
, [this,oldStateEvent] (const RoomMemberEvent& evt) {
// clang-format on
auto* u = user(evt.userId());
const auto* oldMemberEvent =
static_cast<const RoomMemberEvent*>(oldStateEvent);
const auto prevMembership = oldMemberEvent
? oldMemberEvent->membership()
: Membership::Leave;
switch (evt.membership()) {
case Membership::Join:
if (prevMembership != Membership::Join) {
d->insertMemberIntoMap(u);
emit userAdded(u);
} else {
if (evt.newDisplayName()) {
d->insertMemberIntoMap(u);
emit memberRenamed(u);
}
if (evt.newAvatarUrl())
emit memberAvatarChanged(u);
}
break;
case Membership::Invite:
if (!d->usersInvited.contains(u))
d->usersInvited.push_back(u);
if (u == localUser() && evt.isDirect())
connection()->addToDirectChats(this, user(evt.senderId()));
break;
case Membership::Knock:
case Membership::Ban:
case Membership::Leave:
if (!d->membersLeft.contains(u))
d->membersLeft.append(u);
break;
case Membership::Undefined:
qCWarning(MEMBERS) << "Ignored undefined membership type";
}
return Change::Members;
// clang-format off
}
, [this] (const EncryptionEvent&) {
// As encryption can only be switched on once, emit the signal here
// instead of aggregating and emitting in updateData()
emit encryption();
return Change::Other;
}
, [this] (const RoomTombstoneEvent& evt) {
const auto successorId = evt.successorRoomId();
if (auto* successor = connection()->room(successorId))
emit upgraded(evt.serverMessage(), successor);
else
connectUntil(connection(), &Connection::loadedRoomState, this,
[this,successorId,serverMsg=evt.serverMessage()]
(Room* newRoom) {
if (newRoom->id() != successorId)
return false;
emit upgraded(serverMsg, newRoom);
return true;
});
return Change::Other;
// clang-format off
}
, Change::Other);
// clang-format on
Q_ASSERT(result != Change::None);
return result;
}
Room::Changes Room::processEphemeralEvent(EventPtr&& event)
{
Changes changes {};
QElapsedTimer et;
et.start();
switchOnType(*event,
[this, &et](const TypingEvent& evt) {
const auto& users = evt.users();
d->usersTyping.clear();
d->usersTyping.reserve(users.size()); // Assume all are members
for (const auto& userId : users)
if (isMember(userId))
d->usersTyping.append(user(userId));
if (d->usersTyping.size() > 3
|| et.nsecsElapsed() >= profilerMinNsecs())
qDebug(PROFILER)
<< "Processing typing events from" << users.size()
<< "user(s) in" << objectName() << "took" << et;
emit typingChanged();
},
[this, &changes, &et](const ReceiptEvent& evt) {
const auto& receiptsJson = evt.contentJson();
QVector<QString> updatedUserIds;
// Most often (especially for bigger batches), receipts are
// scattered across events (an anecdotal evidence showed 1.2-1.3
// receipts per event on average).
updatedUserIds.reserve(receiptsJson.size() * 2);
for (auto eventIt = receiptsJson.begin();
eventIt != receiptsJson.end(); ++eventIt) {
const auto evtId = eventIt.key();
const auto newMarker = findInTimeline(evtId);
if (newMarker == historyEdge())
qDebug(EPHEMERAL)
<< "Event" << evtId
<< "is not found; saving read receipt(s) anyway";
const auto reads =
eventIt.value().toObject().value("m.read"_ls).toObject();
for (auto userIt = reads.begin(); userIt != reads.end();
++userIt) {
ReadReceipt rr{ evtId,
fromJson<QDateTime>(
userIt->toObject().value("ts"_ls)) };
const auto userId = userIt.key();
if (userId == connection()->userId()) {
// Local user is special, and will get a signal about
// its read receipt separately from (and before) a
// signal on everybody else. No particular reason, just
// less cumbersome code.
changes |= d->setLocalLastReadReceipt(newMarker, rr);
} else if (d->setLastReadReceipt(userId, newMarker, rr)) {
changes |= Change::Other;
updatedUserIds.push_back(userId);
}
}
}
if (updatedUserIds.size() > 10
|| et.nsecsElapsed() >= profilerMinNsecs())
qDebug(PROFILER)
<< "Processing" << updatedUserIds.size()
<< "non-local receipt(s) on" << receiptsJson.size()
<< "event(s) in" << objectName() << "took" << et;
if (!updatedUserIds.empty())
emit lastReadEventChanged(updatedUserIds);
});
return changes;
}
Room::Changes Room::processAccountDataEvent(EventPtr&& event)
{
Changes changes {};
if (auto* evt = eventCast<TagEvent>(event)) {
d->setTags(evt->tags());
changes |= Change::Tags;
}
if (auto* evt = eventCast<const ReadMarkerEvent>(event))
changes |= d->setFullyReadMarker(evt->event_id());
// For all account data events
auto& currentData = d->accountData[event->matrixType()];
// A polymorphic event-specific comparison might be a bit more
// efficient; maaybe do it another day
if (!currentData || currentData->contentJson() != event->contentJson()) {
emit accountDataAboutToChange(event->matrixType());
currentData = move(event);
qCDebug(STATE) << "Updated account data of type"
<< currentData->matrixType();
emit accountDataChanged(currentData->matrixType());
// TODO: Drop AccountDataChange in 0.8
// NB: GCC (at least 10) only accepts QT_IGNORE_DEPRECATIONS around
// a statement, not within a statement
QT_IGNORE_DEPRECATIONS(changes |= Change::AccountData | Change::Other;)
}
return changes;
}
template <typename ContT>
Room::Private::users_shortlist_t
Room::Private::buildShortlist(const ContT& users) const
{
// To calculate room display name the spec requires to sort users
// lexicographically by state_key (user id) and use disambiguated
// display names of two topmost users excluding the current one to render
// the name of the room. The below code selects 3 topmost users,
// slightly extending the spec.
users_shortlist_t shortlist {}; // Prefill with nullptrs
std::partial_sort_copy(
users.begin(), users.end(), shortlist.begin(), shortlist.end(),
[this](const User* u1, const User* u2) {
// localUser(), if it's in the list, is sorted
// below all others
return isLocalUser(u2) || (!isLocalUser(u1) && u1->id() < u2->id());
});
return shortlist;
}
Room::Private::users_shortlist_t
Room::Private::buildShortlist(const QStringList& userIds) const
{
QList<User*> users;
users.reserve(userIds.size());
for (const auto& h : userIds)
users.push_back(q->user(h));
return buildShortlist(users);
}
QString Room::Private::calculateDisplayname() const
{
// CS spec, section 13.2.2.5 Calculating the display name for a room
// Numbers below refer to respective parts in the spec.
// 1. Name (from m.room.name)
auto dispName = q->name();
if (!dispName.isEmpty()) {
return dispName;
}
// 2. Canonical alias
dispName = q->canonicalAlias();
if (!dispName.isEmpty())
return dispName;
// 3. m.room.aliases - only local aliases, subject for further removal
const auto aliases = q->aliases();
if (!aliases.isEmpty())
return aliases.front();
// 4. m.heroes and m.room.member
// From here on, we use a more general algorithm than the spec describes
// in order to provide back-compatibility with pre-MSC688 servers.
// Supplementary code: build the shortlist of users whose names
// will be used to construct the room name. Takes into account MSC688's
// "heroes" if available.
const bool localUserIsIn = joinState == JoinState::Join;
const bool emptyRoom =
membersMap.isEmpty()
|| (membersMap.size() == 1 && isLocalUser(*membersMap.cbegin()));
const bool nonEmptySummary = summary.heroes && !summary.heroes->empty();
auto shortlist = nonEmptySummary ? buildShortlist(*summary.heroes)
: !emptyRoom ? buildShortlist(membersMap)
: users_shortlist_t {};
// When the heroes list is there, we can rely on it. If the heroes list is
// missing, the below code gathers invited, or, if there are no invitees,
// left members.
if (!shortlist.front() && localUserIsIn)
shortlist = buildShortlist(usersInvited);
if (!shortlist.front())
shortlist = buildShortlist(membersLeft);
QStringList names;
for (const auto* u : shortlist) {
if (u == nullptr || isLocalUser(u))
break;
// Only disambiguate if the room is not empty
names.push_back(u->displayname(emptyRoom ? nullptr : q));
}
const auto usersCountExceptLocal =
!emptyRoom
? q->joinedCount() - int(joinState == JoinState::Join)
: !usersInvited.empty()
? usersInvited.count()
: membersLeft.size() - int(joinState == JoinState::Leave);
if (usersCountExceptLocal > int(shortlist.size()))
names << tr(
"%Ln other(s)",
"Used to make a room name from user names: A, B and _N others_",
usersCountExceptLocal - int(shortlist.size()));
const auto namesList = QLocale().createSeparatedList(names);
// Room members
if (!emptyRoom)
return namesList;
// (Spec extension) Invited users
if (!usersInvited.empty())
return tr("Empty room (invited: %1)").arg(namesList);
// Users that previously left the room
if (!membersLeft.isEmpty())
return tr("Empty room (was: %1)").arg(namesList);
// Fail miserably
return tr("Empty room (%1)").arg(id);
}
void Room::Private::updateDisplayname()
{
auto swappedName = calculateDisplayname();
if (swappedName != displayname) {
emit q->displaynameAboutToChange(q);
swap(displayname, swappedName);
qCDebug(MAIN) << q->objectName() << "has changed display name from"
<< swappedName << "to" << displayname;
emit q->displaynameChanged(q, swappedName);
}
}
QJsonObject Room::Private::toJson() const
{
QElapsedTimer et;
et.start();
QJsonObject result;
addParam<IfNotEmpty>(result, QStringLiteral("summary"), summary);
{
QJsonArray stateEvents;
for (const auto* evt : currentState) {
Q_ASSERT(evt->isStateEvent());
if ((evt->isRedacted() && !is<RoomMemberEvent>(*evt))
|| evt->contentJson().isEmpty())
continue;
auto json = evt->fullJson();
auto unsignedJson = evt->unsignedJson();
unsignedJson.remove(QStringLiteral("prev_content"));
json[UnsignedKeyL] = unsignedJson;
stateEvents.append(json);
}
const auto stateObjName = joinState == JoinState::Invite
? QStringLiteral("invite_state")
: QStringLiteral("state");
result.insert(stateObjName,
QJsonObject { { QStringLiteral("events"), stateEvents } });
}
if (!accountData.empty()) {
QJsonArray accountDataEvents;
for (const auto& e : accountData) {
if (!e.second->contentJson().isEmpty())
accountDataEvents.append(e.second->fullJson());
}
result.insert(QStringLiteral("account_data"),
QJsonObject {
{ QStringLiteral("events"), accountDataEvents } });
}
if (const auto& readReceipt = q->lastReadReceipt(connection->userId());
!readReceipt.eventId.isEmpty()) //
{
result.insert(
QStringLiteral("ephemeral"),
QJsonObject {
{ QStringLiteral("events"),
QJsonArray { ReceiptEvent({ { readReceipt.eventId,
{ { connection->userId(),
readReceipt.timestamp } } } })
.fullJson() } } });
}
result.insert(UnreadNotificationsKey,
QJsonObject { { PartiallyReadCountKey,
countFromStats(partiallyReadStats) },
{ HighlightCountKey, serverHighlightCount } });
result.insert(NewUnreadCountKey, countFromStats(unreadStats));
if (et.elapsed() > 30)
qCDebug(PROFILER) << "Room::toJson() for" << q->objectName() << "took"
<< et;
return result;
}
QJsonObject Room::toJson() const { return d->toJson(); }
MemberSorter Room::memberSorter() const { return MemberSorter(this); }
bool MemberSorter::operator()(User* u1, User* u2) const
{
return operator()(u1, room->disambiguatedMemberName(u2->id()));
}
bool MemberSorter::operator()(User* u1, QStringView u2name) const
{
auto n1 = room->disambiguatedMemberName(u1->id());
if (n1.startsWith('@'))
n1.remove(0, 1);
const auto n2 = u2name.mid(u2name.startsWith('@') ? 1 : 0)
#if QT_VERSION_MAJOR < 6
.toString() // Qt 5 doesn't have QStringView::localeAwareCompare
#endif
;
return n1.localeAwareCompare(n2) < 0;
}
void Room::activateEncryption()
{
if(usesEncryption()) {
qCWarning(E2EE) << "Room" << objectName() << "is already encrypted";
return;
}
setState<EncryptionEvent>(EncryptionType::MegolmV1AesSha2);
}
|