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;
45 * @param $path string 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
72 function __construct( $title = false, $repo = false, $path = false, $mime = false ) {
73 if ( !( $title && $repo ) && !$path ) {
74 throw new MWException( __METHOD__
.': not enough parameters, must specify title and repo, or a full path' );
76 if ( $title instanceof Title
) {
77 $this->title
= File
::normalizeTitle( $title, 'exception' );
78 $this->name
= $repo->getNameFromTitle( $title );
80 $this->name
= basename( $path );
81 $this->title
= File
::normalizeTitle( $this->name
, 'exception' );
87 $this->assertRepoDefined();
88 $this->path
= $repo->getRootDirectory() . '/' .
89 $repo->getHashPath( $this->name
) . $this->name
;
94 $this->dims
= array();
97 private function cachePageDimensions( $page = 1 ) {
98 if ( !isset( $this->dims
[$page] ) ) {
99 if ( !$this->getHandler() ) {
102 $this->dims
[$page] = $this->handler
->getPageDimensions( $this, $page );
104 return $this->dims
[$page];
107 function getWidth( $page = 1 ) {
108 $dim = $this->cachePageDimensions( $page );
109 return $dim['width'];
112 function getHeight( $page = 1 ) {
113 $dim = $this->cachePageDimensions( $page );
114 return $dim['height'];
117 function getMimeType() {
118 if ( !isset( $this->mime
) ) {
119 $magic = MimeMagic
::singleton();
120 $this->mime
= $magic->guessMimeType( $this->getLocalRefPath() );
125 function getImageSize( $filename ) {
126 if ( !$this->getHandler() ) {
129 return $this->handler
->getImageSize( $this, $this->getLocalRefPath() );
132 function getMetadata() {
133 if ( !isset( $this->metadata
) ) {
134 if ( !$this->getHandler() ) {
135 $this->metadata
= false;
137 $this->metadata
= $this->handler
->getMetadata( $this, $this->getLocalRefPath() );
140 return $this->metadata
;
145 return $this->repo
->getZoneUrl( 'public' ) . '/' .
146 $this->repo
->getHashPath( $this->name
) . rawurlencode( $this->name
);
153 $this->assertRepoDefined();
154 $props = $this->repo
->getFileProps( $this->path
);
155 if ( isset( $props['size'] ) ) {
156 return $props['size'];
158 return false; // doesn't exist