MediaWiki master
UploadStashFile.php
Go to the documentation of this file.
1<?php
22
27 private $fileKey;
28 private $urlName;
29 protected $url;
30
43 public function __construct( $repo, $path, $key ) {
44 $this->fileKey = $key;
45
46 // resolve mwrepo:// urls
49 } else {
50 // check if path appears to be correct, no parent traversals,
51 // and is in this repo's temp zone.
52 $repoTempPath = $repo->getZonePath( 'temp' );
53 if ( ( !$repo->validateFilename( $path ) ) ||
54 !str_starts_with( $path, $repoTempPath )
55 ) {
56 wfDebug( "UploadStash: tried to construct an UploadStashFile "
57 . "from a file that should already exist at '$path', but path is not valid" );
59 wfMessage( 'uploadstash-bad-path-invalid' )
60 );
61 }
62
63 // check if path exists! and is a plain file.
64 if ( !$repo->fileExists( $path ) ) {
65 wfDebug( "UploadStash: tried to construct an UploadStashFile from "
66 . "a file that should already exist at '$path', but path is not found" );
68 wfMessage( 'uploadstash-file-not-found-not-exists' )
69 );
70 }
71 }
72
73 parent::__construct( false, $repo, $path, false );
74
75 $this->name = basename( $this->path );
76 }
77
86 public function getDescriptionUrl() {
87 return $this->getUrl();
88 }
89
100 public function getThumbPath( $thumbName = false ) {
101 $path = dirname( $this->path );
102 if ( $thumbName !== false ) {
103 $path .= "/$thumbName";
104 }
105
106 return $path;
107 }
108
118 public function thumbName( $params, $flags = 0 ) {
119 return $this->generateThumbName( $this->getUrlName(), $params );
120 }
121
128 private function getSpecialUrl( $subPage ) {
129 return SpecialPage::getTitleFor( 'UploadStash', $subPage )->getLocalURL();
130 }
131
142 public function getThumbUrl( $thumbName = false ) {
143 wfDebug( __METHOD__ . " getting for $thumbName" );
144
145 return $this->getSpecialUrl( 'thumb/' . $this->getUrlName() . '/' . $thumbName );
146 }
147
154 public function getUrlName() {
155 if ( !$this->urlName ) {
156 $this->urlName = $this->fileKey;
157 }
158
159 return $this->urlName;
160 }
161
168 public function getUrl() {
169 if ( !isset( $this->url ) ) {
170 $this->url = $this->getSpecialUrl( 'file/' . $this->getUrlName() );
171 }
172
173 return $this->url;
174 }
175
183 public function getFullUrl() {
184 return $this->getUrl();
185 }
186
193 public function getFileKey() {
194 return $this->fileKey;
195 }
196
201 public function remove() {
202 if ( !$this->repo->fileExists( $this->path ) ) {
203 // Maybe the file's already been removed? This could totally happen in UploadBase.
204 return true;
205 }
206
207 return $this->repo->freeTemp( $this->path );
208 }
209
210 public function exists() {
211 return $this->repo->fileExists( $this->path );
212 }
213}
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
resolveVirtualUrl( $url)
Get the backend storage path corresponding to a virtual URL.
Definition FileRepo.php:357
fileExists( $file)
Checks existence of a file.
getZonePath( $zone)
Get the storage path corresponding to one of the zones.
Definition FileRepo.php:397
static isVirtualUrl( $url)
Determine if a string is an mwrepo:// URL.
Definition FileRepo.php:287
validateFilename( $filename)
Determine if a relative path is valid, i.e.
FileRepo LocalRepo ForeignAPIRepo false $repo
Some member variables can be lazy-initialised using __get().
Definition File.php:120
generateThumbName( $name, $params)
Generate a thumbnail file name from a name and specified parameters.
Definition File.php:1094
Parent class for all special pages.
File without associated database record.
exists()
Returns true if file exists in the repository.
__construct( $repo, $path, $key)
A LocalFile wrapper around a file that has been temporarily stashed, so we can do things like create ...
getThumbPath( $thumbName=false)
Get the path for the thumbnail (actually any transformation of this file) The actual argument is the ...
getDescriptionUrl()
A method needed by the file transforming and scaling routines in File.php We do not necessarily care ...
getUrl()
Return the URL of the file, if for some reason we wanted to download it We tend not to do this for th...
getThumbUrl( $thumbName=false)
Get a URL to access the thumbnail This is required because the model of how files work requires that ...
getFullUrl()
Parent classes use this method, for no obvious reason, to return the path (relative to wiki root,...
getUrlName()
The basename for the URL, which we want to not be related to the filename.
getFileKey()
Getter for file key (the unique id by which this file's location & metadata is stored in the db)
thumbName( $params, $flags=0)
Return the file/url base name of a thumbnail with the specified parameters.