MediaWiki  1.28.0
CopyFileOp.php
Go to the documentation of this file.
1 <?php
29 class CopyFileOp extends FileOp {
30  protected function allowedParams() {
31  return [
32  [ 'src', 'dst' ],
33  [ 'overwrite', 'overwriteSame', 'ignoreMissingSource', 'headers' ],
34  [ 'src', 'dst' ]
35  ];
36  }
37 
38  protected function doPrecheck( array &$predicates ) {
40  // Check if the source file exists
41  if ( !$this->fileExists( $this->params['src'], $predicates ) ) {
42  if ( $this->getParam( 'ignoreMissingSource' ) ) {
43  $this->doOperation = false; // no-op
44  // Update file existence predicates (cache 404s)
45  $predicates['exists'][$this->params['src']] = false;
46  $predicates['sha1'][$this->params['src']] = false;
47 
48  return $status; // nothing to do
49  } else {
50  $status->fatal( 'backend-fail-notexists', $this->params['src'] );
51 
52  return $status;
53  }
54  // Check if a file can be placed/changed at the destination
55  } elseif ( !$this->backend->isPathUsableInternal( $this->params['dst'] ) ) {
56  $status->fatal( 'backend-fail-usable', $this->params['dst'] );
57  $status->fatal( 'backend-fail-copy', $this->params['src'], $this->params['dst'] );
58 
59  return $status;
60  }
61  // Check if destination file exists
62  $status->merge( $this->precheckDestExistence( $predicates ) );
63  $this->params['dstExists'] = $this->destExists; // see FileBackendStore::setFileCache()
64  if ( $status->isOK() ) {
65  // Update file existence predicates
66  $predicates['exists'][$this->params['dst']] = true;
67  $predicates['sha1'][$this->params['dst']] = $this->sourceSha1;
68  }
69 
70  return $status; // safe to call attempt()
71  }
72 
73  protected function doAttempt() {
74  if ( $this->overwriteSameCase ) {
75  $status = StatusValue::newGood(); // nothing to do
76  } elseif ( $this->params['src'] === $this->params['dst'] ) {
77  // Just update the destination file headers
78  $headers = $this->getParam( 'headers' ) ?: [];
79  $status = $this->backend->describeInternal( $this->setFlags( [
80  'src' => $this->params['dst'], 'headers' => $headers
81  ] ) );
82  } else {
83  // Copy the file to the destination
84  $status = $this->backend->copyInternal( $this->setFlags( $this->params ) );
85  }
86 
87  return $status;
88  }
89 
90  public function storagePathsRead() {
91  return [ $this->params['src'] ];
92  }
93 
94  public function storagePathsChanged() {
95  return [ $this->params['dst'] ];
96  }
97 }
the array() calling protocol came about after MediaWiki 1.4rc1.
storagePathsRead()
Definition: CopyFileOp.php:90
FileBackend helper class for representing operations.
Definition: FileOp.php:37
storagePathsChanged()
Definition: CopyFileOp.php:94
getParam($name)
Get the value of the parameter with the given name.
Definition: FileOp.php:140
Copy a file from one storage path to another in the backend.
Definition: CopyFileOp.php:29
setFlags(array $params)
Adjust params to FileBackendStore internal file calls.
Definition: FileOp.php:335
precheckDestExistence(array $predicates)
Check for errors with regards to the destination file already existing.
Definition: FileOp.php:365
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
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
bool $destExists
Definition: FileOp.php:68
fileExists($source, array $predicates)
Check if a file will exist in storage when this operation is attempted.
Definition: FileOp.php:417
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
string $sourceSha1
Definition: FileOp.php:62
doPrecheck(array &$predicates)
Definition: CopyFileOp.php:38