4 * Prioritized list of file repositories
8 var $localRepo, $foreignRepos, $reposInitialised = false;
9 var $localInfo, $foreignInfo;
11 protected static $instance;
14 * Get a RepoGroup instance. At present only one instance of RepoGroup is
15 * needed in a MediaWiki invocation, this may change in the future.
17 static function singleton() {
18 if ( self
::$instance ) {
19 return self
::$instance;
21 global $wgLocalFileRepo, $wgForeignFileRepos;
22 self
::$instance = new RepoGroup( $wgLocalFileRepo, $wgForeignFileRepos );
23 return self
::$instance;
27 * Destroy the singleton instance, so that a new one will be created next
28 * time singleton() is called.
30 static function destroySingleton() {
31 self
::$instance = null;
35 * Set the singleton instance to a given object
37 static function setSingleton( $instance ) {
38 self
::$instance = $instance;
42 * Construct a group of file repositories.
43 * @param array $data Array of repository info arrays.
44 * Each info array is an associative array with the 'class' member
45 * giving the class name. The entire array is passed to the repository
46 * constructor as the first parameter.
48 function __construct( $localInfo, $foreignInfo ) {
49 $this->localInfo
= $localInfo;
50 $this->foreignInfo
= $foreignInfo;
54 * Search repositories for an image.
55 * You can also use wfGetFile() to do this.
56 * @param mixed $title Title object or string
57 * @param mixed $time The 14-char timestamp before which the file should
58 * have been uploaded, or false for the current version
59 * @return File object or false if it is not found
61 function findFile( $title, $time = false ) {
62 if ( !$this->reposInitialised
) {
63 $this->initialiseRepos();
66 $image = $this->localRepo
->findFile( $title, $time );
70 foreach ( $this->foreignRepos
as $repo ) {
71 $image = $repo->findFile( $title, $time );
80 * Interface for FileRepo::checkRedirect()
82 function checkRedirect( $title ) {
83 if ( !$this->reposInitialised
) {
84 $this->initialiseRepos();
87 $redir = $this->localRepo
->checkRedirect( $title );
91 foreach ( $this->foreignRepos
as $repo ) {
92 $redir = $repo->checkRedirect( $title );
101 * Get the repo instance with a given key.
103 function getRepo( $index ) {
104 if ( !$this->reposInitialised
) {
105 $this->initialiseRepos();
107 if ( $index === 'local' ) {
108 return $this->localRepo
;
109 } elseif ( isset( $this->foreignRepos
[$index] ) ) {
110 return $this->foreignRepos
[$index];
117 * Get the local repository, i.e. the one corresponding to the local image
118 * table. Files are typically uploaded to the local repository.
120 function getLocalRepo() {
121 return $this->getRepo( 'local' );
125 * Initialise the $repos array
127 function initialiseRepos() {
128 if ( $this->reposInitialised
) {
131 $this->reposInitialised
= true;
133 $this->localRepo
= $this->newRepo( $this->localInfo
);
134 $this->foreignRepos
= array();
135 foreach ( $this->foreignInfo
as $key => $info ) {
136 $this->foreignRepos
[$key] = $this->newRepo( $info );
141 * Create a repo class based on an info structure
143 protected function newRepo( $info ) {
144 $class = $info['class'];
145 return new $class( $info );
149 * Split a virtual URL into repo, zone and rel parts
150 * @return an array containing repo, zone and rel
152 function splitVirtualUrl( $url ) {
153 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
154 throw new MWException( __METHOD__
.': unknown protoocl' );
157 $bits = explode( '/', substr( $url, 9 ), 3 );
158 if ( count( $bits ) != 3 ) {
159 throw new MWException( __METHOD__
.": invalid mwrepo URL: $url" );
164 function getFileProps( $fileName ) {
165 if ( FileRepo
::isVirtualUrl( $fileName ) ) {
166 list( $repoName, /* $zone */, /* $rel */ ) = $this->splitVirtualUrl( $fileName );
167 if ( $repoName === '' ) {
170 $repo = $this->getRepo( $repoName );
171 return $repo->getFileProps( $fileName );
173 return File
::getPropsFromPath( $fileName );