MediaWiki REL1_31
RESTBagOStuff.php
Go to the documentation of this file.
1<?php
2
29class 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}
serialize()
unserialize( $serialized)
interface is intended to be more or less compatible with the PHP memcached client.
Definition BagOStuff.php:47
const ERR_UNEXPECTED
Definition BagOStuff.php:83
setLastError( $err)
Set the "last error" registry.
Class to handle concurrent HTTP requests.
Interface to key-value storage behind an HTTP server.
__construct( $params)
doGet( $key, $flags=0)
handleError( $msg, $rcode, $rerr)
Handle storage error.
string $url
REST URL to use for storage.
MultiHttpClient $client
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
this hook is for auditing only $req
Definition hooks.txt:990
$params