1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <config_features.h>
#include <loadenv/loadenv.hxx>
#include <loadenv/targethelper.hxx>
#include <pattern/frame.hxx>
#include <classes/resource.hrc>
#include <classes/fwkresid.hxx>
#include <protocols.h>
#include <properties.h>
#include "helper/mischelper.hxx"
#include <com/sun/star/ucb/NameClash.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/frame/Desktop.hpp>
#include <com/sun/star/frame/theGlobalEventBroadcaster.hpp>
#include <com/sun/star/frame/XLoadable.hpp>
#include <com/sun/star/frame/XModel2.hpp>
#include <com/sun/star/frame/ModuleManager.hpp>
#include <com/sun/star/frame/XTitle.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/XController.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/frame/XStorable.hpp>
#include <com/sun/star/util/XModifiable.hpp>
#include <com/sun/star/util/URLTransformer.hpp>
#include <com/sun/star/util/XURLTransformer.hpp>
#include <com/sun/star/frame/XDesktop.hpp>
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/util/XChangesNotifier.hpp>
#include <com/sun/star/util/XChangesBatch.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/document/XDocumentPropertiesSupplier.hpp>
#include <com/sun/star/document/XDocumentRecovery.hpp>
#include <com/sun/star/util/XCloseable.hpp>
#include <com/sun/star/awt/XWindow2.hpp>
#include <com/sun/star/task/XStatusIndicatorFactory.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/document/XDocumentEventListener.hpp>
#include <com/sun/star/document/XDocumentEventBroadcaster.hpp>
#include <com/sun/star/util/XChangesListener.hpp>
#include <com/sun/star/task/XStatusIndicator.hpp>
#include <com/sun/star/util/XModifyListener.hpp>
#include <comphelper/configurationhelper.hxx>
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/exc_hlp.hxx>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/propshlp.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <unotools/mediadescriptor.hxx>
#include <comphelper/namedvaluecollection.hxx>
#include <comphelper/sequence.hxx>
#include <vcl/evntpost.hxx>
#include <vcl/svapp.hxx>
#include <vcl/timer.hxx>
#include <unotools/pathoptions.hxx>
#include <tools/diagnose_ex.h>
#include <unotools/tempfile.hxx>
#include <ucbhelper/content.hxx>
#include <osl/time.h>
#include <vcl/msgbox.hxx>
#include <osl/file.hxx>
#include <unotools/bootstrap.hxx>
#include <unotools/configmgr.hxx>
#include <svl/documentlockfile.hxx>
#include <tools/urlobj.hxx>
#include <general.h>
#include <stdtypes.h>
using namespace css::uno;
using namespace css::document;
using namespace css::frame;
using namespace css::lang;
using namespace framework;
namespace {
/** @short hold all needed information for an asynchronous dispatch alive.
@descr Because some operations are forced to be executed asynchronously
(e.g. requested by our CreashSave/Recovery dialog) ... we must make sure
that these information won't be set as "normal" members of our AutoRecovery
instance. Otherwise they can disturb our normal AutoSave-timer handling.
e.g. it can be unclear then, which progress has to be used for storing documents...
*/
struct DispatchParams
{
public:
DispatchParams();
DispatchParams(const ::comphelper::SequenceAsHashMap& lArgs ,
const css::uno::Reference< css::uno::XInterface >& xOwner);
void forget();
public:
/** @short can be set from outside and is provided to
our internal started operations.
@descr Normally we use the normal status indicator
of the document windows to show a progress.
But in case we are used by any special UI,
it can provide its own status indicator object
to us - so we use it instead of the normal one.
*/
css::uno::Reference< css::task::XStatusIndicator > m_xProgress;
/** TODO document me */
OUString m_sSavePath;
/** @short define the current cache entry, which should be used for current
backup or cleanUp operation ... which is may be done asynchronous */
sal_Int32 m_nWorkingEntryID;
/** @short used for async operations, to prevent us from dying.
@descr If our dispatch() method was forced to start the
internal operation asynchronous... we send an event
to start and return immediately. But we must be sure that
our instance live if the event callback reach us.
So we hold an uno reference to ourself.
*/
css::uno::Reference< css::uno::XInterface > m_xHoldRefForAsyncOpAlive;
};
/**
implements the functionality of AutoSave and AutoRecovery
of documents - including features of an EmergencySave in
case a GPF occurs.
*/
typedef ::cppu::WeakComponentImplHelper<
css::lang::XServiceInfo,
css::frame::XDispatch,
css::document::XDocumentEventListener, // => css.lang.XEventListener
css::util::XChangesListener, // => css.lang.XEventListener
css::util::XModifyListener > // => css.lang.XEventListener
AutoRecovery_BASE;
class AutoRecovery : private cppu::BaseMutex
, public AutoRecovery_BASE
, public ::cppu::OPropertySetHelper // => XPropertySet, XFastPropertySet, XMultiPropertySet
{
public:
/** These values are used as flags and represent the current state of a document.
Every state of the life time of a document has to be recognized here.
@attention Do not change (means reorganize) already used numbers.
There exists some code inside SVX, which uses the same numbers,
to analyze such document states.
Not the best design ... but may be it will be changed later .-)
*/
enum EDocStates
{
/* TEMP STATES */
/// default state, if a document was new created or loaded
E_UNKNOWN = 0,
/// modified against the original file
E_MODIFIED = 1,
/// an active document can be postponed to be saved later.
E_POSTPONED = 2,
/// was already handled during one AutoSave/Recovery session.
E_HANDLED = 4,
/** an action was started (saving/loading) ... Can be interesting later if the process may be was interrupted by an exception. */
E_TRY_SAVE = 8,
E_TRY_LOAD_BACKUP = 16,
E_TRY_LOAD_ORIGINAL = 32,
/* FINAL STATES */
/// the Auto/Emergency saved document is not useable any longer
E_DAMAGED = 64,
/// the Auto/Emergency saved document is not really up-to-date (some changes can be missing)
E_INCOMPLETE = 128,
/// the Auto/Emergency saved document was processed successfully
E_SUCCEDED = 512
};
/** @short indicates the results of a FAILURE_SAFE operation
@descr We must know, which reason was the real one in case
we couldnt copy a "failure document" to a user specified path.
We must know, if we can forget our cache entry or not.
*/
enum EFailureSafeResult
{
E_COPIED,
E_ORIGINAL_FILE_MISSING,
E_WRONG_TARGET_PATH
};
// TODO document me
enum ETimerType
{
/** the timer should not be used next time */
E_DONT_START_TIMER,
/** timer (was/must be) started with normal AutoSaveTimeIntervall */
E_NORMAL_AUTOSAVE_INTERVALL,
/** timer must be started with special short time interval,
to poll for an user idle period */
E_POLL_FOR_USER_IDLE,
/** timer must be started with a very(!) short time interval,
to poll for the end of an user action, which does not allow saving documents in general */
E_POLL_TILL_AUTOSAVE_IS_ALLOWED,
/** don't start the timer - but calls the same action then before immediately again! */
E_CALL_ME_BACK
};
// TODO document me ... flag field
// Emergency_Save and Recovery overwrites Auto_Save!
enum EJob
{
E_NO_JOB = 0,
E_AUTO_SAVE = 1,
E_EMERGENCY_SAVE = 2,
E_RECOVERY = 4,
E_ENTRY_BACKUP = 8,
E_ENTRY_CLEANUP = 16,
E_PREPARE_EMERGENCY_SAVE = 32,
E_SESSION_SAVE = 64,
E_SESSION_RESTORE = 128,
E_DISABLE_AUTORECOVERY = 256,
E_SET_AUTOSAVE_STATE = 512,
E_SESSION_QUIET_QUIT = 1024,
E_USER_AUTO_SAVE = 2048
};
/** @short combine different information about one office document. */
struct TDocumentInfo
{
public:
TDocumentInfo()
: DocumentState (E_UNKNOWN)
, UsedForSaving (false)
, ListenForModify (false)
, IgnoreClosing (false)
, ID (-1 )
{}
/** @short points to the document. */
css::uno::Reference< css::frame::XModel > Document;
/** @short knows, if the document is really modified since the last autosave,
or was postponed, because it was an active one etcpp...
@descr Because we have no CHANGE TRACKING mechanism, based on office document,
we implements it by ourself. We listen for MODIFIED events
of each document and update this state flag here.
Further we postpone saving of active documents, e.g. if the user
works currently on it. We wait for an idle period then ...
*/
sal_Int32 DocumentState;
/** Because our applications not ready for concurrent save requests at the same time,
we have suppress our own AutoSave for the moment, a document will be already saved
by others.
*/
bool UsedForSaving;
/** For every user action, which modifies a document (e.g. key input) we get
a notification as XModifyListener. That seems to be a "performance issue" .-)
So we decided to listen for such modify events only for the time in which the document
was stored as temp. file and was not modified again by the user.
*/
bool ListenForModify;
/** For SessionSave we must close all open documents by ourself.
But because we are listen for documents events, we get some ...
and deregister these documents from our configuration.
That's why we mark these documents as "Closed by ourself" so we can
ignore these "OnUnload" or disposing() events .-)
*/
bool IgnoreClosing;
/** TODO: document me */
OUString OrgURL;
OUString FactoryURL;
OUString TemplateURL;
OUString OldTempURL;
OUString NewTempURL;
OUString AppModule; // e.g. com.sun.star.text.TextDocument - used to identify app module
OUString FactoryService; // the service to create a document of the module
OUString RealFilter; // real filter, which was used at loading time
OUString DefaultFilter; // supports saving of the default format without losing data
OUString Extension; // file extension of the default filter
OUString Title; // can be used as "DisplayName" on every recovery UI!
css::uno::Sequence< OUString >
ViewNames; // names of the view which were active at emergency-save time
sal_Int32 ID;
};
/** @short used to know every currently open document. */
typedef ::std::vector< TDocumentInfo > TDocumentList;
// member
private:
/** @short the global uno service manager.
@descr Must be used to create own needed services.
*/
css::uno::Reference< css::uno::XComponentContext > m_xContext;
/** @short points to the underlying recovery configuration.
@descr This instance does not cache - it calls directly the
configuration API!
*/
css::uno::Reference< css::container::XNameAccess > m_xRecoveryCFG;
/** @short proxy weak binding to forward Events to ourself without
an ownership cycle
*/
css::uno::Reference< css::util::XChangesListener > m_xRecoveryCFGListener;
/** @short points to the used configuration package or.openoffice.Setup
@descr This instance does not cache - it calls directly the
configuration API!
*/
css::uno::Reference< css::container::XNameAccess > m_xModuleCFG;
/** @short holds the global event broadcaster alive,
where we listen for new created documents.
*/
css::uno::Reference< css::frame::XGlobalEventBroadcaster > m_xNewDocBroadcaster;
/** @short proxy weak binding to forward Events to ourself without
an ownership cycle
*/
css::uno::Reference< css::document::XDocumentEventListener > m_xNewDocBroadcasterListener;
/** @short because we stop/restart listening sometimes, it's a good idea to know
if we already registered as listener .-)
*/
bool m_bListenForDocEvents;
bool m_bListenForConfigChanges;
/** @short specify the time interval between two save actions.
@descr tools::Time is measured in [min].
*/
sal_Int32 m_nAutoSaveTimeIntervall;
/** @short for an asynchronous operation we must know, if there is
at least one running job (may be asynchronous!).
*/
sal_Int32 m_eJob;
/** @short the timer, which is used to be informed about the next
saving time ...
@remark must lock SolarMutex to use
*/
Timer m_aTimer;
/** @short make our dispatch asynchronous ... if required to do so! */
vcl::EventPoster m_aAsyncDispatcher;
/** @see DispatchParams
*/
DispatchParams m_aDispatchParams;
/** @short indicates, which time period is currently used by the
internal timer.
*/
ETimerType m_eTimerType;
/** @short this cache is used to hold all information about
recovery/emergency save documents alive.
*/
TDocumentList m_lDocCache;
// TODO document me
sal_Int32 m_nIdPool;
/** @short contains all status listener registered at this instance.
*/
ListenerHash m_lListener;
/** @descr This member is used to prevent us against re-entrance problems.
A mutex can't help to prevent us from concurrent using of members
inside the same thread. But e.g. our internally used stl structures
are not threadsafe ... and furthermore they can't be used at the same time
for iteration and add/remove requests!
So we have to detect such states and ... show a warning.
May be there will be a better solution next time ... (copying the cache temp.
bevor using).
And further it's not possible to use a simple boolean value here.
Because if more than one operation iterates over the same stl container ...
(only to modify it's elements but don't add new or removing existing ones!)
it should be possible doing so. But we must guarantee that the last operation reset
this lock ... not the first one ! So we use a "ref count" mechanism for that."
*/
sal_Int32 m_nDocCacheLock;
/** @descr These members are used to check the minimum disc space, which must exists
to start the corresponding operation.
*/
sal_Int32 m_nMinSpaceDocSave;
sal_Int32 m_nMinSpaceConfigSave;
// interface
public:
explicit AutoRecovery(const css::uno::Reference< css::uno::XComponentContext >& xContext);
virtual ~AutoRecovery( ) override;
virtual OUString SAL_CALL getImplementationName() override
{
return OUString("com.sun.star.comp.framework.AutoRecovery");
}
virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
{
return cppu::supportsService(this, ServiceName);
}
virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override
{
return {"com.sun.star.frame.AutoRecovery"};
}
// XInterface
virtual void SAL_CALL acquire() throw () override
{ OWeakObject::acquire(); }
virtual void SAL_CALL release() throw () override
{ OWeakObject::release(); }
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& type) override;
/// Initialization function after having acquire()'d.
void initListeners();
// XTypeProvider
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) override;
// css.frame.XDispatch
virtual void SAL_CALL dispatch(const css::util::URL& aURL ,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments) override;
virtual void SAL_CALL addStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
const css::util::URL& aURL ) override;
virtual void SAL_CALL removeStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
const css::util::URL& aURL ) override;
// css.document.XDocumentEventListener
/** @short informs about created/opened documents.
@descr Every new opened/created document will be saved internally
so it can be checked if its modified. This modified state
is used later to decide, if it must be saved or not.
@param aEvent
points to the new created/opened document.
*/
virtual void SAL_CALL documentEventOccured(const css::document::DocumentEvent& aEvent) override;
// css.util.XChangesListener
virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent) override;
// css.util.XModifyListener
virtual void SAL_CALL modified(const css::lang::EventObject& aEvent) override;
// css.lang.XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
protected:
// OPropertySetHelper
virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any& aConvertedValue,
css::uno::Any& aOldValue ,
sal_Int32 nHandle ,
const css::uno::Any& aValue ) override;
virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle,
const css::uno::Any& aValue ) override;
using cppu::OPropertySetHelper::getFastPropertyValue;
virtual void SAL_CALL getFastPropertyValue(css::uno::Any& aValue ,
sal_Int32 nHandle) const override;
virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper() override;
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() override;
private:
virtual void SAL_CALL disposing() final override;
/** @short open the underlying configuration.
@descr This method must be called every time
a configuration call is needed. Because
method works together with the member
m_xCFG, open it on demand and cache it
afterwards.
@return [com.sun.star.container.XNameAccess]
the configuration object
@throw [com.sun.star.uno.RuntimeException]
if config could not be opened successfully!
@threadsafe
*/
css::uno::Reference< css::container::XNameAccess > implts_openConfig();
/** @short read the underlying configuration.
@descr After that we know the initial state - means:
- if AutoSave was enabled by the user
- which time interval has to be used
- which recovery entries may already exists
@throw [com.sun.star.uno.RuntimeException]
if config could not be opened or readed successfully!
@threadsafe
*/
void implts_readConfig();
/** @short read the underlying configuration...
@descr ... but only keys related to the AutoSave mechanism.
Means: State and Timer interval.
E.g. the recovery list is not addressed here.
@throw [com.sun.star.uno.RuntimeException]
if config could not be opened or readed successfully!
@threadsafe
*/
void implts_readAutoSaveConfig();
// TODO document me
void implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo ,
bool bRemoveIt = false);
// TODO document me
void implts_startListening();
void implts_startModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
// TODO document me
void implts_stopListening();
void implts_stopModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
/** @short stops and may be(!) restarts the timer.
@descr A running timer is stopped every time here.
But starting depends from the different internal
timer variables (e.g. AutoSaveEnabled, AutoSaveTimeIntervall,
TimerType etcpp.)
@throw [com.sun.star.uno.RuntimeException]
if timer could not be stopped or started!
@threadsafe
*/
void implts_updateTimer();
/** @short stop the timer.
@descr Double calls will be ignored - means we do
nothing here, if the timer is already disabled.
@throw [com.sun.star.uno.RuntimeException]
if timer could not be stopped!
@threadsafe
*/
void implts_stopTimer();
/** @short callback of our internal timer.
*/
DECL_LINK(implts_timerExpired, Timer*, void);
/** @short makes our dispatch() method asynchronous!
*/
DECL_LINK(implts_asyncDispatch, LinkParamNone*, void);
/** @short implements the dispatch real. */
void implts_dispatch(const DispatchParams& aParams);
/** @short validate new detected document and add it into the internal
document list.
@descr This method should be called only, if its clear that a new
document was opened/created during office runtime.
This method checks, if it's a top level document (means not an embedded one).
Only such top level documents can be recognized by this auto save mechanism.
@param xDocument
the new document, which should be checked and registered.
@threadsafe
*/
void implts_registerDocument(const css::uno::Reference< css::frame::XModel >& xDocument);
/** @short remove the specified document from our internal document list.
@param xDocument
the new document, which should be deregistered.
@param bStopListening
sal_False: must be used in case this method is called within disposing() of the document,
where it make no sense to deregister our listener. The container dies...
sal_True : must be used in case this method is used on "deregistration" of this document, where
we must deregister our listener .-)
@threadsafe
*/
void implts_deregisterDocument(const css::uno::Reference< css::frame::XModel >& xDocument ,
bool bStopListening = true);
// TODO document me
void implts_markDocumentModifiedAgainstLastBackup(const css::uno::Reference< css::frame::XModel >& xDocument);
// TODO document me
void implts_updateModifiedState(const css::uno::Reference< css::frame::XModel >& xDocument);
// TODO document me
void implts_updateDocumentUsedForSavingState(const css::uno::Reference< css::frame::XModel >& xDocument ,
bool bSaveInProgress);
// TODO document me
void implts_markDocumentAsSaved(const css::uno::Reference< css::frame::XModel >& xDocument);
/** @short search a document inside given list.
@param rList
reference to a vector, which can contain such
document.
@param xDocument
the document, which should be located inside the
given list.
@return [TDocumentList::iterator]
which points to the located document.
If document does not exists - its set to
rList.end()!
*/
static TDocumentList::iterator impl_searchDocument( AutoRecovery::TDocumentList& rList ,
const css::uno::Reference< css::frame::XModel >& xDocument);
/** TODO document me */
void implts_changeAllDocVisibility(bool bVisible);
void implts_prepareSessionShutdown();
/** @short save all current opened documents to a specific
backup directory.
@descr Only really changed documents will be saved here.
Further this method returns a suggestion, if and how it should
be called again. May be some documents was not saved yet
and must wait for an user idle period ...
@param bAllowUserIdleLoop
Because this method is used for different uses cases, it must
know, which actions are allowed or not.
AUTO_SAVE =>
If a document is the most active one, saving it
will be postponed if there exists other unsaved
documents. This feature was implemented, because
we don't wish to disturb the user on it's work.
... bAllowUserIdleLoop should be set to sal_True
EMERGENCY_SAVE / SESSION_SAVE =>
Here we must finish our work ASAP! It's not allowed
to postpone any document.
... bAllowUserIdleLoop must(!) be set to sal_False
@param pParams
sometimes this method is required inside an external dispatch request.
The it contains some special environment variables, which overwrites
our normal environment.
AutoSave => pParams == 0
SessionSave/CrashSave => pParams != 0
@return A suggestion, how the timer (if it's not already disabled!)
should be restarted to fulfill the requirements.
@threadsafe
*/
AutoRecovery::ETimerType implts_saveDocs( bool bAllowUserIdleLoop,
bool bRemoveLockFiles,
const DispatchParams* pParams = nullptr);
/** @short save one of the current documents to a specific
backup directory.
@descr It:
- defines a new(!) unique temp file name
- save the new temp file
- remove the old temp file
- patch the given info struct
- and return errors.
It does not:
- patch the configuration.
Note further: it patches the info struct
more than ones. E.g. the new temp URL is set
before the file is saved. And the old URL is removed
only if removing oft he old file was successfully.
If this method returns without an exception - everything
was OK. Otherwise the info struct can be analyzed to
get more information, e.g. when the problem occurs.
@param sBackupPath
the base path for saving such temp files.
@param rInfo
points to an information structure, where
e.g. the document, its modified state, the count
of autosave-retries etcpp. exists.
Its used also to return the new temp file name
and some other state values!
@threadsafe
*/
void implts_saveOneDoc(const OUString& sBackupPath ,
AutoRecovery::TDocumentInfo& rInfo ,
const css::uno::Reference< css::task::XStatusIndicator >& xExternalProgress);
/** @short recovery all documents, which was saved during
a crash before.
@return A suggestion, how this method must be called back!
@threadsafe
*/
AutoRecovery::ETimerType implts_openDocs(const DispatchParams& aParams);
// TODO document me
void implts_openOneDoc(const OUString& sURL ,
utl::MediaDescriptor& lDescriptor,
AutoRecovery::TDocumentInfo& rInfo );
// TODO document me
void implts_generateNewTempURL(const OUString& sBackupPath ,
utl::MediaDescriptor& rMediaDescriptor,
AutoRecovery::TDocumentInfo& rInfo );
/** @short notifies all interested listener about the current state
of the currently running operation.
@descr We support different set's of functions. AUTO_SAVE, EMERGENCY_SAVE,
AUTO_RECOVERY, FAILURE_SAVE ... etcpp.
Listener can register itself for any type of supported
functionality ... but not for document URL's in special.
@param eJob
is used to know, which set of listener we must notify.
@param aEvent
describe the event more in detail.
@threadsafe
*/
void implts_informListener( sal_Int32 eJob ,
const css::frame::FeatureStateEvent& aEvent);
/** short create a feature event struct, which can be send
to any interested listener.
@param eJob
describe the current running operation
AUTOSAVE, EMERGENCYSAVE, RECOVERY
@param sEventType
describe the type of this event
START, STOP, UPDATE
@param pInfo
if sOperation is an update, this parameter must be different from NULL
and is used to send information regarding the current handled document.
@return [css::frame::FeatureStateEvent]
the event structure for sending.
*/
static css::frame::FeatureStateEvent implst_createFeatureStateEvent( sal_Int32 eJob ,
const OUString& sEventType,
AutoRecovery::TDocumentInfo const * pInfo );
class ListenerInformer
{
private:
AutoRecovery &m_rRecovery;
sal_Int32 m_eJob;
bool m_bStopped;
public:
ListenerInformer(AutoRecovery &rRecovery, sal_Int32 eJob)
: m_rRecovery(rRecovery), m_eJob(eJob), m_bStopped(false)
{
}
void start();
void stop();
~ListenerInformer()
{
stop();
}
};
// TODO document me
void implts_resetHandleStates();
// TODO document me
void implts_specifyDefaultFilterAndExtension(AutoRecovery::TDocumentInfo& rInfo);
// TODO document me
void implts_specifyAppModuleAndFactory(AutoRecovery::TDocumentInfo& rInfo);
/** retrieves the names of all active views of the given document
@param rInfo
the document info, whose <code>Document</code> member must not be <NULL/>.
*/
void implts_collectActiveViewNames( AutoRecovery::TDocumentInfo& rInfo );
/** updates the configuration so that for all documents, their current view/names are stored
*/
void implts_persistAllActiveViewNames();
// TODO document me
void implts_prepareEmergencySave();
// TODO document me
void implts_doEmergencySave(const DispatchParams& aParams);
// TODO document me
void implts_doRecovery(const DispatchParams& aParams);
// TODO document me
void implts_doSessionSave(const DispatchParams& aParams);
// TODO document me
void implts_doSessionQuietQuit();
// TODO document me
void implts_doSessionRestore(const DispatchParams& aParams);
// TODO document me
void implts_backupWorkingEntry(const DispatchParams& aParams);
// TODO document me
void implts_cleanUpWorkingEntry(const DispatchParams& aParams);
/** try to make sure that all changed config items (not our used
config access only) will be flushed back to disc.
E.g. our svtools::ConfigItems() has to be flushed explicitly .-(
Note: This method can't fail. Flushing of config entries is an
optional feature. Errors can be ignored.
*/
void impl_flushALLConfigChanges();
// TODO document me
AutoRecovery::EFailureSafeResult implts_copyFile(const OUString& sSource ,
const OUString& sTargetPath,
const OUString& sTargetName);
/** @short converts m_eJob into a job description, which
can be used to inform an outside listener
about the current running operation
@param eJob
describe the current running operation
AUTOSAVE, EMERGENCYSAVE, RECOVERY
@return [string]
a suitable job description of form:
vnd.sun.star.autorecovery:/do...
*/
static OUString implst_getJobDescription(sal_Int32 eJob);
/** @short map the given URL to an internal int representation.
@param aURL
the url, which describe the next starting or may be already running
operation.
@return [long]
the internal int representation
see enum EJob
*/
static sal_Int32 implst_classifyJob(const css::util::URL& aURL);
/// TODO
void implts_verifyCacheAgainstDesktopDocumentList();
/// TODO document me
bool impl_enoughDiscSpace(sal_Int32 nRequiredSpace);
/// TODO document me
static void impl_showFullDiscError();
/** @short try to create/use a progress and set it inside the
environment.
@descr The problem behind: There exists different use case of this method.
a) An external progress is provided by our CrashSave or Recovery dialog.
b) We must create our own progress e.g. for an AutoSave
c) Sometimes our application filters don't use the progress
provided by the MediaDescriptor. They use the Frame every time to create
it's own progress. So we implemented a HACK for these and now we set
an InterceptedProgress there for the time WE use this frame for loading/storing documents .-)
@param xNewFrame
must be set only in case WE create a new frame (e.g. for loading documents
on session restore or recovery). Then search for a frame using rInfo.Document must
be suppressed and xFrame must be preferred instead .-)
@param rInfo
used e.g. to find the frame corresponding to a document.
This frame must be used to create a new progress e.g. for an AutoSave.
@param rArgs
is used to set the new created progress as parameter on these set.
*/
void impl_establishProgress(const AutoRecovery::TDocumentInfo& rInfo ,
utl::MediaDescriptor& rArgs ,
const css::uno::Reference< css::frame::XFrame >& xNewFrame);
void impl_forgetProgress(const AutoRecovery::TDocumentInfo& rInfo ,
utl::MediaDescriptor& rArgs ,
const css::uno::Reference< css::frame::XFrame >& xNewFrame);
/** try to remove the specified file from disc.
Every URL supported by our UCB component can be used here.
Further it doesn't matter if the file really exists or not.
Because removing a non existent file will have the same
result at the end... a non existing file .-)
On the other side removing of files from disc is an optional
feature. If we are not able doing so... it's not a real problem.
Ok - users disc place will be smaller then... but we should produce
a crash during crash save because we can't delete a temporary file only!
@param sURL
the url of the file, which should be removed.
*/
void st_impl_removeFile(const OUString& sURL);
/** try to remove ".lock" file from disc if office will be terminated
not using the official way .-)
This method has to be handled "optional". So every error inside
has to be ignored ! This method CAN NOT FAIL ... it can forget something only .-)
*/
void st_impl_removeLockFile();
};
// recovery.xcu
static const char CFG_PACKAGE_RECOVERY[] = "org.openoffice.Office.Recovery/";
static const char CFG_ENTRY_RECOVERYLIST[] = "RecoveryList";
static const char CFG_PATH_RECOVERYINFO[] = "RecoveryInfo";
static const char CFG_ENTRY_CRASHED[] = "Crashed";
static const char CFG_ENTRY_SESSIONDATA[] = "SessionData";
static const char CFG_ENTRY_AUTOSAVE_ENABLED[] = "AutoSave/Enabled";
static const char CFG_ENTRY_AUTOSAVE_TIMEINTERVALL[] = "AutoSave/TimeIntervall"; //sic!
static const char CFG_ENTRY_USERAUTOSAVE_ENABLED[] = "AutoSave/UserAutoSaveEnabled";
static const char CFG_PATH_AUTOSAVE[] = "AutoSave";
static const char CFG_ENTRY_MINSPACE_DOCSAVE[] = "MinSpaceDocSave";
static const char CFG_ENTRY_MINSPACE_CONFIGSAVE[] = "MinSpaceConfigSave";
static const char CFG_PACKAGE_MODULES[] = "org.openoffice.Setup/Office/Factories";
static const char CFG_ENTRY_REALDEFAULTFILTER[] = "ooSetupFactoryActualFilter";
static const char CFG_ENTRY_PROP_TEMPURL[] = "TempURL";
static const char CFG_ENTRY_PROP_ORIGINALURL[] = "OriginalURL";
static const char CFG_ENTRY_PROP_TEMPLATEURL[] = "TemplateURL";
static const char CFG_ENTRY_PROP_FACTORYURL[] = "FactoryURL";
static const char CFG_ENTRY_PROP_MODULE[] = "Module";
static const char CFG_ENTRY_PROP_DOCUMENTSTATE[] = "DocumentState";
static const char CFG_ENTRY_PROP_FILTER[] = "Filter";
static const char CFG_ENTRY_PROP_TITLE[] = "Title";
static const char CFG_ENTRY_PROP_ID[] = "ID";
static const char CFG_ENTRY_PROP_VIEWNAMES[] = "ViewNames";
static const char FILTER_PROP_TYPE[] = "Type";
static const char TYPE_PROP_EXTENSIONS[] = "Extensions";
// setup.xcu
static const char CFG_ENTRY_PROP_EMPTYDOCUMENTURL[] = "ooSetupFactoryEmptyDocumentURL";
static const char CFG_ENTRY_PROP_FACTORYSERVICE[] = "ooSetupFactoryDocumentService";
static const char EVENT_ON_NEW[] = "OnNew";
static const char EVENT_ON_LOAD[] = "OnLoad";
static const char EVENT_ON_UNLOAD[] = "OnUnload";
static const char EVENT_ON_MODIFYCHANGED[] = "OnModifyChanged";
static const char EVENT_ON_SAVE[] = "OnSave";
static const char EVENT_ON_SAVEAS[] = "OnSaveAs";
static const char EVENT_ON_SAVETO[] = "OnCopyTo";
static const char EVENT_ON_SAVEDONE[] = "OnSaveDone";
static const char EVENT_ON_SAVEASDONE[] = "OnSaveAsDone";
static const char EVENT_ON_SAVETODONE[] = "OnCopyToDone";
static const char EVENT_ON_SAVEFAILED[] = "OnSaveFailed";
static const char EVENT_ON_SAVEASFAILED[] = "OnSaveAsFailed";
static const char EVENT_ON_SAVETOFAILED[] = "OnCopyToFailed";
static const char RECOVERY_ITEM_BASE_IDENTIFIER[] = "recovery_item_";
static const char CMD_PROTOCOL[] = "vnd.sun.star.autorecovery:";
static const char CMD_DO_AUTO_SAVE[] = "/doAutoSave"; // force AutoSave ignoring the AutoSave timer
static const char CMD_DO_PREPARE_EMERGENCY_SAVE[] = "/doPrepareEmergencySave"; // prepare the office for the following EmergencySave step (hide windows etcpp.)
static const char CMD_DO_EMERGENCY_SAVE[] = "/doEmergencySave"; // do EmergencySave on crash
static const char CMD_DO_RECOVERY[] = "/doAutoRecovery"; // recover all crashed documents
static const char CMD_DO_ENTRY_BACKUP[] = "/doEntryBackup"; // try to store a temp or original file to a user defined location
static const char CMD_DO_ENTRY_CLEANUP[] = "/doEntryCleanUp"; // remove the specified entry from the recovery cache
static const char CMD_DO_SESSION_SAVE[] = "/doSessionSave"; // save all open documents if e.g. a window manager closes an user session
static const char CMD_DO_SESSION_QUIET_QUIT[] = "/doSessionQuietQuit"; // let the current session be quietly closed ( the saving should be done using doSessionSave previously ) if e.g. a window manager closes an user session
static const char CMD_DO_SESSION_RESTORE[] = "/doSessionRestore"; // restore a saved user session from disc
static const char CMD_DO_DISABLE_RECOVERY[] = "/disableRecovery"; // disable recovery and auto save (!) temp. for this office session
static const char CMD_DO_SET_AUTOSAVE_STATE[] = "/setAutoSaveState"; // disable/enable auto save (not crash save) for this office session
static const char REFERRER_USER[] = "private:user";
static const char PROP_DISPATCH_ASYNCHRON[] = "DispatchAsynchron";
static const char PROP_PROGRESS[] = "StatusIndicator";
static const char PROP_SAVEPATH[] = "SavePath";
static const char PROP_ENTRY_ID[] = "EntryID";
static const char PROP_AUTOSAVE_STATE[] = "AutoSaveState";
static const char OPERATION_START[] = "start";
static const char OPERATION_STOP[] = "stop";
static const char OPERATION_UPDATE[] = "update";
static const sal_Int32 MIN_DISCSPACE_DOCSAVE = 5; // [MB]
static const sal_Int32 MIN_DISCSPACE_CONFIGSAVE = 1; // [MB]
static const sal_Int32 RETRY_STORE_ON_FULL_DISC_FOREVER = 300; // not forever ... but often enough .-)
static const sal_Int32 RETRY_STORE_ON_MIGHT_FULL_DISC_USEFULL = 3; // in case FULL DISC does not seem the real problem
static const sal_Int32 GIVE_UP_RETRY = 1; // in case FULL DISC does not seem the real problem
#define SAVE_IN_PROGRESS true
#define SAVE_FINISHED false
#define LOCK_FOR_CACHE_ADD_REMOVE true
#define LOCK_FOR_CACHE_USE false
#define MIN_TIME_FOR_USER_IDLE 10000 // 10s user idle
// enable the following defines in case you wish to simulate a full disc for debug purposes .-)
// this define throws every time a document is stored or a configuration change
// should be flushed an exception ... so the special error handler for this scenario is triggered
// #define TRIGGER_FULL_DISC_CHECK
// force "return sal_False" for the method impl_enoughDiscSpace().
// #define SIMULATE_FULL_DISC
class CacheLockGuard
{
private:
// holds the outside calli alive, so it's shared resources
// are valid every time
css::uno::Reference< css::uno::XInterface > m_xOwner;
// mutex shared with outside calli !
osl::Mutex& m_rSharedMutex;
// this variable knows the state of the "cache lock"
sal_Int32& m_rCacheLock;
// to prevent increasing/decreasing of m_rCacheLock more than ones
// we must know if THIS guard has an actual lock set there !
bool m_bLockedByThisGuard;
public:
CacheLockGuard(AutoRecovery* pOwner ,
osl::Mutex& rMutex ,
sal_Int32& rCacheLock ,
bool bLockForAddRemoveVectorItems);
~CacheLockGuard();
void lock(bool bLockForAddRemoveVectorItems);
void unlock();
};
CacheLockGuard::CacheLockGuard(AutoRecovery* pOwner ,
osl::Mutex& rMutex ,
sal_Int32& rCacheLock ,
bool bLockForAddRemoveVectorItems)
: m_xOwner (static_cast< css::frame::XDispatch* >(pOwner))
, m_rSharedMutex (rMutex )
, m_rCacheLock (rCacheLock )
, m_bLockedByThisGuard(false )
{
lock(bLockForAddRemoveVectorItems);
}
CacheLockGuard::~CacheLockGuard()
{
unlock();
m_xOwner.clear();
}
void CacheLockGuard::lock(bool bLockForAddRemoveVectorItems)
{
/* SAFE */ {
osl::MutexGuard g(m_rSharedMutex);
if (m_bLockedByThisGuard)
return;
// This cache lock is needed only to prevent us from removing/adding
// items from/into the recovery cache ... during it's used at another code place
// for iterating .-)
// Modifying of item properties is allowed and sometimes needed!
// So we should detect only the dangerous state of concurrent add/remove
// requests and throw an exception then ... which can of course break the whole
// operation. On the other side a crash reasoned by an invalid stl iterator
// will have the same effect .-)
if ( (m_rCacheLock > 0) && bLockForAddRemoveVectorItems )
{
OSL_FAIL("Re-entrance problem detected. Using of an stl structure in combination with iteration, adding, removing of elements etcpp.");
throw css::uno::RuntimeException(
"Re-entrance problem detected. Using of an stl structure in combination with iteration, adding, removing of elements etcpp.",
m_xOwner);
}
++m_rCacheLock;
m_bLockedByThisGuard = true;
} /* SAFE */
}
void CacheLockGuard::unlock()
{
/* SAFE */ {
osl::MutexGuard g(m_rSharedMutex);
if ( ! m_bLockedByThisGuard)
return;
--m_rCacheLock;
m_bLockedByThisGuard = false;
if (m_rCacheLock < 0)
{
OSL_FAIL("Wrong using of member m_nDocCacheLock detected. A ref counted value shouldn't reach values <0 .-)");
throw css::uno::RuntimeException(
"Wrong using of member m_nDocCacheLock detected. A ref counted value shouldn't reach values <0 .-)",
m_xOwner);
}
} /* SAFE */
}
DispatchParams::DispatchParams()
: m_nWorkingEntryID(-1)
{
};
DispatchParams::DispatchParams(const ::comphelper::SequenceAsHashMap& lArgs ,
const css::uno::Reference< css::uno::XInterface >& xOwner)
{
m_nWorkingEntryID = lArgs.getUnpackedValueOrDefault(PROP_ENTRY_ID, (sal_Int32)-1 );
m_xProgress = lArgs.getUnpackedValueOrDefault(PROP_PROGRESS, css::uno::Reference< css::task::XStatusIndicator >());
m_sSavePath = lArgs.getUnpackedValueOrDefault(PROP_SAVEPATH, OUString() );
m_xHoldRefForAsyncOpAlive = xOwner;
};
void DispatchParams::forget()
{
m_sSavePath.clear();
m_nWorkingEntryID = -1;
m_xProgress.clear();
m_xHoldRefForAsyncOpAlive.clear();
};
AutoRecovery::AutoRecovery(const css::uno::Reference< css::uno::XComponentContext >& xContext)
: AutoRecovery_BASE (m_aMutex)
, ::cppu::OPropertySetHelper(cppu::WeakComponentImplHelperBase::rBHelper)
, m_xContext (xContext )
, m_bListenForDocEvents (false )
, m_bListenForConfigChanges (false )
, m_nAutoSaveTimeIntervall (0 )
, m_eJob (AutoRecovery::E_NO_JOB )
, m_aTimer ( "Auto save timer" )
, m_aAsyncDispatcher ( LINK( this, AutoRecovery, implts_asyncDispatch ) )
, m_eTimerType (E_DONT_START_TIMER )
, m_nIdPool (0 )
, m_lListener (cppu::WeakComponentImplHelperBase::rBHelper.rMutex)
, m_nDocCacheLock (0 )
, m_nMinSpaceDocSave (MIN_DISCSPACE_DOCSAVE )
, m_nMinSpaceConfigSave (MIN_DISCSPACE_CONFIGSAVE )
{
m_aTimer.SetDebugName( "framework::AutoRecovery m_aTimer" );
}
void AutoRecovery::initListeners()
{
// read configuration to know if autosave/recovery is on/off etcpp...
implts_readConfig();
implts_startListening();
// establish callback for our internal used timer.
// Note: Its only active, if the timer will be started ...
SolarMutexGuard g;
m_aTimer.SetInvokeHandler(LINK(this, AutoRecovery, implts_timerExpired));
}
AutoRecovery::~AutoRecovery()
{
assert(!m_aTimer.IsActive());
}
void AutoRecovery::disposing()
{
implts_stopTimer();
}
Any SAL_CALL AutoRecovery::queryInterface( const css::uno::Type& _rType )
{
Any aRet = AutoRecovery_BASE::queryInterface( _rType );
if ( !aRet.hasValue() )
aRet = OPropertySetHelper::queryInterface( _rType );
return aRet;
}
Sequence< css::uno::Type > SAL_CALL AutoRecovery::getTypes( )
{
return comphelper::concatSequences(
AutoRecovery_BASE::getTypes(),
::cppu::OPropertySetHelper::getTypes()
);
}
void SAL_CALL AutoRecovery::dispatch(const css::util::URL& aURL ,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments)
{
SAL_INFO("fwk.autorecovery", "AutoRecovery::dispatch() starts ..." << aURL.Complete);
// valid request ?
sal_Int32 eNewJob = AutoRecovery::implst_classifyJob(aURL);
if (eNewJob == AutoRecovery::E_NO_JOB)
return;
bool bAsync;
DispatchParams aParams;
/* SAFE */ {
osl::ClearableMutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// still running operation ... ignoring AUTO_SAVE.
// All other requests has higher prio!
if (
( m_eJob != AutoRecovery::E_NO_JOB ) &&
((m_eJob & AutoRecovery::E_AUTO_SAVE ) != AutoRecovery::E_AUTO_SAVE)
)
{
SAL_INFO("fwk.autorecovery", "AutoRecovery::dispatch(): There is already an asynchronous dispatch() running. New request will be ignored!");
return;
}
::comphelper::SequenceAsHashMap lArgs(lArguments);
// check if somewhere wish to disable recovery temp. for this office session
// This can be done immediately... must not been done asynchronous.
if ((eNewJob & AutoRecovery::E_DISABLE_AUTORECOVERY) == AutoRecovery::E_DISABLE_AUTORECOVERY)
{
// it's important to set a flag internally, so AutoRecovery will be suppressed - even if it's requested.
m_eJob |= eNewJob;
implts_stopTimer();
implts_stopListening();
return;
}
// disable/enable AutoSave for this office session only
// independent from the configuration entry.
if ((eNewJob & AutoRecovery::E_SET_AUTOSAVE_STATE) == AutoRecovery::E_SET_AUTOSAVE_STATE)
{
bool bOn = lArgs.getUnpackedValueOrDefault(PROP_AUTOSAVE_STATE, true);
if (bOn)
{
// don't enable AutoSave hardly !
// reload configuration to know the current state.
implts_readAutoSaveConfig();
g.clear();
implts_updateTimer();
// can it happen that might be the listener was stopped? .-)
// make sure it runs always... even if AutoSave itself was disabled temporarily.
implts_startListening();
}
else
{
implts_stopTimer();
m_eJob &= ~AutoRecovery::E_AUTO_SAVE;
m_eTimerType = AutoRecovery::E_DONT_START_TIMER;
}
return;
}
m_eJob |= eNewJob;
bAsync = lArgs.getUnpackedValueOrDefault(PROP_DISPATCH_ASYNCHRON, false);
aParams = DispatchParams(lArgs, static_cast< css::frame::XDispatch* >(this));
// Hold this instance alive till the asynchronous operation will be finished.
if (bAsync)
m_aDispatchParams = aParams;
} /* SAFE */
if (bAsync)
m_aAsyncDispatcher.Post();
else
implts_dispatch(aParams);
}
void AutoRecovery::ListenerInformer::start()
{
m_rRecovery.implts_informListener(m_eJob,
AutoRecovery::implst_createFeatureStateEvent(m_eJob, OPERATION_START, nullptr));
}
void AutoRecovery::ListenerInformer::stop()
{
if (m_bStopped)
return;
m_rRecovery.implts_informListener(m_eJob,
AutoRecovery::implst_createFeatureStateEvent(m_eJob, OPERATION_STOP, nullptr));
m_bStopped = true;
}
void AutoRecovery::implts_dispatch(const DispatchParams& aParams)
{
sal_Int32 eJob;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
eJob = m_eJob;
} /* SAFE */
// in case a new dispatch overwrites a may ba active AutoSave session
// we must restore this session later. see below ...
bool bWasAutoSaveActive = ((eJob & AutoRecovery::E_AUTO_SAVE) == AutoRecovery::E_AUTO_SAVE);
bool bWasUserAutoSaveActive =
((eJob & AutoRecovery::E_USER_AUTO_SAVE) == AutoRecovery::E_USER_AUTO_SAVE);
// On the other side it make no sense to reactivate the AutoSave operation
// if the new dispatch indicates a final decision ...
// E.g. an EmergencySave/SessionSave indicates the end of life of the current office session.
// It make no sense to reactivate an AutoSave then.
// But a Recovery or SessionRestore should reactivate a may be already active AutoSave.
bool bAllowAutoSaveReactivation = true;
implts_stopTimer();
implts_stopListening();
ListenerInformer aListenerInformer(*this, eJob);
aListenerInformer.start();
try
{
// Auto save is called from our internal timer ... not via dispatch() API !
// else
if (
((eJob & AutoRecovery::E_PREPARE_EMERGENCY_SAVE) == AutoRecovery::E_PREPARE_EMERGENCY_SAVE) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY ) != AutoRecovery::E_DISABLE_AUTORECOVERY )
)
{
SAL_INFO("fwk.autorecovery", "... prepare emergency save ...");
bAllowAutoSaveReactivation = false;
implts_prepareEmergencySave();
}
else
if (
((eJob & AutoRecovery::E_EMERGENCY_SAVE ) == AutoRecovery::E_EMERGENCY_SAVE ) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) != AutoRecovery::E_DISABLE_AUTORECOVERY)
)
{
SAL_INFO("fwk.autorecovery", "... do emergency save ...");
bAllowAutoSaveReactivation = false;
implts_doEmergencySave(aParams);
}
else
if (
((eJob & AutoRecovery::E_RECOVERY ) == AutoRecovery::E_RECOVERY ) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) != AutoRecovery::E_DISABLE_AUTORECOVERY)
)
{
SAL_INFO("fwk.autorecovery", "... do recovery ...");
implts_doRecovery(aParams);
}
else
if (
((eJob & AutoRecovery::E_SESSION_SAVE ) == AutoRecovery::E_SESSION_SAVE ) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) != AutoRecovery::E_DISABLE_AUTORECOVERY)
)
{
SAL_INFO("fwk.autorecovery", "... do session save ...");
bAllowAutoSaveReactivation = false;
implts_doSessionSave(aParams);
}
else
if (
((eJob & AutoRecovery::E_SESSION_QUIET_QUIT ) == AutoRecovery::E_SESSION_QUIET_QUIT ) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) != AutoRecovery::E_DISABLE_AUTORECOVERY)
)
{
SAL_INFO("fwk.autorecovery", "... do session quiet quit ...");
bAllowAutoSaveReactivation = false;
implts_doSessionQuietQuit();
}
else
if (
((eJob & AutoRecovery::E_SESSION_RESTORE ) == AutoRecovery::E_SESSION_RESTORE ) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) != AutoRecovery::E_DISABLE_AUTORECOVERY)
)
{
SAL_INFO("fwk.autorecovery", "... do session restore ...");
implts_doSessionRestore(aParams);
}
else
if (
((eJob & AutoRecovery::E_ENTRY_BACKUP ) == AutoRecovery::E_ENTRY_BACKUP ) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) != AutoRecovery::E_DISABLE_AUTORECOVERY)
)
implts_backupWorkingEntry(aParams);
else
if (
((eJob & AutoRecovery::E_ENTRY_CLEANUP ) == AutoRecovery::E_ENTRY_CLEANUP ) &&
((eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) != AutoRecovery::E_DISABLE_AUTORECOVERY)
)
implts_cleanUpWorkingEntry(aParams);
}
catch(const css::uno::RuntimeException&)
{
throw;
}
catch(const css::uno::Exception&)
{
// TODO better error handling
}
aListenerInformer.stop();
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_eJob = E_NO_JOB;
if ( bAllowAutoSaveReactivation && bWasAutoSaveActive )
{
m_eJob |= AutoRecovery::E_AUTO_SAVE;
if (bWasUserAutoSaveActive)
{
m_eJob |= AutoRecovery::E_USER_AUTO_SAVE;
}
}
} /* SAFE */
// depends on bAllowAutoSaveReactivation implicitly by looking on m_eJob=E_AUTO_SAVE! see before ...
implts_updateTimer();
if (bAllowAutoSaveReactivation)
implts_startListening();
}
void SAL_CALL AutoRecovery::addStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
const css::util::URL& aURL )
{
if (!xListener.is())
throw css::uno::RuntimeException("Invalid listener reference.", static_cast< css::frame::XDispatch* >(this));
// container is threadsafe by using a shared mutex!
m_lListener.addInterface(aURL.Complete, xListener);
// REENTRANT !? -> --------------------------------
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
/* SAFE */ {
osl::ResettableMutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
AutoRecovery::TDocumentList::iterator pIt;
for( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
AutoRecovery::TDocumentInfo& rInfo = *pIt;
css::frame::FeatureStateEvent aEvent = AutoRecovery::implst_createFeatureStateEvent(m_eJob, OPERATION_UPDATE, &rInfo);
// } /* SAFE */
g.clear();
xListener->statusChanged(aEvent);
g.reset();
// /* SAFE */ {
}
} /* SAFE */
}
void SAL_CALL AutoRecovery::removeStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
const css::util::URL& aURL )
{
if (!xListener.is())
throw css::uno::RuntimeException("Invalid listener reference.", static_cast< css::frame::XDispatch* >(this));
// container is threadsafe by using a shared mutex!
m_lListener.removeInterface(aURL.Complete, xListener);
}
void SAL_CALL AutoRecovery::documentEventOccured(const css::document::DocumentEvent& aEvent)
{
css::uno::Reference< css::frame::XModel > xDocument(aEvent.Source, css::uno::UNO_QUERY);
// new document => put it into the internal list
if (
(aEvent.EventName == EVENT_ON_NEW) ||
(aEvent.EventName == EVENT_ON_LOAD)
)
{
implts_registerDocument(xDocument);
}
// document modified => set its modify state new (means modified against the original file!)
else if ( aEvent.EventName == EVENT_ON_MODIFYCHANGED )
{
implts_updateModifiedState(xDocument);
}
/* at least one document starts saving process =>
Our application code is not ready for multiple save requests
at the same time. So we have to suppress our AutoSave feature
for the moment, till this other save requests will be finished.
*/
else if (
(aEvent.EventName == EVENT_ON_SAVE) ||
(aEvent.EventName == EVENT_ON_SAVEAS) ||
(aEvent.EventName == EVENT_ON_SAVETO)
)
{
implts_updateDocumentUsedForSavingState(xDocument, SAVE_IN_PROGRESS);
}
// document saved => remove tmp. files - but hold config entries alive!
else if (
(aEvent.EventName == EVENT_ON_SAVEDONE) ||
(aEvent.EventName == EVENT_ON_SAVEASDONE)
)
{
implts_markDocumentAsSaved(xDocument);
implts_updateDocumentUsedForSavingState(xDocument, SAVE_FINISHED);
}
/* document saved as copy => mark it as "non used by concurrent save operation".
so we can try to create a backup copy if next time AutoSave is started too.
Don't remove temp. files or change the modified state of the document!
It was not really saved to the original file...
*/
else if ( aEvent.EventName == EVENT_ON_SAVETODONE )
{
implts_updateDocumentUsedForSavingState(xDocument, SAVE_FINISHED);
}
// If saving of a document failed by an error ... we have to save this document
// by ourself next time AutoSave or EmergencySave is triggered.
// But we can reset the state "used for other save requests". Otherwhise
// these documents will never be saved!
else if (
(aEvent.EventName == EVENT_ON_SAVEFAILED) ||
(aEvent.EventName == EVENT_ON_SAVEASFAILED) ||
(aEvent.EventName == EVENT_ON_SAVETOFAILED)
)
{
implts_updateDocumentUsedForSavingState(xDocument, SAVE_FINISHED);
}
// document closed => remove temp. files and configuration entries
else if ( aEvent.EventName == EVENT_ON_UNLOAD )
{
implts_deregisterDocument(xDocument); // sal_True => stop listening for disposing() !
}
}
void SAL_CALL AutoRecovery::changesOccurred(const css::util::ChangesEvent& aEvent)
{
const css::uno::Sequence< css::util::ElementChange > lChanges (aEvent.Changes);
const css::util::ElementChange* pChanges = lChanges.getConstArray();
sal_Int32 c = lChanges.getLength();
sal_Int32 i = 0;
/* SAFE */ {
osl::ResettableMutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// Changes of the configuration must be ignored if AutoSave/Recovery was disabled for this
// office session. That can happen if e.g. the command line arguments "--norestore" or "--headless"
// was set.
if ((m_eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) == AutoRecovery::E_DISABLE_AUTORECOVERY)
return;
for (i=0; i<c; ++i)
{
OUString sPath;
pChanges[i].Accessor >>= sPath;
if ( sPath == CFG_ENTRY_AUTOSAVE_ENABLED )
{
bool bEnabled = false;
if (pChanges[i].Element >>= bEnabled)
{
if (bEnabled)
{
m_eJob |= AutoRecovery::E_AUTO_SAVE;
m_eTimerType = AutoRecovery::E_NORMAL_AUTOSAVE_INTERVALL;
}
else
{
m_eJob &= ~AutoRecovery::E_AUTO_SAVE;
m_eTimerType = AutoRecovery::E_DONT_START_TIMER;
}
}
}
else
if ( sPath == CFG_ENTRY_AUTOSAVE_TIMEINTERVALL )
pChanges[i].Element >>= m_nAutoSaveTimeIntervall;
}
} /* SAFE */
// Note: This call stops the timer and starts it again.
// But it checks the different timer states internally and
// may be suppress the restart!
implts_updateTimer();
}
void SAL_CALL AutoRecovery::modified(const css::lang::EventObject& aEvent)
{
css::uno::Reference< css::frame::XModel > xDocument(aEvent.Source, css::uno::UNO_QUERY);
if (! xDocument.is())
return;
implts_markDocumentModifiedAgainstLastBackup(xDocument);
}
void SAL_CALL AutoRecovery::disposing(const css::lang::EventObject& aEvent)
{
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
if (aEvent.Source == m_xNewDocBroadcaster)
{
m_xNewDocBroadcaster.clear();
return;
}
if (aEvent.Source == m_xRecoveryCFG)
{
m_xRecoveryCFG.clear();
return;
}
// dispose from one of our cached documents ?
// Normally they should send a OnUnload message ...
// But some stacktraces shows another possible use case .-)
css::uno::Reference< css::frame::XModel > xDocument(aEvent.Source, css::uno::UNO_QUERY);
if (xDocument.is())
{
implts_deregisterDocument(xDocument, false); // sal_False => don't call removeEventListener() .. because it's not needed here
return;
}
} /* SAFE */
}
css::uno::Reference< css::container::XNameAccess > AutoRecovery::implts_openConfig()
{
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
if (m_xRecoveryCFG.is())
return m_xRecoveryCFG;
} /* SAFE */
OUString sCFG_PACKAGE_RECOVERY(CFG_PACKAGE_RECOVERY);
// throws a RuntimeException if an error occurs!
css::uno::Reference< css::container::XNameAccess > xCFG(
::comphelper::ConfigurationHelper::openConfig(m_xContext, sCFG_PACKAGE_RECOVERY, ::comphelper::EConfigurationModes::Standard),
css::uno::UNO_QUERY);
sal_Int32 nMinSpaceDocSave = MIN_DISCSPACE_DOCSAVE;
sal_Int32 nMinSpaceConfigSave = MIN_DISCSPACE_CONFIGSAVE;
try
{
OUString sCFG_PATH_AUTOSAVE(CFG_PATH_AUTOSAVE);
::comphelper::ConfigurationHelper::readDirectKey(m_xContext,
sCFG_PACKAGE_RECOVERY,
sCFG_PATH_AUTOSAVE,
CFG_ENTRY_MINSPACE_DOCSAVE,
::comphelper::EConfigurationModes::Standard) >>= nMinSpaceDocSave;
::comphelper::ConfigurationHelper::readDirectKey(m_xContext,
sCFG_PACKAGE_RECOVERY,
sCFG_PATH_AUTOSAVE,
CFG_ENTRY_MINSPACE_CONFIGSAVE,
::comphelper::EConfigurationModes::Standard) >>= nMinSpaceConfigSave;
}
catch(const css::uno::Exception&)
{
// These config keys are not sooooo important, that
// we are interested on errors here really .-)
nMinSpaceDocSave = MIN_DISCSPACE_DOCSAVE;
nMinSpaceConfigSave = MIN_DISCSPACE_CONFIGSAVE;
}
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_xRecoveryCFG = xCFG;
m_nMinSpaceDocSave = nMinSpaceDocSave;
m_nMinSpaceConfigSave = nMinSpaceConfigSave;
} /* SAFE */
return xCFG;
}
void AutoRecovery::implts_readAutoSaveConfig()
{
css::uno::Reference< css::container::XHierarchicalNameAccess > xCommonRegistry(implts_openConfig(), css::uno::UNO_QUERY);
// AutoSave [bool]
bool bEnabled = false;
xCommonRegistry->getByHierarchicalName(CFG_ENTRY_AUTOSAVE_ENABLED) >>= bEnabled;
// UserAutoSave [bool]
bool bUserEnabled = false;
xCommonRegistry->getByHierarchicalName(CFG_ENTRY_USERAUTOSAVE_ENABLED) >>= bUserEnabled;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
if (bEnabled)
{
m_eJob |= AutoRecovery::E_AUTO_SAVE;
m_eTimerType = AutoRecovery::E_NORMAL_AUTOSAVE_INTERVALL;
if (bUserEnabled)
{
m_eJob |= AutoRecovery::E_USER_AUTO_SAVE;
}
else
{
m_eJob &= ~AutoRecovery::E_USER_AUTO_SAVE;
}
}
else
{
m_eJob &= ~AutoRecovery::E_AUTO_SAVE;
m_eTimerType = AutoRecovery::E_DONT_START_TIMER;
}
} /* SAFE */
// AutoSaveTimeIntervall [int] in min
sal_Int32 nTimeIntervall = 10;
xCommonRegistry->getByHierarchicalName(CFG_ENTRY_AUTOSAVE_TIMEINTERVALL) >>= nTimeIntervall;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_nAutoSaveTimeIntervall = nTimeIntervall;
} /* SAFE */
}
void AutoRecovery::implts_readConfig()
{
implts_readAutoSaveConfig();
css::uno::Reference< css::container::XHierarchicalNameAccess > xCommonRegistry(implts_openConfig(), css::uno::UNO_QUERY);
// REENTRANT -> --------------------------------
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_ADD_REMOVE);
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// reset current cache load cache
m_lDocCache.clear();
m_nIdPool = 0;
} /* SAFE */
aCacheLock.unlock();
// <- REENTRANT --------------------------------
css::uno::Any aValue;
// RecoveryList [set]
aValue = xCommonRegistry->getByHierarchicalName(CFG_ENTRY_RECOVERYLIST);
css::uno::Reference< css::container::XNameAccess > xList;
aValue >>= xList;
if (xList.is())
{
const OUString sRECOVERY_ITEM_BASE_IDENTIFIER(RECOVERY_ITEM_BASE_IDENTIFIER);
const css::uno::Sequence< OUString > lItems = xList->getElementNames();
const OUString* pItems = lItems.getConstArray();
sal_Int32 c = lItems.getLength();
sal_Int32 i = 0;
// REENTRANT -> --------------------------
aCacheLock.lock(LOCK_FOR_CACHE_ADD_REMOVE);
for (i=0; i<c; ++i)
{
css::uno::Reference< css::beans::XPropertySet > xItem;
xList->getByName(pItems[i]) >>= xItem;
if (!xItem.is())
continue;
AutoRecovery::TDocumentInfo aInfo;
aInfo.NewTempURL.clear();
aInfo.Document.clear();
xItem->getPropertyValue(CFG_ENTRY_PROP_ORIGINALURL) >>= aInfo.OrgURL;
xItem->getPropertyValue(CFG_ENTRY_PROP_TEMPURL) >>= aInfo.OldTempURL;
xItem->getPropertyValue(CFG_ENTRY_PROP_TEMPLATEURL) >>= aInfo.TemplateURL;
xItem->getPropertyValue(CFG_ENTRY_PROP_FILTER) >>= aInfo.RealFilter;
xItem->getPropertyValue(CFG_ENTRY_PROP_DOCUMENTSTATE) >>= aInfo.DocumentState;
xItem->getPropertyValue(CFG_ENTRY_PROP_MODULE) >>= aInfo.AppModule;
xItem->getPropertyValue(CFG_ENTRY_PROP_TITLE) >>= aInfo.Title;
xItem->getPropertyValue(CFG_ENTRY_PROP_VIEWNAMES) >>= aInfo.ViewNames;
implts_specifyAppModuleAndFactory(aInfo);
implts_specifyDefaultFilterAndExtension(aInfo);
if (pItems[i].startsWith(sRECOVERY_ITEM_BASE_IDENTIFIER))
{
OUString sID = pItems[i].copy(sRECOVERY_ITEM_BASE_IDENTIFIER.getLength());
aInfo.ID = sID.toInt32();
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
if (aInfo.ID > m_nIdPool)
{
m_nIdPool = aInfo.ID+1;
SAL_WARN_IF(m_nIdPool<0, "fwk.autorecovery", "AutoRecovery::implts_readConfig(): Overflow of IDPool detected!");
}
} /* SAFE */
}
else
SAL_INFO("fwk.autorecovery", "AutoRecovery::implts_readConfig(): Who changed numbering of recovery items? Cache will be inconsistent then! I do not know, what will happen next time .-)");
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_lDocCache.push_back(aInfo);
} /* SAFE */
}
aCacheLock.unlock();
// <- REENTRANT --------------------------
}
implts_updateTimer();
}
void AutoRecovery::implts_specifyDefaultFilterAndExtension(AutoRecovery::TDocumentInfo& rInfo)
{
if (rInfo.AppModule.isEmpty())
{
throw css::uno::RuntimeException(
"Can not find out the default filter and its extension, if no application module is known!",
static_cast< css::frame::XDispatch* >(this));
}
css::uno::Reference< css::container::XNameAccess> xCFG;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
xCFG = m_xModuleCFG;
} /* SAFE */
try
{
if (! xCFG.is())
{
// open module config on demand and cache the update access
xCFG.set( ::comphelper::ConfigurationHelper::openConfig(m_xContext, CFG_PACKAGE_MODULES,
::comphelper::EConfigurationModes::Standard),
css::uno::UNO_QUERY_THROW);
/* SAFE */ {
osl::MutexGuard g2(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_xModuleCFG = xCFG;
} /* SAFE */
}
css::uno::Reference< css::container::XNameAccess > xModuleProps(
xCFG->getByName(rInfo.AppModule),
css::uno::UNO_QUERY_THROW);
xModuleProps->getByName(CFG_ENTRY_REALDEFAULTFILTER) >>= rInfo.DefaultFilter;
css::uno::Reference< css::container::XNameAccess > xFilterCFG(
m_xContext->getServiceManager()->createInstanceWithContext(
"com.sun.star.document.FilterFactory", m_xContext), css::uno::UNO_QUERY_THROW);
css::uno::Reference< css::container::XNameAccess > xTypeCFG(
m_xContext->getServiceManager()->createInstanceWithContext(
"com.sun.star.document.TypeDetection", m_xContext), css::uno::UNO_QUERY_THROW);
::comphelper::SequenceAsHashMap lFilterProps (xFilterCFG->getByName(rInfo.DefaultFilter));
OUString sTypeRegistration = lFilterProps.getUnpackedValueOrDefault(FILTER_PROP_TYPE, OUString());
::comphelper::SequenceAsHashMap lTypeProps (xTypeCFG->getByName(sTypeRegistration));
css::uno::Sequence< OUString > lExtensions = lTypeProps.getUnpackedValueOrDefault(TYPE_PROP_EXTENSIONS, css::uno::Sequence< OUString >());
if (lExtensions.getLength())
{
rInfo.Extension = "." + lExtensions[0];
}
else
rInfo.Extension = ".unknown";
}
catch(const css::uno::Exception&)
{
rInfo.DefaultFilter.clear();
rInfo.Extension.clear();
}
}
void AutoRecovery::implts_specifyAppModuleAndFactory(AutoRecovery::TDocumentInfo& rInfo)
{
ENSURE_OR_THROW2(
!rInfo.AppModule.isEmpty() || rInfo.Document.is(),
"Can not find out the application module nor its factory URL, if no application module (or a suitable) document is known!",
*this );
css::uno::Reference< css::frame::XModuleManager2 > xManager = ModuleManager::create(m_xContext);
if (rInfo.AppModule.isEmpty())
rInfo.AppModule = xManager->identify(rInfo.Document);
::comphelper::SequenceAsHashMap lModuleDescription(xManager->getByName(rInfo.AppModule));
lModuleDescription[OUString(CFG_ENTRY_PROP_EMPTYDOCUMENTURL)] >>= rInfo.FactoryURL;
lModuleDescription[OUString(CFG_ENTRY_PROP_FACTORYSERVICE)] >>= rInfo.FactoryService;
}
void AutoRecovery::implts_collectActiveViewNames( AutoRecovery::TDocumentInfo& i_rInfo )
{
ENSURE_OR_THROW2( i_rInfo.Document.is(), "need at document, at the very least", *this );
i_rInfo.ViewNames.realloc(0);
// obtain list of controllers of this document
::std::vector< OUString > aViewNames;
const Reference< XModel2 > xModel( i_rInfo.Document, UNO_QUERY );
if ( xModel.is() )
{
const Reference< css::container::XEnumeration > xEnumControllers( xModel->getControllers() );
while ( xEnumControllers->hasMoreElements() )
{
const Reference< XController2 > xController( xEnumControllers->nextElement(), UNO_QUERY );
OUString sViewName;
if ( xController.is() )
sViewName = xController->getViewControllerName();
OSL_ENSURE( !sViewName.isEmpty(), "AutoRecovery::implts_collectActiveViewNames: (no XController2 ->) no view name -> no recovery of this view!" );
if ( !sViewName.isEmpty() )
aViewNames.push_back( sViewName );
}
}
else
{
const Reference< XController2 > xController( xModel->getCurrentController(), UNO_QUERY );
OUString sViewName;
if ( xController.is() )
sViewName = xController->getViewControllerName();
OSL_ENSURE( !sViewName.isEmpty(), "AutoRecovery::implts_collectActiveViewNames: (no XController2 ->) no view name -> no recovery of this view!" );
if ( !sViewName.isEmpty() )
aViewNames.push_back( sViewName );
}
i_rInfo.ViewNames.realloc( aViewNames.size() );
::std::copy( aViewNames.begin(), aViewNames.end(), i_rInfo.ViewNames.getArray() );
}
void AutoRecovery::implts_persistAllActiveViewNames()
{
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// This list will be filled with every document
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
implts_collectActiveViewNames( *pIt );
implts_flushConfigItem( *pIt );
}
}
void AutoRecovery::implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo, bool bRemoveIt)
{
css::uno::Reference< css::container::XHierarchicalNameAccess > xCFG;
try
{
xCFG.set(implts_openConfig(), css::uno::UNO_QUERY_THROW);
css::uno::Reference< css::container::XNameAccess > xCheck;
xCFG->getByHierarchicalName(CFG_ENTRY_RECOVERYLIST) >>= xCheck;
css::uno::Reference< css::container::XNameContainer > xModify(xCheck, css::uno::UNO_QUERY_THROW);
css::uno::Reference< css::lang::XSingleServiceFactory > xCreate(xCheck, css::uno::UNO_QUERY_THROW);
OUStringBuffer sIDBuf;
sIDBuf.append(RECOVERY_ITEM_BASE_IDENTIFIER);
sIDBuf.append((sal_Int32)rInfo.ID);
OUString sID = sIDBuf.makeStringAndClear();
// remove
if (bRemoveIt)
{
// Catch NoSuchElementException.
// It's not a good idea inside multithreaded environments to call hasElement - removeElement.
// DO IT!
try
{
xModify->removeByName(sID);
}
catch(const css::container::NoSuchElementException&)
{
return;
}
}
else
{
// new/modify
css::uno::Reference< css::beans::XPropertySet > xSet;
bool bNew = (!xCheck->hasByName(sID));
if (bNew)
xSet.set(xCreate->createInstance(), css::uno::UNO_QUERY_THROW);
else
xCheck->getByName(sID) >>= xSet;
xSet->setPropertyValue(CFG_ENTRY_PROP_ORIGINALURL, css::uno::makeAny(rInfo.OrgURL ));
xSet->setPropertyValue(CFG_ENTRY_PROP_TEMPURL, css::uno::makeAny(rInfo.OldTempURL ));
xSet->setPropertyValue(CFG_ENTRY_PROP_TEMPLATEURL, css::uno::makeAny(rInfo.TemplateURL ));
xSet->setPropertyValue(CFG_ENTRY_PROP_FILTER, css::uno::makeAny(rInfo.RealFilter));
xSet->setPropertyValue(CFG_ENTRY_PROP_DOCUMENTSTATE, css::uno::makeAny(rInfo.DocumentState));
xSet->setPropertyValue(CFG_ENTRY_PROP_MODULE, css::uno::makeAny(rInfo.AppModule));
xSet->setPropertyValue(CFG_ENTRY_PROP_TITLE, css::uno::makeAny(rInfo.Title));
xSet->setPropertyValue(CFG_ENTRY_PROP_VIEWNAMES, css::uno::makeAny(rInfo.ViewNames));
if (bNew)
xModify->insertByName(sID, css::uno::makeAny(xSet));
}
}
catch(const css::uno::RuntimeException&)
{
throw;
}
catch(const css::uno::Exception&)
{
// ??? can it happen that a full disc let these set of operations fail too ???
}
sal_Int32 nRetry = RETRY_STORE_ON_FULL_DISC_FOREVER;
do
{
try
{
css::uno::Reference< css::util::XChangesBatch > xFlush(xCFG, css::uno::UNO_QUERY_THROW);
xFlush->commitChanges();
#ifdef TRIGGER_FULL_DISC_CHECK
throw css::uno::Exception();
#else // TRIGGER_FULL_DISC_CHECK
nRetry = 0;
#endif // TRIGGER_FULL_DISC_CHECK
}
catch(const css::uno::Exception&)
{
// a) FULL DISC seems to be the problem behind => show error and retry it forever (e.g. retry=300)
// b) unknown problem (may be locking problem) => reset RETRY value to more useful value(!) (e.g. retry=3)
// c) unknown problem (may be locking problem) + 1..2 repeating operations => throw the original exception to force generation of a stacktrace !
sal_Int32 nMinSpaceConfigSave;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
nMinSpaceConfigSave = m_nMinSpaceConfigSave;
} /* SAFE */
if (! impl_enoughDiscSpace(nMinSpaceConfigSave))
AutoRecovery::impl_showFullDiscError();
else if (nRetry > RETRY_STORE_ON_MIGHT_FULL_DISC_USEFULL)
nRetry = RETRY_STORE_ON_MIGHT_FULL_DISC_USEFULL;
else if (nRetry <= GIVE_UP_RETRY)
throw; // force stacktrace to know if there exist might other reasons, why an AutoSave can fail !!!
--nRetry;
}
}
while(nRetry>0);
}
void AutoRecovery::implts_startListening()
{
css::uno::Reference< css::util::XChangesNotifier > xCFG;
css::uno::Reference< css::frame::XGlobalEventBroadcaster > xBroadcaster;
bool bListenForDocEvents;
bool bListenForConfigChanges;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
xCFG.set (m_xRecoveryCFG, css::uno::UNO_QUERY);
xBroadcaster = m_xNewDocBroadcaster;
bListenForDocEvents = m_bListenForDocEvents;
bListenForConfigChanges = m_bListenForConfigChanges;
} /* SAFE */
if (
( xCFG.is() ) &&
(! bListenForConfigChanges)
)
{
css::uno::Reference<css::util::XChangesListener> const xListener(
new WeakChangesListener(this));
xCFG->addChangesListener(xListener);
/* SAFE */ {
osl::MutexGuard g2(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_xRecoveryCFGListener = xListener;
m_bListenForConfigChanges = true;
} /* SAFE */
}
if (!xBroadcaster.is())
{
xBroadcaster = css::frame::theGlobalEventBroadcaster::get(m_xContext);
/* SAFE */ {
osl::MutexGuard g2(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_xNewDocBroadcaster = xBroadcaster;
} /* SAFE */
}
if (
( xBroadcaster.is() ) &&
(! bListenForDocEvents)
)
{
css::uno::Reference<css::document::XDocumentEventListener> const
xListener(new WeakDocumentEventListener(this));
xBroadcaster->addDocumentEventListener(xListener);
/* SAFE */ {
osl::MutexGuard g2(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_xNewDocBroadcasterListener = xListener;
m_bListenForDocEvents = true;
} /* SAFE */
}
}
void AutoRecovery::implts_stopListening()
{
css::uno::Reference< css::util::XChangesNotifier > xCFG;
css::uno::Reference< css::document::XDocumentEventBroadcaster > xGlobalEventBroadcaster;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// Attention: Don't reset our internal members here too.
// May be we must work with our configuration, but don't wish to be informed
// about changes any longer. Needed e.g. during EMERGENCY_SAVE!
xCFG.set (m_xRecoveryCFG , css::uno::UNO_QUERY);
xGlobalEventBroadcaster.set(m_xNewDocBroadcaster, css::uno::UNO_QUERY);
} /* SAFE */
if (
(xGlobalEventBroadcaster.is()) &&
(m_bListenForDocEvents )
)
{
xGlobalEventBroadcaster->removeDocumentEventListener(m_xNewDocBroadcasterListener);
m_bListenForDocEvents = false;
}
if (
(xCFG.is() ) &&
(m_bListenForConfigChanges)
)
{
xCFG->removeChangesListener(m_xRecoveryCFGListener);
m_bListenForConfigChanges = false;
}
}
void AutoRecovery::implts_startModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo)
{
if (rInfo.ListenForModify)
return;
css::uno::Reference< css::util::XModifyBroadcaster > xBroadcaster(rInfo.Document, css::uno::UNO_QUERY);
if (xBroadcaster.is())
{
css::uno::Reference< css::util::XModifyListener > xThis(static_cast< css::frame::XDispatch* >(this), css::uno::UNO_QUERY);
xBroadcaster->addModifyListener(xThis);
rInfo.ListenForModify = true;
}
}
void AutoRecovery::implts_stopModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo)
{
if (! rInfo.ListenForModify)
return;
css::uno::Reference< css::util::XModifyBroadcaster > xBroadcaster(rInfo.Document, css::uno::UNO_QUERY);
if (xBroadcaster.is())
{
css::uno::Reference< css::util::XModifyListener > xThis(static_cast< css::frame::XDispatch* >(this), css::uno::UNO_QUERY);
xBroadcaster->removeModifyListener(xThis);
rInfo.ListenForModify = false;
}
}
void AutoRecovery::implts_updateTimer()
{
implts_stopTimer();
sal_Int32 nMilliSeconds = 0;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
if (
(m_eJob == AutoRecovery::E_NO_JOB ) || // TODO may be superfluous - E_DONT_START_TIMER should be used only
(m_eTimerType == AutoRecovery::E_DONT_START_TIMER)
)
return;
if (m_eTimerType == AutoRecovery::E_NORMAL_AUTOSAVE_INTERVALL)
{
nMilliSeconds = (m_nAutoSaveTimeIntervall*60000); // [min] => 60.000 ms
}
else if (m_eTimerType == AutoRecovery::E_POLL_FOR_USER_IDLE)
{
nMilliSeconds = MIN_TIME_FOR_USER_IDLE;
}
else if (m_eTimerType == AutoRecovery::E_POLL_TILL_AUTOSAVE_IS_ALLOWED)
nMilliSeconds = 300; // there is a minimum time frame, where the user can lose some key input data!
} /* SAFE */
SolarMutexGuard g;
m_aTimer.SetTimeout(nMilliSeconds);
m_aTimer.Start();
}
void AutoRecovery::implts_stopTimer()
{
SolarMutexGuard g;
if (!m_aTimer.IsActive())
return;
m_aTimer.Stop();
}
IMPL_LINK_NOARG(AutoRecovery, implts_timerExpired, Timer *, void)
{
try
{
// This method is called by using a pointer to us.
// But we must be aware that we can be destroyed hardly
// if our uno reference will be gone!
// => Hold this object alive till this method finish its work.
css::uno::Reference< css::uno::XInterface > xSelfHold(static_cast< css::lang::XTypeProvider* >(this));
// Needed! Otherwise every reschedule request allow a new triggered timer event :-(
implts_stopTimer();
// The timer must be ignored if AutoSave/Recovery was disabled for this
// office session. That can happen if e.g. the command line arguments "--norestore" or "--headless"
// was set. But normally the timer was disabled if recovery was disabled ...
// But so we are more "safe" .-)
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
if ((m_eJob & AutoRecovery::E_DISABLE_AUTORECOVERY) == AutoRecovery::E_DISABLE_AUTORECOVERY)
return;
} /* SAFE */
// check some "states", where it's not allowed (better: not a good idea) to
// start an AutoSave. (e.g. if the user makes drag & drop ...)
// Then we poll till this "disallowed" state is gone.
bool bAutoSaveNotAllowed = Application::IsUICaptured();
if (bAutoSaveNotAllowed)
{
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_eTimerType = AutoRecovery::E_POLL_TILL_AUTOSAVE_IS_ALLOWED;
} /* SAFE */
implts_updateTimer();
return;
}
// analyze timer type.
// If we poll for an user idle period, may be we must
// do nothing here and start the timer again.
/* SAFE */ {
osl::ClearableMutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
if (m_eTimerType == AutoRecovery::E_POLL_FOR_USER_IDLE)
{
bool bUserIdle = (Application::GetLastInputInterval()>MIN_TIME_FOR_USER_IDLE);
if (!bUserIdle)
{
g.clear();
implts_updateTimer();
return;
}
}
} /* SAFE */
implts_informListener(AutoRecovery::E_AUTO_SAVE,
AutoRecovery::implst_createFeatureStateEvent(AutoRecovery::E_AUTO_SAVE, OPERATION_START, nullptr));
// force save of all currently open documents
// The called method returns an info, if and how this
// timer must be restarted.
AutoRecovery::ETimerType eSuggestedTimer = implts_saveDocs(true/*bAllowUserIdleLoop*/, false);
// If timer is not used for "short callbacks" (means polling
// for special states) ... reset the handle state of all
// cache items. Such handle state indicates, that a document
// was already saved during the THIS(!) AutoSave session.
// Of course NEXT AutoSave session must be started without
// any "handle" state ...
if (
(eSuggestedTimer == AutoRecovery::E_DONT_START_TIMER ) ||
(eSuggestedTimer == AutoRecovery::E_NORMAL_AUTOSAVE_INTERVALL)
)
{
implts_resetHandleStates();
}
implts_informListener(AutoRecovery::E_AUTO_SAVE,
AutoRecovery::implst_createFeatureStateEvent(AutoRecovery::E_AUTO_SAVE, OPERATION_STOP, nullptr));
// restart timer - because it was disabled before ...
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
m_eTimerType = eSuggestedTimer;
} /* SAFE */
implts_updateTimer();
}
catch(const css::uno::Exception&)
{
}
}
IMPL_LINK_NOARG(AutoRecovery, implts_asyncDispatch, LinkParamNone*, void)
{
DispatchParams aParams;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
aParams = m_aDispatchParams;
css::uno::Reference< css::uno::XInterface > xHoldRefForMethodAlive = aParams.m_xHoldRefForAsyncOpAlive;
m_aDispatchParams.forget(); // clears all members ... including the ref-hold object .-)
} /* SAFE */
try
{
implts_dispatch(aParams);
}
catch (...)
{
}
}
void AutoRecovery::implts_registerDocument(const css::uno::Reference< css::frame::XModel >& xDocument)
{
// ignore corrupted events, where no document is given ... Runtime Error ?!
if (!xDocument.is())
return;
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
// notification for already existing document !
// Can happen if events came in asynchronous on recovery time.
// Then our cache was filled from the configuration ... but now we get some
// asynchronous events from the global event broadcaster. We must be sure that
// we don't add the same document more than once.
AutoRecovery::TDocumentList::iterator pIt = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
if (pIt != m_lDocCache.end())
{
// Normally nothing must be done for this "late" notification.
// But may be the modified state was changed inbetween.
// Check it...
implts_updateModifiedState(xDocument);
return;
}
aCacheLock.unlock();
utl::MediaDescriptor lDescriptor(xDocument->getArgs());
// check if this document must be ignored for recovery !
// Some use cases don't wish support for AutoSave/Recovery ... as e.g. OLE-Server / ActiveX Control etcpp.
bool bNoAutoSave = lDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_NOAUTOSAVE(), false);
if (bNoAutoSave)
return;
// Check if doc is well known on the desktop. Otherwhise ignore it!
// Other frames mostly are used from external programs - e.g. the bean ...
css::uno::Reference< css::frame::XController > xController = xDocument->getCurrentController();
if (!xController.is())
return;
css::uno::Reference< css::frame::XFrame > xFrame = xController->getFrame();
if (!xFrame.is())
return;
css::uno::Reference< css::frame::XDesktop > xDesktop (xFrame->getCreator(), css::uno::UNO_QUERY);
if (!xDesktop.is())
return;
// if the document doesn't support the XDocumentRecovery interface, we're not interested in it.
Reference< XDocumentRecovery > xDocRecovery( xDocument, UNO_QUERY );
if ( !xDocRecovery.is() )
return;
// get all needed information of this document
// We need it to update our cache or to locate already existing elements there!
AutoRecovery::TDocumentInfo aNew;
aNew.Document = xDocument;
// TODO replace getLocation() with getURL() ... it's a workaround currently only!
css::uno::Reference< css::frame::XStorable > xDoc(aNew.Document, css::uno::UNO_QUERY_THROW);
aNew.OrgURL = xDoc->getLocation();
css::uno::Reference< css::frame::XTitle > xTitle(aNew.Document, css::uno::UNO_QUERY_THROW);
aNew.Title = xTitle->getTitle ();
// classify the used application module, which is used by this document.
implts_specifyAppModuleAndFactory(aNew);
// Hack! Check for "illegal office documents"... as e.g. the Basic IDE
// It's not really a full featured office document. It doesn't provide an URL, any filter, a factory URL etcpp.
// TODO file bug to Basic IDE developers. They must remove the office document API from its service.
if (
(aNew.OrgURL.isEmpty()) &&
(aNew.FactoryURL.isEmpty())
)
{
OSL_FAIL( "AutoRecovery::implts_registerDocument: this should not happen anymore!" );
// nowadays, the Basic IDE should already die on the "supports XDocumentRecovery" check. And no other known
// document type fits in here ...
return;
}
// By the way - get some information about the default format for saving!
// and save an information about the real used filter by this document.
// We save this document with DefaultFilter ... and load it with the RealFilter.
implts_specifyDefaultFilterAndExtension(aNew);
aNew.RealFilter = lDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_FILTERNAME() , OUString());
// Further we must know, if this document base on a template.
// Then we must load it in a different way.
css::uno::Reference< css::document::XDocumentPropertiesSupplier > xSupplier(aNew.Document, css::uno::UNO_QUERY);
if (xSupplier.is()) // optional interface!
{
css::uno::Reference< css::document::XDocumentProperties > xDocProps(xSupplier->getDocumentProperties(), css::uno::UNO_QUERY_THROW);
aNew.TemplateURL = xDocProps->getTemplateURL();
}
css::uno::Reference< css::util::XModifiable > xModifyCheck(xDocument, css::uno::UNO_QUERY_THROW);
if (xModifyCheck->isModified())
{
aNew.DocumentState |= AutoRecovery::E_MODIFIED;
}
aCacheLock.lock(LOCK_FOR_CACHE_ADD_REMOVE);
AutoRecovery::TDocumentInfo aInfo;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// create a new cache entry ... this document is not known.
++m_nIdPool;
aNew.ID = m_nIdPool;
SAL_WARN_IF(m_nIdPool<0, "fwk.autorecovery", "AutoRecovery::implts_registerDocument(): Overflow of ID pool detected.");
m_lDocCache.push_back(aNew);
AutoRecovery::TDocumentList::iterator pIt1 = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
aInfo = *pIt1;
} /* SAFE */
implts_flushConfigItem(aInfo);
implts_startModifyListeningOnDoc(aInfo);
aCacheLock.unlock();
}
void AutoRecovery::implts_deregisterDocument(const css::uno::Reference< css::frame::XModel >& xDocument ,
bool bStopListening)
{
AutoRecovery::TDocumentInfo aInfo;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// Attention: Don't leave SAFE section, if you work with pIt!
// Because it points directly into the m_lDocCache list ...
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
AutoRecovery::TDocumentList::iterator pIt = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
if (pIt == m_lDocCache.end())
return; // unknown document => not a runtime error! Because we register only a few documents. see registration ...
aInfo = *pIt;
aCacheLock.unlock();
// Sometimes we close documents by ourself.
// And these documents can't be deregistered.
// Otherwhise we lose our configuration data... but need it !
// see SessionSave !
if (aInfo.IgnoreClosing)
return;
CacheLockGuard aCacheLock2(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_ADD_REMOVE);
pIt = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
if (pIt != m_lDocCache.end())
m_lDocCache.erase(pIt);
pIt = m_lDocCache.end(); // otherwise it's not specified what pIt means!
aCacheLock2.unlock();
} /* SAFE */
/* This method is called within disposing() of the document too. But there it's not a good idea to
deregister us as listener. Further it make no sense - because the broadcaster dies.
So we suppress deregistration in such case...
*/
if (bStopListening)
implts_stopModifyListeningOnDoc(aInfo);
AutoRecovery::st_impl_removeFile(aInfo.OldTempURL);
AutoRecovery::st_impl_removeFile(aInfo.NewTempURL);
implts_flushConfigItem(aInfo, true); // sal_True => remove it from config
}
void AutoRecovery::implts_markDocumentModifiedAgainstLastBackup(const css::uno::Reference< css::frame::XModel >& xDocument)
{
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
AutoRecovery::TDocumentList::iterator pIt = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
if (pIt != m_lDocCache.end())
{
/* Now we know, that this document was modified again and must be saved next time.
But we don't need this information for every e.g. key input of the user.
So we stop listening here.
But if the document was saved as temp. file we start listening for this event again.
*/
implts_stopModifyListeningOnDoc(*pIt);
}
} /* SAFE */
}
void AutoRecovery::implts_updateModifiedState(const css::uno::Reference< css::frame::XModel >& xDocument)
{
// use true as fallback to get every document on EmergencySave/AutoRecovery!
bool bModified = true;
css::uno::Reference< css::util::XModifiable > xModify(xDocument, css::uno::UNO_QUERY);
if (xModify.is())
bModified = xModify->isModified();
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
AutoRecovery::TDocumentList::iterator pIt = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
if (pIt != m_lDocCache.end())
{
AutoRecovery::TDocumentInfo& rInfo = *pIt;
if (bModified)
{
rInfo.DocumentState |= AutoRecovery::E_MODIFIED;
}
else
{
rInfo.DocumentState &= ~AutoRecovery::E_MODIFIED;
}
}
} /* SAFE */
}
void AutoRecovery::implts_updateDocumentUsedForSavingState(const css::uno::Reference< css::frame::XModel >& xDocument ,
bool bSaveInProgress)
{
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
AutoRecovery::TDocumentList::iterator pIt = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
if (pIt == m_lDocCache.end())
return;
AutoRecovery::TDocumentInfo& rInfo = *pIt;
rInfo.UsedForSaving = bSaveInProgress;
} /* SAFE */
}
void AutoRecovery::implts_markDocumentAsSaved(const css::uno::Reference< css::frame::XModel >& xDocument)
{
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
AutoRecovery::TDocumentInfo aInfo;
OUString sRemoveURL1;
OUString sRemoveURL2;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
AutoRecovery::TDocumentList::iterator pIt = AutoRecovery::impl_searchDocument(m_lDocCache, xDocument);
if (pIt == m_lDocCache.end())
return;
aInfo = *pIt;
/* Since the document has been saved, update its entry in the document
* cache. We essentially reset the state of the document from an
* autorecovery perspective, updating things like the filename (which
* would change in the case of a 'Save as' operation) and the associated
* backup file URL. */
aInfo.DocumentState = AutoRecovery::E_UNKNOWN;
// TODO replace getLocation() with getURL() ... it's a workaround currently only!
css::uno::Reference< css::frame::XStorable > xDoc(aInfo.Document, css::uno::UNO_QUERY);
aInfo.OrgURL = xDoc->getLocation();
/* Save off the backup file URLs and then clear them. NOTE - it is
* important that we clear them - otherwise, we could enter a state
* where pIt->OldTempURL == pIt->NewTempURL and our backup algorithm
* in implts_saveOneDoc will write to that URL and then delete the file
* at that URL (bug #96607) */
sRemoveURL1 = aInfo.OldTempURL;
sRemoveURL2 = aInfo.NewTempURL;
aInfo.OldTempURL.clear();
aInfo.NewTempURL.clear();
utl::MediaDescriptor lDescriptor(aInfo.Document->getArgs());
aInfo.RealFilter = lDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_FILTERNAME(), OUString());
css::uno::Reference< css::frame::XTitle > xDocTitle(xDocument, css::uno::UNO_QUERY);
if (xDocTitle.is ())
aInfo.Title = xDocTitle->getTitle ();
else
{
aInfo.Title = lDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_TITLE() , OUString());
if (aInfo.Title.isEmpty())
aInfo.Title = lDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_DOCUMENTTITLE(), OUString());
}
aInfo.UsedForSaving = false;
*pIt = aInfo;
} /* SAFE */
implts_flushConfigItem(aInfo);
aCacheLock.unlock();
AutoRecovery::st_impl_removeFile(sRemoveURL1);
AutoRecovery::st_impl_removeFile(sRemoveURL2);
}
AutoRecovery::TDocumentList::iterator AutoRecovery::impl_searchDocument( AutoRecovery::TDocumentList& rList ,
const css::uno::Reference< css::frame::XModel >& xDocument)
{
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = rList.begin();
pIt != rList.end();
++pIt )
{
const AutoRecovery::TDocumentInfo& rInfo = *pIt;
if (rInfo.Document == xDocument)
break;
}
return pIt;
}
namespace
{
void lcl_changeVisibility( const css::uno::Reference< css::frame::XFramesSupplier >& i_rFrames, bool i_bVisible )
{
css::uno::Reference< css::container::XIndexAccess > xFramesContainer( i_rFrames->getFrames(), css::uno::UNO_QUERY );
const sal_Int32 count = xFramesContainer->getCount();
Any aElement;
for ( sal_Int32 i=0; i < count; ++i )
{
aElement = xFramesContainer->getByIndex(i);
// check for sub frames
css::uno::Reference< css::frame::XFramesSupplier > xFramesSupp( aElement, css::uno::UNO_QUERY );
if ( xFramesSupp.is() )
lcl_changeVisibility( xFramesSupp, i_bVisible );
css::uno::Reference< css::frame::XFrame > xFrame( aElement, css::uno::UNO_QUERY );
if ( !xFrame.is() )
continue;
css::uno::Reference< css::awt::XWindow > xWindow( xFrame->getContainerWindow(), UNO_SET_THROW );
xWindow->setVisible( i_bVisible );
}
}
}
void AutoRecovery::implts_changeAllDocVisibility(bool bVisible)
{
css::uno::Reference< css::frame::XFramesSupplier > xDesktop( css::frame::Desktop::create(m_xContext), css::uno::UNO_QUERY);
lcl_changeVisibility( xDesktop, bVisible );
}
/* Currently the document is not closed in case of crash,
so the lock file must be removed explicitly
*/
void lc_removeLockFile(AutoRecovery::TDocumentInfo const & rInfo)
{
#if !HAVE_FEATURE_MULTIUSER_ENVIRONMENT || HAVE_FEATURE_MACOSX_SANDBOX
(void) rInfo;
#else
if ( rInfo.Document.is() )
{
try
{
css::uno::Reference< css::frame::XStorable > xStore(rInfo.Document, css::uno::UNO_QUERY_THROW);
OUString aURL = xStore->getLocation();
if ( !aURL.isEmpty() )
{
::svt::DocumentLockFile aLockFile( aURL );
aLockFile.RemoveFile();
}
}
catch( const css::uno::Exception& )
{
}
}
#endif
}
void AutoRecovery::implts_prepareSessionShutdown()
{
SAL_INFO("fwk.autorecovery", "AutoRecovery::implts_prepareSessionShutdown() starts ...");
// a) reset modified documents (of course the must be saved before this method is called!)
// b) close it without showing any UI!
/* SAFE */ {
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
AutoRecovery::TDocumentInfo& rInfo = *pIt;
// WORKAROUND... Since the documents are not closed the lock file must be removed explicitly
// it is not done on documents saving since shutdown can be cancelled
lc_removeLockFile( rInfo );
// Prevent us from deregistration of these documents.
// Because we close these documents by ourself (see XClosable below) ...
// it's fact, that we reach our deregistration method. There we
// must not(!) update our configuration ... Otherwhise all
// session data are lost !!!
rInfo.IgnoreClosing = true;
// reset modified flag of these documents (ignoring the notification about it!)
// Otherwise a message box is shown on closing these models.
implts_stopModifyListeningOnDoc(rInfo);
// if the session save is still running the documents should not be thrown away,
// actually that would be a bad sign, that means that the SessionManager tries
// to kill the session before the saving is ready
if ((m_eJob & AutoRecovery::E_SESSION_SAVE) != AutoRecovery::E_SESSION_SAVE)
{
css::uno::Reference< css::util::XModifiable > xModify(rInfo.Document, css::uno::UNO_QUERY);
if (xModify.is())
xModify->setModified(false);
// close the model.
css::uno::Reference< css::util::XCloseable > xClose(rInfo.Document, css::uno::UNO_QUERY);
if (xClose.is())
{
try
{
xClose->close(false);
}
catch(const css::uno::Exception&)
{
// At least it's only a try to close these documents before anybody else it does.
// So it seems to be possible to ignore any error here .-)
}
rInfo.Document.clear();
}
}
}
aCacheLock.unlock();
} /* SAFE */
}
/* TODO WORKAROUND:
#i64599#
Normally the MediaDescriptor argument NoAutoSave indicates,
that a document must be ignored for AutoSave and Recovery.
But sometimes XModel->getArgs() does not contained this information
if implts_registerDocument() was called.
So we have to check a second time, if this property is set...
Best place doing so is to check it immediately before saving
and suppressing saving the document then.
Of course removing the corresponding cache entry is not an option.
Because it would disturb iteration over the cache!
So we ignore such documents only...
Hopefully next time they are not inserted in our cache.
*/
bool lc_checkIfSaveForbiddenByArguments(AutoRecovery::TDocumentInfo const & rInfo)
{
if (! rInfo.Document.is())
return true;
utl::MediaDescriptor lDescriptor(rInfo.Document->getArgs());
bool bNoAutoSave = lDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_NOAUTOSAVE(), false);
return bNoAutoSave;
}
AutoRecovery::ETimerType AutoRecovery::implts_saveDocs( bool bAllowUserIdleLoop,
bool bRemoveLockFiles,
const DispatchParams* pParams )
{
css::uno::Reference< css::task::XStatusIndicator > xExternalProgress;
if (pParams)
xExternalProgress = pParams->m_xProgress;
css::uno::Reference< css::frame::XDesktop2 > xDesktop = css::frame::Desktop::create(m_xContext);
OUString sBackupPath(SvtPathOptions().GetBackupPath());
css::uno::Reference< css::frame::XController > xActiveController;
css::uno::Reference< css::frame::XModel > xActiveModel;
css::uno::Reference< css::frame::XFrame > xActiveFrame = xDesktop->getActiveFrame();
if (xActiveFrame.is())
xActiveController = xActiveFrame->getController();
if (xActiveController.is())
xActiveModel = xActiveController->getModel();
// Set the default timer action for our calli.
// Default = NORMAL_AUTOSAVE
// We return a suggestion for an active timer only.
// It will be ignored if the timer was disabled by the user ...
// Further this state can be set to USER_IDLE only later in this method.
// It's not allowed to reset such state then. Because we must know, if
// there exists POSTPONED documents. see below ...
AutoRecovery::ETimerType eTimer = AutoRecovery::E_NORMAL_AUTOSAVE_INTERVALL;
sal_Int32 eJob = m_eJob;
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
/* SAFE */ {
osl::ResettableMutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
// This list will be filled with every document
// which should be saved as last one. E.g. if it was used
// already for an UI save operation => crashed ... and
// now we try to save it again ... which can fail again ( of course .-) ).
::std::vector< AutoRecovery::TDocumentList::iterator > lDangerousDocs;
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
AutoRecovery::TDocumentInfo aInfo = *pIt;
// WORKAROUND... Since the documents are not closed the lock file must be removed explicitly
if ( bRemoveLockFiles )
lc_removeLockFile( aInfo );
// WORKAROUND ... see comment of this method
if (lc_checkIfSaveForbiddenByArguments(aInfo))
continue;
// already auto saved during this session :-)
// This state must be reset for all documents
// if timer is started with normal AutoSaveTimerIntervall!
if ((aInfo.DocumentState & AutoRecovery::E_HANDLED) == AutoRecovery::E_HANDLED)
continue;
// Not modified documents are not saved.
// We safe an information about the URL only!
Reference< XDocumentRecovery > xDocRecover( aInfo.Document, UNO_QUERY_THROW );
if ( !xDocRecover->wasModifiedSinceLastSave() )
{
aInfo.DocumentState |= AutoRecovery::E_HANDLED;
continue;
}
// check if this document is still used by a concurrent save operation
// e.g. if the user tried to save via UI.
// Handle it in the following way:
// i) For an AutoSave ... ignore this document! It will be saved and next time we will (hopefully)
// get a notification about the state of this operation.
// And if a document was saved by the user we can remove our temp. file. But that will be done inside
// our callback for SaveDone notification.
// ii) For a CrashSave ... add it to the list of dangerous documents and
// save it after all other documents was saved successfully. That decrease
// the chance for a crash inside a crash.
// On the other side it's not necessary for documents, which are not modified.
// They can be handled normally - means we patch the corresponding configuration entry only.
// iii) For a SessionSave ... ignore it! There is no time to wait for this save operation.
// Because the WindowManager will kill the process if it doesn't react immediately.
// On the other side we can't risk a concurrent save request ... because we know
// that it will produce a crash.
// Attention: Because eJob is used as a flag field, you have to check for the worst case first.
// E.g. a CrashSave can overwrite an AutoSave. So you have to check for a CrashSave before an AutoSave!
if (aInfo.UsedForSaving)
{
if ((eJob & AutoRecovery::E_EMERGENCY_SAVE) == AutoRecovery::E_EMERGENCY_SAVE)
{
lDangerousDocs.push_back(pIt);
continue;
}
else
if ((eJob & AutoRecovery::E_SESSION_SAVE) == AutoRecovery::E_SESSION_SAVE)
{
continue;
}
else
if ((eJob & AutoRecovery::E_AUTO_SAVE) == AutoRecovery::E_AUTO_SAVE)
{
eTimer = AutoRecovery::E_POLL_TILL_AUTOSAVE_IS_ALLOWED;
aInfo.DocumentState |= AutoRecovery::E_POSTPONED;
continue;
}
}
// a) Document was not postponed - and is active now. => postpone it (restart timer, restart loop)
// b) Document was not postponed - and is not active now. => save it
// c) Document was postponed - and is not active now. => save it
// d) Document was postponed - and is active now. => save it (because user idle was checked already)
bool bActive = (xActiveModel == aInfo.Document);
bool bWasPostponed = ((aInfo.DocumentState & AutoRecovery::E_POSTPONED) == AutoRecovery::E_POSTPONED);
if (
! bWasPostponed &&
bActive
)
{
aInfo.DocumentState |= AutoRecovery::E_POSTPONED;
*pIt = aInfo;
// postponed documents will be saved if this method is called again!
// That can be done by an outside started timer => E_POLL_FOR_USER_IDLE (if normal AutoSave is active)
// or it must be done directly without starting any timer => E_CALL_ME_BACK (if Emergency- or SessionSave is active and must be finished ASAP!)
eTimer = AutoRecovery::E_POLL_FOR_USER_IDLE;
if (!bAllowUserIdleLoop)
eTimer = AutoRecovery::E_CALL_ME_BACK;
continue;
}
// b, c, d)
// } /* SAFE */
g.clear();
// changing of aInfo and flushing it is done inside implts_saveOneDoc!
implts_saveOneDoc(sBackupPath, aInfo, xExternalProgress);
implts_informListener(eJob, AutoRecovery::implst_createFeatureStateEvent(eJob, OPERATION_UPDATE, &aInfo));
g.reset();
// /* SAFE */ {
*pIt = aInfo;
}
// Did we have some "dangerous candidates" ?
// Try to save it ... but may be it will fail !
::std::vector< AutoRecovery::TDocumentList::iterator >::iterator pIt2;
for ( pIt2 = lDangerousDocs.begin();
pIt2 != lDangerousDocs.end();
++pIt2 )
{
pIt = *pIt2;
AutoRecovery::TDocumentInfo aInfo = *pIt;
// } /* SAFE */
g.clear();
// changing of aInfo and flushing it is done inside implts_saveOneDoc!
implts_saveOneDoc(sBackupPath, aInfo, xExternalProgress);
implts_informListener(eJob, AutoRecovery::implst_createFeatureStateEvent(eJob, OPERATION_UPDATE, &aInfo));
g.reset();
// /* SAFE */ {
*pIt = aInfo;
}
} /* SAFE */
return eTimer;
}
void AutoRecovery::implts_saveOneDoc(const OUString& sBackupPath ,
AutoRecovery::TDocumentInfo& rInfo ,
const css::uno::Reference< css::task::XStatusIndicator >& xExternalProgress)
{
// no document? => can occur if we loaded our configuration with files,
// which couldnt be recovered successfully. In such case we have all needed information
// excepting the real document instance!
// TODO: search right place, where such "dead files" can be removed from the configuration!
if (!rInfo.Document.is())
return;
utl::MediaDescriptor lOldArgs(rInfo.Document->getArgs());
implts_generateNewTempURL(sBackupPath, lOldArgs, rInfo);
// if the document was loaded with a password, it should be
// stored with password
utl::MediaDescriptor lNewArgs;
css::uno::Sequence< css::beans::NamedValue > aEncryptionData =
lOldArgs.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_ENCRYPTIONDATA(),
css::uno::Sequence< css::beans::NamedValue >());
if (aEncryptionData.getLength() > 0)
lNewArgs[utl::MediaDescriptor::PROP_ENCRYPTIONDATA()] <<= aEncryptionData;
// Further it must be saved using the default file format of that application.
// Otherwhise we will some data lost.
if (!rInfo.DefaultFilter.isEmpty())
lNewArgs[utl::MediaDescriptor::PROP_FILTERNAME()] <<= rInfo.DefaultFilter;
// prepare frame/document/mediadescriptor in a way, that it uses OUR progress .-)
if (xExternalProgress.is())
lNewArgs[utl::MediaDescriptor::PROP_STATUSINDICATOR()] <<= xExternalProgress;
impl_establishProgress(rInfo, lNewArgs, css::uno::Reference< css::frame::XFrame >());
// #i66598# use special handling of property "DocumentBaseURL" (it must be an empty string!)
// for make hyperlinks working
lNewArgs[utl::MediaDescriptor::PROP_DOCUMENTBASEURL()] <<= OUString();
// try to save this document as a new temp file every time.
// Mark AutoSave state as "INCOMPLETE" if it failed.
// Because the last temp file is to old and does not include all changes.
Reference< XDocumentRecovery > xDocRecover(rInfo.Document, css::uno::UNO_QUERY_THROW);
// safe the state about "trying to save"
// ... we need it for recovery if e.g. a crash occurs inside next line!
rInfo.DocumentState |= AutoRecovery::E_TRY_SAVE;
implts_flushConfigItem(rInfo);
// If userautosave is enabled, first try to save the original file.
// Note that we must do it *before* calling storeToRecoveryFile, so in case of failure here
// we won't remain with the modified flag set to true, even though the autorecovery save succeeded.
try
{
// We must check here for an empty URL to avoid a "This operation is not supported on this operating system."
// message during autosave.
if ((m_eJob & AutoRecovery::E_USER_AUTO_SAVE) == AutoRecovery::E_USER_AUTO_SAVE && !rInfo.OrgURL.isEmpty())
{
Reference< XStorable > xDocSave(rInfo.Document, css::uno::UNO_QUERY_THROW);
xDocSave->store();
}
}
catch(const css::uno::Exception&)
{
}
sal_Int32 nRetry = RETRY_STORE_ON_FULL_DISC_FOREVER;
bool bError = false;
do
{
try
{
xDocRecover->storeToRecoveryFile( rInfo.NewTempURL, lNewArgs.getAsConstPropertyValueList() );
#ifdef TRIGGER_FULL_DISC_CHECK
throw css::uno::Exception();
#else // TRIGGER_FULL_DISC_CHECK
bError = false;
nRetry = 0;
#endif // TRIGGER_FULL_DISC_CHECK
}
catch(const css::uno::Exception&)
{
bError = true;
// a) FULL DISC seems to be the problem behind => show error and retry it forever (e.g. retry=300)
// b) unknown problem (may be locking problem) => reset RETRY value to more useful value(!) (e.g. retry=3)
// c) unknown problem (may be locking problem) + 1..2 repeating operations => throw the original exception to force generation of a stacktrace !
sal_Int32 nMinSpaceDocSave;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
nMinSpaceDocSave = m_nMinSpaceDocSave;
} /* SAFE */
if (! impl_enoughDiscSpace(nMinSpaceDocSave))
AutoRecovery::impl_showFullDiscError();
else if (nRetry > RETRY_STORE_ON_MIGHT_FULL_DISC_USEFULL)
nRetry = RETRY_STORE_ON_MIGHT_FULL_DISC_USEFULL;
else if (nRetry <= GIVE_UP_RETRY)
throw; // force stacktrace to know if there exist might other reasons, why an AutoSave can fail !!!
--nRetry;
}
}
while(nRetry>0);
if (! bError)
{
// safe the state about success
// ... you know the reason: to know it on recovery time if next line crash .-)
rInfo.DocumentState &= ~AutoRecovery::E_TRY_SAVE;
rInfo.DocumentState |= AutoRecovery::E_HANDLED;
rInfo.DocumentState |= AutoRecovery::E_SUCCEDED;
}
else
{
// safe the state about error ...
rInfo.NewTempURL.clear();
rInfo.DocumentState &= ~AutoRecovery::E_TRY_SAVE;
rInfo.DocumentState |= AutoRecovery::E_HANDLED;
rInfo.DocumentState |= AutoRecovery::E_INCOMPLETE;
}
// make sure the progress is not referred any longer
impl_forgetProgress(rInfo, lNewArgs, css::uno::Reference< css::frame::XFrame >());
// try to remove the old temp file.
// Ignore any error here. We have a new temp file, which is up to date.
// The only thing is: we fill the disk with temp files, if we can't remove old ones :-)
OUString sRemoveFile = rInfo.OldTempURL;
rInfo.OldTempURL = rInfo.NewTempURL;
rInfo.NewTempURL.clear();
implts_flushConfigItem(rInfo);
// We must know if the user modifies the document again ...
implts_startModifyListeningOnDoc(rInfo);
AutoRecovery::st_impl_removeFile(sRemoveFile);
}
AutoRecovery::ETimerType AutoRecovery::implts_openDocs(const DispatchParams& aParams)
{
AutoRecovery::ETimerType eTimer = AutoRecovery::E_DONT_START_TIMER;
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
/* SAFE */ {
osl::ResettableMutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
sal_Int32 eJob = m_eJob;
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
AutoRecovery::TDocumentInfo& rInfo = *pIt;
// Such documents are already loaded by the last loop.
// Don't check E_SUCCEDED here! It may be the final state of an AutoSave
// operation before!!!
if ((rInfo.DocumentState & AutoRecovery::E_HANDLED) == AutoRecovery::E_HANDLED)
continue;
// a1,b1,c1,d2,e2,f2)
if ((rInfo.DocumentState & AutoRecovery::E_DAMAGED) == AutoRecovery::E_DAMAGED)
{
// don't forget to inform listener! May be this document was
// damaged on last saving time ...
// Then our listener need this notification.
// If it was damaged during last "try to open" ...
// it will be notified more than once. SH.. HAPPENS ...
// } /* SAFE */
g.clear();
implts_informListener(eJob,
AutoRecovery::implst_createFeatureStateEvent(eJob, OPERATION_UPDATE, &rInfo));
g.reset();
// /* SAFE */ {
continue;
}
utl::MediaDescriptor lDescriptor;
// it's an UI feature - so the "USER" itself must be set as referer
lDescriptor[utl::MediaDescriptor::PROP_REFERRER()] <<= OUString(REFERRER_USER);
lDescriptor[utl::MediaDescriptor::PROP_SALVAGEDFILE()] <<= OUString();
// recovered documents are loaded hidden, and shown all at once, later
lDescriptor[utl::MediaDescriptor::PROP_HIDDEN()] <<= true;
if (aParams.m_xProgress.is())
lDescriptor[utl::MediaDescriptor::PROP_STATUSINDICATOR()] <<= aParams.m_xProgress;
bool bBackupWasTried = (
((rInfo.DocumentState & AutoRecovery::E_TRY_LOAD_BACKUP ) == AutoRecovery::E_TRY_LOAD_BACKUP) || // temp. state!
((rInfo.DocumentState & AutoRecovery::E_INCOMPLETE ) == AutoRecovery::E_INCOMPLETE ) // transport TRY_LOAD_BACKUP from last loop to this new one!
);
bool bOriginalWasTried = ((rInfo.DocumentState & AutoRecovery::E_TRY_LOAD_ORIGINAL) == AutoRecovery::E_TRY_LOAD_ORIGINAL);
if (bBackupWasTried)
{
if (!bOriginalWasTried)
{
rInfo.DocumentState |= AutoRecovery::E_INCOMPLETE;
// try original URL ... ! don't continue with next item here ...
}
else
{
rInfo.DocumentState |= AutoRecovery::E_DAMAGED;
continue;
}
}
OUString sLoadOriginalURL;
OUString sLoadBackupURL;
if (!bBackupWasTried)
sLoadBackupURL = rInfo.OldTempURL;
if (!rInfo.OrgURL.isEmpty())
{
sLoadOriginalURL = rInfo.OrgURL;
}
else if (!rInfo.TemplateURL.isEmpty())
{
sLoadOriginalURL = rInfo.TemplateURL;
lDescriptor[utl::MediaDescriptor::PROP_ASTEMPLATE()] <<= true;
lDescriptor[utl::MediaDescriptor::PROP_TEMPLATENAME()] <<= rInfo.TemplateURL;
}
else if (!rInfo.FactoryURL.isEmpty())
{
sLoadOriginalURL = rInfo.FactoryURL;
lDescriptor[utl::MediaDescriptor::PROP_ASTEMPLATE()] <<= true;
}
// A "Salvaged" item must exists every time. The core can make something special then for recovery.
// Of course it should be the real file name of the original file, in case we load the temp. backup here.
OUString sURL;
if (!sLoadBackupURL.isEmpty())
{
sURL = sLoadBackupURL;
rInfo.DocumentState |= AutoRecovery::E_TRY_LOAD_BACKUP;
lDescriptor[utl::MediaDescriptor::PROP_SALVAGEDFILE()] <<= sLoadOriginalURL;
}
else if (!sLoadOriginalURL.isEmpty())
{
sURL = sLoadOriginalURL;
rInfo.DocumentState |= AutoRecovery::E_TRY_LOAD_ORIGINAL;
}
else
continue; // TODO ERROR!
LoadEnv::initializeUIDefaults( m_xContext, lDescriptor, true, nullptr );
// } /* SAFE */
g.clear();
implts_flushConfigItem(rInfo);
implts_informListener(eJob,
AutoRecovery::implst_createFeatureStateEvent(eJob, OPERATION_UPDATE, &rInfo));
try
{
implts_openOneDoc(sURL, lDescriptor, rInfo);
}
catch(const css::uno::Exception&)
{
rInfo.DocumentState &= ~AutoRecovery::E_TRY_LOAD_BACKUP;
rInfo.DocumentState &= ~AutoRecovery::E_TRY_LOAD_ORIGINAL;
if (!sLoadBackupURL.isEmpty())
{
rInfo.DocumentState |= AutoRecovery::E_INCOMPLETE;
eTimer = AutoRecovery::E_CALL_ME_BACK;
}
else
{
rInfo.DocumentState |= AutoRecovery::E_HANDLED;
rInfo.DocumentState |= AutoRecovery::E_DAMAGED;
}
implts_flushConfigItem(rInfo, true);
implts_informListener(eJob,
AutoRecovery::implst_createFeatureStateEvent(eJob, OPERATION_UPDATE, &rInfo));
// /* SAFE */ {
// Needed for next loop!
g.reset();
continue;
}
if (!rInfo.RealFilter.isEmpty())
{
utl::MediaDescriptor lPatchDescriptor(rInfo.Document->getArgs());
lPatchDescriptor[utl::MediaDescriptor::PROP_FILTERNAME()] <<= rInfo.RealFilter;
rInfo.Document->attachResource(rInfo.Document->getURL(), lPatchDescriptor.getAsConstPropertyValueList());
// do *not* use sURL here. In case this points to the recovery file, it has already been passed
// to recoverFromFile. Also, passing it here is logically wrong, as attachResource is intended
// to take the logical file URL.
}
css::uno::Reference< css::util::XModifiable > xModify(rInfo.Document, css::uno::UNO_QUERY);
if ( xModify.is() )
{
bool bModified = ((rInfo.DocumentState & AutoRecovery::E_MODIFIED) == AutoRecovery::E_MODIFIED);
xModify->setModified(bModified);
}
rInfo.DocumentState &= ~AutoRecovery::E_TRY_LOAD_BACKUP;
rInfo.DocumentState &= ~AutoRecovery::E_TRY_LOAD_ORIGINAL;
rInfo.DocumentState |= AutoRecovery::E_HANDLED;
rInfo.DocumentState |= AutoRecovery::E_SUCCEDED;
implts_flushConfigItem(rInfo);
implts_informListener(eJob,
AutoRecovery::implst_createFeatureStateEvent(eJob, OPERATION_UPDATE, &rInfo));
/* Normally we listen as XModifyListener on a document to know if a document was changed
since our last AutoSave. And we deregister us in case we know this state.
But directly after one document as recovered ... we must start listening.
Otherwhise the first "modify" doesn't reach us. Because we ourself called setModified()
on the document via API. And currently we don't listen for any events (not at theGlobalEventBroadcaster
nor at any document!).
*/
implts_startModifyListeningOnDoc(rInfo);
// /* SAFE */ {
// Needed for next loop. Don't unlock it again!
g.reset();
}
} /* SAFE */
return eTimer;
}
void AutoRecovery::implts_openOneDoc(const OUString& sURL ,
utl::MediaDescriptor& lDescriptor,
AutoRecovery::TDocumentInfo& rInfo )
{
css::uno::Reference< css::frame::XDesktop2 > xDesktop = css::frame::Desktop::create(m_xContext);
::std::vector< Reference< XComponent > > aCleanup;
try
{
// create a new document of the desired type
Reference< XModel2 > xModel(m_xContext->getServiceManager()->createInstanceWithContext(
rInfo.FactoryService, m_xContext), UNO_QUERY_THROW);
aCleanup.push_back( xModel.get() );
// put the filter name into the descriptor - we're not going to involve any type detection, so
// the document might be lost without the FilterName property
if ( (rInfo.DocumentState & AutoRecovery::E_TRY_LOAD_ORIGINAL) == AutoRecovery::E_TRY_LOAD_ORIGINAL)
lDescriptor[ utl::MediaDescriptor::PROP_FILTERNAME() ] <<= rInfo.RealFilter;
else
lDescriptor[ utl::MediaDescriptor::PROP_FILTERNAME() ] <<= rInfo.DefaultFilter;
if ( sURL == rInfo.FactoryURL )
{
// if the document was a new, unmodified document, then there's nothing to recover, just to init
ENSURE_OR_THROW( ( rInfo.DocumentState & AutoRecovery::E_MODIFIED ) == 0,
"unexpected document state" );
Reference< XLoadable > xModelLoad( xModel, UNO_QUERY_THROW );
xModelLoad->initNew();
// TODO: remove load-process specific arguments from the descriptor, e.g. the status indicator
xModel->attachResource( sURL, lDescriptor.getAsConstPropertyValueList() );
}
else
{
// let it recover itself
Reference< XDocumentRecovery > xDocRecover( xModel, UNO_QUERY_THROW );
xDocRecover->recoverFromFile(
sURL,
lDescriptor.getUnpackedValueOrDefault( utl::MediaDescriptor::PROP_SALVAGEDFILE(), OUString() ),
lDescriptor.getAsConstPropertyValueList()
);
// No attachResource needed here. By definition (of XDocumentRecovery), the implementation is responsible
// for completely initializing the model, which includes attachResource (or equivalent), if required.
}
// re-create all the views
::std::vector< OUString > aViewsToRestore( rInfo.ViewNames.getLength() );
if ( rInfo.ViewNames.getLength() )
::std::copy( rInfo.ViewNames.begin(), rInfo.ViewNames.end(), aViewsToRestore.begin() );
// if we don't have views for whatever reason, then create a default-view, at least
if ( aViewsToRestore.empty() )
aViewsToRestore.push_back( OUString() );
for ( ::std::vector< OUString >::const_iterator viewName = aViewsToRestore.begin();
viewName != aViewsToRestore.end();
++viewName
)
{
// create a frame
Reference< XFrame > xTargetFrame = xDesktop->findFrame( SPECIALTARGET_BLANK, 0 );
aCleanup.push_back( xTargetFrame.get() );
// create a view to the document
Reference< XController2 > xController;
if ( viewName->getLength() )
{
xController.set( xModel->createViewController( *viewName, Sequence< css::beans::PropertyValue >(), xTargetFrame ), UNO_SET_THROW );
}
else
{
xController.set( xModel->createDefaultViewController( xTargetFrame ), UNO_SET_THROW );
}
// introduce model/view/controller to each other
xController->attachModel( xModel.get() );
xModel->connectController( xController.get() );
xTargetFrame->setComponent( xController->getComponentWindow(), xController.get() );
xController->attachFrame( xTargetFrame );
xModel->setCurrentController( xController.get() );
}
rInfo.Document = xModel.get();
}
catch(const css::uno::RuntimeException&)
{
throw;
}
catch(const css::uno::Exception&)
{
Any aCaughtException( ::cppu::getCaughtException() );
// clean up
for ( ::std::vector< Reference< XComponent > >::const_iterator component = aCleanup.begin();
component != aCleanup.end();
++component
)
{
css::uno::Reference< css::util::XCloseable > xClose( *component, css::uno::UNO_QUERY );
if ( xClose.is() )
xClose->close( true );
else
(*component)->dispose();
}
// re-throw
throw css::lang::WrappedTargetException(
"Recovery of \"" + sURL + "\" failed.",
static_cast< css::frame::XDispatch* >(this),
aCaughtException
);
}
}
void AutoRecovery::implts_generateNewTempURL(const OUString& sBackupPath ,
utl::MediaDescriptor& /*rMediaDescriptor*/,
AutoRecovery::TDocumentInfo& rInfo )
{
// specify URL for saving (which points to a temp file inside backup directory)
// and define an unique name, so we can locate it later.
// This unique name must solve an optimization problem too!
// In case we are asked to save unmodified documents too - and one of them
// is an empty one (because it was new created using e.g. an URL private:factory/...)
// we should not save it really. Then we put the information about such "empty document"
// into the configuration and don't create any recovery file on disk.
// We use the title of the document to make it unique.
OUStringBuffer sUniqueName;
if (!rInfo.OrgURL.isEmpty())
{
css::uno::Reference< css::util::XURLTransformer > xParser(css::util::URLTransformer::create(m_xContext));
css::util::URL aURL;
aURL.Complete = rInfo.OrgURL;
xParser->parseStrict(aURL);
sUniqueName.append(aURL.Name);
}
else if (!rInfo.FactoryURL.isEmpty())
sUniqueName.append("untitled");
sUniqueName.append("_");
// TODO: Must we strip some illegal signes - if we use the title?
OUString sName(sUniqueName.makeStringAndClear());
OUString sExtension(rInfo.Extension);
OUString sPath(sBackupPath);
::utl::TempFile aTempFile(sName, true, &sExtension, &sPath);
rInfo.NewTempURL = aTempFile.GetURL();
}
void AutoRecovery::implts_informListener( sal_Int32 eJob ,
const css::frame::FeatureStateEvent& aEvent)
{
// Helper shares mutex with us -> threadsafe!
::cppu::OInterfaceContainerHelper* pListenerForURL = nullptr;
OUString sJob = AutoRecovery::implst_getJobDescription(eJob);
// inform listener, which are registered for any URLs(!)
pListenerForURL = m_lListener.getContainer(sJob);
if(pListenerForURL != nullptr)
{
::cppu::OInterfaceIteratorHelper pIt(*pListenerForURL);
while(pIt.hasMoreElements())
{
try
{
css::uno::Reference< css::frame::XStatusListener > xListener(static_cast<css::frame::XStatusListener*>(pIt.next()), css::uno::UNO_QUERY);
xListener->statusChanged(aEvent);
}
catch(const css::uno::RuntimeException&)
{
pIt.remove();
}
}
}
}
OUString AutoRecovery::implst_getJobDescription(sal_Int32 eJob)
{
// describe the current running operation
OUStringBuffer sFeature(256);
sFeature.append(CMD_PROTOCOL);
// Attention: Because "eJob" is used as a flag field the order of checking these
// flags is important. We must preferr job with higher priorities!
// E.g. EmergencySave has an higher prio then AutoSave ...
// On the other side there exist a well defined order between two different jobs.
// e.g. PrepareEmergencySave must be done before EmergencySave is started of course.
if ((eJob & AutoRecovery::E_PREPARE_EMERGENCY_SAVE) == AutoRecovery::E_PREPARE_EMERGENCY_SAVE)
sFeature.append(CMD_DO_PREPARE_EMERGENCY_SAVE);
else if ((eJob & AutoRecovery::E_EMERGENCY_SAVE) == AutoRecovery::E_EMERGENCY_SAVE)
sFeature.append(CMD_DO_EMERGENCY_SAVE);
else if ((eJob & AutoRecovery::E_RECOVERY) == AutoRecovery::E_RECOVERY)
sFeature.append(CMD_DO_RECOVERY);
else if ((eJob & AutoRecovery::E_SESSION_SAVE) == AutoRecovery::E_SESSION_SAVE)
sFeature.append(CMD_DO_SESSION_SAVE);
else if ((eJob & AutoRecovery::E_SESSION_QUIET_QUIT) == AutoRecovery::E_SESSION_QUIET_QUIT)
sFeature.append(CMD_DO_SESSION_QUIET_QUIT);
else if ((eJob & AutoRecovery::E_SESSION_RESTORE) == AutoRecovery::E_SESSION_RESTORE)
sFeature.append(CMD_DO_SESSION_RESTORE);
else if ((eJob & AutoRecovery::E_ENTRY_BACKUP) == AutoRecovery::E_ENTRY_BACKUP)
sFeature.append(CMD_DO_ENTRY_BACKUP);
else if ((eJob & AutoRecovery::E_ENTRY_CLEANUP) == AutoRecovery::E_ENTRY_CLEANUP)
sFeature.append(CMD_DO_ENTRY_CLEANUP);
else if ((eJob & AutoRecovery::E_AUTO_SAVE) == AutoRecovery::E_AUTO_SAVE)
sFeature.append(CMD_DO_AUTO_SAVE);
else if ( eJob != AutoRecovery::E_NO_JOB )
SAL_INFO("fwk.autorecovery", "AutoRecovery::implst_getJobDescription(): Invalid job identifier detected.");
return sFeature.makeStringAndClear();
}
sal_Int32 AutoRecovery::implst_classifyJob(const css::util::URL& aURL)
{
if ( aURL.Protocol == CMD_PROTOCOL )
{
if ( aURL.Path == CMD_DO_PREPARE_EMERGENCY_SAVE )
return AutoRecovery::E_PREPARE_EMERGENCY_SAVE;
else if ( aURL.Path == CMD_DO_EMERGENCY_SAVE )
return AutoRecovery::E_EMERGENCY_SAVE;
else if ( aURL.Path == CMD_DO_RECOVERY )
return AutoRecovery::E_RECOVERY;
else if ( aURL.Path == CMD_DO_ENTRY_BACKUP )
return AutoRecovery::E_ENTRY_BACKUP;
else if ( aURL.Path == CMD_DO_ENTRY_CLEANUP )
return AutoRecovery::E_ENTRY_CLEANUP;
else if ( aURL.Path == CMD_DO_SESSION_SAVE )
return AutoRecovery::E_SESSION_SAVE;
else if ( aURL.Path == CMD_DO_SESSION_QUIET_QUIT )
return AutoRecovery::E_SESSION_QUIET_QUIT;
else if ( aURL.Path == CMD_DO_SESSION_RESTORE )
return AutoRecovery::E_SESSION_RESTORE;
else if ( aURL.Path == CMD_DO_DISABLE_RECOVERY )
return AutoRecovery::E_DISABLE_AUTORECOVERY;
else if ( aURL.Path == CMD_DO_SET_AUTOSAVE_STATE )
return AutoRecovery::E_SET_AUTOSAVE_STATE;
}
SAL_INFO("fwk.autorecovery", "AutoRecovery::implts_classifyJob(): Invalid URL (protocol).");
return AutoRecovery::E_NO_JOB;
}
css::frame::FeatureStateEvent AutoRecovery::implst_createFeatureStateEvent( sal_Int32 eJob ,
const OUString& sEventType,
AutoRecovery::TDocumentInfo const * pInfo )
{
css::frame::FeatureStateEvent aEvent;
aEvent.FeatureURL.Complete = AutoRecovery::implst_getJobDescription(eJob);
aEvent.FeatureDescriptor = sEventType;
if (pInfo && sEventType == OPERATION_UPDATE)
{
// pack rInfo for transport via UNO
::comphelper::NamedValueCollection aInfo;
aInfo.put( OUString(CFG_ENTRY_PROP_ID), pInfo->ID );
aInfo.put( OUString(CFG_ENTRY_PROP_ORIGINALURL), pInfo->OrgURL );
aInfo.put( OUString(CFG_ENTRY_PROP_FACTORYURL), pInfo->FactoryURL );
aInfo.put( OUString(CFG_ENTRY_PROP_TEMPLATEURL), pInfo->TemplateURL );
aInfo.put( OUString(CFG_ENTRY_PROP_TEMPURL), pInfo->OldTempURL.isEmpty() ? pInfo->NewTempURL : pInfo->OldTempURL );
aInfo.put( OUString(CFG_ENTRY_PROP_MODULE), pInfo->AppModule);
aInfo.put( OUString(CFG_ENTRY_PROP_TITLE), pInfo->Title);
aInfo.put( OUString(CFG_ENTRY_PROP_VIEWNAMES), pInfo->ViewNames);
aInfo.put( OUString(CFG_ENTRY_PROP_DOCUMENTSTATE), pInfo->DocumentState);
aEvent.State <<= aInfo.getPropertyValues();
}
return aEvent;
}
void AutoRecovery::implts_resetHandleStates()
{
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
/* SAFE */ {
osl::ResettableMutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
AutoRecovery::TDocumentInfo& rInfo = *pIt;
rInfo.DocumentState &= ~AutoRecovery::E_HANDLED;
rInfo.DocumentState &= ~AutoRecovery::E_POSTPONED;
// } /* SAFE */
g.clear();
implts_flushConfigItem(rInfo);
g.reset();
// /* SAFE */ {
}
} /* SAFE */
}
void AutoRecovery::implts_prepareEmergencySave()
{
// Be sure to know all open documents really .-)
implts_verifyCacheAgainstDesktopDocumentList();
// hide all docs, so the user can't disturb our emergency save .-)
implts_changeAllDocVisibility(false);
}
void AutoRecovery::implts_doEmergencySave(const DispatchParams& aParams)
{
// Write a hint "we crashed" into the configuration, so
// the error report tool is started too in case no recovery
// documents exists and was saved.
::comphelper::ConfigurationHelper::writeDirectKey(
m_xContext,
CFG_PACKAGE_RECOVERY,
CFG_PATH_RECOVERYINFO,
CFG_ENTRY_CRASHED,
css::uno::makeAny(true),
::comphelper::EConfigurationModes::Standard);
// for all docs, store their current view/names in the configurtion
implts_persistAllActiveViewNames();
// The called method for saving documents runs
// during normal AutoSave more than once. Because
// it postpone active documents and save it later.
// That is normally done by recalling it from a timer.
// Here we must do it immediately!
// Of course this method returns the right state -
// because it knows, that we are running in EMERGENCY SAVE mode .-)
bool const bAllowUserIdleLoop = false; // not allowed to change that .-)
AutoRecovery::ETimerType eSuggestedTimer = AutoRecovery::E_DONT_START_TIMER;
do
{
eSuggestedTimer = implts_saveDocs(bAllowUserIdleLoop, true, &aParams);
}
while(eSuggestedTimer == AutoRecovery::E_CALL_ME_BACK);
// reset the handle state of all
// cache items. Such handle state indicates, that a document
// was already saved during the THIS(!) EmergencySave session.
// Of course following recovery session must be started without
// any "handle" state ...
implts_resetHandleStates();
// flush config cached back to disc.
impl_flushALLConfigChanges();
// try to make sure next time office will be started user won't be
// notified about any other might be running office instance
// remove ".lock" file from disc !
AutoRecovery::st_impl_removeLockFile();
}
void AutoRecovery::implts_doRecovery(const DispatchParams& aParams)
{
AutoRecovery::ETimerType eSuggestedTimer = AutoRecovery::E_DONT_START_TIMER;
do
{
eSuggestedTimer = implts_openDocs(aParams);
}
while(eSuggestedTimer == AutoRecovery::E_CALL_ME_BACK);
// reset the handle state of all
// cache items. Such handle state indicates, that a document
// was already saved during the THIS(!) Recovery session.
// Of course a may be following EmergencySave session must be started without
// any "handle" state ...
implts_resetHandleStates();
// Reset the configuration hint "we was crashed"!
::comphelper::ConfigurationHelper::writeDirectKey(
m_xContext,
CFG_PACKAGE_RECOVERY,
CFG_PATH_RECOVERYINFO,
CFG_ENTRY_CRASHED,
css::uno::makeAny(false),
::comphelper::EConfigurationModes::Standard);
}
void AutoRecovery::implts_doSessionSave(const DispatchParams& aParams)
{
SAL_INFO("fwk.autorecovery", "AutoRecovery::implts_doSessionSave()");
// Be sure to know all open documents really .-)
implts_verifyCacheAgainstDesktopDocumentList();
// for all docs, store their current view/names in the configurtion
implts_persistAllActiveViewNames();
// The called method for saving documents runs
// during normal AutoSave more than once. Because
// it postpone active documents and save it later.
// That is normally done by recalling it from a timer.
// Here we must do it immediately!
// Of course this method returns the right state -
// because it knows, that we are running in SESSION SAVE mode .-)
bool const bAllowUserIdleLoop = false; // not allowed to change that .-)
AutoRecovery::ETimerType eSuggestedTimer = AutoRecovery::E_DONT_START_TIMER;
do
{
// do not remove lock files of the documents, it will be done on session quit
eSuggestedTimer = implts_saveDocs(bAllowUserIdleLoop, false, &aParams);
}
while(eSuggestedTimer == AutoRecovery::E_CALL_ME_BACK);
// reset the handle state of all
// cache items. Such handle state indicates, that a document
// was already saved during the THIS(!) save session.
// Of course following restore session must be started without
// any "handle" state ...
implts_resetHandleStates();
// flush config cached back to disc.
impl_flushALLConfigChanges();
}
void AutoRecovery::implts_doSessionQuietQuit()
{
SAL_INFO("fwk.autorecovery", "AutoRecovery::implts_doSessionQuietQuit()");
// try to make sure next time office will be started user won't be
// notified about any other might be running office instance
// remove ".lock" file from disc!
// it is done as a first action for session save since Gnome sessions
// do not provide enough time for shutdown, and the dialog looks to be
// confusing for the user
AutoRecovery::st_impl_removeLockFile();
// reset all modified documents, so the don't show any UI on closing ...
// and close all documents, so we can shutdown the OS!
implts_prepareSessionShutdown();
// Write a hint for "stored session data" into the configuration, so
// the on next startup we know what's happen last time
::comphelper::ConfigurationHelper::writeDirectKey(
m_xContext,
CFG_PACKAGE_RECOVERY,
CFG_PATH_RECOVERYINFO,
CFG_ENTRY_SESSIONDATA,
css::uno::makeAny(true),
::comphelper::EConfigurationModes::Standard);
// flush config cached back to disc.
impl_flushALLConfigChanges();
}
void AutoRecovery::implts_doSessionRestore(const DispatchParams& aParams)
{
SAL_INFO("fwk.autorecovery", "AutoRecovery::implts_doSessionRestore() ...");
AutoRecovery::ETimerType eSuggestedTimer = AutoRecovery::E_DONT_START_TIMER;
do
{
eSuggestedTimer = implts_openDocs(aParams);
}
while(eSuggestedTimer == AutoRecovery::E_CALL_ME_BACK);
// reset the handle state of all
// cache items. Such handle state indicates, that a document
// was already saved during the THIS(!) Restore session.
// Of course a may be following save session must be started without
// any "handle" state ...
implts_resetHandleStates();
// make all opened documents visible
implts_changeAllDocVisibility(true);
// Reset the configuration hint for "session save"!
SAL_INFO("fwk.autorecovery", "... reset config key 'SessionData'");
::comphelper::ConfigurationHelper::writeDirectKey(
m_xContext,
CFG_PACKAGE_RECOVERY,
CFG_PATH_RECOVERYINFO,
CFG_ENTRY_SESSIONDATA,
css::uno::makeAny(false),
::comphelper::EConfigurationModes::Standard);
SAL_INFO("fwk.autorecovery", "... AutoRecovery::implts_doSessionRestore()");
}
void AutoRecovery::implts_backupWorkingEntry(const DispatchParams& aParams)
{
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_USE);
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
const AutoRecovery::TDocumentInfo& rInfo = *pIt;
if (rInfo.ID != aParams.m_nWorkingEntryID)
continue;
OUString sSourceURL;
// Prefer temp file. It contains the changes against the original document!
if (!rInfo.OldTempURL.isEmpty())
sSourceURL = rInfo.OldTempURL;
else if (!rInfo.NewTempURL.isEmpty())
sSourceURL = rInfo.NewTempURL;
else if (!rInfo.OrgURL.isEmpty())
sSourceURL = rInfo.OrgURL;
else
continue; // nothing real to save! An unmodified but new created document.
INetURLObject aParser(sSourceURL);
// AutoRecovery::EFailureSafeResult eResult =
implts_copyFile(sSourceURL, aParams.m_sSavePath, aParser.getName());
// TODO: Check eResult and react for errors (InteractionHandler!?)
// Currently we ignore it ...
// DON'T UPDATE THE CACHE OR REMOVE ANY TEMP. FILES FROM DISK.
// That has to be forced from outside explicitly.
// See implts_cleanUpWorkingEntry() for further details.
}
}
void AutoRecovery::implts_cleanUpWorkingEntry(const DispatchParams& aParams)
{
CacheLockGuard aCacheLock(this, cppu::WeakComponentImplHelperBase::rBHelper.rMutex, m_nDocCacheLock, LOCK_FOR_CACHE_ADD_REMOVE);
AutoRecovery::TDocumentList::iterator pIt;
for ( pIt = m_lDocCache.begin();
pIt != m_lDocCache.end();
++pIt )
{
AutoRecovery::TDocumentInfo& rInfo = *pIt;
if (rInfo.ID != aParams.m_nWorkingEntryID)
continue;
AutoRecovery::st_impl_removeFile(rInfo.OldTempURL);
AutoRecovery::st_impl_removeFile(rInfo.NewTempURL);
implts_flushConfigItem(rInfo, true); // sal_True => remove it from xml config!
m_lDocCache.erase(pIt);
break; /// !!! pIt is not defined any longer ... further this function has finished it's work
}
}
AutoRecovery::EFailureSafeResult AutoRecovery::implts_copyFile(const OUString& sSource ,
const OUString& sTargetPath,
const OUString& sTargetName)
{
// create content for the parent folder and call transfer on that content with the source content
// and the destination file name as parameters
css::uno::Reference< css::ucb::XCommandEnvironment > xEnvironment;
::ucbhelper::Content aSourceContent;
::ucbhelper::Content aTargetContent;
try
{
aTargetContent = ::ucbhelper::Content(sTargetPath, xEnvironment, m_xContext);
}
catch(const css::uno::Exception&)
{
return AutoRecovery::E_WRONG_TARGET_PATH;
}
sal_Int32 nNameClash;
nNameClash = css::ucb::NameClash::RENAME;
try
{
bool bSuccess = ::ucbhelper::Content::create(sSource, xEnvironment, m_xContext, aSourceContent);
if (!bSuccess)
return AutoRecovery::E_ORIGINAL_FILE_MISSING;
aTargetContent.transferContent(aSourceContent, ::ucbhelper::InsertOperation::Copy, sTargetName, nNameClash);
}
catch(const css::uno::Exception&)
{
return AutoRecovery::E_ORIGINAL_FILE_MISSING;
}
return AutoRecovery::E_COPIED;
}
sal_Bool SAL_CALL AutoRecovery::convertFastPropertyValue( css::uno::Any& /*aConvertedValue*/,
css::uno::Any& /*aOldValue*/ ,
sal_Int32 /*nHandle*/ ,
const css::uno::Any& /*aValue*/ )
{
// not needed currently
return false;
}
void SAL_CALL AutoRecovery::setFastPropertyValue_NoBroadcast( sal_Int32 /*nHandle*/,
const css::uno::Any& /*aValue*/ )
{
// not needed currently
}
void SAL_CALL AutoRecovery::getFastPropertyValue(css::uno::Any& aValue ,
sal_Int32 nHandle) const
{
switch(nHandle)
{
case AUTORECOVERY_PROPHANDLE_EXISTS_RECOVERYDATA :
{
bool bSessionData = false;
::comphelper::ConfigurationHelper::readDirectKey(
m_xContext,
CFG_PACKAGE_RECOVERY,
CFG_PATH_RECOVERYINFO,
CFG_ENTRY_SESSIONDATA,
::comphelper::EConfigurationModes::ReadOnly) >>= bSessionData;
bool bRecoveryData = m_lDocCache.size() > 0;
// exists session data ... => then we can't say, that these
// data are valid for recovery. So we have to return sal_False then!
if (bSessionData)
bRecoveryData = false;
aValue <<= bRecoveryData;
}
break;
case AUTORECOVERY_PROPHANDLE_CRASHED :
aValue = ::comphelper::ConfigurationHelper::readDirectKey(
m_xContext,
CFG_PACKAGE_RECOVERY,
CFG_PATH_RECOVERYINFO,
CFG_ENTRY_CRASHED,
::comphelper::EConfigurationModes::ReadOnly);
break;
case AUTORECOVERY_PROPHANDLE_EXISTS_SESSIONDATA :
aValue = ::comphelper::ConfigurationHelper::readDirectKey(
m_xContext,
CFG_PACKAGE_RECOVERY,
CFG_PATH_RECOVERYINFO,
CFG_ENTRY_SESSIONDATA,
::comphelper::EConfigurationModes::ReadOnly);
break;
}
}
const css::uno::Sequence< css::beans::Property > impl_getStaticPropertyDescriptor()
{
const css::beans::Property pPropertys[] =
{
css::beans::Property( AUTORECOVERY_PROPNAME_CRASHED , AUTORECOVERY_PROPHANDLE_CRASHED , cppu::UnoType<bool>::get() , css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY ),
css::beans::Property( AUTORECOVERY_PROPNAME_EXISTS_RECOVERYDATA, AUTORECOVERY_PROPHANDLE_EXISTS_RECOVERYDATA, cppu::UnoType<bool>::get() , css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY ),
css::beans::Property( AUTORECOVERY_PROPNAME_EXISTS_SESSIONDATA , AUTORECOVERY_PROPHANDLE_EXISTS_SESSIONDATA , cppu::UnoType<bool>::get() , css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY ),
};
const css::uno::Sequence< css::beans::Property > lPropertyDescriptor(pPropertys, AUTORECOVERY_PROPCOUNT);
return lPropertyDescriptor;
}
::cppu::IPropertyArrayHelper& SAL_CALL AutoRecovery::getInfoHelper()
{
static ::cppu::OPropertyArrayHelper ourInfoHelper(impl_getStaticPropertyDescriptor(), true);
return ourInfoHelper;
}
css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL AutoRecovery::getPropertySetInfo()
{
static css::uno::Reference< css::beans::XPropertySetInfo > xInfo(
::cppu::OPropertySetHelper::createPropertySetInfo(getInfoHelper()));
return xInfo;
}
void AutoRecovery::implts_verifyCacheAgainstDesktopDocumentList()
{
SAL_INFO("fwk.autorecovery", "AutoRecovery::implts_verifyCacheAgainstDesktopDocumentList() ...");
try
{
css::uno::Reference< css::frame::XDesktop2 > xDesktop = css::frame::Desktop::create(m_xContext);
css::uno::Reference< css::container::XIndexAccess > xContainer(
xDesktop->getFrames(),
css::uno::UNO_QUERY_THROW);
sal_Int32 i = 0;
sal_Int32 c = xContainer->getCount();
for (i=0; i<c; ++i)
{
css::uno::Reference< css::frame::XFrame > xFrame;
try
{
xContainer->getByIndex(i) >>= xFrame;
if (!xFrame.is())
continue;
}
// can happen in multithreaded environments, that frames was removed from the container during this loop runs!
// Ignore it.
catch(const css::lang::IndexOutOfBoundsException&)
{
continue;
}
// We are interested on visible documents only.
// Note: It's n optional interface .-(
css::uno::Reference< css::awt::XWindow2 > xVisibleCheck(
xFrame->getContainerWindow(),
css::uno::UNO_QUERY);
if (
(!xVisibleCheck.is() ) ||
(!xVisibleCheck->isVisible())
)
{
continue;
}
// extract the model from the frame.
// Ignore "view only" frames, which does not have a model.
css::uno::Reference< css::frame::XController > xController;
css::uno::Reference< css::frame::XModel > xModel;
xController = xFrame->getController();
if (xController.is())
xModel = xController->getModel();
if (!xModel.is())
continue;
// insert model into cache ...
// If the model is already well known inside cache
// it's information set will be updated by asking the
// model again for its new states.
implts_registerDocument(xModel);
}
}
catch(const css::uno::RuntimeException&)
{
throw;
}
catch(const css::uno::Exception&)
{
}
SAL_INFO("fwk.autorecovery", "... AutoRecovery::implts_verifyCacheAgainstDesktopDocumentList()");
}
bool AutoRecovery::impl_enoughDiscSpace(sal_Int32 nRequiredSpace)
{
#ifdef SIMULATE_FULL_DISC
return sal_False;
#else // SIMULATE_FULL_DISC
// In case an error occurs and we are not able to retrieve the needed information
// it's better to "disable" the feature ShowErrorOnFullDisc !
// Otherwhise we start a confusing process of error handling ...
sal_uInt64 nFreeSpace = SAL_MAX_UINT64;
OUString sBackupPath(SvtPathOptions().GetBackupPath());
::osl::VolumeInfo aInfo (osl_VolumeInfo_Mask_FreeSpace);
::osl::FileBase::RC aRC = ::osl::Directory::getVolumeInfo(sBackupPath, aInfo);
if (
(aInfo.isValid(osl_VolumeInfo_Mask_FreeSpace)) &&
(aRC == ::osl::FileBase::E_None )
)
{
nFreeSpace = aInfo.getFreeSpace();
}
sal_uInt64 nFreeMB = (nFreeSpace/1048576);
return (nFreeMB >= (sal_uInt64)nRequiredSpace);
#endif // SIMULATE_FULL_DISC
}
void AutoRecovery::impl_showFullDiscError()
{
OUString sBtn(FwkResId(STR_FULL_DISC_RETRY_BUTTON));
OUString sMsg(FwkResId(STR_FULL_DISC_MSG));
OUString sBackupURL(SvtPathOptions().GetBackupPath());
INetURLObject aConverter(sBackupURL);
sal_Unicode aDelimiter;
OUString sBackupPath = aConverter.getFSysPath(FSysStyle::Detect, &aDelimiter);
if (sBackupPath.getLength() < 1)
sBackupPath = sBackupURL;
ScopedVclPtrInstance<ErrorBox> dlgError(
nullptr, WB_OK,
sMsg.replaceAll("%PATH", sBackupPath));
dlgError->SetButtonText(dlgError->GetButtonId(0), sBtn);
dlgError->Execute();
}
void AutoRecovery::impl_establishProgress(const AutoRecovery::TDocumentInfo& rInfo ,
utl::MediaDescriptor& rArgs ,
const css::uno::Reference< css::frame::XFrame >& xNewFrame)
{
// external well known frame must be preferred (because it was created by ourself
// for loading documents into this frame)!
// But if no frame exists ... we can try to locate it using any frame bound to the provided
// document. Of course we must live without any frame in case the document does not exists at this
// point. But this state should not occur. In such case xNewFrame should be valid ... hopefully .-)
css::uno::Reference< css::frame::XFrame > xFrame = xNewFrame;
if (
(!xFrame.is() ) &&
(rInfo.Document.is())
)
{
css::uno::Reference< css::frame::XController > xController = rInfo.Document->getCurrentController();
if (xController.is())
xFrame = xController->getFrame();
}
// Any outside progress must be used ...
// Only if there is no progress, we can create our own one.
css::uno::Reference< css::task::XStatusIndicator > xInternalProgress;
css::uno::Reference< css::task::XStatusIndicator > xExternalProgress = rArgs.getUnpackedValueOrDefault(
utl::MediaDescriptor::PROP_STATUSINDICATOR(),
css::uno::Reference< css::task::XStatusIndicator >() );
// Normally a progress is set from outside (e.g. by the CrashSave/Recovery dialog, which uses our dispatch API).
// But for a normal auto save we don't have such "external progress"... because this function is triggered by our own timer then.
// In such case we must create our own progress !
if (
(! xExternalProgress.is()) &&
(xFrame.is() )
)
{
css::uno::Reference< css::task::XStatusIndicatorFactory > xProgressFactory(xFrame, css::uno::UNO_QUERY);
if (xProgressFactory.is())
xInternalProgress = xProgressFactory->createStatusIndicator();
}
// HACK
// An external provided progress (most given by the CrashSave/Recovery dialog)
// must be preferred. But we know that some application filters query it's own progress instance
// at the frame method Frame::createStatusIndicator().
// So we use a two step mechanism:
// 1) we set the progress inside the MediaDescriptor, which will be provided to the filter
// 2) and we set a special Frame property, which overwrites the normal behaviour of Frame::createStatusIndicator .-)
// But we suppress 2) in case we uses an internal progress. Because then it doesn't matter
// if our applications make it wrong. In such case the internal progress resists at the same frame
// and there is no need to forward progress activities to e.g. an outside dialog .-)
if (
(xExternalProgress.is()) &&
(xFrame.is() )
)
{
css::uno::Reference< css::beans::XPropertySet > xFrameProps(xFrame, css::uno::UNO_QUERY);
if (xFrameProps.is())
xFrameProps->setPropertyValue(FRAME_PROPNAME_ASCII_INDICATORINTERCEPTION, css::uno::makeAny(xExternalProgress));
}
// But inside the MediaDescriptor we must set our own create progress ...
// in case there is not already another progress set.
rArgs.createItemIfMissing(utl::MediaDescriptor::PROP_STATUSINDICATOR(), xInternalProgress);
}
void AutoRecovery::impl_forgetProgress(const AutoRecovery::TDocumentInfo& rInfo ,
utl::MediaDescriptor& rArgs ,
const css::uno::Reference< css::frame::XFrame >& xNewFrame)
{
// external well known frame must be preferred (because it was created by ourself
// for loading documents into this frame)!
// But if no frame exists ... we can try to locate it using any frame bound to the provided
// document. Of course we must live without any frame in case the document does not exists at this
// point. But this state should not occur. In such case xNewFrame should be valid ... hopefully .-)
css::uno::Reference< css::frame::XFrame > xFrame = xNewFrame;
if (
(!xFrame.is() ) &&
(rInfo.Document.is())
)
{
css::uno::Reference< css::frame::XController > xController = rInfo.Document->getCurrentController();
if (xController.is())
xFrame = xController->getFrame();
}
// stop progress interception on corresponding frame.
css::uno::Reference< css::beans::XPropertySet > xFrameProps(xFrame, css::uno::UNO_QUERY);
if (xFrameProps.is())
xFrameProps->setPropertyValue(FRAME_PROPNAME_ASCII_INDICATORINTERCEPTION, css::uno::makeAny(css::uno::Reference< css::task::XStatusIndicator >()));
// forget progress inside list of arguments.
utl::MediaDescriptor::iterator pArg = rArgs.find(utl::MediaDescriptor::PROP_STATUSINDICATOR());
if (pArg != rArgs.end())
{
rArgs.erase(pArg);
pArg = rArgs.end();
}
}
void AutoRecovery::impl_flushALLConfigChanges()
{
try
{
css::uno::Reference< css::uno::XInterface > xRecoveryCfg;
/* SAFE */ {
osl::MutexGuard g(cppu::WeakComponentImplHelperBase::rBHelper.rMutex);
xRecoveryCfg.set(m_xRecoveryCFG, css::uno::UNO_QUERY);
} /* SAFE */
if (xRecoveryCfg.is())
::comphelper::ConfigurationHelper::flush(xRecoveryCfg);
// SOLAR SAFE ->
SolarMutexGuard aGuard;
::utl::ConfigManager::storeConfigItems();
}
catch(const css::uno::Exception&)
{
}
}
void AutoRecovery::st_impl_removeFile(const OUString& sURL)
{
if ( sURL.isEmpty())
return;
try
{
::ucbhelper::Content aContent = ::ucbhelper::Content(sURL, css::uno::Reference< css::ucb::XCommandEnvironment >(), m_xContext);
aContent.executeCommand("delete", css::uno::makeAny(true));
}
catch(const css::uno::Exception&)
{
}
}
void AutoRecovery::st_impl_removeLockFile()
{
try
{
OUString sUserURL;
::utl::Bootstrap::locateUserInstallation( sUserURL );
OUStringBuffer sLockURLBuf;
sLockURLBuf.append (sUserURL);
sLockURLBuf.append("/.lock");
OUString sLockURL = sLockURLBuf.makeStringAndClear();
AutoRecovery::st_impl_removeFile(sLockURL);
}
catch(const css::uno::Exception&)
{
}
}
struct Instance {
explicit Instance(
css::uno::Reference<css::uno::XComponentContext> const & context):
instance(
static_cast<cppu::OWeakObject *>(new AutoRecovery(context)))
{
// 2nd phase initialization needed
static_cast<AutoRecovery*>(static_cast<cppu::OWeakObject *>
(instance.get()))->initListeners();
}
css::uno::Reference<css::uno::XInterface> instance;
};
struct Singleton:
public rtl::StaticWithArg<
Instance, css::uno::Reference<css::uno::XComponentContext>, Singleton>
{};
}
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * SAL_CALL
com_sun_star_comp_framework_AutoRecovery_get_implementation(
css::uno::XComponentContext *context,
css::uno::Sequence<css::uno::Any> const &)
{
return cppu::acquire(static_cast<cppu::OWeakObject *>(
Singleton::get(context).instance.get()));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|