MediaWiki  master
ImportStreamSource.php
Go to the documentation of this file.
1 <?php
27 
32 class ImportStreamSource implements ImportSource {
33  function __construct( $handle ) {
34  $this->mHandle = $handle;
35  }
36 
40  function atEnd() {
41  return feof( $this->mHandle );
42  }
43 
47  function readChunk() {
48  return fread( $this->mHandle, 32768 );
49  }
50 
55  static function newFromFile( $filename ) {
56  Wikimedia\suppressWarnings();
57  $file = fopen( $filename, 'rt' );
58  Wikimedia\restoreWarnings();
59  if ( !$file ) {
60  return Status::newFatal( "importcantopen" );
61  }
62  return Status::newGood( new ImportStreamSource( $file ) );
63  }
64 
69  static function newFromUpload( $fieldname = "xmlimport" ) {
70  $upload =& $_FILES[$fieldname];
71 
72  if ( $upload === null || !$upload['name'] ) {
73  return Status::newFatal( 'importnofile' );
74  }
75  if ( !empty( $upload['error'] ) ) {
76  switch ( $upload['error'] ) {
77  case UPLOAD_ERR_INI_SIZE:
78  // The uploaded file exceeds the upload_max_filesize directive in php.ini.
79  return Status::newFatal( 'importuploaderrorsize' );
80  case UPLOAD_ERR_FORM_SIZE:
81  // The uploaded file exceeds the MAX_FILE_SIZE directive that
82  // was specified in the HTML form.
83  // FIXME This is probably never used since that directive was removed in 8e91c520?
84  return Status::newFatal( 'importuploaderrorsize' );
85  case UPLOAD_ERR_PARTIAL:
86  // The uploaded file was only partially uploaded
87  return Status::newFatal( 'importuploaderrorpartial' );
88  case UPLOAD_ERR_NO_TMP_DIR:
89  // Missing a temporary folder.
90  return Status::newFatal( 'importuploaderrortemp' );
91  // Other error codes get the generic 'importnofile' error message below
92  }
93 
94  }
95  $fname = $upload['tmp_name'];
96  if ( is_uploaded_file( $fname ) ) {
97  return self::newFromFile( $fname );
98  } else {
99  return Status::newFatal( 'importnofile' );
100  }
101  }
102 
108  static function newFromURL( $url, $method = 'GET' ) {
109  global $wgHTTPImportTimeout;
110  wfDebug( __METHOD__ . ": opening $url\n" );
111  # Use the standard HTTP fetch function; it times out
112  # quicker and sorts out user-agent problems which might
113  # otherwise prevent importing from large sites, such
114  # as the Wikimedia cluster, etc.
115  $data = MediaWikiServices::getInstance()->getHttpRequestFactory()->request(
116  $method,
117  $url,
118  [
119  'followRedirects' => true,
120  'timeout' => $wgHTTPImportTimeout
121  ],
122  __METHOD__
123  );
124  if ( $data !== false ) {
125  $file = tmpfile();
126  fwrite( $file, $data );
127  fflush( $file );
128  fseek( $file, 0 );
129  return Status::newGood( new ImportStreamSource( $file ) );
130  } else {
131  return Status::newFatal( 'importcantopen' );
132  }
133  }
134 
143  public static function newFromInterwiki( $interwiki, $page, $history = false,
144  $templates = false, $pageLinkDepth = 0
145  ) {
146  if ( $page == '' ) {
147  return Status::newFatal( 'import-noarticle' );
148  }
149 
150  # Look up the first interwiki prefix, and let the foreign site handle
151  # subsequent interwiki prefixes
152  $firstIwPrefix = strtok( $interwiki, ':' );
153  $interwikiLookup = MediaWikiServices::getInstance()->getInterwikiLookup();
154  $firstIw = $interwikiLookup->fetch( $firstIwPrefix );
155  if ( !$firstIw ) {
156  return Status::newFatal( 'importbadinterwiki' );
157  }
158 
159  $additionalIwPrefixes = strtok( '' );
160  if ( $additionalIwPrefixes ) {
161  $additionalIwPrefixes .= ':';
162  }
163  # Have to do a DB-key replacement ourselves; otherwise spaces get
164  # URL-encoded to +, which is wrong in this case. Similar to logic in
165  # Title::getLocalURL
166  $link = $firstIw->getURL( strtr( "${additionalIwPrefixes}Special:Export/$page",
167  ' ', '_' ) );
168 
169  $params = [];
170  if ( $history ) {
171  $params['history'] = 1;
172  }
173  if ( $templates ) {
174  $params['templates'] = 1;
175  }
176  if ( $pageLinkDepth ) {
177  $params['pagelink-depth'] = $pageLinkDepth;
178  }
179 
180  $url = wfAppendQuery( $link, $params );
181  # For interwikis, use POST to avoid redirects.
182  return self::newFromURL( $url, "POST" );
183  }
184 }
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
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 MediaWikiServices
Definition: injection.txt:23
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3038
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$wgHTTPImportTimeout
Timeout for HTTP requests done internally for transwiki imports, in seconds.
static newFromUpload( $fieldname="xmlimport")
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$params
Imports a XML dump from a file (either from file upload, files on disk, or HTTP)
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:767
static newFromURL( $url, $method='GET')
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:131
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
Source interface for XML import.
static newFromInterwiki( $interwiki, $page, $history=false, $templates=false, $pageLinkDepth=0)
static newFromFile( $filename)