1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876
|
// Copyright 2012 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/omnibox/browser/omnibox_edit_model.h"
#include <algorithm>
#include <iterator>
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include "base/auto_reset.h"
#include "base/feature_list.h"
#include "base/format_macros.h"
#include "base/functional/bind.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/metrics/user_metrics.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/trace_event/trace_event.h"
#include "base/trace_event/typed_macros.h"
#include "build/branding_buildflags.h"
#include "build/build_config.h"
#include "components/bookmarks/browser/bookmark_model.h"
#include "components/dom_distiller/core/url_constants.h"
#include "components/dom_distiller/core/url_utils.h"
#include "components/grit/components_scaled_resources.h"
#include "components/history_embeddings/history_embeddings_features.h"
#include "components/navigation_metrics/navigation_metrics.h"
#include "components/omnibox/browser/actions/omnibox_action.h"
#include "components/omnibox/browser/actions/omnibox_pedal.h"
#include "components/omnibox/browser/actions/omnibox_pedal_concepts.h"
#include "components/omnibox/browser/autocomplete_classifier.h"
#include "components/omnibox/browser/autocomplete_match.h"
#include "components/omnibox/browser/autocomplete_match_type.h"
#include "components/omnibox/browser/autocomplete_provider.h"
#include "components/omnibox/browser/autocomplete_provider_client.h"
#include "components/omnibox/browser/contextual_search_provider.h"
#include "components/omnibox/browser/history_fuzzy_provider.h"
#include "components/omnibox/browser/history_url_provider.h"
#include "components/omnibox/browser/keyword_provider.h"
#include "components/omnibox/browser/omnibox.mojom-shared.h"
#include "components/omnibox/browser/omnibox_client.h"
#include "components/omnibox/browser/omnibox_controller.h"
#include "components/omnibox/browser/omnibox_event_global_tracker.h"
#include "components/omnibox/browser/omnibox_field_trial.h"
#include "components/omnibox/browser/omnibox_log.h"
#include "components/omnibox/browser/omnibox_logging_utils.h"
#include "components/omnibox/browser/omnibox_metrics_provider.h"
#include "components/omnibox/browser/omnibox_navigation_observer.h"
#include "components/omnibox/browser/omnibox_popup_selection.h"
#include "components/omnibox/browser/omnibox_popup_view.h"
#include "components/omnibox/browser/omnibox_prefs.h"
#include "components/omnibox/browser/omnibox_text_util.h"
#include "components/omnibox/browser/omnibox_view.h"
#include "components/omnibox/browser/page_classification_functions.h"
#include "components/omnibox/browser/search_provider.h"
#include "components/omnibox/browser/suggestion_answer.h"
#include "components/omnibox/browser/verbatim_match.h"
#include "components/omnibox/common/omnibox_feature_configs.h"
#include "components/omnibox/common/omnibox_features.h"
#include "components/omnibox/common/omnibox_focus_state.h"
#include "components/prefs/pref_service.h"
#include "components/search_engines/search_engine_type.h"
#include "components/search_engines/template_url.h"
#include "components/search_engines/template_url_prepopulate_data.h"
#include "components/search_engines/template_url_service.h"
#include "components/search_engines/template_url_starter_pack_data.h"
#include "components/strings/grit/components_strings.h"
#include "net/cookies/cookie_util.h"
#include "third_party/icu/source/common/unicode/ubidi.h"
#include "third_party/metrics_proto/omnibox_event.pb.h"
#include "third_party/metrics_proto/omnibox_focus_type.pb.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/resource/resource_bundle.h"
#include "ui/gfx/color_palette.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/image/image.h"
#include "url/third_party/mozilla/url_parse.h"
#include "url/url_util.h"
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
#include "components/omnibox/browser/vector_icons.h" // nogncheck
#include "ui/gfx/paint_vector_icon.h"
#include "ui/gfx/vector_icon_types.h"
#endif
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
#include "components/vector_icons/vector_icons.h" // nogncheck
#endif
constexpr bool kIsDesktop = !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS);
using bookmarks::BookmarkModel;
using metrics::OmniboxEventProto;
using omnibox::mojom::NavigationPredictor;
// Helpers --------------------------------------------------------------------
namespace {
// The possible histogram values emitted when escape is pressed.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class OmniboxEscapeAction {
// `kNone` doesn't mean escape did nothing (e.g. it could have stopped a
// navigation), just that it did not affect the omnibox state.
// kNone = 0, No longer used since escape now always blurs the omnibox if it
// does nothing else.
kRevertTemporaryText = 1,
kClosePopup = 2,
kClearUserInput = 3,
kClosePopupAndClearUserInput = 4,
kBlur = 5,
kMaxValue = kBlur,
};
const char kOmniboxFocusResultedInNavigation[] =
"Omnibox.FocusResultedInNavigation";
// Histogram name which counts the number of times the user enters
// keyword hint mode and via what method. The possible values are listed
// in the metrics OmniboxEnteredKeywordMode2 enum which is defined in metrics
// enum XML file.
const char kEnteredKeywordModeHistogram[] = "Omnibox.EnteredKeywordMode2";
// Histogram name which counts the number of times the user completes a search
// in keyword mode, enumerated by how they enter keyword mode.
const char kAcceptedKeywordSuggestionHistogram[] =
"Omnibox.AcceptedKeywordSuggestion";
// Histogram name which counts the number of times the user enters the keyword
// mode, enumerated by the type of search engine.
const char kKeywordModeUsageByEngineTypeEnteredHistogramName[] =
"Omnibox.KeywordModeUsageByEngineType.Entered";
// Histogram name which counts the number of times the user completes a search
// in keyword mode, enumerated by the type of search engine.
const char kKeywordModeUsageByEngineTypeAcceptedHistogramName[] =
"Omnibox.KeywordModeUsageByEngineType.Accepted";
void EmitEnteredKeywordModeHistogram(
OmniboxEventProto::KeywordModeEntryMethod entry_method,
const TemplateURL* turl) {
UMA_HISTOGRAM_ENUMERATION(
kEnteredKeywordModeHistogram, static_cast<int>(entry_method),
static_cast<int>(OmniboxEventProto::KeywordModeEntryMethod_MAX + 1));
if (turl != nullptr) {
base::UmaHistogramEnumeration(
kKeywordModeUsageByEngineTypeEnteredHistogramName,
turl->GetBuiltinEngineType(),
BuiltinEngineType::KEYWORD_MODE_ENGINE_TYPE_MAX);
}
}
void EmitAcceptedKeywordSuggestionHistogram(
OmniboxEventProto::KeywordModeEntryMethod entry_method,
const TemplateURL* turl) {
UMA_HISTOGRAM_ENUMERATION(
kAcceptedKeywordSuggestionHistogram, static_cast<int>(entry_method),
static_cast<int>(OmniboxEventProto::KeywordModeEntryMethod_MAX + 1));
if (turl != nullptr) {
base::UmaHistogramEnumeration(
kKeywordModeUsageByEngineTypeAcceptedHistogramName,
turl->GetBuiltinEngineType(),
BuiltinEngineType::KEYWORD_MODE_ENGINE_TYPE_MAX);
}
}
} // namespace
// OmniboxEditModel::State ----------------------------------------------------
OmniboxEditModel::State::State(
bool user_input_in_progress,
const std::u16string& user_text,
const std::u16string& keyword,
const std::u16string& keyword_placeholder,
bool is_keyword_hint,
OmniboxEventProto::KeywordModeEntryMethod keyword_mode_entry_method,
OmniboxFocusState focus_state,
const AutocompleteInput& autocomplete_input)
: user_input_in_progress(user_input_in_progress),
user_text(user_text),
keyword(keyword),
keyword_placeholder(keyword_placeholder),
is_keyword_hint(is_keyword_hint),
keyword_mode_entry_method(keyword_mode_entry_method),
focus_state(focus_state),
autocomplete_input(autocomplete_input) {}
OmniboxEditModel::State::State(const State& other) = default;
OmniboxEditModel::State::~State() = default;
// OmniboxEditModel -----------------------------------------------------------
OmniboxEditModel::OmniboxEditModel(OmniboxController* controller,
OmniboxView* view)
: controller_(controller),
view_(view),
user_input_in_progress_(false),
focus_resulted_in_navigation_(false),
just_deleted_text_(false),
has_temporary_text_(false),
paste_state_(NONE),
control_key_state_(UP),
is_keyword_hint_(false),
keyword_mode_entry_method_(OmniboxEventProto::INVALID),
in_revert_(false),
allow_exact_keyword_match_(false) {}
OmniboxEditModel::~OmniboxEditModel() = default;
void OmniboxEditModel::set_popup_view(OmniboxPopupView* popup_view) {
popup_view_ = popup_view;
// Clear/reset popup-related state.
rich_suggestion_bitmaps_.clear();
icon_bitmaps_.clear();
old_focused_url_ = GURL();
popup_selection_ = OmniboxPopupSelection(OmniboxPopupSelection::kNoMatch,
OmniboxPopupSelection::NORMAL);
}
metrics::OmniboxEventProto::PageClassification
OmniboxEditModel::GetPageClassification() const {
return controller_->client()->GetPageClassification(/*is_prefetch=*/false);
}
OmniboxEditModel::State OmniboxEditModel::GetStateForTabSwitch() const {
// NOTE: it's important this doesn't attempt to access any state that
// may come from the active WebContents. At the time this is called, the
// active WebContents has already changed.
// Like typing, switching tabs "accepts" the temporary text as the user
// text, because it makes little sense to have temporary text when the
// popup is closed.
std::u16string user_text;
if (user_input_in_progress_) {
const std::u16string display_text = GetText();
if (!MaybePrependKeyword(display_text).empty())
user_text = display_text;
// Else case is user deleted all the text. The expectation (which matches
// other browsers) is when the user restores the state a revert happens as
// well as a select all. The revert shouldn't be done here, as at the time
// this is called a revert would revert to the url of the newly activated
// tab (because at the time this is called, the WebContents has already
// changed). By leaving the |user_text| empty downstream code is able to
// detect this and select all.
} else {
user_text = user_text_;
}
return State(user_input_in_progress_, user_text, keyword_,
keyword_placeholder_, is_keyword_hint_,
keyword_mode_entry_method_, focus_state_, input_);
}
void OmniboxEditModel::RestoreState(const State* state) {
// We need to update the permanent display texts correctly and revert the
// view regardless of whether there is saved state.
ResetDisplayTexts();
if (view_) {
view_->RevertAll();
}
// Restore the autocomplete controller's input, or clear it if this is a new
// tab.
input_ = state ? state->autocomplete_input : AutocompleteInput();
if (!state) {
return;
}
// The tab-management system saves the last-focused control for each tab and
// restores it. That operation also updates this edit model's focus_state_
// if necessary. This occurs before we reach this point in the code.
//
// The only reason we need to separately save and restore our focus state is
// to preserve our special "invisible focus" state used for the fakebox.
//
// However, in some circumstances (if the last-focused control was destroyed),
// the Omnibox will be focused by default, and the edit model's saved state
// may be invalid. We make a check to guard against that.
//
// The experiment with `features::kOmniboxRestoreInvisibleFocusOnly` explores
// only restoring focus when needed due to one of the states being the
// "invisible focus" state.
const bool saved_focus_state_invalid =
focus_state_ == OMNIBOX_FOCUS_VISIBLE &&
state->focus_state == OMNIBOX_FOCUS_NONE;
const bool invisible_focus_changed =
focus_state_ == OMNIBOX_FOCUS_INVISIBLE ||
state->focus_state == OMNIBOX_FOCUS_INVISIBLE;
if (base::FeatureList::IsEnabled(omnibox::kOmniboxRestoreInvisibleFocusOnly)
? invisible_focus_changed
: !saved_focus_state_invalid) {
SetFocusState(state->focus_state, OMNIBOX_FOCUS_CHANGE_TAB_SWITCH);
}
// Restore any user editing.
if (state->user_input_in_progress) {
// NOTE: Be sure to set keyword-related state AFTER invoking
// SetUserText(), as SetUserText() clears the keyword state.
if ((!state->user_text.empty() || !state->keyword.empty()) && view_) {
view_->SetUserText(state->user_text, false);
}
SetKeyword(state->keyword);
SetKeywordPlaceholder(state->keyword_placeholder);
is_keyword_hint_ = state->is_keyword_hint;
keyword_mode_entry_method_ = state->keyword_mode_entry_method;
if (view_) {
view_->OnKeywordPlaceholderTextChange();
}
} else if (!state->user_text.empty()) {
// If the |user_input_in_progress| is false but we have |user_text|,
// restore the |user_text| to the model and the view. It's likely unelided
// text that the user has not made any modifications to.
InternalSetUserText(state->user_text);
// We let the View manage restoring the cursor position afterwards.
if (view_) {
view_->SetWindowTextAndCaretPos(state->user_text, 0, false, false);
}
}
}
AutocompleteMatch OmniboxEditModel::CurrentMatch(
GURL* alternate_nav_url) const {
// If we have a valid match use it. Otherwise get one for the current text.
AutocompleteMatch match = current_match_;
if (!match.destination_url.is_valid()) {
GetInfoForCurrentText(&match, alternate_nav_url);
} else if (alternate_nav_url) {
AutocompleteProviderClient* provider_client =
autocomplete_controller()->autocomplete_provider_client();
*alternate_nav_url = AutocompleteResult::ComputeAlternateNavUrl(
input_, match, provider_client);
}
return match;
}
bool OmniboxEditModel::ResetDisplayTexts() {
const std::u16string old_display_text = GetPermanentDisplayText();
url_for_editing_ = controller_->client()->GetFormattedFullURL();
#if BUILDFLAG(IS_IOS)
// iOS is unusual in that it uses a separate LocationView to show the
// LocationBarModel's display-only URL. The actual OmniboxViewIOS widget is
// hidden in the defocused state, and always contains the URL for editing.
display_text_ = url_for_editing_;
#else
display_text_ = controller_->client()->GetURLForDisplay();
#endif
// When there's new permanent text, and the user isn't interacting with the
// omnibox, we want to revert the edit to show the new text. We could simply
// define "interacting" as "the omnibox has focus", but we still allow updates
// when the omnibox has focus as long as the user hasn't begun editing, and
// isn't seeing zerosuggestions (because changing this text would require
// changing or hiding those suggestions). When the omnibox doesn't have
// focus, we assume the user may have abandoned their interaction and it's
// always safe to change the text; this also prevents someone toggling "Show
// URL" (which sounds as if it might be persistent) from seeing just that URL
// forever afterwards.
return (GetPermanentDisplayText() != old_display_text) &&
(!has_focus() || (!user_input_in_progress_ && !PopupIsOpen()));
}
std::u16string OmniboxEditModel::GetPermanentDisplayText() const {
return display_text_;
}
void OmniboxEditModel::SetUserText(const std::u16string& text) {
SetInputInProgress(true);
keyword_.clear();
keyword_placeholder_.clear();
is_keyword_hint_ = false;
keyword_mode_entry_method_ = OmniboxEventProto::INVALID;
if (view_) {
view_->OnKeywordPlaceholderTextChange();
}
InternalSetUserText(text);
GetInfoForCurrentText(¤t_match_, nullptr);
paste_state_ = NONE;
has_temporary_text_ = false;
}
bool OmniboxEditModel::Unelide() {
// Unelision should not occur if the user has already inputted text.
if (user_input_in_progress())
return false;
// No need to unelide if we are already displaying the full URL.
if (GetText() == controller_->client()->GetFormattedFullURL()) {
return false;
}
// Set the user text to the unelided URL, but don't change
// |user_input_in_progress_|. This is to save the unelided URL on tab switch.
InternalSetUserText(url_for_editing_);
if (view_) {
view_->SetWindowTextAndCaretPos(url_for_editing_, 0, false, false);
// Select all in reverse to ensure the beginning of the URL is shown.
view_->SelectAll(true /* reversed */);
}
return true;
}
void OmniboxEditModel::OnChanged() {
// Don't call CurrentMatch() when there's no editing, as in this case we'll
// never actually use it. This avoids running the autocomplete providers (and
// any systems they then spin up) during startup.
const AutocompleteMatch& current_match =
user_input_in_progress_ ? CurrentMatch(nullptr) : AutocompleteMatch();
controller_->client()->OnTextChanged(
current_match, user_input_in_progress_, user_text_,
autocomplete_controller()->result(), has_focus());
}
void OmniboxEditModel::GetDataForURLExport(GURL* url,
std::u16string* title,
gfx::Image* favicon) {
*url = CurrentMatch(nullptr).destination_url;
if (*url == controller_->client()->GetURL()) {
*title = controller_->client()->GetTitle();
*favicon = controller_->client()->GetFavicon();
}
}
bool OmniboxEditModel::CurrentTextIsURL() const {
// If !user_input_in_progress_, we can determine if the text is a URL without
// starting the autocomplete system. This speeds browser startup.
return !user_input_in_progress_ ||
!AutocompleteMatch::IsSearchType(CurrentMatch(nullptr).type);
}
void OmniboxEditModel::AdjustTextForCopy(int sel_min,
std::u16string* text,
GURL* url_from_text,
bool* write_url) {
omnibox::AdjustTextForCopy(
sel_min, text,
/*has_user_modified_text=*/user_input_in_progress_ ||
(*text != display_text_ && *text != url_for_editing_),
is_keyword_selected(),
PopupIsOpen() ? std::optional<AutocompleteMatch>(CurrentMatch(nullptr))
: std::nullopt,
controller_->client(), url_from_text, write_url);
}
bool OmniboxEditModel::ShouldShowCurrentPageIcon() const {
// If the popup is open, don't show the current page's icon. The caller is
// instead expected to show the current match's icon.
if (PopupIsOpen()) {
return false;
}
// On the New Tab Page, the omnibox textfield is empty. We want to display
// the default search provider favicon instead of the NTP security icon.
if (GetText().empty()) {
return false;
}
// If user input is not in progress, always show the current page's icon.
if (!user_input_in_progress())
return true;
// If user input is in progress, keep showing the current page's icon so long
// as the text matches the current page's URL, elided or unelided.
return GetText() == display_text_ || GetText() == url_for_editing_;
}
ui::ImageModel OmniboxEditModel::GetSuperGIcon(int image_size,
bool dark_mode) const {
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
if (dark_mode) {
return ui::ImageModel::FromVectorIcon(
vector_icons::kGoogleGLogoMonochromeIcon, ui::kColorRefPrimary100,
image_size);
} else {
// The icon color does not matter in this case since this icon has colors
// hardcoded into it.
return ui::ImageModel::FromVectorIcon(vector_icons::kGoogleSuperGIcon,
gfx::kPlaceholderColor, image_size);
}
#else
return ui::ImageModel();
#endif
}
gfx::Image OmniboxEditModel::GetAgentspaceIcon(bool dark_mode) const {
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
if (dark_mode) {
// For dark mode, per Agentspace branding, use `SK_ColorWhite` over the
// monochrome logo.
return controller_->client()->GetSizedIcon(
vector_icons::kGoogleAgentspaceMonochromeLogoIcon, SK_ColorWHITE);
} else {
return controller_->client()->GetSizedIcon(
ui::ResourceBundle::GetSharedInstance()
.GetImageNamed(IDR_GOOGLE_AGENTSPACE_LOGO)
.ToSkBitmap());
}
#else
return gfx::Image();
#endif
}
void OmniboxEditModel::UpdateInput(bool has_selected_text,
bool prevent_inline_autocomplete) {
bool changed_to_user_input_in_progress = SetInputInProgressNoNotify(true);
if (!has_focus()) {
if (changed_to_user_input_in_progress)
NotifyObserversInputInProgress(true);
return;
}
if (!is_keyword_selected() && changed_to_user_input_in_progress &&
user_text_.empty()) {
// In the case the user enters user-input-in-progress mode by clearing
// everything (i.e. via Backspace), ask for ZeroSuggestions instead of the
// normal prefix (as-you-type) autocomplete.
//
// We also check that no keyword is selected, as otherwise that breaks
// entering keyword mode via Ctrl+K.
//
// TODO(tommycli): The difference between a ZeroSuggest request and a normal
// prefix autocomplete request is getting fuzzier, and should be fully
// encapsulated by the AutocompleteInput::focus_type() member. We should
// merge these two calls soon, lest we confuse future developers.
StartZeroSuggestRequest(/*user_clobbered_permanent_text=*/true);
} else {
// Otherwise run the normal prefix (as-you-type) autocomplete.
StartAutocomplete(has_selected_text, prevent_inline_autocomplete);
}
if (changed_to_user_input_in_progress)
NotifyObserversInputInProgress(true);
}
void OmniboxEditModel::SetInputInProgress(bool in_progress) {
if (SetInputInProgressNoNotify(in_progress))
NotifyObserversInputInProgress(in_progress);
}
void OmniboxEditModel::Revert() {
SetInputInProgress(false);
input_.Clear();
paste_state_ = NONE;
InternalSetUserText(std::u16string());
keyword_.clear();
keyword_placeholder_.clear();
is_keyword_hint_ = false;
keyword_mode_entry_method_ = OmniboxEventProto::INVALID;
if (view_) {
view_->OnKeywordPlaceholderTextChange();
}
has_temporary_text_ = false;
size_t start, end;
if (view_) {
view_->GetSelectionBounds(&start, &end);
}
current_match_ = AutocompleteMatch();
// First home the cursor, so view of text is scrolled to left, then correct
// it. |SetCaretPos()| doesn't scroll the text, so doing that first wouldn't
// accomplish anything.
std::u16string current_permanent_url = GetPermanentDisplayText();
if (view_) {
view_->SetWindowTextAndCaretPos(current_permanent_url, 0, false, true);
view_->SetCaretPos(std::min(current_permanent_url.length(), start));
}
controller_->client()->OnRevert();
}
void OmniboxEditModel::StartAutocomplete(bool has_selected_text,
bool prevent_inline_autocomplete) {
const std::u16string input_text = MaybePrependKeyword(user_text_);
size_t start, cursor_position;
// This method currently only works when there's a view, but ideally the
// model should be primary for determining such state.
CHECK(view_);
view_->GetSelectionBounds(&start, &cursor_position);
// For keyword searches, the text that AutocompleteInput expects is
// of the form "<keyword> <query>", where our query is |user_text_|.
// So we need to adjust the cursor position forward by the length of
// any keyword added by MaybePrependKeyword() above.
if (is_keyword_selected()) {
// If there is user text, the cursor is past the keyword and doesn't
// account for its size. Add the keyword's size to the position passed
// to autocomplete.
if (!user_text_.empty()) {
cursor_position += input_text.length() - user_text_.length();
} else {
// Otherwise, cursor may point into keyword or otherwise not account
// for the keyword's size (depending on how this code is reached).
// Pass a cursor at end of input to autocomplete. This is safe in all
// conditions.
cursor_position = input_text.length();
}
}
input_ = AutocompleteInput(
input_text, cursor_position, GetPageClassification(),
controller_->client()->GetSchemeClassifier(),
controller_->client()->ShouldDefaultTypedNavigationsToHttps(),
controller_->client()->GetHttpsPortForTesting(),
controller_->client()->IsUsingFakeHttpsForHttpsUpgradeTesting());
input_.set_current_url(controller_->client()->GetURL());
input_.set_current_title(controller_->client()->GetTitle());
input_.set_prevent_inline_autocomplete(
prevent_inline_autocomplete || just_deleted_text_ ||
(has_selected_text && inline_autocompletion_.empty()) ||
paste_state_ != NONE);
input_.set_prefer_keyword(is_keyword_selected());
input_.set_allow_exact_keyword_match(is_keyword_selected() ||
allow_exact_keyword_match_);
input_.set_keyword_mode_entry_method(keyword_mode_entry_method_);
if (std::optional<lens::proto::LensOverlaySuggestInputs> suggest_inputs =
controller_->client()->GetLensOverlaySuggestInputs()) {
input_.set_lens_overlay_suggest_inputs(*suggest_inputs);
}
controller_->StartAutocomplete(input_);
}
bool OmniboxEditModel::CanPasteAndGo(const std::u16string& text) const {
if (!controller_->client()->IsPasteAndGoEnabled()) {
return false;
}
AutocompleteMatch match;
ClassifyString(text, &match, nullptr);
return match.destination_url.is_valid();
}
void OmniboxEditModel::PasteAndGo(const std::u16string& text,
base::TimeTicks match_selection_timestamp) {
DCHECK(CanPasteAndGo(text));
if (view_) {
view_->RevertAll();
}
AutocompleteMatch match;
GURL alternate_nav_url;
ClassifyString(text, &match, &alternate_nav_url);
GURL upgraded_url;
if (match.type == AutocompleteMatchType::URL_WHAT_YOU_TYPED &&
controller_->client()->ShouldDefaultTypedNavigationsToHttps() &&
AutocompleteInput::ShouldUpgradeToHttps(
text, match.destination_url,
controller_->client()->GetHttpsPortForTesting(),
controller_->client()->IsUsingFakeHttpsForHttpsUpgradeTesting(),
&upgraded_url)) {
input_.set_added_default_scheme_to_typed_url(true);
DCHECK(upgraded_url.is_valid());
match.destination_url = upgraded_url;
} else {
input_.set_added_default_scheme_to_typed_url(false);
}
OpenMatch(OmniboxPopupSelection(OmniboxPopupSelection::kNoMatch), match,
WindowOpenDisposition::CURRENT_TAB, alternate_nav_url, text,
match_selection_timestamp);
}
void OmniboxEditModel::EnterKeywordMode(
OmniboxEventProto::KeywordModeEntryMethod entry_method,
const TemplateURL* template_url,
const std::u16string& placeholder_text) {
DCHECK(template_url);
controller_->StopAutocomplete(/*clear_result=*/false);
if (keyword_ != template_url->keyword()) {
// Note, this is not the only place that keyword mode can be entered, but
// it would be better to make it so than to add extra notification calls
// elsewhere. At present, the method is only meaningfully used for exit.
controller_->client()->OnKeywordModeChanged(true, template_url->keyword());
}
SetKeyword(template_url->keyword());
SetKeywordPlaceholder(placeholder_text);
is_keyword_hint_ = false;
keyword_mode_entry_method_ = entry_method;
if (view_) {
view_->OnKeywordPlaceholderTextChange();
}
std::u16string display_text =
user_input_in_progress_ ? GetText() : std::u16string();
size_t caret_pos = display_text.length();
if (entry_method == OmniboxEventProto::QUESTION_MARK) {
display_text.erase(0, 1);
caret_pos = 0;
}
InternalSetUserText(display_text);
if (view_) {
view_->SetWindowTextAndCaretPos(display_text, caret_pos, true, false);
if (entry_method == OmniboxEventProto::KEYBOARD_SHORTCUT) {
view_->SelectAll(false);
}
}
EmitEnteredKeywordModeHistogram(entry_method, template_url);
}
void OmniboxEditModel::EnterKeywordModeForDefaultSearchProvider(
OmniboxEventProto::KeywordModeEntryMethod entry_method) {
if (!controller_->client()->IsDefaultSearchProviderEnabled()) {
return;
}
EnterKeywordMode(entry_method,
controller_->client()
->GetTemplateURLService()
->GetDefaultSearchProvider(),
u"");
}
void OmniboxEditModel::OpenSelection(OmniboxPopupSelection selection,
base::TimeTicks timestamp,
WindowOpenDisposition disposition) {
// Intentionally accept input when selection has no line.
// This will usually reach `OpenMatch` indirectly.
if (selection.line >= autocomplete_controller()->result().size()) {
AcceptInput(disposition, timestamp);
return;
}
// The keyword mode button doesn't commit the omnibox, it's a
// transient UI element leading to other normal omnibox selections.
if (selection.state == OmniboxPopupSelection::KEYWORD_MODE) {
return;
}
const AutocompleteMatch& match =
autocomplete_controller()->result().match_at(selection.line);
if (selection.state == OmniboxPopupSelection::FOCUSED_BUTTON_THUMBS_UP) {
UpdateFeedbackOnMatch(selection.line, FeedbackType::kThumbsUp);
} else if (selection.state ==
OmniboxPopupSelection::FOCUSED_BUTTON_THUMBS_DOWN) {
UpdateFeedbackOnMatch(selection.line, FeedbackType::kThumbsDown);
} else if (selection.state ==
OmniboxPopupSelection::FOCUSED_BUTTON_REMOVE_SUGGESTION) {
TryDeletingPopupLine(selection.line);
} else if (selection.state == OmniboxPopupSelection::FOCUSED_IPH_LINK) {
controller_->client()->OpenIphLink(match.iph_link_url);
} else {
// Open the match.
GURL alternate_nav_url = AutocompleteResult::ComputeAlternateNavUrl(
input_, match,
autocomplete_controller()->autocomplete_provider_client());
OpenMatch(selection, match, disposition, alternate_nav_url,
std::u16string(), timestamp);
}
}
void OmniboxEditModel::OpenSelection(base::TimeTicks timestamp,
WindowOpenDisposition disposition) {
OpenSelection(popup_selection_, timestamp, disposition);
}
bool OmniboxEditModel::AcceptKeyword(
OmniboxEventProto::KeywordModeEntryMethod entry_method) {
TRACE_EVENT0("omnibox", "OmniboxEditModel::AcceptKeyword");
DCHECK(!keyword_.empty()) << keyword_;
controller_->StopAutocomplete(/*clear_result=*/false);
is_keyword_hint_ = false;
keyword_mode_entry_method_ = entry_method;
if (original_user_text_with_keyword_.empty()) {
original_user_text_with_keyword_ = user_text_;
}
user_text_ = MaybeStripKeyword(user_text_);
if (PopupIsOpen()) {
OmniboxPopupSelection selection = GetPopupSelection();
selection.state = OmniboxPopupSelection::KEYWORD_MODE;
SetPopupSelection(selection);
} else {
StartAutocomplete(false, true);
}
// When user text is empty (the user hasn't typed anything beyond the
// keyword), the new text to show is whatever the newly-selected match in the
// dropdown is. When user text is not empty, however, we should make sure to
// use the actual |user_text_| as the basis for the new text. This ensures
// that if the user types "<keyword><space>" and the default match would have
// inline autocompleted a further string (e.g. because there's a past
// multi-word search beginning with this keyword), the inline autocompletion
// doesn't get filled in as the keyword search query text.
//
// We also treat tabbing into keyword mode like tabbing through the popup in
// that we set |has_temporary_text_|, whereas pressing space is treated like
// a new keystroke that changes the current match instead of overlaying it
// with a temporary one. This is important because rerunning autocomplete
// after the user pressed space, which will have happened just before reaching
// here, may have generated a new match, which the user won't actually see and
// which we don't want to switch back to when exiting keyword mode; see
// comments in ClearKeyword().
if (view_) {
view_->OnTemporaryTextMaybeChanged(user_text_, {}, !has_temporary_text_,
true);
if (!user_text_.empty()) {
view_->UpdatePopup();
}
}
base::RecordAction(base::UserMetricsAction("AcceptedKeywordHint"));
const TemplateURL* turl =
controller_->client()->GetTemplateURLService()->GetTemplateURLForKeyword(
keyword_);
EmitEnteredKeywordModeHistogram(entry_method, turl);
return true;
}
void OmniboxEditModel::AcceptTemporaryTextAsUserText() {
InternalSetUserText(GetText());
has_temporary_text_ = false;
if (user_input_in_progress_ || !in_revert_)
controller_->client()->OnInputStateChanged();
}
void OmniboxEditModel::ClearKeyword() {
if (!is_keyword_selected() || !view_) {
return;
}
TRACE_EVENT0("omnibox", "OmniboxEditModel::ClearKeyword");
controller_->StopAutocomplete(/*clear_result=*/false);
// While we're always in keyword mode upon reaching here, sometimes we've just
// toggled in via space or tab, and sometimes we're on a non-toggled line
// (usually because the user has typed a search string). Keep track of the
// difference, as we'll need it below. `popup_view_` may be nullptr in tests.
bool was_toggled_into_keyword_mode =
popup_view_ &&
GetPopupSelection().state == OmniboxPopupSelection::KEYWORD_MODE;
bool entry_by_tab = keyword_mode_entry_method_ == OmniboxEventProto::TAB;
controller_->ClearPopupKeywordMode();
// There are several possible states we could have been in before the user hit
// backspace or shift-tab to enter this function:
// (1) was_toggled_into_keyword_mode == false, entry_by_tab == false
// The user typed a further key after being in keyword mode already, e.g.
// "google.com f".
// (2) was_toggled_into_keyword_mode == false, entry_by_tab == true
// The user tabbed away from a dropdown entry in keyword mode, then tabbed
// back to it, e.g. "google.com f<tab><shift-tab>".
// (3) was_toggled_into_keyword_mode == true, entry_by_tab == false
// The user had just typed space to enter keyword mode, e.g.
// "google.com ".
// (4) was_toggled_into_keyword_mode == true, entry_by_tab == true
// The user had just typed tab to enter keyword mode, e.g.
// "google.com<tab>".
//
// For states 1-3, we can safely handle the exit from keyword mode by using
// OnBefore/AfterPossibleChange() to do a complete state update of all
// objects. However, with state 4, if we do this, and if the user had tabbed
// into keyword mode on a line in the middle of the dropdown instead of the
// first line, then the state update will rerun autocompletion and reset the
// whole dropdown, and end up with the first line selected instead, instead of
// just "undoing" the keyword mode entry on the non-first line. So in this
// case we simply reset |is_keyword_hint_| to true and update the window text.
//
// You might wonder why we don't simply do this in all cases. In states 1-2,
// getting out of keyword mode likely shouldn't put us in keyword hint mode;
// if the user typed "google.com f" and then put the cursor before 'f' and hit
// backspace, the resulting text would be "google.comf", which is unlikely to
// be a keyword. Unconditionally putting things back in keyword hint mode is
// going to lead to internally inconsistent state, and possible future
// crashes. State 3 is more subtle; here we need to do the full state update
// because before entering keyword mode to begin with, we will have re-run
// autocomplete in ways that can produce surprising results if we just switch
// back out of keyword mode. For example, if a user has a keyword named "x",
// an inline-autocompletable history site "xyz.com", and a lower-ranked
// inline-autocompletable search "x y", then typing "x" will inline-
// autocomplete to "xyz.com", hitting space will toggle into keyword mode, but
// then hitting backspace could wind up with the default match as the "x y"
// search, which feels bizarre.
if (was_toggled_into_keyword_mode && entry_by_tab) {
// State 4 above.
is_keyword_hint_ = true;
keyword_mode_entry_method_ = OmniboxEventProto::INVALID;
const std::u16string window_text = keyword_ + view_->GetText();
view_->SetWindowTextAndCaretPos(window_text, keyword_.length(), false,
true);
// TODO (manukh): Exiting keyword mode in this case will not restore
// the omnibox additional text. E.g., if before entering keyword mode, the
// location bar displays 'google.com | (Google)', after entering (via tab)
// and leaving keyword mode, it will display 'google.com' leaving keyword
// mode, it will only display 'Google.com'.
} else {
// States 1-3 above.
view_->OnBeforePossibleChange();
// Add a space after the keyword to allow the user to continue typing
// without re-enabling keyword mode. The common case is state 3, where
// the user entered keyword mode unintentionally, so backspacing
// immediately out of keyword mode should keep the space. In states 1 and
// 2, having the space is "safer" behavior. For instance, if the user types
// "google.com f" or "google.com<tab>f" in the omnibox, moves the cursor to
// the left, and presses backspace to leave keyword mode (state 1), it's
// better to have the space because it may be what the user wanted. The
// user can easily delete it. On the other hand, if there is no space and
// the user wants it, it's more work to add because typing the space will
// enter keyword mode, which then the user would have to leave again.
// If we entered keyword mode in a special way like using a keyboard
// shortcut or typing a question mark in a blank omnibox, don't restore the
// keyword. Instead, restore the question mark iff the user originally
// typed one.
std::u16string prefix;
if (keyword_mode_entry_method_ == OmniboxEventProto::QUESTION_MARK)
prefix = u"?";
else if (keyword_mode_entry_method_ != OmniboxEventProto::KEYBOARD_SHORTCUT)
prefix = keyword_ + u" ";
keyword_.clear();
keyword_placeholder_.clear();
is_keyword_hint_ = false;
keyword_mode_entry_method_ = OmniboxEventProto::INVALID;
if (view_) {
view_->OnKeywordPlaceholderTextChange();
}
view_->SetWindowTextAndCaretPos(prefix + view_->GetText(), prefix.length(),
false, false);
view_->OnAfterPossibleChange(false);
}
}
void OmniboxEditModel::ClearAdditionalText() {
TRACE_EVENT0("omnibox", "OmniboxEditModel::ClearAdditionalText");
if (view_) {
view_->SetAdditionalText(std::u16string());
}
}
void OmniboxEditModel::OnSetFocus(bool control_down) {
TRACE_EVENT0("omnibox", "OmniboxEditModel::OnSetFocus");
last_omnibox_focus_ = base::TimeTicks::Now();
focus_resulted_in_navigation_ = false;
// If the omnibox lost focus while the caret was hidden and then regained
// focus, OnSetFocus() is called and should restore visibility. Note that
// focus can be regained without an accompanying call to
// OmniboxView::SetFocus(), e.g. by tabbing in.
SetFocusState(OMNIBOX_FOCUS_VISIBLE, OMNIBOX_FOCUS_CHANGE_EXPLICIT);
// On focusing the omnibox, if the ctrl key is pressed, we don't want to
// trigger ctrl-enter behavior unless it is released and re-pressed. For
// example, if the user presses ctrl-l to focus the omnibox.
control_key_state_ = control_down ? DOWN_AND_CONSUMED : UP;
if (user_input_in_progress_ || !in_revert_)
controller_->client()->OnInputStateChanged();
if (omnibox_feature_configs::HappinessTrackingSurveyForOmniboxOnFocusZps::
Get()
.enabled) {
controller_->client()->MaybeShowOnFocusHatsSurvey(
autocomplete_controller()->autocomplete_provider_client());
}
}
void OmniboxEditModel::StartZeroSuggestRequest(
bool user_clobbered_permanent_text) {
// Early exit if a query is already in progress or the popup is already open.
// This is what allows this method to be called multiple times in multiple
// code locations without harm.
if (!autocomplete_controller()->done() || PopupIsOpen()) {
return;
}
// Early exit if the page has not loaded yet, so we don't annoy users.
if (!controller_->client()->CurrentPageExists()) {
return;
}
// Early exit if the user already has a navigation or search query in mind.
if (user_input_in_progress_ && !user_clobbered_permanent_text)
return;
TRACE_EVENT0("omnibox", "OmniboxEditModel::StartZeroSuggestRequest");
// Send the textfield contents exactly as-is, as otherwise the verbatim
// match can be wrong. The full page URL is anyways in set_current_url().
// Don't attempt to use https as the default scheme for these requests.
input_ = AutocompleteInput(
GetText(), GetPageClassification(),
controller_->client()->GetSchemeClassifier(),
/*should_use_https_as_default_scheme=*/false,
controller_->client()->GetHttpsPortForTesting(),
controller_->client()->IsUsingFakeHttpsForHttpsUpgradeTesting());
input_.set_current_url(controller_->client()->GetURL());
input_.set_current_title(controller_->client()->GetTitle());
input_.set_focus_type(metrics::OmniboxFocusType::INTERACTION_FOCUS);
// Set the lens overlay suggest inputs, if available.
if (std::optional<lens::proto::LensOverlaySuggestInputs> suggest_inputs =
controller_->client()->GetLensOverlaySuggestInputs()) {
input_.set_lens_overlay_suggest_inputs(*suggest_inputs);
}
controller_->StartAutocomplete(input_);
}
void OmniboxEditModel::SetCaretVisibility(bool visible) {
// Caret visibility only matters if the omnibox has focus.
if (focus_state_ != OMNIBOX_FOCUS_NONE) {
SetFocusState(visible ? OMNIBOX_FOCUS_VISIBLE : OMNIBOX_FOCUS_INVISIBLE,
OMNIBOX_FOCUS_CHANGE_EXPLICIT);
}
}
void OmniboxEditModel::ConsumeCtrlKey() {
if (control_key_state_ == DOWN)
control_key_state_ = DOWN_AND_CONSUMED;
}
void OmniboxEditModel::OnWillKillFocus() {
if (user_input_in_progress_ || !in_revert_)
controller_->client()->OnInputStateChanged();
}
void OmniboxEditModel::OnKillFocus() {
UMA_HISTOGRAM_BOOLEAN(kOmniboxFocusResultedInNavigation,
focus_resulted_in_navigation_);
SetFocusState(OMNIBOX_FOCUS_NONE, OMNIBOX_FOCUS_CHANGE_EXPLICIT);
last_omnibox_focus_ = base::TimeTicks();
paste_state_ = NONE;
control_key_state_ = UP;
#if BUILDFLAG(IS_WIN)
if (view_) {
view_->HideImeIfNeeded();
}
#endif
}
bool OmniboxEditModel::OnEscapeKeyPressed() {
const char* kOmniboxEscapeHistogramName = "Omnibox.Escape";
// If there is temporary text (i.e. a non default suggestion is selected),
// revert it.
if (has_temporary_text_) {
base::UmaHistogramEnumeration(kOmniboxEscapeHistogramName,
OmniboxEscapeAction::kRevertTemporaryText);
RevertTemporaryTextAndPopup();
return true;
}
// We do not clear the pending entry from the omnibox when a load is first
// stopped. If the user presses Escape while stopped, whether editing or not,
// we clear it.
if (controller_->client()->CurrentPageExists() &&
!controller_->client()->IsLoading()) {
controller_->client()->DiscardNonCommittedNavigations();
if (view_) {
view_->Update();
}
}
// Close the popup if it's open.
if (PopupIsOpen()) {
base::UmaHistogramEnumeration(kOmniboxEscapeHistogramName,
OmniboxEscapeAction::kClosePopup);
if (view_) {
view_->CloseOmniboxPopup();
}
return true;
}
// Unconditionally revert/select all. This ensures any popup, whether due to
// normal editing or ZeroSuggest, is closed, and the full text is selected.
// This in turn allows the user to use escape to quickly select all the text
// for ease of replacement, and matches other browsers.
bool user_input_was_in_progress = user_input_in_progress_;
// TODO(crbug.com/40230336): If the popup was open, `user_input_in_progress_`
// *should* also be true; checking `user_text_` in the DCHECK below, and
// checking `popup_was_open` in the if predicate below *should* be
// unnecessary. However, that's not always the case (see
// `user_input_in_progress_` comment in the header).
if (view_) {
view_->RevertAll();
view_->SelectAll(true);
}
if (user_input_was_in_progress) {
base::UmaHistogramEnumeration(kOmniboxEscapeHistogramName,
OmniboxEscapeAction::kClearUserInput);
// If the user was in the midst of editing, don't cancel any underlying page
// load. This doesn't match IE or Firefox, but seems more correct. Note
// that we do allow the page load to be stopped in the case where
// ZeroSuggest was visible; this is so that it's still possible to focus the
// address bar and hit escape once to stop a load even if the address being
// loaded triggers the ZeroSuggest popup.
return true;
}
// Blur the omnibox and focus the web contents.
base::UmaHistogramEnumeration(kOmniboxEscapeHistogramName,
OmniboxEscapeAction::kBlur);
controller_->client()->FocusWebContents();
return true;
}
void OmniboxEditModel::OnControlKeyChanged(bool pressed) {
if (pressed == (control_key_state_ == UP))
control_key_state_ = pressed ? DOWN : UP;
}
void OmniboxEditModel::OnPaste() {
UMA_HISTOGRAM_COUNTS_1M("Omnibox.Paste", 1);
paste_state_ = PASTING;
}
void OmniboxEditModel::OnUpOrDownPressed(bool down, bool page) {
const auto direction =
down ? OmniboxPopupSelection::kForward : OmniboxPopupSelection::kBackward;
const auto step = page ? OmniboxPopupSelection::kAllLines
: OmniboxPopupSelection::kWholeLine;
StepPopupSelection(direction, step);
}
void OmniboxEditModel::OnTabPressed(bool shift) {
StepPopupSelection(shift ? OmniboxPopupSelection::kBackward
: OmniboxPopupSelection::kForward,
OmniboxPopupSelection::kStateOrLine);
}
bool OmniboxEditModel::OnSpacePressed() {
if (!kIsDesktop) {
return false;
}
if (!GetPrefService()->GetBoolean(omnibox::kKeywordSpaceTriggeringEnabled)) {
return false;
}
if (!is_keyword_hint_ && keyword_.empty() &&
input_.cursor_position() == input_.text().length()) {
// Keywords can now be accessed anywhere in the match list. If one is
// found on an instant keyword match, select and accept it.
const AutocompleteResult& result = autocomplete_controller()->result();
for (size_t i = 0; i < result.size(); i++) {
const AutocompleteMatch& match = result.match_at(i);
if (input_.text() == match.keyword &&
match.HasInstantKeyword(
controller_->client()->GetTemplateURLService())) {
SetPopupSelection(OmniboxPopupSelection(i));
AcceptKeyword(metrics::OmniboxEventProto::SPACE_AT_END);
return true;
}
}
}
return false;
}
bool OmniboxEditModel::MaybeAccelerateKeywordSelection(
std::u16string_view input_text,
char16_t ch) {
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
// Only check for acceleration when the current input text is "@" exactly.
if (AutocompleteInput::GetFeaturedKeywordMode(input_text) !=
AutocompleteInput::FeaturedKeywordMode::kExact ||
!history_embeddings::GetFeatureParameters().at_keyword_acceleration) {
return false;
}
TemplateURLService* turl_service =
controller_->client()->GetTemplateURLService();
const AutocompleteResult& result = autocomplete_controller()->result();
for (size_t i = 0; i < result.size(); i++) {
const AutocompleteMatch& match = result.match_at(i);
// TODO(b/332783748): If this gets used in practice, a more general
// matching mechanism would be needed to handle keywords with a
// prefix in common. This is simple for the prototype where all
// first characters are unique.
if (match.HasInstantKeyword(turl_service) && match.keyword.size() > 1 &&
match.keyword[1] == ch) {
SetPopupSelection(OmniboxPopupSelection(i), true, true);
// TODO(b/332783748): Use a different entry method.
AcceptKeyword(metrics::OmniboxEventProto::TAB);
return true;
}
}
#endif // !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
return false;
}
void OmniboxEditModel::OnNavigationLikely(
size_t line,
NavigationPredictor navigation_predictor) {
if (autocomplete_controller()->result().empty()) {
return;
}
if (line == OmniboxPopupSelection::kNoMatch) {
return;
}
if (line >= autocomplete_controller()->result().size()) {
return;
}
controller_->client()->OnNavigationLikely(
line, autocomplete_controller()->result().match_at(line),
navigation_predictor);
}
void OmniboxEditModel::OpenMatchForTesting(
AutocompleteMatch match,
WindowOpenDisposition disposition,
const GURL& alternate_nav_url,
const std::u16string& pasted_text,
size_t index,
base::TimeTicks match_selection_timestamp) {
OpenMatch(OmniboxPopupSelection(index), match, disposition, alternate_nav_url,
pasted_text, match_selection_timestamp);
}
void OmniboxEditModel::OnPopupDataChanged(
const std::u16string& temporary_text,
bool is_temporary_text,
const std::u16string& inline_autocompletion,
const std::u16string& keyword,
const std::u16string& keyword_placeholder,
bool is_keyword_hint,
const std::u16string& additional_text,
const AutocompleteMatch& new_match) {
current_match_ = new_match;
if (!original_user_text_with_keyword_.empty() && !is_temporary_text &&
(keyword.empty() || is_keyword_hint)) {
user_text_ = original_user_text_with_keyword_;
original_user_text_with_keyword_.clear();
}
// Update keyword/hint-related local state.
bool keyword_state_changed =
(keyword_ != keyword) ||
((is_keyword_hint_ != is_keyword_hint) && !keyword.empty());
if (keyword_state_changed) {
bool keyword_was_selected = is_keyword_selected();
SetKeyword(keyword);
SetKeywordPlaceholder(keyword_placeholder);
is_keyword_hint_ = is_keyword_hint;
if (!keyword_was_selected && is_keyword_selected()) {
// Since we entered keyword mode, record the reason. Note that we
// don't do this simply because the keyword changes, since the user
// never left keyword mode.
keyword_mode_entry_method_ = OmniboxEventProto::SELECT_SUGGESTION;
} else if (!is_keyword_selected()) {
// We've left keyword mode, so align the entry method field with that.
keyword_mode_entry_method_ = OmniboxEventProto::INVALID;
}
if (view_) {
view_->OnKeywordPlaceholderTextChange();
}
// |is_keyword_hint_| should always be false if |keyword_| is empty.
DCHECK(!keyword_.empty() || !is_keyword_hint_);
}
// Handle changes to temporary text.
if (is_temporary_text) {
const bool save_original_selection = !has_temporary_text_;
if (save_original_selection) {
// Save the original selection and URL so it can be reverted later.
has_temporary_text_ = true;
inline_autocompletion_.clear();
if (view_) {
view_->OnInlineAutocompleteTextCleared();
}
}
// Arrowing around the popup cancels control-enter.
ConsumeCtrlKey();
// Now things are a bit screwy: the desired_tld has changed, but if we
// update the popup, the new order of entries won't match the old, so the
// user's selection gets screwy; and if we don't update the popup, and the
// user reverts, then the selected item will be as if control is still
// pressed, even though maybe it isn't any more. There is no obvious
// right answer here :(
if (view_) {
view_->OnTemporaryTextMaybeChanged(
MaybeStripKeyword(temporary_text), current_match_,
save_original_selection && original_user_text_with_keyword_.empty(),
true);
}
return;
}
inline_autocompletion_ = inline_autocompletion;
if (inline_autocompletion_.empty() && view_) {
view_->OnInlineAutocompleteTextCleared();
}
const std::u16string& user_text =
user_input_in_progress_ ? user_text_ : input_.text();
if (keyword_state_changed && is_keyword_selected() &&
inline_autocompletion_.empty()) {
// If we reach here, the user most likely entered keyword mode by inserting
// a space between a keyword name and a search string (as pressing space or
// tab after the keyword name alone would have been be handled in
// MaybeAcceptKeywordBySpace() by calling AcceptKeyword(), which won't reach
// here). In this case, we don't want to call
// OnInlineAutocompleteTextMaybeChanged() as normal, because that will
// correctly change the text (to the search string alone) but move the caret
// to the end of the string; instead we want the caret at the start of the
// search string since that's where it was in the original input. So we set
// the text and caret position directly.
//
// It may also be possible to reach here if we're reverting from having
// temporary text back to a default match that's a keyword search, but in
// that case the RevertTemporaryTextAndPopup() call below will reset the
// caret or selection correctly so the caret positioning we do here won't
// matter.
if (view_) {
view_->SetWindowTextAndCaretPos(user_text, 0, false, true);
}
} else {
if (view_) {
view_->OnInlineAutocompleteTextMaybeChanged(user_text,
inline_autocompletion_);
view_->SetAdditionalText(additional_text);
}
}
// We need to invoke OnChanged in case the destination url changed (as could
// happen when control is toggled).
OnChanged();
}
bool OmniboxEditModel::OnAfterPossibleChange(
const OmniboxView::StateChanges& state_changes,
bool allow_keyword_ui_change) {
// Update the paste state as appropriate: if we're just finishing a paste
// that replaced all the text, preserve that information; otherwise, if we've
// made some other edit, clear paste tracking.
if (paste_state_ == PASTING) {
paste_state_ = PASTED;
GURL url = GURL(*(state_changes.new_text));
if (url.is_valid()) {
controller_->client()->OnUserPastedInOmniboxResultingInValidURL();
}
} else if (state_changes.text_differs)
paste_state_ = NONE;
if (state_changes.text_differs || state_changes.selection_differs) {
// Restore caret visibility whenever the user changes text or selection in
// the omnibox.
SetFocusState(OMNIBOX_FOCUS_VISIBLE, OMNIBOX_FOCUS_CHANGE_TYPING);
}
// When the user performs an action with the ctrl key pressed down, we assume
// the ctrl key was intended for that action. If they then press enter without
// releasing the ctrl key, we prevent "ctrl-enter" behavior.
ConsumeCtrlKey();
// If the user text does not need to be changed, return now, so we don't
// change any other state, lest arrowing around the omnibox do something like
// reset |just_deleted_text_|. Note that modifying the selection accepts any
// inline autocompletion, which results in a user text change.
if (!state_changes.text_differs &&
(!state_changes.selection_differs || inline_autocompletion_.empty())) {
if (state_changes.keyword_differs && view_) {
// We won't need the below logic for creating a keyword by a space at the
// end or in the middle, or by typing a '?', but we do need to update the
// popup view because the keyword can change without the text changing,
// for example when the keyword is "youtube.com" and the user presses
// ctrl-k to change it to "google.com", or if the user text is empty and
// the user presses backspace.
view_->UpdatePopup();
}
return state_changes.keyword_differs;
}
InternalSetUserText(*state_changes.new_text);
has_temporary_text_ = false;
just_deleted_text_ = state_changes.just_deleted_text;
const bool no_selection =
state_changes.new_sel_start == state_changes.new_sel_end;
// Update the popup for the change, in the process changing to keyword mode
// if the user hit space in mid-string after a keyword.
// |allow_exact_keyword_match_| will be used by StartAutocomplete() method,
// which will be called by |view_->UpdatePopup()|; so after that returns we
// can safely reset this flag.
// If entering keyword mode by space is disabled, do not set
// |allow_exact_keyword_match_|.
allow_exact_keyword_match_ =
AllowKeywordSpaceTriggering() && state_changes.text_differs &&
allow_keyword_ui_change && !state_changes.just_deleted_text &&
no_selection &&
CreatedKeywordSearchByInsertingSpaceInMiddle(
*state_changes.old_text, user_text_, state_changes.new_sel_start);
if (view_) {
view_->UpdatePopup();
}
if (allow_exact_keyword_match_) {
keyword_mode_entry_method_ = OmniboxEventProto::SPACE_IN_MIDDLE;
const TemplateURL* turl = controller_->client()
->GetTemplateURLService()
->GetTemplateURLForKeyword(keyword_);
EmitEnteredKeywordModeHistogram(OmniboxEventProto::SPACE_IN_MIDDLE, turl);
allow_exact_keyword_match_ = false;
}
if (!state_changes.text_differs || !allow_keyword_ui_change ||
(state_changes.just_deleted_text && no_selection) ||
is_keyword_selected() || (paste_state_ != NONE))
return true;
// If the user input a "?" at the beginning of the text, put them into
// keyword mode for their default search provider.
if ((state_changes.new_sel_start == 1) && (user_text_[0] == '?')) {
EnterKeywordModeForDefaultSearchProvider(OmniboxEventProto::QUESTION_MARK);
return false;
}
// Change to keyword mode if the user is now pressing space after a keyword
// name. Note that if this is the case, then even if there was no keyword
// hint when we entered this function (e.g. if the user has used space to
// replace some selected text that was adjoined to this keyword), there will
// be one now because of the call to UpdatePopup() above; so it's safe for
// MaybeAcceptKeywordBySpace() to look at |keyword_| and |is_keyword_hint_|
// to determine what keyword, if any, is applicable.
//
// If MaybeAcceptKeywordBySpace() accepts the keyword and returns true, that
// will have updated our state already, so in that case we don't also return
// true from this function.
return (state_changes.new_sel_start != user_text_.length()) ||
!MaybeAcceptKeywordBySpace(user_text_);
}
// TODO(beaudoin): Merge OnPopupDataChanged with this method once the popup
// handling has completely migrated to omnibox_controller.
void OmniboxEditModel::OnCurrentMatchChanged() {
has_temporary_text_ = false;
DCHECK(autocomplete_controller()->result().default_match());
const AutocompleteMatch& match =
*autocomplete_controller()->result().default_match();
// We store |keyword| and |is_keyword_hint| in temporary variables since
// OnPopupDataChanged use their previous state to detect changes.
std::u16string keyword;
std::u16string keyword_placeholder;
bool is_keyword_hint;
TemplateURLService* service = controller_->client()->GetTemplateURLService();
match.GetKeywordUIState(service,
controller_->client()->IsHistoryEmbeddingsEnabled(),
&keyword, &keyword_placeholder, &is_keyword_hint);
OnPopupResultChanged();
if (!is_keyword_selected() && !is_keyword_hint && !keyword.empty()) {
// We just entered keyword mode, so remove the keyword from the input.
// We don't call MaybeStripKeyword, as we haven't yet updated our internal
// state (keyword_ and is_keyword_hint_), and MaybeStripKeyword checks this.
user_text_ =
AutocompleteInput::SplitReplacementStringFromInput(user_text_, false);
original_user_text_with_keyword_.clear();
}
// OnPopupDataChanged() resets OmniboxController's |current_match_| early
// on. Therefore, copy match.inline_autocompletion to a temp to preserve
// its value across the entire call.
OnPopupDataChanged(std::u16string(),
/*is_temporary_text=*/false, match.inline_autocompletion,
keyword, keyword_placeholder, is_keyword_hint,
match.additional_text, match);
}
// static
const char OmniboxEditModel::kCutOrCopyAllTextHistogram[] =
"Omnibox.CutOrCopyAllText";
void OmniboxEditModel::SetAccessibilityLabel(const AutocompleteMatch& match) {
if (view_) {
view_->SetAccessibilityLabel(view_->GetText(), match, true);
}
}
void OmniboxEditModel::InternalSetUserText(const std::u16string& text) {
user_text_ = text;
original_user_text_with_keyword_.clear();
just_deleted_text_ = false;
inline_autocompletion_.clear();
if (view_) {
view_->OnInlineAutocompleteTextCleared();
}
}
std::u16string OmniboxEditModel::MaybeStripKeyword(
const std::u16string& text) const {
return is_keyword_selected()
? AutocompleteInput::SplitReplacementStringFromInput(text, false)
: text;
}
std::u16string OmniboxEditModel::MaybePrependKeyword(
const std::u16string& text) const {
return is_keyword_selected() ? (keyword_ + u' ' + text) : text;
}
void OmniboxEditModel::GetInfoForCurrentText(AutocompleteMatch* match,
GURL* alternate_nav_url) const {
DCHECK(match);
// If there's a query in progress or the popup is open, pick out the default
// match or selected match, if there is one.
bool found_match_for_text = false;
if (!autocomplete_controller()->done() || PopupIsOpen()) {
if (!autocomplete_controller()->done() &&
autocomplete_controller()->result().default_match()) {
// The user cannot have manually selected a match, or the query would have
// stopped. So the default match must be the desired selection.
*match = *autocomplete_controller()->result().default_match();
found_match_for_text = true;
} else if (PopupIsOpen() &&
GetPopupSelection().line != OmniboxPopupSelection::kNoMatch) {
const OmniboxPopupSelection selection = GetPopupSelection();
const AutocompleteMatch& selected_match =
autocomplete_controller()->result().match_at(selection.line);
*match = (selection.state == OmniboxPopupSelection::KEYWORD_MODE)
? *selected_match.associated_keyword
: selected_match;
found_match_for_text = true;
}
if (found_match_for_text && alternate_nav_url &&
(!popup_view_ || IsPopupSelectionOnInitialLine())) {
AutocompleteProviderClient* provider_client =
autocomplete_controller()->autocomplete_provider_client();
*alternate_nav_url = AutocompleteResult::ComputeAlternateNavUrl(
input_, *match, provider_client);
}
}
if (!found_match_for_text) {
// For match generation, we use the unelided |url_for_editing_|, unless the
// user input is in progress.
std::u16string text_for_match_generation =
user_input_in_progress() ? user_text_ : url_for_editing_;
controller_->client()->GetAutocompleteClassifier()->Classify(
MaybePrependKeyword(text_for_match_generation), is_keyword_selected(),
true, GetPageClassification(), match, alternate_nav_url);
}
}
void OmniboxEditModel::RevertTemporaryTextAndPopup() {
// The user typed something, then selected a different item. Restore the
// text they typed and change back to the default item.
// NOTE: This purposefully does not reset paste_state_.
just_deleted_text_ = false;
has_temporary_text_ = false;
ResetPopupToInitialState();
// There are two cases in which resetting to the default match doesn't restore
// the proper original text:
// 1. If user input is not in progress, we are reverting an on-focus
// suggestion. These may be unrelated to the original input.
// 2. If there's no default match at all.
//
// The original selection will be restored in OnRevertTemporaryText() below.
if ((!user_input_in_progress_ ||
!autocomplete_controller()->result().default_match()) &&
view_) {
view_->SetWindowTextAndCaretPos(input_.text(), /*caret_pos=*/0,
/*update_popup=*/false,
/*notify_text_changed=*/true);
}
if (view_) {
const AutocompleteMatch& match = CurrentMatch(nullptr);
view_->OnRevertTemporaryText(match.fill_into_edit, match);
}
}
bool OmniboxEditModel::IsStarredMatch(const AutocompleteMatch& match) const {
auto* bookmark_model = controller_->client()->GetBookmarkModel();
return bookmark_model && bookmark_model->IsBookmarked(match.destination_url);
}
// Android and iOS have their own platform-specific icon logic.
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
gfx::Image OmniboxEditModel::GetMatchIcon(const AutocompleteMatch& match,
SkColor vector_icon_color,
bool dark_mode) const {
if (!match.icon_url.is_empty()) {
const SkBitmap* bitmap = GetIconBitmap(match.icon_url);
if (bitmap) {
return controller_->client()->GetSizedIcon(bitmap);
}
}
gfx::Image extension_icon = GetMatchIconIfExtension(match);
if (!extension_icon.IsEmpty()) {
return extension_icon;
}
const TemplateURL* turl =
match.associated_keyword
? controller_->client()
->GetTemplateURLService()
->GetTemplateURLForKeyword(match.associated_keyword->keyword)
: nullptr;
// Get the favicon for navigational suggestions.
//
// The starter pack suggestions are a unique case. These suggestions
// normally use a favicon image that cannot be styled further by client
// code. In order to apply custom styling to the icon (e.g. colors), we ignore
// this favicon in favor of using a vector icon which has better styling
// support.
// Enterprise search aggregator people suggestions are another unique case.
// These suggestions should use the Agentspace icon if available. Otherwise,
// they should use the vector icon instead of the favicon.
if (match.enterprise_search_aggregator_type ==
AutocompleteMatch::EnterpriseSearchAggregatorType::PEOPLE) {
gfx::Image agentspace_icon = GetAgentspaceIcon(dark_mode);
if (!agentspace_icon.IsEmpty()) {
return agentspace_icon;
}
} else if (!AutocompleteMatch::IsSearchType(match.type) &&
match.type != AutocompleteMatchType::DOCUMENT_SUGGESTION &&
match.type != AutocompleteMatchType::HISTORY_CLUSTER &&
match.type != AutocompleteMatchType::HISTORY_EMBEDDINGS_ANSWER &&
!AutocompleteMatch::IsStarterPackType(match.type)) {
// Because the Views UI code calls GetMatchIcon in both the layout and
// painting code, we may generate multiple `OnFaviconFetched` callbacks,
// all run one after another. This seems to be harmless as the callback
// just flips a flag to schedule a repaint. However, if it turns out to be
// costly, we can optimize away the redundant extra callbacks.
gfx::Image favicon;
auto on_icon_fetched =
base::BindOnce(&OmniboxEditModel::OnFaviconFetched,
weak_factory_.GetWeakPtr(), match.destination_url);
favicon =
(turl && AutocompleteMatch::IsFeaturedEnterpriseSearchType(match.type))
? controller_->client()->GetFaviconForKeywordSearchProvider(
turl, std::move(on_icon_fetched))
: controller_->client()->GetFaviconForPageUrl(
match.destination_url, std::move(on_icon_fetched));
// Extension icons are the correct size for non-touch UI but need to be
// adjusted to be the correct size for touch mode.
if (!favicon.IsEmpty()) {
return controller_->client()->GetSizedIcon(favicon);
}
}
bool is_starred_match = IsStarredMatch(match);
const auto& vector_icon_type = match.GetVectorIcon(is_starred_match, turl);
return controller_->client()->GetSizedIcon(vector_icon_type,
vector_icon_color);
}
gfx::Image OmniboxEditModel::GetMatchIconIfExtension(
const AutocompleteMatch& match) const {
// Return an empty image if not an extension match.
TemplateURLService* service = controller_->client()->GetTemplateURLService();
const TemplateURL* template_url = match.GetTemplateURL(service, false);
if (!template_url ||
template_url->type() != TemplateURL::OMNIBOX_API_EXTENSION) {
return gfx::Image();
}
// Return the image specified in the suggestion match if set by looking it up
// in the rich suggestions bitmaps. Fall back to the extension icon if empty
// or not found.
if (match.provider &&
match.provider->type() == AutocompleteProvider::TYPE_UNSCOPED_EXTENSION &&
!match.ImageUrl().is_empty()) {
const SkBitmap* bitmap = GetPopupRichSuggestionBitmap(match.image_url);
if (bitmap) {
return controller_->client()->GetSizedIcon(bitmap);
}
}
gfx::Image extension_icon =
controller_->client()->GetExtensionIcon(template_url);
// Extension icons are the correct size for non-touch UI but need to be
// adjusted to be the correct size for touch mode
return extension_icon.IsEmpty()
? extension_icon
: controller_->client()->GetSizedIcon(extension_icon);
}
#endif // !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
std::u16string OmniboxEditModel::GetSuggestionGroupHeaderText(
const std::optional<omnibox::GroupId>& suggestion_group_id) const {
if (suggestion_group_id.has_value()) {
bool force_hide_row_header =
OmniboxFieldTrial::IsHideSuggestionGroupHeadersEnabledInContext(
autocomplete_controller()->input().current_page_classification());
auto header_text =
autocomplete_controller()->result().GetHeaderForSuggestionGroup(
suggestion_group_id.value());
// Show contextual search suggestion group header if the Lens action has
// been moved to the Omnibox toolbelt.
bool has_toolbelt_lens_action =
autocomplete_controller()->contextual_search_provider() &&
autocomplete_controller()
->contextual_search_provider()
->HasToolbeltLensAction();
if (suggestion_group_id.value() == omnibox::GROUP_CONTEXTUAL_SEARCH &&
has_toolbelt_lens_action) {
// TODO(khalidpeer): Make direct use of `header_text` once we start
// receiving a non-empty contextual search header from the server.
return header_text.empty()
? l10n_util::GetStringUTF16(
IDS_CONTEXTUAL_SEARCH_OPEN_LENS_ACTION_LABEL)
: header_text;
}
return force_hide_row_header ? u"" : header_text;
}
return u"";
}
bool OmniboxEditModel::PopupIsOpen() const {
return popup_view_ && popup_view_->IsOpen();
}
void OmniboxEditModel::ResetPopupToInitialState() {
if (!popup_view_) {
return;
}
size_t new_line = autocomplete_controller()->result().default_match()
? 0
: OmniboxPopupSelection::kNoMatch;
SetPopupSelection(
OmniboxPopupSelection(new_line, OmniboxPopupSelection::NORMAL),
/*reset_to_default=*/true);
get_popup_view()->OnDragCanceled();
}
OmniboxPopupSelection OmniboxEditModel::GetPopupSelection() const {
DCHECK(popup_view_);
return popup_selection_;
}
void OmniboxEditModel::SetPopupSelection(OmniboxPopupSelection new_selection,
bool reset_to_default,
bool force_update_ui) {
DCHECK(popup_view_);
if (autocomplete_controller()->result().empty()) {
return;
}
// Cancel the query so the matches don't change on the user.
controller_->StopAutocomplete(/*clear_result=*/false);
if (new_selection == popup_selection_ && !force_update_ui) {
// This occurs when e.g. pressing tab to select an action chip or the x
// delete icon. Nothing else to do.
return;
}
// We need to update selection before notifying any views, as they will query
// `popup_selection_` to update themselves.
const OmniboxPopupSelection old_selection = popup_selection_;
popup_selection_ = new_selection;
popup_view_->OnSelectionChanged(old_selection, popup_selection_);
// This occurs when e.g., pressing escape to select the null match in
// zero-input mode.
if (popup_selection_.line == OmniboxPopupSelection::kNoMatch) {
current_match_ = AutocompleteMatch();
return;
}
const AutocompleteMatch& match =
autocomplete_controller()->result().match_at(popup_selection_.line);
DCHECK((popup_selection_.state != OmniboxPopupSelection::KEYWORD_MODE) ||
match.associated_keyword.get());
if (popup_selection_.IsButtonFocused()) {
old_focused_url_ = match.destination_url;
SetAccessibilityLabel(match);
// TODO(tommycli): Fold the focus hint into
// popup_view_->OnSelectionChanged(). Caveat: We must update the
// accessibility label before notifying the View.
popup_view_->ProvideButtonFocusHint(GetPopupSelection().line);
}
std::u16string keyword;
std::u16string keyword_placeholder;
bool is_keyword_hint;
TemplateURLService* service = controller_->client()->GetTemplateURLService();
match.GetKeywordUIState(service,
controller_->client()->IsHistoryEmbeddingsEnabled(),
&keyword, &keyword_placeholder, &is_keyword_hint);
if (old_selection.line != popup_selection_.line ||
(old_selection.state != OmniboxPopupSelection::KEYWORD_MODE &&
new_selection.state != OmniboxPopupSelection::KEYWORD_MODE)) {
// Don't update the edit model if entering or leaving keyword mode; doing so
// breaks keyword mode. Updating when there is no line change is necessary
// because omnibox text changes when:
// a) Moving down from a header row.
// b) Focusing other states; e.g. the switch-to-tab chip.
if (reset_to_default) {
OnPopupDataChanged(
std::u16string(),
/*is_temporary_text=*/false, match.inline_autocompletion, keyword,
keyword_placeholder, is_keyword_hint, match.additional_text, match);
} else {
OnPopupDataChanged(match.fill_into_edit,
/*is_temporary_text=*/true, std::u16string(), keyword,
keyword_placeholder, is_keyword_hint, std::u16string(),
match);
}
}
// Without this, focus indicators may appear stale (see crbug.com/1369229).
popup_view_->UpdatePopupAppearance();
}
bool OmniboxEditModel::IsPopupSelectionOnInitialLine() const {
DCHECK(popup_view_);
size_t initial_line = autocomplete_controller()->result().default_match()
? 0
: OmniboxPopupSelection::kNoMatch;
return GetPopupSelection().line == initial_line;
}
bool OmniboxEditModel::IsPopupControlPresentOnMatch(
OmniboxPopupSelection selection) const {
DCHECK(popup_view_);
return selection.IsControlPresentOnMatch(autocomplete_controller()->result(),
GetPrefService());
}
void OmniboxEditModel::TryDeletingPopupLine(size_t line) {
DCHECK(popup_view_);
// When called with line == GetPopupSelection().line, we could use
// GetInfoForCurrentText() here, but it seems better to try and delete the
// actual selection, rather than any "in progress, not yet visible" one.
if (line == OmniboxPopupSelection::kNoMatch) {
return;
}
// Cancel the query so the matches don't change on the user.
controller_->StopAutocomplete(/*clear_result=*/false);
const AutocompleteMatch& match =
autocomplete_controller()->result().match_at(line);
if (match.SupportsDeletion()) {
// Try to preserve the selection even after match deletion.
size_t old_selected_line = GetPopupSelection().line;
// This will synchronously notify both the edit and us that the results
// have changed, causing both to revert to the default match.
autocomplete_controller()->DeleteMatch(match);
// Clamp the old selection to the new size of
// autocomplete_controller()->result(), since there may be fewer results
// now.
if (old_selected_line != OmniboxPopupSelection::kNoMatch) {
old_selected_line =
std::min(line, autocomplete_controller()->result().size() - 1);
}
// Move the selection to the next choice after the deleted one.
// SetPopupSelection() will clamp to take care of the case where we deleted
// the last item.
// TODO(pkasting): Eventually the controller should take care of this
// before notifying us, reducing flicker. At that point the check for
// deletability can move there too.
SetPopupSelection(
OmniboxPopupSelection(old_selected_line, OmniboxPopupSelection::NORMAL),
false, true);
}
}
std::u16string OmniboxEditModel::GetPopupAccessibilityLabelForCurrentSelection(
const std::u16string& match_text,
bool include_positional_info,
int* label_prefix_length) {
DCHECK(popup_view_);
size_t line = popup_selection_.line;
DCHECK_NE(line, OmniboxPopupSelection::kNoMatch)
<< "GetPopupAccessibilityLabelForCurrentSelection should never be called "
"if the current selection is kNoMatch.";
const AutocompleteMatch& match =
autocomplete_controller()->result().match_at(line);
if (match.type == AutocompleteMatchType::HISTORY_EMBEDDINGS_ANSWER) {
// This match type is a special case that puts its primary meaningful
// content (the answer) into the `description` and repurposes other fields.
// So using `fill_into_edit` or `inline_autocompletion` or even just match
// `contents` doesn't make sense in this case. Instead, we provide the
// screen reader with the header ("Summary") and then the answer in
// `description`, and finally the URL details in `contents` (includes date).
return AutocompleteMatchType::ToAccessibilityLabel(
match, GetSuggestionGroupHeaderText(match.suggestion_group_id),
base::StrCat({
match.history_embeddings_answer_header_text,
match.description,
match.contents,
}),
line, autocomplete_controller()->result().size(), u"",
label_prefix_length);
}
int additional_message_id = 0;
std::u16string additional_message;
// This switch statement should be updated when new selection types are added.
static_assert(OmniboxPopupSelection::LINE_STATE_MAX_VALUE == 7);
switch (popup_selection_.state) {
case OmniboxPopupSelection::NORMAL: {
int available_actions_count = 0;
if (OmniboxPopupSelection(line, OmniboxPopupSelection::KEYWORD_MODE)
.IsControlPresentOnMatch(autocomplete_controller()->result(),
GetPrefService())) {
additional_message_id = IDS_ACC_KEYWORD_SUFFIX;
available_actions_count++;
}
if (OmniboxPopupSelection(line,
OmniboxPopupSelection::FOCUSED_BUTTON_ACTION)
.IsControlPresentOnMatch(autocomplete_controller()->result(),
GetPrefService())) {
additional_message =
match.GetActionAt(0u)->GetLabelStrings().accessibility_suffix;
available_actions_count++;
}
if (OmniboxPopupSelection(line,
OmniboxPopupSelection::FOCUSED_BUTTON_THUMBS_UP)
.IsControlPresentOnMatch(autocomplete_controller()->result(),
GetPrefService())) {
// No need to set `additional_message_id`. Thumbs up and thumbs down
// button are always present together; `additional_message_id` is set to
// `IDS_ACC_MULTIPLE_ACTIONS_SUFFIX` further down.
available_actions_count++;
}
if (OmniboxPopupSelection(
line, OmniboxPopupSelection::FOCUSED_BUTTON_THUMBS_DOWN)
.IsControlPresentOnMatch(autocomplete_controller()->result(),
GetPrefService())) {
// No need to set `additional_message_id`. Thumbs up and thumbs down
// button are always present together; `additional_message_id` is set to
// `IDS_ACC_MULTIPLE_ACTIONS_SUFFIX` further down.
available_actions_count++;
}
if (OmniboxPopupSelection(
line, OmniboxPopupSelection::FOCUSED_BUTTON_REMOVE_SUGGESTION)
.IsControlPresentOnMatch(autocomplete_controller()->result(),
GetPrefService())) {
additional_message_id = IDS_ACC_REMOVE_SUGGESTION_SUFFIX;
available_actions_count++;
}
if (available_actions_count > 1)
additional_message_id = IDS_ACC_MULTIPLE_ACTIONS_SUFFIX;
break;
}
case OmniboxPopupSelection::KEYWORD_MODE: {
// In keyword mode, the match we're interested in is actually the
// associated_keyword of the match we're on. Populate the a11y string
// with information from the keyword match, rather than the current match.
CHECK(match.associated_keyword) << match.keyword;
const TemplateURL* turl = match.associated_keyword->GetTemplateURL(
controller_->client()->GetTemplateURLService(), false);
std::u16string replacement_string =
turl ? turl->short_name() : match.contents;
bool ask_keyword = turl && turl->is_ask_starter_pack();
// For featured search engines, we also want to add the shortcut name.
if (AutocompleteMatch::IsFeaturedSearchType(match.type)) {
int message_id = ask_keyword ? IDS_ACC_ASK_KEYWORD_MODE_WITH_SHORTCUT
: IDS_ACC_KEYWORD_MODE_WITH_SHORTCUT;
return l10n_util::GetStringFUTF16(message_id, match.keyword,
replacement_string);
}
int message_id =
ask_keyword ? IDS_ACC_ASK_KEYWORD_MODE : IDS_ACC_KEYWORD_MODE;
return l10n_util::GetStringFUTF16(message_id, replacement_string);
}
case OmniboxPopupSelection::FOCUSED_BUTTON_ACTION:
// When pedal button is focused, the autocomplete suggestion isn't
// read because it's not relevant to the button's action.
DCHECK(match.GetActionAt(0u));
return match.GetActionAt(0u)->GetLabelStrings().accessibility_hint;
case OmniboxPopupSelection::FOCUSED_BUTTON_THUMBS_UP:
additional_message_id = IDS_ACC_THUMBS_UP_SUGGESTION_FOCUSED_PREFIX;
break;
case OmniboxPopupSelection::FOCUSED_BUTTON_THUMBS_DOWN:
additional_message_id = IDS_ACC_THUMBS_DOWN_SUGGESTION_FOCUSED_PREFIX;
break;
case OmniboxPopupSelection::FOCUSED_BUTTON_REMOVE_SUGGESTION:
additional_message_id = match.IsIPHSuggestion()
? IDS_ACC_DISMISS_CHROME_TIP_FOCUSED_PREFIX
: IDS_ACC_REMOVE_SUGGESTION_FOCUSED_PREFIX;
break;
case OmniboxPopupSelection::FOCUSED_IPH_LINK:
return base::StrCat(
{match_text, u" ",
AutocompleteMatchType::ToAccessibilityLabel(
match, GetSuggestionGroupHeaderText(match.suggestion_group_id),
match.iph_link_text, line, 0,
l10n_util::GetStringUTF16(IDS_ACC_OMNIBOX_IPH_LINK_SELECTED),
label_prefix_length)});
default:
break;
}
if (additional_message_id != 0 && additional_message.empty()) {
additional_message = l10n_util::GetStringUTF16(additional_message_id);
}
if (popup_selection_.IsButtonFocused()) {
include_positional_info = false;
}
size_t total_matches =
include_positional_info ? autocomplete_controller()->result().size() : 0;
// If there's a button focused, we don't want the "n of m" message announced.
return AutocompleteMatchType::ToAccessibilityLabel(
match, GetSuggestionGroupHeaderText(match.suggestion_group_id),
match_text, line, total_matches, additional_message, label_prefix_length);
}
std::u16string
OmniboxEditModel::MaybeGetPopupAccessibilityLabelForIPHSuggestion() {
DCHECK(popup_view_);
DCHECK_NE(popup_selection_.line, OmniboxPopupSelection::kNoMatch)
<< "MaybeGetPopupAccessibilityLabelForIPHSuggestion should never be "
"called "
"if the current selection is kNoMatch.";
std::u16string label = u"";
size_t next_line = popup_selection_.line + 1;
if (next_line < autocomplete_controller()->result().size()) {
const AutocompleteMatch& next_match =
autocomplete_controller()->result().match_at(next_line);
if (next_match.IsIPHSuggestion()) {
label =
l10n_util::GetStringFUTF16(IDS_ACC_CHROME_TIP, next_match.contents);
// Iff the next selection (the next time the user presses tab) is the
// remove suggestion button for the IPH row, also append its a11y label.
auto next_selection = popup_selection_.GetNextSelection(
autocomplete_controller()->result(), GetPrefService(),
controller_->client()->GetTemplateURLService(),
OmniboxPopupSelection::kForward, OmniboxPopupSelection::kStateOrLine,
OmniboxFieldTrial::IsHideSuggestionGroupHeadersEnabledInContext(
GetPageClassification()));
if (next_selection.line == next_line &&
next_selection.state ==
OmniboxPopupSelection::FOCUSED_BUTTON_REMOVE_SUGGESTION) {
label = l10n_util::GetStringFUTF16(IDS_ACC_DISMISS_CHROME_TIP_SUFFIX,
label);
}
}
}
return label;
}
void OmniboxEditModel::OnPopupResultChanged() {
if (!popup_view_) {
return;
}
rich_suggestion_bitmaps_.clear();
const AutocompleteResult& result = autocomplete_controller()->result();
size_t old_selected_line = GetPopupSelection().line;
if (result.default_match()) {
OmniboxPopupSelection selection = GetPopupSelection();
selection.line = 0;
const bool has_focused_match =
selection.state == OmniboxPopupSelection::FOCUSED_BUTTON_ACTION &&
result.match_at(selection.line).has_tab_match.value_or(false);
const bool has_changed =
selection.line != old_selected_line ||
result.match_at(selection.line).destination_url != old_focused_url_;
if (!has_focused_match || has_changed) {
selection.state = OmniboxPopupSelection::NORMAL;
}
popup_selection_ = selection;
} else {
popup_selection_ = OmniboxPopupSelection(OmniboxPopupSelection::kNoMatch,
OmniboxPopupSelection::NORMAL);
}
popup_view_->UpdatePopupAppearance();
}
const SkBitmap* OmniboxEditModel::GetPopupRichSuggestionBitmap(
int result_index) const {
DCHECK(popup_view_);
const auto iter = rich_suggestion_bitmaps_.find(result_index);
if (iter == rich_suggestion_bitmaps_.end()) {
return nullptr;
}
return &iter->second;
}
const SkBitmap* OmniboxEditModel::GetPopupRichSuggestionBitmap(
const std::u16string& keyword) const {
DCHECK(popup_view_);
auto it = std::ranges::find_if(autocomplete_controller()->result(),
[&keyword](const AutocompleteMatch& match) {
return match.associated_keyword &&
match.associated_keyword->keyword ==
keyword;
});
return it == autocomplete_controller()->result().end()
? nullptr
: GetPopupRichSuggestionBitmap(std::distance(
autocomplete_controller()->result().begin(), it));
}
const SkBitmap* OmniboxEditModel::GetPopupRichSuggestionBitmap(
const GURL& image_url) const {
DCHECK(popup_view_);
auto iter =
std::ranges::find_if(autocomplete_controller()->result(),
[&image_url](const AutocompleteMatch& result_match) {
return (!result_match.ImageUrl().is_empty() &&
result_match.ImageUrl() == image_url);
});
return iter == autocomplete_controller()->result().end()
? nullptr
: GetPopupRichSuggestionBitmap(std::distance(
autocomplete_controller()->result().begin(), iter));
}
const SkBitmap* OmniboxEditModel::GetIconBitmap(const GURL& icon_url) const {
DCHECK(popup_view_);
auto iter = icon_bitmaps_.find(icon_url);
if (iter == icon_bitmaps_.end()) {
return nullptr;
}
return &iter->second;
}
void OmniboxEditModel::SetPopupRichSuggestionBitmap(int result_index,
const SkBitmap& bitmap) {
DCHECK(popup_view_);
rich_suggestion_bitmaps_[result_index] = bitmap;
popup_view_->UpdatePopupAppearance();
}
void OmniboxEditModel::SetIconBitmap(const GURL& icon_url,
const SkBitmap& bitmap) {
DCHECK(popup_view_ && !icon_url.is_empty());
icon_bitmaps_[icon_url] = bitmap;
popup_view_->UpdatePopupAppearance();
}
void OmniboxEditModel::SetAutocompleteInput(AutocompleteInput input) {
input_ = std::move(input);
}
PrefService* OmniboxEditModel::GetPrefService() {
return controller_->client()->GetPrefs();
}
const PrefService* OmniboxEditModel::GetPrefService() const {
return controller_->client()->GetPrefs();
}
AutocompleteController* OmniboxEditModel::autocomplete_controller() const {
return controller_->autocomplete_controller();
}
bool OmniboxEditModel::MaybeStartQueryForPopup() {
if (PopupIsOpen() || !autocomplete_controller()->done()) {
return false;
}
// The popup is neither open nor working on a query already. So, start an
// autocomplete query for the current text. This also sets
// `user_input_in_progress_` to true, which we want: if the user has started
// to interact with the popup, changing the `url_for_editing_` shouldn't
// change the displayed text.
// Note: This does not force the popup to open immediately.
// TODO(pkasting): We should, in fact, force this particular query to open
// the popup immediately.
if (!user_input_in_progress_)
InternalSetUserText(url_for_editing_);
if (view_) {
view_->UpdatePopup();
}
return true;
}
void OmniboxEditModel::StepPopupSelection(
OmniboxPopupSelection::Direction direction,
OmniboxPopupSelection::Step step) {
// NOTE: This purposefully doesn't trigger any code that resets
// `paste_state_`.
// The popup could be working on a query but is not open. In that case, force
// it to open immediately.
if (MaybeStartQueryForPopup() || !PopupIsOpen())
return;
// The popup is open, so the user should be able to interact with it normally.
// This block steps the popup selection, with special consideration for
// existing keyword logic in the edit model, where `ClearKeyword()` must be
// called before changing the selected line. `AcceptKeyword()` should be
// called after changing the selected line so we don't accept keyword on the
// wrong suggestion when stepping backwards.
const OmniboxPopupSelection old_selection = GetPopupSelection();
OmniboxPopupSelection new_selection = old_selection.GetNextSelection(
autocomplete_controller()->result(), GetPrefService(),
controller_->client()->GetTemplateURLService(), direction, step,
OmniboxFieldTrial::IsHideSuggestionGroupHeadersEnabledInContext(
GetPageClassification()));
if (kIsDesktop) {
if (old_selection.IsChangeToKeyword(new_selection)) {
ClearKeyword();
SetPopupSelection(new_selection);
} else if (new_selection.state ==
OmniboxPopupSelection::LineState::KEYWORD_MODE) {
// Prepare for keyword mode before accepting it.
SetPopupSelection(OmniboxPopupSelection(
new_selection.line, OmniboxPopupSelection::LineState::NORMAL));
// Note: Popup behavior currently depends on the entry method being tab.
// This is not ideal for nuanced metrics, but it is how it has worked
// for a long time. Consider refactoring to fix this if needed.
AcceptKeyword(metrics::OmniboxEventProto::TAB);
} else {
// If, as a result of the key press, we would select the first result,
// then we should revert the temporary text same as what pressing escape
// would have done.
//
// Reverting, however, does not make sense for on-focus suggestions
// (`user_input_in_progress_` is false) unless the first result is a
// verbatim match of the omnibox input (on-focus query refinements on
// SERP).
if (autocomplete_controller()->result().default_match() &&
has_temporary_text_ && new_selection == OmniboxPopupSelection(0) &&
(user_input_in_progress_ || autocomplete_controller()
->result()
.default_match()
->IsVerbatimType())) {
RevertTemporaryTextAndPopup();
} else {
SetPopupSelection(new_selection);
}
}
} else {
if (old_selection.IsChangeToKeyword(new_selection) ||
new_selection.IsChangeToKeyword(old_selection)) {
if (old_selection.IsChangeToKeyword(new_selection)) {
ClearKeyword();
}
SetPopupSelection(new_selection);
if (new_selection.IsChangeToKeyword(old_selection)) {
AcceptKeyword(metrics::OmniboxEventProto::TAB);
}
} else if (autocomplete_controller()->result().default_match() &&
has_temporary_text_ &&
new_selection == OmniboxPopupSelection{0} &&
(user_input_in_progress_ || autocomplete_controller()
->result()
.default_match()
->IsVerbatimType())) {
// If, as a result of the key press, we would select the first result,
// then we should revert the temporary text same as what pressing escape
// would have done.
//
// Reverting, however, does not make sense for on-focus suggestions
// (`user_input_in_progress_` is false) unless the first result is a
// verbatim match of the omnibox input (on-focus query refinements on
// SERP).
RevertTemporaryTextAndPopup();
} else {
SetPopupSelection(new_selection);
}
}
// `AcceptKeyword()` above updates the popup for the case where we step into
// keyword mode with extra user text, e.g. user input is "youtube.com query"
// then press tab to enter keyword mode. This is to ensure that the user text
// is populated accordingly and the new default suggestion is immediately
// clickable. In this case, the current selection (the clickable keyword
// suggestion) will not match the expected "next" suggestion (the keyword
// button focused).
if (new_selection.state != OmniboxPopupSelection::KEYWORD_MODE ||
user_text_.empty()) {
DCHECK(popup_selection_ == new_selection);
}
// Inform the client that a new row is now selected.
OnNavigationLikely(popup_selection_.line,
NavigationPredictor::kUpOrDownArrowButton);
}
void OmniboxEditModel::AcceptInput(WindowOpenDisposition disposition,
base::TimeTicks match_selection_timestamp) {
// Get the URL and transition type for the selected entry.
GURL alternate_nav_url;
AutocompleteMatch match = CurrentMatch(&alternate_nav_url);
// If CTRL is down it means the user wants to append ".com" to the text they
// typed. If we can successfully generate a URL_WHAT_YOU_TYPED match doing
// that, then we use this. These matches are marked as generated by the
// HistoryURLProvider so we only generate them if this provider is present.
bool accept_via_control_enter =
control_key_state_ == DOWN && !is_keyword_selected() &&
autocomplete_controller()->history_url_provider();
base::UmaHistogramBoolean("Omnibox.Search.CtrlEnter.Used",
accept_via_control_enter);
if (accept_via_control_enter) {
// For generating the hostname of the URL, we use the most recent
// input instead of the currently visible text. This means we'll ignore any
// visible inline autocompletion: if a user types "foo" and is autocompleted
// to "foodnetwork.com", ctrl-enter will navigate to "foo.com", not
// "foodnetwork.com". At the time of writing, this behavior matches
// Internet Explorer, but not Firefox. Two exceptions to our own rule:
// 1. If the user has selected a suggestion, use the suggestion text.
// 2. If the user has never edited the text, use the current page's full
// URL instead of the elided URL to avoid HTTPS downgrading.
std::u16string text_for_desired_tld_navigation = input_.text();
if (has_temporary_text_) {
text_for_desired_tld_navigation = GetText();
} else if (!user_input_in_progress()) {
text_for_desired_tld_navigation = url_for_editing_;
}
// Generate a new AutocompleteInput, copying the latest one but using "com"
// as the desired TLD. Then use this autocomplete input to generate a
// URL_WHAT_YOU_TYPED AutocompleteMatch.
AutocompleteInput input(
text_for_desired_tld_navigation, input_.cursor_position(), "com",
input_.current_page_classification(),
controller_->client()->GetSchemeClassifier(),
controller_->client()->ShouldDefaultTypedNavigationsToHttps(), 0,
false);
input.set_prevent_inline_autocomplete(input_.prevent_inline_autocomplete());
input.set_prefer_keyword(input_.prefer_keyword());
input.set_keyword_mode_entry_method(input_.keyword_mode_entry_method());
input.set_allow_exact_keyword_match(input_.allow_exact_keyword_match());
input.set_omit_asynchronous_matches(input_.omit_asynchronous_matches());
input.set_focus_type(input_.focus_type());
input_ = input;
AutocompleteMatch url_match(VerbatimMatchForInput(
autocomplete_controller()->history_url_provider(),
autocomplete_controller()->autocomplete_provider_client(), input_,
input_.canonicalized_url(), false));
base::UmaHistogramBoolean("Omnibox.Search.CtrlEnter.ResolvedAsUrl",
url_match.destination_url.is_valid());
if (url_match.destination_url.is_valid()) {
// We have a valid URL, we use this newly generated AutocompleteMatch.
match = url_match;
alternate_nav_url = GURL();
}
}
if (!match.destination_url.is_valid()) {
return;
}
if (paste_state_ != NONE &&
match.type == AutocompleteMatchType::URL_WHAT_YOU_TYPED) {
// When the user pasted in a URL and hit enter, score it like a link click
// rather than a normal typed URL, so it doesn't get inline autocompleted
// as aggressively later.
match.transition = ui::PAGE_TRANSITION_LINK;
}
if (popup_view_) {
OpenMatch(OmniboxPopupSelection(OmniboxPopupSelection::kNoMatch), match,
disposition, alternate_nav_url, std::u16string(),
match_selection_timestamp);
}
}
void OmniboxEditModel::OpenMatch(OmniboxPopupSelection selection,
AutocompleteMatch match,
WindowOpenDisposition disposition,
const GURL& alternate_nav_url,
const std::u16string& pasted_text,
base::TimeTicks match_selection_timestamp) {
// If the user is executing an action, this will be non-null and some match
// opening and metrics behavior will be adjusted accordingly.
OmniboxAction* action = nullptr;
if (selection.state == OmniboxPopupSelection::NORMAL &&
match.takeover_action) {
DCHECK(match_selection_timestamp != base::TimeTicks());
action = match.takeover_action.get();
} else if (selection.IsAction()) {
DCHECK_LT(selection.action_index, match.actions.size());
action = match.actions[selection.action_index].get();
}
// Invalid URLs such as chrome://history can end up here, but that's okay
// if the user is executing an action instead of navigating to the URL.
if (!match.destination_url.is_valid() && !action) {
return;
}
// NULL_RESULT_MESSAGE matches are informational only and cannot be acted
// upon. Immediately return when attempting to open one.
// When the toolbelt is enabled, a non-selectable match may still have
// selectable actions on it, and these can still be executed.
if (match.type == AutocompleteMatchType::NULL_RESULT_MESSAGE &&
(!omnibox_feature_configs::Toolbelt::Get().enabled || !action)) {
return;
}
// Switch the window disposition to SWITCH_TO_TAB for open tab matches that
// originated while in keyword mode. This is to support the keyword mode
// starter pack's tab search (@tabs) feature, which should open all
// suggestions in the existing open tab.
bool is_open_tab_match =
match.from_keyword &&
match.provider->type() == AutocompleteProvider::TYPE_OPEN_TAB;
// Also switch the window disposition for tab switch actions. The action
// itself will already open with SWITCH_TO_TAB disposition, but the change
// is needed earlier for metrics.
bool is_tab_switch_action =
action && action->ActionId() == OmniboxActionId::TAB_SWITCH;
if (is_open_tab_match || is_tab_switch_action) {
disposition = WindowOpenDisposition::SWITCH_TO_TAB;
}
TRACE_EVENT("omnibox", "OmniboxEditModel::OpenMatch", "match", match,
"disposition", disposition, "altenate_nav_url", alternate_nav_url,
"pasted_text", pasted_text);
const base::TimeTicks& now(base::TimeTicks::Now());
base::TimeDelta elapsed_time_since_user_first_modified_omnibox(
now - time_user_first_modified_omnibox_);
autocomplete_controller()
->UpdateMatchDestinationURLWithAdditionalSearchboxStats(
elapsed_time_since_user_first_modified_omnibox, &match);
GURL destination_url = action ? action->getUrl() : match.destination_url;
// Save the result of the interaction, but do not record the histogram yet.
focus_resulted_in_navigation_ = true;
omnibox::RecordActionShownForAllActions(autocomplete_controller()->result(),
selection);
HistoryFuzzyProvider::RecordOpenMatchMetrics(
autocomplete_controller()->result(), match);
std::u16string input_text(pasted_text);
if (input_text.empty()) {
input_text = user_input_in_progress_ ? user_text_ : url_for_editing_;
}
// Create a dummy AutocompleteInput for use in calling VerbatimMatchForInput()
// to create an alternate navigational match.
AutocompleteInput alternate_input(
input_text, GetPageClassification(),
controller_->client()->GetSchemeClassifier(),
controller_->client()->ShouldDefaultTypedNavigationsToHttps(), 0, false);
// Somehow we can occasionally get here with no active tab. It's not
// clear why this happens.
alternate_input.set_current_url(controller_->client()->GetURL());
alternate_input.set_current_title(controller_->client()->GetTitle());
base::TimeDelta elapsed_time_since_last_change_to_default_match(
now - autocomplete_controller()->last_time_default_match_changed());
DCHECK(match.provider);
// These elapsed times don't really make sense for matches that come from
// omnibox focus (because the user did not modify the omnibox), so for those
// we set the elapsed times to something that will be ignored by
// metrics_log.cc. They also don't necessarily make sense if the omnibox
// dropdown is closed or the user used paste-and-go. (In most
// cases when this happens, the user never modified the omnibox.)
const bool popup_open = PopupIsOpen();
const base::TimeDelta default_time_delta = base::Milliseconds(-1);
if (input_.IsZeroSuggest() || !pasted_text.empty()) {
elapsed_time_since_user_first_modified_omnibox = default_time_delta;
elapsed_time_since_last_change_to_default_match = default_time_delta;
}
base::TimeDelta elapsed_time_since_user_focused_omnibox = default_time_delta;
if (!last_omnibox_focus_.is_null()) {
elapsed_time_since_user_focused_omnibox = now - last_omnibox_focus_;
// Only record focus to open time when a focus actually happened (as
// opposed to, say, dragging a link onto the omnibox).
omnibox::LogFocusToOpenTime(
elapsed_time_since_user_focused_omnibox, input_.IsZeroSuggest(),
GetPageClassification(), match,
selection.IsAction() ? selection.action_index : -1);
}
// In some unusual cases, we ignore autocomplete_controller()->result() and
// instead log a fake result set with a single element (|match|) and
// selected_index of 0. For these cases:
// 1. If the popup is closed (there is no result set). This doesn't apply
// for WebUI searchboxes since they don't have an associated popup.
// 2. If the index is out of bounds. This should only happen if
// |selection.line| is
// kNoMatch, which can happen if the default search provider is disabled.
// 3. If this is paste-and-go (meaning the contents of the dropdown
// are ignored regardless).
const bool dropdown_ignored =
(!popup_open && !omnibox::IsWebUISearchbox(GetPageClassification())) ||
selection.line >= autocomplete_controller()->result().size() ||
!pasted_text.empty();
ACMatches fake_single_entry_matches;
fake_single_entry_matches.push_back(match);
AutocompleteResult fake_single_entry_result;
fake_single_entry_result.AppendMatches(fake_single_entry_matches);
std::u16string user_text =
input_.IsZeroSuggest() ? std::u16string() : input_text;
size_t completed_length = match.allowed_to_be_default_match
? match.inline_autocompletion.length()
: std::u16string::npos;
bool is_incognito = autocomplete_controller()
->autocomplete_provider_client()
->IsOffTheRecord();
OmniboxLog log(
user_text, just_deleted_text_, input_.type(), is_keyword_selected(),
keyword_mode_entry_method_, popup_open,
dropdown_ignored ? OmniboxPopupSelection(0) : selection, disposition,
!pasted_text.empty(),
SessionID::InvalidValue(), // don't know tab ID; set later if appropriate
GetPageClassification(), elapsed_time_since_user_first_modified_omnibox,
completed_length, elapsed_time_since_last_change_to_default_match,
dropdown_ignored ? fake_single_entry_result
: autocomplete_controller()->result(),
destination_url, is_incognito, input_.IsZeroSuggest(), match.session);
// Check disabled on iOS as the platform shows a default suggestion on focus
// (crbug.com/40061502).
#if !BUILDFLAG(IS_IOS)
DCHECK(dropdown_ignored ||
(log.elapsed_time_since_user_first_modified_omnibox >=
log.elapsed_time_since_last_change_to_default_match))
<< "We should've got the notification that the user modified the "
<< "omnibox text at same time or before the most recent time the "
<< "default match changed.";
#endif
log.elapsed_time_since_user_focused_omnibox =
elapsed_time_since_user_focused_omnibox;
log.ukm_source_id = controller_->client()->GetUKMSourceId();
if ((disposition == WindowOpenDisposition::CURRENT_TAB) &&
controller_->client()->CurrentPageExists()) {
// If we know the destination is being opened in the current tab,
// we can easily get the tab ID. (If it's being opened in a new
// tab, we don't know the tab ID yet.)
log.tab_id = controller_->client()->GetSessionID();
}
autocomplete_controller()->AddProviderAndTriggeringLogs(&log);
base::UmaHistogramEnumeration("Omnibox.SuggestionUsed.RichAutocompletion",
match.rich_autocompletion_triggered);
omnibox::LogIPv4PartsCount(user_text, destination_url, completed_length);
controller_->client()->OnURLOpenedFromOmnibox(&log);
OmniboxEventGlobalTracker::GetInstance()->OnURLOpened(&log);
LOCAL_HISTOGRAM_BOOLEAN("Omnibox.EventCount", true);
omnibox::answer_data_parser::LogAnswerUsed(match.answer_type);
TemplateURLService* service = controller_->client()->GetTemplateURLService();
TemplateURL* template_url = match.GetTemplateURL(service, false);
if (template_url) {
// |match| is a Search navigation or a URL navigation in keyword mode; log
// search engine usage metrics.
AutocompleteMatch::LogSearchEngineUsed(match, service);
if (ui::PageTransitionTypeIncludingQualifiersIs(
match.transition, ui::PAGE_TRANSITION_KEYWORD) ||
match.provider->type() ==
AutocompleteProvider::TYPE_UNSCOPED_EXTENSION) {
// User is in keyword mode or accepted an unscoped extension suggestion,
// increment usage count for the keyword.
base::RecordAction(base::UserMetricsAction("AcceptedKeyword"));
EmitAcceptedKeywordSuggestionHistogram(keyword_mode_entry_method_,
template_url);
controller_->client()->GetTemplateURLService()->IncrementUsageCount(
template_url);
// Notify the extension of the selected input, but ignore if the selection
// corresponds to an action created by an extension in unscoped mode.
if (template_url->type() == TemplateURL::OMNIBOX_API_EXTENSION &&
!action) {
controller_->client()->ProcessExtensionMatch(input_text, template_url,
match, disposition);
if (disposition != WindowOpenDisposition::NEW_BACKGROUND_TAB && view_) {
base::AutoReset<bool> tmp(&in_revert_, true);
view_->RevertAll();
}
// Avoid calling `OmniboxClient::OnAutocompleteAccept()`. The extension
// was notfied of the accepted input and will handle the navigation.
return;
}
} else {
DCHECK(ui::PageTransitionTypeIncludingQualifiersIs(
match.transition, ui::PAGE_TRANSITION_GENERATED) ||
ui::PageTransitionTypeIncludingQualifiersIs(
match.transition, ui::PAGE_TRANSITION_RELOAD));
// NOTE: We purposefully don't increment the usage count of the default
// search engine here like we do for explicit keywords above; see comments
// in template_url.h.
}
} else {
// |match| is a URL navigation, not a search.
// For logging the below histogram, only record uses that depend on the
// omnibox suggestion system, i.e., TYPED navigations. That is, exclude
// omnibox URL interactions that are treated as reloads or link-following
// (i.e., cut-and-paste of URLs) or paste-and-go.
if (ui::PageTransitionTypeIncludingQualifiersIs(
match.transition, ui::PAGE_TRANSITION_TYPED) &&
pasted_text.empty()) {
navigation_metrics::RecordOmniboxURLNavigation(destination_url);
}
// The following histograms should be recorded for both TYPED and pasted
// URLs, but should still exclude reloads.
if (ui::PageTransitionTypeIncludingQualifiersIs(
match.transition, ui::PAGE_TRANSITION_TYPED) ||
ui::PageTransitionTypeIncludingQualifiersIs(match.transition,
ui::PAGE_TRANSITION_LINK)) {
net::cookie_util::RecordCookiePortOmniboxHistograms(destination_url);
}
}
TemplateURLService* template_url_service =
controller_->client()->GetTemplateURLService();
if (action) {
OmniboxAction::ExecutionContext context(
*(autocomplete_controller()->autocomplete_provider_client()),
base::BindOnce(&OmniboxClient::OnAutocompleteAccept,
controller_->client()->AsWeakPtr()),
match_selection_timestamp, disposition);
action->Execute(context);
if (context.enter_starter_pack_id_ != 0 && template_url_service) {
if (const TemplateURL* starter_pack_turl =
template_url_service->FindStarterPackTemplateURL(
context.enter_starter_pack_id_)) {
// TODO(crbug.com/422575584): Use new KeywordModeEntryMethod.
EnterKeywordMode(
OmniboxEventProto::SELECT_SUGGESTION, starter_pack_turl,
AutocompleteMatch::GetKeywordPlaceholder(
starter_pack_turl,
controller_->client()->IsHistoryEmbeddingsEnabled()));
return;
}
}
}
if (disposition != WindowOpenDisposition::NEW_BACKGROUND_TAB && view_) {
base::AutoReset<bool> tmp(&in_revert_, true);
view_->RevertAll(); // Revert the box to its unedited state.
}
if (!action) {
// Track whether the destination URL sends us to a search results page
// using the default search provider.
if (template_url_service &&
template_url_service->IsSearchResultsPageFromDefaultSearchProvider(
match.destination_url)) {
base::RecordAction(
base::UserMetricsAction("OmniboxDestinationURLIsSearchOnDSP"));
base::UmaHistogramBoolean("Omnibox.Search.OffTheRecord", is_incognito);
}
BookmarkModel* bookmark_model = controller_->client()->GetBookmarkModel();
if (bookmark_model && bookmark_model->IsBookmarked(destination_url)) {
controller_->client()->OnBookmarkLaunched();
}
// This block should be the last call in OpenMatch, because controller_ is
// not guaranteed to exist after client()->OnAutocompleteAccept is called.
if (destination_url.is_valid()) {
// This calls RevertAll again.
base::AutoReset<bool> tmp(&in_revert_, true);
controller_->client()->OnAutocompleteAccept(
destination_url, match.post_content.get(), disposition,
ui::PageTransitionFromInt(match.transition |
ui::PAGE_TRANSITION_FROM_ADDRESS_BAR),
match.type, match_selection_timestamp,
input_.added_default_scheme_to_typed_url(),
input_.typed_url_had_http_scheme() &&
match.type == AutocompleteMatchType::URL_WHAT_YOU_TYPED,
input_text, match,
VerbatimMatchForInput(
autocomplete_controller()->history_url_provider(),
autocomplete_controller()->autocomplete_provider_client(),
alternate_input, alternate_nav_url, false));
}
}
}
void OmniboxEditModel::UpdateFeedbackOnMatch(size_t match_index,
FeedbackType feedback_type) {
if (match_index == OmniboxPopupSelection::kNoMatch ||
match_index >= autocomplete_controller()->result().size()) {
return;
}
auto& match = const_cast<AutocompleteMatch&>(
autocomplete_controller()->result().match_at(match_index));
// Set the feedback or reset it if the same feedback is given.
match.feedback_type = match.feedback_type == feedback_type
? FeedbackType::kNone
: feedback_type;
// Update the suggestion appearance.
popup_view_->UpdatePopupAppearance();
// Show the feedback form on negative feedback.
if (match.feedback_type == FeedbackType::kThumbsDown) {
controller_->client()->ShowFeedbackPage(
autocomplete_controller()->input().text(), match.destination_url);
}
}
bool OmniboxEditModel::AllowKeywordSpaceTriggering() const {
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
return GetPrefService()->GetBoolean(omnibox::kKeywordSpaceTriggeringEnabled);
#else
return true;
#endif
}
bool OmniboxEditModel::MaybeAcceptKeywordBySpace(
const std::u16string& new_text) {
if (!AllowKeywordSpaceTriggering())
return false;
size_t keyword_length = new_text.length() - 1;
return is_keyword_hint_ && (keyword_.length() == keyword_length) &&
IsSpaceCharForAcceptingKeyword(new_text[keyword_length]) &&
!new_text.compare(0, keyword_length, keyword_, 0, keyword_length) &&
AcceptKeyword(OmniboxEventProto::SPACE_AT_END);
}
bool OmniboxEditModel::CreatedKeywordSearchByInsertingSpaceInMiddle(
const std::u16string& old_text,
const std::u16string& new_text,
size_t caret_position) const {
DCHECK_GE(new_text.length(), caret_position);
// Check simple conditions first.
if ((paste_state_ != NONE) || (caret_position < 2) ||
(old_text.length() < caret_position) ||
(new_text.length() == caret_position))
return false;
size_t space_position = caret_position - 1;
if (!IsSpaceCharForAcceptingKeyword(new_text[space_position]) ||
base::IsUnicodeWhitespace(new_text[space_position - 1]) ||
new_text.compare(0, space_position, old_text, 0, space_position) ||
!new_text.compare(space_position, new_text.length() - space_position,
old_text, space_position,
old_text.length() - space_position)) {
return false;
}
// Then check if the text before the inserted space matches a keyword.
std::u16string keyword;
base::TrimWhitespace(new_text.substr(0, space_position), base::TRIM_LEADING,
&keyword);
return !keyword.empty() &&
!autocomplete_controller()
->keyword_provider()
->GetKeywordForText(
keyword, controller_->client()->GetTemplateURLService())
.empty();
}
// static
bool OmniboxEditModel::IsSpaceCharForAcceptingKeyword(wchar_t c) {
switch (c) {
case 0x0020: // Space
case 0x3000: // Ideographic Space
return true;
default:
return false;
}
}
void OmniboxEditModel::ClassifyString(const std::u16string& text,
AutocompleteMatch* match,
GURL* alternate_nav_url) const {
DCHECK(match);
controller_->client()->GetAutocompleteClassifier()->Classify(
text, false, false, GetPageClassification(), match, alternate_nav_url);
}
bool OmniboxEditModel::SetInputInProgressNoNotify(bool in_progress) {
if (user_input_in_progress_ == in_progress)
return false;
user_input_in_progress_ = in_progress;
if (user_input_in_progress_) {
time_user_first_modified_omnibox_ = base::TimeTicks::Now();
base::RecordAction(base::UserMetricsAction("OmniboxInputInProgress"));
autocomplete_controller()->ResetSession();
}
return true;
}
void OmniboxEditModel::NotifyObserversInputInProgress(bool in_progress) {
controller_->client()->OnInputInProgress(in_progress);
if (user_input_in_progress_ || !in_revert_)
controller_->client()->OnInputStateChanged();
}
void OmniboxEditModel::SetFocusState(OmniboxFocusState state,
OmniboxFocusChangeReason reason) {
if (state == focus_state_)
return;
// Update state and notify view if the omnibox has focus and the caret
// visibility changed.
const bool was_caret_visible = is_caret_visible();
focus_state_ = state;
if (focus_state_ != OMNIBOX_FOCUS_NONE &&
is_caret_visible() != was_caret_visible && view_) {
view_->ApplyCaretVisibility();
}
controller_->client()->OnFocusChanged(focus_state_, reason);
}
void OmniboxEditModel::OnFaviconFetched(const GURL& page_url,
const gfx::Image& icon) const {
if (icon.IsEmpty() || !PopupIsOpen()) {
return;
}
// Notify all affected matches.
for (size_t i = 0; i < autocomplete_controller()->result().size(); ++i) {
auto& match = autocomplete_controller()->result().match_at(i);
if (!AutocompleteMatch::IsSearchType(match.type) &&
match.destination_url == page_url) {
popup_view_->OnMatchIconUpdated(i);
}
}
}
std::u16string OmniboxEditModel::GetText() const {
// Once the model owns primary text, the check for `view_` won't be needed.
if (view_) {
return view_->GetText();
} else {
NOTREACHED();
}
}
void OmniboxEditModel::SetKeyword(const std::u16string& keyword) {
keyword_ = keyword;
}
void OmniboxEditModel::SetKeywordPlaceholder(
const std::u16string& keyword_placeholder) {
keyword_placeholder_ = keyword_placeholder;
}
|