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
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/desks_storage/core/desk_template_conversion.h"
#include <optional>
#include <string_view>
#include "base/containers/fixed_flat_set.h"
#include "base/json/json_reader.h"
#include "base/json/values_util.h"
#include "base/logging.h"
#include "base/notreached.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/time/time.h"
#include "base/uuid.h"
#include "chromeos/ui/base/window_state_type.h"
#include "components/app_constants/constants.h"
#include "components/app_restore/app_launch_info.h"
#include "components/app_restore/restore_data.h"
#include "components/app_restore/window_info.h"
#include "components/services/app_service/public/cpp/app_registry_cache.h"
#include "components/services/app_service/public/cpp/app_types.h"
#include "components/sync/protocol/proto_enum_conversions.h"
#include "components/sync_device_info/device_info_proto_enum_util.h"
#include "components/tab_groups/tab_group_color.h"
#include "components/tab_groups/tab_group_info.h"
#include "components/tab_groups/tab_group_visual_data.h"
#include "ui/base/mojom/window_show_state.mojom.h"
#include "ui/gfx/geometry/rect.h"
namespace {
using SyncWindowOpenDisposition =
sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition;
using SyncLaunchContainer = sync_pb::WorkspaceDeskSpecifics_LaunchContainer;
using GroupColor = tab_groups::TabGroupColorId;
using BrowserAppTab =
sync_pb::WorkspaceDeskSpecifics_BrowserAppWindow_BrowserAppTab;
using BrowserAppWindow = sync_pb::WorkspaceDeskSpecifics_BrowserAppWindow;
using ArcApp = sync_pb::WorkspaceDeskSpecifics_ArcApp;
using ArcAppWindowSize = sync_pb::WorkspaceDeskSpecifics_ArcApp_WindowSize;
using ash::DeskTemplate;
using ash::DeskTemplateSource;
using ash::DeskTemplateType;
using SyncDeskType = sync_pb::WorkspaceDeskSpecifics_DeskType;
using WindowState = sync_pb::WorkspaceDeskSpecifics_WindowState;
using WindowBound = sync_pb::WorkspaceDeskSpecifics_WindowBound;
using LaunchContainer = sync_pb::WorkspaceDeskSpecifics_LaunchContainer;
// Use name prefixed with Sync here to avoid name collision with original class
// which isn't defined in a namespace.
using SyncWindowOpenDisposition =
sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition;
using ProgressiveWebApp = sync_pb::WorkspaceDeskSpecifics_ProgressiveWebApp;
using ChromeApp = sync_pb::WorkspaceDeskSpecifics_ChromeApp;
using WorkspaceDeskSpecifics_App = sync_pb::WorkspaceDeskSpecifics_App;
using SyncTabGroup = sync_pb::WorkspaceDeskSpecifics_BrowserAppWindow_TabGroup;
using SyncTabGroupColor = sync_pb::WorkspaceDeskSpecifics_TabGroupColor;
using TabGroupColor = tab_groups::TabGroupColorId;
// JSON value keys.
constexpr char kActiveTabIndex[] = "active_tab_index";
constexpr char kAppId[] = "app_id";
constexpr char kApps[] = "apps";
constexpr char kAppName[] = "app_name";
constexpr char kAppType[] = "app_type";
constexpr char kAppTypeArc[] = "ARC";
constexpr char kAppTypeArcAdminFormat[] = "arc";
constexpr char kAppTypeBrowser[] = "BROWSER";
constexpr char kAppTypeBrowserAdminFormat[] = "browser";
constexpr char kAppTypeChrome[] = "CHROME_APP";
constexpr char kAppTypeChromeAdminFormat[] = "chrome_app";
constexpr char kAppTypeProgressiveWebAdminFormat[] = "progressive_web_app";
constexpr char kAppTypeIsolatedWebAppAdminFormat[] = "isolated_web_app";
constexpr char kAppTypeUnknown[] = "UKNOWN";
constexpr char kAppTypeUnsupported[] = "UNSUPPORTED";
constexpr char kAutoLaunchOnStartup[] = "auto_launch_on_startup";
constexpr char kBoundsInRoot[] = "bounds_in_root";
constexpr char kCreatedTime[] = "created_time_usec";
constexpr char kCoralTabAppEntities[] = "coral_tab_app_entities";
constexpr char kDesk[] = "desk";
constexpr char kDeskType[] = "desk_type";
constexpr char kDeskTypeTemplate[] = "TEMPLATE";
constexpr char kDeskTypeSaveAndRecall[] = "SAVE_AND_RECALL";
constexpr char kDeskTypeCoral[] = "CORAL";
constexpr char kDeskTypeFloatingWorkspace[] = "FLOATING_WORKSPACE";
constexpr char kDeskTypeUnknown[] = "UNKNOWN";
constexpr char kDisplayId[] = "display_id";
constexpr char kEventFlag[] = "event_flag";
constexpr char kFirstNonPinnedTabIndex[] = "first_non_pinned_tab_index";
constexpr char kIsAppTypeBrowser[] = "is_app";
constexpr char kLaunchContainer[] = "launch_container";
constexpr char kLaunchContainerWindow[] = "LAUNCH_CONTAINER_WINDOW";
constexpr char kLaunchContainerUnspecified[] = "LAUNCH_CONTAINER_UNSPECIFIED";
constexpr char kLaunchContainerPanelDeprecated[] = "LAUNCH_CONTAINER_PANEL";
constexpr char kLaunchContainerTab[] = "LAUNCH_CONTAINER_TAB";
constexpr char kLaunchContainerNone[] = "LAUNCH_CONTAINER_NONE";
constexpr char kMaximumSize[] = "maximum_size";
constexpr char kMinimumSize[] = "minimum_size";
constexpr char kName[] = "name";
constexpr char kOverrideUrl[] = "override_url";
constexpr char kPolicy[] = "policy";
constexpr char kPreMinimizedWindowState[] = "pre_minimized_window_state";
constexpr char kTabRangeFirstIndex[] = "first_index";
constexpr char kTabRangeLastIndex[] = "last_index";
constexpr char kSizeHeight[] = "height";
constexpr char kSizeWidth[] = "width";
constexpr char kSnapPercentage[] = "snap_percent";
constexpr char kTabs[] = "tabs";
constexpr char kTabsAdminFormat[] = "browser_tabs";
constexpr char kTabGroups[] = "tab_groups";
constexpr char kTabUrl[] = "url";
constexpr char kTitle[] = "title";
constexpr char kUpdatedTime[] = "updated_time_usec";
constexpr char kUuid[] = "uuid";
constexpr char kVersion[] = "version";
constexpr char kTabGroupTitleKey[] = "title";
constexpr char kTabGroupColorKey[] = "color";
constexpr char kTabGroupIsCollapsed[] = "is_collapsed";
constexpr char kWindowId[] = "window_id";
constexpr char kWindowBound[] = "window_bound";
constexpr char kWindowBoundHeight[] = "height";
constexpr char kWindowBoundLeft[] = "left";
constexpr char kWindowBoundTop[] = "top";
constexpr char kWindowBoundWidth[] = "width";
constexpr char kWindowOpenDisposition[] = "window_open_disposition";
constexpr char kWindowOpenDispositionUnknown[] = "UNKOWN";
constexpr char kWindowOpenDispositionCurrentTab[] = "CURRENT_TAB";
constexpr char kWindowOpenDispositionSingletonTab[] = "SINGLETON_TAB";
constexpr char kWindowOpenDispositionNewForegroundTab[] = "NEW_FOREGROUND_TAB";
constexpr char kWindowOpenDispositionNewBackgroundTab[] = "NEW_BACKGROUND_TAB";
constexpr char kWindowOpenDispositionNewPopup[] = "NEW_POPUP";
constexpr char kWindowOpenDispositionNewWindow[] = "NEW_WINDOW";
constexpr char kWindowOpenDispositionSaveToDisk[] = "SAVE_TO_DISK";
constexpr char kWindowOpenDispositionOffTheRecord[] = "OFF_THE_RECORD";
constexpr char kWindowOpenDispositionIgnoreAction[] = "IGNORE_ACTION";
constexpr char kWindowOpenDispositionSwitchToTab[] = "SWITCH_TO_TAB";
constexpr char kWindowOpenDispositionNewPictureInPicture[] =
"NEW_PICTURE_IN_PICTURE";
constexpr char kWindowState[] = "window_state";
constexpr char kWindowStateNormal[] = "NORMAL";
constexpr char kWindowStateMinimized[] = "MINIMIZED";
constexpr char kWindowStateMaximized[] = "MAXIMIZED";
constexpr char kWindowStateFullscreen[] = "FULLSCREEN";
constexpr char kWindowStatePrimarySnapped[] = "PRIMARY_SNAPPED";
constexpr char kWindowStateSecondarySnapped[] = "SECONDARY_SNAPPED";
constexpr char kWindowStateFloated[] = "FLOATED";
constexpr char kZIndex[] = "z_index";
// Valid value sets.
constexpr auto kValidDeskTypes = base::MakeFixedFlatSet<std::string_view>(
{kDeskTypeTemplate, kDeskTypeSaveAndRecall, kDeskTypeCoral,
kDeskTypeFloatingWorkspace});
constexpr auto kValidLaunchContainers =
base::MakeFixedFlatSet<std::string_view>(
{kLaunchContainerWindow, kLaunchContainerPanelDeprecated,
kLaunchContainerTab, kLaunchContainerNone,
kLaunchContainerUnspecified});
constexpr auto kValidWindowOpenDispositions =
base::MakeFixedFlatSet<std::string_view>(
{kWindowOpenDispositionUnknown, kWindowOpenDispositionCurrentTab,
kWindowOpenDispositionSingletonTab,
kWindowOpenDispositionNewForegroundTab,
kWindowOpenDispositionNewBackgroundTab, kWindowOpenDispositionNewPopup,
kWindowOpenDispositionNewWindow, kWindowOpenDispositionSaveToDisk,
kWindowOpenDispositionOffTheRecord, kWindowOpenDispositionIgnoreAction,
kWindowOpenDispositionSwitchToTab,
kWindowOpenDispositionNewPictureInPicture});
constexpr auto kValidWindowStates = base::MakeFixedFlatSet<std::string_view>(
{kWindowStateNormal, kWindowStateMinimized, kWindowStateMaximized,
kWindowStateFullscreen, kWindowStatePrimarySnapped,
kWindowStateSecondarySnapped, kWindowStateFloated, kZIndex});
constexpr auto kValidTabGroupColors = base::MakeFixedFlatSet<std::string_view>(
{tab_groups::kTabGroupColorUnknown, tab_groups::kTabGroupColorGrey,
tab_groups::kTabGroupColorBlue, tab_groups::kTabGroupColorRed,
tab_groups::kTabGroupColorYellow, tab_groups::kTabGroupColorGreen,
tab_groups::kTabGroupColorPink, tab_groups::kTabGroupColorPurple,
tab_groups::kTabGroupColorCyan, tab_groups::kTabGroupColorOrange});
// Version number.
constexpr int kVersionNum = 1;
// Conversion to desk methods.
bool GetString(const base::Value::Dict& dict,
const char* key,
std::string* out) {
const std::string* value = dict.FindString(key);
if (!value)
return false;
*out = *value;
return true;
}
bool GetInt(const base::Value::Dict& dict, const char* key, int* out) {
std::optional<int> value = dict.FindInt(key);
if (!value)
return false;
*out = *value;
return true;
}
bool GetBool(const base::Value::Dict& dict, const char* key, bool* out) {
std::optional<bool> value = dict.FindBool(key);
if (!value)
return false;
*out = *value;
return true;
}
// Get App ID from App proto.
std::string GetJsonAppId(const base::Value::Dict& app) {
std::string app_type;
if (GetString(app, kAppType, &app_type) && app_type == kAppTypeBrowser) {
return std::string(app_constants::kChromeAppId);
}
// Fall back on a stored app_id (which may or may not be present).
std::string app_id;
GetString(app, kAppId, &app_id);
return app_id;
}
// Convert a TabGroupInfo object to a base::Value::Dict.
base::Value::Dict ConvertTabGroupInfoToDict(
const tab_groups::TabGroupInfo& group_info) {
base::Value::Dict tab_group_dict;
tab_group_dict.Set(kTabRangeFirstIndex,
static_cast<int>(group_info.tab_range.start()));
tab_group_dict.Set(kTabRangeLastIndex,
static_cast<int>(group_info.tab_range.end()));
tab_group_dict.Set(kTabGroupTitleKey,
base::UTF16ToUTF8(group_info.visual_data.title()));
tab_group_dict.Set(kTabGroupColorKey, tab_groups::TabGroupColorToString(
group_info.visual_data.color()));
tab_group_dict.Set(kTabGroupIsCollapsed,
group_info.visual_data.is_collapsed());
return tab_group_dict;
}
// Convert Coral tab and app entities to a base::Value::Dict.
base::Value::Dict ConvertCoralTabAppEntitiesToDict(
const std::vector<coral::mojom::EntityPtr>& coral_tab_app_entities) {
base::Value::List tab_entities;
base::Value::List app_entities;
for (const auto& entity : coral_tab_app_entities) {
if (entity->is_tab()) {
const auto& tab = entity->get_tab();
auto tab_value = base::Value::Dict()
.Set(kTitle, tab->title)
.Set(kTabUrl, tab->url.possibly_invalid_spec());
tab_entities.Append(std::move(tab_value));
} else if (entity->is_app()) {
const auto& app = entity->get_app();
auto app_value =
base::Value::Dict().Set(kAppName, app->title).Set(kAppId, app->id);
app_entities.Append(std::move(app_value));
}
}
base::Value::Dict tab_app_entities_dict;
if (!tab_entities.empty()) {
tab_app_entities_dict.Set(kTabs, std::move(tab_entities));
}
if (!app_entities.empty()) {
tab_app_entities_dict.Set(kApps, std::move(app_entities));
}
return tab_app_entities_dict;
}
bool IsValidGroupColor(const std::string& group_color) {
return base::Contains(kValidTabGroupColors, group_color);
}
GroupColor ConvertGroupColorStringToGroupColor(const std::string& group_color) {
if (group_color == tab_groups::kTabGroupColorGrey) {
return GroupColor::kGrey;
} else if (group_color == tab_groups::kTabGroupColorBlue) {
return GroupColor::kBlue;
} else if (group_color == tab_groups::kTabGroupColorRed) {
return GroupColor::kRed;
} else if (group_color == tab_groups::kTabGroupColorYellow) {
return GroupColor::kYellow;
} else if (group_color == tab_groups::kTabGroupColorGreen) {
return GroupColor::kGreen;
} else if (group_color == tab_groups::kTabGroupColorPink) {
return GroupColor::kPink;
} else if (group_color == tab_groups::kTabGroupColorPurple) {
return GroupColor::kPurple;
} else if (group_color == tab_groups::kTabGroupColorCyan) {
return GroupColor::kCyan;
} else if (group_color == tab_groups::kTabGroupColorOrange) {
return GroupColor::kOrange;
// There is no UNKNOWN equivalent in GroupColor, simply default
// to grey.
} else if (group_color == tab_groups::kTabGroupColorUnknown) {
return GroupColor::kGrey;
} else {
NOTREACHED();
}
}
// Constructs a GroupVisualData from value `group_visual_data` IFF all fields
// are present and valid in the value parameter. Returns true on success, false
// on failure.
bool MakeTabGroupVisualDataFromDict(
const base::Value::Dict& tab_group,
tab_groups::TabGroupVisualData* out_visual_data) {
std::string tab_group_title;
std::string group_color_string;
bool is_collapsed;
if (GetString(tab_group, kTabGroupTitleKey, &tab_group_title) &&
GetBool(tab_group, kTabGroupIsCollapsed, &is_collapsed) &&
GetString(tab_group, kTabGroupColorKey, &group_color_string) &&
IsValidGroupColor(group_color_string)) {
*out_visual_data = tab_groups::TabGroupVisualData(
base::UTF8ToUTF16(tab_group_title),
ConvertGroupColorStringToGroupColor(group_color_string), is_collapsed);
return true;
}
return false;
}
// Constructs a gfx::Range from value `group_range` IFF all fields are
// present and valid in the value parameter. Returns true on success, false on
// failure.
bool MakeTabGroupRangeFromDict(const base::Value::Dict& tab_group,
gfx::Range* out_range) {
int32_t range_start;
int32_t range_end;
if (GetInt(tab_group, kTabRangeFirstIndex, &range_start) &&
GetInt(tab_group, kTabRangeLastIndex, &range_end)) {
*out_range = gfx::Range(range_start, range_end);
return true;
}
return false;
}
// Constructs a TabGroupInfo from `tab_group` IFF all fields are present
// and valid in the value parameter. Returns true on success, false on failure.
std::optional<tab_groups::TabGroupInfo> MakeTabGroupInfoFromDict(
const base::Value::Dict& tab_group) {
std::optional<tab_groups::TabGroupInfo> tab_group_info = std::nullopt;
tab_groups::TabGroupVisualData visual_data;
gfx::Range range;
if (MakeTabGroupRangeFromDict(tab_group, &range) &&
MakeTabGroupVisualDataFromDict(tab_group, &visual_data)) {
tab_group_info.emplace(range, visual_data);
}
return tab_group_info;
}
// Returns true if launch container string value is valid.
bool IsValidLaunchContainer(const std::string& launch_container) {
return base::Contains(kValidLaunchContainers, launch_container);
}
// Returns a casted apps::LaunchContainer to be set as an app restore data's
// container field.
int32_t StringToLaunchContainer(const std::string& launch_container) {
if (launch_container == kLaunchContainerWindow) {
return static_cast<int32_t>(apps::LaunchContainer::kLaunchContainerWindow);
} else if (launch_container == kLaunchContainerPanelDeprecated) {
return static_cast<int32_t>(
apps::LaunchContainer::kLaunchContainerPanelDeprecated);
} else if (launch_container == kLaunchContainerTab) {
return static_cast<int32_t>(apps::LaunchContainer::kLaunchContainerTab);
} else if (launch_container == kLaunchContainerNone) {
return static_cast<int32_t>(apps::LaunchContainer::kLaunchContainerNone);
} else if (launch_container == kLaunchContainerUnspecified) {
return static_cast<int32_t>(apps::LaunchContainer::kLaunchContainerWindow);
// Dcheck if our container isn't valid. We should not reach here.
} else {
DCHECK(IsValidLaunchContainer(launch_container));
return static_cast<int32_t>(apps::LaunchContainer::kLaunchContainerWindow);
}
}
// Returns true if the disposition is a valid value.
bool IsValidWindowOpenDisposition(const std::string& disposition) {
return base::Contains(kValidWindowOpenDispositions, disposition);
}
// Returns a casted WindowOpenDisposition to be set in the app restore data.
int32_t StringToWindowOpenDisposition(const std::string& disposition) {
if (disposition == kWindowOpenDispositionUnknown) {
return static_cast<int32_t>(WindowOpenDisposition::UNKNOWN);
} else if (disposition == kWindowOpenDispositionCurrentTab) {
return static_cast<int32_t>(WindowOpenDisposition::CURRENT_TAB);
} else if (disposition == kWindowOpenDispositionSingletonTab) {
return static_cast<int32_t>(WindowOpenDisposition::SINGLETON_TAB);
} else if (disposition == kWindowOpenDispositionNewForegroundTab) {
return static_cast<int32_t>(WindowOpenDisposition::NEW_FOREGROUND_TAB);
} else if (disposition == kWindowOpenDispositionNewBackgroundTab) {
return static_cast<int32_t>(WindowOpenDisposition::NEW_BACKGROUND_TAB);
} else if (disposition == kWindowOpenDispositionNewPopup) {
return static_cast<int32_t>(WindowOpenDisposition::NEW_POPUP);
} else if (disposition == kWindowOpenDispositionNewWindow) {
return static_cast<int32_t>(WindowOpenDisposition::NEW_WINDOW);
} else if (disposition == kWindowOpenDispositionSaveToDisk) {
return static_cast<int32_t>(WindowOpenDisposition::SAVE_TO_DISK);
} else if (disposition == kWindowOpenDispositionOffTheRecord) {
return static_cast<int32_t>(WindowOpenDisposition::OFF_THE_RECORD);
} else if (disposition == kWindowOpenDispositionIgnoreAction) {
return static_cast<int32_t>(WindowOpenDisposition::IGNORE_ACTION);
} else if (disposition == kWindowOpenDispositionNewPictureInPicture) {
return static_cast<int32_t>(WindowOpenDisposition::NEW_PICTURE_IN_PICTURE);
// Dcheck that the disposition is valid, we should never get here unless
// the disposition is invalid.
} else {
DCHECK(IsValidWindowOpenDisposition(disposition));
return static_cast<int32_t>(WindowOpenDisposition::UNKNOWN);
}
}
// Convert App JSON to `app_restore::AppLaunchInfo`.
std::unique_ptr<app_restore::AppLaunchInfo> ConvertJsonToAppLaunchInfo(
const base::Value::Dict& app) {
int32_t window_id;
if (!GetInt(app, kWindowId, &window_id))
return nullptr;
const std::string app_id = GetJsonAppId(app);
if (app_id.empty())
return nullptr;
std::unique_ptr<app_restore::AppLaunchInfo> app_launch_info =
std::make_unique<app_restore::AppLaunchInfo>(app_id, window_id);
std::string display_id_string;
int64_t display_id;
if (GetString(app, kDisplayId, &display_id_string) &&
base::StringToInt64(display_id_string, &display_id)) {
app_launch_info->display_id = display_id;
}
std::string launch_container;
if (GetString(app, kLaunchContainer, &launch_container) &&
IsValidLaunchContainer(launch_container)) {
app_launch_info->container = StringToLaunchContainer(launch_container);
}
std::string disposition;
if (GetString(app, kWindowOpenDisposition, &disposition) &&
IsValidWindowOpenDisposition(disposition)) {
app_launch_info->disposition = StringToWindowOpenDisposition(disposition);
}
std::string app_name;
if (GetString(app, kAppName, &app_name)) {
app_launch_info->browser_extra_info.app_name = app_name;
}
std::string override_url;
if (GetString(app, kOverrideUrl, &override_url)) {
app_launch_info->override_url = GURL(override_url);
}
// TODO(crbug.com/1311801): Add support for actual event_flag values.
app_launch_info->event_flag = 0;
bool app_type_browser;
if (GetBool(app, kIsAppTypeBrowser, &app_type_browser)) {
app_launch_info->browser_extra_info.app_type_browser = app_type_browser;
}
if (app_id == app_constants::kChromeAppId) {
int active_tab_index;
if (GetInt(app, kActiveTabIndex, &active_tab_index)) {
app_launch_info->browser_extra_info.active_tab_index = active_tab_index;
}
int first_non_pinned_tab_index;
if (GetInt(app, kFirstNonPinnedTabIndex, &first_non_pinned_tab_index)) {
app_launch_info->browser_extra_info.first_non_pinned_tab_index =
first_non_pinned_tab_index;
}
// Fill in the URL list
if (const base::Value::List* tabs = app.FindList(kTabs)) {
for (auto& tab : *tabs) {
std::string url;
if (GetString(tab.GetDict(), kTabUrl, &url)) {
app_launch_info->browser_extra_info.urls.emplace_back(url);
}
}
}
// Fill the tab groups
if (const base::Value::List* tab_groups = app.FindList(kTabGroups)) {
for (auto& tab : *tab_groups) {
std::optional<tab_groups::TabGroupInfo> tab_group =
MakeTabGroupInfoFromDict(tab.GetDict());
if (tab_group.has_value()) {
app_launch_info->browser_extra_info.tab_group_infos.push_back(
std::move(tab_group.value()));
}
}
}
}
// For Chrome apps and PWAs, the `app_id` is sufficient for identification.
return app_launch_info;
}
std::vector<coral::mojom::EntityPtr> ConvertDictToCoralTabAppEntities(
const base::Value::Dict& tab_app_entities_dict) {
std::vector<coral::mojom::EntityPtr> tab_app_entities;
if (const auto* tab_entities = tab_app_entities_dict.FindList(kTabs)) {
for (const auto& tab_entity : *tab_entities) {
const std::string* tab_title_ptr =
tab_entity.GetDict().FindString(kTitle);
const std::string* tab_url_ptr = tab_entity.GetDict().FindString(kTabUrl);
tab_app_entities.emplace_back(coral::mojom::Entity::NewTab(
coral::mojom::Tab::New(tab_title_ptr ? *tab_title_ptr : std::string(),
tab_url_ptr ? GURL(*tab_url_ptr) : GURL())));
}
}
if (const auto* app_entities = tab_app_entities_dict.FindList(kApps)) {
for (const auto& app_entity : *app_entities) {
const std::string* app_name_ptr =
app_entity.GetDict().FindString(kAppName);
const std::string* app_id_ptr = app_entity.GetDict().FindString(kAppId);
tab_app_entities.emplace_back(coral::mojom::Entity::NewApp(
coral::mojom::App::New(app_name_ptr ? *app_name_ptr : std::string(),
app_id_ptr ? *app_id_ptr : std::string())));
}
}
return tab_app_entities;
}
bool IsValidWindowState(const std::string& window_state) {
return base::Contains(kValidWindowStates, window_state);
}
// Convert JSON string WindowState `state` to ui::mojom::WindowShowState used by
// the app_restore::WindowInfo struct.
ui::mojom::WindowShowState ToUiWindowState(const std::string& window_state) {
if (window_state == kWindowStateNormal)
return ui::mojom::WindowShowState::kNormal;
else if (window_state == kWindowStateMinimized)
return ui::mojom::WindowShowState::kMinimized;
else if (window_state == kWindowStateMaximized)
return ui::mojom::WindowShowState::kMaximized;
else if (window_state == kWindowStateFullscreen)
return ui::mojom::WindowShowState::kFullscreen;
else if (window_state == kWindowStatePrimarySnapped)
return ui::mojom::WindowShowState::kNormal;
else if (window_state == kWindowStateSecondarySnapped)
return ui::mojom::WindowShowState::kNormal;
// We should never reach here unless we have been passed an invalid window
// state
DCHECK(IsValidWindowState(window_state));
return ui::mojom::WindowShowState::kNormal;
}
// Convert JSON string WindowState `state` to chromeos::WindowStateType used by
// the app_restore::WindowInfo struct.
chromeos::WindowStateType ToChromeOsWindowState(
const std::string& window_state) {
if (window_state == kWindowStateNormal)
return chromeos::WindowStateType::kNormal;
else if (window_state == kWindowStateMinimized)
return chromeos::WindowStateType::kMinimized;
else if (window_state == kWindowStateMaximized)
return chromeos::WindowStateType::kMaximized;
else if (window_state == kWindowStateFullscreen)
return chromeos::WindowStateType::kFullscreen;
else if (window_state == kWindowStatePrimarySnapped)
return chromeos::WindowStateType::kPrimarySnapped;
else if (window_state == kWindowStateSecondarySnapped)
return chromeos::WindowStateType::kSecondarySnapped;
else if (window_state == kWindowStateFloated)
return chromeos::WindowStateType::kFloated;
// We should never reach here unless we have been passed an invalid window
// state.
DCHECK(IsValidWindowState(window_state));
return chromeos::WindowStateType::kNormal;
}
void FillArcExtraWindowInfoFromJson(
const base::Value::Dict& app,
app_restore::WindowInfo::ArcExtraInfo* out_window_info) {
const base::Value::Dict* bounds_in_root = app.FindDict(kBoundsInRoot);
int top;
int left;
int bounds_width;
int bounds_height;
if (bounds_in_root && GetInt(*bounds_in_root, kWindowBoundTop, &top) &&
GetInt(*bounds_in_root, kWindowBoundLeft, &left) &&
GetInt(*bounds_in_root, kWindowBoundWidth, &bounds_width) &&
GetInt(*bounds_in_root, kWindowBoundHeight, &bounds_height)) {
out_window_info->bounds_in_root.emplace(left, top, bounds_width,
bounds_height);
}
const base::Value::Dict* maximum_size = app.FindDict(kMaximumSize);
int max_width;
int max_height;
if (maximum_size && GetInt(*maximum_size, kSizeWidth, &max_width) &&
GetInt(*maximum_size, kSizeHeight, &max_height)) {
out_window_info->maximum_size.emplace(max_width, max_height);
}
const base::Value::Dict* minimum_size = app.FindDict(kMinimumSize);
int min_width;
int min_height;
if (minimum_size && GetInt(*minimum_size, kSizeWidth, &min_width) &&
GetInt(*minimum_size, kSizeHeight, &min_height)) {
out_window_info->minimum_size.emplace(min_width, min_height);
}
}
// Fill `out_window_info` with information from JSON `app`.
void FillWindowInfoFromJson(const base::Value::Dict& app,
app_restore::WindowInfo* out_window_info) {
std::string window_state;
chromeos::WindowStateType cros_window_state =
chromeos::WindowStateType::kDefault;
if (GetString(app, kWindowState, &window_state) &&
IsValidWindowState(window_state)) {
cros_window_state = ToChromeOsWindowState(window_state);
out_window_info->window_state_type.emplace(cros_window_state);
}
std::string app_type;
if (GetString(app, kAppType, &app_type) && app_type == kAppTypeArc) {
FillArcExtraWindowInfoFromJson(app,
&out_window_info->arc_extra_info.emplace());
}
const base::Value::Dict* window_bound = app.FindDict(kWindowBound);
int top;
int left;
int width;
int height;
if (window_bound && GetInt(*window_bound, kWindowBoundTop, &top) &&
GetInt(*window_bound, kWindowBoundLeft, &left) &&
GetInt(*window_bound, kWindowBoundWidth, &width) &&
GetInt(*window_bound, kWindowBoundHeight, &height)) {
out_window_info->current_bounds.emplace(left, top, width, height);
}
int z_index;
if (GetInt(app, kZIndex, &z_index))
out_window_info->activation_index.emplace(z_index);
std::string display_id_string;
int64_t display_id;
if (GetString(app, kDisplayId, &display_id_string) &&
base::StringToInt64(display_id_string, &display_id)) {
out_window_info->display_id = display_id;
}
std::string pre_minimized_window_state;
if (GetString(app, kPreMinimizedWindowState, &pre_minimized_window_state) &&
IsValidWindowState(pre_minimized_window_state) &&
cros_window_state == chromeos::WindowStateType::kMinimized) {
out_window_info->pre_minimized_show_state_type.emplace(
ToUiWindowState(pre_minimized_window_state));
}
int snap_percentage;
if (GetInt(app, kSnapPercentage, &snap_percentage))
out_window_info->snap_percentage.emplace(snap_percentage);
std::string title;
if (GetString(app, kTitle, &title))
out_window_info->app_title.emplace(base::UTF8ToUTF16(title));
}
// Convert a desk template to `app_restore::RestoreData`.
std::unique_ptr<app_restore::RestoreData> ConvertJsonToRestoreData(
const base::Value::Dict* desk) {
std::unique_ptr<app_restore::RestoreData> restore_data =
std::make_unique<app_restore::RestoreData>();
const base::Value::List* apps = desk->FindList(kApps);
if (apps) {
for (const auto& app : *apps) {
const base::Value::Dict& app_dict = app.GetDict();
std::unique_ptr<app_restore::AppLaunchInfo> app_launch_info =
ConvertJsonToAppLaunchInfo(app_dict);
if (!app_launch_info)
continue; // Skip unsupported app.
int window_id;
if (!GetInt(app_dict, kWindowId, &window_id)) {
return nullptr;
}
const std::string app_id = app_launch_info->app_id;
restore_data->AddAppLaunchInfo(std::move(app_launch_info));
app_restore::WindowInfo app_window_info;
FillWindowInfoFromJson(app_dict, &app_window_info);
restore_data->ModifyWindowInfo(app_id, window_id, app_window_info);
}
}
return restore_data;
}
// Conversion to value methods.
base::Value::Dict ConvertWindowBoundToValue(const gfx::Rect& rect) {
base::Value::Dict rectangle_value;
rectangle_value.Set(kWindowBoundTop, base::Value(rect.y()));
rectangle_value.Set(kWindowBoundLeft, base::Value(rect.x()));
rectangle_value.Set(kWindowBoundHeight, base::Value(rect.height()));
rectangle_value.Set(kWindowBoundWidth, base::Value(rect.width()));
return rectangle_value;
}
base::Value::Dict ConvertSizeToValue(const gfx::Size& size) {
base::Value::Dict size_value;
size_value.Set(kSizeWidth, base::Value(size.width()));
size_value.Set(kSizeHeight, base::Value(size.height()));
return size_value;
}
// Convert ui::WindowStateType `window_state` to std::string used by the
// base::Value representation.
std::string ChromeOsWindowStateToString(
const chromeos::WindowStateType& window_state) {
switch (window_state) {
case chromeos::WindowStateType::kNormal:
return kWindowStateNormal;
case chromeos::WindowStateType::kMinimized:
return kWindowStateMinimized;
case chromeos::WindowStateType::kMaximized:
return kWindowStateMaximized;
case chromeos::WindowStateType::kFullscreen:
return kWindowStateFullscreen;
case chromeos::WindowStateType::kPrimarySnapped:
return kWindowStatePrimarySnapped;
case chromeos::WindowStateType::kSecondarySnapped:
return kWindowStateSecondarySnapped;
case chromeos::WindowStateType::kFloated:
return kWindowStateFloated;
default:
// Available states in JSON representation is a subset of all window
// states enumerated by WindowStateType. Default to normal if not
// supported.
return kWindowStateNormal;
}
}
// Convert ui::mojom::WindowShowState `state` to JSON used by the base::Value
// representation.
std::string UiWindowStateToString(
const ui::mojom::WindowShowState& window_state) {
switch (window_state) {
case ui::mojom::WindowShowState::kNormal:
return kWindowStateNormal;
case ui::mojom::WindowShowState::kMinimized:
return kWindowStateMinimized;
case ui::mojom::WindowShowState::kMaximized:
return kWindowStateMaximized;
case ui::mojom::WindowShowState::kFullscreen:
return kWindowStateFullscreen;
default:
// available states in JSON representation is a subset
// of all window states enumerated by WindowShowState.
// Default to normal if not supported.
return kWindowStateNormal;
}
}
// Returns a string WindowOpenDisposition when given a value of the
// WindowOpenDisposition passed into this function. Assumes the caller
// casts the disposition from a int32_t.
std::string WindowOpenDispositionToString(WindowOpenDisposition disposition) {
switch (disposition) {
case WindowOpenDisposition::UNKNOWN:
return kWindowOpenDispositionUnknown;
case WindowOpenDisposition::CURRENT_TAB:
return kWindowOpenDispositionCurrentTab;
case WindowOpenDisposition::SINGLETON_TAB:
return kWindowOpenDispositionSingletonTab;
case WindowOpenDisposition::NEW_FOREGROUND_TAB:
return kWindowOpenDispositionNewForegroundTab;
case WindowOpenDisposition::NEW_BACKGROUND_TAB:
return kWindowOpenDispositionNewBackgroundTab;
case WindowOpenDisposition::NEW_POPUP:
return kWindowOpenDispositionNewPopup;
case WindowOpenDisposition::NEW_WINDOW:
return kWindowOpenDispositionNewWindow;
case WindowOpenDisposition::SAVE_TO_DISK:
return kWindowOpenDispositionSaveToDisk;
case WindowOpenDisposition::SWITCH_TO_TAB:
return kWindowOpenDispositionSwitchToTab;
case WindowOpenDisposition::OFF_THE_RECORD:
return kWindowOpenDispositionOffTheRecord;
case WindowOpenDisposition::IGNORE_ACTION:
return kWindowOpenDispositionIgnoreAction;
case WindowOpenDisposition::NEW_PICTURE_IN_PICTURE:
return kWindowOpenDispositionNewPictureInPicture;
}
}
std::string LaunchContainerToString(apps::LaunchContainer launch_container) {
switch (launch_container) {
case apps::LaunchContainer::kLaunchContainerWindow:
return kLaunchContainerWindow;
case apps::LaunchContainer::kLaunchContainerPanelDeprecated:
return kLaunchContainerPanelDeprecated;
case apps::LaunchContainer::kLaunchContainerTab:
return kLaunchContainerTab;
case apps::LaunchContainer::kLaunchContainerNone:
return kLaunchContainerNone;
}
}
base::Value::List ConvertURLsToBrowserAppTabValues(
const std::vector<GURL>& urls) {
base::Value::List tab_list;
for (const auto& url : urls) {
base::Value::Dict browser_tab;
browser_tab.Set(kTabUrl, url.spec());
tab_list.Append(std::move(browser_tab));
}
return tab_list;
}
std::string GetAppTypeForJson(apps::AppRegistryCache* apps_cache,
const std::string& app_id) {
// This switch should follow the same structure as DeskSyncBridge#FillApp.
switch (apps_cache->GetAppType(app_id)) {
case apps::AppType::kWeb:
case apps::AppType::kSystemWeb:
return kAppTypeChrome;
case apps::AppType::kChromeApp:
if (app_id == app_constants::kChromeAppId) {
return kAppTypeBrowser;
} else {
return kAppTypeChrome;
}
case apps::AppType::kArc:
return kAppTypeArc;
case apps::AppType::kUnknown:
return kAppTypeUnknown;
case apps::AppType::kCrostini:
case apps::AppType::kPluginVm:
case apps::AppType::kRemote:
case apps::AppType::kBorealis:
case apps::AppType::kBruschetta:
case apps::AppType::kExtension:
// Default to unsupported. This app should not be captured.
return kAppTypeUnsupported;
}
}
base::Value ConvertWindowToDeskApp(const std::string& app_id,
const int window_id,
const app_restore::AppRestoreData* app,
apps::AppRegistryCache* apps_cache) {
std::string app_type = GetAppTypeForJson(apps_cache, app_id);
if (app_type == kAppTypeUnsupported) {
return base::Value(base::Value::Type::NONE);
}
base::Value::Dict app_data;
if (app_type != kAppTypeUnknown) {
app_data.Set(kAppType, app_type);
}
if (app->window_info.current_bounds.has_value()) {
app_data.Set(kWindowBound, ConvertWindowBoundToValue(
app->window_info.current_bounds.value()));
}
const std::optional<app_restore::WindowInfo::ArcExtraInfo>& arc_info =
app->window_info.arc_extra_info;
if (arc_info) {
if (arc_info->bounds_in_root.has_value()) {
app_data.Set(kBoundsInRoot,
ConvertWindowBoundToValue(arc_info->bounds_in_root.value()));
}
if (arc_info->minimum_size.has_value()) {
app_data.Set(kMinimumSize,
ConvertSizeToValue(arc_info->minimum_size.value()));
}
if (arc_info->maximum_size.has_value()) {
app_data.Set(kMaximumSize,
ConvertSizeToValue(arc_info->maximum_size.value()));
}
}
if (app->window_info.app_title.has_value()) {
app_data.Set(kTitle, base::UTF16ToUTF8(app->window_info.app_title.value()));
}
chromeos::WindowStateType window_state = chromeos::WindowStateType::kDefault;
if (app->window_info.window_state_type.has_value()) {
window_state = app->window_info.window_state_type.value();
app_data.Set(kWindowState, ChromeOsWindowStateToString(window_state));
}
// TODO(crbug.com/1311801): Add support for actual event_flag values.
app_data.Set(kEventFlag, 0);
if (app->window_info.activation_index.has_value()) {
app_data.Set(kZIndex, app->window_info.activation_index.value());
}
if (!app->browser_extra_info.urls.empty()) {
app_data.Set(
kTabs, ConvertURLsToBrowserAppTabValues(app->browser_extra_info.urls));
}
if (!app->browser_extra_info.tab_group_infos.empty()) {
base::Value::List tab_groups_value;
for (const auto& tab_group : app->browser_extra_info.tab_group_infos) {
tab_groups_value.Append(ConvertTabGroupInfoToDict(tab_group));
}
app_data.Set(kTabGroups, std::move(tab_groups_value));
}
if (app->browser_extra_info.active_tab_index.has_value()) {
app_data.Set(kActiveTabIndex,
app->browser_extra_info.active_tab_index.value());
}
if (app->browser_extra_info.first_non_pinned_tab_index.has_value()) {
app_data.Set(kFirstNonPinnedTabIndex,
app->browser_extra_info.first_non_pinned_tab_index.value());
}
if (app->browser_extra_info.app_type_browser.has_value()) {
app_data.Set(kIsAppTypeBrowser,
app->browser_extra_info.app_type_browser.value());
}
app_data.Set(kAppId, app_id);
app_data.Set(kWindowId, window_id);
if (app->display_id.has_value()) {
app_data.Set(kDisplayId, base::NumberToString(app->display_id.value()));
}
if (app->window_info.pre_minimized_show_state_type.has_value() &&
window_state == chromeos::WindowStateType::kMinimized) {
app_data.Set(kPreMinimizedWindowState,
UiWindowStateToString(
app->window_info.pre_minimized_show_state_type.value()));
}
if (app->window_info.snap_percentage.has_value()) {
app_data.Set(kSnapPercentage,
static_cast<int>(app->window_info.snap_percentage.value()));
}
if (app->browser_extra_info.app_name.has_value()) {
app_data.Set(kAppName, app->browser_extra_info.app_name.value());
}
if (app->disposition.has_value()) {
WindowOpenDisposition disposition =
static_cast<WindowOpenDisposition>(app->disposition.value());
app_data.Set(kWindowOpenDisposition,
WindowOpenDispositionToString(disposition));
}
if (app->container.has_value()) {
apps::LaunchContainer container =
static_cast<apps::LaunchContainer>(app->container.value());
app_data.Set(kLaunchContainer, LaunchContainerToString(container));
}
if (app->override_url.has_value()) {
app_data.Set(kOverrideUrl, app->override_url->spec());
}
return base::Value(std::move(app_data));
}
base::Value ConvertRestoreDataToValue(
const app_restore::RestoreData* restore_data,
apps::AppRegistryCache* apps_cache) {
base::Value::List desk_data;
for (const auto& app : restore_data->app_id_to_launch_list()) {
for (const auto& window : app.second) {
auto app_data = ConvertWindowToDeskApp(app.first, window.first,
window.second.get(), apps_cache);
if (app_data.is_none())
continue;
desk_data.Append(std::move(app_data));
}
}
base::Value::Dict apps;
apps.Set(kApps, std::move(desk_data));
return base::Value(std::move(apps));
}
std::string SerializeDeskTypeAsString(ash::DeskTemplateType desk_type) {
switch (desk_type) {
case ash::DeskTemplateType::kTemplate:
return kDeskTypeTemplate;
case ash::DeskTemplateType::kSaveAndRecall:
return kDeskTypeSaveAndRecall;
case ash::DeskTemplateType::kCoral:
return kDeskTypeCoral;
case ash::DeskTemplateType::kFloatingWorkspace:
return kDeskTypeFloatingWorkspace;
case ash::DeskTemplateType::kUnknown:
return kDeskTypeUnknown;
}
}
bool IsValidDeskTemplateType(const std::string& desk_template_type) {
return base::Contains(kValidDeskTypes, desk_template_type);
}
// TODO(b/258692868): Currently parse any invalid value for this field as
// SaveAndRecall. Fix by crash / signal some error instead.
ash::DeskTemplateType GetDeskTypeFromString(const std::string& desk_type) {
DCHECK(IsValidDeskTemplateType(desk_type));
if (desk_type == kDeskTypeTemplate) {
return ash::DeskTemplateType::kTemplate;
}
if (desk_type == kDeskTypeFloatingWorkspace) {
return ash::DeskTemplateType::kFloatingWorkspace;
}
if (desk_type == kDeskTypeSaveAndRecall) {
return ash::DeskTemplateType::kSaveAndRecall;
}
if (desk_type == kDeskTypeCoral) {
return ash::DeskTemplateType::kCoral;
}
return ash::DeskTemplateType::kUnknown;
}
// Convert from apps::LaunchContainer to sync proto LaunchContainer.
// Assumes caller has cast `container` from int32_t to
// apps::LaunchContainer
SyncLaunchContainer FromLaunchContainer(apps::LaunchContainer container) {
switch (container) {
case apps::LaunchContainer::kLaunchContainerWindow:
return sync_pb::
WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_WINDOW;
case apps::LaunchContainer::kLaunchContainerPanelDeprecated:
return sync_pb::
WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_PANEL_DEPRECATED;
case apps::LaunchContainer::kLaunchContainerTab:
return sync_pb::
WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_TAB;
case apps::LaunchContainer::kLaunchContainerNone:
return sync_pb::
WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_NONE;
}
}
// Convert from sync proto LaunchContainer to apps::LaunchContainer.
// Assumes caller has cast `container` from int32_t to
// apps::LaunchContainer
apps::LaunchContainer ToLaunchContainer(SyncLaunchContainer container) {
switch (container) {
case sync_pb::
WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_UNSPECIFIED:
return apps::LaunchContainer::kLaunchContainerWindow;
case sync_pb::
WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_WINDOW:
return apps::LaunchContainer::kLaunchContainerWindow;
case sync_pb::
WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_PANEL_DEPRECATED:
return apps::LaunchContainer::kLaunchContainerPanelDeprecated;
case sync_pb::WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_TAB:
return apps::LaunchContainer::kLaunchContainerTab;
case sync_pb::WorkspaceDeskSpecifics_LaunchContainer_LAUNCH_CONTAINER_NONE:
return apps::LaunchContainer::kLaunchContainerNone;
}
}
// Convert sync proto WindowOpenDisposition to base's WindowOpenDisposition.
// This value is cast to int32_t by the caller to be assigned to the
// `disposition` field in AppRestoreData.
WindowOpenDisposition ToBaseWindowOpenDisposition(
SyncWindowOpenDisposition disposition) {
switch (disposition) {
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_UNKNOWN:
return WindowOpenDisposition::UNKNOWN;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_CURRENT_TAB:
return WindowOpenDisposition::CURRENT_TAB;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_SINGLETON_TAB:
return WindowOpenDisposition::SINGLETON_TAB;
case sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_FOREGROUND_TAB:
return WindowOpenDisposition::NEW_FOREGROUND_TAB;
case sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_BACKGROUND_TAB:
return WindowOpenDisposition::NEW_BACKGROUND_TAB;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_POPUP:
return WindowOpenDisposition::NEW_POPUP;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_WINDOW:
return WindowOpenDisposition::NEW_WINDOW;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_SAVE_TO_DISK:
return WindowOpenDisposition::SAVE_TO_DISK;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_OFF_THE_RECORD:
return WindowOpenDisposition::OFF_THE_RECORD;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_IGNORE_ACTION:
return WindowOpenDisposition::IGNORE_ACTION;
case sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_SWITCH_TO_TAB:
return WindowOpenDisposition::SWITCH_TO_TAB;
case sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_PICTURE_IN_PICTURE:
return WindowOpenDisposition::NEW_PICTURE_IN_PICTURE;
}
}
// Fill `out_gurls` using tabs' URL in `browser_app_window`.
void FillUrlList(const BrowserAppWindow& browser_app_window,
std::vector<GURL>* out_gurls) {
for (auto tab : browser_app_window.tabs()) {
if (tab.has_url())
out_gurls->emplace_back(tab.url());
}
}
// Since tab groups must have completely valid fields therefore this function
// exists to validate that sync tab groups are entirely valid.
bool ValidSyncTabGroup(const SyncTabGroup& sync_tab_group) {
return sync_tab_group.has_first_index() && sync_tab_group.has_last_index() &&
sync_tab_group.has_title() && sync_tab_group.has_color();
}
// Converts a sync tab group color to its tab_groups::TabGroupColorId
// equivalent.
TabGroupColor TabGroupColorIdFromSyncTabColor(
const SyncTabGroupColor& sync_color) {
switch (sync_color) {
// Default to grey if unknown.
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_UNKNOWN_COLOR:
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_GREY:
return TabGroupColor::kGrey;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_BLUE:
return TabGroupColor::kBlue;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_RED:
return TabGroupColor::kRed;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_YELLOW:
return TabGroupColor::kYellow;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_GREEN:
return TabGroupColor::kGreen;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_PINK:
return TabGroupColor::kPink;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_PURPLE:
return TabGroupColor::kPurple;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_CYAN:
return TabGroupColor::kCyan;
case SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_ORANGE:
return TabGroupColor::kOrange;
};
}
// Instantiates a TabGroup from its sync equivalent.
tab_groups::TabGroupInfo FillTabGroupInfoFromProto(
const SyncTabGroup& sync_tab_group) {
// This function should never be called with a partially instantiated
// tab group.
DCHECK(ValidSyncTabGroup(sync_tab_group));
return tab_groups::TabGroupInfo(
{static_cast<uint32_t>(sync_tab_group.first_index()),
static_cast<uint32_t>(sync_tab_group.last_index())},
tab_groups::TabGroupVisualData(
base::UTF8ToUTF16(sync_tab_group.title()),
TabGroupColorIdFromSyncTabColor(sync_tab_group.color()),
sync_tab_group.is_collapsed()));
}
// Fill `out_group_infos` using information found in the proto's
// tab group structure.
void FillTabGroupInfosFromProto(
const BrowserAppWindow& browser_app_window,
std::vector<tab_groups::TabGroupInfo>* out_group_infos) {
for (const auto& group : browser_app_window.tab_groups()) {
if (!ValidSyncTabGroup(group)) {
continue;
}
out_group_infos->push_back(FillTabGroupInfoFromProto(group));
}
}
// Get App ID from App proto.
std::string GetAppId(const sync_pb::WorkspaceDeskSpecifics_App& app) {
switch (app.app().app_case()) {
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::APP_NOT_SET:
// Return an empty string to indicate this app is unsupported.
return std::string();
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kBrowserAppWindow: {
// Browser app has a known app ID.
return std::string(app_constants::kChromeAppId);
}
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kChromeApp:
return app.app().chrome_app().app_id();
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kProgressWebApp:
return app.app().progress_web_app().app_id();
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kArcApp:
return app.app().arc_app().app_id();
}
}
// Convert App proto to `app_restore::AppLaunchInfo`.
std::unique_ptr<app_restore::AppLaunchInfo> ConvertToAppLaunchInfo(
const sync_pb::WorkspaceDeskSpecifics_App& app) {
const std::string app_id = GetAppId(app);
if (app_id.empty())
return nullptr;
auto app_launch_info =
std::make_unique<app_restore::AppLaunchInfo>(app_id, app.window_id());
if (app.has_display_id())
app_launch_info->display_id = app.display_id();
if (app.has_container()) {
app_launch_info->container =
static_cast<int32_t>(ToLaunchContainer(app.container()));
}
if (app.has_disposition()) {
app_launch_info->disposition =
static_cast<int32_t>(ToBaseWindowOpenDisposition(app.disposition()));
}
if (app.has_app_name()) {
app_launch_info->browser_extra_info.app_name = app.app_name();
}
if (app.has_override_url()) {
app_launch_info->override_url = GURL(app.override_url());
}
// This is a short-term fix as `event_flag` is required to launch ArcApp.
// Currently we don't support persisting user action in template
// so always default to 0 which is no action.
// https://source.chromium.org/chromium/chromium/src/
// +/main:ui/base/window_open_disposition.cc;l=34
//
// TODO(crbug.com/1311801): Add support for actual event_flag values.
app_launch_info->event_flag = 0;
switch (app.app().app_case()) {
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::APP_NOT_SET:
// This should never happen. `APP_NOT_SET` corresponds to empty `app_id`.
// This method will early return when `app_id` is empty.
NOTREACHED();
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kBrowserAppWindow:
if (app.app().browser_app_window().has_active_tab_index()) {
app_launch_info->browser_extra_info.active_tab_index =
app.app().browser_app_window().active_tab_index();
}
FillUrlList(app.app().browser_app_window(),
&app_launch_info->browser_extra_info.urls);
if (app.app().browser_app_window().tab_groups_size() > 0) {
FillTabGroupInfosFromProto(
app.app().browser_app_window(),
&app_launch_info->browser_extra_info.tab_group_infos);
}
if (app.app().browser_app_window().has_show_as_app()) {
app_launch_info->browser_extra_info.app_type_browser =
app.app().browser_app_window().show_as_app();
}
if (app.app().browser_app_window().has_first_non_pinned_tab_index()) {
app_launch_info->browser_extra_info.first_non_pinned_tab_index =
app.app().browser_app_window().first_non_pinned_tab_index();
}
break;
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kChromeApp:
// `app_id` is enough to identify a Chrome app.
break;
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kProgressWebApp:
// `app_id` is enough to identify a Progressive Web app.
break;
case sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kArcApp:
// `app_id` is enough to identify an Arc app.
break;
}
return app_launch_info;
}
// Convert sync proto WindowOpenDisposition to base's WindowOpenDisposition.
// This value is cast to int32_t by the caller to be assigned to the
// `disposition` field in AppRestoreData.
SyncWindowOpenDisposition FromBaseWindowOpenDisposition(
WindowOpenDisposition disposition) {
switch (disposition) {
case WindowOpenDisposition::UNKNOWN:
return sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_UNKNOWN;
case WindowOpenDisposition::CURRENT_TAB:
return sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_CURRENT_TAB;
case WindowOpenDisposition::SINGLETON_TAB:
return sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_SINGLETON_TAB;
case WindowOpenDisposition::NEW_FOREGROUND_TAB:
return sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_FOREGROUND_TAB;
case WindowOpenDisposition::NEW_BACKGROUND_TAB:
return sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_BACKGROUND_TAB;
case WindowOpenDisposition::NEW_POPUP:
return sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_POPUP;
case WindowOpenDisposition::NEW_WINDOW:
return sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_WINDOW;
case WindowOpenDisposition::SAVE_TO_DISK:
return sync_pb::WorkspaceDeskSpecifics_WindowOpenDisposition_SAVE_TO_DISK;
case WindowOpenDisposition::OFF_THE_RECORD:
return sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_OFF_THE_RECORD;
case WindowOpenDisposition::IGNORE_ACTION:
return sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_IGNORE_ACTION;
case WindowOpenDisposition::SWITCH_TO_TAB:
return sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_SWITCH_TO_TAB;
case WindowOpenDisposition::NEW_PICTURE_IN_PICTURE:
return sync_pb::
WorkspaceDeskSpecifics_WindowOpenDisposition_NEW_PICTURE_IN_PICTURE;
}
}
// Convert Sync proto WindowState `state` to ui::mojom::WindowShowState used by
// the app_restore::WindowInfo struct.
ui::mojom::WindowShowState ToUiWindowState(WindowState state) {
switch (state) {
case WindowState::WorkspaceDeskSpecifics_WindowState_UNKNOWN_WINDOW_STATE:
return ui::mojom::WindowShowState::kNormal;
case WindowState::WorkspaceDeskSpecifics_WindowState_NORMAL:
return ui::mojom::WindowShowState::kNormal;
case WindowState::WorkspaceDeskSpecifics_WindowState_MINIMIZED:
return ui::mojom::WindowShowState::kMinimized;
case WindowState::WorkspaceDeskSpecifics_WindowState_MAXIMIZED:
return ui::mojom::WindowShowState::kMaximized;
case WindowState::WorkspaceDeskSpecifics_WindowState_FULLSCREEN:
return ui::mojom::WindowShowState::kFullscreen;
case WindowState::WorkspaceDeskSpecifics_WindowState_PRIMARY_SNAPPED:
return ui::mojom::WindowShowState::kNormal;
case WindowState::WorkspaceDeskSpecifics_WindowState_SECONDARY_SNAPPED:
return ui::mojom::WindowShowState::kNormal;
case WindowState::WorkspaceDeskSpecifics_WindowState_FLOATED:
return ui::mojom::WindowShowState::kNormal;
}
}
// Convert Sync proto WindowState `state` to chromeos::WindowStateType used
// by the app_restore::WindowInfo struct.
chromeos::WindowStateType ToChromeOsWindowState(WindowState state) {
switch (state) {
case WindowState::WorkspaceDeskSpecifics_WindowState_UNKNOWN_WINDOW_STATE:
return chromeos::WindowStateType::kNormal;
case WindowState::WorkspaceDeskSpecifics_WindowState_NORMAL:
return chromeos::WindowStateType::kNormal;
case WindowState::WorkspaceDeskSpecifics_WindowState_MINIMIZED:
return chromeos::WindowStateType::kMinimized;
case WindowState::WorkspaceDeskSpecifics_WindowState_MAXIMIZED:
return chromeos::WindowStateType::kMaximized;
case WindowState::WorkspaceDeskSpecifics_WindowState_FULLSCREEN:
return chromeos::WindowStateType::kFullscreen;
case WindowState::WorkspaceDeskSpecifics_WindowState_PRIMARY_SNAPPED:
return chromeos::WindowStateType::kPrimarySnapped;
case WindowState::WorkspaceDeskSpecifics_WindowState_SECONDARY_SNAPPED:
return chromeos::WindowStateType::kSecondarySnapped;
case WindowState::WorkspaceDeskSpecifics_WindowState_FLOATED:
return chromeos::WindowStateType::kFloated;
}
}
// Convert chromeos::WindowStateType to Sync proto WindowState.
WindowState FromChromeOsWindowState(chromeos::WindowStateType state) {
switch (state) {
case chromeos::WindowStateType::kDefault:
case chromeos::WindowStateType::kNormal:
case chromeos::WindowStateType::kInactive:
case chromeos::WindowStateType::kPinned:
case chromeos::WindowStateType::kTrustedPinned:
case chromeos::WindowStateType::kPip:
// TODO(crbug.com/1331825): Float state support for desk template.
return WindowState::WorkspaceDeskSpecifics_WindowState_NORMAL;
case chromeos::WindowStateType::kMinimized:
return WindowState::WorkspaceDeskSpecifics_WindowState_MINIMIZED;
case chromeos::WindowStateType::kMaximized:
return WindowState::WorkspaceDeskSpecifics_WindowState_MAXIMIZED;
case chromeos::WindowStateType::kFullscreen:
return WindowState::WorkspaceDeskSpecifics_WindowState_FULLSCREEN;
case chromeos::WindowStateType::kPrimarySnapped:
return WindowState::WorkspaceDeskSpecifics_WindowState_PRIMARY_SNAPPED;
case chromeos::WindowStateType::kSecondarySnapped:
return WindowState::WorkspaceDeskSpecifics_WindowState_SECONDARY_SNAPPED;
case chromeos::WindowStateType::kFloated:
return WindowState::WorkspaceDeskSpecifics_WindowState_FLOATED;
}
}
// Convert ui::mojom::WindowShowState to Sync proto WindowState.
WindowState FromUiWindowState(ui::mojom::WindowShowState state) {
switch (state) {
case ui::mojom::WindowShowState::kDefault:
case ui::mojom::WindowShowState::kNormal:
case ui::mojom::WindowShowState::kInactive:
case ui::mojom::WindowShowState::kEnd:
return WindowState::WorkspaceDeskSpecifics_WindowState_NORMAL;
case ui::mojom::WindowShowState::kMinimized:
return WindowState::WorkspaceDeskSpecifics_WindowState_MINIMIZED;
case ui::mojom::WindowShowState::kMaximized:
return WindowState::WorkspaceDeskSpecifics_WindowState_MAXIMIZED;
case ui::mojom::WindowShowState::kFullscreen:
return WindowState::WorkspaceDeskSpecifics_WindowState_FULLSCREEN;
}
}
// Converts a sync tab group color to its tab_groups::TabGroupColorId
// equivalent.
SyncTabGroupColor SyncTabColorFromTabGroupColorId(
const TabGroupColor& sync_color) {
switch (sync_color) {
case TabGroupColor::kGrey:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_GREY;
case TabGroupColor::kBlue:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_BLUE;
case TabGroupColor::kRed:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_RED;
case TabGroupColor::kYellow:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_YELLOW;
case TabGroupColor::kGreen:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_GREEN;
case TabGroupColor::kPink:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_PINK;
case TabGroupColor::kPurple:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_PURPLE;
case TabGroupColor::kCyan:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_CYAN;
case TabGroupColor::kOrange:
return SyncTabGroupColor::WorkspaceDeskSpecifics_TabGroupColor_ORANGE;
case TabGroupColor::kNumEntries:
NOTREACHED() << "kNumEntries is not a supported color enum.";
};
}
void FillSyncTabGroupInfo(const tab_groups::TabGroupInfo& tab_group_info,
SyncTabGroup* out_sync_tab_group) {
out_sync_tab_group->set_first_index(tab_group_info.tab_range.start());
out_sync_tab_group->set_last_index(tab_group_info.tab_range.end());
out_sync_tab_group->set_title(
base::UTF16ToUTF8(tab_group_info.visual_data.title()));
// Save some storage space by leaving is_collapsed to default value if the
// tab group isn't collapsed.
if (tab_group_info.visual_data.is_collapsed()) {
out_sync_tab_group->set_is_collapsed(
tab_group_info.visual_data.is_collapsed());
}
out_sync_tab_group->set_color(
SyncTabColorFromTabGroupColorId(tab_group_info.visual_data.color()));
}
void FillBrowserAppTabGroupInfos(
const std::vector<tab_groups::TabGroupInfo>& tab_group_infos,
BrowserAppWindow* out_browser_app_window) {
for (const auto& tab_group : tab_group_infos) {
SyncTabGroup* sync_tab_group = out_browser_app_window->add_tab_groups();
FillSyncTabGroupInfo(tab_group, sync_tab_group);
}
}
// Fill `out_browser_app_window` with the given GURLs as BrowserAppTabs.
void FillBrowserAppTabs(const std::vector<GURL>& gurls,
BrowserAppWindow* out_browser_app_window) {
for (const auto& gurl : gurls) {
const std::string& url = gurl.spec();
if (url.empty()) {
// Skip invalid URLs.
continue;
}
BrowserAppTab* browser_app_tab = out_browser_app_window->add_tabs();
browser_app_tab->set_url(url);
}
}
// Fill `out_browser_app_window` with urls and tab information from
// `app_restore_data`.
void FillBrowserAppWindow(const app_restore::AppRestoreData* app_restore_data,
BrowserAppWindow* out_browser_app_window) {
const app_restore::BrowserExtraInfo browser_extra_info =
app_restore_data->browser_extra_info;
if (!browser_extra_info.urls.empty()) {
FillBrowserAppTabs(browser_extra_info.urls, out_browser_app_window);
}
if (browser_extra_info.active_tab_index.has_value()) {
out_browser_app_window->set_active_tab_index(
browser_extra_info.active_tab_index.value());
}
if (browser_extra_info.app_type_browser.has_value()) {
out_browser_app_window->set_show_as_app(
browser_extra_info.app_type_browser.value());
}
if (!browser_extra_info.tab_group_infos.empty()) {
FillBrowserAppTabGroupInfos(browser_extra_info.tab_group_infos,
out_browser_app_window);
}
if (browser_extra_info.first_non_pinned_tab_index.has_value()) {
out_browser_app_window->set_first_non_pinned_tab_index(
browser_extra_info.first_non_pinned_tab_index.value());
}
}
// Fill `out_window_bounds` with information from `bounds`.
void FillWindowBound(const gfx::Rect& bounds, WindowBound* out_window_bounds) {
out_window_bounds->set_left(bounds.x());
out_window_bounds->set_top(bounds.y());
out_window_bounds->set_width(bounds.width());
out_window_bounds->set_height(bounds.height());
}
// Fill `out_app` with information from `window_info`.
void FillAppWithWindowInfo(const app_restore::WindowInfo* window_info,
WorkspaceDeskSpecifics_App* out_app) {
if (window_info->activation_index.has_value())
out_app->set_z_index(window_info->activation_index.value());
if (window_info->current_bounds.has_value()) {
FillWindowBound(window_info->current_bounds.value(),
out_app->mutable_window_bound());
}
if (window_info->window_state_type.has_value()) {
out_app->set_window_state(
FromChromeOsWindowState(window_info->window_state_type.value()));
}
if (window_info->pre_minimized_show_state_type.has_value()) {
out_app->set_pre_minimized_window_state(
FromUiWindowState(window_info->pre_minimized_show_state_type.value()));
}
if (window_info->snap_percentage.has_value())
out_app->set_snap_percentage(window_info->snap_percentage.value());
if (window_info->app_title.has_value())
out_app->set_title(base::UTF16ToUTF8(window_info->app_title.value()));
// AppRestoreData.GetWindowInfo does not include `display_id` in the returned
// WindowInfo. Therefore, we are not filling `display_id` here.
}
// Fill `out_app` with the `display_id` from `app_restore_data`.
void FillAppWithDisplayId(const app_restore::AppRestoreData* app_restore_data,
WorkspaceDeskSpecifics_App* out_app) {
if (app_restore_data->display_id.has_value())
out_app->set_display_id(app_restore_data->display_id.value());
}
// Fill `out_app` with `container` from `app_restore_data`.
void FillAppWithLaunchContainer(
const app_restore::AppRestoreData* app_restore_data,
WorkspaceDeskSpecifics_App* out_app) {
if (app_restore_data->container.has_value()) {
out_app->set_container(
FromLaunchContainer(static_cast<apps::LaunchContainer>(
app_restore_data->container.value())));
}
}
// Fill `out_app` with `disposition` from `app_restore_data`.
void FillAppWithWindowOpenDisposition(
const app_restore::AppRestoreData* app_restore_data,
WorkspaceDeskSpecifics_App* out_app) {
if (app_restore_data->disposition.has_value()) {
out_app->set_disposition(
FromBaseWindowOpenDisposition(static_cast<WindowOpenDisposition>(
app_restore_data->disposition.value())));
}
}
// Fills `out_app` with `app_name` and `title` from `app_restore_data`.
void FillAppWithAppNameAndTitle(
const app_restore::AppRestoreData* app_restore_data,
WorkspaceDeskSpecifics_App* out_app) {
const std::string app_name =
app_restore_data->browser_extra_info.app_name.value_or("");
if (!app_name.empty()) {
out_app->set_app_name(app_name);
}
if (app_restore_data->window_info.app_title.has_value() &&
!app_restore_data->window_info.app_title->empty()) {
out_app->set_title(
base::UTF16ToUTF8(*app_restore_data->window_info.app_title));
}
}
void FillAppWithAppOverrideUrl(
const app_restore::AppRestoreData* app_restore_data,
WorkspaceDeskSpecifics_App* out_app) {
if (app_restore_data->override_url.has_value()) {
out_app->set_override_url(app_restore_data->override_url->spec());
}
}
void FillArcAppSize(const gfx::Size& size, ArcAppWindowSize* out_window_size) {
out_window_size->set_width(size.width());
out_window_size->set_height(size.height());
}
void FillArcBoundsInRoot(const gfx::Rect& data_rect, WindowBound* out_rect) {
out_rect->set_left(data_rect.x());
out_rect->set_top(data_rect.y());
out_rect->set_width(data_rect.width());
out_rect->set_height(data_rect.height());
}
void FillArcApp(const app_restore::AppRestoreData* app_restore_data,
ArcApp* out_app) {
const std::optional<app_restore::WindowInfo::ArcExtraInfo>& arc_info =
app_restore_data->window_info.arc_extra_info;
if (!arc_info) {
return;
}
if (arc_info->minimum_size.has_value()) {
FillArcAppSize(arc_info->minimum_size.value(),
out_app->mutable_minimum_size());
}
if (arc_info->maximum_size.has_value()) {
FillArcAppSize(arc_info->maximum_size.value(),
out_app->mutable_maximum_size());
}
if (arc_info->bounds_in_root.has_value()) {
FillArcBoundsInRoot(arc_info->bounds_in_root.value(),
out_app->mutable_bounds_in_root());
}
}
// Fills an app with container and open disposition. This is only done in the
// specific cases of Chrome Apps and PWAs.
void FillAppWithLaunchContainerAndOpenDisposition(
const app_restore::AppRestoreData* app_restore_data,
WorkspaceDeskSpecifics_App* out_app) {
// If present, fills the proto's `container` field with the information stored
// in the `app_restore_data`'s `container` field.
FillAppWithLaunchContainer(app_restore_data, out_app);
// If present, fills the proto's `disposition` field with the information
// stored in the `app_restore_data`'s `disposition` field.
FillAppWithWindowOpenDisposition(app_restore_data, out_app);
}
// Fill `out_app` with `app_restore_data`.
// Return `false` if app type is unsupported.
bool FillApp(const std::string& app_id,
const apps::AppType app_type,
const app_restore::AppRestoreData* app_restore_data,
WorkspaceDeskSpecifics_App* out_app) {
// See definition in components/services/app_service/public/cpp/app_types.h
switch (app_type) {
case apps::AppType::kWeb:
case apps::AppType::kSystemWeb: {
// System Web Apps.
// Even though, kSystemWeb was returned for System Web Apps in
// Lacros-primary configuration and while SWA's are mostly deprecated, a
// few internal apps like Settings are still implemented as SWA's. These
// can be persisted and launched the same way as Chrome Apps.
ChromeApp* chrome_app_window =
out_app->mutable_app()->mutable_chrome_app();
chrome_app_window->set_app_id(app_id);
FillAppWithLaunchContainerAndOpenDisposition(app_restore_data, out_app);
break;
}
case apps::AppType::kChromeApp: {
// Ash Chrome browser OR PWA OR Chrome App hosted in Ash Chrome.
if (app_constants::kChromeAppId == app_id) {
// This window is either a browser window or a PWA window.
// Both cases are persisted as "browser app" since they are launched the
// same way. PWA window will have field `app_name` and
// `app_type_browser` fields set. FillAppWithAppNameAndTitle has
// persisted `app_name` field. FillBrowserAppWindow will persist
// `app_type_browser` field.
BrowserAppWindow* browser_app_window =
out_app->mutable_app()->mutable_browser_app_window();
FillBrowserAppWindow(app_restore_data, browser_app_window);
} else {
// Chrome App
ChromeApp* chrome_app_window =
out_app->mutable_app()->mutable_chrome_app();
chrome_app_window->set_app_id(app_id);
FillAppWithLaunchContainerAndOpenDisposition(app_restore_data, out_app);
}
break;
}
case apps::AppType::kArc: {
ArcApp* arc_app = out_app->mutable_app()->mutable_arc_app();
arc_app->set_app_id(app_id);
FillArcApp(app_restore_data, arc_app);
break;
}
case apps::AppType::kCrostini:
case apps::AppType::kPluginVm:
case apps::AppType::kUnknown:
case apps::AppType::kRemote:
case apps::AppType::kBorealis:
case apps::AppType::kBruschetta:
case apps::AppType::kExtension:
// Unsupported app types will be ignored.
return false;
}
FillAppWithWindowInfo(app_restore_data->GetWindowInfo().get(), out_app);
// AppRestoreData.GetWindowInfo does not include `display_id` in the returned
// WindowInfo. We need to fill the `display_id` from AppRestoreData.
FillAppWithDisplayId(app_restore_data, out_app);
// If present, fills the proto's `app_name` and `title` fields with the
// information stored in the `app_restore_data`'s `app_name` and `title`
// fields.
FillAppWithAppNameAndTitle(app_restore_data, out_app);
// If present, fills the proto's `override_url` field with the information
// from `app_restore_data`.
FillAppWithAppOverrideUrl(app_restore_data, out_app);
return true;
}
void FillArcExtraInfoFromProto(const ArcApp& app,
app_restore::WindowInfo* out_window_info) {
out_window_info->arc_extra_info.emplace();
app_restore::WindowInfo::ArcExtraInfo& arc_info =
out_window_info->arc_extra_info.value();
if (app.has_minimum_size()) {
arc_info.minimum_size.emplace(app.minimum_size().width(),
app.minimum_size().height());
}
if (app.has_maximum_size()) {
arc_info.maximum_size.emplace(app.maximum_size().width(),
app.maximum_size().height());
}
if (app.has_bounds_in_root()) {
arc_info.bounds_in_root.emplace(
app.bounds_in_root().left(), app.bounds_in_root().top(),
app.bounds_in_root().width(), app.bounds_in_root().height());
}
}
// Fill `out_window_info` with information from Sync proto `app`.
void FillWindowInfoFromProto(sync_pb::WorkspaceDeskSpecifics_App& app,
app_restore::WindowInfo* out_window_info) {
if (app.has_window_state() &&
sync_pb::WorkspaceDeskSpecifics_WindowState_IsValid(app.window_state())) {
out_window_info->window_state_type.emplace(
ToChromeOsWindowState(app.window_state()));
}
if (app.has_window_bound()) {
out_window_info->current_bounds.emplace(
app.window_bound().left(), app.window_bound().top(),
app.window_bound().width(), app.window_bound().height());
}
if (app.has_z_index())
out_window_info->activation_index.emplace(app.z_index());
if (app.has_display_id())
out_window_info->display_id.emplace(app.display_id());
if (app.has_pre_minimized_window_state() &&
app.window_state() ==
sync_pb::WorkspaceDeskSpecifics_WindowState_MINIMIZED) {
out_window_info->pre_minimized_show_state_type.emplace(
ToUiWindowState(app.pre_minimized_window_state()));
}
if (app.has_snap_percentage() &&
(app.window_state() ==
sync_pb::WorkspaceDeskSpecifics_WindowState_PRIMARY_SNAPPED ||
app.window_state() ==
sync_pb::WorkspaceDeskSpecifics_WindowState_SECONDARY_SNAPPED)) {
out_window_info->snap_percentage.emplace(app.snap_percentage());
}
if (app.has_title())
out_window_info->app_title.emplace(base::UTF8ToUTF16(app.title()));
if (app.app().app_case() ==
sync_pb::WorkspaceDeskSpecifics_AppOneOf::AppCase::kArcApp) {
FillArcExtraInfoFromProto(app.app().arc_app(), out_window_info);
}
}
// Convert a desk template to `app_restore::RestoreData`.
std::unique_ptr<app_restore::RestoreData> ConvertToRestoreData(
const sync_pb::WorkspaceDeskSpecifics& entry_proto) {
auto restore_data = std::make_unique<app_restore::RestoreData>();
for (auto app_proto : entry_proto.desk().apps()) {
std::unique_ptr<app_restore::AppLaunchInfo> app_launch_info =
ConvertToAppLaunchInfo(app_proto);
if (!app_launch_info) {
// Skip unsupported app.
continue;
}
const std::string app_id = app_launch_info->app_id;
restore_data->AddAppLaunchInfo(std::move(app_launch_info));
app_restore::WindowInfo app_window_info;
FillWindowInfoFromProto(app_proto, &app_window_info);
restore_data->ModifyWindowInfo(app_id, app_proto.window_id(),
app_window_info);
}
return restore_data;
}
// Fill a desk template `out_entry_proto` with information from
// `restore_data`.
void FillWorkspaceDeskSpecifics(
apps::AppRegistryCache* apps_cache,
const app_restore::RestoreData* restore_data,
sync_pb::WorkspaceDeskSpecifics* out_entry_proto) {
DCHECK(apps_cache);
for (auto const& app_id_to_launch_list :
restore_data->app_id_to_launch_list()) {
const std::string app_id = app_id_to_launch_list.first;
for (auto const& window_id_to_launch_info : app_id_to_launch_list.second) {
const int window_id = window_id_to_launch_info.first;
const app_restore::AppRestoreData* app_restore_data =
window_id_to_launch_info.second.get();
const auto app_type = apps_cache->GetAppType(app_id);
WorkspaceDeskSpecifics_App* app =
out_entry_proto->mutable_desk()->add_apps();
app->set_window_id(window_id);
if (!FillApp(app_id, app_type, app_restore_data, app)) {
// Unsupported app type, remove this app entry.
out_entry_proto->mutable_desk()->mutable_apps()->RemoveLast();
}
}
}
}
// Fill a desk template `out_entry_proto` with the type of desk based on the
// desk's type field.
void FillDeskType(const DeskTemplate* desk_template,
sync_pb::WorkspaceDeskSpecifics* out_entry_proto) {
switch (desk_template->type()) {
case DeskTemplateType::kTemplate:
out_entry_proto->set_desk_type(
SyncDeskType::WorkspaceDeskSpecifics_DeskType_TEMPLATE);
return;
case DeskTemplateType::kSaveAndRecall:
out_entry_proto->set_desk_type(
SyncDeskType::WorkspaceDeskSpecifics_DeskType_SAVE_AND_RECALL);
return;
case DeskTemplateType::kFloatingWorkspace:
out_entry_proto->set_desk_type(
SyncDeskType::WorkspaceDeskSpecifics_DeskType_FLOATING_WORKSPACE);
return;
// Do nothing if type is unknown.
case DeskTemplateType::kCoral:
case DeskTemplateType::kUnknown:
return;
}
}
// Takes in the Proto enum for a desk type `proto_type` and returns it's
// DeskTemplateType equivalent.
DeskTemplateType GetDeskTemplateTypeFromProtoType(
const SyncDeskType& proto_type) {
switch (proto_type) {
// Treat unknown desk types as templates.
case SyncDeskType::WorkspaceDeskSpecifics_DeskType_UNKNOWN_TYPE:
return DeskTemplateType::kUnknown;
case SyncDeskType::WorkspaceDeskSpecifics_DeskType_TEMPLATE:
return DeskTemplateType::kTemplate;
case SyncDeskType::WorkspaceDeskSpecifics_DeskType_SAVE_AND_RECALL:
return DeskTemplateType::kSaveAndRecall;
case SyncDeskType::WorkspaceDeskSpecifics_DeskType_FLOATING_WORKSPACE:
return DeskTemplateType::kFloatingWorkspace;
}
}
// Fill a desk template `out_entry_proto` with the Coral tab and app entities.
void FillCoralTabAppEntities(const DeskTemplate& desk_template,
sync_pb::WorkspaceDeskSpecifics* out_entry_proto) {
for (const auto& entity : desk_template.coral_tab_app_entities()) {
if (entity->is_tab()) {
const auto& tab = entity->get_tab();
auto* tab_proto =
out_entry_proto->mutable_coral_tab_app_entities()->add_tab_entities();
tab_proto->set_tab_title(tab->title);
tab_proto->set_tab_url(tab->url.possibly_invalid_spec());
} else if (entity->is_app()) {
const auto& app = entity->get_app();
auto* app_proto =
out_entry_proto->mutable_coral_tab_app_entities()->add_app_entities();
app_proto->set_app_name(app->title);
app_proto->set_app_id(app->id);
}
}
}
std::vector<coral::mojom::EntityPtr> GetCoralTabAppEntitiesFromProto(
const sync_pb::WorkspaceDeskSpecifics& entry_proto) {
std::vector<coral::mojom::EntityPtr> tab_app_entities;
for (const auto& tab_proto :
entry_proto.coral_tab_app_entities().tab_entities()) {
tab_app_entities.emplace_back(
coral::mojom::Entity::NewTab(coral::mojom::Tab::New(
tab_proto.tab_title(), GURL(tab_proto.tab_url()))));
}
for (const auto& app_proto :
entry_proto.coral_tab_app_entities().app_entities()) {
tab_app_entities.emplace_back(coral::mojom::Entity::NewApp(
coral::mojom::App::New(app_proto.app_name(), app_proto.app_id())));
}
return tab_app_entities;
}
// Corrects the admin template browser format so that subsequent serialization
// code stores browsers correctly.
void CorrectAdminTemplateBrowserFormat(base::Value& app) {
if (!app.is_dict()) {
return;
}
auto& app_dict = app.GetDict();
base::Value::List* tabs = app_dict.FindList(kTabsAdminFormat);
if (tabs == nullptr) {
return;
}
app_dict.Set(kTabs, tabs->Clone());
}
// Corrects the admin template format for app types. Modifies the reference
// passed.
void CorrectAdminTemplateAppTypeFormat(base::Value& app) {
if (!app.is_dict()) {
return;
}
auto& app_dict = app.GetDict();
std::string app_type;
if (!GetString(app_dict, kAppType, &app_type)) {
return;
}
// In the future all these types will be supported so we include them here
// to exhaust the possible enum types that can be given to us. However
// app types that are not browser will not be supported in the current version
// of admin templates so return unsupported for everything other than
// browsers.
if (app_type == kAppTypeBrowserAdminFormat) {
app_dict.Set(kAppType, kAppTypeBrowser);
CorrectAdminTemplateBrowserFormat(app);
} else if (app_type == kAppTypeArcAdminFormat) {
app_dict.Set(kAppType, kAppTypeUnsupported);
} else if (app_type == kAppTypeChromeAdminFormat) {
app_dict.Set(kAppType, kAppTypeUnsupported);
} else if (app_type == kAppTypeProgressiveWebAdminFormat) {
app_dict.Set(kAppType, kAppTypeUnsupported);
} else if (app_type == kAppTypeIsolatedWebAppAdminFormat) {
app_dict.Set(kAppType, kAppTypeUnsupported);
} else {
app_dict.Set(kAppType, kAppTypeUnsupported);
}
}
// Modifies the strings in the desk's apps such that they match the format
// defined by this file. This does not verify the format, that is handled
// by `ConvertJsonToRestoreData`. The value is copied and returned corrected.
// If the admin format itself is corrupted return the clone, it will be
// discarded by the parsing code.
base::Value::Dict CorrectAdminTemplateFormat(const base::Value::Dict* desk) {
auto desk_clone = desk->Clone();
base::Value::List* apps = desk_clone.FindList(kApps);
if (apps == nullptr) {
return desk_clone;
}
if (apps) {
for (auto& app : *apps) {
CorrectAdminTemplateAppTypeFormat(app);
}
}
return desk_clone;
}
std::unique_ptr<ash::DeskTemplate> ParseAdminTemplate(
const base::Value& admin_template) {
if (!admin_template.is_dict()) {
return nullptr;
}
const base::Value::Dict& value_dict = admin_template.GetDict();
bool auto_launch_on_startup;
std::string created_time_usec_str;
int64_t created_time_usec;
std::string name;
std::string updated_time_usec_str;
int64_t updated_time_usec;
std::string uuid_str;
const base::Value::Dict* desk = value_dict.FindDict(kDesk);
if (!desk ||
!GetBool(value_dict, kAutoLaunchOnStartup, &auto_launch_on_startup) ||
!GetString(value_dict, kUuid, &uuid_str) ||
!GetString(value_dict, kName, &name) ||
!GetString(value_dict, kCreatedTime, &created_time_usec_str) ||
!base::StringToInt64(created_time_usec_str, &created_time_usec) ||
!GetString(value_dict, kUpdatedTime, &updated_time_usec_str) ||
!base::StringToInt64(updated_time_usec_str, &updated_time_usec) ||
name.empty() || created_time_usec_str.empty() ||
updated_time_usec_str.empty()) {
return nullptr;
}
base::Uuid uuid = base::Uuid::ParseCaseInsensitive(uuid_str);
if (!uuid.is_valid()) {
return nullptr;
}
const base::Time created_time =
desks_storage::desk_template_conversion::ProtoTimeToTime(
created_time_usec);
const base::Time updated_time =
desks_storage::desk_template_conversion::ProtoTimeToTime(
updated_time_usec);
auto ash_admin_template = std::make_unique<ash::DeskTemplate>(
std::move(uuid), ash::DeskTemplateSource::kPolicy, name, created_time,
ash::DeskTemplateType::kTemplate, auto_launch_on_startup,
admin_template.Clone());
auto corrected_desk = CorrectAdminTemplateFormat(desk);
ash_admin_template->set_updated_time(updated_time);
ash_admin_template->set_desk_restore_data(
ConvertJsonToRestoreData(&corrected_desk));
return ash_admin_template;
}
} // namespace
namespace desks_storage {
namespace desk_template_conversion {
// Converts the TabGroupColorId passed into its string equivalent
// as defined in the k constants above.
std::string ConvertTabGroupColorIdToString(GroupColor color) {
switch (color) {
case GroupColor::kGrey:
return tab_groups::kTabGroupColorGrey;
case GroupColor::kBlue:
return tab_groups::kTabGroupColorBlue;
case GroupColor::kRed:
return tab_groups::kTabGroupColorRed;
case GroupColor::kYellow:
return tab_groups::kTabGroupColorYellow;
case GroupColor::kGreen:
return tab_groups::kTabGroupColorGreen;
case GroupColor::kPink:
return tab_groups::kTabGroupColorPink;
case GroupColor::kPurple:
return tab_groups::kTabGroupColorPurple;
case GroupColor::kCyan:
return tab_groups::kTabGroupColorCyan;
case GroupColor::kOrange:
return tab_groups::kTabGroupColorOrange;
case GroupColor::kNumEntries:
NOTREACHED() << "kNumEntries is not a supported color enum.";
}
}
// Converts a time field from sync protobufs to a time object.
base::Time ProtoTimeToTime(int64_t proto_time) {
return base::Time::FromDeltaSinceWindowsEpoch(base::Microseconds(proto_time));
}
// Converts a time object to the format used in sync protobufs
// (Microseconds since the Windows epoch).
int64_t TimeToProtoTime(const base::Time& t) {
return t.ToDeltaSinceWindowsEpoch().InMicroseconds();
}
std::vector<std::unique_ptr<ash::DeskTemplate>>
ParseAdminTemplatesFromPolicyValue(const base::Value& value) {
std::vector<std::unique_ptr<ash::DeskTemplate>> desk_templates;
if (!value.is_list()) {
return desk_templates;
}
for (const auto& desk_template : value.GetList()) {
auto desk_template_ptr = ParseAdminTemplate(desk_template);
if (desk_template_ptr == nullptr) {
continue;
}
desk_templates.push_back(std::move(desk_template_ptr));
}
return desk_templates;
}
ParseSavedDeskResult ParseDeskTemplateFromBaseValue(
const base::Value& value,
ash::DeskTemplateSource source) {
if (!value.is_dict()) {
return base::unexpected(SavedDeskParseError::kBaseValueIsNotDict);
}
const base::Value::Dict& value_dict = value.GetDict();
std::string created_time_usec_str;
int64_t created_time_usec;
std::string name;
std::string updated_time_usec_str;
int64_t updated_time_usec;
std::string uuid_str;
int version;
const base::Value::Dict* desk = value_dict.FindDict(kDesk);
if (!desk || !GetInt(value_dict, kVersion, &version) ||
!GetString(value_dict, kUuid, &uuid_str) ||
!GetString(value_dict, kName, &name) ||
!GetString(value_dict, kCreatedTime, &created_time_usec_str) ||
!base::StringToInt64(created_time_usec_str, &created_time_usec) ||
!GetString(value_dict, kUpdatedTime, &updated_time_usec_str) ||
!base::StringToInt64(updated_time_usec_str, &updated_time_usec) ||
name.empty() || created_time_usec_str.empty() ||
updated_time_usec_str.empty()) {
return base::unexpected(SavedDeskParseError::kMissingRequiredFields);
}
base::Uuid uuid = base::Uuid::ParseCaseInsensitive(uuid_str);
if (!uuid.is_valid()) {
return base::unexpected(SavedDeskParseError::kInvalidUuid);
}
// Set default value for the desk type to template.
std::string desk_type_string;
if (!GetString(value_dict, kDeskType, &desk_type_string)) {
desk_type_string = kDeskTypeTemplate;
} else if (!IsValidDeskTemplateType(desk_type_string)) {
return base::unexpected(SavedDeskParseError::kInvalidDeskType);
}
const ash::DeskTemplateType desk_type =
GetDeskTypeFromString(desk_type_string);
// If policy template set auto launch bool.
bool auto_launch_on_startup = false;
GetBool(value_dict, kAutoLaunchOnStartup, &auto_launch_on_startup);
const base::Time created_time = ProtoTimeToTime(created_time_usec);
const base::Time updated_time = ProtoTimeToTime(updated_time_usec);
std::unique_ptr<ash::DeskTemplate> desk_template = nullptr;
// Note: this method is responsible for parsing both regular and policy
// templates after said policy templates are pushed to the device.
if (auto* policy_value = value_dict.FindDict(kPolicy)) {
desk_template = std::make_unique<ash::DeskTemplate>(
std::move(uuid), source, name, created_time, desk_type,
auto_launch_on_startup, base::Value(policy_value->Clone()));
} else {
desk_template = std::make_unique<ash::DeskTemplate>(
std::move(uuid), source, name, created_time, desk_type);
}
desk_template->set_updated_time(updated_time);
desk_template->set_desk_restore_data(ConvertJsonToRestoreData(desk));
if (const auto* tab_app_entities_dict =
value_dict.FindDict(kCoralTabAppEntities)) {
desk_template->set_coral_tab_app_entities(
ConvertDictToCoralTabAppEntities(*tab_app_entities_dict));
}
return base::ok(std::move(desk_template));
}
base::Value SerializeDeskTemplateAsBaseValue(
const ash::DeskTemplate* desk,
apps::AppRegistryCache* app_cache) {
base::Value::Dict desk_dict;
desk_dict.Set(kVersion, kVersionNum);
desk_dict.Set(kUuid, desk->uuid().AsLowercaseString());
desk_dict.Set(kName, desk->template_name());
desk_dict.Set(kCreatedTime, base::TimeToValue(desk->created_time()));
desk_dict.Set(kUpdatedTime, base::TimeToValue(desk->GetLastUpdatedTime()));
desk_dict.Set(kDeskType, SerializeDeskTypeAsString(desk->type()));
desk_dict.Set(kAutoLaunchOnStartup, desk->should_launch_on_startup());
desk_dict.Set(
kDesk, ConvertRestoreDataToValue(desk->desk_restore_data(), app_cache));
if (desk->policy_definition().type() == base::Value::Type::DICT) {
desk_dict.Set(kPolicy, desk->policy_definition().Clone());
}
if (desk->type() == DeskTemplateType::kCoral &&
!desk->coral_tab_app_entities().empty()) {
desk_dict.Set(kCoralTabAppEntities, ConvertCoralTabAppEntitiesToDict(
desk->coral_tab_app_entities()));
}
return base::Value(std::move(desk_dict));
}
std::unique_ptr<DeskTemplate> FromSyncProto(
const sync_pb::WorkspaceDeskSpecifics& pb_entry) {
base::Uuid uuid = base::Uuid::ParseCaseInsensitive(pb_entry.uuid());
if (!uuid.is_valid())
return nullptr;
const base::Time created_time =
ProtoTimeToTime(pb_entry.created_time_windows_epoch_micros());
const ash::DeskTemplateType desk_type =
pb_entry.has_desk_type()
? GetDeskTemplateTypeFromProtoType(pb_entry.desk_type())
: ash::DeskTemplateType::kTemplate;
if (desk_type == ash::DeskTemplateType::kUnknown) {
return nullptr;
}
// Protobuf parsing enforces UTF-8 encoding for all strings.
auto desk_template = std::make_unique<DeskTemplate>(
std::move(uuid), ash::DeskTemplateSource::kUser, pb_entry.name(),
created_time, desk_type);
if (pb_entry.has_updated_time_windows_epoch_micros()) {
desk_template->set_updated_time(
ProtoTimeToTime(pb_entry.updated_time_windows_epoch_micros()));
}
desk_template->set_desk_restore_data(ConvertToRestoreData(pb_entry));
if (pb_entry.has_client_cache_guid()) {
desk_template->set_client_cache_guid(pb_entry.client_cache_guid());
}
if (pb_entry.has_device_form_factor()) {
desk_template->set_device_form_factor(
syncer::ToDeviceInfoFormFactor(pb_entry.device_form_factor()));
} else {
desk_template->set_device_form_factor(
syncer::DeviceInfo::FormFactor::kUnknown);
}
if (pb_entry.has_coral_tab_app_entities()) {
desk_template->set_coral_tab_app_entities(
GetCoralTabAppEntitiesFromProto(pb_entry));
}
return desk_template;
}
sync_pb::WorkspaceDeskSpecifics ToSyncProto(const DeskTemplate* desk_template,
apps::AppRegistryCache* cache) {
DCHECK(cache);
sync_pb::WorkspaceDeskSpecifics pb_entry;
FillDeskType(desk_template, &pb_entry);
pb_entry.set_uuid(desk_template->uuid().AsLowercaseString());
pb_entry.set_name(base::UTF16ToUTF8(desk_template->template_name()));
pb_entry.set_created_time_windows_epoch_micros(
TimeToProtoTime(desk_template->created_time()));
if (desk_template->WasUpdatedSinceCreation()) {
pb_entry.set_updated_time_windows_epoch_micros(
TimeToProtoTime(desk_template->GetLastUpdatedTime()));
}
if (desk_template->desk_restore_data()) {
FillWorkspaceDeskSpecifics(cache, desk_template->desk_restore_data(),
&pb_entry);
}
if (!desk_template->coral_tab_app_entities().empty()) {
FillCoralTabAppEntities(*desk_template, &pb_entry);
}
if (!desk_template->client_cache_guid().empty()) {
pb_entry.set_client_cache_guid(desk_template->client_cache_guid());
}
pb_entry.set_device_form_factor(
syncer::ToDeviceFormFactorProto(desk_template->device_form_factor()));
return pb_entry;
}
} // namespace desk_template_conversion
} // namespace desks_storage
|