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
|
<?php
/**
* @defgroup ExternalStorage ExternalStorage
*/
/**
* Constructor class for data kept in external repositories
*
* External repositories might be populated by maintenance/async
* scripts, thus partial moving of data may be possible, as well
* as possibility to have any storage format (i.e. for archives)
*
* @ingroup ExternalStorage
*/
class ExternalStore {
var $mParams;
function __construct( $params = array() ) {
$this->mParams = $params;
}
/**
* Fetch data from given URL
*
* @param $url String: The URL of the text to get
* @param $params Array: associative array of parameters for the ExternalStore object.
* @return The text stored or false on error
*/
static function fetchFromURL( $url, $params = array() ) {
global $wgExternalStores;
if( !$wgExternalStores )
return false;
@list( $proto, $path ) = explode( '://', $url, 2 );
/* Bad URL */
if( $path == '' )
return false;
$store = self::getStoreObject( $proto, $params );
if ( $store === false )
return false;
return $store->fetchFromURL( $url );
}
/**
* Get an external store object of the given type, with the given parameters
*
* @param $proto String: type of external storage, should be a value in $wgExternalStores
* @param $params Array: associative array of parameters for the ExternalStore object.
* @return ExternalStore subclass or false on error
*/
static function getStoreObject( $proto, $params = array() ) {
global $wgExternalStores;
if( !$wgExternalStores )
return false;
/* Protocol not enabled */
if( !in_array( $proto, $wgExternalStores ) )
return false;
$class = 'ExternalStore' . ucfirst( $proto );
/* Any custom modules should be added to $wgAutoLoadClasses for on-demand loading */
if( !class_exists( $class ) ) {
return false;
}
return new $class($params);
}
/**
* Store a data item to an external store, identified by a partial URL
* The protocol part is used to identify the class, the rest is passed to the
* class itself as a parameter.
* @return The URL of the stored data item, or false on error
*/
static function insert( $url, $data, $params = array() ) {
list( $proto, $params ) = explode( '://', $url, 2 );
$store = self::getStoreObject( $proto, $params );
if ( $store === false ) {
return false;
} else {
return $store->store( $params, $data );
}
}
/**
* Like insert() above, but does more of the work for us.
* This function does not need a url param, it builds it by
* itself. It also fails-over to the next possible clusters.
*
* @param $data String
* @param $storageParams Array: associative array of parameters for the ExternalStore object.
* @return The URL of the stored data item, or false on error
*/
public static function insertToDefault( $data, $storageParams = array() ) {
global $wgDefaultExternalStore;
$tryStores = (array)$wgDefaultExternalStore;
$error = false;
while ( count( $tryStores ) > 0 ) {
$index = mt_rand(0, count( $tryStores ) - 1);
$storeUrl = $tryStores[$index];
wfDebug( __METHOD__.": trying $storeUrl\n" );
list( $proto, $params ) = explode( '://', $storeUrl, 2 );
$store = self::getStoreObject( $proto, $storageParams );
if ( $store === false ) {
throw new MWException( "Invalid external storage protocol - $storeUrl" );
}
try {
$url = $store->store( $params, $data ); // Try to save the object
} catch ( DBConnectionError $error ) {
$url = false;
} catch( DBQueryError $error ) {
$url = false;
}
if ( $url ) {
return $url; // Done!
} else {
unset( $tryStores[$index] ); // Don't try this one again!
$tryStores = array_values( $tryStores ); // Must have consecutive keys
wfDebugLog( 'ExternalStorage', "Unable to store text to external storage $storeUrl" );
}
}
// All stores failed
if ( $error ) {
// Rethrow the last connection error
throw $error;
} else {
throw new MWException( "Unable to store text to external storage" );
}
}
/** Like insertToDefault, but inserts on another wiki */
public static function insertToForeignDefault( $data, $wiki ) {
return self::insertToDefault( $data, array( 'wiki' => $wiki ) );
}
}
|
