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
|
<?php
/**
* 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
*/
class UploadStashFile extends UnregisteredLocalFile {
private $fileKey;
private $urlName;
protected $url;
/**
* A LocalFile wrapper around a file that has been temporarily stashed,
* so we can do things like create thumbnails for it. Arguably
* UnregisteredLocalFile should be handling its own file repo but that
* class is a bit retarded currently.
*
* @param FileRepo $repo Repository where we should find the path
* @param string $path Path to file
* @param string $key Key to store the path and any stashed data under
* @throws UploadStashBadPathException
* @throws UploadStashFileNotFoundException
*/
public function __construct( $repo, $path, $key ) {
$this->fileKey = $key;
// resolve mwrepo:// urls
if ( FileRepo::isVirtualUrl( $path ) ) {
$path = $repo->resolveVirtualUrl( $path );
} else {
// check if path appears to be sane, no parent traversals,
// and is in this repo's temp zone.
$repoTempPath = $repo->getZonePath( 'temp' );
if ( ( !$repo->validateFilename( $path ) ) ||
( strpos( $path, $repoTempPath ) !== 0 )
) {
wfDebug( "UploadStash: tried to construct an UploadStashFile "
. "from a file that should already exist at '$path', but path is not valid" );
throw new UploadStashBadPathException(
wfMessage( 'uploadstash-bad-path-invalid' )
);
}
// check if path exists! and is a plain file.
if ( !$repo->fileExists( $path ) ) {
wfDebug( "UploadStash: tried to construct an UploadStashFile from "
. "a file that should already exist at '$path', but path is not found" );
throw new UploadStashFileNotFoundException(
wfMessage( 'uploadstash-file-not-found-not-exists' )
);
}
}
parent::__construct( false, $repo, $path, false );
$this->name = basename( $this->path );
}
/**
* A method needed by the file transforming and scaling routines in File.php
* We do not necessarily care about doing the description at this point
* However, we also can't return the empty string, as the rest of MediaWiki
* demands this (and calls to imagemagick convert require it to be there)
*
* @return string Dummy value
*/
public function getDescriptionUrl() {
return $this->getUrl();
}
/**
* Get the path for the thumbnail (actually any transformation of this file)
* The actual argument is the result of thumbName although we seem to have
* buggy code elsewhere that expects a boolean 'suffix'
*
* @param string $thumbName Name of thumbnail (e.g. "120px-123456.jpg" ),
* or false to just get the path
* @return string Path thumbnail should take on filesystem, or containing
* directory if thumbname is false
*/
public function getThumbPath( $thumbName = false ) {
$path = dirname( $this->path );
if ( $thumbName !== false ) {
$path .= "/$thumbName";
}
return $path;
}
/**
* Return the file/url base name of a thumbnail with the specified parameters.
* We override this because we want to use the pretty url name instead of the
* ugly file name.
*
* @param array $params Handler-specific parameters
* @param int $flags Bitfield that supports THUMB_* constants
* @return string|null Base name for URL, like '120px-12345.jpg', or null if there is no handler
*/
public function thumbName( $params, $flags = 0 ) {
return $this->generateThumbName( $this->getUrlName(), $params );
}
/**
* Helper function -- given a 'subpage', return the local URL,
* e.g. /wiki/Special:UploadStash/subpage
* @param string $subPage
* @return string Local URL for this subpage in the Special:UploadStash space.
*/
private function getSpecialUrl( $subPage ) {
return SpecialPage::getTitleFor( 'UploadStash', $subPage )->getLocalURL();
}
/**
* Get a URL to access the thumbnail
* This is required because the model of how files work requires that
* the thumbnail urls be predictable. However, in our model the URL is
* not based on the filename (that's hidden in the db)
*
* @param string $thumbName Basename of thumbnail file -- however, we don't
* want to use the file exactly
* @return string URL to access thumbnail, or URL with partial path
*/
public function getThumbUrl( $thumbName = false ) {
wfDebug( __METHOD__ . " getting for $thumbName" );
return $this->getSpecialUrl( 'thumb/' . $this->getUrlName() . '/' . $thumbName );
}
/**
* The basename for the URL, which we want to not be related to the filename.
* Will also be used as the lookup key for a thumbnail file.
*
* @return string Base url name, like '120px-123456.jpg'
*/
public function getUrlName() {
if ( !$this->urlName ) {
$this->urlName = $this->fileKey;
}
return $this->urlName;
}
/**
* Return the URL of the file, if for some reason we wanted to download it
* We tend not to do this for the original file, but we do want thumb icons
*
* @return string Url
*/
public function getUrl() {
if ( !isset( $this->url ) ) {
$this->url = $this->getSpecialUrl( 'file/' . $this->getUrlName() );
}
return $this->url;
}
/**
* Parent classes use this method, for no obvious reason, to return the path
* (relative to wiki root, I assume). But with this class, the URL is
* unrelated to the path.
*
* @return string Url
*/
public function getFullUrl() {
return $this->getUrl();
}
/**
* Getter for file key (the unique id by which this file's location &
* metadata is stored in the db)
*
* @return string File key
*/
public function getFileKey() {
return $this->fileKey;
}
/**
* Remove the associated temporary file
* @return bool Success
*/
public function remove() {
if ( !$this->repo->fileExists( $this->path ) ) {
// Maybe the file's already been removed? This could totally happen in UploadBase.
return true;
}
return $this->repo->freeTemp( $this->path );
}
public function exists() {
return $this->repo->fileExists( $this->path );
}
}
|
