Page MenuHomeWickedGov Phorge
Files F4108942

PageArchive.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

PageArchive.php
View Options

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\FileRepo\File\FileSelectQueryBuilder;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\UndeletePage;
use MediaWiki\Title\Title;
use MediaWiki\User\UserIdentity;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\LikeValue;
use Wikimedia\Rdbms\SelectQueryBuilder;
/**
* Used to show archived pages and eventually restore them.
*/
class PageArchive {
protected Title $title;
/**
* @param Title $title
*/
public function __construct( Title $title ) {
$this->title = $title;
}
/**
* List deleted pages recorded in the archive matching the
* given term, using search engine archive.
* Returns result wrapper with (ar_namespace, ar_title, count) fields.
*
* @param string $term Search term
* @return IResultWrapper|bool
*/
public static function listPagesBySearch( $term ) {
$title = Title::newFromText( $term );
if ( $title ) {
$ns = $title->getNamespace();
$termMain = $title->getText();
$termDb = $title->getDBkey();
} else {
// Prolly won't work too good
// @todo handle bare namespace names cleanly?
$ns = 0;
$termMain = $termDb = $term;
}
// Try search engine first
$engine = MediaWikiServices::getInstance()->newSearchEngine();
$engine->setLimitOffset( 100 );
$engine->setNamespaces( [ $ns ] );
$results = $engine->searchArchiveTitle( $termMain );
if ( !$results->isOK() ) {
$results = [];
} else {
$results = $results->getValue();
}
if ( !$results ) {
// Fall back to regular prefix search
return self::listPagesByPrefix( $term );
}
$dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
$condTitles = array_values( array_unique( array_map( static function ( Title $t ) {
return $t->getDBkey();
}, $results ) ) );
$conds = [
'ar_namespace' => $ns,
$dbr->expr( 'ar_title', '=', $condTitles )
->or( 'ar_title', IExpression::LIKE, new LikeValue( $termDb, $dbr->anyString() ) ),
];
return self::listPages( $dbr, $conds );
}
/**
* List deleted pages recorded in the archive table matching the
* given title prefix.
* Returns result wrapper with (ar_namespace, ar_title, count) fields.
*
* @param string $prefix Title prefix
* @return IResultWrapper|bool
*/
public static function listPagesByPrefix( $prefix ) {
$dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
$title = Title::newFromText( $prefix );
if ( $title ) {
$ns = $title->getNamespace();
$prefix = $title->getDBkey();
} else {
// Prolly won't work too good
// @todo handle bare namespace names cleanly?
$ns = 0;
}
$conds = [
'ar_namespace' => $ns,
$dbr->expr( 'ar_title', IExpression::LIKE, new LikeValue( $prefix, $dbr->anyString() ) ),
];
return self::listPages( $dbr, $conds );
}
/**
* @param IReadableDatabase $dbr
* @param string|array $condition
* @return IResultWrapper
*/
protected static function listPages( IReadableDatabase $dbr, $condition ) {
return $dbr->newSelectQueryBuilder()
->select( [ 'ar_namespace', 'ar_title', 'count' => 'COUNT(*)' ] )
->from( 'archive' )
->where( $condition )
->groupBy( [ 'ar_namespace', 'ar_title' ] )
->orderBy( [ 'ar_namespace', 'ar_title' ] )
->limit( 100 )
->caller( __METHOD__ )->fetchResultSet();
}
/**
* List the deleted file revisions for this page, if it's a file page.
* Returns a result wrapper with various filearchive fields, or null
* if not a file page.
*
* @return IResultWrapper|null
* @todo Does this belong in Image for fuller encapsulation?
*/
public function listFiles() {
if ( $this->title->getNamespace() !== NS_FILE ) {
return null;
}
$dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
$queryBuilder = FileSelectQueryBuilder::newForArchivedFile( $dbr );
$queryBuilder->where( [ 'fa_name' => $this->title->getDBkey() ] )
->orderBy( 'fa_timestamp', SelectQueryBuilder::SORT_DESC );
return $queryBuilder->caller( __METHOD__ )->fetchResultSet();
}
/**
* Restore the given (or all) text and file revisions for the page.
* Once restored, the items will be removed from the archive tables.
* The deletion log will be updated with an undeletion notice.
*
* @since 1.35
* @deprecated since 1.38, use UndeletePage instead, hard-deprecated since 1.43
*
* @param array $timestamps Pass an empty array to restore all revisions,
* otherwise list the ones to undelete.
* @param UserIdentity $user
* @param string $comment
* @param array $fileVersions
* @param bool $unsuppress
* @param string|string[]|null $tags Change tags to add to log entry
* ($user should be able to add the specified tags before this is called)
* @return array|false [ number of file revisions restored, number of image revisions
* restored, log message ] on success, false on failure.
*/
public function undeleteAsUser(
$timestamps,
UserIdentity $user,
$comment = '',
$fileVersions = [],
$unsuppress = false,
$tags = null
) {
wfDeprecated( __METHOD__, '1.43' );
$services = MediaWikiServices::getInstance();
$page = $services->getWikiPageFactory()->newFromTitle( $this->title );
$user = $services->getUserFactory()->newFromUserIdentity( $user );
$up = $services->getUndeletePageFactory()->newUndeletePage( $page, $user );
if ( is_string( $tags ) ) {
$tags = [ $tags ];
} elseif ( $tags === null ) {
$tags = [];
}
$status = $up
->setUndeleteOnlyTimestamps( $timestamps )
->setUndeleteOnlyFileVersions( $fileVersions ?: [] )
->setUnsuppress( $unsuppress )
->setTags( $tags ?: [] )
->undeleteUnsafe( $comment );
// BC with old return format
if ( $status->isGood() ) {
$restoredRevs = $status->getValue()[UndeletePage::REVISIONS_RESTORED];
$restoredFiles = $status->getValue()[UndeletePage::FILES_RESTORED];
if ( $restoredRevs === 0 && $restoredFiles === 0 ) {
$ret = false;
} else {
$ret = [ $restoredRevs, $restoredFiles, $comment ];
}
} else {
$ret = false;
}
return $ret;
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 20:48 (2 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
01/13/7c4b8a46d783209ca9184c50f487
Default Alt Text
PageArchive.php (6 KB)

Event Timeline