2005-04-18 17:21:27 +00:00
|
|
|
<?php
|
WARNING: HUGE COMMIT
Doxygen documentation update:
* Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group.
* Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file.
* Removed some empty comments
* Removed some ?>
Added following groups:
* ExternalStorage
* JobQueue
* MaintenanceLanguage
One more thing: there are still a lot of warnings when generating the doc.
2008-05-20 17:13:28 +00:00
|
|
|
/**
|
|
|
|
|
* @defgroup ExternalStorage ExternalStorage
|
|
|
|
|
*/
|
|
|
|
|
|
2005-04-18 17:21:27 +00:00
|
|
|
/**
|
|
|
|
|
* Constructor class for data kept in external repositories
|
|
|
|
|
*
|
2006-01-07 13:09:30 +00:00
|
|
|
* External repositories might be populated by maintenance/async
|
|
|
|
|
* scripts, thus partial moving of data may be possible, as well
|
2005-04-18 17:21:27 +00:00
|
|
|
* as possibility to have any storage format (i.e. for archives)
|
WARNING: HUGE COMMIT
Doxygen documentation update:
* Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group.
* Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file.
* Removed some empty comments
* Removed some ?>
Added following groups:
* ExternalStorage
* JobQueue
* MaintenanceLanguage
One more thing: there are still a lot of warnings when generating the doc.
2008-05-20 17:13:28 +00:00
|
|
|
*
|
|
|
|
|
* @ingroup ExternalStorage
|
2005-04-18 17:21:27 +00:00
|
|
|
*/
|
|
|
|
|
class ExternalStore {
|
|
|
|
|
/* Fetch data from given URL */
|
2008-01-15 14:48:24 +00:00
|
|
|
static function fetchFromURL($url) {
|
2005-04-18 17:21:27 +00:00
|
|
|
global $wgExternalStores;
|
|
|
|
|
|
2006-01-07 13:09:30 +00:00
|
|
|
if (!$wgExternalStores)
|
2005-04-18 17:21:27 +00:00
|
|
|
return false;
|
|
|
|
|
|
|
|
|
|
@list($proto,$path)=explode('://',$url,2);
|
|
|
|
|
/* Bad URL */
|
2006-01-07 13:09:30 +00:00
|
|
|
if ($path=="")
|
2005-04-18 17:21:27 +00:00
|
|
|
return false;
|
2006-01-09 03:16:56 +00:00
|
|
|
|
|
|
|
|
$store =& ExternalStore::getStoreObject( $proto );
|
|
|
|
|
if ( $store === false )
|
|
|
|
|
return false;
|
|
|
|
|
return $store->fetchFromURL($url);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get an external store object of the given type
|
|
|
|
|
*/
|
2008-01-15 14:48:24 +00:00
|
|
|
static function &getStoreObject( $proto ) {
|
2006-01-09 03:16:56 +00:00
|
|
|
global $wgExternalStores;
|
|
|
|
|
if (!$wgExternalStores)
|
|
|
|
|
return false;
|
2005-04-18 17:21:27 +00:00
|
|
|
/* Protocol not enabled */
|
|
|
|
|
if (!in_array( $proto, $wgExternalStores ))
|
|
|
|
|
return false;
|
|
|
|
|
|
|
|
|
|
$class='ExternalStore'.ucfirst($proto);
|
2007-06-06 16:01:14 +00:00
|
|
|
/* Any custom modules should be added to $wgAutoLoadClasses for on-demand loading */
|
2005-04-18 17:21:27 +00:00
|
|
|
if (!class_exists($class)) {
|
2007-06-06 16:01:14 +00:00
|
|
|
return false;
|
2005-04-18 17:21:27 +00:00
|
|
|
}
|
|
|
|
|
$store=new $class();
|
2006-01-09 03:16:56 +00:00
|
|
|
return $store;
|
2005-04-18 17:21:27 +00:00
|
|
|
}
|
|
|
|
|
|
2006-01-09 03:16:56 +00:00
|
|
|
/**
|
|
|
|
|
* Store a data item to an external store, identified by a partial URL
|
2006-03-11 17:13:49 +00:00
|
|
|
* The protocol part is used to identify the class, the rest is passed to the
|
|
|
|
|
* class itself as a parameter.
|
2006-01-09 03:16:56 +00:00
|
|
|
* Returns the URL of the stored data item, or false on error
|
2005-04-18 17:21:27 +00:00
|
|
|
*/
|
2008-01-15 14:48:24 +00:00
|
|
|
static function insert( $url, $data ) {
|
2006-01-09 03:16:56 +00:00
|
|
|
list( $proto, $params ) = explode( '://', $url, 2 );
|
|
|
|
|
$store =& ExternalStore::getStoreObject( $proto );
|
|
|
|
|
if ( $store === false ) {
|
|
|
|
|
return false;
|
|
|
|
|
} else {
|
|
|
|
|
return $store->store( $params, $data );
|
|
|
|
|
}
|
|
|
|
|
}
|
2005-04-18 17:21:27 +00:00
|
|
|
}
|