3 * File without associated database record.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileAbstraction
25 * A file object referring to either a standalone local file, or a file in a
26 * local repository with no database, for example an FileRepo repository.
30 * TODO: Currently it doesn't really work in the repository role, there are
31 * lots of functions missing. It is used by the WebStore extension in the
34 * @ingroup FileAbstraction
36 class UnregisteredLocalFile
extends File
{
37 var $title, $path, $mime, $dims, $metadata;
45 * @param string $path Storage path
47 * @return UnregisteredLocalFile
49 static function newFromPath( $path, $mime ) {
50 return new self( false, false, $path, $mime );
56 * @return UnregisteredLocalFile
58 static function newFromTitle( $title, $repo ) {
59 return new self( $title, $repo, false, false );
63 * Create an UnregisteredLocalFile based on a path or a (title,repo) pair.
64 * A FileRepo object is not required here, unlike most other File classes.
67 * @param $title Title|bool
68 * @param $repo FileRepo|bool
69 * @param $path string|bool
70 * @param $mime string|bool
72 function __construct( $title = false, $repo = false, $path = false, $mime = false ) {
73 if ( !( $title && $repo ) && !$path ) {
74 throw new MWException( __METHOD__
.
75 ': not enough parameters, must specify title and repo, or a full path' );
77 if ( $title instanceof Title
) {
78 $this->title
= File
::normalizeTitle( $title, 'exception' );
79 $this->name
= $repo->getNameFromTitle( $title );
81 $this->name
= basename( $path );
82 $this->title
= File
::normalizeTitle( $this->name
, 'exception' );
88 $this->assertRepoDefined();
89 $this->path
= $repo->getRootDirectory() . '/' .
90 $repo->getHashPath( $this->name
) . $this->name
;
95 $this->dims
= array();
102 private function cachePageDimensions( $page = 1 ) {
103 if ( !isset( $this->dims
[$page] ) ) {
104 if ( !$this->getHandler() ) {
107 $this->dims
[$page] = $this->handler
->getPageDimensions( $this, $page );
110 return $this->dims
[$page];
117 function getWidth( $page = 1 ) {
118 $dim = $this->cachePageDimensions( $page );
120 return $dim['width'];
127 function getHeight( $page = 1 ) {
128 $dim = $this->cachePageDimensions( $page );
130 return $dim['height'];
134 * @return bool|string
136 function getMimeType() {
137 if ( !isset( $this->mime
) ) {
138 $magic = MimeMagic
::singleton();
139 $this->mime
= $magic->guessMimeType( $this->getLocalRefPath() );
146 * @param $filename String
149 function getImageSize( $filename ) {
150 if ( !$this->getHandler() ) {
154 return $this->handler
->getImageSize( $this, $this->getLocalRefPath() );
160 function getMetadata() {
161 if ( !isset( $this->metadata
) ) {
162 if ( !$this->getHandler() ) {
163 $this->metadata
= false;
165 $this->metadata
= $this->handler
->getMetadata( $this, $this->getLocalRefPath() );
169 return $this->metadata
;
173 * @return bool|string
177 return $this->repo
->getZoneUrl( 'public' ) . '/' .
178 $this->repo
->getHashPath( $this->name
) . rawurlencode( $this->name
);
188 $this->assertRepoDefined();
190 return $this->repo
->getFileSize( $this->path
);
194 * Optimize getLocalRefPath() by using an existing local reference.
195 * The file at the path of $fsFile should not be deleted (or at least
196 * not until the end of the request). This is mostly a performance hack.
198 * @param $fsFile FSFile
201 public function setLocalReference( FSFile
$fsFile ) {
202 $this->fsFile
= $fsFile;