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
|
<?php
declare(strict_types=1);
namespace PhpMyAdmin;
use PhpMyAdmin\Dbal\ResultInterface;
use PhpMyAdmin\Html\Generator;
use PhpMyAdmin\Html\MySQLDocumentation;
use PhpMyAdmin\Query\Compatibility;
use PhpMyAdmin\Query\Utilities;
use PhpMyAdmin\SqlParser\Components\Expression;
use PhpMyAdmin\SqlParser\Context;
use PhpMyAdmin\SqlParser\Token;
use PhpMyAdmin\Utils\SessionCache;
use Stringable;
use function __;
use function _pgettext;
use function abs;
use function array_key_exists;
use function array_map;
use function array_merge;
use function array_shift;
use function array_unique;
use function basename;
use function bin2hex;
use function chr;
use function count;
use function ctype_digit;
use function date;
use function decbin;
use function explode;
use function extension_loaded;
use function fclose;
use function floatval;
use function floor;
use function fread;
use function function_exists;
use function htmlentities;
use function htmlspecialchars;
use function htmlspecialchars_decode;
use function implode;
use function in_array;
use function ini_get;
use function is_array;
use function is_callable;
use function is_object;
use function is_scalar;
use function is_string;
use function log10;
use function mb_detect_encoding;
use function mb_strlen;
use function mb_strpos;
use function mb_strrpos;
use function mb_strstr;
use function mb_strtolower;
use function mb_substr;
use function number_format;
use function ord;
use function parse_url;
use function preg_match;
use function preg_quote;
use function preg_replace;
use function random_bytes;
use function range;
use function reset;
use function round;
use function rtrim;
use function set_time_limit;
use function sort;
use function sprintf;
use function str_contains;
use function str_getcsv;
use function str_pad;
use function str_replace;
use function strcasecmp;
use function strftime;
use function strlen;
use function strrev;
use function strtolower;
use function strtr;
use function substr;
use function time;
use function trim;
use function uksort;
use const ENT_COMPAT;
use const ENT_QUOTES;
use const PHP_INT_SIZE;
use const PHP_MAJOR_VERSION;
use const STR_PAD_LEFT;
/**
* Misc functions used all over the scripts.
*/
class Util
{
/**
* Checks whether configuration value tells to show icons.
*
* @param string $value Configuration option name
*/
public static function showIcons($value): bool
{
return in_array($GLOBALS['cfg'][$value], ['icons', 'both']);
}
/**
* Checks whether configuration value tells to show text.
*
* @param string $value Configuration option name
*/
public static function showText($value): bool
{
return in_array($GLOBALS['cfg'][$value], ['text', 'both']);
}
/**
* Returns the formatted maximum size for an upload
*
* @param int|float|string $maxUploadSize the size
*
* @return string the message
*/
public static function getFormattedMaximumUploadSize($maxUploadSize): string
{
// I have to reduce the second parameter (sensitiveness) from 6 to 4
// to avoid weird results like 512 kKib
[$maxSize, $maxUnit] = self::formatByteDown($maxUploadSize, 4);
return '(' . sprintf(__('Max: %s%s'), $maxSize, $maxUnit) . ')';
}
/**
* Add slashes before "_" and "%" characters for using them in MySQL
* database, table and field names.
* Note: This function does not escape backslashes!
*
* @param string $name the string to escape
*
* @return string the escaped string
*/
public static function escapeMysqlWildcards($name): string
{
return strtr($name, ['_' => '\\_', '%' => '\\%']);
}
/**
* removes slashes before "_" and "%" characters
* Note: This function does not unescape backslashes!
*
* @param string $name the string to escape
*
* @return string the escaped string
*/
public static function unescapeMysqlWildcards($name): string
{
return strtr($name, ['\\_' => '_', '\\%' => '%']);
}
/**
* removes quotes (',",`) from a quoted string
*
* checks if the string is quoted and removes this quotes
*
* @param string $quotedString string to remove quotes from
* @param string $quote type of quote to remove
*
* @return string unquoted string
*/
public static function unQuote(string $quotedString, ?string $quote = null): string
{
$quotes = [];
if ($quote === null) {
$quotes[] = '`';
$quotes[] = '"';
$quotes[] = "'";
} else {
$quotes[] = $quote;
}
foreach ($quotes as $quote) {
if (mb_substr($quotedString, 0, 1) === $quote && mb_substr($quotedString, -1, 1) === $quote) {
$unquotedString = mb_substr($quotedString, 1, -1);
// replace escaped quotes
$unquotedString = str_replace($quote . $quote, $quote, $unquotedString);
return $unquotedString;
}
}
return $quotedString;
}
/**
* Get a URL link to the official MySQL documentation
*
* @param string $link contains name of page/anchor that is being linked
* @param string $anchor anchor to page part
*
* @return string the URL link
*/
public static function getMySQLDocuURL(string $link, string $anchor = ''): string
{
global $dbi;
// Fixup for newly used names:
$link = str_replace('_', '-', mb_strtolower($link));
if (empty($link)) {
$link = 'index';
}
$mysql = '5.5';
$lang = 'en';
if (isset($dbi)) {
$serverVersion = $dbi->getVersion();
if ($serverVersion >= 80000) {
$mysql = '8.0';
} elseif ($serverVersion >= 50700) {
$mysql = '5.7';
} elseif ($serverVersion >= 50600) {
$mysql = '5.6';
} elseif ($serverVersion >= 50500) {
$mysql = '5.5';
}
}
$url = 'https://dev.mysql.com/doc/refman/'
. $mysql . '/' . $lang . '/' . $link . '.html';
if (! empty($anchor)) {
$url .= '#' . $anchor;
}
return Core::linkURL($url);
}
/**
* Get a URL link to the official documentation page of either MySQL
* or MariaDB depending on the database server
* of the user.
*
* @param bool $isMariaDB if the database server is MariaDB
*
* @return string The URL link
*/
public static function getDocuURL(bool $isMariaDB = false): string
{
if ($isMariaDB) {
$url = 'https://mariadb.com/kb/en/documentation/';
return Core::linkURL($url);
}
return self::getMySQLDocuURL('');
}
/**
* Check the correct row count
*
* @param string $db the db name
* @param array $table the table infos
*
* @return int the possibly modified row count
*/
private static function checkRowCount($db, array $table)
{
global $dbi;
$rowCount = 0;
if ($table['Rows'] === null) {
// Do not check exact row count here,
// if row count is invalid possibly the table is defect
// and this would break the navigation panel;
// but we can check row count if this is a view or the
// information_schema database
// since Table::countRecords() returns a limited row count
// in this case.
// set this because Table::countRecords() can use it
$tableIsView = $table['TABLE_TYPE'] === 'VIEW';
if ($tableIsView || Utilities::isSystemSchema($db)) {
$rowCount = $dbi
->getTable($db, $table['Name'])
->countRecords();
}
}
return $rowCount;
}
/**
* returns array with tables of given db with extended information and grouped
*
* @param string $db
*
* @return array (recursive) grouped table list
*/
public static function getTableList($db): array
{
global $dbi;
$sep = $GLOBALS['cfg']['NavigationTreeTableSeparator'];
$tables = $dbi->getTablesFull($db);
if ($GLOBALS['cfg']['NaturalOrder']) {
uksort($tables, 'strnatcasecmp');
}
if (count($tables) < 1) {
return $tables;
}
$default = [
'Name' => '',
'Rows' => 0,
'Comment' => '',
'disp_name' => '',
];
$tableGroups = [];
foreach ($tables as $table) {
/** @var string $tableName */
$tableName = $table['TABLE_NAME'];
$table['Rows'] = self::checkRowCount($db, $table);
// in $group we save the reference to the place in $table_groups
// where to store the table info
if ($GLOBALS['cfg']['NavigationTreeEnableGrouping'] && $sep && mb_strstr($tableName, $sep)) {
$parts = explode($sep, $tableName);
$group =& $tableGroups;
$i = 0;
$groupNameFull = '';
$partsCount = count($parts) - 1;
while (($i < $partsCount) && ($i < $GLOBALS['cfg']['NavigationTreeTableLevel'])) {
$groupName = $parts[$i] . $sep;
$groupNameFull .= $groupName;
if (! isset($group[$groupName])) {
$group[$groupName] = [];
$group[$groupName]['is' . $sep . 'group'] = true;
$group[$groupName]['tab' . $sep . 'count'] = 1;
$group[$groupName]['tab' . $sep . 'group'] = $groupNameFull;
} elseif (! isset($group[$groupName]['is' . $sep . 'group'])) {
$table = $group[$groupName];
$group[$groupName] = [];
$group[$groupName][$groupName] = $table;
$group[$groupName]['is' . $sep . 'group'] = true;
$group[$groupName]['tab' . $sep . 'count'] = 1;
$group[$groupName]['tab' . $sep . 'group'] = $groupNameFull;
} else {
$group[$groupName]['tab' . $sep . 'count']++;
}
$group =& $group[$groupName];
$i++;
}
} else {
if (! isset($tableGroups[$tableName])) {
$tableGroups[$tableName] = [];
}
$group =& $tableGroups;
}
$table['disp_name'] = $table['Name'];
$group[$tableName] = array_merge($default, $table);
}
return $tableGroups;
}
/* ----------------------- Set of misc functions ----------------------- */
/**
* Adds backquotes on both sides of a database, table or field name.
* and escapes backquotes inside the name with another backquote
*
* example:
* <code>
* echo backquote('owner`s db'); // `owner``s db`
*
* </code>
*
* @param Stringable|string|null $identifier the database, table or field name to "backquote"
*/
public static function backquote($identifier): string
{
return static::backquoteCompat($identifier, 'NONE', true);
}
/**
* Adds backquotes on both sides of a database, table or field name.
* in compatibility mode
*
* example:
* <code>
* echo backquoteCompat('owner`s db'); // `owner``s db`
*
* </code>
*
* @param Stringable|string|null $identifier the database, table or field name to "backquote"
* @param string $compatibility string compatibility mode (used by dump functions)
* @param bool|null $doIt a flag to bypass this function (used by dump functions)
*/
public static function backquoteCompat(
$identifier,
string $compatibility = 'MSSQL',
$doIt = true
): string {
$identifier = (string) $identifier;
if ($identifier === '' || $identifier === '*') {
return $identifier;
}
if (! $doIt && ! ((int) Context::isKeyword($identifier) & Token::FLAG_KEYWORD_RESERVED)) {
return $identifier;
}
$quote = '`';
$escapeChar = '`';
if ($compatibility === 'MSSQL') {
$quote = '"';
$escapeChar = '\\';
}
return $quote . str_replace($quote, $escapeChar . $quote, $identifier) . $quote;
}
/**
* Formats $value to byte view
*
* @param float|int|string|null $value the value to format
* @param int $limes the sensitiveness
* @param int $comma the number of decimals to retain
*
* @return array|null the formatted value and its unit
*/
public static function formatByteDown($value, $limes = 6, $comma = 0): ?array
{
if ($value === null) {
return null;
}
if (is_string($value)) {
$value = (float) $value;
}
$byteUnits = [
/* l10n: shortcuts for Byte */
__('B'),
/* l10n: shortcuts for Kilobyte */
__('KiB'),
/* l10n: shortcuts for Megabyte */
__('MiB'),
/* l10n: shortcuts for Gigabyte */
__('GiB'),
/* l10n: shortcuts for Terabyte */
__('TiB'),
/* l10n: shortcuts for Petabyte */
__('PiB'),
/* l10n: shortcuts for Exabyte */
__('EiB'),
];
$dh = 10 ** $comma;
$li = 10 ** $limes;
$unit = $byteUnits[0];
for ($d = 6, $ex = 15; $d >= 1; $d--, $ex -= 3) {
$unitSize = $li * 10 ** $ex;
if (isset($byteUnits[$d]) && $value >= $unitSize) {
// use 1024.0 to avoid integer overflow on 64-bit machines
$value = round($value / (1024 ** $d / $dh)) / $dh;
$unit = $byteUnits[$d];
break 1;
}
}
if ($unit != $byteUnits[0]) {
// if the unit is not bytes (as represented in current language)
// reformat with max length of 5
// 4th parameter=true means do not reformat if value < 1
$returnValue = self::formatNumber($value, 5, $comma, true, false);
} else {
// do not reformat, just handle the locale
$returnValue = self::formatNumber($value, 0);
}
return [
trim($returnValue),
$unit,
];
}
/**
* Formats $value to the given length and appends SI prefixes
* with a $length of 0 no truncation occurs, number is only formatted
* to the current locale
*
* examples:
* <code>
* echo formatNumber(123456789, 6); // 123,457 k
* echo formatNumber(-123456789, 4, 2); // -123.46 M
* echo formatNumber(-0.003, 6); // -3 m
* echo formatNumber(0.003, 3, 3); // 0.003
* echo formatNumber(0.00003, 3, 2); // 0.03 m
* echo formatNumber(0, 6); // 0
* </code>
*
* @param float|int|string $value the value to format
* @param int $digitsLeft number of digits left of the comma
* @param int $digitsRight number of digits right of the comma
* @param bool $onlyDown do not reformat numbers below 1
* @param bool $noTrailingZero removes trailing zeros right of the comma (default: true)
*
* @return string the formatted value and its unit
*/
public static function formatNumber(
$value,
$digitsLeft = 3,
$digitsRight = 0,
$onlyDown = false,
$noTrailingZero = true
) {
if ($value == 0) {
return '0';
}
if (is_string($value)) {
$value = (float) $value;
}
$originalValue = $value;
//number_format is not multibyte safe, str_replace is safe
if ($digitsLeft === 0) {
$value = number_format(
(float) $value,
$digitsRight,
/* l10n: Decimal separator */
__('.'),
/* l10n: Thousands separator */
__(',')
);
if (($originalValue != 0) && (floatval($value) == 0)) {
$value = ' <' . (1 / 10 ** $digitsRight);
}
return $value;
}
// this units needs no translation, ISO
$units = [
-8 => 'y',
-7 => 'z',
-6 => 'a',
-5 => 'f',
-4 => 'p',
-3 => 'n',
-2 => 'µ',
-1 => 'm',
0 => ' ',
1 => 'k',
2 => 'M',
3 => 'G',
4 => 'T',
5 => 'P',
6 => 'E',
7 => 'Z',
8 => 'Y',
];
/* l10n: Decimal separator */
$decimalSep = __('.');
/* l10n: Thousands separator */
$thousandsSep = __(',');
// check for negative value to retain sign
if ($value < 0) {
$sign = '-';
$value = abs($value);
} else {
$sign = '';
}
$dh = 10 ** $digitsRight;
/*
* This gives us the right SI prefix already,
* but $digits_left parameter not incorporated
*/
$d = floor(log10((float) $value) / 3);
/*
* Lowering the SI prefix by 1 gives us an additional 3 zeros
* So if we have 3,6,9,12.. free digits ($digits_left - $cur_digits)
* to use, then lower the SI prefix
*/
$curDigits = floor(log10($value / 1000 ** $d) + 1);
if ($digitsLeft > $curDigits) {
$d -= floor(($digitsLeft - $curDigits) / 3);
}
if ($d < 0 && $onlyDown) {
$d = 0;
}
$value = round($value / (1000 ** $d / $dh)) / $dh;
$unit = $units[$d];
// number_format is not multibyte safe, str_replace is safe
$formattedValue = number_format($value, $digitsRight, $decimalSep, $thousandsSep);
// If we don't want any zeros, remove them now
if ($noTrailingZero && str_contains($formattedValue, $decimalSep)) {
$formattedValue = preg_replace('/' . preg_quote($decimalSep, '/') . '?0+$/', '', $formattedValue);
}
if ($originalValue != 0 && floatval($value) == 0) {
return ' <' . number_format(1 / 10 ** $digitsRight, $digitsRight, $decimalSep, $thousandsSep) . ' ' . $unit;
}
return $sign . $formattedValue . ' ' . $unit;
}
/**
* Returns the number of bytes when a formatted size is given
*
* @param string|int $formattedSize the size expression (for example 8MB)
*
* @return int|float The numerical part of the expression (for example 8)
*/
public static function extractValueFromFormattedSize($formattedSize)
{
$returnValue = -1;
$formattedSize = (string) $formattedSize;
if (preg_match('/^[0-9]+GB$/', $formattedSize)) {
$returnValue = (int) mb_substr($formattedSize, 0, -2) * 1024 ** 3;
} elseif (preg_match('/^[0-9]+MB$/', $formattedSize)) {
$returnValue = (int) mb_substr($formattedSize, 0, -2) * 1024 ** 2;
} elseif (preg_match('/^[0-9]+K$/', $formattedSize)) {
$returnValue = (int) mb_substr($formattedSize, 0, -1) * 1024 ** 1;
}
return $returnValue;
}
/**
* Writes localised date
*
* @param int $timestamp the current timestamp
* @param string $format format
*
* @return string the formatted date
*/
public static function localisedDate($timestamp = -1, $format = '')
{
$month = [
/* l10n: Short month name */
__('Jan'),
/* l10n: Short month name */
__('Feb'),
/* l10n: Short month name */
__('Mar'),
/* l10n: Short month name */
__('Apr'),
/* l10n: Short month name */
_pgettext('Short month name', 'May'),
/* l10n: Short month name */
__('Jun'),
/* l10n: Short month name */
__('Jul'),
/* l10n: Short month name */
__('Aug'),
/* l10n: Short month name */
__('Sep'),
/* l10n: Short month name */
__('Oct'),
/* l10n: Short month name */
__('Nov'),
/* l10n: Short month name */
__('Dec'),
];
$dayOfWeek = [
/* l10n: Short week day name for Sunday */
_pgettext('Short week day name for Sunday', 'Sun'),
/* l10n: Short week day name for Monday */
__('Mon'),
/* l10n: Short week day name for Tuesday */
__('Tue'),
/* l10n: Short week day name for Wednesday */
__('Wed'),
/* l10n: Short week day name for Thursday */
__('Thu'),
/* l10n: Short week day name for Friday */
__('Fri'),
/* l10n: Short week day name for Saturday */
__('Sat'),
];
if ($format == '') {
/* l10n: See https://www.php.net/manual/en/function.strftime.php */
$format = __('%B %d, %Y at %I:%M %p');
}
if ($timestamp == -1) {
$timestamp = time();
}
$date = (string) preg_replace(
'@%[aA]@',
$dayOfWeek[(int) @strftime('%w', (int) $timestamp)],
$format
);
$date = (string) preg_replace(
'@%[bB]@',
$month[(int) @strftime('%m', (int) $timestamp) - 1],
$date
);
/* Fill in AM/PM */
$hours = (int) date('H', (int) $timestamp);
if ($hours >= 12) {
$amPm = _pgettext('AM/PM indication in time', 'PM');
} else {
$amPm = _pgettext('AM/PM indication in time', 'AM');
}
$date = (string) preg_replace('@%[pP]@', $amPm, $date);
// Can return false on windows for Japanese language
// See https://github.com/phpmyadmin/phpmyadmin/issues/15830
$ret = @strftime($date, (int) $timestamp);
// Some OSes such as Win8.1 Traditional Chinese version did not produce UTF-8
// output here. See https://github.com/phpmyadmin/phpmyadmin/issues/10598
if ($ret === false || mb_detect_encoding($ret, 'UTF-8', true) !== 'UTF-8') {
$ret = date('Y-m-d H:i:s', (int) $timestamp);
}
return $ret;
}
/**
* Splits a URL string by parameter
*
* @param string $url the URL
*
* @return array<int, string> the parameter/value pairs, for example [0] db=sakila
*/
public static function splitURLQuery($url): array
{
// decode encoded url separators
$separator = Url::getArgSeparator();
// on most places separator is still hard coded ...
if ($separator !== '&') {
// ... so always replace & with $separator
$url = str_replace([htmlentities('&'), '&'], [$separator, $separator], $url);
}
$url = str_replace(htmlentities($separator), $separator, $url);
// end decode
$urlParts = parse_url($url);
if (is_array($urlParts) && isset($urlParts['query']) && strlen($separator) > 0) {
return explode($separator, $urlParts['query']);
}
return [];
}
/**
* Returns a given timespan value in a readable format.
*
* @param int $seconds the timespan
*
* @return string the formatted value
*/
public static function timespanFormat($seconds): string
{
$days = floor($seconds / 86400);
if ($days > 0) {
$seconds -= $days * 86400;
}
$hours = floor($seconds / 3600);
if ($days > 0 || $hours > 0) {
$seconds -= $hours * 3600;
}
$minutes = floor($seconds / 60);
if ($days > 0 || $hours > 0 || $minutes > 0) {
$seconds -= $minutes * 60;
}
return sprintf(
__('%s days, %s hours, %s minutes and %s seconds'),
(string) $days,
(string) $hours,
(string) $minutes,
(string) $seconds
);
}
/**
* Function added to avoid path disclosures.
* Called by each script that needs parameters, it displays
* an error message and, by default, stops the execution.
*
* @param string[] $params The names of the parameters needed by the calling
* script
* @param bool $request Check parameters in request
*/
public static function checkParameters($params, $request = false): void
{
$reportedScriptName = basename($GLOBALS['PMA_PHP_SELF']);
$foundError = false;
$errorMessage = '';
if ($request) {
$array = $_REQUEST;
} else {
$array = $GLOBALS;
}
foreach ($params as $param) {
if (isset($array[$param])) {
continue;
}
$errorMessage .= $reportedScriptName
. ': ' . __('Missing parameter:') . ' '
. $param
. MySQLDocumentation::showDocumentation('faq', 'faqmissingparameters', true)
. '[br]';
$foundError = true;
}
if (! $foundError) {
return;
}
Core::fatalError($errorMessage);
}
/**
* Build a condition and with a value
*
* @param string|int|float|null $row The row value
* @param FieldMetadata $meta The field metadata
* @param int $fieldsCount A number of fields
* @param string $conditionKey A key used for BINARY fields functions
* @param string $condition The condition
*
* @return array<int,string|null>
* @psalm-return array{string|null, string}
*/
private static function getConditionValue(
$row,
FieldMetadata $meta,
int $fieldsCount,
string $conditionKey,
string $condition
): array {
global $dbi;
if ($row === null) {
return ['IS NULL', $condition];
}
$conditionValue = '';
$isBinaryString = $meta->isType(FieldMetadata::TYPE_STRING) && $meta->isBinary();
// 63 is the binary charset, see: https://dev.mysql.com/doc/internals/en/charsets.html
$isBlobAndIsBinaryCharset = $meta->isType(FieldMetadata::TYPE_BLOB) && $meta->charsetnr === 63;
if ($meta->isNumeric) {
$conditionValue = '= ' . $row;
} elseif ($isBlobAndIsBinaryCharset || (! empty($row) && $isBinaryString)) {
// hexify only if this is a true not empty BLOB or a BINARY
// do not waste memory building a too big condition
$rowLength = mb_strlen((string) $row);
if ($rowLength > 0 && $rowLength < 1000) {
// use a CAST if possible, to avoid problems
// if the field contains wildcard characters % or _
$conditionValue = '= CAST(0x' . bin2hex((string) $row) . ' AS BINARY)';
} elseif ($fieldsCount === 1) {
// when this blob is the only field present
// try settling with length comparison
$condition = ' CHAR_LENGTH(' . $conditionKey . ') ';
$conditionValue = ' = ' . $rowLength;
} else {
// this blob won't be part of the final condition
$conditionValue = null;
}
} elseif ($meta->isMappedTypeGeometry && ! empty($row)) {
// do not build a too big condition
if (mb_strlen((string) $row) < 5000) {
$condition .= '= CAST(0x' . bin2hex((string) $row) . ' AS BINARY)';
} else {
$condition = '';
}
} elseif ($meta->isMappedTypeBit) {
$conditionValue = "= b'"
. self::printableBitValue((int) $row, (int) $meta->length) . "'";
} else {
$conditionValue = '= \''
. $dbi->escapeString((string) $row) . '\'';
}
return [$conditionValue, $condition];
}
/**
* Function to generate unique condition for specified row.
*
* @param int $fieldsCount number of fields
* @param FieldMetadata[] $fieldsMeta meta information about fields
* @param array $row current row
* @param bool $forceUnique generate condition only on pk or unique
* @param string|bool $restrictToTable restrict the unique condition to this table or false if none
* @param Expression[] $expressions An array of Expression instances.
* @psalm-param array<int, mixed> $row
*
* @return array the calculated condition and whether condition is unique
*/
public static function getUniqueCondition(
$fieldsCount,
array $fieldsMeta,
array $row,
$forceUnique = false,
$restrictToTable = false,
array $expressions = []
): array {
global $dbi;
$primaryKey = '';
$uniqueKey = '';
$nonPrimaryCondition = '';
$preferredCondition = '';
$primaryKeyArray = [];
$uniqueKeyArray = [];
$nonPrimaryConditionArray = [];
$conditionArray = [];
for ($i = 0; $i < $fieldsCount; ++$i) {
$meta = $fieldsMeta[$i];
// do not use a column alias in a condition
if ($meta->orgname === '') {
$meta->orgname = $meta->name;
foreach ($expressions as $expression) {
if (empty($expression->alias) || empty($expression->column)) {
continue;
}
if (strcasecmp($meta->name, $expression->alias) == 0) {
$meta->orgname = $expression->column;
break;
}
}
}
// Do not use a table alias in a condition.
// Test case is:
// select * from galerie x WHERE
//(select count(*) from galerie y where y.datum=x.datum)>1
//
// But orgtable is present only with mysqli extension so the
// fix is only for mysqli.
// Also, do not use the original table name if we are dealing with
// a view because this view might be updatable.
// (The isView() verification should not be costly in most cases
// because there is some caching in the function).
if (
$meta->table !== $meta->orgtable
&& ! $dbi->getTable($GLOBALS['db'], $meta->table)->isView()
) {
$meta->table = $meta->orgtable;
}
// If this field is not from the table which the unique clause needs
// to be restricted to.
if ($restrictToTable && $restrictToTable != $meta->table) {
continue;
}
// to fix the bug where float fields (primary or not)
// can't be matched because of the imprecision of
// floating comparison, use CONCAT
// (also, the syntax "CONCAT(field) IS NULL"
// that we need on the next "if" will work)
if ($meta->isType(FieldMetadata::TYPE_REAL)) {
$conKey = 'CONCAT(' . self::backquote($meta->table) . '.'
. self::backquote($meta->orgname) . ')';
} else {
$conKey = self::backquote($meta->table) . '.'
. self::backquote($meta->orgname);
}
$condition = ' ' . $conKey . ' ';
[$conVal, $condition] = self::getConditionValue($row[$i] ?? null, $meta, $fieldsCount, $conKey, $condition);
if ($conVal === null) {
continue;
}
$condition .= $conVal . ' AND';
if ($meta->isPrimaryKey()) {
$primaryKey .= $condition;
$primaryKeyArray[$conKey] = $conVal;
} elseif ($meta->isUniqueKey()) {
$uniqueKey .= $condition;
$uniqueKeyArray[$conKey] = $conVal;
}
$nonPrimaryCondition .= $condition;
$nonPrimaryConditionArray[$conKey] = $conVal;
}
// Correction University of Virginia 19991216:
// prefer primary or unique keys for condition,
// but use conjunction of all values if no primary key
$clauseIsUnique = true;
if ($primaryKey) {
$preferredCondition = $primaryKey;
$conditionArray = $primaryKeyArray;
} elseif ($uniqueKey) {
$preferredCondition = $uniqueKey;
$conditionArray = $uniqueKeyArray;
} elseif (! $forceUnique) {
$preferredCondition = $nonPrimaryCondition;
$conditionArray = $nonPrimaryConditionArray;
$clauseIsUnique = false;
}
$whereClause = trim((string) preg_replace('|\s?AND$|', '', $preferredCondition));
return [
$whereClause,
$clauseIsUnique,
$conditionArray,
];
}
/**
* Generate the charset query part
*
* @param string $collation Collation
* @param bool $override (optional) force 'CHARACTER SET' keyword
*/
public static function getCharsetQueryPart(string $collation, bool $override = false): string
{
[$charset] = explode('_', $collation);
$keyword = ' CHARSET=';
if ($override) {
$keyword = ' CHARACTER SET ';
}
return $keyword . $charset
. ($charset == $collation ? '' : ' COLLATE ' . $collation);
}
/**
* Generate a pagination selector for browsing resultsets
*
* @param string $name The name for the request parameter
* @param int $rows Number of rows in the pagination set
* @param int $pageNow current page number
* @param int $nbTotalPage number of total pages
* @param int $showAll If the number of pages is lower than this
* variable, no pages will be omitted in pagination
* @param int $sliceStart How many rows at the beginning should always
* be shown?
* @param int $sliceEnd How many rows at the end should always be shown?
* @param int $percent Percentage of calculation page offsets to hop to a
* next page
* @param int $range Near the current page, how many pages should
* be considered "nearby" and displayed as well?
* @param string $prompt The prompt to display (sometimes empty)
*/
public static function pageselector(
$name,
$rows,
$pageNow = 1,
$nbTotalPage = 1,
$showAll = 200,
$sliceStart = 5,
$sliceEnd = 5,
$percent = 20,
$range = 10,
$prompt = ''
): string {
$increment = floor($nbTotalPage / $percent);
$pageNowMinusRange = $pageNow - $range;
$pageNowPlusRange = $pageNow + $range;
$gotoPage = $prompt . ' <select class="pageselector ajax"';
$gotoPage .= ' name="' . $name . '" >';
if ($nbTotalPage < $showAll) {
$pages = range(1, $nbTotalPage);
} else {
$pages = [];
// Always show first X pages
for ($i = 1; $i <= $sliceStart; $i++) {
$pages[] = $i;
}
// Always show last X pages
for ($i = $nbTotalPage - $sliceEnd; $i <= $nbTotalPage; $i++) {
$pages[] = $i;
}
// Based on the number of results we add the specified
// $percent percentage to each page number,
// so that we have a representing page number every now and then to
// immediately jump to specific pages.
// As soon as we get near our currently chosen page ($pageNow -
// $range), every page number will be shown.
$i = $sliceStart;
$x = $nbTotalPage - $sliceEnd;
$metBoundary = false;
while ($i <= $x) {
if ($i >= $pageNowMinusRange && $i <= $pageNowPlusRange) {
// If our pageselector comes near the current page, we use 1
// counter increments
$i++;
$metBoundary = true;
} else {
// We add the percentage increment to our current page to
// hop to the next one in range
$i += $increment;
// Make sure that we do not cross our boundaries.
if ($i > $pageNowMinusRange && ! $metBoundary) {
$i = $pageNowMinusRange;
}
}
if ($i <= 0 || $i > $x) {
continue;
}
$pages[] = $i;
}
/*
Add page numbers with "geometrically increasing" distances.
This helps me a lot when navigating through giant tables.
Test case: table with 2.28 million sets, 76190 pages. Page of interest
is between 72376 and 76190.
Selecting page 72376.
Now, old version enumerated only +/- 10 pages around 72376 and the
percentage increment produced steps of about 3000.
The following code adds page numbers +/- 2,4,8,16,32,64,128,256 etc.
around the current page.
*/
$i = $pageNow;
$dist = 1;
while ($i < $x) {
$dist = 2 * $dist;
$i = $pageNow + $dist;
if ($i <= 0 || $i > $x) {
continue;
}
$pages[] = $i;
}
$i = $pageNow;
$dist = 1;
while ($i > 0) {
$dist = 2 * $dist;
$i = $pageNow - $dist;
if ($i <= 0 || $i > $x) {
continue;
}
$pages[] = $i;
}
// Since because of ellipsing of the current page some numbers may be
// double, we unify our array:
sort($pages);
$pages = array_unique($pages);
}
if ($pageNow > $nbTotalPage) {
$pages[] = $pageNow;
}
foreach ($pages as $i) {
if ($i == $pageNow) {
$selected = 'selected="selected" style="font-weight: bold"';
} else {
$selected = '';
}
$gotoPage .= ' <option ' . $selected
. ' value="' . (($i - 1) * $rows) . '">' . $i . '</option>' . "\n";
}
$gotoPage .= ' </select>';
return $gotoPage;
}
/**
* Calculate page number through position
*
* @param int $pos position of first item
* @param int $maxCount number of items per page
*
* @return int $page_num
*/
public static function getPageFromPosition($pos, $maxCount)
{
return (int) floor($pos / $maxCount) + 1;
}
/**
* replaces %u in given path with current user name
*
* example:
* <code>
* $user_dir = userDir('/var/pma_tmp/%u/'); // '/var/pma_tmp/root/'
*
* </code>
*
* @param string $dir with wildcard for user
*
* @return string per user directory
*/
public static function userDir(string $dir): string
{
// add trailing slash
if (mb_substr($dir, -1) !== '/') {
$dir .= '/';
}
return str_replace('%u', Core::securePath($GLOBALS['cfg']['Server']['user']), $dir);
}
/**
* Clears cache content which needs to be refreshed on user change.
*/
public static function clearUserCache(): void
{
SessionCache::remove('is_superuser');
SessionCache::remove('is_createuser');
SessionCache::remove('is_grantuser');
SessionCache::remove('mysql_cur_user');
SessionCache::remove('mysql_cur_role');
}
/**
* Converts a bit value to printable format;
* in MySQL a BIT field can be from 1 to 64 bits so we need this
* function because in PHP, decbin() supports only 32 bits
* on 32-bit servers
*
* @param int $value coming from a BIT field
* @param int $length length
*
* @return string the printable value
*/
public static function printableBitValue(int $value, int $length): string
{
// if running on a 64-bit server or the length is safe for decbin()
if (PHP_INT_SIZE == 8 || $length < 33) {
$printable = decbin($value);
} else {
// FIXME: does not work for the leftmost bit of a 64-bit value
$i = 0;
$printable = '';
while ($value >= 2 ** $i) {
++$i;
}
if ($i != 0) {
--$i;
}
while ($i >= 0) {
if ($value - 2 ** $i < 0) {
$printable = '0' . $printable;
} else {
$printable = '1' . $printable;
$value -= 2 ** $i;
}
--$i;
}
$printable = strrev($printable);
}
$printable = str_pad($printable, $length, '0', STR_PAD_LEFT);
return $printable;
}
/**
* Converts a BIT type default value
* for example, b'010' becomes 010
*
* @param string|null $bitDefaultValue value
*
* @return string the converted value
*/
public static function convertBitDefaultValue(?string $bitDefaultValue): string
{
return (string) preg_replace(
"/^b'(\d*)'?$/",
'$1',
htmlspecialchars_decode((string) $bitDefaultValue, ENT_QUOTES),
1
);
}
/**
* Extracts the various parts from a column spec
*
* @param string $columnSpecification Column specification
*
* @return array associative array containing type, spec_in_brackets
* and possibly enum_set_values (another array)
*/
public static function extractColumnSpec($columnSpecification)
{
$firstBracketPos = mb_strpos($columnSpecification, '(');
if ($firstBracketPos) {
$specInBrackets = rtrim(
mb_substr(
$columnSpecification,
$firstBracketPos + 1,
mb_strrpos($columnSpecification, ')') - $firstBracketPos - 1
)
);
// convert to lowercase just to be sure
$type = mb_strtolower(
rtrim(mb_substr($columnSpecification, 0, $firstBracketPos))
);
} else {
// Split trailing attributes such as unsigned,
// binary, zerofill and get data type name
$typeParts = explode(' ', $columnSpecification);
$type = mb_strtolower($typeParts[0]);
$specInBrackets = '';
}
if ($type === 'enum' || $type === 'set') {
// Define our working vars
$enumSetValues = self::parseEnumSetValues($columnSpecification, false);
$printType = $type
. '(' . str_replace("','", "', '", $specInBrackets) . ')';
$binary = false;
$unsigned = false;
$zerofill = false;
$compressed = false;
} else {
$enumSetValues = [];
/* Create printable type name */
$printType = mb_strtolower($columnSpecification);
// Strip the "BINARY" attribute, except if we find "BINARY(" because
// this would be a BINARY or VARBINARY column type;
// by the way, a BLOB should not show the BINARY attribute
// because this is not accepted in MySQL syntax.
if (str_contains($printType, 'binary') && ! preg_match('@binary[\(]@', $printType)) {
$printType = str_replace('binary', '', $printType);
$binary = true;
} else {
$binary = false;
}
$printType = (string) preg_replace('@zerofill@', '', $printType, -1, $zerofillCount);
$zerofill = ($zerofillCount > 0);
$printType = (string) preg_replace('@unsigned@', '', $printType, -1, $unsignedCount);
$unsigned = ($unsignedCount > 0);
$printType = (string) preg_replace('@\/\*!100301 compressed\*\/@', '', $printType, -1, $compressedCount);
$compressed = ($compressedCount > 0);
$printType = trim($printType);
}
$attribute = ' ';
if ($binary) {
$attribute = 'BINARY';
}
if ($unsigned) {
$attribute = 'UNSIGNED';
}
if ($zerofill) {
$attribute = 'UNSIGNED ZEROFILL';
}
if ($compressed) {
// With InnoDB page compression, multiple compression algorithms are supported.
// In contrast, with InnoDB's COMPRESSED row format, zlib is the only supported compression algorithm.
// This means that the COMPRESSED row format has less compression options than InnoDB page compression does.
// @see https://mariadb.com/kb/en/innodb-page-compression/#comparison-with-the-compressed-row-format
$attribute = 'COMPRESSED=zlib';
}
$canContainCollation = false;
if (! $binary && preg_match('@^(char|varchar|text|tinytext|mediumtext|longtext|set|enum)@', $type)) {
$canContainCollation = true;
}
// for the case ENUM('–','“')
$displayedType = htmlspecialchars($printType, ENT_COMPAT);
if (mb_strlen($printType) > $GLOBALS['cfg']['LimitChars']) {
$displayedType = '<abbr title="' . htmlspecialchars($printType) . '">';
$displayedType .= htmlspecialchars(
mb_substr(
$printType,
0,
(int) $GLOBALS['cfg']['LimitChars']
) . '...',
ENT_COMPAT
);
$displayedType .= '</abbr>';
}
return [
'type' => $type,
'spec_in_brackets' => $specInBrackets,
'enum_set_values' => $enumSetValues,
'print_type' => $printType,
'binary' => $binary,
'unsigned' => $unsigned,
'zerofill' => $zerofill,
'attribute' => $attribute,
'can_contain_collation' => $canContainCollation,
'displayed_type' => $displayedType,
];
}
/**
* If the string starts with a \r\n pair (0x0d0a) add an extra \n
*
* @param string $string string
*
* @return string with the chars replaced
*/
public static function duplicateFirstNewline(string $string): string
{
$firstOccurrence = mb_strpos($string, "\r\n");
if ($firstOccurrence === 0) {
$string = "\n" . $string;
}
return $string;
}
/**
* Get the action word corresponding to a script name
* in order to display it as a title in navigation panel
*
* @param string $target a valid value for $cfg['NavigationTreeDefaultTabTable'],
* $cfg['NavigationTreeDefaultTabTable2'],
* $cfg['DefaultTabTable'] or $cfg['DefaultTabDatabase']
*
* @return string|bool Title for the $cfg value
*/
public static function getTitleForTarget($target)
{
$mapping = [
'structure' => __('Structure'),
'sql' => __('SQL'),
'search' => __('Search'),
'insert' => __('Insert'),
'browse' => __('Browse'),
'operations' => __('Operations'),
];
return $mapping[$target] ?? false;
}
/**
* Get the script name corresponding to a plain English config word
* in order to append in links on navigation and main panel
*
* @param string $target a valid value for
* $cfg['NavigationTreeDefaultTabTable'],
* $cfg['NavigationTreeDefaultTabTable2'],
* $cfg['DefaultTabTable'], $cfg['DefaultTabDatabase'] or
* $cfg['DefaultTabServer']
* @param string $location one out of 'server', 'table', 'database'
*
* @return string script name corresponding to the config word
*/
public static function getScriptNameForOption($target, string $location): string
{
return Url::getFromRoute(self::getUrlForOption($target, $location));
}
/**
* Get the URL corresponding to a plain English config word
* in order to append in links on navigation and main panel
*
* @param string $target a valid value for
* $cfg['NavigationTreeDefaultTabTable'],
* $cfg['NavigationTreeDefaultTabTable2'],
* $cfg['DefaultTabTable'], $cfg['DefaultTabDatabase'] or
* $cfg['DefaultTabServer']
* @param string $location one out of 'server', 'table', 'database'
*
* @return string The URL corresponding to the config word
*/
public static function getUrlForOption($target, string $location): string
{
if ($location === 'server') {
// Values for $cfg['DefaultTabServer']
switch ($target) {
case 'welcome':
case 'index.php':
return '/';
case 'databases':
case 'server_databases.php':
return '/server/databases';
case 'status':
case 'server_status.php':
return '/server/status';
case 'variables':
case 'server_variables.php':
return '/server/variables';
case 'privileges':
case 'server_privileges.php':
return '/server/privileges';
}
} elseif ($location === 'database') {
// Values for $cfg['DefaultTabDatabase']
switch ($target) {
case 'structure':
case 'db_structure.php':
return '/database/structure';
case 'sql':
case 'db_sql.php':
return '/database/sql';
case 'search':
case 'db_search.php':
return '/database/search';
case 'operations':
case 'db_operations.php':
return '/database/operations';
}
} elseif ($location === 'table') {
// Values for $cfg['DefaultTabTable'],
// $cfg['NavigationTreeDefaultTabTable'] and
// $cfg['NavigationTreeDefaultTabTable2']
switch ($target) {
case 'structure':
case 'tbl_structure.php':
return '/table/structure';
case 'sql':
case 'tbl_sql.php':
return '/table/sql';
case 'search':
case 'tbl_select.php':
return '/table/search';
case 'insert':
case 'tbl_change.php':
return '/table/change';
case 'browse':
case 'sql.php':
return '/sql';
}
}
return '/';
}
/**
* Formats user string, expanding @VARIABLES@, accepting strftime format
* string.
*
* @param string $string Text where to do expansion.
* @param array|string $escape Function to call for escaping variable values.
* Can also be an array of:
* - the escape method name
* - the class that contains the method
* - location of the class (for inclusion)
* @param array $updates Array with overrides for default parameters
* (obtained from GLOBALS).
*
* @return string
*/
public static function expandUserString(
$string,
$escape = null,
array $updates = []
) {
global $dbi;
/* Content */
$vars = [];
$vars['http_host'] = Core::getenv('HTTP_HOST');
$vars['server_name'] = $GLOBALS['cfg']['Server']['host'];
$vars['server_verbose'] = $GLOBALS['cfg']['Server']['verbose'];
if (empty($GLOBALS['cfg']['Server']['verbose'])) {
$vars['server_verbose_or_name'] = $GLOBALS['cfg']['Server']['host'];
} else {
$vars['server_verbose_or_name'] = $GLOBALS['cfg']['Server']['verbose'];
}
$vars['database'] = $GLOBALS['db'];
$vars['table'] = $GLOBALS['table'];
$vars['phpmyadmin_version'] = 'phpMyAdmin ' . Version::VERSION;
/* Update forced variables */
foreach ($updates as $key => $val) {
$vars[$key] = $val;
}
/* Replacement mapping */
/*
* The __VAR__ ones are for backward compatibility, because user
* might still have it in cookies.
*/
$replace = [
'@HTTP_HOST@' => $vars['http_host'],
'@SERVER@' => $vars['server_name'],
'__SERVER__' => $vars['server_name'],
'@VERBOSE@' => $vars['server_verbose'],
'@VSERVER@' => $vars['server_verbose_or_name'],
'@DATABASE@' => $vars['database'],
'__DB__' => $vars['database'],
'@TABLE@' => $vars['table'],
'__TABLE__' => $vars['table'],
'@PHPMYADMIN@' => $vars['phpmyadmin_version'],
];
/* Optional escaping */
if ($escape !== null) {
if (is_array($escape)) {
$escapeClass = new $escape[1]();
$escapeMethod = $escape[0];
}
foreach ($replace as $key => $val) {
if (isset($escapeClass, $escapeMethod)) {
$replace[$key] = $escapeClass->$escapeMethod($val);
} elseif ($escape === 'backquote') {
$replace[$key] = self::backquote($val);
} elseif (is_callable($escape)) {
$replace[$key] = $escape($val);
}
}
}
/* Backward compatibility in 3.5.x */
if (str_contains($string, '@FIELDS@')) {
$string = strtr($string, ['@FIELDS@' => '@COLUMNS@']);
}
/* Fetch columns list if required */
if (str_contains($string, '@COLUMNS@')) {
$columnsList = $dbi->getColumns($GLOBALS['db'], $GLOBALS['table']);
// sometimes the table no longer exists at this point
if ($columnsList !== null) {
$columnNames = [];
foreach ($columnsList as $column) {
if ($escape !== null) {
$columnNames[] = self::$escape($column['Field']);
} else {
$columnNames[] = $column['Field'];
}
}
$replace['@COLUMNS@'] = implode(',', $columnNames);
} else {
$replace['@COLUMNS@'] = '*';
}
}
/* Do the replacement */
return strtr((string) @strftime($string), $replace);
}
/**
* This function processes the datatypes supported by the DB,
* as specified in Types->getColumns() and either returns an array
* (useful for quickly checking if a datatype is supported)
* or an HTML snippet that creates a drop-down list.
*
* @param bool $html Whether to generate an html snippet or an array
* @param string $selected The value to mark as selected in HTML mode
*
* @return mixed An HTML snippet or an array of datatypes.
*/
public static function getSupportedDatatypes($html = false, $selected = '')
{
global $dbi;
if ($html) {
$retval = Generator::getSupportedDatatypes($selected);
} else {
$retval = [];
foreach ($dbi->types->getColumns() as $value) {
if (is_array($value)) {
foreach ($value as $subvalue) {
if ($subvalue === '-') {
continue;
}
$retval[] = $subvalue;
}
} else {
if ($value !== '-') {
$retval[] = $value;
}
}
}
}
return $retval;
}
/**
* Returns a list of datatypes that are not (yet) handled by PMA.
* Used by: /table/change and libraries/Routines.php
*
* @return array list of datatypes
*/
public static function unsupportedDatatypes(): array
{
return [];
}
/**
* This function is to check whether database support UUID
*/
public static function isUUIDSupported(): bool
{
return Compatibility::isUUIDSupported($GLOBALS['dbi']);
}
/**
* Checks if the current user has a specific privilege and returns true if the
* user indeed has that privilege or false if they don't. This function must
* only be used for features that are available since MySQL 5, because it
* relies on the INFORMATION_SCHEMA database to be present.
*
* Example: currentUserHasPrivilege('CREATE ROUTINE', 'mydb');
* // Checks if the currently logged in user has the global
* // 'CREATE ROUTINE' privilege or, if not, checks if the
* // user has this privilege on database 'mydb'.
*
* @param string $priv The privilege to check
* @param string|null $db null, to only check global privileges
* string, db name where to also check
* for privileges
* @param string|null $tbl null, to only check global/db privileges
* string, table name where to also check
* for privileges
*/
public static function currentUserHasPrivilege(string $priv, ?string $db = null, ?string $tbl = null): bool
{
global $dbi;
// Get the username for the current user in the format
// required to use in the information schema database.
[$user, $host] = $dbi->getCurrentUserAndHost();
// MySQL is started with --skip-grant-tables
if ($user === '') {
return true;
}
$username = "''";
$username .= str_replace("'", "''", $user);
$username .= "''@''";
$username .= str_replace("'", "''", $host);
$username .= "''";
// Prepare the query
$query = 'SELECT `PRIVILEGE_TYPE` FROM `INFORMATION_SCHEMA`.`%s` '
. "WHERE GRANTEE='%s' AND PRIVILEGE_TYPE='%s'";
// Check global privileges first.
$userPrivileges = $dbi->fetchValue(
sprintf(
$query,
'USER_PRIVILEGES',
$username,
$priv
)
);
if ($userPrivileges) {
return true;
}
// If a database name was provided and user does not have the
// required global privilege, try database-wise permissions.
if ($db === null) {
// There was no database name provided and the user
// does not have the correct global privilege.
return false;
}
$query .= " AND '%s' LIKE `TABLE_SCHEMA`";
$schemaPrivileges = $dbi->fetchValue(
sprintf(
$query,
'SCHEMA_PRIVILEGES',
$username,
$priv,
$dbi->escapeString($db)
)
);
if ($schemaPrivileges) {
return true;
}
// If a table name was also provided and we still didn't
// find any valid privileges, try table-wise privileges.
if ($tbl !== null) {
$query .= " AND TABLE_NAME='%s'";
$tablePrivileges = $dbi->fetchValue(
sprintf(
$query,
'TABLE_PRIVILEGES',
$username,
$priv,
$dbi->escapeString($db),
$dbi->escapeString($tbl)
)
);
if ($tablePrivileges) {
return true;
}
}
/**
* If we reached this point, the user does not
* have even valid table-wise privileges.
*/
return false;
}
/**
* Returns server type for current connection
*
* Known types are: MariaDB, Percona Server and MySQL (default)
*
* @phpstan-return 'MariaDB'|'Percona Server'|'MySQL'
*/
public static function getServerType(): string
{
global $dbi;
if ($dbi->isMariaDB()) {
return 'MariaDB';
}
if ($dbi->isPercona()) {
return 'Percona Server';
}
return 'MySQL';
}
/**
* Parses ENUM/SET values
*
* @param string $definition The definition of the column
* for which to parse the values
* @param bool $escapeHtml Whether to escape html entities
*
* @return array
*/
public static function parseEnumSetValues($definition, $escapeHtml = true)
{
// There is a JS port of the below parser in functions.js
// If you are fixing something here,
// you need to also update the JS port.
// This should really be delegated to MySQL but since we also want to HTML encode it,
// it is easier this way.
// It future replace str_getcsv with $dbi->fetchSingleRow('SELECT '.$expressionInBrackets[1]);
preg_match('/\((.*)\)/', $definition, $expressionInBrackets);
$matches = str_getcsv($expressionInBrackets[1], ',', "'", '\\');
$values = [];
foreach ($matches as $value) {
$value = strtr($value, ['\\\\' => '\\']); // str_getcsv doesn't unescape backslashes so we do it ourselves
$values[] = $escapeHtml ? htmlspecialchars($value, ENT_QUOTES, 'UTF-8') : $value;
}
return $values;
}
/**
* Return the list of tabs for the menu with corresponding names
*
* @param string $level 'server', 'db' or 'table' level
*
* @return array|null list of tabs for the menu
*/
public static function getMenuTabList($level = null)
{
$tabList = [
'server' => [
'databases' => __('Databases'),
'sql' => __('SQL'),
'status' => __('Status'),
'rights' => __('Users'),
'export' => __('Export'),
'import' => __('Import'),
'settings' => __('Settings'),
'binlog' => __('Binary log'),
'replication' => __('Replication'),
'vars' => __('Variables'),
'charset' => __('Charsets'),
'plugins' => __('Plugins'),
'engine' => __('Engines'),
],
'db' => [
'structure' => __('Structure'),
'sql' => __('SQL'),
'search' => __('Search'),
'query' => __('Query'),
'export' => __('Export'),
'import' => __('Import'),
'operation' => __('Operations'),
'privileges' => __('Privileges'),
'routines' => __('Routines'),
'events' => __('Events'),
'triggers' => __('Triggers'),
'tracking' => __('Tracking'),
'designer' => __('Designer'),
'central_columns' => __('Central columns'),
],
'table' => [
'browse' => __('Browse'),
'structure' => __('Structure'),
'sql' => __('SQL'),
'search' => __('Search'),
'insert' => __('Insert'),
'export' => __('Export'),
'import' => __('Import'),
'privileges' => __('Privileges'),
'operation' => __('Operations'),
'tracking' => __('Tracking'),
'triggers' => __('Triggers'),
],
];
if ($level == null) {
return $tabList;
}
if (array_key_exists($level, $tabList)) {
return $tabList[$level];
}
return null;
}
/**
* Add fractional seconds to time, datetime and timestamp strings.
* If the string contains fractional seconds,
* pads it with 0s up to 6 decimal places.
*
* @param string $value time, datetime or timestamp strings
*
* @return string time, datetime or timestamp strings with fractional seconds
*/
public static function addMicroseconds($value)
{
if ($value === '' || preg_match('/^current_timestamp(\([0-6]?\))?$/i', $value)) {
return $value;
}
if (! str_contains($value, '.')) {
return $value . '.000000';
}
$value .= '000000';
return mb_substr(
$value,
0,
mb_strpos($value, '.') + 7
);
}
/**
* Reads the file, detects the compression MIME type, closes the file
* and returns the MIME type
*
* @param resource $file the file handle
*
* @return string the MIME type for compression, or 'none'
*/
public static function getCompressionMimeType($file)
{
$test = fread($file, 4);
if ($test === false) {
fclose($file);
return 'none';
}
$len = strlen($test);
fclose($file);
if ($len >= 2 && $test[0] == chr(31) && $test[1] == chr(139)) {
return 'application/gzip';
}
if ($len >= 3 && substr($test, 0, 3) === 'BZh') {
return 'application/bzip2';
}
if ($len >= 4 && $test == "PK\003\004") {
return 'application/zip';
}
return 'none';
}
/**
* Provide COLLATE clause, if required, to perform case sensitive comparisons
* for queries on information_schema.
*
* @return string COLLATE clause if needed or empty string.
*/
public static function getCollateForIS()
{
global $dbi;
$names = $dbi->getLowerCaseNames();
if ($names === '0') {
return 'COLLATE utf8_bin';
}
if ($names === '2') {
return 'COLLATE utf8_general_ci';
}
return '';
}
/**
* Process the index data.
*
* @param array $indexes index data
*
* @return array processes index data
*/
public static function processIndexData(array $indexes)
{
$lastIndex = '';
$primary = '';
$pkArray = []; // will be use to emphasis prim. keys in the table
$indexesInfo = [];
$indexesData = [];
// view
foreach ($indexes as $row) {
// Backups the list of primary keys
if ($row['Key_name'] === 'PRIMARY') {
$primary .= $row['Column_name'] . ', ';
$pkArray[$row['Column_name']] = 1;
}
// Retains keys informations
if ($row['Key_name'] != $lastIndex) {
$indexes[] = $row['Key_name'];
$lastIndex = $row['Key_name'];
}
$indexesInfo[$row['Key_name']]['Sequences'][] = $row['Seq_in_index'];
$indexesInfo[$row['Key_name']]['Non_unique'] = $row['Non_unique'];
if (isset($row['Cardinality'])) {
$indexesInfo[$row['Key_name']]['Cardinality'] = $row['Cardinality'];
}
// I don't know what does following column mean....
// $indexes_info[$row['Key_name']]['Packed'] = $row['Packed'];
$indexesInfo[$row['Key_name']]['Comment'] = $row['Comment'];
$indexesData[$row['Key_name']][$row['Seq_in_index']]['Column_name'] = $row['Column_name'];
if (! isset($row['Sub_part'])) {
continue;
}
$indexesData[$row['Key_name']][$row['Seq_in_index']]['Sub_part'] = $row['Sub_part'];
}
return [
$primary,
$pkArray,
$indexesInfo,
$indexesData,
];
}
/**
* Gets the list of tables in the current db and information about these
* tables if possible
*
* @param string $db database name
* @param string $subPart part of script name
*
* @return array
*/
public static function getDbInfo($db, string $subPart)
{
global $cfg, $dbi;
/**
* limits for table list
*/
if (! isset($_SESSION['tmpval']['table_limit_offset']) || $_SESSION['tmpval']['table_limit_offset_db'] != $db) {
$_SESSION['tmpval']['table_limit_offset'] = 0;
$_SESSION['tmpval']['table_limit_offset_db'] = $db;
}
if (isset($_REQUEST['pos'])) {
$_SESSION['tmpval']['table_limit_offset'] = (int) $_REQUEST['pos'];
}
$pos = $_SESSION['tmpval']['table_limit_offset'];
/**
* whether to display extended stats
*/
$isShowStats = $cfg['ShowStats'];
/**
* whether selected db is information_schema
*/
$isSystemSchema = false;
if (Utilities::isSystemSchema($db)) {
$isShowStats = false;
$isSystemSchema = true;
}
/**
* information about tables in db
*/
$tables = [];
$tooltipTrueName = [];
$tooltipAliasName = [];
// Special speedup for newer MySQL Versions (in 4.0 format changed)
if ($cfg['SkipLockedTables'] === true) {
$dbInfoResult = $dbi->query(
'SHOW OPEN TABLES FROM ' . self::backquote($db) . ' WHERE In_use > 0;'
);
// Blending out tables in use
if ($dbInfoResult->numRows() > 0) {
$tables = self::getTablesWhenOpen($db, $dbInfoResult);
}
}
if (empty($tables)) {
// Set some sorting defaults
$sort = 'Name';
$sortOrder = 'ASC';
if (isset($_REQUEST['sort'])) {
$sortableNameMappings = [
'table' => 'Name',
'records' => 'Rows',
'type' => 'Engine',
'collation' => 'Collation',
'size' => 'Data_length',
'overhead' => 'Data_free',
'creation' => 'Create_time',
'last_update' => 'Update_time',
'last_check' => 'Check_time',
'comment' => 'Comment',
];
// Make sure the sort type is implemented
if (isset($sortableNameMappings[$_REQUEST['sort']])) {
$sort = $sortableNameMappings[$_REQUEST['sort']];
if ($_REQUEST['sort_order'] === 'DESC') {
$sortOrder = 'DESC';
}
}
}
$groupWithSeparator = false;
$tableType = null;
$limitOffset = 0;
$limitCount = false;
$groupTable = [];
if (! empty($_REQUEST['tbl_group']) || ! empty($_REQUEST['tbl_type'])) {
if (! empty($_REQUEST['tbl_type'])) {
// only tables for selected type
$tableType = $_REQUEST['tbl_type'];
}
if (! empty($_REQUEST['tbl_group'])) {
// only tables for selected group
$tableGroup = $_REQUEST['tbl_group'];
// include the table with the exact name of the group if such
// exists
$groupTable = $dbi->getTablesFull(
$db,
$tableGroup,
false,
$limitOffset,
$limitCount,
$sort,
$sortOrder,
$tableType
);
$groupWithSeparator = $tableGroup
. $GLOBALS['cfg']['NavigationTreeTableSeparator'];
}
} else {
// all tables in db
// - get the total number of tables
// (needed for proper working of the MaxTableList feature)
$tables = $dbi->getTables($db);
$totalNumTables = count($tables);
if ($subPart !== '_export') {
// fetch the details for a possible limited subset
$limitOffset = $pos;
$limitCount = true;
}
}
$tables = $groupTable + $dbi->getTablesFull(
$db,
$groupWithSeparator !== false ? $groupWithSeparator : $tables,
$groupWithSeparator !== false,
$limitOffset,
$limitCount,
$sort,
$sortOrder,
$tableType
);
}
$numTables = count($tables);
// (needed for proper working of the MaxTableList feature)
if (! isset($totalNumTables)) {
$totalNumTables = $numTables;
}
/**
* If coming from a Show MySQL link on the home page,
* put something in $sub_part
*/
if ($subPart === '') {
$subPart = '_structure';
}
return [
$tables,
$numTables,
$totalNumTables,
$subPart,
$isShowStats,
$isSystemSchema,
$tooltipTrueName,
$tooltipAliasName,
$pos,
];
}
/**
* Gets the list of tables in the current db, taking into account
* that they might be "in use"
*
* @param string $db database name
* @param ResultInterface $dbInfoResult result set
*
* @return array list of tables
*/
public static function getTablesWhenOpen($db, ResultInterface $dbInfoResult): array
{
global $dbi;
$sotCache = [];
$tables = [];
foreach ($dbInfoResult as $tmp) {
$sotCache[$tmp['Table']] = true;
}
// is there at least one "in use" table?
if (count($sotCache) > 0) {
$tblGroupSql = '';
$whereAdded = false;
if (
isset($_REQUEST['tbl_group'])
&& is_scalar($_REQUEST['tbl_group'])
&& strlen((string) $_REQUEST['tbl_group']) > 0
) {
$group = $dbi->escapeMysqlLikeString((string) $_REQUEST['tbl_group']);
$groupWithSeparator = $dbi->escapeMysqlLikeString(
$_REQUEST['tbl_group']
. $GLOBALS['cfg']['NavigationTreeTableSeparator']
);
$tblGroupSql .= ' WHERE ('
. self::backquote('Tables_in_' . $db)
. " LIKE '" . $groupWithSeparator . "%'"
. ' OR '
. self::backquote('Tables_in_' . $db)
. " LIKE '" . $group . "')";
$whereAdded = true;
}
if (isset($_REQUEST['tbl_type']) && in_array($_REQUEST['tbl_type'], ['table', 'view'])) {
$tblGroupSql .= $whereAdded ? ' AND' : ' WHERE';
if ($_REQUEST['tbl_type'] === 'view') {
$tblGroupSql .= " `Table_type` NOT IN ('BASE TABLE', 'SYSTEM VERSIONED')";
} else {
$tblGroupSql .= " `Table_type` IN ('BASE TABLE', 'SYSTEM VERSIONED')";
}
}
$dbInfoResult = $dbi->query('SHOW FULL TABLES FROM ' . self::backquote($db) . $tblGroupSql);
unset($tblGroupSql, $whereAdded);
if ($dbInfoResult->numRows() > 0) {
$names = [];
while ($tmp = $dbInfoResult->fetchRow()) {
if (! isset($sotCache[$tmp[0]])) {
$names[] = $tmp[0];
} else { // table in use
$tables[$tmp[0]] = [
'TABLE_NAME' => $tmp[0],
'ENGINE' => '',
'TABLE_TYPE' => '',
'TABLE_ROWS' => 0,
'TABLE_COMMENT' => '',
];
}
}
if (count($names) > 0) {
$tables += $dbi->getTablesFull($db, $names);
}
if ($GLOBALS['cfg']['NaturalOrder']) {
uksort($tables, 'strnatcasecmp');
}
}
unset($sotCache);
}
return $tables;
}
/**
* Checks whether database extension is loaded
*
* @param string $extension mysql extension to check
*/
public static function checkDbExtension(string $extension = 'mysqli'): bool
{
return function_exists($extension . '_connect');
}
/**
* Returns list of used PHP extensions.
*
* @return string[]
*/
public static function listPHPExtensions(): array
{
$result = [];
if (self::checkDbExtension('mysqli')) {
$result[] = 'mysqli';
}
if (extension_loaded('curl')) {
$result[] = 'curl';
}
if (extension_loaded('mbstring')) {
$result[] = 'mbstring';
}
if (extension_loaded('sodium')) {
$result[] = 'sodium';
}
return $result;
}
/**
* Converts given (request) parameter to string
*
* @param mixed $value Value to convert
*/
public static function requestString($value): string
{
while (is_array($value) || is_object($value)) {
if (is_object($value)) {
$value = (array) $value;
}
$value = reset($value);
}
return trim((string) $value);
}
/**
* Generates random string consisting of ASCII chars
*
* @param int $length Length of string
* @param bool $asHex (optional) Send the result as hex
*/
public static function generateRandom(int $length, bool $asHex = false): string
{
$result = '';
while (strlen($result) < $length) {
// Get random byte and strip highest bit
// to get ASCII only range
$byte = ord(random_bytes(1)) & 0x7f;
// We want only ASCII chars and no DEL character (127)
if ($byte <= 32 || $byte === 127) {
continue;
}
$result .= chr($byte);
}
return $asHex ? bin2hex($result) : $result;
}
/**
* Wrapper around PHP date function
*
* @param string $format Date format string
*
* @return string
*/
public static function date($format)
{
return date($format);
}
/**
* Wrapper around php's set_time_limit
*/
public static function setTimeLimit(): void
{
// The function can be disabled in php.ini
if (! function_exists('set_time_limit')) {
return;
}
@set_time_limit((int) $GLOBALS['cfg']['ExecTimeLimit']);
}
/**
* Access to a multidimensional array by dot notation
*
* @param array $array List of values
* @param string|array $path Path to searched value
* @param mixed $default Default value
*
* @return mixed Searched value
*/
public static function getValueByKey(array $array, $path, $default = null)
{
if (is_string($path)) {
$path = explode('.', $path);
}
$p = array_shift($path);
while (isset($p)) {
if (! isset($array[$p])) {
return $default;
}
$array = $array[$p];
$p = array_shift($path);
}
return $array;
}
/**
* Creates a clickable column header for table information
*
* @param string $title Title to use for the link
* @param string $sort Corresponds to sortable data name mapped
* in Util::getDbInfo
* @param string $initialSortOrder Initial sort order
*
* @return string Link to be displayed in the table header
*/
public static function sortableTableHeader($title, $sort, $initialSortOrder = 'ASC')
{
$requestedSort = 'table';
$requestedSortOrder = $futureSortOrder = $initialSortOrder;
// If the user requested a sort
if (isset($_REQUEST['sort'])) {
$requestedSort = $_REQUEST['sort'];
if (isset($_REQUEST['sort_order'])) {
$requestedSortOrder = $_REQUEST['sort_order'];
}
}
$orderImg = '';
$orderLinkParams = [];
$orderLinkParams['title'] = __('Sort');
// If this column was requested to be sorted.
if ($requestedSort == $sort) {
if ($requestedSortOrder === 'ASC') {
$futureSortOrder = 'DESC';
// current sort order is ASC
$orderImg = ' ' . Generator::getImage(
's_asc',
__('Ascending'),
[
'class' => 'sort_arrow',
'title' => '',
]
);
$orderImg .= ' ' . Generator::getImage(
's_desc',
__('Descending'),
[
'class' => 'sort_arrow hide',
'title' => '',
]
);
// but on mouse over, show the reverse order (DESC)
$orderLinkParams['onmouseover'] = "$('.sort_arrow').toggle();";
// on mouse out, show current sort order (ASC)
$orderLinkParams['onmouseout'] = "$('.sort_arrow').toggle();";
} else {
$futureSortOrder = 'ASC';
// current sort order is DESC
$orderImg = ' ' . Generator::getImage(
's_asc',
__('Ascending'),
[
'class' => 'sort_arrow hide',
'title' => '',
]
);
$orderImg .= ' ' . Generator::getImage(
's_desc',
__('Descending'),
[
'class' => 'sort_arrow',
'title' => '',
]
);
// but on mouse over, show the reverse order (ASC)
$orderLinkParams['onmouseover'] = "$('.sort_arrow').toggle();";
// on mouse out, show current sort order (DESC)
$orderLinkParams['onmouseout'] = "$('.sort_arrow').toggle();";
}
}
$urlParams = [
'db' => $_REQUEST['db'],
'pos' => 0, // We set the position back to 0 every time they sort.
'sort' => $sort,
'sort_order' => $futureSortOrder,
];
if (isset($_REQUEST['tbl_type']) && in_array($_REQUEST['tbl_type'], ['view', 'table'])) {
$urlParams['tbl_type'] = $_REQUEST['tbl_type'];
}
if (! empty($_REQUEST['tbl_group'])) {
$urlParams['tbl_group'] = $_REQUEST['tbl_group'];
}
$url = Url::getFromRoute('/database/structure', $urlParams, false);
return Generator::linkOrButton($url, null, $title . $orderImg, $orderLinkParams);
}
/**
* Check that input is an int or an int in a string
*
* @param mixed $input input to check
*/
public static function isInteger($input): bool
{
return ctype_digit((string) $input);
}
/**
* Get the protocol from the RFC 7239 Forwarded header
*
* @param string $headerContents The Forwarded header contents
*
* @return string the protocol http/https
*/
public static function getProtoFromForwardedHeader(string $headerContents): string
{
if (str_contains($headerContents, '=')) {// does not contain any equal sign
$hops = explode(',', $headerContents);
$parts = explode(';', $hops[0]);
foreach ($parts as $part) {
$keyValueArray = explode('=', $part, 2);
if (count($keyValueArray) !== 2) {
continue;
}
[
$keyName,
$value,
] = $keyValueArray;
$value = trim(strtolower($value));
if (strtolower(trim($keyName)) === 'proto' && in_array($value, ['http', 'https'])) {
return $value;
}
}
}
return '';
}
/**
* Check if error reporting is available
*/
public static function isErrorReportingAvailable(): bool
{
// issue #16256 - PHP 7.x does not return false for a core function
if (PHP_MAJOR_VERSION < 8) {
$disabled = ini_get('disable_functions');
if (is_string($disabled)) {
$disabled = explode(',', $disabled);
$disabled = array_map(static function (string $part) {
return trim($part);
}, $disabled);
return ! in_array('error_reporting', $disabled);
}
}
return function_exists('error_reporting');
}
}
|