dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
* remove end of line whitespace
[lhc/web/wiklou.git] / includes / filerepo / LocalFile.php
1 <?php
2 /**
3 */
4
5 /**
6 * Bump this number when serialized cache records may be incompatible.
7 */
8 define( 'MW_FILE_VERSION', 7 );
9
10 /**
11 * Class to represent a local file in the wiki's own database
12 *
13 * Provides methods to retrieve paths (physical, logical, URL),
14 * to generate image thumbnails or for uploading.
15 *
16 * Note that only the repo object knows what its file class is called. You should
17 * never name a file class explictly outside of the repo class. Instead use the
18 * repo's factory functions to generate file objects, for example:
19 *
20 * RepoGroup::singleton()->getLocalRepo()->newFile($title);
21 *
22 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
23 * in most cases.
24 *
25 * @addtogroup FileRepo
26 */
27 class LocalFile extends File
28 {
29 /**#@+
30 * @private
31 */
32 var $fileExists, # does the file file exist on disk? (loadFromXxx)
33 $historyLine, # Number of line to return by nextHistoryLine() (constructor)
34 $historyRes, # result of the query for the file's history (nextHistoryLine)
35 $width, # \
36 $height, # |
37 $bits, # --- returned by getimagesize (loadFromXxx)
38 $attr, # /
39 $media_type, # MEDIATYPE_xxx (bitmap, drawing, audio...)
40 $mime, # MIME type, determined by MimeMagic::guessMimeType
41 $major_mime, # Major mime type
42 $minor_mime, # Minor mime type
43 $size, # Size in bytes (loadFromXxx)
44 $metadata, # Handler-specific metadata
45 $timestamp, # Upload timestamp
46 $sha1, # SHA-1 base 36 content hash
47 $user, $user_text, # User, who uploaded the file
48 $description, # Description of current revision of the file
49 $dataLoaded, # Whether or not all this has been loaded from the database (loadFromXxx)
50 $upgraded, # Whether the row was upgraded on load
51 $locked, # True if the image row is locked
52 $deleted; # Bitfield akin to rev_deleted
53
54 /**#@-*/
55
56 /**
57 * Create a LocalFile from a title
58 * Do not call this except from inside a repo class.
59 *
60 * Note: $unused param is only here to avoid an E_STRICT
61 */
62 static function newFromTitle( $title, $repo, $unused = null ) {
63 return new self( $title, $repo );
64 }
65
66 /**
67 * Create a LocalFile from a title
68 * Do not call this except from inside a repo class.
69 */
70 static function newFromRow( $row, $repo ) {
71 $title = Title::makeTitle( NS_IMAGE, $row->img_name );
72 $file = new self( $title, $repo );
73 $file->loadFromRow( $row );
74 return $file;
75 }
76
77 /**
78 * Constructor.
79 * Do not call this except from inside a repo class.
80 */
81 function __construct( $title, $repo ) {
82 if( !is_object( $title ) ) {
83 throw new MWException( __CLASS__.' constructor given bogus title.' );
84 }
85 parent::__construct( $title, $repo );
86 $this->metadata = '';
87 $this->historyLine = 0;
88 $this->historyRes = null;
89 $this->dataLoaded = false;
90 }
91
92 /**
93 * Get the memcached key
94 */
95 function getCacheKey() {
96 $hashedName = md5($this->getName());
97 return wfMemcKey( 'file', $hashedName );
98 }
99
100 /**
101 * Try to load file metadata from memcached. Returns true on success.
102 */
103 function loadFromCache() {
104 global $wgMemc;
105 wfProfileIn( __METHOD__ );
106 $this->dataLoaded = false;
107 $key = $this->getCacheKey();
108 if ( !$key ) {
109 return false;
110 }
111 $cachedValues = $wgMemc->get( $key );
112
113 // Check if the key existed and belongs to this version of MediaWiki
114 if ( isset($cachedValues['version']) && ( $cachedValues['version'] == MW_FILE_VERSION ) ) {
115 wfDebug( "Pulling file metadata from cache key $key\n" );
116 $this->fileExists = $cachedValues['fileExists'];
117 if ( $this->fileExists ) {
118 $this->setProps( $cachedValues );
119 }
120 $this->dataLoaded = true;
121 }
122 if ( $this->dataLoaded ) {
123 wfIncrStats( 'image_cache_hit' );
124 } else {
125 wfIncrStats( 'image_cache_miss' );
126 }
127
128 wfProfileOut( __METHOD__ );
129 return $this->dataLoaded;
130 }
131
132 /**
133 * Save the file metadata to memcached
134 */
135 function saveToCache() {
136 global $wgMemc;
137 $this->load();
138 $key = $this->getCacheKey();
139 if ( !$key ) {
140 return;
141 }
142 $fields = $this->getCacheFields( '' );
143 $cache = array( 'version' => MW_FILE_VERSION );
144 $cache['fileExists'] = $this->fileExists;
145 if ( $this->fileExists ) {
146 foreach ( $fields as $field ) {
147 $cache[$field] = $this->$field;
148 }
149 }
150
151 $wgMemc->set( $key, $cache, 60 * 60 * 24 * 7 ); // A week
152 }
153
154 /**
155 * Load metadata from the file itself
156 */
157 function loadFromFile() {
158 $this->setProps( self::getPropsFromPath( $this->getPath() ) );
159 }
160
161 function getCacheFields( $prefix = 'img_' ) {
162 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
163 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
164 static $results = array();
165 if ( $prefix == '' ) {
166 return $fields;
167 }
168 if ( !isset( $results[$prefix] ) ) {
169 $prefixedFields = array();
170 foreach ( $fields as $field ) {
171 $prefixedFields[] = $prefix . $field;
172 }
173 $results[$prefix] = $prefixedFields;
174 }
175 return $results[$prefix];
176 }
177
178 /**
179 * Load file metadata from the DB
180 */
181 function loadFromDB() {
182 # Polymorphic function name to distinguish foreign and local fetches
183 $fname = get_class( $this ) . '::' . __FUNCTION__;
184 wfProfileIn( $fname );
185
186 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
187 $this->dataLoaded = true;
188
189 $dbr = $this->repo->getMasterDB();
190
191 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
192 array( 'img_name' => $this->getName() ), $fname );
193 if ( $row ) {
194 $this->loadFromRow( $row );
195 } else {
196 $this->fileExists = false;
197 }
198
199 wfProfileOut( $fname );
200 }
201
202 /**
203 * Decode a row from the database (either object or array) to an array
204 * with timestamps and MIME types decoded, and the field prefix removed.
205 */
206 function decodeRow( $row, $prefix = 'img_' ) {
207 $array = (array)$row;
208 $prefixLength = strlen( $prefix );
209 // Sanity check prefix once
210 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
211 throw new MWException( __METHOD__. ': incorrect $prefix parameter' );
212 }
213 $decoded = array();
214 foreach ( $array as $name => $value ) {
215 $decoded[substr( $name, $prefixLength )] = $value;
216 }
217 $decoded['timestamp'] = wfTimestamp( TS_MW, $decoded['timestamp'] );
218 if ( empty( $decoded['major_mime'] ) ) {
219 $decoded['mime'] = "unknown/unknown";
220 } else {
221 if (!$decoded['minor_mime']) {
222 $decoded['minor_mime'] = "unknown";
223 }
224 $decoded['mime'] = $decoded['major_mime'].'/'.$decoded['minor_mime'];
225 }
226 # Trim zero padding from char/binary field
227 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
228 return $decoded;
229 }
230
231 /*
232 * Load file metadata from a DB result row
233 */
234 function loadFromRow( $row, $prefix = 'img_' ) {
235 $this->dataLoaded = true;
236 $array = $this->decodeRow( $row, $prefix );
237 foreach ( $array as $name => $value ) {
238 $this->$name = $value;
239 }
240 $this->fileExists = true;
241 $this->maybeUpgradeRow();
242 }
243
244 /**
245 * Load file metadata from cache or DB, unless already loaded
246 */
247 function load() {
248 if ( !$this->dataLoaded ) {
249 if ( !$this->loadFromCache() ) {
250 $this->loadFromDB();
251 $this->saveToCache();
252 }
253 $this->dataLoaded = true;
254 }
255 }
256
257 /**
258 * Upgrade a row if it needs it
259 */
260 function maybeUpgradeRow() {
261 if ( wfReadOnly() ) {
262 return;
263 }
264 if ( is_null($this->media_type) ||
265 $this->mime == 'image/svg'
266 ) {
267 $this->upgradeRow();
268 $this->upgraded = true;
269 } else {
270 $handler = $this->getHandler();
271 if ( $handler && !$handler->isMetadataValid( $this, $this->metadata ) ) {
272 $this->upgradeRow();
273 $this->upgraded = true;
274 }
275 }
276 }
277
278 function getUpgraded() {
279 return $this->upgraded;
280 }
281
282 /**
283 * Fix assorted version-related problems with the image row by reloading it from the file
284 */
285 function upgradeRow() {
286 wfProfileIn( __METHOD__ );
287
288 $this->loadFromFile();
289
290 # Don't destroy file info of missing files
291 if ( !$this->fileExists ) {
292 wfDebug( __METHOD__.": file does not exist, aborting\n" );
293 return;
294 }
295 $dbw = $this->repo->getMasterDB();
296 list( $major, $minor ) = self::splitMime( $this->mime );
297
298 if ( wfReadOnly() ) {
299 return;
300 }
301 wfDebug(__METHOD__.': upgrading '.$this->getName()." to the current schema\n");
302
303 $dbw->update( 'image',
304 array(
305 'img_width' => $this->width,
306 'img_height' => $this->height,
307 'img_bits' => $this->bits,
308 'img_media_type' => $this->media_type,
309 'img_major_mime' => $major,
310 'img_minor_mime' => $minor,
311 'img_metadata' => $this->metadata,
312 'img_sha1' => $this->sha1,
313 ), array( 'img_name' => $this->getName() ),
314 __METHOD__
315 );
316 $this->saveToCache();
317 wfProfileOut( __METHOD__ );
318 }
319
320 /**
321 * Set properties in this object to be equal to those given in the
322 * associative array $info. Only cacheable fields can be set.
323 *
324 * If 'mime' is given, it will be split into major_mime/minor_mime.
325 * If major_mime/minor_mime are given, $this->mime will also be set.
326 */
327 function setProps( $info ) {
328 $this->dataLoaded = true;
329 $fields = $this->getCacheFields( '' );
330 $fields[] = 'fileExists';
331 foreach ( $fields as $field ) {
332 if ( isset( $info[$field] ) ) {
333 $this->$field = $info[$field];
334 }
335 }
336 // Fix up mime fields
337 if ( isset( $info['major_mime'] ) ) {
338 $this->mime = "{$info['major_mime']}/{$info['minor_mime']}";
339 } elseif ( isset( $info['mime'] ) ) {
340 list( $this->major_mime, $this->minor_mime ) = self::splitMime( $this->mime );
341 }
342 }
343
344 /** splitMime inherited */
345 /** getName inherited */
346 /** getTitle inherited */
347 /** getURL inherited */
348 /** getViewURL inherited */
349 /** getPath inherited */
350 /** isVisible inhereted */
351
352 /**
353 * Return the width of the image
354 *
355 * Returns false on error
356 * @public
357 */
358 function getWidth( $page = 1 ) {
359 $this->load();
360 if ( $this->isMultipage() ) {
361 $dim = $this->getHandler()->getPageDimensions( $this, $page );
362 if ( $dim ) {
363 return $dim['width'];
364 } else {
365 return false;
366 }
367 } else {
368 return $this->width;
369 }
370 }
371
372 /**
373 * Return the height of the image
374 *
375 * Returns false on error
376 * @public
377 */
378 function getHeight( $page = 1 ) {
379 $this->load();
380 if ( $this->isMultipage() ) {
381 $dim = $this->getHandler()->getPageDimensions( $this, $page );
382 if ( $dim ) {
383 return $dim['height'];
384 } else {
385 return false;
386 }
387 } else {
388 return $this->height;
389 }
390 }
391
392 /**
393 * Returns ID or name of user who uploaded the file
394 *
395 * @param $type string 'text' or 'id'
396 */
397 function getUser($type='text') {
398 $this->load();
399 if( $type == 'text' ) {
400 return $this->user_text;
401 } elseif( $type == 'id' ) {
402 return $this->user;
403 }
404 }
405
406 /**
407 * Get handler-specific metadata
408 */
409 function getMetadata() {
410 $this->load();
411 return $this->metadata;
412 }
413
414 /**
415 * Return the size of the image file, in bytes
416 * @public
417 */
418 function getSize() {
419 $this->load();
420 return $this->size;
421 }
422
423 /**
424 * Returns the mime type of the file.
425 */
426 function getMimeType() {
427 $this->load();
428 return $this->mime;
429 }
430
431 /**
432 * Return the type of the media in the file.
433 * Use the value returned by this function with the MEDIATYPE_xxx constants.
434 */
435 function getMediaType() {
436 $this->load();
437 return $this->media_type;
438 }
439
440 /** canRender inherited */
441 /** mustRender inherited */
442 /** allowInlineDisplay inherited */
443 /** isSafeFile inherited */
444 /** isTrustedFile inherited */
445
446 /**
447 * Returns true if the file file exists on disk.
448 * @return boolean Whether file file exist on disk.
449 * @public
450 */
451 function exists() {
452 $this->load();
453 return $this->fileExists;
454 }
455
456 /** getTransformScript inherited */
457 /** getUnscaledThumb inherited */
458 /** thumbName inherited */
459 /** createThumb inherited */
460 /** getThumbnail inherited */
461 /** transform inherited */
462
463 /**
464 * Fix thumbnail files from 1.4 or before, with extreme prejudice
465 */
466 function migrateThumbFile( $thumbName ) {
467 $thumbDir = $this->getThumbPath();
468 $thumbPath = "$thumbDir/$thumbName";
469 if ( is_dir( $thumbPath ) ) {
470 // Directory where file should be
471 // This happened occasionally due to broken migration code in 1.5
472 // Rename to broken-*
473 for ( $i = 0; $i < 100 ; $i++ ) {
474 $broken = $this->repo->getZonePath('public') . "/broken-$i-$thumbName";
475 if ( !file_exists( $broken ) ) {
476 rename( $thumbPath, $broken );
477 break;
478 }
479 }
480 // Doesn't exist anymore
481 clearstatcache();
482 }
483 if ( is_file( $thumbDir ) ) {
484 // File where directory should be
485 unlink( $thumbDir );
486 // Doesn't exist anymore
487 clearstatcache();
488 }
489 }
490
491 /** getHandler inherited */
492 /** iconThumb inherited */
493 /** getLastError inherited */
494
495 /**
496 * Get all thumbnail names previously generated for this file
497 */
498 function getThumbnails() {
499 if ( $this->isHashed() ) {
500 $this->load();
501 $files = array();
502 $dir = $this->getThumbPath();
503
504 if ( is_dir( $dir ) ) {
505 $handle = opendir( $dir );
506
507 if ( $handle ) {
508 while ( false !== ( $file = readdir($handle) ) ) {
509 if ( $file{0} != '.' ) {
510 $files[] = $file;
511 }
512 }
513 closedir( $handle );
514 }
515 }
516 } else {
517 $files = array();
518 }
519
520 return $files;
521 }
522
523 /**
524 * Refresh metadata in memcached, but don't touch thumbnails or squid
525 */
526 function purgeMetadataCache() {
527 $this->loadFromDB();
528 $this->saveToCache();
529 $this->purgeHistory();
530 }
531
532 /**
533 * Purge the shared history (OldLocalFile) cache
534 */
535 function purgeHistory() {
536 global $wgMemc;
537 $hashedName = md5($this->getName());
538 $oldKey = wfMemcKey( 'oldfile', $hashedName );
539 $wgMemc->delete( $oldKey );
540 }
541
542 /**
543 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
544 */
545 function purgeCache() {
546 // Refresh metadata cache
547 $this->purgeMetadataCache();
548
549 // Delete thumbnails
550 $this->purgeThumbnails();
551
552 // Purge squid cache for this file
553 SquidUpdate::purge( array( $this->getURL() ) );
554 }
555
556 /**
557 * Delete cached transformed files
558 */
559 function purgeThumbnails() {
560 global $wgUseSquid;
561 // Delete thumbnails
562 $files = $this->getThumbnails();
563 $dir = $this->getThumbPath();
564 $urls = array();
565 foreach ( $files as $file ) {
566 # Check that the base file name is part of the thumb name
567 # This is a basic sanity check to avoid erasing unrelated directories
568 if ( strpos( $file, $this->getName() ) !== false ) {
569 $url = $this->getThumbUrl( $file );
570 $urls[] = $url;
571 @unlink( "$dir/$file" );
572 }
573 }
574
575 // Purge the squid
576 if ( $wgUseSquid ) {
577 SquidUpdate::purge( $urls );
578 }
579 }
580
581 /** purgeDescription inherited */
582 /** purgeEverything inherited */
583
584 function getHistory($limit = null, $start = null, $end = null) {
585 $dbr = $this->repo->getSlaveDB();
586 $conds = $opts = array();
587 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBKey() );
588 if( $start !== null ) {
589 $conds[] = "oi_timestamp <= " . $dbr->addQuotes( $dbr->timestamp( $start ) );
590 }
591 if( $end !== null ) {
592 $conds[] = "oi_timestamp >= " . $dbr->addQuotes( $dbr->timestamp( $end ) );
593 }
594 if( $limit ) {
595 $opts['LIMIT'] = $limit;
596 }
597 $opts['ORDER BY'] = 'oi_timestamp DESC';
598 $res = $dbr->select('oldimage', '*', $conds, __METHOD__, $opts);
599 $r = array();
600 while( $row = $dbr->fetchObject($res) ) {
601 $r[] = OldLocalFile::newFromRow($row, $this->repo);
602 }
603 return $r;
604 }
605
606 /**
607 * Return the history of this file, line by line.
608 * starts with current version, then old versions.
609 * uses $this->historyLine to check which line to return:
610 * 0 return line for current version
611 * 1 query for old versions, return first one
612 * 2, ... return next old version from above query
613 *
614 * @public
615 */
616 function nextHistoryLine() {
617 # Polymorphic function name to distinguish foreign and local fetches
618 $fname = get_class( $this ) . '::' . __FUNCTION__;
619
620 $dbr = $this->repo->getSlaveDB();
621
622 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
623 $this->historyRes = $dbr->select( 'image',
624 array(
625 '*',
626 "'' AS oi_archive_name",
627 '0 as oi_deleted',
628 'img_sha1'
629 ),
630 array( 'img_name' => $this->title->getDBkey() ),
631 $fname
632 );
633 if ( 0 == $dbr->numRows( $this->historyRes ) ) {
634 $dbr->freeResult($this->historyRes);
635 $this->historyRes = null;
636 return FALSE;
637 }
638 } else if ( $this->historyLine == 1 ) {
639 $dbr->freeResult($this->historyRes);
640 $this->historyRes = $dbr->select( 'oldimage', '*',
641 array( 'oi_name' => $this->title->getDBkey() ),
642 $fname,
643 array( 'ORDER BY' => 'oi_timestamp DESC' )
644 );
645 }
646 $this->historyLine ++;
647
648 return $dbr->fetchObject( $this->historyRes );
649 }
650
651 /**
652 * Reset the history pointer to the first element of the history
653 * @public
654 */
655 function resetHistory() {
656 $this->historyLine = 0;
657 if (!is_null($this->historyRes)) {
658 $this->repo->getSlaveDB()->freeResult($this->historyRes);
659 $this->historyRes = null;
660 }
661 }
662
663 /** getFullPath inherited */
664 /** getHashPath inherited */
665 /** getRel inherited */
666 /** getUrlRel inherited */
667 /** getArchiveRel inherited */
668 /** getThumbRel inherited */
669 /** getArchivePath inherited */
670 /** getThumbPath inherited */
671 /** getArchiveUrl inherited */
672 /** getThumbUrl inherited */
673 /** getArchiveVirtualUrl inherited */
674 /** getThumbVirtualUrl inherited */
675 /** isHashed inherited */
676
677 /**
678 * Upload a file and record it in the DB
679 * @param string $srcPath Source path or virtual URL
680 * @param string $comment Upload description
681 * @param string $pageText Text to use for the new description page, if a new description page is created
682 * @param integer $flags Flags for publish()
683 * @param array $props File properties, if known. This can be used to reduce the
684 * upload time when uploading virtual URLs for which the file info
685 * is already known
686 * @param string $timestamp Timestamp for img_timestamp, or false to use the current time
687 *
688 * @return FileRepoStatus object. On success, the value member contains the
689 * archive name, or an empty string if it was a new file.
690 */
691 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false ) {
692 $this->lock();
693 $status = $this->publish( $srcPath, $flags );
694 if ( $status->ok ) {
695 if ( !$this->recordUpload2( $status->value, $comment, $pageText, $props, $timestamp ) ) {
696 $status->fatal( 'filenotfound', $srcPath );
697 }
698 }
699 $this->unlock();
700 return $status;
701 }
702
703 /**
704 * Record a file upload in the upload log and the image table
705 * @deprecated use upload()
706 */
707 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
708 $watch = false, $timestamp = false )
709 {
710 $pageText = UploadForm::getInitialPageText( $desc, $license, $copyStatus, $source );
711 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
712 return false;
713 }
714 if ( $watch ) {
715 global $wgUser;
716 $wgUser->addWatch( $this->getTitle() );
717 }
718 return true;
719
720 }
721
722 /**
723 * Record a file upload in the upload log and the image table
724 */
725 function recordUpload2( $oldver, $comment, $pageText, $props = false, $timestamp = false )
726 {
727 global $wgUser;
728
729 $dbw = $this->repo->getMasterDB();
730
731 if ( !$props ) {
732 $props = $this->repo->getFileProps( $this->getVirtualUrl() );
733 }
734 $props['description'] = $comment;
735 $props['user'] = $wgUser->getID();
736 $props['user_text'] = $wgUser->getName();
737 $props['timestamp'] = wfTimestamp( TS_MW );
738 $this->setProps( $props );
739
740 // Delete thumbnails and refresh the metadata cache
741 $this->purgeThumbnails();
742 $this->saveToCache();
743 SquidUpdate::purge( array( $this->getURL() ) );
744
745 // Fail now if the file isn't there
746 if ( !$this->fileExists ) {
747 wfDebug( __METHOD__.": File ".$this->getPath()." went missing!\n" );
748 return false;
749 }
750
751 $reupload = false;
752 if ( $timestamp === false ) {
753 $timestamp = $dbw->timestamp();
754 }
755
756 # Test to see if the row exists using INSERT IGNORE
757 # This avoids race conditions by locking the row until the commit, and also
758 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
759 $dbw->insert( 'image',
760 array(
761 'img_name' => $this->getName(),
762 'img_size'=> $this->size,
763 'img_width' => intval( $this->width ),
764 'img_height' => intval( $this->height ),
765 'img_bits' => $this->bits,
766 'img_media_type' => $this->media_type,
767 'img_major_mime' => $this->major_mime,
768 'img_minor_mime' => $this->minor_mime,
769 'img_timestamp' => $timestamp,
770 'img_description' => $comment,
771 'img_user' => $wgUser->getID(),
772 'img_user_text' => $wgUser->getName(),
773 'img_metadata' => $this->metadata,
774 'img_sha1' => $this->sha1
775 ),
776 __METHOD__,
777 'IGNORE'
778 );
779
780 if( $dbw->affectedRows() == 0 ) {
781 $reupload = true;
782
783 # Collision, this is an update of a file
784 # Insert previous contents into oldimage
785 $dbw->insertSelect( 'oldimage', 'image',
786 array(
787 'oi_name' => 'img_name',
788 'oi_archive_name' => $dbw->addQuotes( $oldver ),
789 'oi_size' => 'img_size',
790 'oi_width' => 'img_width',
791 'oi_height' => 'img_height',
792 'oi_bits' => 'img_bits',
793 'oi_timestamp' => 'img_timestamp',
794 'oi_description' => 'img_description',
795 'oi_user' => 'img_user',
796 'oi_user_text' => 'img_user_text',
797 'oi_metadata' => 'img_metadata',
798 'oi_media_type' => 'img_media_type',
799 'oi_major_mime' => 'img_major_mime',
800 'oi_minor_mime' => 'img_minor_mime',
801 'oi_sha1' => 'img_sha1'
802 ), array( 'img_name' => $this->getName() ), __METHOD__
803 );
804
805 # Update the current image row
806 $dbw->update( 'image',
807 array( /* SET */
808 'img_size' => $this->size,
809 'img_width' => intval( $this->width ),
810 'img_height' => intval( $this->height ),
811 'img_bits' => $this->bits,
812 'img_media_type' => $this->media_type,
813 'img_major_mime' => $this->major_mime,
814 'img_minor_mime' => $this->minor_mime,
815 'img_timestamp' => $timestamp,
816 'img_description' => $comment,
817 'img_user' => $wgUser->getID(),
818 'img_user_text' => $wgUser->getName(),
819 'img_metadata' => $this->metadata,
820 'img_sha1' => $this->sha1
821 ), array( /* WHERE */
822 'img_name' => $this->getName()
823 ), __METHOD__
824 );
825 } else {
826 # This is a new file
827 # Update the image count
828 $site_stats = $dbw->tableName( 'site_stats' );
829 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__ );
830 }
831
832 $descTitle = $this->getTitle();
833 $article = new Article( $descTitle );
834
835 # Add the log entry
836 $log = new LogPage( 'upload' );
837 $action = $reupload ? 'overwrite' : 'upload';
838 $log->addEntry( $action, $descTitle, $comment );
839
840 if( $descTitle->exists() ) {
841 # Create a null revision
842 $nullRevision = Revision::newNullRevision( $dbw, $descTitle->getArticleId(), $log->getRcComment(), false );
843 $nullRevision->insertOn( $dbw );
844 $article->updateRevisionOn( $dbw, $nullRevision );
845
846 # Invalidate the cache for the description page
847 $descTitle->invalidateCache();
848 $descTitle->purgeSquid();
849 } else {
850 // New file; create the description page.
851 // There's already a log entry, so don't make a second RC entry
852 $article->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC );
853 }
854
855 # Hooks, hooks, the magic of hooks...
856 wfRunHooks( 'FileUpload', array( $this ) );
857
858 # Commit the transaction now, in case something goes wrong later
859 # The most important thing is that files don't get lost, especially archives
860 $dbw->immediateCommit();
861
862 # Invalidate cache for all pages using this file
863 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
864 $update->doUpdate();
865 # Invalidate cache for all pages that redirects on this page
866 $redirs = $this->getTitle()->getRedirectsHere();
867 foreach( $redirs as $redir ) {
868 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
869 $update->doUpdate();
870 }
871
872 return true;
873 }
874
875 /**
876 * Move or copy a file to its public location. If a file exists at the
877 * destination, move it to an archive. Returns the archive name on success
878 * or an empty string if it was a new file, and a wikitext-formatted
879 * WikiError object on failure.
880 *
881 * The archive name should be passed through to recordUpload for database
882 * registration.
883 *
884 * @param string $sourcePath Local filesystem path to the source image
885 * @param integer $flags A bitwise combination of:
886 * File::DELETE_SOURCE Delete the source file, i.e. move
887 * rather than copy
888 * @return FileRepoStatus object. On success, the value member contains the
889 * archive name, or an empty string if it was a new file.
890 */
891 function publish( $srcPath, $flags = 0 ) {
892 $this->lock();
893 $dstRel = $this->getRel();
894 $archiveName = gmdate( 'YmdHis' ) . '!'. $this->getName();
895 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
896 $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
897 $status = $this->repo->publish( $srcPath, $dstRel, $archiveRel, $flags );
898 if ( $status->value == 'new' ) {
899 $status->value = '';
900 } else {
901 $status->value = $archiveName;
902 }
903 $this->unlock();
904 return $status;
905 }
906
907 /** getLinksTo inherited */
908 /** getExifData inherited */
909 /** isLocal inherited */
910 /** wasDeleted inherited */
911
912 /**
913 * Delete all versions of the file.
914 *
915 * Moves the files into an archive directory (or deletes them)
916 * and removes the database rows.
917 *
918 * Cache purging is done; logging is caller's responsibility.
919 *
920 * @param $reason
921 * @param $suppress
922 * @return FileRepoStatus object.
923 */
924 function delete( $reason, $suppress = false ) {
925 $this->lock();
926 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
927 $batch->addCurrent();
928
929 # Get old version relative paths
930 $dbw = $this->repo->getMasterDB();
931 $result = $dbw->select( 'oldimage',
932 array( 'oi_archive_name' ),
933 array( 'oi_name' => $this->getName() ) );
934 while ( $row = $dbw->fetchObject( $result ) ) {
935 $batch->addOld( $row->oi_archive_name );
936 }
937 $status = $batch->execute();
938
939 if ( $status->ok ) {
940 // Update site_stats
941 $site_stats = $dbw->tableName( 'site_stats' );
942 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__ );
943 $this->purgeEverything();
944 }
945
946 $this->unlock();
947 return $status;
948 }
949
950 /**
951 * Delete an old version of the file.
952 *
953 * Moves the file into an archive directory (or deletes it)
954 * and removes the database row.
955 *
956 * Cache purging is done; logging is caller's responsibility.
957 *
958 * @param $reason
959 * @param $suppress
960 * @throws MWException or FSException on database or filestore failure
961 * @return FileRepoStatus object.
962 */
963 function deleteOld( $archiveName, $reason, $suppress=false ) {
964 $this->lock();
965 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
966 $batch->addOld( $archiveName );
967 $status = $batch->execute();
968 $this->unlock();
969 if ( $status->ok ) {
970 $this->purgeDescription();
971 $this->purgeHistory();
972 }
973 return $status;
974 }
975
976 /**
977 * Restore all or specified deleted revisions to the given file.
978 * Permissions and logging are left to the caller.
979 *
980 * May throw database exceptions on error.
981 *
982 * @param $versions set of record ids of deleted items to restore,
983 * or empty to restore all revisions.
984 * @param $unuppress
985 * @return FileRepoStatus
986 */
987 function restore( $versions = array(), $unsuppress = false ) {
988 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
989 if ( !$versions ) {
990 $batch->addAll();
991 } else {
992 $batch->addIds( $versions );
993 }
994 $status = $batch->execute();
995 if ( !$status->ok ) {
996 return $status;
997 }
998
999 $cleanupStatus = $batch->cleanup();
1000 $cleanupStatus->successCount = 0;
1001 $cleanupStatus->failCount = 0;
1002 $status->merge( $cleanupStatus );
1003 return $status;
1004 }
1005
1006 /** isMultipage inherited */
1007 /** pageCount inherited */
1008 /** scaleHeight inherited */
1009 /** getImageSize inherited */
1010
1011 /**
1012 * Get the URL of the file description page.
1013 */
1014 function getDescriptionUrl() {
1015 return $this->title->getLocalUrl();
1016 }
1017
1018 /**
1019 * Get the HTML text of the description page
1020 * This is not used by ImagePage for local files, since (among other things)
1021 * it skips the parser cache.
1022 */
1023 function getDescriptionText() {
1024 global $wgParser;
1025 $revision = Revision::newFromTitle( $this->title );
1026 if ( !$revision ) return false;
1027 $text = $revision->getText();
1028 if ( !$text ) return false;
1029 $html = $wgParser->parse( $text, new ParserOptions );
1030 return $html;
1031 }
1032
1033 function getDescription() {
1034 $this->load();
1035 return $this->description;
1036 }
1037
1038 function getTimestamp() {
1039 $this->load();
1040 return $this->timestamp;
1041 }
1042
1043 function getSha1() {
1044 $this->load();
1045 // Initialise now if necessary
1046 if ( $this->sha1 == '' && $this->fileExists ) {
1047 $this->sha1 = File::sha1Base36( $this->getPath() );
1048 if ( strval( $this->sha1 ) != '' ) {
1049 $dbw = $this->repo->getMasterDB();
1050 $dbw->update( 'image',
1051 array( 'img_sha1' => $this->sha1 ),
1052 array( 'img_name' => $this->getName() ),
1053 __METHOD__ );
1054 $this->saveToCache();
1055 }
1056 }
1057
1058 return $this->sha1;
1059 }
1060
1061 /**
1062 * Start a transaction and lock the image for update
1063 * Increments a reference counter if the lock is already held
1064 * @return boolean True if the image exists, false otherwise
1065 */
1066 function lock() {
1067 $dbw = $this->repo->getMasterDB();
1068 if ( !$this->locked ) {
1069 $dbw->begin();
1070 $this->locked++;
1071 }
1072 return $dbw->selectField( 'image', '1', array( 'img_name' => $this->getName() ), __METHOD__ );
1073 }
1074
1075 /**
1076 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1077 * the transaction and thereby releases the image lock.
1078 */
1079 function unlock() {
1080 if ( $this->locked ) {
1081 --$this->locked;
1082 if ( !$this->locked ) {
1083 $dbw = $this->repo->getMasterDB();
1084 $dbw->commit();
1085 }
1086 }
1087 }
1088
1089 /**
1090 * Roll back the DB transaction and mark the image unlocked
1091 */
1092 function unlockAndRollback() {
1093 $this->locked = false;
1094 $dbw = $this->repo->getMasterDB();
1095 $dbw->rollback();
1096 }
1097 } // LocalFile class
1098
1099 #------------------------------------------------------------------------------
1100
1101 /**
1102 * Helper class for file deletion
1103 */
1104 class LocalFileDeleteBatch {
1105 var $file, $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1106 var $status;
1107
1108 function __construct( File $file, $reason = '', $suppress = false ) {
1109 $this->file = $file;
1110 $this->reason = $reason;
1111 $this->suppress = $suppress;
1112 $this->status = $file->repo->newGood();
1113 }
1114
1115 function addCurrent() {
1116 $this->srcRels['.'] = $this->file->getRel();
1117 }
1118
1119 function addOld( $oldName ) {
1120 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
1121 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
1122 }
1123
1124 function getOldRels() {
1125 if ( !isset( $this->srcRels['.'] ) ) {
1126 $oldRels =& $this->srcRels;
1127 $deleteCurrent = false;
1128 } else {
1129 $oldRels = $this->srcRels;
1130 unset( $oldRels['.'] );
1131 $deleteCurrent = true;
1132 }
1133 return array( $oldRels, $deleteCurrent );
1134 }
1135
1136 /*protected*/ function getHashes() {
1137 $hashes = array();
1138 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1139 if ( $deleteCurrent ) {
1140 $hashes['.'] = $this->file->getSha1();
1141 }
1142 if ( count( $oldRels ) ) {
1143 $dbw = $this->file->repo->getMasterDB();
1144 $res = $dbw->select( 'oldimage', array( 'oi_archive_name', 'oi_sha1' ),
1145 'oi_archive_name IN(' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1146 __METHOD__ );
1147 while ( $row = $dbw->fetchObject( $res ) ) {
1148 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
1149 // Get the hash from the file
1150 $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
1151 $props = $this->file->repo->getFileProps( $oldUrl );
1152 if ( $props['fileExists'] ) {
1153 // Upgrade the oldimage row
1154 $dbw->update( 'oldimage',
1155 array( 'oi_sha1' => $props['sha1'] ),
1156 array( 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ),
1157 __METHOD__ );
1158 $hashes[$row->oi_archive_name] = $props['sha1'];
1159 } else {
1160 $hashes[$row->oi_archive_name] = false;
1161 }
1162 } else {
1163 $hashes[$row->oi_archive_name] = $row->oi_sha1;
1164 }
1165 }
1166 }
1167 $missing = array_diff_key( $this->srcRels, $hashes );
1168 foreach ( $missing as $name => $rel ) {
1169 $this->status->error( 'filedelete-old-unregistered', $name );
1170 }
1171 foreach ( $hashes as $name => $hash ) {
1172 if ( !$hash ) {
1173 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
1174 unset( $hashes[$name] );
1175 }
1176 }
1177
1178 return $hashes;
1179 }
1180
1181 function doDBInserts() {
1182 global $wgUser;
1183 $dbw = $this->file->repo->getMasterDB();
1184 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1185 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1186 $encReason = $dbw->addQuotes( $this->reason );
1187 $encGroup = $dbw->addQuotes( 'deleted' );
1188 $ext = $this->file->getExtension();
1189 $dotExt = $ext === '' ? '' : ".$ext";
1190 $encExt = $dbw->addQuotes( $dotExt );
1191 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1192
1193 // Bitfields to further suppress the content
1194 if ( $this->suppress ) {
1195 $bitfield = 0;
1196 // This should be 15...
1197 $bitfield |= Revision::DELETED_TEXT;
1198 $bitfield |= Revision::DELETED_COMMENT;
1199 $bitfield |= Revision::DELETED_USER;
1200 $bitfield |= Revision::DELETED_RESTRICTED;
1201 } else {
1202 $bitfield = 'oi_deleted';
1203 }
1204
1205 if ( $deleteCurrent ) {
1206 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1207 $where = array( 'img_name' => $this->file->getName() );
1208 $dbw->insertSelect( 'filearchive', 'image',
1209 array(
1210 'fa_storage_group' => $encGroup,
1211 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1212 'fa_deleted_user' => $encUserId,
1213 'fa_deleted_timestamp' => $encTimestamp,
1214 'fa_deleted_reason' => $encReason,
1215 'fa_deleted' => $this->suppress ? $bitfield : 0,
1216
1217 'fa_name' => 'img_name',
1218 'fa_archive_name' => 'NULL',
1219 'fa_size' => 'img_size',
1220 'fa_width' => 'img_width',
1221 'fa_height' => 'img_height',
1222 'fa_metadata' => 'img_metadata',
1223 'fa_bits' => 'img_bits',
1224 'fa_media_type' => 'img_media_type',
1225 'fa_major_mime' => 'img_major_mime',
1226 'fa_minor_mime' => 'img_minor_mime',
1227 'fa_description' => 'img_description',
1228 'fa_user' => 'img_user',
1229 'fa_user_text' => 'img_user_text',
1230 'fa_timestamp' => 'img_timestamp'
1231 ), $where, __METHOD__ );
1232 }
1233
1234 if ( count( $oldRels ) ) {
1235 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1236 $where = array(
1237 'oi_name' => $this->file->getName(),
1238 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1239 $dbw->insertSelect( 'filearchive', 'oldimage',
1240 array(
1241 'fa_storage_group' => $encGroup,
1242 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1243 'fa_deleted_user' => $encUserId,
1244 'fa_deleted_timestamp' => $encTimestamp,
1245 'fa_deleted_reason' => $encReason,
1246 'fa_deleted' => $this->suppress ? $bitfield : 'oi_deleted',
1247
1248 'fa_name' => 'oi_name',
1249 'fa_archive_name' => 'oi_archive_name',
1250 'fa_size' => 'oi_size',
1251 'fa_width' => 'oi_width',
1252 'fa_height' => 'oi_height',
1253 'fa_metadata' => 'oi_metadata',
1254 'fa_bits' => 'oi_bits',
1255 'fa_media_type' => 'oi_media_type',
1256 'fa_major_mime' => 'oi_major_mime',
1257 'fa_minor_mime' => 'oi_minor_mime',
1258 'fa_description' => 'oi_description',
1259 'fa_user' => 'oi_user',
1260 'fa_user_text' => 'oi_user_text',
1261 'fa_timestamp' => 'oi_timestamp',
1262 'fa_deleted' => $bitfield
1263 ), $where, __METHOD__ );
1264 }
1265 }
1266
1267 function doDBDeletes() {
1268 $dbw = $this->file->repo->getMasterDB();
1269 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1270 if ( count( $oldRels ) ) {
1271 $dbw->delete( 'oldimage',
1272 array(
1273 'oi_name' => $this->file->getName(),
1274 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')'
1275 ), __METHOD__ );
1276 }
1277 if ( $deleteCurrent ) {
1278 $dbw->delete( 'image', array( 'img_name' => $this->file->getName() ), __METHOD__ );
1279 }
1280 }
1281
1282 /**
1283 * Run the transaction
1284 */
1285 function execute() {
1286 global $wgUser, $wgUseSquid;
1287 wfProfileIn( __METHOD__ );
1288
1289 $this->file->lock();
1290 // Leave private files alone
1291 $privateFiles = array();
1292 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1293 $dbw = $this->file->repo->getMasterDB();
1294 if( !empty( $oldRels ) ) {
1295 $res = $dbw->select( 'oldimage',
1296 array( 'oi_archive_name' ),
1297 array( 'oi_name' => $this->file->getName(),
1298 'oi_archive_name IN (' . $dbw->makeList( array_keys($oldRels) ) . ')',
1299 'oi_deleted & ' . File::DELETED_FILE => File::DELETED_FILE ),
1300 __METHOD__ );
1301 while( $row = $dbw->fetchObject( $res ) ) {
1302 $privateFiles[$row->oi_archive_name] = 1;
1303 }
1304 }
1305 // Prepare deletion batch
1306 $hashes = $this->getHashes();
1307 $this->deletionBatch = array();
1308 $ext = $this->file->getExtension();
1309 $dotExt = $ext === '' ? '' : ".$ext";
1310 foreach ( $this->srcRels as $name => $srcRel ) {
1311 // Skip files that have no hash (missing source).
1312 // Keep private files where they are.
1313 if ( isset($hashes[$name]) && !array_key_exists($name,$privateFiles) ) {
1314 $hash = $hashes[$name];
1315 $key = $hash . $dotExt;
1316 $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
1317 $this->deletionBatch[$name] = array( $srcRel, $dstRel );
1318 }
1319 }
1320
1321 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1322 // We acquire this lock by running the inserts now, before the file operations.
1323 //
1324 // This potentially has poor lock contention characteristics -- an alternative
1325 // scheme would be to insert stub filearchive entries with no fa_name and commit
1326 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1327 $this->doDBInserts();
1328
1329 // Execute the file deletion batch
1330 $status = $this->file->repo->deleteBatch( $this->deletionBatch );
1331 if ( !$status->isGood() ) {
1332 $this->status->merge( $status );
1333 }
1334
1335 if ( !$this->status->ok ) {
1336 // Critical file deletion error
1337 // Roll back inserts, release lock and abort
1338 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1339 $this->file->unlockAndRollback();
1340 return $this->status;
1341 }
1342
1343 // Purge squid
1344 if ( $wgUseSquid ) {
1345 $urls = array();
1346 foreach ( $this->srcRels as $srcRel ) {
1347 $urlRel = str_replace( '%2F', '/', rawurlencode( $srcRel ) );
1348 $urls[] = $this->file->repo->getZoneUrl( 'public' ) . '/' . $urlRel;
1349 }
1350 SquidUpdate::purge( $urls );
1351 }
1352
1353 // Delete image/oldimage rows
1354 $this->doDBDeletes();
1355
1356 // Commit and return
1357 $this->file->unlock();
1358 wfProfileOut( __METHOD__ );
1359 return $this->status;
1360 }
1361 }
1362
1363 #------------------------------------------------------------------------------
1364
1365 /**
1366 * Helper class for file undeletion
1367 */
1368 class LocalFileRestoreBatch {
1369 var $file, $cleanupBatch, $ids, $all, $unsuppress = false;
1370
1371 function __construct( File $file, $unsuppress = false ) {
1372 $this->file = $file;
1373 $this->cleanupBatch = $this->ids = array();
1374 $this->ids = array();
1375 $this->unsuppress = $unsuppress;
1376 }
1377
1378 /**
1379 * Add a file by ID
1380 */
1381 function addId( $fa_id ) {
1382 $this->ids[] = $fa_id;
1383 }
1384
1385 /**
1386 * Add a whole lot of files by ID
1387 */
1388 function addIds( $ids ) {
1389 $this->ids = array_merge( $this->ids, $ids );
1390 }
1391
1392 /**
1393 * Add all revisions of the file
1394 */
1395 function addAll() {
1396 $this->all = true;
1397 }
1398
1399 /**
1400 * Run the transaction, except the cleanup batch.
1401 * The cleanup batch should be run in a separate transaction, because it locks different
1402 * rows and there's no need to keep the image row locked while it's acquiring those locks
1403 * The caller may have its own transaction open.
1404 * So we save the batch and let the caller call cleanup()
1405 */
1406 function execute() {
1407 global $wgUser, $wgLang;
1408 if ( !$this->all && !$this->ids ) {
1409 // Do nothing
1410 return $this->file->repo->newGood();
1411 }
1412
1413 $exists = $this->file->lock();
1414 $dbw = $this->file->repo->getMasterDB();
1415 $status = $this->file->repo->newGood();
1416
1417 // Fetch all or selected archived revisions for the file,
1418 // sorted from the most recent to the oldest.
1419 $conditions = array( 'fa_name' => $this->file->getName() );
1420 if( !$this->all ) {
1421 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids ) . ')';
1422 }
1423
1424 $result = $dbw->select( 'filearchive', '*',
1425 $conditions,
1426 __METHOD__,
1427 array( 'ORDER BY' => 'fa_timestamp DESC' ) );
1428
1429 $idsPresent = array();
1430 $storeBatch = array();
1431 $insertBatch = array();
1432 $insertCurrent = false;
1433 $deleteIds = array();
1434 $first = true;
1435 $archiveNames = array();
1436 while( $row = $dbw->fetchObject( $result ) ) {
1437 $idsPresent[] = $row->fa_id;
1438
1439 if ( $row->fa_name != $this->file->getName() ) {
1440 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
1441 $status->failCount++;
1442 continue;
1443 }
1444 if ( $row->fa_storage_key == '' ) {
1445 // Revision was missing pre-deletion
1446 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
1447 $status->failCount++;
1448 continue;
1449 }
1450
1451 $deletedRel = $this->file->repo->getDeletedHashPath( $row->fa_storage_key ) . $row->fa_storage_key;
1452 $deletedUrl = $this->file->repo->getVirtualUrl() . '/deleted/' . $deletedRel;
1453
1454 $sha1 = substr( $row->fa_storage_key, 0, strcspn( $row->fa_storage_key, '.' ) );
1455 # Fix leading zero
1456 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1457 $sha1 = substr( $sha1, 1 );
1458 }
1459
1460 if( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
1461 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
1462 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
1463 || is_null( $row->fa_metadata ) ) {
1464 // Refresh our metadata
1465 // Required for a new current revision; nice for older ones too. :)
1466 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
1467 } else {
1468 $props = array(
1469 'minor_mime' => $row->fa_minor_mime,
1470 'major_mime' => $row->fa_major_mime,
1471 'media_type' => $row->fa_media_type,
1472 'metadata' => $row->fa_metadata );
1473 }
1474
1475 if ( $first && !$exists ) {
1476 // The live (current) version cannot be hidden!
1477 if( !$this->unsuppress && $row->fa_deleted ) {
1478 $this->file->unlock();
1479 return $status;
1480 }
1481 // This revision will be published as the new current version
1482 $destRel = $this->file->getRel();
1483 $insertCurrent = array(
1484 'img_name' => $row->fa_name,
1485 'img_size' => $row->fa_size,
1486 'img_width' => $row->fa_width,
1487 'img_height' => $row->fa_height,
1488 'img_metadata' => $props['metadata'],
1489 'img_bits' => $row->fa_bits,
1490 'img_media_type' => $props['media_type'],
1491 'img_major_mime' => $props['major_mime'],
1492 'img_minor_mime' => $props['minor_mime'],
1493 'img_description' => $row->fa_description,
1494 'img_user' => $row->fa_user,
1495 'img_user_text' => $row->fa_user_text,
1496 'img_timestamp' => $row->fa_timestamp,
1497 'img_sha1' => $sha1);
1498 } else {
1499 $archiveName = $row->fa_archive_name;
1500 if( $archiveName == '' ) {
1501 // This was originally a current version; we
1502 // have to devise a new archive name for it.
1503 // Format is <timestamp of archiving>!<name>
1504 $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
1505 do {
1506 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
1507 $timestamp++;
1508 } while ( isset( $archiveNames[$archiveName] ) );
1509 }
1510 $archiveNames[$archiveName] = true;
1511 $destRel = $this->file->getArchiveRel( $archiveName );
1512 $insertBatch[] = array(
1513 'oi_name' => $row->fa_name,
1514 'oi_archive_name' => $archiveName,
1515 'oi_size' => $row->fa_size,
1516 'oi_width' => $row->fa_width,
1517 'oi_height' => $row->fa_height,
1518 'oi_bits' => $row->fa_bits,
1519 'oi_description' => $row->fa_description,
1520 'oi_user' => $row->fa_user,
1521 'oi_user_text' => $row->fa_user_text,
1522 'oi_timestamp' => $row->fa_timestamp,
1523 'oi_metadata' => $props['metadata'],
1524 'oi_media_type' => $props['media_type'],
1525 'oi_major_mime' => $props['major_mime'],
1526 'oi_minor_mime' => $props['minor_mime'],
1527 'oi_deleted' => $this->unsuppress ? 0 : $row->fa_deleted,
1528 'oi_sha1' => $sha1 );
1529 }
1530
1531 $deleteIds[] = $row->fa_id;
1532 if( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
1533 // private files can stay where they are
1534 } else {
1535 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1536 $this->cleanupBatch[] = $row->fa_storage_key;
1537 }
1538 $first = false;
1539 }
1540 unset( $result );
1541
1542 // Add a warning to the status object for missing IDs
1543 $missingIds = array_diff( $this->ids, $idsPresent );
1544 foreach ( $missingIds as $id ) {
1545 $status->error( 'undelete-missing-filearchive', $id );
1546 }
1547
1548 // Run the store batch
1549 // Use the OVERWRITE_SAME flag to smooth over a common error
1550 $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
1551 $status->merge( $storeStatus );
1552
1553 if ( !$status->ok ) {
1554 // Store batch returned a critical error -- this usually means nothing was stored
1555 // Stop now and return an error
1556 $this->file->unlock();
1557 return $status;
1558 }
1559
1560 // Run the DB updates
1561 // Because we have locked the image row, key conflicts should be rare.
1562 // If they do occur, we can roll back the transaction at this time with
1563 // no data loss, but leaving unregistered files scattered throughout the
1564 // public zone.
1565 // This is not ideal, which is why it's important to lock the image row.
1566 if ( $insertCurrent ) {
1567 $dbw->insert( 'image', $insertCurrent, __METHOD__ );
1568 }
1569 if ( $insertBatch ) {
1570 $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
1571 }
1572 if ( $deleteIds ) {
1573 $dbw->delete( 'filearchive',
1574 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
1575 __METHOD__ );
1576 }
1577
1578 if( $status->successCount > 0 ) {
1579 if( !$exists ) {
1580 wfDebug( __METHOD__." restored {$status->successCount} items, creating a new current\n" );
1581
1582 // Update site_stats
1583 $site_stats = $dbw->tableName( 'site_stats' );
1584 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__ );
1585
1586 $this->file->purgeEverything();
1587 } else {
1588 wfDebug( __METHOD__." restored {$status->successCount} as archived versions\n" );
1589 $this->file->purgeDescription();
1590 $this->file->purgeHistory();
1591 }
1592 }
1593 $this->file->unlock();
1594 return $status;
1595 }
1596
1597 /**
1598 * Delete unused files in the deleted zone.
1599 * This should be called from outside the transaction in which execute() was called.
1600 */
1601 function cleanup() {
1602 if ( !$this->cleanupBatch ) {
1603 return $this->file->repo->newGood();
1604 }
1605 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
1606 return $status;
1607 }
1608 }
Wiklou, le Wiki du Wiklou