MediaWiki master
|
A foreign repository for a remote MediaWiki accessible through api.php requests. More...
Inherits FileRepo, and IForeignRepoWithMWApi.
Public Member Functions | |
__construct ( $info) | |
canCacheThumbs () | |
Are we locally caching the thumbnails? | |
enumFiles ( $callback) | |
fetchImageQuery ( $query) | |
Make an API query in the foreign repo, caching results. | |
fileExistsBatch (array $files) | |
findBySha1 ( $hash) | |
getFileProps ( $virtualUrl) | |
getImageInfo ( $data) | |
getInfo () | |
Get information about the repo - overrides/extends the parent class's information. | |
getThumbError ( $name, $width=-1, $height=-1, $otherParams='', $lang=null) | |
getThumbUrlFromCache ( $name, $width, $height, $params="") | |
Return the imageurl from cache if possible. | |
getZonePath ( $zone) | |
Get the local directory corresponding to one of the basic zones. | |
getZoneUrl ( $zone, $ext=null) | |
httpGetCached ( $attribute, $query, $cacheTTL=3600) | |
HTTP GET request to a mediawiki API (with caching) | |
newFile ( $title, $time=false) | |
Per docs in FileRepo, this needs to return false if we don't support versioned files. | |
Public Member Functions inherited from FileRepo | |
__construct (?array $info=null) | |
addShellboxInputFile (BoxedCommand $command, string $boxedName, string $virtualUrl) | |
Add a file to a Shellbox command as an input file. | |
backendSupportsUnicodePaths () | |
canTransformLocally () | |
Returns true if the repository can transform files locally. | |
canTransformVia404 () | |
Returns true if the repository can transform files via a 404 handler. | |
checkRedirect ( $title) | |
Checks if there is a redirect named as $title. | |
cleanDir ( $dir) | |
Deletes a directory if empty. | |
cleanupBatch (array $files, $flags=0) | |
Deletes a batch of files. | |
cleanupDeletedBatch (array $storageKeys) | |
Delete files in the deleted directory if they are not referenced in the filearchive table. | |
concatenate (array $srcPaths, $dstPath, $flags=0) | |
Concatenate a list of temporary files into a target file location. | |
delete ( $srcRel, $archiveRel) | |
Move a file to the deletion archive. | |
deleteBatch (array $sourceDestPairs) | |
Move a group of files to the deletion archive. | |
fileExists ( $file) | |
Checks existence of a file. | |
findBySha1s (array $hashes) | |
Get an array of arrays or iterators of file objects for files that have the given SHA-1 content hashes. | |
findFile ( $title, $options=[]) | |
Find an instance of the named file created at the specified time Returns false if the file does not exist. | |
findFileFromKey ( $sha1, $options=[]) | |
Find an instance of the file with this key, created at the specified time Returns false if the file does not exist. | |
findFiles (array $items, $flags=0) | |
Find many files at once. | |
findFilesByPrefix ( $prefix, $limit) | |
Return an array of files where the name starts with $prefix. | |
freeTemp ( $virtualUrl) | |
Remove a temporary file or mark it for garbage collection. | |
getBackend () | |
Get the file backend instance. | |
getDeletedHashPath ( $key) | |
Get a relative path for a deletion archive key, e.g. | |
getDescriptionRenderUrl ( $name, $lang=null) | |
Get the URL of the content-only fragment of the description page. | |
getDescriptionStylesheetUrl () | |
Get the URL of the stylesheet to apply to description pages. | |
getDescriptionUrl ( $name) | |
Get the URL of an image description page. | |
getDisplayName () | |
Get the human-readable name of the repo. | |
getFileSha1 ( $virtualUrl) | |
Get the sha1 (base 36) of a file with a given virtual URL/storage path. | |
getFileSize ( $virtualUrl) | |
Get the size of a file with a given virtual URL/storage path. | |
getFileTimestamp ( $virtualUrl) | |
Get the timestamp of a file with a given virtual URL/storage path. | |
getHashLevels () | |
Get the number of hash directory levels. | |
getHashPath ( $name) | |
Get a relative path including trailing slash, e.g. | |
getLocalCacheKey ( $kClassSuffix,... $components) | |
Get a site-local, repository-qualified, WAN cache key. | |
getLocalCopy ( $virtualUrl) | |
Get a local FS copy of a file with a given virtual URL/storage path. | |
getLocalReference ( $virtualUrl) | |
Get a local FS file with a given virtual URL/storage path. | |
getName () | |
Get the name of this repository, as specified by $info['name]' to the constructor. | |
getNameFromTitle ( $title) | |
Get the name of a file from its title. | |
getReadOnlyReason () | |
Get an explanatory message if this repo is read-only. | |
getRootDirectory () | |
Get the public zone root storage directory of the repository. | |
getSharedCacheKey ( $kClassSuffix,... $components) | |
Get a global, repository-qualified, WAN cache key. | |
getTempHashPath ( $suffix) | |
Get a relative path including trailing slash, e.g. | |
getTempRepo () | |
Get a temporary private FileRepo associated with this repo. | |
getThumbProxySecret () | |
Get the secret key for the proxied thumb service. | |
getThumbProxyUrl () | |
Get the URL thumb.php requests are being proxied to. | |
getThumbScriptUrl () | |
Get the URL of thumb.php. | |
getUploadStash (?UserIdentity $user=null) | |
Get an UploadStash associated with this repo. | |
getVirtualUrl ( $suffix=false) | |
Get a URL referring to this repository, with the private mwrepo protocol. | |
hasSha1Storage () | |
Returns whether or not storage is SHA-1 based. | |
invalidateImageRedirect ( $title) | |
Invalidates image redirect cache related to that image Doesn't do anything for repositories that don't support image redirects. | |
isLocal () | |
Returns true if this the local file repository. | |
makeUrl ( $query='', $entry='index') | |
Make an url to this repo. | |
nameForThumb ( $name) | |
Get the portion of the file that contains the origin file name. | |
newFatal ( $message,... $parameters) | |
Create a new fatal error. | |
newGood ( $value=null) | |
Create a new good result. | |
paranoidClean ( $param) | |
Path disclosure protection function. | |
passThrough ( $param) | |
Path disclosure protection function. | |
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 repository at the specified destination location. | |
publishBatch (array $ntuples, $flags=0) | |
Publish a batch of files. | |
quickCleanDir ( $dir) | |
Deletes a directory if empty. | |
quickImport ( $src, $dst, $options=null) | |
Import a file from the local file system into the repo. | |
quickImportBatch (array $triples) | |
Import a batch of files from the local file system into the repo. | |
quickPurge ( $path) | |
Purge a file from the repo. | |
quickPurgeBatch (array $paths) | |
Purge a batch of files from the repo. | |
resolveVirtualUrl ( $url) | |
Get the backend storage path corresponding to a virtual URL. | |
store ( $srcPath, $dstZone, $dstRel, $flags=0) | |
Store a file to a given destination. | |
storeBatch (array $triplets, $flags=0) | |
Store a batch of files. | |
storeTemp ( $originalName, $srcPath) | |
Pick a random name in the temp zone and store a file to it. | |
streamFileWithStatus ( $virtualUrl, $headers=[], $optHeaders=[]) | |
Attempt to stream a file with the given virtual URL/storage path. | |
supportsSha1URLs () | |
Returns whether or not repo supports having originals SHA-1s in the thumb URLs. | |
validateFilename ( $filename) | |
Determine if a relative path is valid, i.e. | |
Static Public Member Functions | |
static | getUserAgent () |
The user agent the ForeignAPIRepo will use. | |
static | httpGet ( $url, $timeout='default', $options=[], &$mtime=false) |
Static Public Member Functions inherited from FileRepo | |
static | isVirtualUrl ( $url) |
Determine if a string is an mwrepo:// URL. | |
Protected Member Functions | |
assertWritableRepo () | |
Protected Member Functions inherited from FileRepo | |
enumFilesInStorage ( $callback) | |
Call a callback function for every public file in the repository. | |
getZoneLocation ( $zone) | |
The storage container and base path of a zone. | |
initDirectory ( $dir) | |
Creates a directory with the appropriate zone permissions. | |
initZones ( $doZones=[]) | |
Ensure that a single zone or list of zones is defined for usage. | |
resolveToStoragePathIfVirtual ( $path) | |
If a path is a virtual URL, resolve it to a storage path. | |
Static Protected Member Functions | |
static | getIIProps () |
Static Protected Member Functions inherited from FileRepo | |
static | getHashPathForLevel ( $name, $levels) |
Protected Attributes | |
int | $apiMetadataExpiry = 4 * 3600 |
API metadata cache time. | |
int | $apiThumbCacheExpiry = 24 * 3600 |
Check back with Commons after this expiry. | |
int | $fileCacheExpiry = 30 * 24 * 3600 |
Redownload thumbnail files after this expiry. | |
callable | $fileFactory = [ ForeignAPIFile::class, 'newFromTitle' ] |
array | $mFileExists = [] |
Protected Attributes inherited from FileRepo | |
int | $abbrvThreshold |
File names over this size will use the short form of thumbnail names. | |
string | $articleUrl |
Equivalent to $wgArticlePath, e.g. | |
FileBackend | $backend |
int | $deletedHashLevels |
The number of directory levels for hash-based division of deleted files. | |
string | $descBaseUrl |
URL of image description pages, e.g. | |
bool | $disableLocalTransform = false |
Disable local image scaling. | |
null string | $favicon = null |
The URL to a favicon (optional, may be a server-local path URL). | |
callable | $fileFactory = [ UnregisteredLocalFile::class, 'newFromTitle' ] |
Override these in the base class. | |
callable false | $fileFactoryKey = false |
Override these in the base class. | |
int | $hashLevels |
The number of directory levels for hash-based division of files. | |
bool | $hasSha1Storage = false |
bool | $initialCapital |
Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames implicitly start with a capital letter. | |
bool | $isPrivate |
Whether all zones should be private (e.g. | |
callable false | $oldFileFactory = false |
Override these in the base class. | |
callable false | $oldFileFactoryKey = false |
Override these in the base class. | |
string | $pathDisclosureProtection = 'simple' |
May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders. | |
string | $scriptDirUrl |
URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g. | |
bool | $supportsSha1URLs = false |
string | $thumbProxySecret |
Secret key to pass as an X-Swift-Secret header to the proxied thumb service. | |
string | $thumbProxyUrl |
URL of where to proxy thumb.php requests to. | |
string | $thumbScriptUrl |
URL of thumb.php. | |
string false | $thumbUrl |
The base thumbnail URL. | |
bool | $transformVia404 |
Whether to skip media file transformation on parse and rely on a 404 handler instead. | |
string false | $url |
Public zone URL. | |
WANObjectCache | $wanCache |
array | $zones = [] |
Map of zones to config. | |
Additional Inherited Members | |
Public Attributes inherited from FileRepo | |
int | $descriptionCacheExpiry |
bool | $fetchDescription |
Whether to fetch commons image description pages and display them on the local wiki. | |
string | $name |
const | DELETE_SOURCE = 1 |
const | NAME_AND_TIME_ONLY = 1 |
const | OVERWRITE = 2 |
const | OVERWRITE_SAME = 4 |
const | SKIP_LOCKING = 8 |
A foreign repository for a remote MediaWiki accessible through api.php requests.
Definition at line 47 of file ForeignAPIRepo.php.
ForeignAPIRepo::__construct | ( | $info | ) |
array | null | $info |
Definition at line 91 of file ForeignAPIRepo.php.
References canCacheThumbs().
|
protected |
ForeignAPIRepo::canCacheThumbs | ( | ) |
Are we locally caching the thumbnails?
Definition at line 482 of file ForeignAPIRepo.php.
Referenced by __construct(), and getThumbUrlFromCache().
ForeignAPIRepo::enumFiles | ( | $callback | ) |
callable | $callback |
Reimplemented from FileRepo.
Definition at line 622 of file ForeignAPIRepo.php.
ForeignAPIRepo::fetchImageQuery | ( | $query | ) |
Make an API query in the foreign repo, caching results.
array | $query |
Implements IForeignRepoWithMWApi.
Definition at line 206 of file ForeignAPIRepo.php.
References httpGetCached().
Referenced by fileExistsBatch(), findBySha1(), and getThumbError().
ForeignAPIRepo::fileExistsBatch | ( | array | $files | ) |
string[] | $files |
Reimplemented from FileRepo.
Definition at line 141 of file ForeignAPIRepo.php.
References fetchImageQuery(), and wfWarn().
ForeignAPIRepo::findBySha1 | ( | $hash | ) |
string | $hash |
Reimplemented from FileRepo.
Definition at line 254 of file ForeignAPIRepo.php.
References fetchImageQuery(), ForeignAPIFile\getProps(), and NS_FILE.
ForeignAPIRepo::getFileProps | ( | $virtualUrl | ) |
string | $virtualUrl |
Reimplemented from FileRepo.
Definition at line 196 of file ForeignAPIRepo.php.
|
staticprotected |
ForeignAPIRepo::getImageInfo | ( | $data | ) |
array | $data |
Definition at line 234 of file ForeignAPIRepo.php.
Referenced by getThumbError().
ForeignAPIRepo::getInfo | ( | ) |
Get information about the repo - overrides/extends the parent class's information.
Reimplemented from FileRepo.
Definition at line 501 of file ForeignAPIRepo.php.
References httpGetCached().
ForeignAPIRepo::getThumbError | ( | $name, | |
$width = -1, | |||
$height = -1, | |||
$otherParams = '', | |||
$lang = null ) |
string | $name | |
int | $width | |
int | $height | |
string | $otherParams | |
string | null | $lang | Language code for language of error |
Definition at line 314 of file ForeignAPIRepo.php.
References FileRepo\$name, fetchImageQuery(), FileRepo\getDisplayName(), getImageInfo(), and wfDebug().
ForeignAPIRepo::getThumbUrlFromCache | ( | $name, | |
$width, | |||
$height, | |||
$params = "" ) |
Return the imageurl from cache if possible.
If the url has been requested today, get it from cache Otherwise retrieve remote thumb url, check for local file.
string | $name | Is a dbkey form of a title |
int | $width | |
int | $height | |
string | $params | Other rendering parameters (page number, etc) from handler's makeParamString. |
Definition at line 356 of file ForeignAPIRepo.php.
References $apiThumbCacheExpiry, FileRepo\$backend, FileRepo\$name, $params, canCacheThumbs(), Wikimedia\FileBackend\FileBackend\fileExists(), FileRepo\getBackend(), Wikimedia\FileBackend\FileBackend\getFileTimestamp(), FileRepo\getHashPath(), FileRepo\getLocalCacheKey(), getZonePath(), getZoneUrl(), httpGet(), Wikimedia\FileBackend\FileBackend\prepare(), Wikimedia\FileBackend\FileBackend\quickCreate(), FileRepo\validateFilename(), wfDebug(), and wfTimestamp().
|
static |
The user agent the ForeignAPIRepo will use.
Definition at line 490 of file ForeignAPIRepo.php.
Referenced by httpGet().
ForeignAPIRepo::getZonePath | ( | $zone | ) |
Get the local directory corresponding to one of the basic zones.
string | $zone |
Reimplemented from FileRepo.
Definition at line 469 of file ForeignAPIRepo.php.
Referenced by getThumbUrlFromCache().
ForeignAPIRepo::getZoneUrl | ( | $zone, | |
$ext = null ) |
string | $zone | |
string | null | $ext | Optional file extension |
Reimplemented from FileRepo.
Definition at line 453 of file ForeignAPIRepo.php.
References FileRepo\$thumbUrl, and FileRepo\$url.
Referenced by getThumbUrlFromCache().
|
static |
string | $url | |
string | $timeout | |
array | $options | |
int | false | &$mtime | Resulting Last-Modified UNIX timestamp if received |
Definition at line 535 of file ForeignAPIRepo.php.
References FileRepo\$url, getUserAgent(), PROTO_HTTP, wfDebug(), and wfTimestamp().
Referenced by getThumbUrlFromCache(), and httpGetCached().
ForeignAPIRepo::httpGetCached | ( | $attribute, | |
$query, | |||
$cacheTTL = 3600 ) |
HTTP GET request to a mediawiki API (with caching)
string | $attribute | Used in cache key creation, mostly |
array | $query | The query parameters for the API request |
int | $cacheTTL | Time to live for the memcached caching |
Definition at line 588 of file ForeignAPIRepo.php.
References FileRepo\$url, httpGet(), FileRepo\makeUrl(), and wfAppendQuery().
Referenced by fetchImageQuery(), and getInfo().
ForeignAPIRepo::newFile | ( | $title, | |
$time = false ) |
Per docs in FileRepo, this needs to return false if we don't support versioned files.
Well, we don't.
PageIdentity | LinkTarget | string | $title | |
string | false | $time |
Reimplemented from FileRepo.
Definition at line 129 of file ForeignAPIRepo.php.
|
protected |
API metadata cache time.
This is often the performance bottleneck for ForeignAPIRepo. For each file used, we must fetch file metadata for it and every high-DPI variant, in serial, during the parse. This is slow if a page has many files, with RTT of the handshake often being significant. The metadata rarely changes, but if a new version of the file was uploaded, it might be displayed incorrectly until its metadata entry falls out of cache.
Definition at line 80 of file ForeignAPIRepo.php.
|
protected |
Check back with Commons after this expiry.
Definition at line 64 of file ForeignAPIRepo.php.
Referenced by getThumbUrlFromCache().
|
protected |
Redownload thumbnail files after this expiry.
Definition at line 67 of file ForeignAPIRepo.php.
|
protected |
Definition at line 62 of file ForeignAPIRepo.php.
|
protected |
Definition at line 83 of file ForeignAPIRepo.php.