includes/filerepo/file/ForeignDBFile.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 use MediaWiki\Language\Language;
  22 use MediaWiki\MediaWikiServices;
  23 use MediaWiki\Status\Status;
  24 use MediaWiki\Title\Title;
  25 use MediaWiki\User\UserIdentity;
  26 use Wikimedia\ObjectCache\WANObjectCache;
  27 use Wikimedia\Rdbms\DBUnexpectedError;
  28
  29 /**
  30  * Foreign file from a reachable database in the same wiki farm.
  31  *
  32  * @ingroup FileAbstraction
  33  */
  34 class ForeignDBFile extends LocalFile {
  35
  36         /**
  37          * @return ForeignDBRepo|false
  38          */
  39         public function getRepo() {
  40                 return $this->repo;
  41         }
  42
  43         /**
  44          * @param string $srcPath
  45          * @param int $flags
  46          * @param array $options
  47          * @return Status
  48          */
  49         public function publish( $srcPath, $flags = 0, array $options = [] ) {
  50                 $this->readOnlyError();
  51         }
  52
  53         /**
  54          * @param int[] $versions
  55          * @param bool $unsuppress
  56          * @return Status
  57          */
  58         public function restore( $versions = [], $unsuppress = false ) {
  59                 $this->readOnlyError();
  60         }
  61
  62         /**
  63          * @param string $reason
  64          * @param UserIdentity $user
  65          * @param bool $suppress
  66          * @return Status
  67          */
  68         public function deleteFile( $reason, UserIdentity $user, $suppress = false ) {
  69                 $this->readOnlyError();
  70         }
  71
  72         /**
  73          * @param Title $target
  74          * @return Status
  75          */
  76         public function move( $target ) {
  77                 $this->readOnlyError();
  78         }
  79
  80         /**
  81          * @return string
  82          */
  83         public function getDescriptionUrl() {
  84                 // Restore remote behavior
  85                 return File::getDescriptionUrl();
  86         }
  87
  88         /**
  89          * @param Language|null $lang Optional language to fetch description in.
  90          * @return string|false
  91          */
  92         public function getDescriptionText( ?Language $lang = null ) {
  93                 global $wgLang;
  94
  95                 if ( !$this->repo->fetchDescription ) {
  96                         return false;
  97                 }
  98
  99                 $lang ??= $wgLang;
 100                 $renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
 101                 if ( !$renderUrl ) {
 102                         return false;
 103                 }
 104
 105                 $touched = $this->repo->getReplicaDB()->newSelectQueryBuilder()
 106                         ->select( 'page_touched' )
 107                         ->from( 'page' )
 108                         ->where( [ 'page_namespace' => NS_FILE, 'page_title' => $this->title->getDBkey() ] )
 109                         ->caller( __METHOD__ )->fetchField();
 110                 if ( $touched === false ) {
 111                         return false; // no description page
 112                 }
 113
 114                 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
 115                 $fname = __METHOD__;
 116
 117                 return $cache->getWithSetCallback(
 118                         $this->repo->getLocalCacheKey(
 119                                 'file-foreign-description',
 120                                 $lang->getCode(),
 121                                 md5( $this->getName() ),
 122                                 $touched
 123                         ),
 124                         $this->repo->descriptionCacheExpiry ?: $cache::TTL_UNCACHEABLE,
 125                         static function ( $oldValue, &$ttl, array &$setOpts ) use ( $renderUrl, $fname ) {
 126                                 wfDebug( "Fetching shared description from $renderUrl" );
 127                                 $res = MediaWikiServices::getInstance()->getHttpRequestFactory()->
 128                                         get( $renderUrl, [], $fname );
 129                                 if ( !$res ) {
 130                                         $ttl = WANObjectCache::TTL_UNCACHEABLE;
 131                                 }
 132
 133                                 return $res;
 134                         }
 135                 );
 136         }
 137
 138         /**
 139          * Get short description URL for a file based on the page ID.
 140          *
 141          * @return string|null
 142          * @throws DBUnexpectedError
 143          * @since 1.27
 144          */
 145         public function getDescriptionShortUrl() {
 146                 $dbr = $this->repo->getReplicaDB();
 147                 $pageId = $dbr->newSelectQueryBuilder()
 148                         ->select( 'page_id' )
 149                         ->from( 'page' )
 150                         ->where( [ 'page_namespace' => NS_FILE, 'page_title' => $this->title->getDBkey() ] )
 151                         ->caller( __METHOD__ )->fetchField();
 152
 153                 if ( $pageId !== false ) {
 154                         $url = $this->repo->makeUrl( [ 'curid' => $pageId ] );
 155                         if ( $url !== false ) {
 156                                 return $url;
 157                         }
 158                 }
 159                 return null;
 160         }
 161
 162 }