MediaWiki REL1_33
ApiImport.php
Go to the documentation of this file.
1<?php
28class ApiImport extends ApiBase {
29
30 public function execute() {
32
33 $user = $this->getUser();
35
36 $this->requireMaxOneParameter( $params, 'namespace', 'rootpage' );
37
38 $isUpload = false;
39 if ( isset( $params['interwikisource'] ) ) {
40 if ( !$user->isAllowed( 'import' ) ) {
41 $this->dieWithError( 'apierror-cantimport' );
42 }
43 if ( !isset( $params['interwikipage'] ) ) {
44 $this->dieWithError( [ 'apierror-missingparam', 'interwikipage' ] );
45 }
47 $params['interwikisource'],
48 $params['interwikipage'],
49 $params['fullhistory'],
50 $params['templates']
51 );
52 $usernamePrefix = $params['interwikisource'];
53 } else {
54 $isUpload = true;
55 if ( !$user->isAllowed( 'importupload' ) ) {
56 $this->dieWithError( 'apierror-cantimport-upload' );
57 }
59 $usernamePrefix = (string)$params['interwikiprefix'];
60 if ( $usernamePrefix === '' ) {
61 $encParamName = $this->encodeParamName( 'interwikiprefix' );
62 $this->dieWithError( [ 'apierror-missingparam', $encParamName ] );
63 }
64 }
65 if ( !$source->isOK() ) {
66 $this->dieStatus( $source );
67 }
68
69 // Check if user can add the log entry tags which were requested
70 if ( $params['tags'] ) {
72 if ( !$ableToTag->isOK() ) {
73 $this->dieStatus( $ableToTag );
74 }
75 }
76
77 $importer = new WikiImporter( $source->value, $this->getConfig() );
78 if ( isset( $params['namespace'] ) ) {
79 $importer->setTargetNamespace( $params['namespace'] );
80 } elseif ( isset( $params['rootpage'] ) ) {
81 $statusRootPage = $importer->setTargetRootPage( $params['rootpage'] );
82 if ( !$statusRootPage->isGood() ) {
83 $this->dieStatus( $statusRootPage );
84 }
85 }
86 $importer->setUsernamePrefix( $usernamePrefix, $params['assignknownusers'] );
87 $reporter = new ApiImportReporter(
88 $importer,
89 $isUpload,
90 $params['interwikisource'],
91 $params['summary']
92 );
93 if ( $params['tags'] ) {
94 $reporter->setChangeTags( $params['tags'] );
95 }
96
97 try {
98 $importer->doImport();
99 } catch ( Exception $e ) {
100 $this->dieWithException( $e, [ 'wrap' => 'apierror-import-unknownerror' ] );
101 }
102
103 $resultData = $reporter->getData();
104 $result = $this->getResult();
105 ApiResult::setIndexedTagName( $resultData, 'page' );
106 $result->addValue( null, $this->getModuleName(), $resultData );
107 }
108
116 public function getAllowedImportSources() {
117 $importSources = $this->getConfig()->get( 'ImportSources' );
118 Hooks::run( 'ImportSources', [ &$importSources ] );
119
120 $result = [];
121 foreach ( $importSources as $key => $value ) {
122 if ( is_int( $key ) ) {
123 $result[] = $value;
124 } else {
125 foreach ( $value as $subproject ) {
126 $result[] = "$key:$subproject";
127 }
128 }
129 }
130 return $result;
131 }
132
133 public function mustBePosted() {
134 return true;
135 }
136
137 public function isWriteMode() {
138 return true;
139 }
140
141 public function getAllowedParams() {
142 return [
143 'summary' => null,
144 'xml' => [
145 ApiBase::PARAM_TYPE => 'upload',
146 ],
147 'interwikiprefix' => [
148 ApiBase::PARAM_TYPE => 'string',
149 ],
150 'interwikisource' => [
152 ],
153 'interwikipage' => null,
154 'fullhistory' => false,
155 'templates' => false,
156 'namespace' => [
157 ApiBase::PARAM_TYPE => 'namespace'
158 ],
159 'assignknownusers' => false,
160 'rootpage' => null,
161 'tags' => [
162 ApiBase::PARAM_TYPE => 'tags',
164 ],
165 ];
166 }
167
168 public function needsToken() {
169 return 'csrf';
170 }
171
172 protected function getExamplesMessages() {
173 return [
174 'action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&' .
175 'namespace=100&fullhistory=&token=123ABC'
176 => 'apihelp-import-example-import',
177 ];
178 }
179
180 public function getHelpUrls() {
181 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Import';
182 }
183}
184
190 private $mResultArr = [];
191
200 public function reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo ) {
201 // Add a result entry
202 $r = [];
203
204 if ( $title === null ) {
205 # Invalid or non-importable title
206 $r['title'] = $pageInfo['title'];
207 $r['invalid'] = true;
208 } else {
210 $r['revisions'] = (int)$successCount;
211 }
212
213 $this->mResultArr[] = $r;
214
215 // Piggyback on the parent to do the logging
216 parent::reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo );
217 }
218
219 public function getData() {
220 return $this->mResultArr;
221 }
222}
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:37
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition ApiBase.php:721
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1990
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
getResult()
Get the result object.
Definition ApiBase.php:632
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:743
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:913
dieWithException( $exception, array $options=[])
Abort execution with an error derived from an exception.
Definition ApiBase.php:2002
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition ApiBase.php:2061
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition ApiBase.php:1847
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
Import reporter for the API.
reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo)
API module that imports an XML file like Special:Import does.
Definition ApiImport.php:28
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition ApiImport.php:30
needsToken()
Returns the token type this module requires in order to execute.
isWriteMode()
Indicates whether this module requires write mode.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
mustBePosted()
Indicates whether this module must be called with a POST request.
getAllowedImportSources()
Returns a list of interwiki prefixes corresponding to each defined import source.
getExamplesMessages()
Returns usage examples for this module.
getHelpUrls()
Return links to more detailed help pages about the module.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
static canAddTagsAccompanyingChange(array $tags, User $user=null)
Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the cha...
Reporting callback.
static newFromInterwiki( $interwiki, $page, $history=false, $templates=false, $pageLinkDepth=0)
static newFromUpload( $fieldname="xmlimport")
XML file reader for the page data importer.
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
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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:1991
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition hooks.txt:181
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:955
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
returning false will NOT prevent logging $e
Definition hooks.txt:2175
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
$source
$params