29 define(
'MW_FILE_VERSION', 9 );
162 $file->loadFromRow( $row );
179 $conds = [
'img_sha1' =>
$sha1 ];
184 $row =
$dbr->selectRow(
'image', self::selectFields(), $conds, __METHOD__ );
186 return self::newFromRow( $row,
$repo );
224 $this->metadata =
'';
225 $this->historyLine = 0;
226 $this->historyRes = null;
227 $this->dataLoaded =
false;
228 $this->extraDataLoaded =
false;
240 $hashedName = md5( $this->
getName() );
242 return $this->repo->getSharedCacheKey(
'file', $hashedName );
250 $this->dataLoaded =
false;
251 $this->extraDataLoaded =
false;
259 $cachedValues =
$cache->get( $key );
262 if ( is_array( $cachedValues ) && $cachedValues[
'version'] ==
MW_FILE_VERSION ) {
263 $this->fileExists = $cachedValues[
'fileExists'];
264 if ( $this->fileExists ) {
267 $this->dataLoaded =
true;
268 $this->extraDataLoaded =
true;
270 $this->extraDataLoaded = $this->extraDataLoaded && isset( $cachedValues[$field] );
292 if ( $this->fileExists ) {
293 foreach ( $fields
as $field ) {
294 $cacheVal[$field] = $this->$field;
302 if ( isset( $cacheVal[$field] ) && strlen( $cacheVal[$field] ) > 100 * 1024 ) {
303 unset( $cacheVal[$field] );
308 $ttl = $this->fileExists ? 86400 * 7 : 86400;
322 $this->repo->getMasterDB()->onTransactionPreCommitOrIdle(
function()
use ( $key ) {
331 $props = $this->repo->getFileProps( $this->
getVirtualUrl() );
340 static $fields = [
'size',
'width',
'height',
'bits',
'media_type',
341 'major_mime',
'minor_mime',
'metadata',
'timestamp',
'sha1',
'user',
342 'user_text',
'description' ];
343 static $results = [];
345 if ( $prefix ==
'' ) {
349 if ( !isset( $results[$prefix] ) ) {
350 $prefixedFields = [];
351 foreach ( $fields
as $field ) {
352 $prefixedFields[] = $prefix . $field;
354 $results[$prefix] = $prefixedFields;
357 return $results[$prefix];
365 static $fields = [
'metadata' ];
366 static $results = [];
368 if ( $prefix ==
'' ) {
372 if ( !isset( $results[$prefix] ) ) {
373 $prefixedFields = [];
374 foreach ( $fields
as $field ) {
375 $prefixedFields[] = $prefix . $field;
377 $results[$prefix] = $prefixedFields;
380 return $results[$prefix];
388 $fname = get_class( $this ) .
'::' . __FUNCTION__;
390 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
391 $this->dataLoaded =
true;
392 $this->extraDataLoaded =
true;
395 ? $this->repo->getMasterDB()
396 : $this->repo->getSlaveDB();
404 $this->fileExists =
false;
413 $fname = get_class( $this ) .
'::' . __FUNCTION__;
415 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
416 $this->extraDataLoaded =
true;
428 throw new MWException(
"Could not find data for image '{$this->getName()}'." );
446 # File may have been uploaded over in the meantime; check the old versions
465 $array = (
array)$row;
466 $prefixLength = strlen( $prefix );
469 if ( substr(
key( $array ), 0, $prefixLength ) !== $prefix ) {
470 throw new MWException( __METHOD__ .
': incorrect $prefix parameter' );
494 $decoded[
'metadata'] = $this->repo->getSlaveDB()->decodeBlob( $decoded[
'metadata'] );
496 if ( empty( $decoded[
'major_mime'] ) ) {
497 $decoded[
'mime'] =
'unknown/unknown';
499 if ( !$decoded[
'minor_mime'] ) {
500 $decoded[
'minor_mime'] =
'unknown';
502 $decoded[
'mime'] = $decoded[
'major_mime'] .
'/' . $decoded[
'minor_mime'];
506 $decoded[
'sha1'] = rtrim( $decoded[
'sha1'],
"\0" );
512 foreach ( [
'size',
'width',
'height',
'bits' ]
as $field ) {
513 $decoded[$field] = +$decoded[$field];
526 $this->dataLoaded =
true;
527 $this->extraDataLoaded =
true;
529 $array = $this->
decodeRow( $row, $prefix );
535 $this->fileExists =
true;
544 if ( !$this->dataLoaded ) {
549 $this->dataLoaded =
true;
551 if ( (
$flags & self::LOAD_ALL ) && !$this->extraDataLoaded ) {
567 if ( is_null( $this->media_type ) ||
568 $this->mime ==
'image/svg'
589 $this->upgraded =
true;
605 # Don't destroy file info of missing files
606 if ( !$this->fileExists ) {
608 wfDebug( __METHOD__ .
": file does not exist, aborting\n" );
613 $dbw = $this->repo->getMasterDB();
614 list( $major, $minor ) = self::splitMime( $this->mime );
621 wfDebug( __METHOD__ .
': upgrading ' . $this->
getName() .
" to the current schema\n" );
623 $dbw->update(
'image',
625 'img_size' => $this->size,
626 'img_width' => $this->
width,
627 'img_height' => $this->height,
628 'img_bits' => $this->bits,
629 'img_media_type' => $this->media_type,
630 'img_major_mime' => $major,
631 'img_minor_mime' => $minor,
632 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
635 [
'img_name' => $this->
getName() ],
656 $this->dataLoaded =
true;
658 $fields[] =
'fileExists';
660 foreach ( $fields
as $field ) {
661 if ( isset( $info[$field] ) ) {
662 $this->$field = $info[$field];
667 if ( isset( $info[
'major_mime'] ) ) {
668 $this->mime =
"{$info['major_mime']}/{$info['minor_mime']}";
669 } elseif ( isset( $info[
'mime'] ) ) {
670 $this->mime = $info[
'mime'];
671 list( $this->major_mime, $this->minor_mime ) = self::splitMime( $this->mime );
687 if ( $this->missing === null ) {
711 return $dim[
'width'];
738 return $dim[
'height'];
758 if (
$type ==
'text' ) {
760 } elseif (
$type ==
'id' ) {
773 $pageId = $this->
title->getArticleID();
775 if ( $pageId !== null ) {
776 $url = $this->repo->makeUrl( [
'curid' => $pageId ] );
777 if (
$url !==
false ) {
789 $this->
load( self::LOAD_ALL );
865 if ( $archiveName ) {
871 $backend = $this->repo->getBackend();
874 $iterator = $backend->getFileList( [
'dir' =>
$dir ] );
875 foreach ( $iterator
as $file ) {
921 Hooks::run(
'LocalFilePurgeThumbnails', [ $this, $archiveName ] );
946 array_shift(
$urls );
949 if ( !empty(
$options[
'forThumbRefresh'] ) ) {
957 Hooks::run(
'LocalFilePurgeThumbnails', [ $this,
false ] );
973 $fileListDebug = strtr(
974 var_export(
$files,
true ),
977 wfDebug( __METHOD__ .
": $fileListDebug\n" );
981 # Check that the base file name is part of the thumb name
982 # This is a basic sanity check to avoid erasing unrelated directories
983 if ( strpos( $file, $this->
getName() ) !==
false
984 || strpos( $file,
"-thumbnail" ) !==
false
986 $purgeList[] =
"{$dir}/{$file}";
990 # Delete the thumbnails
991 $this->repo->quickPurgeBatch( $purgeList );
992 # Clear out the thumbnail directory if empty
993 $this->repo->quickCleanDir(
$dir );
1007 $dbr = $this->repo->getSlaveDB();
1010 $conds = $opts = $join_conds = [];
1011 $eq = $inc ?
'=' :
'';
1012 $conds[] =
"oi_name = " .
$dbr->addQuotes( $this->
title->getDBkey() );
1015 $conds[] =
"oi_timestamp <$eq " .
$dbr->addQuotes(
$dbr->timestamp( $start ) );
1019 $conds[] =
"oi_timestamp >$eq " .
$dbr->addQuotes(
$dbr->timestamp( $end ) );
1027 $order = ( !$start && $end !== null ) ?
'ASC' :
'DESC';
1028 $opts[
'ORDER BY'] =
"oi_timestamp $order";
1029 $opts[
'USE INDEX'] = [
'oldimage' =>
'oi_name_timestamp' ];
1032 &$conds, &$opts, &$join_conds ] );
1034 $res =
$dbr->select(
$tables, $fields, $conds, __METHOD__, $opts, $join_conds );
1037 foreach (
$res as $row ) {
1038 $r[] = $this->repo->newFileFromRow( $row );
1041 if ( $order ==
'ASC' ) {
1042 $r = array_reverse( $r );
1058 # Polymorphic function name to distinguish foreign and local fetches
1059 $fname = get_class( $this ) .
'::' . __FUNCTION__;
1061 $dbr = $this->repo->getSlaveDB();
1063 if ( $this->historyLine == 0 ) {
1064 $this->historyRes =
$dbr->select(
'image',
1067 "'' AS oi_archive_name",
1071 [
'img_name' => $this->
title->getDBkey() ],
1075 if ( 0 ==
$dbr->numRows( $this->historyRes ) ) {
1076 $this->historyRes = null;
1080 } elseif ( $this->historyLine == 1 ) {
1081 $this->historyRes =
$dbr->select(
'oldimage',
'*',
1082 [
'oi_name' => $this->
title->getDBkey() ],
1084 [
'ORDER BY' =>
'oi_timestamp DESC' ]
1087 $this->historyLine++;
1089 return $dbr->fetchObject( $this->historyRes );
1096 $this->historyLine = 0;
1098 if ( !is_null( $this->historyRes ) ) {
1099 $this->historyRes = null;
1138 if ( $this->
getRepo()->getReadOnlyReason() !==
false ) {
1142 $srcPath = ( $src instanceof
FSFile ) ? $src->getPath() : $src;
1144 if ( $this->repo->isVirtualUrl( $srcPath )
1147 $props = $this->repo->getFileProps( $srcPath );
1170 if (
$status->successCount >= 2 ) {
1179 $status->fatal(
'filenotfound', $srcPath );
1234 if ( is_null(
$user ) ) {
1239 $dbw = $this->repo->getMasterDB();
1241 # Imports or such might force a certain timestamp; otherwise we generate
1242 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1245 $allowTimeKludge =
true;
1247 $allowTimeKludge =
false;
1250 $props = $props ?: $this->repo->getFileProps( $this->
getVirtualUrl() );
1252 $props[
'user'] =
$user->getId();
1253 $props[
'user_text'] =
$user->getName();
1257 # Fail now if the file isn't there
1258 if ( !$this->fileExists ) {
1259 wfDebug( __METHOD__ .
": File " . $this->
getRel() .
" went missing!\n" );
1264 $dbw->startAtomic( __METHOD__ );
1266 # Test to see if the row exists using INSERT IGNORE
1267 # This avoids race conditions by locking the row until the commit, and also
1268 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1269 $dbw->insert(
'image',
1271 'img_name' => $this->
getName(),
1272 'img_size' => $this->size,
1273 'img_width' => intval( $this->
width ),
1274 'img_height' => intval( $this->height ),
1275 'img_bits' => $this->bits,
1276 'img_media_type' => $this->media_type,
1277 'img_major_mime' => $this->major_mime,
1278 'img_minor_mime' => $this->minor_mime,
1281 'img_user' =>
$user->getId(),
1282 'img_user_text' =>
$user->getName(),
1283 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1290 $reupload = ( $dbw->affectedRows() == 0 );
1292 if ( $allowTimeKludge ) {
1293 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1294 $ltimestamp = $dbw->selectField(
1297 [
'img_name' => $this->
getName() ],
1299 [
'LOCK IN SHARE MODE' ]
1302 # Avoid a timestamp that is not newer than the last version
1303 # TODO: the image/oldimage tables should be like page/revision with an ID field
1306 $timestamp = $dbw->timestamp( $lUnixtime + 1 );
1311 # (bug 34993) Note: $oldver can be empty here, if the previous
1312 # version of the file was broken. Allow registration of the new
1313 # version to continue anyway, because that's better than having
1314 # an image that's not fixable by user operations.
1315 # Collision, this is an update of a file
1316 # Insert previous contents into oldimage
1317 $dbw->insertSelect(
'oldimage',
'image',
1319 'oi_name' =>
'img_name',
1320 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1321 'oi_size' =>
'img_size',
1322 'oi_width' =>
'img_width',
1323 'oi_height' =>
'img_height',
1324 'oi_bits' =>
'img_bits',
1325 'oi_timestamp' =>
'img_timestamp',
1326 'oi_description' =>
'img_description',
1327 'oi_user' =>
'img_user',
1328 'oi_user_text' =>
'img_user_text',
1329 'oi_metadata' =>
'img_metadata',
1330 'oi_media_type' =>
'img_media_type',
1331 'oi_major_mime' =>
'img_major_mime',
1332 'oi_minor_mime' =>
'img_minor_mime',
1333 'oi_sha1' =>
'img_sha1'
1335 [
'img_name' => $this->
getName() ],
1339 # Update the current image row
1340 $dbw->update(
'image',
1342 'img_size' => $this->size,
1343 'img_width' => intval( $this->
width ),
1344 'img_height' => intval( $this->height ),
1345 'img_bits' => $this->bits,
1346 'img_media_type' => $this->media_type,
1347 'img_major_mime' => $this->major_mime,
1348 'img_minor_mime' => $this->minor_mime,
1351 'img_user' =>
$user->getId(),
1352 'img_user_text' =>
$user->getName(),
1353 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1356 [
'img_name' => $this->
getName() ],
1362 $descId = $descTitle->getArticleID();
1364 $wikiPage->setFile( $this );
1367 $logEntry =
new ManualLogEntry(
'upload', $reupload ?
'overwrite' :
'upload' );
1368 $logEntry->setTimestamp( $this->timestamp );
1369 $logEntry->setPerformer(
$user );
1371 $logEntry->setTarget( $descTitle );
1374 $logEntry->setParameters(
1376 'img_sha1' => $this->sha1,
1386 $logId = $logEntry->insert();
1388 if ( $descTitle->exists() ) {
1390 $formatter = LogFormatter::newFromEntry( $logEntry );
1392 $editSummary = $formatter->getPlainActionText();
1401 if ( $nullRevision ) {
1402 $nullRevision->insertOn( $dbw );
1404 'NewRevisionFromEditComplete',
1405 [ $wikiPage, $nullRevision, $nullRevision->getParentId(),
$user ]
1407 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1409 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1412 $newPageContent = null;
1415 $newPageContent = ContentHandler::makeContent( $pageText, $descTitle );
1418 # Defer purges, page creation, and link updates in case they error out.
1419 # The most important thing is that files and the DB registry stay synced.
1420 $dbw->endAtomic( __METHOD__ );
1422 # Do some cache purges after final commit so that:
1423 # a) Changes are more likely to be seen post-purge
1424 # b) They won't cause rollback of the log publish/update above
1431 $logEntry, $logId, $descId, $tags
1433 # Update memcache after the commit
1436 $updateLogPage =
false;
1437 if ( $newPageContent ) {
1438 # New file page; create the description page.
1439 # There's already a log entry, so don't make a second RC entry
1440 # CDN and file cache for the description page are purged by doEditContent.
1441 $status = $wikiPage->doEditContent(
1449 if ( isset(
$status->value[
'revision'] ) ) {
1451 $logEntry->setAssociatedRevId(
$status->value[
'revision']->getId() );
1455 if ( isset(
$status->value[
'revision'] ) ) {
1458 $updateLogPage =
$rev->getPage();
1461 # Existing file page: invalidate description page cache
1462 $wikiPage->getTitle()->invalidateCache();
1463 $wikiPage->getTitle()->purgeSquid();
1464 # Allow the new file version to be patrolled from the page footer
1468 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1469 # but setAssociatedRevId() wasn't called at that point yet...
1470 $logParams = $logEntry->getParameters();
1471 $logParams[
'associated_rev_id'] = $logEntry->getAssociatedRevId();
1473 if ( $updateLogPage ) {
1474 # Also log page, in case where we just created it above
1475 $update[
'log_page'] = $updateLogPage;
1477 $this->
getRepo()->getMasterDB()->update(
1480 [
'log_id' => $logId ],
1483 $this->
getRepo()->getMasterDB()->insert(
1486 'ls_field' =>
'associated_rev_id',
1487 'ls_value' => $logEntry->getAssociatedRevId(),
1488 'ls_log_id' => $logId,
1493 # Add change tags, if any
1495 $logEntry->setTags( $tags );
1498 # Uploads can be patrolled
1499 $logEntry->setIsPatrollable(
true );
1501 # Now that the log entry is up-to-date, make an RC entry.
1502 $logEntry->publish( $logId );
1504 # Run hook for other updates (typically more cache purging)
1505 Hooks::run(
'FileUpload', [ $this, $reupload, !$newPageContent ] );
1508 # Delete old thumbnails
1510 # Remove the old file from the CDN cache
1516 # Update backlink pages pointing to this title if created
1524 # This is a new file, so update the image count
1528 # Invalidate cache for all pages using this file
1569 $srcPath = ( $src instanceof
FSFile ) ? $src->getPath() : $src;
1579 $archiveRel =
'archive/' . $this->
getHashPath() . $archiveName;
1592 $status->value = $archiveName;
1598 if (
$status->value ==
'new' ) {
1601 $status->value = $archiveName;
1628 if ( $this->
getRepo()->getReadOnlyReason() !==
false ) {
1632 wfDebugLog(
'imagemove',
"Got request to move {$this->name} to " . $target->getText() );
1636 $batch->addCurrent();
1637 $archiveNames = $batch->addOlds();
1641 wfDebugLog(
'imagemove',
"Finished moving {$this->name}" );
1649 $this->
getRepo()->getMasterDB(),
1651 function ()
use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1652 $oldTitleFile->purgeEverything();
1653 foreach ( $archiveNames
as $archiveName ) {
1654 $oldTitleFile->purgeOldThumbnails( $archiveName );
1656 $newTitleFile->purgeEverything();
1664 $this->
title = $target;
1666 unset( $this->
name );
1667 unset( $this->hashPath );
1686 function delete( $reason, $suppress =
false,
$user = null ) {
1687 if ( $this->
getRepo()->getReadOnlyReason() !==
false ) {
1696 $archiveNames =
$batch->addOlds();
1707 $this->
getRepo()->getMasterDB(),
1709 function ()
use ( $archiveNames ) {
1711 foreach ( $archiveNames
as $archiveName ) {
1721 foreach ( $archiveNames
as $archiveName ) {
1745 if ( $this->
getRepo()->getReadOnlyReason() !==
false ) {
1752 $batch->addOld( $archiveName );
1780 function restore( $versions = [], $unsuppress =
false ) {
1781 if ( $this->
getRepo()->getReadOnlyReason() !==
false ) {
1791 $batch->addIds( $versions );
1795 $cleanupStatus =
$batch->cleanup();
1796 $cleanupStatus->successCount = 0;
1797 $cleanupStatus->failCount = 0;
1798 $status->merge( $cleanupStatus );
1815 return $this->
title->getLocalURL();
1831 $content = $revision->getContent();
1837 return $pout->getText();
1847 if ( $audience == self::FOR_PUBLIC && $this->
isDeleted( self::DELETED_COMMENT ) ) {
1849 } elseif ( $audience == self::FOR_THIS_USER
1874 if ( $this->descriptionTouched === null ) {
1876 'page_namespace' => $this->
title->getNamespace(),
1877 'page_title' => $this->
title->getDBkey()
1879 $touched = $this->repo->getSlaveDB()->selectField(
'page',
'page_touched', $cond, __METHOD__ );
1880 $this->descriptionTouched = $touched ?
wfTimestamp(
TS_MW, $touched ) :
false;
1892 if ( $this->sha1 ==
'' && $this->fileExists ) {
1895 $this->sha1 = $this->repo->getFileSha1( $this->
getPath() );
1896 if ( !
wfReadOnly() && strval( $this->sha1 ) !=
'' ) {
1897 $dbw = $this->repo->getMasterDB();
1898 $dbw->update(
'image',
1899 [
'img_sha1' => $this->sha1 ],
1900 [
'img_name' => $this->
getName() ],
1918 return $this->extraDataLoaded
1919 && strlen(
serialize( $this->metadata ) ) <= self::CACHE_FIELD_MAX_LEN;
1927 return $this->
getRepo()->getBackend()->lockFiles(
1937 return $this->
getRepo()->getBackend()->unlockFiles(
1952 if ( !$this->locked ) {
1953 $logger = LoggerFactory::getInstance(
'LocalFile' );
1955 $dbw = $this->repo->getMasterDB();
1956 $makesTransaction = !$dbw->trxLevel();
1957 $dbw->startAtomic( self::ATOMIC_SECTION_LOCK );
1963 $dbw->endAtomic( self::ATOMIC_SECTION_LOCK );
1964 $logger->warning(
"Failed to lock '{file}'", [
'file' => $this->
name ] );
1970 $dbw->onTransactionResolution(
function ()
use ( $logger ) {
1973 $logger->error(
"Failed to unlock '{file}'", [
'file' => $this->
name ] );
1977 $this->lockedOwnTrx = $makesTransaction;
1994 if ( $this->locked ) {
1996 if ( !$this->locked ) {
1997 $dbw = $this->repo->getMasterDB();
1998 $dbw->endAtomic( self::ATOMIC_SECTION_LOCK );
1999 $this->lockedOwnTrx =
false;
2008 return $this->
getRepo()->newFatal(
'filereadonlyerror', $this->
getName(),
2020 # ------------------------------------------------------------------------------
2067 $this->status = $file->repo->newGood();
2071 $this->srcRels[
'.'] = $this->
file->getRel();
2078 $this->srcRels[$oldName] = $this->
file->getArchiveRel( $oldName );
2079 $this->archiveUrls[] = $this->
file->getArchiveUrl( $oldName );
2089 $dbw = $this->
file->repo->getMasterDB();
2090 $result = $dbw->select(
'oldimage',
2091 [
'oi_archive_name' ],
2092 [
'oi_name' => $this->
file->getName() ],
2097 $this->
addOld( $row->oi_archive_name );
2098 $archiveNames[] = $row->oi_archive_name;
2101 return $archiveNames;
2108 if ( !isset( $this->srcRels[
'.'] ) ) {
2110 $deleteCurrent =
false;
2113 unset( $oldRels[
'.'] );
2114 $deleteCurrent =
true;
2117 return [ $oldRels, $deleteCurrent ];
2127 if ( $deleteCurrent ) {
2131 if ( count( $oldRels ) ) {
2132 $dbw = $this->
file->repo->getMasterDB();
2133 $res = $dbw->select(
2135 [
'oi_archive_name',
'oi_sha1' ],
2136 [
'oi_archive_name' => array_keys( $oldRels ),
2137 'oi_name' => $this->
file->getName() ],
2141 foreach (
$res as $row ) {
2142 if ( rtrim( $row->oi_sha1,
"\0" ) ===
'' ) {
2144 $oldUrl = $this->
file->getArchiveVirtualUrl( $row->oi_archive_name );
2145 $props = $this->
file->repo->getFileProps( $oldUrl );
2147 if ( $props[
'fileExists'] ) {
2149 $dbw->update(
'oldimage',
2150 [
'oi_sha1' => $props[
'sha1'] ],
2151 [
'oi_name' => $this->
file->getName(),
'oi_archive_name' => $row->oi_archive_name ],
2153 $hashes[$row->oi_archive_name] = $props[
'sha1'];
2155 $hashes[$row->oi_archive_name] =
false;
2158 $hashes[$row->oi_archive_name] = $row->oi_sha1;
2163 $missing = array_diff_key( $this->srcRels,
$hashes );
2165 foreach ( $missing
as $name => $rel ) {
2166 $this->status->error(
'filedelete-old-unregistered',
$name );
2171 $this->status->error(
'filedelete-missing', $this->srcRels[
$name] );
2180 $dbw = $this->
file->repo->getMasterDB();
2181 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
2182 $encUserId = $dbw->addQuotes( $this->
user->getId() );
2183 $encReason = $dbw->addQuotes( $this->reason );
2184 $encGroup = $dbw->addQuotes(
'deleted' );
2185 $ext = $this->
file->getExtension();
2186 $dotExt =
$ext ===
'' ?
'' :
".$ext";
2187 $encExt = $dbw->addQuotes( $dotExt );
2191 if ( $this->suppress ) {
2199 $bitfield =
'oi_deleted';
2202 if ( $deleteCurrent ) {
2203 $concat = $dbw->buildConcat( [
"img_sha1", $encExt ] );
2204 $where = [
'img_name' => $this->
file->getName() ];
2205 $dbw->insertSelect(
'filearchive',
'image',
2207 'fa_storage_group' => $encGroup,
2208 'fa_storage_key' => $dbw->conditional(
2209 [
'img_sha1' =>
'' ],
2210 $dbw->addQuotes(
'' ),
2213 'fa_deleted_user' => $encUserId,
2214 'fa_deleted_timestamp' => $encTimestamp,
2215 'fa_deleted_reason' => $encReason,
2216 'fa_deleted' => $this->suppress ? $bitfield : 0,
2218 'fa_name' =>
'img_name',
2219 'fa_archive_name' =>
'NULL',
2220 'fa_size' =>
'img_size',
2221 'fa_width' =>
'img_width',
2222 'fa_height' =>
'img_height',
2223 'fa_metadata' =>
'img_metadata',
2224 'fa_bits' =>
'img_bits',
2225 'fa_media_type' =>
'img_media_type',
2226 'fa_major_mime' =>
'img_major_mime',
2227 'fa_minor_mime' =>
'img_minor_mime',
2228 'fa_description' =>
'img_description',
2229 'fa_user' =>
'img_user',
2230 'fa_user_text' =>
'img_user_text',
2231 'fa_timestamp' =>
'img_timestamp',
2232 'fa_sha1' =>
'img_sha1',
2233 ], $where, __METHOD__ );
2236 if ( count( $oldRels ) ) {
2237 $concat = $dbw->buildConcat( [
"oi_sha1", $encExt ] );
2239 'oi_name' => $this->
file->getName(),
2240 'oi_archive_name' => array_keys( $oldRels ) ];
2241 $dbw->insertSelect(
'filearchive',
'oldimage',
2243 'fa_storage_group' => $encGroup,
2244 'fa_storage_key' => $dbw->conditional(
2245 [
'oi_sha1' =>
'' ],
2246 $dbw->addQuotes(
'' ),
2249 'fa_deleted_user' => $encUserId,
2250 'fa_deleted_timestamp' => $encTimestamp,
2251 'fa_deleted_reason' => $encReason,
2252 'fa_deleted' => $this->suppress ? $bitfield :
'oi_deleted',
2254 'fa_name' =>
'oi_name',
2255 'fa_archive_name' =>
'oi_archive_name',
2256 'fa_size' =>
'oi_size',
2257 'fa_width' =>
'oi_width',
2258 'fa_height' =>
'oi_height',
2259 'fa_metadata' =>
'oi_metadata',
2260 'fa_bits' =>
'oi_bits',
2261 'fa_media_type' =>
'oi_media_type',
2262 'fa_major_mime' =>
'oi_major_mime',
2263 'fa_minor_mime' =>
'oi_minor_mime',
2264 'fa_description' =>
'oi_description',
2265 'fa_user' =>
'oi_user',
2266 'fa_user_text' =>
'oi_user_text',
2267 'fa_timestamp' =>
'oi_timestamp',
2268 'fa_sha1' =>
'oi_sha1',
2269 ], $where, __METHOD__ );
2274 $dbw = $this->
file->repo->getMasterDB();
2277 if ( count( $oldRels ) ) {
2278 $dbw->delete(
'oldimage',
2280 'oi_name' => $this->
file->getName(),
2281 'oi_archive_name' => array_keys( $oldRels )
2285 if ( $deleteCurrent ) {
2286 $dbw->delete(
'image', [
'img_name' => $this->
file->getName() ], __METHOD__ );
2295 $repo = $this->
file->getRepo();
2296 $this->
file->lock();
2300 $this->deletionBatch = [];
2301 $ext = $this->
file->getExtension();
2302 $dotExt =
$ext ===
'' ?
'' :
".$ext";
2304 foreach ( $this->srcRels
as $name => $srcRel ) {
2308 $key = $hash . $dotExt;
2309 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2310 $this->deletionBatch[
$name] = [ $srcRel, $dstRel ];
2314 if ( !$repo->hasSha1Storage() ) {
2318 if ( !$checkStatus->isGood() ) {
2319 $this->status->merge( $checkStatus );
2322 $this->deletionBatch = $checkStatus->value;
2325 $status = $this->
file->repo->deleteBatch( $this->deletionBatch );
2327 $this->status->merge(
$status );
2331 if ( !$this->status->isOK() ) {
2333 $this->
file->unlock();
2344 $this->
file->unlock();
2358 list( $src, ) = $batchItem;
2359 $files[$src] = $this->
file->repo->getVirtualUrl(
'public' ) .
'/' . rawurlencode( $src );
2363 if ( in_array( null,
$result,
true ) ) {
2365 $this->
file->repo->getBackend()->getName() );
2369 if (
$result[$batchItem[0]] ) {
2370 $newBatch[] = $batchItem;
2378 # ------------------------------------------------------------------------------
2406 $this->cleanupBatch = $this->ids = [];
2416 $this->ids[] = $fa_id;
2424 $this->ids = array_merge( $this->ids,
$ids );
2445 $repo = $this->
file->getRepo();
2446 if ( !$this->all && !$this->ids ) {
2448 return $repo->newGood();
2451 $lockOwnsTrx = $this->
file->lock();
2453 $dbw = $this->
file->repo->getMasterDB();
2456 $exists = (bool)$dbw->selectField(
'image',
'1',
2457 [
'img_name' => $this->file->getName() ],
2462 $lockOwnsTrx ? [] : [
'LOCK IN SHARE MODE' ]
2467 $conditions = [
'fa_name' => $this->
file->getName() ];
2469 if ( !$this->all ) {
2478 [
'ORDER BY' =>
'fa_timestamp DESC' ]
2484 $insertCurrent =
false;
2490 $idsPresent[] = $row->fa_id;
2492 if ( $row->fa_name != $this->file->getName() ) {
2493 $status->error(
'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
2498 if ( $row->fa_storage_key ==
'' ) {
2500 $status->error(
'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
2505 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key ) .
2506 $row->fa_storage_key;
2507 $deletedUrl = $repo->getVirtualUrl() .
'/deleted/' . $deletedRel;
2509 if ( isset( $row->fa_sha1 ) ) {
2510 $sha1 = $row->fa_sha1;
2517 if ( strlen( $sha1 ) == 32 && $sha1[0] ==
'0' ) {
2518 $sha1 = substr( $sha1, 1 );
2521 if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime ==
'unknown'
2522 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime ==
'unknown'
2523 || is_null( $row->fa_media_type ) || $row->fa_media_type ==
'UNKNOWN'
2524 || is_null( $row->fa_metadata )
2531 'minor_mime' => $row->fa_minor_mime,
2532 'major_mime' => $row->fa_major_mime,
2533 'media_type' => $row->fa_media_type,
2534 'metadata' => $row->fa_metadata
2538 if ( $first && !$exists ) {
2540 $destRel = $this->
file->getRel();
2542 'img_name' => $row->fa_name,
2543 'img_size' => $row->fa_size,
2544 'img_width' => $row->fa_width,
2545 'img_height' => $row->fa_height,
2546 'img_metadata' => $props[
'metadata'],
2547 'img_bits' => $row->fa_bits,
2548 'img_media_type' => $props[
'media_type'],
2549 'img_major_mime' => $props[
'major_mime'],
2550 'img_minor_mime' => $props[
'minor_mime'],
2551 'img_description' => $row->fa_description,
2552 'img_user' => $row->fa_user,
2553 'img_user_text' => $row->fa_user_text,
2554 'img_timestamp' => $row->fa_timestamp,
2559 if ( !$this->unsuppress && $row->fa_deleted ) {
2560 $storeBatch[] = [ $deletedUrl,
'public', $destRel ];
2561 $this->cleanupBatch[] = $row->fa_storage_key;
2564 $archiveName = $row->fa_archive_name;
2566 if ( $archiveName ==
'' ) {
2575 }
while ( isset( $archiveNames[$archiveName] ) );
2578 $archiveNames[$archiveName] =
true;
2579 $destRel = $this->
file->getArchiveRel( $archiveName );
2581 'oi_name' => $row->fa_name,
2582 'oi_archive_name' => $archiveName,
2583 'oi_size' => $row->fa_size,
2584 'oi_width' => $row->fa_width,
2585 'oi_height' => $row->fa_height,
2586 'oi_bits' => $row->fa_bits,
2587 'oi_description' => $row->fa_description,
2588 'oi_user' => $row->fa_user,
2589 'oi_user_text' => $row->fa_user_text,
2590 'oi_timestamp' => $row->fa_timestamp,
2591 'oi_metadata' => $props[
'metadata'],
2592 'oi_media_type' => $props[
'media_type'],
2593 'oi_major_mime' => $props[
'major_mime'],
2594 'oi_minor_mime' => $props[
'minor_mime'],
2595 'oi_deleted' => $this->unsuppress ? 0 : $row->fa_deleted,
2596 'oi_sha1' => $sha1 ];
2599 $deleteIds[] = $row->fa_id;
2605 $storeBatch[] = [ $deletedUrl,
'public', $destRel ];
2606 $this->cleanupBatch[] = $row->fa_storage_key;
2615 $missingIds = array_diff( $this->ids, $idsPresent );
2617 foreach ( $missingIds
as $id ) {
2618 $status->error(
'undelete-missing-filearchive', $id );
2621 if ( !$repo->hasSha1Storage() ) {
2624 if ( !$checkStatus->isGood() ) {
2625 $status->merge( $checkStatus );
2628 $storeBatch = $checkStatus->value;
2633 $status->merge( $storeStatus );
2640 $this->
file->unlock();
2652 if ( $insertCurrent ) {
2653 $dbw->insert(
'image', $insertCurrent, __METHOD__ );
2656 if ( $insertBatch ) {
2657 $dbw->insert(
'oldimage', $insertBatch, __METHOD__ );
2661 $dbw->delete(
'filearchive',
2662 [
'fa_id' => $deleteIds ],
2667 if (
$status->successCount > 0 || !$storeBatch || $repo->hasSha1Storage() ) {
2669 wfDebug( __METHOD__ .
" restored {$status->successCount} items, creating a new current\n" );
2673 $this->
file->purgeEverything();
2675 wfDebug( __METHOD__ .
" restored {$status->successCount} as archived versions\n" );
2676 $this->
file->purgeDescription();
2680 $this->
file->unlock();
2691 $files = $filteredTriplets = [];
2692 foreach ( $triplets
as $file ) {
2693 $files[$file[0]] = $file[0];
2697 if ( in_array( null,
$result,
true ) ) {
2699 $this->
file->repo->getBackend()->getName() );
2702 foreach ( $triplets
as $file ) {
2704 $filteredTriplets[] =
$file;
2718 $repo = $this->
file->repo;
2721 $files[
$file] = $repo->getVirtualUrl(
'deleted' ) .
'/' .
2722 rawurlencode( $repo->getDeletedHashPath( $file ) .
$file );
2729 $newBatch[] =
$file;
2742 if ( !$this->cleanupBatch ) {
2743 return $this->
file->repo->newGood();
2748 $status = $this->
file->repo->cleanupDeletedBatch( $this->cleanupBatch );
2763 foreach ( $storeStatus->success
as $i =>
$success ) {
2768 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
2775 # ------------------------------------------------------------------------------
2806 $this->oldHash = $this->
file->repo->getHashPath( $this->
file->getName() );
2807 $this->newHash = $this->
file->repo->getHashPath( $this->target->getDBkey() );
2808 $this->oldName = $this->
file->getName();
2809 $this->newName = $this->
file->repo->getNameFromTitle( $this->target );
2810 $this->oldRel = $this->oldHash . $this->oldName;
2811 $this->newRel = $this->newHash . $this->newName;
2812 $this->db = $file->
getRepo()->getMasterDB();
2819 $this->cur = [ $this->oldRel, $this->newRel ];
2827 $archiveBase =
'archive';
2829 $this->oldCount = 0;
2832 $result = $this->db->select(
'oldimage',
2833 [
'oi_archive_name',
'oi_deleted' ],
2834 [
'oi_name' => $this->oldName ],
2836 [
'LOCK IN SHARE MODE' ]
2840 $archiveNames[] = $row->oi_archive_name;
2841 $oldName = $row->oi_archive_name;
2842 $bits = explode(
'!', $oldName, 2 );
2844 if ( count( $bits ) != 2 ) {
2845 wfDebug(
"Old file name missing !: '$oldName' \n" );
2851 if ( $this->oldName != $filename ) {
2852 wfDebug(
"Old file name doesn't match: '$oldName' \n" );
2864 "{$archiveBase}/{$this->oldHash}{$oldName}",
2865 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2869 return $archiveNames;
2877 $repo = $this->
file->repo;
2881 $this->
file->lock();
2886 if ( !$checkStatus->isGood() ) {
2887 $destFile->unlock();
2888 $this->
file->unlock();
2889 $status->merge( $checkStatus );
2892 $triplets = $checkStatus->value;
2896 if ( !$statusDb->isGood() ) {
2897 $destFile->unlock();
2898 $this->
file->unlock();
2899 $statusDb->ok =
false;
2904 if ( !$repo->hasSha1Storage() ) {
2909 wfDebugLog(
'imagemove',
"Moved files for {$this->file->getName()}: " .
2910 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2911 if ( !$statusMove->isGood() ) {
2914 $destFile->unlock();
2915 $this->
file->unlock();
2916 wfDebugLog(
'imagemove',
"Error in moving files: "
2917 . $statusMove->getWikiText(
false,
false,
'en' ) );
2918 $statusMove->ok =
false;
2922 $status->merge( $statusMove );
2928 wfDebugLog(
'imagemove',
"Renamed {$this->file->getName()} in database: " .
2929 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2931 $destFile->unlock();
2932 $this->
file->unlock();
2949 $repo = $this->
file->repo;
2956 [
'img_name' => $this->oldName ],
2960 $oldRowCount = $dbw->selectField(
2963 [
'oi_name' => $this->oldName ],
2968 if ( $hasCurrent ) {
2973 $status->successCount += $oldRowCount;
2977 $status->failCount += max( 0, $this->oldCount - $oldRowCount );
2979 $status->error(
'imageinvalidfilename' );
2995 [
'img_name' => $this->newName ],
2996 [
'img_name' => $this->oldName ],
3003 'oi_name' => $this->newName,
3004 'oi_archive_name = ' . $dbw->strreplace(
'oi_archive_name',
3005 $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
3007 [
'oi_name' => $this->oldName ],
3017 $moves = array_merge( [ $this->cur ], $this->olds );
3020 foreach ( $moves
as $move ) {
3022 $srcUrl = $this->
file->repo->getVirtualUrl() .
'/public/' . rawurlencode( $move[0] );
3023 $triplets[] = [ $srcUrl,
'public', $move[1] ];
3026 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3041 foreach ( $triplets
as $file ) {
3042 $files[$file[0]] = $file[0];
3046 if ( in_array( null,
$result,
true ) ) {
3048 $this->
file->repo->getBackend()->getName() );
3051 $filteredTriplets = [];
3052 foreach ( $triplets
as $file ) {
3054 $filteredTriplets[] =
$file;
3056 wfDebugLog(
'imagemove',
"File {$file[0]} does not exist" );
3071 foreach ( $triplets
as $triplet ) {
3073 $pairs[] = [ $triplet[1], $triplet[2] ];
3076 $this->
file->repo->cleanupBatch( $pairs );
3087 foreach ( $triplets
as $triplet ) {
3097 parent::__construct(
3105 $wgOut->setStatusCode( 429 );
static purgePatrolFooterCache($articleID)
Purge the cache used to check if it is worth showing the patrol footer For example, it is done during re-uploads when file patrol is used.
removeNonexistentFiles($batch)
Removes non-existent files from a deletion batch.
getArchiveThumbPath($archiveName, $suffix=false)
Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified.
static getMainWANInstance()
Get the main WAN cache object.
exists()
canRender inherited
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
invalidateCache()
Purge the file object/metadata cache.
the array() calling protocol came about after MediaWiki 1.4rc1.
string $media_type
MEDIATYPE_xxx (bitmap, drawing, audio...)
recordUpload($oldver, $desc, $license= '', $copyStatus= '', $source= '', $watch=false, $timestamp=false, User $user=null)
Record a file upload in the upload log and the image table.
bool $extraDataLoaded
Whether or not lazy-loaded data has been loaded from the database.
assertTitleDefined()
Assert that $this->title is set to a Title.
userCan($field, User $user=null)
Determine if the current user is allowed to view a particular field of this file, if it's marked as d...
addAll()
Add all revisions of the file.
cleanupTarget($triplets)
Cleanup a partially moved array of triplets by deleting the target files.
processing should stop and the error should be shown to the user * false
cleanupSource($triplets)
Cleanup a fully moved array of triplets by deleting the source files.
loadFromRow($row, $prefix= 'img_')
Load file metadata from a DB result row.
string $minor_mime
Minor MIME type.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getHistory($limit=null, $start=null, $end=null, $inc=true)
purgeDescription inherited
restore($versions=[], $unsuppress=false)
Restore all or specified deleted revisions to the given file.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Set options of the Parser.
purgeMetadataCache()
Refresh metadata in memcached, but don't touch thumbnails or CDN.
if(!isset($args[0])) $lang
__construct(File $file, $reason= '', $suppress=false, $user=null)
cleanup()
Delete unused files in the deleted zone.
getUser($type= 'text')
Returns ID or name of user who uploaded the file.
getThumbPath($suffix=false)
Get the path of the thumbnail directory, or a particular file if $suffix is specified.
recordUpload2($oldver, $comment, $pageText, $props=false, $timestamp=false, $user=null, $tags=[])
Record a file upload in the upload log and the image table.
addCurrent()
Add the current image to the batch.
getSize()
Returns the size of the image file, in bytes.
Handles purging appropriate CDN URLs given a title (or titles)
Generic operation result class Has warning/error list, boolean status and arbitrary value...
verifyDBUpdates()
Verify the database updates and return a new FileRepoStatus indicating how many rows would be updated...
Helper class for file undeletion.
unlock()
Decrement the lock reference count and end the atomic section if it reaches zero. ...
string $major_mime
Major MIME type.
string $sha1
SHA-1 base 36 content hash.
isMissing()
splitMime inherited
getArchiveThumbUrl($archiveName, $suffix=false)
Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified.
static isVirtualUrl($url)
Determine if a string is an mwrepo:// URL.
assertRepoDefined()
Assert that $this->repo is set to a valid FileRepo instance.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
getName()
Return the name of this file.
string $name
The name of a file from its title object.
static newFromKey($sha1, $repo, $timestamp=false)
Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class.
getRepo()
Returns the repository.
unprefixRow($row, $prefix= 'img_')
const MW_FILE_VERSION
Bump this number when serialized cache records may be incompatible.
array $cleanupBatch
List of file IDs to restore.
int $user
User ID of uploader.
Represents a title within MediaWiki.
setProps($info)
Set properties in this object to be equal to those given in the associative array $info...
when a variable name is used in a it is silently declared as a new local masking the global
static makeParamBlob($params)
Create a blob from a parameter array.
static newFatal($message)
Factory function for fatal errors.
int $bits
Returned by getimagesize (loadFromXxx)
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target...
publish($src, $flags=0, array $options=[])
Move or copy a file to its public location.
const ATOMIC_SECTION_LOCK
bool $fileExists
Does the file exist on disk? (loadFromXxx)
wfLocalFile($title)
Get an object referring to a locally registered file.
doDBUpdates()
Do the database updates and return a new FileRepoStatus indicating how many rows where updated...
getHeight($page=1)
Return the height of the image.
getTitle()
Return the associated title object.
getHashPath()
Get the filename hash component of the directory including trailing slash, e.g.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist & $tables
purgeEverything()
Purge metadata and all affected pages when the file is created, deleted, or majorly updated...
__destruct()
Clean up any dangling locks.
static queueRecursiveJobsForTable(Title $title, $table)
Queue a RefreshLinks job for any table.
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
getBackend()
Get the file backend instance.
update($table, $values, $conds, $fname=__METHOD__, $options=[])
UPDATE wrapper.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
getThumbnails()
Get all thumbnail names previously generated for this file STUB Overridden by LocalFile.
Deferrable Update for closure/callback updates that should use auto-commit mode.
getDescriptionShortUrl()
Get short description URL for a file based on the page ID.
nextHistoryLine()
Returns the history of this file, line by line.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
__construct(File $file, Title $target)
getPath()
Return the storage path to the file.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
removeNonexistentFiles($triplets)
Removes non-existent files from move batch.
int $historyRes
Result of the query for the file's history (nextHistoryLine)
bool $locked
True if the image row is locked.
getFileSha1($virtualUrl)
Get the sha1 (base 36) of a file with a given virtual URL/storage path.
deleteOld($archiveName, $reason, $suppress=false, $user=null)
Delete an old version of the file.
getReadOnlyReason()
Get an explanatory message if this repo is read-only.
__construct(File $file, $unsuppress=false)
wfReadOnly()
Check whether the wiki is in read-only mode.
string $metadata
Handler-specific metadata.
string $descriptionTouched
TS_MW timestamp of the last change of the file description.
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
publishTo($src, $dstRel, $flags=0, array $options=[])
Move or copy a file to a specified location.
File backend exception for checked exceptions (e.g.
An error page which can definitely be safely rendered using the OutputPage.
isDeleted($field)
Is this file a "deleted" file in a private archive? STUB.
Class to invalidate the HTML cache of all the pages linking to a given title.
isMultipage()
Returns 'true' if this file is a type which supports multiple pages, e.g.
getHandler()
Get a MediaHandler instance for this file.
getCacheKey()
Get the memcached key for the main data for this file, or false if there is no access to the shared c...
static factory(array $deltas)
static selectFields()
Fields in the filearchive table.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
getRel()
Get the path of the file relative to the public zone root.
static singleton()
Get a RepoGroup instance.
static isStoragePath($path)
Check if a given path is a "mwstore://" path.
bool $unsuppress
Whether to remove all settings for suppressed fields.
static newNullRevision($dbw, $pageId, $summary, $minor, $user=null)
Create a new null-revision for insertion into a page's history.
static selectFields()
Fields in the image table.
string $user_text
User name of uploader.
__construct($title, $repo)
Constructor.
const CACHE_FIELD_MAX_LEN
__construct(Status $status)
purgeThumbList($dir, $files)
Delete a list of thumbnails visible at urls.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
upload($src, $comment, $pageText, $flags=0, $props=false, $timestamp=false, $user=null, $tags=[])
getHashPath inherited
loadExtraFromDB()
Load lazy file metadata from the DB.
static newFromRow($row, $repo)
Create a LocalFile from a title Do not call this except from inside a repo class. ...
maybeUpgradeRow()
Upgrade a row if it needs it.
static getInitialPageText($comment= '', $license= '', $copyStatus= '', $source= '', Config $config=null)
Get the initial image page text based on a comment and optional file status information.
quickImport($src, $dst, $options=null)
Import a file from the local file system into the repo.
Helper class for file movement.
bool $upgraded
Whether the row was upgraded on load.
static newExtraneousContext(Title $title, $request=[])
Create a new extraneous context.
static selectFields()
Fields in the oldimage table.
static newFromTitle($title, $repo, $unused=null)
Create a LocalFile from a title Do not call this except from inside a repo class. ...
loadFieldsWithTimestamp($dbr, $fname)
execute()
Run the transaction.
getVirtualUrl($suffix=false)
Get the public zone virtual URL for a current version source file.
bool $all
Add all revisions of the file.
decodeRow($row, $prefix= 'img_')
Decode a row from the database (either object or array) to an array with timestamps and MIME types de...
bool $lockedOwnTrx
True if the image row is locked with a lock initiated transaction.
static addUpdate(DeferrableUpdate $update, $type=self::POSTSEND)
Add an update to the deferred list.
getThumbnails($archiveName=false)
getTransformScript inherited
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
array $ids
List of file IDs to restore.
bool $dataLoaded
Whether or not core data has been loaded from the database (loadFromXxx)
FileRepo LocalRepo ForeignAPIRepo bool $repo
Some member variables can be lazy-initialised using __get().
getMetadata()
Get handler-specific metadata.
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
static getSha1Base36FromPath($path)
Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits.
static getCacheSetOptions(IDatabase $db1)
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estima...
string $mime
MIME type, determined by MimeMagic::guessMimeType.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Special handling for file pages.
execute()
Perform the move.
Helper class for file deletion.
array $deletionBatch
Items to be processed in the deletion batch.
purgeOldThumbnails($archiveName)
Delete cached transformed files for an archived version only.
getWidth($page=1)
Return the width of the image.
removeNonexistentFiles($triplets)
Removes non-existent files from a store batch.
getMessage($shortContext=false, $longContext=false, $lang=null)
Get a bullet list of the errors as a Message object.
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
removeNonexistentFromCleanup($batch)
Removes non-existent files from a cleanup batch.
selectField($table, $var, $cond= '', $fname=__METHOD__, $options=[])
A SELECT wrapper which returns a single field from a single result row.
Class for creating log entries manually, to inject them into the database.
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
upgradeRow()
Fix assorted version-related problems with the image row by reloading it from the file...
Class representing a non-directory file on the file system.
static getHashFromKey($key)
Gets the SHA1 hash from a storage key.
getCacheFields($prefix= 'img_')
cleanupFailedBatch($storeStatus, $storeBatch)
Cleanup a failed batch.
lock()
Start an atomic DB section and lock the image for update or increments a reference counter if the loc...
getDescriptionText($lang=null)
Get the HTML text of the description page This is not used by ImagePage for local files...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
string $url
The URL corresponding to one of the four basic zones.
int $deleted
Bitfield akin to rev_deleted.
move($target)
getLinksTo inherited
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
getUrl()
Return the URL of the file.
bool $missing
True if file is not present in file system.
to move a page</td >< td > &*You are moving the page across *A non empty talk page already exists under the new or *You uncheck the box below In those you will have to move or merge the page manually if desired</td >< td > be sure to &You are responsible for making sure that links continue to point where they are supposed to go Note that the page will &a page at the new title
getDescriptionUrl()
isMultipage inherited
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
getDescription($audience=self::FOR_PUBLIC, User $user=null)
Class to represent a local file in the wiki's own database.
addOlds()
Add the old versions of the image to the batch.
getThumbUrl($suffix=false)
Get the URL of the thumbnail directory, or a particular file if $suffix is specified.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method.MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances.The"Spi"in MediaWiki\Logger\Spi stands for"service provider interface".An SPI is an API intended to be implemented or extended by a third party.This software design pattern is intended to enable framework extension and replaceable components.It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki.The service provider interface allows the backend logging library to be implemented in multiple ways.The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime.This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance.Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
getMoveTriplets()
Generate triplets for FileRepo::storeBatch().
string $timestamp
Upload timestamp.
loadFromDB($flags=0)
Load file metadata from the DB.
getLazyCacheFields($prefix= 'img_')
publish($src, $dstRel, $archiveRel, $flags=0, array $options=[])
Copy or move a file either from a storage path, virtual URL, or file system path, into this repositor...
loadFromFile()
Load metadata from the file itself.
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
string $description
Description of current revision of the file.
load($flags=0)
Load file metadata from cache or DB, unless already loaded.
purgeCache($options=[])
Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN...
Implements some public methods and some protected utility functions which are required by multiple ch...
isGood()
Returns whether the operation completed and didn't have any error or warnings.
bool $suppress
Whether to suppress all suppressable fields when deleting.
getArchiveUrl($suffix=false)
Get the URL of the archive directory, or a particular file if $suffix is specified.
getMediaType()
Returns the type of the media in the file.
loadFromCache()
Try to load file metadata from memcached.
purgeThumbnails($options=[])
Delete cached transformed files for the current version only.
getMimeType()
Returns the MIME type of the file.
resetHistory()
Reset the history pointer to the first element of the history.
static getPropsFromPath($path, $ext=true)
Get an associative array containing information about a file in the local filesystem.
int $size
Size in bytes (loadFromXxx)
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
addOlds()
Add the old versions of the image to the batch.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
purgeDescription()
Purge the file description page, but don't go after pages using the file.
$wgUpdateCompatibleMetadata
If to automatically update the img_metadata field if the metadata field is outdated but compatible wi...
addIds($ids)
Add a whole lot of files by ID.
static newGood($value=null)
Factory function for good results.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
saveToCache()
Save the file metadata to memcached.
int $historyLine
Number of line to return by nextHistoryLine() (constructor)
execute()
Run the transaction, except the cleanup batch.
Allows to change the fields on the form that will be generated $name
addId($fa_id)
Add a file by ID.