MediaWiki  REL1_31
RESTBagOStuff.php
Go to the documentation of this file.
1 <?php
2 
29 class RESTBagOStuff extends BagOStuff {
30 
34  private $client;
35 
40  private $url;
41 
42  public function __construct( $params ) {
43  if ( empty( $params['url'] ) ) {
44  throw new InvalidArgumentException( 'URL parameter is required' );
45  }
46  parent::__construct( $params );
47  if ( empty( $params['client'] ) ) {
48  $this->client = new MultiHttpClient( [] );
49  } else {
50  $this->client = $params['client'];
51  }
52  // Make sure URL ends with /
53  $this->url = rtrim( $params['url'], '/' ) . '/';
54  // Default config, R+W > N; no locks on reads though; writes go straight to state-machine
56  }
57 
63  protected function doGet( $key, $flags = 0 ) {
64  $req = [
65  'method' => 'GET',
66  'url' => $this->url . rawurlencode( $key ),
67  ];
68 
69  list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->client->run( $req );
70  if ( $rcode === 200 ) {
71  if ( is_string( $rbody ) ) {
72  return unserialize( $rbody );
73  }
74  return false;
75  }
76  if ( $rcode === 0 || ( $rcode >= 400 && $rcode != 404 ) ) {
77  return $this->handleError( "Failed to fetch $key", $rcode, $rerr );
78  }
79  return false;
80  }
81 
89  protected function handleError( $msg, $rcode, $rerr ) {
90  $this->logger->error( "$msg : ({code}) {error}", [
91  'code' => $rcode,
92  'error' => $rerr
93  ] );
94  $this->setLastError( $rcode === 0 ? self::ERR_UNREACHABLE : self::ERR_UNEXPECTED );
95  return false;
96  }
97 
107  public function set( $key, $value, $exptime = 0, $flags = 0 ) {
108  $req = [
109  'method' => 'PUT',
110  'url' => $this->url . rawurlencode( $key ),
111  'body' => serialize( $value )
112  ];
113  list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->client->run( $req );
114  if ( $rcode === 200 || $rcode === 201 ) {
115  return true;
116  }
117  return $this->handleError( "Failed to store $key", $rcode, $rerr );
118  }
119 
126  public function delete( $key ) {
127  $req = [
128  'method' => 'DELETE',
129  'url' => $this->url . rawurlencode( $key ),
130  ];
131  list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->client->run( $req );
132  if ( $rcode === 200 || $rcode === 204 || $rcode === 205 ) {
133  return true;
134  }
135  return $this->handleError( "Failed to delete $key", $rcode, $rerr );
136  }
137 }
MultiHttpClient
Class to handle concurrent HTTP requests.
Definition: MultiHttpClient.php:48
unserialize
unserialize( $serialized)
Definition: ApiMessage.php:192
$params
$params
Definition: styleTest.css.php:40
serialize
serialize()
Definition: ApiMessage.php:184
BagOStuff
interface is intended to be more or less compatible with the PHP memcached client.
Definition: BagOStuff.php:47
RESTBagOStuff
Interface to key-value storage behind an HTTP server.
Definition: RESTBagOStuff.php:29
IExpiringStore\QOS_SYNCWRITES_QC
const QOS_SYNCWRITES_QC
Definition: IExpiringStore.php:55
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
RESTBagOStuff\__construct
__construct( $params)
Definition: RESTBagOStuff.php:42
RESTBagOStuff\doGet
doGet( $key, $flags=0)
Definition: RESTBagOStuff.php:63
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
$value
$value
Definition: styleTest.css.php:45
RESTBagOStuff\$client
MultiHttpClient $client
Definition: RESTBagOStuff.php:34
RESTBagOStuff\$url
string $url
REST URL to use for storage.
Definition: RESTBagOStuff.php:40
IExpiringStore\ATTR_SYNCWRITES
const ATTR_SYNCWRITES
Definition: IExpiringStore.php:52
$req
this hook is for auditing only $req
Definition: hooks.txt:990
RESTBagOStuff\handleError
handleError( $msg, $rcode, $rerr)
Handle storage error.
Definition: RESTBagOStuff.php:89
BagOStuff\setLastError
setLastError( $err)
Set the "last error" registry.
Definition: BagOStuff.php:633