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
|
<?php
/**
* Base class for the backend of file upload.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Upload
*/
use MediaWiki\Api\ApiResult;
use MediaWiki\Api\ApiUpload;
use MediaWiki\Context\RequestContext;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\PermissionStatus;
use MediaWiki\Request\WebRequest;
use MediaWiki\Shell\Shell;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use MediaWiki\User\UserIdentity;
use Wikimedia\AtEase\AtEase;
use Wikimedia\FileBackend\FileBackend;
use Wikimedia\FileBackend\FSFile\FSFile;
use Wikimedia\FileBackend\FSFile\TempFSFile;
use Wikimedia\Message\MessageParam;
use Wikimedia\Mime\XmlTypeCheck;
use Wikimedia\ObjectCache\BagOStuff;
use Wikimedia\Rdbms\IDBAccessObject;
/**
* @defgroup Upload Upload related
*/
/**
* @ingroup Upload
*
* UploadBase and subclasses are the backend of MediaWiki's file uploads.
* The frontends are formed by ApiUpload and SpecialUpload.
*
* @stable to extend
*
* @author Brooke Vibber
* @author Bryan Tong Minh
* @author Michael Dale
*/
abstract class UploadBase {
use ProtectedHookAccessorTrait;
/** @var string|null Local file system path to the file to upload (or a local copy) */
protected $mTempPath;
/** @var TempFSFile|null Wrapper to handle deleting the temp file */
protected $tempFileObj;
/** @var string|null */
protected $mDesiredDestName;
/** @var string|null */
protected $mDestName;
/** @var bool|null */
protected $mRemoveTempFile;
/** @var string|null */
protected $mSourceType;
/** @var Title|false|null */
protected $mTitle = false;
/** @var int */
protected $mTitleError = 0;
/** @var string|null */
protected $mFilteredName;
/** @var string|null */
protected $mFinalExtension;
/** @var LocalFile|null */
protected $mLocalFile;
/** @var UploadStashFile|null */
protected $mStashFile;
/** @var int|null */
protected $mFileSize;
/** @var array|null */
protected $mFileProps;
/** @var string[] */
protected $mBlackListedExtensions;
/** @var bool|null */
protected $mJavaDetected;
/** @var string|false */
protected $mSVGNSError;
private const SAFE_XML_ENCONDINGS = [
'UTF-8',
'US-ASCII',
'ISO-8859-1',
'ISO-8859-2',
'UTF-16',
'UTF-32',
'WINDOWS-1250',
'WINDOWS-1251',
'WINDOWS-1252',
'WINDOWS-1253',
'WINDOWS-1254',
'WINDOWS-1255',
'WINDOWS-1256',
'WINDOWS-1257',
'WINDOWS-1258',
];
public const SUCCESS = 0;
public const OK = 0;
public const EMPTY_FILE = 3;
public const MIN_LENGTH_PARTNAME = 4;
public const ILLEGAL_FILENAME = 5;
public const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
public const FILETYPE_MISSING = 8;
public const FILETYPE_BADTYPE = 9;
public const VERIFICATION_ERROR = 10;
public const HOOK_ABORTED = 11;
public const FILE_TOO_LARGE = 12;
public const WINDOWS_NONASCII_FILENAME = 13;
public const FILENAME_TOO_LONG = 14;
private const CODE_TO_STATUS = [
self::EMPTY_FILE => 'empty-file',
self::FILE_TOO_LARGE => 'file-too-large',
self::FILETYPE_MISSING => 'filetype-missing',
self::FILETYPE_BADTYPE => 'filetype-banned',
self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
self::ILLEGAL_FILENAME => 'illegal-filename',
self::OVERWRITE_EXISTING_FILE => 'overwrite',
self::VERIFICATION_ERROR => 'verification-error',
self::HOOK_ABORTED => 'hookaborted',
self::WINDOWS_NONASCII_FILENAME => 'windows-nonascii-filename',
self::FILENAME_TOO_LONG => 'filename-toolong',
];
/**
* @param int $error
* @return string
*/
public function getVerificationErrorCode( $error ) {
return self::CODE_TO_STATUS[$error] ?? 'unknown-error';
}
/**
* Returns true if uploads are enabled.
* Can be override by subclasses.
* @stable to override
* @return bool
*/
public static function isEnabled() {
$enableUploads = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::EnableUploads );
return $enableUploads && wfIniGetBool( 'file_uploads' );
}
/**
* Returns true if the user can use this upload module or else a string
* identifying the missing permission.
* Can be overridden by subclasses.
*
* @param Authority $performer
* @return bool|string
*/
public static function isAllowed( Authority $performer ) {
foreach ( [ 'upload', 'edit' ] as $permission ) {
if ( !$performer->isAllowed( $permission ) ) {
return $permission;
}
}
return true;
}
/**
* Returns true if the user has surpassed the upload rate limit, false otherwise.
*
* @deprecated since 1.41, use verifyTitlePermissions() instead.
* Rate limit checks are now implicit in permission checks.
*
* @param User $user
* @return bool
*/
public static function isThrottled( $user ) {
wfDeprecated( __METHOD__, '1.41' );
return $user->pingLimiter( 'upload' );
}
/** @var string[] Upload handlers. Should probably just be a configuration variable. */
private static $uploadHandlers = [ 'Stash', 'File', 'Url' ];
/**
* Create a form of UploadBase depending on wpSourceType and initializes it.
*
* @param WebRequest &$request
* @param string|null $type
* @return null|self
*/
public static function createFromRequest( &$request, $type = null ) {
$type = $type ?: $request->getVal( 'wpSourceType', 'File' );
if ( !$type ) {
return null;
}
// Get the upload class
$type = ucfirst( $type );
// Give hooks the chance to handle this request
/** @var self|null $className */
$className = null;
( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
->onUploadCreateFromRequest( $type, $className );
if ( $className === null ) {
$className = 'UploadFrom' . $type;
wfDebug( __METHOD__ . ": class name: $className" );
if ( !in_array( $type, self::$uploadHandlers ) ) {
return null;
}
}
if ( !$className::isEnabled() || !$className::isValidRequest( $request ) ) {
return null;
}
/** @var self $handler */
$handler = new $className;
$handler->initializeFromRequest( $request );
return $handler;
}
/**
* Check whether a request if valid for this handler.
* @param WebRequest $request
* @return bool
*/
public static function isValidRequest( $request ) {
return false;
}
/**
* Get the desired destination name.
* @return string|null
*/
public function getDesiredDestName() {
return $this->mDesiredDestName;
}
/**
* @stable to call
*/
public function __construct() {
}
/**
* Returns the upload type. Should be overridden by child classes.
*
* @since 1.18
* @stable to override
* @return string|null
*/
public function getSourceType() {
return null;
}
/**
* @param string $name The desired destination name
* @param string|null $tempPath Callers should make sure this is not a storage path
* @param int|null $fileSize
* @param bool $removeTempFile (false) remove the temporary file?
*/
public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
$this->mDesiredDestName = $name;
if ( FileBackend::isStoragePath( $tempPath ) ) {
throw new InvalidArgumentException( __METHOD__ . " given storage path `$tempPath`." );
}
$this->setTempFile( $tempPath, $fileSize );
$this->mRemoveTempFile = $removeTempFile;
}
/**
* Initialize from a WebRequest. Override this in a subclass.
*
* @param WebRequest &$request
*/
abstract public function initializeFromRequest( &$request );
/**
* @param string|null $tempPath File system path to temporary file containing the upload
* @param int|null $fileSize
*/
protected function setTempFile( $tempPath, $fileSize = null ) {
$this->mTempPath = $tempPath ?? '';
$this->mFileSize = $fileSize ?: null;
$this->mFileProps = null;
if ( strlen( $this->mTempPath ) && file_exists( $this->mTempPath ) ) {
$this->tempFileObj = new TempFSFile( $this->mTempPath );
if ( !$fileSize ) {
$this->mFileSize = filesize( $this->mTempPath );
}
} else {
$this->tempFileObj = null;
}
}
/**
* Fetch the file. Usually a no-op.
* @stable to override
* @return Status
*/
public function fetchFile() {
return Status::newGood();
}
/**
* Perform checks to see if the file can be fetched. Usually a no-op.
* @stable to override
* @return Status
*/
public function canFetchFile() {
return Status::newGood();
}
/**
* Return true if the file is empty.
* @return bool
*/
public function isEmptyFile() {
return !$this->mFileSize;
}
/**
* Return the file size.
* @return int
*/
public function getFileSize() {
return $this->mFileSize;
}
/**
* Get the base 36 SHA1 of the file.
* @stable to override
* @return string|false
*/
public function getTempFileSha1Base36() {
// Use cached version if we already have it.
if ( $this->mFileProps && is_string( $this->mFileProps['sha1'] ) ) {
return $this->mFileProps['sha1'];
}
return FSFile::getSha1Base36FromPath( $this->mTempPath );
}
/**
* @param string $srcPath The source path
* @return string|false The real path if it was a virtual URL Returns false on failure
*/
public function getRealPath( $srcPath ) {
$repo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
if ( FileRepo::isVirtualUrl( $srcPath ) ) {
/** @todo Just make uploads work with storage paths UploadFromStash
* loads files via virtual URLs.
*/
$tmpFile = $repo->getLocalCopy( $srcPath );
if ( $tmpFile ) {
$tmpFile->bind( $this ); // keep alive with $this
}
$path = $tmpFile ? $tmpFile->getPath() : false;
} else {
$path = $srcPath;
}
return $path;
}
/**
* Verify whether the upload is sensible.
*
* Return a status array representing the outcome of the verification.
* Possible keys are:
* - 'status': set to self::OK in case of success, or to one of the error constants defined in
* this class in case of failure
* - 'max': set to the maximum allowed file size ($wgMaxUploadSize) if the upload is too large
* - 'details': set to error details if the file type is valid but contents are corrupt
* - 'filtered': set to the sanitized file name if the requested file name is invalid
* - 'finalExt': set to the file's file extension if it is not an allowed file extension
* - 'blacklistedExt': set to the list of disallowed file extensions if the current file extension
* is not allowed for uploads and the list is not empty
*
* @stable to override
* @return mixed[] array representing the result of the verification
*/
public function verifyUpload() {
/**
* If there was no filename or a zero size given, give up quick.
*/
if ( $this->isEmptyFile() ) {
return [ 'status' => self::EMPTY_FILE ];
}
/**
* Honor $wgMaxUploadSize
*/
$maxSize = self::getMaxUploadSize( $this->getSourceType() );
if ( $this->mFileSize > $maxSize ) {
return [
'status' => self::FILE_TOO_LARGE,
'max' => $maxSize,
];
}
/**
* Look at the contents of the file; if we can recognize the
* type, but it's corrupt or data of the wrong type, we should
* probably not accept it.
*/
$verification = $this->verifyFile();
if ( $verification !== true ) {
return [
'status' => self::VERIFICATION_ERROR,
'details' => $verification
];
}
/**
* Make sure this file can be created
*/
$result = $this->validateName();
if ( $result !== true ) {
return $result;
}
return [ 'status' => self::OK ];
}
/**
* Verify that the name is valid and, if necessary, that we can overwrite
*
* @return array|bool True if valid, otherwise an array with 'status'
* and other keys
*/
public function validateName() {
$nt = $this->getTitle();
if ( $nt === null ) {
$result = [ 'status' => $this->mTitleError ];
if ( $this->mTitleError === self::ILLEGAL_FILENAME ) {
$result['filtered'] = $this->mFilteredName;
}
if ( $this->mTitleError === self::FILETYPE_BADTYPE ) {
$result['finalExt'] = $this->mFinalExtension;
if ( count( $this->mBlackListedExtensions ) ) {
$result['blacklistedExt'] = $this->mBlackListedExtensions;
}
}
return $result;
}
$this->mDestName = $this->getLocalFile()->getName();
return true;
}
/**
* Verify the MIME type.
*
* @note Only checks that it is not an evil MIME.
* The "does it have the correct file extension given its MIME type?" check is in verifyFile.
* @param string $mime Representing the MIME
* @return array|bool True if the file is verified, an array otherwise
*/
protected function verifyMimeType( $mime ) {
$verifyMimeType = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::VerifyMimeType );
if ( $verifyMimeType ) {
wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>" );
$mimeTypeExclusions = MediaWikiServices::getInstance()->getMainConfig()
->get( MainConfigNames::MimeTypeExclusions );
if ( self::checkFileExtension( $mime, $mimeTypeExclusions ) ) {
return [ 'filetype-badmime', $mime ];
}
}
return true;
}
/**
* Verifies that it's ok to include the uploaded file
*
* @return array|true True of the file is verified, array otherwise.
*/
protected function verifyFile() {
$config = MediaWikiServices::getInstance()->getMainConfig();
$verifyMimeType = $config->get( MainConfigNames::VerifyMimeType );
$disableUploadScriptChecks = $config->get( MainConfigNames::DisableUploadScriptChecks );
$status = $this->verifyPartialFile();
if ( $status !== true ) {
return $status;
}
// Calculating props calculates the sha1 which is expensive.
// reuse props if we already have them
if ( !is_array( $this->mFileProps ) ) {
$mwProps = new MWFileProps( MediaWikiServices::getInstance()->getMimeAnalyzer() );
$this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
}
$mime = $this->mFileProps['mime'];
if ( $verifyMimeType ) {
# XXX: Missing extension will be caught by validateName() via getTitle()
if ( (string)$this->mFinalExtension !== '' &&
!self::verifyExtension( $mime, $this->mFinalExtension )
) {
return [ 'filetype-mime-mismatch', $this->mFinalExtension, $mime ];
}
}
# check for htmlish code and javascript
if ( !$disableUploadScriptChecks ) {
if ( $this->mFinalExtension === 'svg' || $mime === 'image/svg+xml' ) {
$svgStatus = $this->detectScriptInSvg( $this->mTempPath, false );
if ( $svgStatus !== false ) {
return $svgStatus;
}
}
}
$handler = MediaHandler::getHandler( $mime );
if ( $handler ) {
$handlerStatus = $handler->verifyUpload( $this->mTempPath );
if ( !$handlerStatus->isOK() ) {
$errors = $handlerStatus->getErrorsArray();
return reset( $errors );
}
}
$error = true;
$this->getHookRunner()->onUploadVerifyFile( $this, $mime, $error );
if ( $error !== true ) {
if ( !is_array( $error ) ) {
$error = [ $error ];
}
return $error;
}
wfDebug( __METHOD__ . ": all clear; passing." );
return true;
}
/**
* A verification routine suitable for partial files
*
* Runs the deny list checks, but not any checks that may
* assume the entire file is present.
*
* @return array|true True, if the file is valid, else an array with error message key.
* @phan-return non-empty-array|true
*/
protected function verifyPartialFile() {
$config = MediaWikiServices::getInstance()->getMainConfig();
$disableUploadScriptChecks = $config->get( MainConfigNames::DisableUploadScriptChecks );
# getTitle() sets some internal parameters like $this->mFinalExtension
$this->getTitle();
// Calculating props calculates the sha1 which is expensive.
// reuse props if we already have them (e.g. During stashed upload)
if ( !is_array( $this->mFileProps ) ) {
$mwProps = new MWFileProps( MediaWikiServices::getInstance()->getMimeAnalyzer() );
$this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
}
# check MIME type, if desired
$mime = $this->mFileProps['file-mime'];
$status = $this->verifyMimeType( $mime );
if ( $status !== true ) {
return $status;
}
# check for htmlish code and javascript
if ( !$disableUploadScriptChecks ) {
if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
return [ 'uploadscripted' ];
}
if ( $this->mFinalExtension === 'svg' || $mime === 'image/svg+xml' ) {
$svgStatus = $this->detectScriptInSvg( $this->mTempPath, true );
if ( $svgStatus !== false ) {
return $svgStatus;
}
}
}
# Scan the uploaded file for viruses
$virus = self::detectVirus( $this->mTempPath );
if ( $virus ) {
return [ 'uploadvirus', $virus ];
}
return true;
}
/**
* Callback for ZipDirectoryReader to detect Java class files.
*
* @param array $entry
*/
public function zipEntryCallback( $entry ) {
$names = [ $entry['name'] ];
// If there is a null character, cut off the name at it, because JDK's
// ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
// were constructed which had ".class\0" followed by a string chosen to
// make the hash collide with the truncated name, that file could be
// returned in response to a request for the .class file.
$nullPos = strpos( $entry['name'], "\000" );
if ( $nullPos !== false ) {
$names[] = substr( $entry['name'], 0, $nullPos );
}
// If there is a trailing slash in the file name, we have to strip it,
// because that's what ZIP_GetEntry() does.
if ( preg_grep( '!\.class/?$!', $names ) ) {
$this->mJavaDetected = true;
}
}
/**
* Alias for verifyTitlePermissions. The function was originally
* 'verifyPermissions', but that suggests it's checking the user, when it's
* really checking the title + user combination.
*
* @param Authority $performer to verify the permissions against
* @return array|bool An array as returned by getPermissionErrors or true
* in case the user has proper permissions.
*/
public function verifyPermissions( Authority $performer ) {
return $this->verifyTitlePermissions( $performer );
}
/**
* Check whether the user can edit, upload and create the image. This
* checks only against the current title; if it returns errors, it may
* very well be that another title will not give errors. Therefore
* isAllowed() should be called as well for generic is-user-blocked or
* can-user-upload checking.
*
* @param Authority $performer to verify the permissions against
* @return array|bool An array as returned by getPermissionErrors or true
* in case the user has proper permissions.
*/
public function verifyTitlePermissions( Authority $performer ) {
/**
* If the image is protected, non-sysop users won't be able
* to modify it by uploading a new revision.
*/
$nt = $this->getTitle();
if ( $nt === null ) {
return true;
}
$status = PermissionStatus::newEmpty();
$performer->authorizeWrite( 'edit', $nt, $status );
$performer->authorizeWrite( 'upload', $nt, $status );
if ( !$status->isGood() ) {
return $status->toLegacyErrorArray();
}
$overwriteError = $this->checkOverwrite( $performer );
if ( $overwriteError !== true ) {
return [ $overwriteError ];
}
return true;
}
/**
* Check for non fatal problems with the file.
*
* This should not assume that mTempPath is set.
*
* @param User|null $user Accepted since 1.35
*
* @return mixed[] Array of warnings
*/
public function checkWarnings( $user = null ) {
if ( $user === null ) {
// TODO check uses and hard deprecate
$user = RequestContext::getMain()->getUser();
}
$warnings = [];
$localFile = $this->getLocalFile();
$localFile->load( IDBAccessObject::READ_LATEST );
$filename = $localFile->getName();
$hash = $this->getTempFileSha1Base36();
$badFileName = $this->checkBadFileName( $filename, $this->mDesiredDestName );
if ( $badFileName !== null ) {
$warnings['badfilename'] = $badFileName;
}
$unwantedFileExtensionDetails = $this->checkUnwantedFileExtensions( (string)$this->mFinalExtension );
if ( $unwantedFileExtensionDetails !== null ) {
$warnings['filetype-unwanted-type'] = $unwantedFileExtensionDetails;
}
$fileSizeWarnings = $this->checkFileSize( $this->mFileSize );
if ( $fileSizeWarnings ) {
$warnings = array_merge( $warnings, $fileSizeWarnings );
}
$localFileExistsWarnings = $this->checkLocalFileExists( $localFile, $hash );
if ( $localFileExistsWarnings ) {
$warnings = array_merge( $warnings, $localFileExistsWarnings );
}
if ( $this->checkLocalFileWasDeleted( $localFile ) ) {
$warnings['was-deleted'] = $filename;
}
// If a file with the same name exists locally then the local file has already been tested
// for duplication of content
$ignoreLocalDupes = isset( $warnings['exists'] );
$dupes = $this->checkAgainstExistingDupes( $hash, $ignoreLocalDupes );
if ( $dupes ) {
$warnings['duplicate'] = $dupes;
}
$archivedDupes = $this->checkAgainstArchiveDupes( $hash, $user );
if ( $archivedDupes !== null ) {
$warnings['duplicate-archive'] = $archivedDupes;
}
return $warnings;
}
/**
* Convert the warnings array returned by checkWarnings() to something that
* can be serialized, and that is suitable for inclusion directly in action API results.
*
* File objects will be converted to an associative array with the following keys:
*
* - fileName: The name of the file
* - timestamp: The upload timestamp
*
* @param mixed[] $warnings
* @return mixed[]
*/
public static function makeWarningsSerializable( $warnings ) {
array_walk_recursive( $warnings, static function ( &$param, $key ) {
if ( $param instanceof File ) {
$param = [
'fileName' => $param->getName(),
'timestamp' => $param->getTimestamp()
];
} elseif ( $param instanceof MessageParam ) {
// Do nothing (T390001)
} elseif ( is_object( $param ) ) {
throw new InvalidArgumentException(
'UploadBase::makeWarningsSerializable: ' .
'Unexpected object of class ' . get_class( $param ) );
}
} );
return $warnings;
}
/**
* Convert the serialized warnings array created by makeWarningsSerializable()
* back to the output of checkWarnings().
*
* @param mixed[] $warnings
* @return mixed[]
*/
public static function unserializeWarnings( $warnings ) {
foreach ( $warnings as $key => $value ) {
if ( is_array( $value ) ) {
if ( isset( $value['fileName'] ) && isset( $value['timestamp'] ) ) {
$warnings[$key] = MediaWikiServices::getInstance()->getRepoGroup()->findFile(
$value['fileName'],
[ 'time' => $value['timestamp'] ]
);
} else {
$warnings[$key] = self::unserializeWarnings( $value );
}
}
}
return $warnings;
}
/**
* Check whether the resulting filename is different from the desired one,
* but ignore things like ucfirst() and spaces/underscore things
*
* @param string $filename
* @param string $desiredFileName
*
* @return string|null String that was determined to be bad or null if the filename is okay
*/
private function checkBadFileName( $filename, $desiredFileName ) {
$comparableName = str_replace( ' ', '_', $desiredFileName );
$comparableName = Title::capitalize( $comparableName, NS_FILE );
if ( $desiredFileName != $filename && $comparableName != $filename ) {
return $filename;
}
return null;
}
/**
* @param string $fileExtension The file extension to check
*
* @return array|null array with the following keys:
* 0 => string The final extension being used
* 1 => string[] The extensions that are allowed
* 2 => int The number of extensions that are allowed.
*/
private function checkUnwantedFileExtensions( $fileExtension ) {
$checkFileExtensions = MediaWikiServices::getInstance()->getMainConfig()
->get( MainConfigNames::CheckFileExtensions );
$fileExtensions = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::FileExtensions );
if ( $checkFileExtensions ) {
$extensions = array_unique( $fileExtensions );
if ( !self::checkFileExtension( $fileExtension, $extensions ) ) {
return [
$fileExtension,
Message::listParam( $extensions, 'comma' ),
count( $extensions )
];
}
}
return null;
}
/**
* @param int $fileSize
*
* @return array warnings
*/
private function checkFileSize( $fileSize ) {
$uploadSizeWarning = MediaWikiServices::getInstance()->getMainConfig()
->get( MainConfigNames::UploadSizeWarning );
$warnings = [];
if ( $uploadSizeWarning && ( $fileSize > $uploadSizeWarning ) ) {
$warnings['large-file'] = [
Message::sizeParam( $uploadSizeWarning ),
Message::sizeParam( $fileSize ),
];
}
if ( $fileSize == 0 ) {
$warnings['empty-file'] = true;
}
return $warnings;
}
/**
* @param LocalFile $localFile
* @param string|false $hash sha1 hash of the file to check
*
* @return array warnings
*/
private function checkLocalFileExists( LocalFile $localFile, $hash ) {
$warnings = [];
$exists = self::getExistsWarning( $localFile );
if ( $exists !== false ) {
$warnings['exists'] = $exists;
// check if file is an exact duplicate of current file version
if ( $hash !== false && $hash === $localFile->getSha1() ) {
$warnings['no-change'] = $localFile;
}
// check if file is an exact duplicate of older versions of this file
$history = $localFile->getHistory();
foreach ( $history as $oldFile ) {
if ( $hash === $oldFile->getSha1() ) {
$warnings['duplicate-version'][] = $oldFile;
}
}
}
return $warnings;
}
private function checkLocalFileWasDeleted( LocalFile $localFile ) {
return $localFile->wasDeleted() && !$localFile->exists();
}
/**
* @param string|false $hash sha1 hash of the file to check
* @param bool $ignoreLocalDupes True to ignore local duplicates
*
* @return File[] Duplicate files, if found.
*/
private function checkAgainstExistingDupes( $hash, $ignoreLocalDupes ) {
if ( $hash === false ) {
return [];
}
$dupes = MediaWikiServices::getInstance()->getRepoGroup()->findBySha1( $hash );
$title = $this->getTitle();
foreach ( $dupes as $key => $dupe ) {
if (
( $dupe instanceof LocalFile ) &&
$ignoreLocalDupes &&
$title->equals( $dupe->getTitle() )
) {
unset( $dupes[$key] );
}
}
return $dupes;
}
/**
* @param string|false $hash sha1 hash of the file to check
* @param Authority $performer
*
* @return string|null Name of the dupe or empty string if discovered (depending on visibility)
* null if the check discovered no dupes.
*/
private function checkAgainstArchiveDupes( $hash, Authority $performer ) {
if ( $hash === false ) {
return null;
}
$archivedFile = new ArchivedFile( null, 0, '', $hash );
if ( $archivedFile->getID() > 0 ) {
if ( $archivedFile->userCan( File::DELETED_FILE, $performer ) ) {
return $archivedFile->getName();
}
return '';
}
return null;
}
/**
* Really perform the upload. Stores the file in the local repo, watches
* if necessary and runs the UploadComplete hook.
*
* @param string $comment
* @param string|false $pageText
* @param bool $watch Whether the file page should be added to user's watchlist.
* (This doesn't check $user's permissions.)
* @param User $user
* @param string[] $tags Change tags to add to the log entry and page revision.
* (This doesn't check $user's permissions.)
* @param string|null $watchlistExpiry Optional watchlist expiry timestamp in any format
* acceptable to wfTimestamp().
* @return Status Indicating the whether the upload succeeded.
*
* @since 1.35 Accepts $watchlistExpiry parameter.
*/
public function performUpload(
$comment, $pageText, $watch, $user, $tags = [], ?string $watchlistExpiry = null
) {
$this->getLocalFile()->load( IDBAccessObject::READ_LATEST );
$props = $this->mFileProps;
$error = null;
$this->getHookRunner()->onUploadVerifyUpload( $this, $user, $props, $comment, $pageText, $error );
if ( $error ) {
if ( !is_array( $error ) ) {
$error = [ $error ];
}
return Status::newFatal( ...$error );
}
$status = $this->getLocalFile()->upload(
$this->mTempPath,
$comment,
$pageText !== false ? $pageText : '',
File::DELETE_SOURCE,
$props,
false,
$user,
$tags
);
if ( $status->isGood() ) {
if ( $watch ) {
MediaWikiServices::getInstance()->getWatchlistManager()->addWatchIgnoringRights(
$user,
$this->getLocalFile()->getTitle(),
$watchlistExpiry
);
}
$this->getHookRunner()->onUploadComplete( $this );
$this->postProcessUpload();
}
return $status;
}
/**
* Perform extra steps after a successful upload.
*
* @stable to override
* @since 1.25
*/
public function postProcessUpload() {
}
/**
* Returns the title of the file to be uploaded. Sets mTitleError in case
* the name was illegal.
*
* @return Title|null The title of the file or null in case the name was illegal
*/
public function getTitle() {
if ( $this->mTitle !== false ) {
return $this->mTitle;
}
if ( !is_string( $this->mDesiredDestName ) ) {
$this->mTitleError = self::ILLEGAL_FILENAME;
$this->mTitle = null;
return $this->mTitle;
}
/* Assume that if a user specified File:Something.jpg, this is an error
* and that the namespace prefix needs to be stripped of.
*/
$title = Title::newFromText( $this->mDesiredDestName );
if ( $title && $title->getNamespace() === NS_FILE ) {
$this->mFilteredName = $title->getDBkey();
} else {
$this->mFilteredName = $this->mDesiredDestName;
}
# oi_archive_name is max 255 bytes, which include a timestamp and an
# exclamation mark, so restrict file name to 240 bytes.
if ( strlen( $this->mFilteredName ) > 240 ) {
$this->mTitleError = self::FILENAME_TOO_LONG;
$this->mTitle = null;
return $this->mTitle;
}
/**
* Chop off any directories in the given filename. Then
* filter out illegal characters, and try to make a legible name
* out of it. We'll strip some silently that Title would die on.
*/
$this->mFilteredName = wfStripIllegalFilenameChars( $this->mFilteredName );
/* Normalize to title form before we do any further processing */
$nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
if ( $nt === null ) {
$this->mTitleError = self::ILLEGAL_FILENAME;
$this->mTitle = null;
return $this->mTitle;
}
$this->mFilteredName = $nt->getDBkey();
/**
* We'll want to prevent against *any* 'extension', and use
* only the final one for the allow list.
*/
[ $partname, $ext ] = self::splitExtensions( $this->mFilteredName );
if ( $ext !== [] ) {
$this->mFinalExtension = trim( end( $ext ) );
} else {
$this->mFinalExtension = '';
// No extension, try guessing one from the temporary file
// FIXME: Sometimes we mTempPath isn't set yet here, possibly due to an unrealistic
// or incomplete test case in UploadBaseTest (T272328)
if ( $this->mTempPath !== null ) {
$magic = MediaWikiServices::getInstance()->getMimeAnalyzer();
$mime = $magic->guessMimeType( $this->mTempPath );
if ( $mime !== 'unknown/unknown' ) {
# Get a space separated list of extensions
$mimeExt = $magic->getExtensionFromMimeTypeOrNull( $mime );
if ( $mimeExt !== null ) {
# Set the extension to the canonical extension
$this->mFinalExtension = $mimeExt;
# Fix up the other variables
$this->mFilteredName .= ".{$this->mFinalExtension}";
$nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
$ext = [ $this->mFinalExtension ];
}
}
}
}
// Don't allow users to override the list of prohibited file extensions (check file extension)
$config = MediaWikiServices::getInstance()->getMainConfig();
$checkFileExtensions = $config->get( MainConfigNames::CheckFileExtensions );
$strictFileExtensions = $config->get( MainConfigNames::StrictFileExtensions );
$fileExtensions = $config->get( MainConfigNames::FileExtensions );
$prohibitedFileExtensions = $config->get( MainConfigNames::ProhibitedFileExtensions );
$badList = self::checkFileExtensionList( $ext, $prohibitedFileExtensions );
if ( $this->mFinalExtension == '' ) {
$this->mTitleError = self::FILETYPE_MISSING;
$this->mTitle = null;
return $this->mTitle;
}
if ( $badList ||
( $checkFileExtensions && $strictFileExtensions &&
!self::checkFileExtension( $this->mFinalExtension, $fileExtensions ) )
) {
$this->mBlackListedExtensions = $badList;
$this->mTitleError = self::FILETYPE_BADTYPE;
$this->mTitle = null;
return $this->mTitle;
}
// Windows may be broken with special characters, see T3780
if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
&& !MediaWikiServices::getInstance()->getRepoGroup()
->getLocalRepo()->backendSupportsUnicodePaths()
) {
$this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
$this->mTitle = null;
return $this->mTitle;
}
# If there was more than one file "extension", reassemble the base
# filename to prevent bogus complaints about length
if ( count( $ext ) > 1 ) {
$iterations = count( $ext ) - 1;
for ( $i = 0; $i < $iterations; $i++ ) {
$partname .= '.' . $ext[$i];
}
}
if ( strlen( $partname ) < 1 ) {
$this->mTitleError = self::MIN_LENGTH_PARTNAME;
$this->mTitle = null;
return $this->mTitle;
}
$this->mTitle = $nt;
return $this->mTitle;
}
/**
* Return the local file and initializes if necessary.
*
* @stable to override
* @return LocalFile|null
*/
public function getLocalFile() {
if ( $this->mLocalFile === null ) {
$nt = $this->getTitle();
$this->mLocalFile = $nt === null
? null
: MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()->newFile( $nt );
}
return $this->mLocalFile;
}
/**
* @return UploadStashFile|null
*/
public function getStashFile() {
return $this->mStashFile;
}
/**
* Like stashFile(), but respects extensions' wishes to prevent the stashing. verifyUpload() must
* be called before calling this method (unless $isPartial is true).
*
* Upload stash exceptions are also caught and converted to an error status.
*
* @since 1.28
* @stable to override
* @param User $user
* @param bool $isPartial Pass `true` if this is a part of a chunked upload (not a complete file).
* @return Status If successful, value is an UploadStashFile instance
*/
public function tryStashFile( User $user, $isPartial = false ) {
if ( !$isPartial ) {
$error = $this->runUploadStashFileHook( $user );
if ( $error ) {
return Status::newFatal( ...$error );
}
}
try {
$file = $this->doStashFile( $user );
return Status::newGood( $file );
} catch ( UploadStashException $e ) {
return Status::newFatal( 'uploadstash-exception', get_class( $e ), $e->getMessage() );
}
}
/**
* @param User $user
* @return array|null Error message and parameters, null if there's no error
*/
protected function runUploadStashFileHook( User $user ) {
$props = $this->mFileProps;
$error = null;
$this->getHookRunner()->onUploadStashFile( $this, $user, $props, $error );
if ( $error && !is_array( $error ) ) {
$error = [ $error ];
}
return $error;
}
/**
* Implementation for stashFile() and tryStashFile().
*
* @stable to override
* @param User|null $user
* @return UploadStashFile Stashed file
*/
protected function doStashFile( ?User $user = null ) {
$stash = MediaWikiServices::getInstance()->getRepoGroup()
->getLocalRepo()->getUploadStash( $user );
$file = $stash->stashFile( $this->mTempPath, $this->getSourceType(), $this->mFileProps );
$this->mStashFile = $file;
return $file;
}
/**
* If we've modified the upload file, then we need to manually remove it
* on exit to clean up.
*/
public function cleanupTempFile() {
if ( $this->mRemoveTempFile && $this->tempFileObj ) {
// Delete when all relevant TempFSFile handles go out of scope
wfDebug( __METHOD__ . ": Marked temporary file '{$this->mTempPath}' for removal" );
$this->tempFileObj->autocollect();
}
}
/**
* @return string|null
*/
public function getTempPath() {
return $this->mTempPath;
}
/**
* Split a file into a base name and all dot-delimited 'extensions'
* on the end. Some web server configurations will fall back to
* earlier pseudo-'extensions' to determine type and execute
* scripts, so we need to check them all.
*
* @param string $filename
* @return array [ string, string[] ]
*/
public static function splitExtensions( $filename ) {
$bits = explode( '.', $filename );
$basename = array_shift( $bits );
return [ $basename, $bits ];
}
/**
* Perform case-insensitive match against a list of file extensions.
*
* @param string $ext File extension
* @param array $list
* @return bool Returns true if the extension is in the list.
*/
public static function checkFileExtension( $ext, $list ) {
return in_array( strtolower( $ext ?? '' ), $list, true );
}
/**
* Perform case-insensitive match against a list of file extensions.
* Returns an array of matching extensions.
*
* @param string[] $ext File extensions
* @param string[] $list
* @return string[]
*/
public static function checkFileExtensionList( $ext, $list ) {
return array_intersect( array_map( 'strtolower', $ext ), $list );
}
/**
* Checks if the MIME type of the uploaded file matches the file extension.
*
* @param string $mime The MIME type of the uploaded file
* @param string $extension The filename extension that the file is to be served with
* @return bool
*/
public static function verifyExtension( $mime, $extension ) {
$magic = MediaWikiServices::getInstance()->getMimeAnalyzer();
if ( !$mime || $mime === 'unknown' || $mime === 'unknown/unknown' ) {
if ( !$magic->isRecognizableExtension( $extension ) ) {
wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
"unrecognized extension '$extension', can't verify" );
return true;
}
wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; " .
"recognized extension '$extension', so probably invalid file" );
return false;
}
$match = $magic->isMatchingExtension( $extension, $mime );
if ( $match === null ) {
if ( $magic->getMimeTypesFromExtension( $extension ) !== [] ) {
wfDebug( __METHOD__ . ": No extension known for $mime, but we know a mime for $extension" );
return false;
}
wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file" );
return true;
}
if ( $match ) {
wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file" );
/** @todo If it's a bitmap, make sure PHP or ImageMagick resp. can handle it! */
return true;
}
wfDebug( __METHOD__
. ": mime type $mime mismatches file extension $extension, rejecting file" );
return false;
}
/**
* Heuristic for detecting files that *could* contain JavaScript instructions or
* things that may look like HTML to a browser and are thus
* potentially harmful. The present implementation will produce false
* positives in some situations.
*
* @param string|null $file Pathname to the temporary upload file
* @param string $mime The MIME type of the file
* @param string|null $extension The extension of the file
* @return bool True if the file contains something looking like embedded scripts
*/
public static function detectScript( $file, $mime, $extension ) {
# ugly hack: for text files, always look at the entire file.
# For binary field, just check the first K.
if ( str_starts_with( $mime ?? '', 'text/' ) ) {
$chunk = file_get_contents( $file );
} else {
$fp = fopen( $file, 'rb' );
if ( !$fp ) {
return false;
}
$chunk = fread( $fp, 1024 );
fclose( $fp );
}
$chunk = strtolower( $chunk );
if ( !$chunk ) {
return false;
}
# decode from UTF-16 if needed (could be used for obfuscation).
if ( str_starts_with( $chunk, "\xfe\xff" ) ) {
$enc = 'UTF-16BE';
} elseif ( str_starts_with( $chunk, "\xff\xfe" ) ) {
$enc = 'UTF-16LE';
} else {
$enc = null;
}
if ( $enc !== null ) {
AtEase::suppressWarnings();
$chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
AtEase::restoreWarnings();
}
$chunk = trim( $chunk );
/** @todo FIXME: Convert from UTF-16 if necessary! */
wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff" );
# check for HTML doctype
if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
return true;
}
// Some browsers will interpret obscure xml encodings as UTF-8, while
// PHP/expat will interpret the given encoding in the xml declaration (T49304)
if ( $extension === 'svg' || str_starts_with( $mime ?? '', 'image/svg' ) ) {
if ( self::checkXMLEncodingMissmatch( $file ) ) {
return true;
}
}
// Quick check for HTML heuristics in old IE and Safari.
//
// The exact heuristics IE uses are checked separately via verifyMimeType(), so we
// don't need them all here as it can cause many false positives.
//
// Check for `<script` and such still to forbid script tags and embedded HTML in SVG:
$tags = [
'<body',
'<head',
'<html', # also in safari
'<script', # also in safari
];
foreach ( $tags as $tag ) {
if ( strpos( $chunk, $tag ) !== false ) {
wfDebug( __METHOD__ . ": found something that may make it be mistaken for html: $tag" );
return true;
}
}
/*
* look for JavaScript
*/
# resolve entity-refs to look at attributes. may be harsh on big files... cache result?
$chunk = Sanitizer::decodeCharReferences( $chunk );
# look for script-types
if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!im', $chunk ) ) {
wfDebug( __METHOD__ . ": found script types" );
return true;
}
# look for html-style script-urls
if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!im', $chunk ) ) {
wfDebug( __METHOD__ . ": found html-style script urls" );
return true;
}
# look for css-style script-urls
if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!im', $chunk ) ) {
wfDebug( __METHOD__ . ": found css-style script urls" );
return true;
}
wfDebug( __METHOD__ . ": no scripts found" );
return false;
}
/**
* Check an allowed list of xml encodings that are known not to be interpreted differently
* by the server's xml parser (expat) and some common browsers.
*
* @param string $file Pathname to the temporary upload file
* @return bool True if the file contains an encoding that could be misinterpreted
*/
public static function checkXMLEncodingMissmatch( $file ) {
// https://mimesniff.spec.whatwg.org/#resource-header says browsers
// should read the first 1445 bytes. Do 4096 bytes for good measure.
// XML Spec says XML declaration if present must be first thing in file
// other than BOM
$contents = file_get_contents( $file, false, null, 0, 4096 );
$encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
if ( preg_match( $encodingRegex, $matches[1], $encMatch )
&& !in_array( strtoupper( $encMatch[1] ), self::SAFE_XML_ENCONDINGS )
) {
wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'" );
return true;
}
} elseif ( preg_match( "!<\?xml\b!i", $contents ) ) {
// Start of XML declaration without an end in the first 4096 bytes
// bytes. There shouldn't be a legitimate reason for this to happen.
wfDebug( __METHOD__ . ": Unmatched XML declaration start" );
return true;
} elseif ( str_starts_with( $contents, "\x4C\x6F\xA7\x94" ) ) {
// EBCDIC encoded XML
wfDebug( __METHOD__ . ": EBCDIC Encoded XML" );
return true;
}
// It's possible the file is encoded with multibyte encoding, so re-encode attempt to
// detect the encoding in case it specifies an encoding not allowed in self::SAFE_XML_ENCONDINGS
$attemptEncodings = [ 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' ];
foreach ( $attemptEncodings as $encoding ) {
AtEase::suppressWarnings();
$str = iconv( $encoding, 'UTF-8', $contents );
AtEase::restoreWarnings();
if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
if ( preg_match( $encodingRegex, $matches[1], $encMatch )
&& !in_array( strtoupper( $encMatch[1] ), self::SAFE_XML_ENCONDINGS )
) {
wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'" );
return true;
}
} elseif ( $str != '' && preg_match( "!<\?xml\b!i", $str ) ) {
// Start of XML declaration without an end in the first 4096 bytes
// bytes. There shouldn't be a legitimate reason for this to happen.
wfDebug( __METHOD__ . ": Unmatched XML declaration start" );
return true;
}
}
return false;
}
/**
* @param string $filename
* @param bool $partial
* @return bool|array
*/
protected function detectScriptInSvg( $filename, $partial ) {
$this->mSVGNSError = false;
$check = new XmlTypeCheck(
$filename,
[ $this, 'checkSvgScriptCallback' ],
true,
[
'processing_instruction_handler' => [ __CLASS__, 'checkSvgPICallback' ],
'external_dtd_handler' => [ __CLASS__, 'checkSvgExternalDTD' ],
]
);
if ( $check->wellFormed !== true ) {
// Invalid xml (T60553)
// But only when non-partial (T67724)
return $partial ? false : [ 'uploadinvalidxml' ];
}
if ( $check->filterMatch ) {
if ( $this->mSVGNSError ) {
return [ 'uploadscriptednamespace', $this->mSVGNSError ];
}
return $check->filterMatchType;
}
return false;
}
/**
* Callback to filter SVG Processing Instructions.
*
* @param string $target Processing instruction name
* @param string $data Processing instruction attribute and value
* @return bool|array
*/
public static function checkSvgPICallback( $target, $data ) {
// Don't allow external stylesheets (T59550)
if ( preg_match( '/xml-stylesheet/i', $target ) ) {
return [ 'upload-scripted-pi-callback' ];
}
return false;
}
/**
* Verify that DTD URLs referenced are only the standard DTDs.
*
* Browsers seem to ignore external DTDs.
*
* However, just to be on the safe side, only allow DTDs from the SVG standard.
*
* @param string $type PUBLIC or SYSTEM
* @param string $publicId The well-known public identifier for the dtd
* @param string $systemId The url for the external dtd
* @return bool|array
*/
public static function checkSvgExternalDTD( $type, $publicId, $systemId ) {
// This doesn't include the XHTML+MathML+SVG doctype since we don't
// allow XHTML anyway.
static $allowedDTDs = [
'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd',
'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd',
'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd',
'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd',
// https://phabricator.wikimedia.org/T168856
'http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd',
];
if ( $type !== 'PUBLIC'
|| !in_array( $systemId, $allowedDTDs )
|| !str_starts_with( $publicId, "-//W3C//" )
) {
return [ 'upload-scripted-dtd' ];
}
return false;
}
/**
* @todo Replace this with a allow list filter!
* @param string $element
* @param array $attribs
* @param string|null $data
* @return bool|array
*/
public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
[ $namespace, $strippedElement ] = self::splitXmlNamespace( $element );
// We specifically don't include:
// http://www.w3.org/1999/xhtml (T62771)
static $validNamespaces = [
'',
'adobe:ns:meta/',
'http://creativecommons.org/ns#',
'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
'http://ns.adobe.com/adobeillustrator/10.0/',
'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
'http://ns.adobe.com/extensibility/1.0/',
'http://ns.adobe.com/flows/1.0/',
'http://ns.adobe.com/illustrator/1.0/',
'http://ns.adobe.com/imagereplacement/1.0/',
'http://ns.adobe.com/pdf/1.3/',
'http://ns.adobe.com/photoshop/1.0/',
'http://ns.adobe.com/saveforweb/1.0/',
'http://ns.adobe.com/variables/1.0/',
'http://ns.adobe.com/xap/1.0/',
'http://ns.adobe.com/xap/1.0/g/',
'http://ns.adobe.com/xap/1.0/g/img/',
'http://ns.adobe.com/xap/1.0/mm/',
'http://ns.adobe.com/xap/1.0/rights/',
'http://ns.adobe.com/xap/1.0/stype/dimensions#',
'http://ns.adobe.com/xap/1.0/stype/font#',
'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
'http://ns.adobe.com/xap/1.0/stype/resourceref#',
'http://ns.adobe.com/xap/1.0/t/pg/',
'http://purl.org/dc/elements/1.1/',
'http://purl.org/dc/elements/1.1',
'http://schemas.microsoft.com/visio/2003/svgextensions/',
'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
'http://taptrix.com/inkpad/svg_extensions',
'http://web.resource.org/cc/',
'http://www.freesoftware.fsf.org/bkchem/cdml',
'http://www.inkscape.org/namespaces/inkscape',
'http://www.opengis.net/gml',
'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
'http://www.w3.org/2000/svg',
'http://www.w3.org/tr/rec-rdf-syntax/',
'http://www.w3.org/2000/01/rdf-schema#',
'http://www.w3.org/2000/02/svg/testsuite/description/', // https://phabricator.wikimedia.org/T278044
];
// Inkscape mangles namespace definitions created by Adobe Illustrator.
// This is nasty but harmless. (T144827)
$isBuggyInkscape = preg_match( '/^&(#38;)*ns_[a-z_]+;$/', $namespace );
if ( !( $isBuggyInkscape || in_array( $namespace, $validNamespaces ) ) ) {
wfDebug( __METHOD__ . ": Non-svg namespace '$namespace' in uploaded file." );
/** @todo Return a status object to a closure in XmlTypeCheck, for MW1.21+ */
$this->mSVGNSError = $namespace;
return true;
}
// check for elements that can contain javascript
if ( $strippedElement === 'script' ) {
wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file." );
return [ 'uploaded-script-svg', $strippedElement ];
}
// e.g., <svg xmlns="http://www.w3.org/2000/svg">
// <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
if ( $strippedElement === 'handler' ) {
wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file." );
return [ 'uploaded-script-svg', $strippedElement ];
}
// SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
if ( $strippedElement === 'stylesheet' ) {
wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file." );
return [ 'uploaded-script-svg', $strippedElement ];
}
// Block iframes, in case they pass the namespace check
if ( $strippedElement === 'iframe' ) {
wfDebug( __METHOD__ . ": iframe in uploaded file." );
return [ 'uploaded-script-svg', $strippedElement ];
}
// Check <style> css
if ( $strippedElement === 'style'
&& self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
) {
wfDebug( __METHOD__ . ": hostile css in style element." );
return [ 'uploaded-hostile-svg' ];
}
static $cssAttrs = [ 'font', 'clip-path', 'fill', 'filter', 'marker',
'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' ];
foreach ( $attribs as $attrib => $value ) {
// If attributeNamespace is '', it is relative to its element's namespace
[ $attributeNamespace, $stripped ] = self::splitXmlNamespace( $attrib );
$value = strtolower( $value );
if ( !(
// Inkscape element's have valid attribs that start with on and are safe, fail all others
$namespace === 'http://www.inkscape.org/namespaces/inkscape' &&
$attributeNamespace === ''
) && str_starts_with( $stripped, 'on' )
) {
wfDebug( __METHOD__
. ": Found event-handler attribute '$attrib'='$value' in uploaded file." );
return [ 'uploaded-event-handler-on-svg', $attrib, $value ];
}
// Do not allow relative links, or unsafe url schemas.
// For <a> tags, only data:, http: and https: and same-document
// fragment links are allowed.
// For all other tags, only 'data:' and fragments (#) are allowed.
if (
$stripped === 'href'
&& $value !== ''
&& !str_starts_with( $value, 'data:' )
&& !str_starts_with( $value, '#' )
&& !( $strippedElement === 'a' && preg_match( '!^https?://!i', $value ) )
) {
wfDebug( __METHOD__ . ": Found href attribute <$strippedElement "
. "'$attrib'='$value' in uploaded file." );
return [ 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
}
// Only allow 'data:\' targets that should be safe.
// This prevents vectors like image/svg, text/xml, application/xml, and text/html, which can contain scripts
if ( $stripped === 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
// RFC2397 parameters.
// This is only slightly slower than (;[\w;]+)*.
// phpcs:ignore Generic.Files.LineLength
$parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
wfDebug( __METHOD__ . ": Found href to allow listed data: uri "
. "\"<$strippedElement '$attrib'='$value'...\" in uploaded file." );
return [ 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
}
}
// Change href with animate from (http://html5sec.org/#137).
if ( $stripped === 'attributename'
&& $strippedElement === 'animate'
&& $this->stripXmlNamespace( $value ) === 'href'
) {
wfDebug( __METHOD__ . ": Found animate that might be changing href using from "
. "\"<$strippedElement '$attrib'='$value'...\" in uploaded file." );
return [ 'uploaded-animate-svg', $strippedElement, $attrib, $value ];
}
// Use set/animate to add event-handler attribute to parent.
if ( ( $strippedElement === 'set' || $strippedElement === 'animate' )
&& $stripped === 'attributename'
&& str_starts_with( $value, 'on' )
) {
wfDebug( __METHOD__ . ": Found svg setting event-handler attribute with "
. "\"<$strippedElement $stripped='$value'...\" in uploaded file." );
return [ 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
}
// use set to add href attribute to parent element.
if ( $strippedElement === 'set'
&& $stripped === 'attributename'
&& str_contains( $value, 'href' )
) {
wfDebug( __METHOD__ . ": Found svg setting href attribute '$value' in uploaded file." );
return [ 'uploaded-setting-href-svg' ];
}
// use set to add a remote / data / script target to an element.
if ( $strippedElement === 'set'
&& $stripped === 'to'
&& preg_match( '!(http|https|data|script):!im', $value )
) {
wfDebug( __METHOD__ . ": Found svg setting attribute to '$value' in uploaded file." );
return [ 'uploaded-wrong-setting-svg', $value ];
}
// use handler attribute with remote / data / script.
if ( $stripped === 'handler' && preg_match( '!(http|https|data|script):!im', $value ) ) {
wfDebug( __METHOD__ . ": Found svg setting handler with remote/data/script "
. "'$attrib'='$value' in uploaded file." );
return [ 'uploaded-setting-handler-svg', $attrib, $value ];
}
// use CSS styles to bring in remote code.
if ( $stripped === 'style'
&& self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
) {
wfDebug( __METHOD__ . ": Found svg setting a style with "
. "remote url '$attrib'='$value' in uploaded file." );
return [ 'uploaded-remote-url-svg', $attrib, $value ];
}
// Several attributes can include css, css character escaping isn't allowed.
if ( in_array( $stripped, $cssAttrs, true )
&& self::checkCssFragment( $value )
) {
wfDebug( __METHOD__ . ": Found svg setting a style with "
. "remote url '$attrib'='$value' in uploaded file." );
return [ 'uploaded-remote-url-svg', $attrib, $value ];
}
// image filters can pull in url, which could be svg that executes scripts.
// Only allow url( "#foo" ).
// Do not allow url( http://example.com )
if ( $strippedElement === 'image'
&& $stripped === 'filter'
&& preg_match( '!url\s*\(\s*["\']?[^#]!im', $value )
) {
wfDebug( __METHOD__ . ": Found image filter with url: "
. "\"<$strippedElement $stripped='$value'...\" in uploaded file." );
return [ 'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
}
}
return false; // No scripts detected
}
/**
* Check a block of CSS or CSS fragment for anything that looks like
* it is bringing in remote code.
* @param string $value a string of CSS
* @return bool true if the CSS contains an illegal string, false if otherwise
*/
private static function checkCssFragment( $value ) {
# Forbid external stylesheets, for both reliability and to protect viewer's privacy
if ( stripos( $value, '@import' ) !== false ) {
return true;
}
# We allow @font-face to embed fonts with data: urls, so we snip the string
# 'url' out so that this case won't match when we check for urls below
$pattern = '!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
$value = preg_replace( $pattern, '$1$2', $value );
# Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
# properties filter and accelerator don't seem to be useful for xss in SVG files.
# Expression and -o-link don't seem to work either, but filtering them here in case.
# Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
# but not local ones such as url("#..., url('#..., url(#....
if ( preg_match( '!expression
| -o-link\s*:
| -o-link-source\s*:
| -o-replace\s*:!imx', $value ) ) {
return true;
}
if ( preg_match_all(
"!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
$value,
$matches
) !== 0
) {
# TODO: redo this in one regex. Until then, url("#whatever") matches the first
foreach ( $matches[1] as $match ) {
if ( !preg_match( "!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
return true;
}
}
}
return (bool)preg_match( '/[\000-\010\013\016-\037\177]/', $value );
}
/**
* Divide the element name passed by the XML parser to the callback into URI and prefix.
* @param string $element
* @return array Containing the namespace URI and prefix
*/
private static function splitXmlNamespace( $element ) {
// 'http://www.w3.org/2000/svg:script' -> [ 'http://www.w3.org/2000/svg', 'script' ]
$parts = explode( ':', strtolower( $element ) );
$name = array_pop( $parts );
$ns = implode( ':', $parts );
return [ $ns, $name ];
}
/**
* @param string $element
* @return string
*/
private function stripXmlNamespace( $element ) {
// 'http://www.w3.org/2000/svg:script' -> 'script'
return self::splitXmlNamespace( $element )[1];
}
/**
* Generic wrapper function for a virus scanner program.
* This relies on the $wgAntivirus and $wgAntivirusSetup variables.
* $wgAntivirusRequired may be used to deny upload if the scan fails.
*
* @param string $file Pathname to the temporary upload file
* @return bool|null|string False if not virus is found, null if the scan fails or is disabled,
* or a string containing feedback from the virus scanner if a virus was found.
* If textual feedback is missing but a virus was found, this function returns true.
*/
public static function detectVirus( $file ) {
global $wgOut;
$mainConfig = MediaWikiServices::getInstance()->getMainConfig();
$antivirus = $mainConfig->get( MainConfigNames::Antivirus );
$antivirusSetup = $mainConfig->get( MainConfigNames::AntivirusSetup );
$antivirusRequired = $mainConfig->get( MainConfigNames::AntivirusRequired );
if ( !$antivirus ) {
wfDebug( __METHOD__ . ": virus scanner disabled" );
return null;
}
if ( !$antivirusSetup[$antivirus] ) {
wfDebug( __METHOD__ . ": unknown virus scanner: {$antivirus}" );
$wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
[ 'virus-badscanner', $antivirus ] );
return wfMessage( 'virus-unknownscanner' )->text() . " {$antivirus}";
}
# look up scanner configuration
$command = $antivirusSetup[$antivirus]['command'];
$exitCodeMap = $antivirusSetup[$antivirus]['codemap'];
$msgPattern = $antivirusSetup[$antivirus]['messagepattern'] ?? null;
if ( !str_contains( $command, "%f" ) ) {
# simple pattern: append file to scan
$command .= " " . Shell::escape( $file );
} else {
# complex pattern: replace "%f" with file to scan
$command = str_replace( "%f", Shell::escape( $file ), $command );
}
wfDebug( __METHOD__ . ": running virus scan: $command " );
# execute virus scanner
$exitCode = false;
# NOTE: there's a 50-line workaround to make stderr redirection work on windows, too.
# that does not seem to be worth the pain.
# Ask me (Duesentrieb) about it if it's ever needed.
$output = wfShellExecWithStderr( $command, $exitCode );
# map exit code to AV_xxx constants.
$mappedCode = $exitCode;
if ( $exitCodeMap ) {
if ( isset( $exitCodeMap[$exitCode] ) ) {
$mappedCode = $exitCodeMap[$exitCode];
} elseif ( isset( $exitCodeMap["*"] ) ) {
$mappedCode = $exitCodeMap["*"];
}
}
# NB: AV_NO_VIRUS is 0, but AV_SCAN_FAILED is false,
# so we need the strict equalities === and thus can't use a switch here
if ( $mappedCode === AV_SCAN_FAILED ) {
# scan failed (code was mapped to false by $exitCodeMap)
wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode)." );
$output = $antivirusRequired
? wfMessage( 'virus-scanfailed', [ $exitCode ] )->text()
: null;
} elseif ( $mappedCode === AV_SCAN_ABORTED ) {
# scan failed because filetype is unknown (probably immune)
wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode)." );
$output = null;
} elseif ( $mappedCode === AV_NO_VIRUS ) {
# no virus found
wfDebug( __METHOD__ . ": file passed virus scan." );
$output = false;
} else {
$output = trim( $output );
if ( !$output ) {
$output = true; # if there's no output, return true
} elseif ( $msgPattern ) {
$groups = [];
if ( preg_match( $msgPattern, $output, $groups ) && $groups[1] ) {
$output = $groups[1];
}
}
wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output" );
}
return $output;
}
/**
* Check if there's a file overwrite conflict and, if so, if restrictions
* forbid this user from performing the upload.
*
* @param Authority $performer
*
* @return bool|array
*/
private function checkOverwrite( Authority $performer ) {
// First check whether the local file can be overwritten
$file = $this->getLocalFile();
$file->load( IDBAccessObject::READ_LATEST );
if ( $file->exists() ) {
if ( !self::userCanReUpload( $performer, $file ) ) {
return [ 'fileexists-forbidden', $file->getName() ];
}
return true;
}
$services = MediaWikiServices::getInstance();
/* Check shared conflicts: if the local file does not exist, but
* RepoGroup::findFile finds a file, it exists in a shared repository.
*/
$file = $services->getRepoGroup()->findFile( $this->getTitle(), [ 'latest' => true ] );
if ( $file && !$performer->isAllowed( 'reupload-shared' ) ) {
return [ 'fileexists-shared-forbidden', $file->getName() ];
}
return true;
}
/**
* Check if a user is the last uploader
*
* @param Authority $performer
* @param File $img
* @return bool
*/
public static function userCanReUpload( Authority $performer, File $img ) {
if ( $performer->isAllowed( 'reupload' ) ) {
return true; // non-conditional
}
if ( !$performer->isAllowed( 'reupload-own' ) ) {
return false;
}
if ( !( $img instanceof LocalFile ) ) {
return false;
}
return $performer->getUser()->equals( $img->getUploader( File::RAW ) );
}
/**
* Helper function that does various existence checks for a file.
* The following checks are performed:
* - If the file exists
* - If an article with the same name as the file exists
* - If a file exists with normalized extension
* - If the file looks like a thumbnail and the original exists
*
* @param File $file The File object to check
* @return array|false False if the file does not exist, else an array
*/
public static function getExistsWarning( $file ) {
if ( $file->exists() ) {
return [ 'warning' => 'exists', 'file' => $file ];
}
if ( $file->getTitle()->getArticleID() ) {
return [ 'warning' => 'page-exists', 'file' => $file ];
}
$n = strrpos( $file->getName(), '.' );
if ( $n > 0 ) {
$partname = substr( $file->getName(), 0, $n );
$extension = substr( $file->getName(), $n + 1 );
} else {
$partname = $file->getName();
$extension = '';
}
$normalizedExtension = File::normalizeExtension( $extension );
$localRepo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
if ( $normalizedExtension != $extension ) {
// We're not using the normalized form of the extension.
// Normal form is lowercase, using most common of alternate
// extensions (e.g. 'jpg' rather than 'JPEG').
// Check for another file using the normalized form...
$nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
$file_lc = $localRepo->newFile( $nt_lc );
if ( $file_lc->exists() ) {
return [
'warning' => 'exists-normalized',
'file' => $file,
'normalizedFile' => $file_lc
];
}
}
// Check for files with the same name but a different extension
$similarFiles = $localRepo->findFilesByPrefix( "{$partname}.", 1 );
if ( count( $similarFiles ) ) {
return [
'warning' => 'exists-normalized',
'file' => $file,
'normalizedFile' => $similarFiles[0],
];
}
if ( self::isThumbName( $file->getName() ) ) {
// Check for filenames like 50px- or 180px-, these are mostly thumbnails
$nt_thb = Title::newFromText(
substr( $partname, strpos( $partname, '-' ) + 1 ) . '.' . $extension,
NS_FILE
);
$file_thb = $localRepo->newFile( $nt_thb );
if ( $file_thb->exists() ) {
return [
'warning' => 'thumb',
'file' => $file,
'thumbFile' => $file_thb
];
}
// The file does not exist, but we just don't like the name
return [
'warning' => 'thumb-name',
'file' => $file,
'thumbFile' => $file_thb
];
}
foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
if ( str_starts_with( $partname, $prefix ) ) {
return [
'warning' => 'bad-prefix',
'file' => $file,
'prefix' => $prefix
];
}
}
return false;
}
/**
* Helper function that checks whether the filename looks like a thumbnail
* @param string $filename
* @return bool
*/
public static function isThumbName( $filename ) {
$n = strrpos( $filename, '.' );
$partname = $n ? substr( $filename, 0, $n ) : $filename;
return (
substr( $partname, 3, 3 ) === 'px-' ||
substr( $partname, 2, 3 ) === 'px-'
) && preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
}
/**
* Get a list of disallowed filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]
*
* @return string[] List of prefixes
*/
public static function getFilenamePrefixBlacklist() {
$list = [];
$message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
if ( !$message->isDisabled() ) {
$lines = explode( "\n", $message->plain() );
foreach ( $lines as $line ) {
// Remove comment lines
$comment = substr( trim( $line ), 0, 1 );
if ( $comment === '#' || $comment == '' ) {
continue;
}
// Remove additional comments after a prefix
$comment = strpos( $line, '#' );
if ( $comment > 0 ) {
$line = substr( $line, 0, $comment - 1 );
}
$list[] = trim( $line );
}
}
return $list;
}
/**
* Gets image info about the file just uploaded.
*
* @deprecated since 1.42, subclasses of ApiUpload can use
* ApiUpload::getUploadImageInfo() instead.
*
* @param ?ApiResult $result unused since 1.42
* @return array Image info
*/
public function getImageInfo( $result = null ) {
$apiUpload = ApiUpload::getDummyInstance();
return $apiUpload->getUploadImageInfo( $this );
}
/**
* @param array $error
* @return Status
*/
public function convertVerifyErrorToStatus( $error ) {
$code = $error['status'];
unset( $code['status'] );
return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
}
/**
* Get MediaWiki's maximum uploaded file size for a given type of upload, based on
* $wgMaxUploadSize.
*
* @param null|string $forType
* @return int
*/
public static function getMaxUploadSize( $forType = null ) {
$maxUploadSize = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::MaxUploadSize );
if ( is_array( $maxUploadSize ) ) {
return $maxUploadSize[$forType] ?? $maxUploadSize['*'];
}
return intval( $maxUploadSize );
}
/**
* Get the PHP maximum uploaded file size, based on ini settings. If there is no limit or the
* limit can't be guessed, return a very large number (PHP_INT_MAX) instead.
*
* @since 1.27
* @return int
*/
public static function getMaxPhpUploadSize() {
$phpMaxFileSize = wfShorthandToInteger(
ini_get( 'upload_max_filesize' ),
PHP_INT_MAX
);
$phpMaxPostSize = wfShorthandToInteger(
ini_get( 'post_max_size' ),
PHP_INT_MAX
) ?: PHP_INT_MAX;
return min( $phpMaxFileSize, $phpMaxPostSize );
}
/**
* Get the current status of a chunked upload (used for polling).
*
* This should only be called during POST requests since we
* fetch from dc-local MainStash, and from a GET request we can't
* know that the value is available or up-to-date.
*
* @param UserIdentity $user
* @param string $statusKey
* @return mixed[]|false
*/
public static function getSessionStatus( UserIdentity $user, $statusKey ) {
$store = self::getUploadSessionStore();
$key = self::getUploadSessionKey( $store, $user, $statusKey );
return $store->get( $key );
}
/**
* Set the current status of a chunked upload (used for polling).
*
* The value will be set in cache for 1 day.
*
* This should only be called during POST requests.
*
* @param UserIdentity $user
* @param string $statusKey
* @param array|false $value
* @return void
*/
public static function setSessionStatus( UserIdentity $user, $statusKey, $value ) {
$store = self::getUploadSessionStore();
$key = self::getUploadSessionKey( $store, $user, $statusKey );
$logger = LoggerFactory::getInstance( 'upload' );
if ( is_array( $value ) && ( $value['result'] ?? '' ) === 'Failure' ) {
$logger->info( 'Upload session {key} for {user} set to failure {status} at {stage}',
[
'result' => $value['result'] ?? '',
'stage' => $value['stage'] ?? 'unknown',
'user' => $user->getName(),
'status' => (string)( $value['status'] ?? '-' ),
'filekey' => $value['filekey'] ?? '',
'key' => $statusKey
]
);
} elseif ( is_array( $value ) ) {
$logger->debug( 'Upload session {key} for {user} changed {status} at {stage}',
[
'result' => $value['result'] ?? '',
'stage' => $value['stage'] ?? 'unknown',
'user' => $user->getName(),
'status' => (string)( $value['status'] ?? '-' ),
'filekey' => $value['filekey'] ?? '',
'key' => $statusKey
]
);
} else {
$logger->debug( "Upload session {key} deleted for {user}",
[
'value' => $value,
'key' => $statusKey,
'user' => $user->getName()
]
);
}
if ( $value === false ) {
$store->delete( $key );
} else {
$store->set( $key, $value, $store::TTL_DAY );
}
}
/**
* @param BagOStuff $store
* @param UserIdentity $user
* @param string $statusKey
* @return string
*/
private static function getUploadSessionKey( BagOStuff $store, UserIdentity $user, $statusKey ) {
return $store->makeKey(
'uploadstatus',
$user->isRegistered() ? $user->getId() : md5( $user->getName() ),
$statusKey
);
}
/**
* @return BagOStuff
*/
private static function getUploadSessionStore() {
return MediaWikiServices::getInstance()->getMainObjectStash();
}
}
|