MediaWiki  master
SwiftVirtualRESTService.php
Go to the documentation of this file.
1 <?php
30  protected $authCreds;
32  protected $authSessionTimestamp = 0;
36  protected $authCachedStatus = null;
38  protected $authCachedReason = null;
39 
47  public function __construct( array $params ) {
48  // set up defaults and merge them with the given params
49  $mparams = array_merge( [
50  'name' => 'swift'
51  ], $params );
52  parent::__construct( $mparams );
53  }
54 
58  protected function needsAuthRequest() {
59  if ( !$this->authCreds ) {
60  return true;
61  }
62  if ( $this->authErrorTimestamp !== null ) {
63  if ( ( time() - $this->authErrorTimestamp ) < 60 ) {
64  return $this->authCachedStatus; // failed last attempt; don't bother
65  } else { // actually retry this time
66  $this->authErrorTimestamp = null;
67  }
68  }
69  // Session keys expire after a while, so we renew them periodically
70  return ( ( time() - $this->authSessionTimestamp ) > $this->params['swiftAuthTTL'] );
71  }
72 
73  protected function applyAuthResponse( array $req ) {
74  $this->authSessionTimestamp = 0;
75  list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $req['response'];
76  if ( $rcode >= 200 && $rcode <= 299 ) { // OK
77  $this->authCreds = [
78  'auth_token' => $rhdrs['x-auth-token'],
79  'storage_url' => $rhdrs['x-storage-url']
80  ];
81  $this->authSessionTimestamp = time();
82  return true;
83  } elseif ( $rcode === 403 ) {
84  $this->authCachedStatus = 401;
85  $this->authCachedReason = 'Authorization Required';
86  $this->authErrorTimestamp = time();
87  return false;
88  } else {
89  $this->authCachedStatus = $rcode;
90  $this->authCachedReason = $rdesc;
91  $this->authErrorTimestamp = time();
92  return null;
93  }
94  }
95 
96  public function onRequests( array $reqs, Closure $idGeneratorFunc ) {
97  $result = [];
98  $firstReq = reset( $reqs );
99  if ( $firstReq && count( $reqs ) == 1 && isset( $firstReq['isAuth'] ) ) {
100  // This was an authentication request for work requests...
101  $result = $reqs; // no change
102  } else {
103  // These are actual work requests...
104  $needsAuth = $this->needsAuthRequest();
105  if ( $needsAuth === true ) {
106  // These are work requests and we don't have any token to use.
107  // Replace the work requests with an authentication request.
108  $result = [
109  $idGeneratorFunc() => [
110  'method' => 'GET',
111  'url' => $this->params['swiftAuthUrl'] . "/v1.0",
112  'headers' => [
113  'x-auth-user' => $this->params['swiftUser'],
114  'x-auth-key' => $this->params['swiftKey'] ],
115  'isAuth' => true,
116  'chain' => $reqs
117  ]
118  ];
119  } elseif ( $needsAuth !== false ) {
120  // These are work requests and authentication has previously failed.
121  // It is most efficient to just give failed pseudo responses back for
122  // the original work requests.
123  foreach ( $reqs as $key => $req ) {
124  $req['response'] = [
125  'code' => $this->authCachedStatus,
126  'reason' => $this->authCachedReason,
127  'headers' => [],
128  'body' => '',
129  'error' => ''
130  ];
131  $result[$key] = $req;
132  }
133  } else {
134  // These are work requests and we have a token already.
135  // Go through and mangle each request to include a token.
136  foreach ( $reqs as $key => $req ) {
137  // The default encoding treats the URL as a REST style path that uses
138  // forward slash as a hierarchical delimiter (and never otherwise).
139  // Subclasses can override this, and should be documented in any case.
140  $parts = array_map( 'rawurlencode', explode( '/', $req['url'] ) );
141  $req['url'] = $this->authCreds['storage_url'] . '/' . implode( '/', $parts );
142  $req['headers']['x-auth-token'] = $this->authCreds['auth_token'];
143  $result[$key] = $req;
144  // @TODO: add ETag/Content-Length and such as needed
145  }
146  }
147  }
148  return $result;
149  }
150 
151  public function onResponses( array $reqs, Closure $idGeneratorFunc ) {
152  $firstReq = reset( $reqs );
153  if ( $firstReq && count( $reqs ) == 1 && isset( $firstReq['isAuth'] ) ) {
154  $result = [];
155  // This was an authentication request for work requests...
156  if ( $this->applyAuthResponse( $firstReq ) ) {
157  // If it succeeded, we can subsitute the work requests back.
158  // Call this recursively in order to munge and add headers.
159  $result = $this->onRequests( $firstReq['chain'], $idGeneratorFunc );
160  } else {
161  // If it failed, it is most efficient to just give failing
162  // pseudo-responses back for the actual work requests.
163  foreach ( $firstReq['chain'] as $key => $req ) {
164  $req['response'] = [
165  'code' => $this->authCachedStatus,
166  'reason' => $this->authCachedReason,
167  'headers' => [],
168  'body' => '',
169  'error' => ''
170  ];
171  $result[$key] = $req;
172  }
173  }
174  } else {
175  $result = $reqs; // no change
176  }
177  return $result;
178  }
179 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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
int $authSessionTimestamp
UNIX timestamp.
onRequests(array $reqs, Closure $idGeneratorFunc)
Virtual HTTP service instance that can be mounted on to a VirtualRESTService.
Example virtual rest service for OpenStack Swift.
int $authErrorTimestamp
UNIX timestamp.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
onResponses(array $reqs, Closure $idGeneratorFunc)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
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:35
this hook is for auditing only $req
Definition: hooks.txt:979
array $params
Key/value map.