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
137
138
139
140
141
142
143
144
145
146
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\MediaWikiServices;
/**
* @ingroup ExternalStorage
* @deprecated since 1.34 Use the ExternalStoreAccess service instead.
*/
class ExternalStore {
/**
* Get an external store object of the given type, with the given parameters
*
* @param string $proto Type of external storage, should be a value in $wgExternalStores
* @param array $params Associative array of ExternalStoreMedium parameters
* @return ExternalStoreMedium|bool The store class or false on error
* @deprecated since 1.34
*/
public static function getStoreObject( $proto, array $params = [] ) {
try {
return MediaWikiServices::getInstance()
->getExternalStoreFactory()
->getStore( $proto, $params );
} catch ( ExternalStoreException $e ) {
return false;
}
}
/**
* Fetch data from given URL
*
* @param string $url The URL of the text to get
* @param array $params Associative array of ExternalStoreMedium parameters
* @return string|bool The text stored or false on error
* @deprecated since 1.34
*/
public static function fetchFromURL( $url, array $params = [] ) {
try {
return MediaWikiServices::getInstance()
->getExternalStoreAccess()
->fetchFromURL( $url, $params );
} catch ( ExternalStoreException $e ) {
return false;
}
}
/**
* 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.
*
* @param string $url A partial external store URL ("<store type>://<location>")
* @param string $data
* @param array $params Associative array of ExternalStoreMedium parameters
* @return string|bool The URL of the stored data item, or false on error
* @deprecated since 1.34
*/
public static function insert( $url, $data, array $params = [] ) {
try {
$esFactory = MediaWikiServices::getInstance()->getExternalStoreFactory();
$location = $esFactory->getStoreLocationFromUrl( $url );
return $esFactory->getStoreForUrl( $url, $params )->store( $location, $data );
} catch ( ExternalStoreException $e ) {
return false;
}
}
/**
* Fetch data from multiple URLs with a minimum of round trips
*
* @param array $urls The URLs of the text to get
* @return array Map from url to its data. Data is either string when found
* or false on failure.
* @throws ExternalStoreException
* @deprecated since 1.34
*/
public static function batchFetchFromURLs( array $urls ) {
return MediaWikiServices::getInstance()->getExternalStoreAccess()->fetchFromURLs( $urls );
}
/**
* 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
* provided by $wgDefaultExternalStore.
*
* @param string $data
* @param array $params Map of ExternalStoreMedium::__construct context parameters
* @return string The URL of the stored data item
* @throws ExternalStoreException
* @deprecated since 1.34
*/
public static function insertToDefault( $data, array $params = [] ) {
return MediaWikiServices::getInstance()->getExternalStoreAccess()->insert( $data, $params );
}
/**
* 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
* as provided in the first parameter.
*
* @param array $tryStores Refer to $wgDefaultExternalStore
* @param string $data
* @param array $params Map of ExternalStoreMedium::__construct context parameters
* @return string The URL of the stored data item
* @throws ExternalStoreException
* @deprecated since 1.34
*/
public static function insertWithFallback( array $tryStores, $data, array $params = [] ) {
return MediaWikiServices::getInstance()
->getExternalStoreAccess()
->insert( $data, $params, $tryStores );
}
/**
* @param string $data
* @param string $wiki
* @return string The URL of the stored data item
* @throws ExternalStoreException
* @deprecated since 1.34 Use insertToDefault() with 'wiki' set
*/
public static function insertToForeignDefault( $data, $wiki ) {
return MediaWikiServices::getInstance()
->getExternalStoreAccess()
->insert( $data, [ 'domain' => $wiki ] );
}
}
|
