diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2008-12-15 18:02:47 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2008-12-15 18:02:47 +0100 |
commit | 396b28f3d881f5debd888ba9bb9b47c2d478a76f (patch) | |
tree | 10d6e1a721ee4ef69def34a57f02d7eb3fc9e31e /includes/SpecialLog.php | |
parent | 0be4d3ccf6c4fe98a72704f9463ecdea2ee5e615 (diff) |
update to Mediawiki 1.13.3; some cleanups
Diffstat (limited to 'includes/SpecialLog.php')
-rw-r--r-- | includes/SpecialLog.php | 527 |
1 files changed, 0 insertions, 527 deletions
diff --git a/includes/SpecialLog.php b/includes/SpecialLog.php deleted file mode 100644 index 5c28340f..00000000 --- a/includes/SpecialLog.php +++ /dev/null @@ -1,527 +0,0 @@ -<?php -# Copyright (C) 2004 Brion Vibber <brion@pobox.com> -# http://www.mediawiki.org/ -# -# 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 - -/** - * - * @addtogroup SpecialPage - */ - -/** - * constructor - */ -function wfSpecialLog( $par = '' ) { - global $wgRequest; - $logReader = new LogReader( $wgRequest ); - if( $wgRequest->getVal( 'type' ) == '' && $par != '' ) { - $logReader->limitType( $par ); - } - $logViewer = new LogViewer( $logReader ); - $logViewer->show(); -} - -/** - * - * @addtogroup SpecialPage - */ -class LogReader { - var $db, $joinClauses, $whereClauses; - var $type = '', $user = '', $title = null, $pattern = false; - - /** - * @param WebRequest $request For internal use use a FauxRequest object to pass arbitrary parameters. - */ - function LogReader( $request ) { - $this->db = wfGetDB( DB_SLAVE ); - $this->setupQuery( $request ); - } - - /** - * Basic setup and applies the limiting factors from the WebRequest object. - * @param WebRequest $request - * @private - */ - function setupQuery( $request ) { - $page = $this->db->tableName( 'page' ); - $user = $this->db->tableName( 'user' ); - $this->joinClauses = array( - "LEFT OUTER JOIN $page ON log_namespace=page_namespace AND log_title=page_title", - "INNER JOIN $user ON user_id=log_user" ); - $this->whereClauses = array(); - - $this->limitType( $request->getVal( 'type' ) ); - $this->limitUser( $request->getText( 'user' ) ); - $this->limitTitle( $request->getText( 'page' ) , $request->getBool( 'pattern' ) ); - $this->limitTime( $request->getVal( 'from' ), '>=' ); - $this->limitTime( $request->getVal( 'until' ), '<=' ); - - list( $this->limit, $this->offset ) = $request->getLimitOffset(); - - // XXX This all needs to use Pager, ugly hack for now. - global $wgMiserMode; - if( $wgMiserMode ) - $this->offset = min( $this->offset, 10000 ); - } - - /** - * Set the log reader to return only entries of the given type. - * @param string $type A log type ('upload', 'delete', etc) - * @private - */ - function limitType( $type ) { - if( empty( $type ) ) { - return false; - } - $this->type = $type; - $safetype = $this->db->strencode( $type ); - $this->whereClauses[] = "log_type='$safetype'"; - } - - /** - * Set the log reader to return only entries by the given user. - * @param string $name (In)valid user name - * @private - */ - function limitUser( $name ) { - if ( $name == '' ) - return false; - $usertitle = Title::makeTitleSafe( NS_USER, $name ); - if ( is_null( $usertitle ) ) - return false; - $this->user = $usertitle->getText(); - - /* Fetch userid at first, if known, provides awesome query plan afterwards */ - $userid = $this->db->selectField('user','user_id',array('user_name'=>$this->user)); - if (!$userid) - /* It should be nicer to abort query at all, - but for now it won't pass anywhere behind the optimizer */ - $this->whereClauses[] = "NULL"; - else - $this->whereClauses[] = "log_user=$userid"; - } - - /** - * Set the log reader to return only entries affecting the given page. - * (For the block and rights logs, this is a user page.) - * @param string $page Title name as text - * @private - */ - function limitTitle( $page , $pattern ) { - global $wgMiserMode; - - $title = Title::newFromText( $page ); - - if( strlen( $page ) == 0 || !$title instanceof Title ) - return false; - - $this->title =& $title; - $this->pattern = $pattern; - $ns = $title->getNamespace(); - if ( $pattern && !$wgMiserMode ) { - $safetitle = $this->db->escapeLike( $title->getDBkey() ); // use escapeLike to avoid expensive search patterns like 't%st%' - $this->whereClauses[] = "log_namespace=$ns AND log_title LIKE '$safetitle%'"; - } else { - $safetitle = $this->db->strencode( $title->getDBkey() ); - $this->whereClauses[] = "log_namespace=$ns AND log_title = '$safetitle'"; - } - } - - /** - * Set the log reader to return only entries in a given time range. - * @param string $time Timestamp of one endpoint - * @param string $direction either ">=" or "<=" operators - * @private - */ - function limitTime( $time, $direction ) { - # Direction should be a comparison operator - if( empty( $time ) ) { - return false; - } - $safetime = $this->db->strencode( wfTimestamp( TS_MW, $time ) ); - $this->whereClauses[] = "log_timestamp $direction '$safetime'"; - } - - /** - * Build an SQL query from all the set parameters. - * @return string the SQL query - * @private - */ - function getQuery() { - $logging = $this->db->tableName( "logging" ); - $sql = "SELECT /*! STRAIGHT_JOIN */ log_type, log_action, log_timestamp, - log_user, user_name, - log_namespace, log_title, page_id, - log_comment, log_params FROM $logging "; - if( !empty( $this->joinClauses ) ) { - $sql .= implode( ' ', $this->joinClauses ); - } - if( !empty( $this->whereClauses ) ) { - $sql .= " WHERE " . implode( ' AND ', $this->whereClauses ); - } - $sql .= " ORDER BY log_timestamp DESC "; - $sql = $this->db->limitResult($sql, $this->limit, $this->offset ); - return $sql; - } - - /** - * Execute the query and start returning results. - * @return ResultWrapper result object to return the relevant rows - */ - function getRows() { - $res = $this->db->query( $this->getQuery(), __METHOD__ ); - return $this->db->resultObject( $res ); - } - - /** - * @return string The query type that this LogReader has been limited to. - */ - function queryType() { - return $this->type; - } - - /** - * @return string The username type that this LogReader has been limited to, if any. - */ - function queryUser() { - return $this->user; - } - - /** - * @return boolean The checkbox, if titles should be searched by a pattern too - */ - function queryPattern() { - return $this->pattern; - } - - /** - * @return string The text of the title that this LogReader has been limited to. - */ - function queryTitle() { - if( is_null( $this->title ) ) { - return ''; - } else { - return $this->title->getPrefixedText(); - } - } - - /** - * Is there at least one row? - * - * @return bool - */ - public function hasRows() { - # Little hack... - $limit = $this->limit; - $this->limit = 1; - $res = $this->db->query( $this->getQuery() ); - $this->limit = $limit; - $ret = $this->db->numRows( $res ) > 0; - $this->db->freeResult( $res ); - return $ret; - } - -} - -/** - * - * @addtogroup SpecialPage - */ -class LogViewer { - const NO_ACTION_LINK = 1; - - /** - * @var LogReader $reader - */ - var $reader; - var $numResults = 0; - var $flags = 0; - - /** - * @param LogReader &$reader where to get our data from - * @param integer $flags Bitwise combination of flags: - * self::NO_ACTION_LINK Don't show restore/unblock/block links - */ - function LogViewer( &$reader, $flags = 0 ) { - global $wgUser; - $this->skin = $wgUser->getSkin(); - $this->reader =& $reader; - $this->flags = $flags; - } - - /** - * Take over the whole output page in $wgOut with the log display. - */ - function show() { - global $wgOut; - $this->showHeader( $wgOut ); - $this->showOptions( $wgOut ); - $result = $this->getLogRows(); - if ( $this->numResults > 0 ) { - $this->showPrevNext( $wgOut ); - $this->doShowList( $wgOut, $result ); - $this->showPrevNext( $wgOut ); - } else { - $this->showError( $wgOut ); - } - } - - /** - * Load the data from the linked LogReader - * Preload the link cache - * Initialise numResults - * - * Must be called before calling showPrevNext - * - * @return object database result set - */ - function getLogRows() { - $result = $this->reader->getRows(); - $this->numResults = 0; - - // Fetch results and form a batch link existence query - $batch = new LinkBatch; - while ( $s = $result->fetchObject() ) { - // User link - $batch->addObj( Title::makeTitleSafe( NS_USER, $s->user_name ) ); - $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $s->user_name ) ); - - // Move destination link - if ( $s->log_type == 'move' ) { - $paramArray = LogPage::extractParams( $s->log_params ); - $title = Title::newFromText( $paramArray[0] ); - $batch->addObj( $title ); - } - ++$this->numResults; - } - $batch->execute(); - - return $result; - } - - - /** - * Output just the list of entries given by the linked LogReader, - * with extraneous UI elements. Use for displaying log fragments in - * another page (eg at Special:Undelete) - * @param OutputPage $out where to send output - */ - function showList( &$out ) { - $result = $this->getLogRows(); - if ( $this->numResults > 0 ) { - $this->doShowList( $out, $result ); - } else { - $this->showError( $out ); - } - } - - function doShowList( &$out, $result ) { - // Rewind result pointer and go through it again, making the HTML - $html = "\n<ul>\n"; - $result->seek( 0 ); - while( $s = $result->fetchObject() ) { - $html .= $this->logLine( $s ); - } - $html .= "\n</ul>\n"; - $out->addHTML( $html ); - $result->free(); - } - - function showError( &$out ) { - $out->addWikiMsg( 'logempty' ); - } - - /** - * @param Object $s a single row from the result set - * @return string Formatted HTML list item - * @private - */ - function logLine( $s ) { - global $wgLang, $wgUser, $wgContLang; - $skin = $wgUser->getSkin(); - $title = Title::makeTitle( $s->log_namespace, $s->log_title ); - $time = $wgLang->timeanddate( wfTimestamp(TS_MW, $s->log_timestamp), true ); - - // Enter the existence or non-existence of this page into the link cache, - // for faster makeLinkObj() in LogPage::actionText() - $linkCache =& LinkCache::singleton(); - if( $s->page_id ) { - $linkCache->addGoodLinkObj( $s->page_id, $title ); - } else { - $linkCache->addBadLinkObj( $title ); - } - - $userLink = $this->skin->userLink( $s->log_user, $s->user_name ) . $this->skin->userToolLinksRedContribs( $s->log_user, $s->user_name ); - $comment = $wgContLang->getDirMark() . $this->skin->commentBlock( $s->log_comment ); - $paramArray = LogPage::extractParams( $s->log_params ); - $revert = ''; - // show revertmove link - if ( !( $this->flags & self::NO_ACTION_LINK ) ) { - if ( $s->log_type == 'move' && isset( $paramArray[0] ) && $wgUser->isAllowed( 'move' ) ) { - $destTitle = Title::newFromText( $paramArray[0] ); - if ( $destTitle ) { - $revert = '(' . $this->skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Movepage' ), - wfMsg( 'revertmove' ), - 'wpOldTitle=' . urlencode( $destTitle->getPrefixedDBkey() ) . - '&wpNewTitle=' . urlencode( $title->getPrefixedDBkey() ) . - '&wpReason=' . urlencode( wfMsgForContent( 'revertmove' ) ) . - '&wpMovetalk=0' ) . ')'; - } - // show undelete link - } elseif ( $s->log_action == 'delete' && $wgUser->isAllowed( 'delete' ) ) { - $revert = '(' . $this->skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Undelete' ), - wfMsg( 'undeletelink' ) , - 'target='. urlencode( $title->getPrefixedDBkey() ) ) . ')'; - // show unblock link - } elseif ( $s->log_action == 'block' && $wgUser->isAllowed( 'block' ) ) { - $revert = '(' . $skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Ipblocklist' ), - wfMsg( 'unblocklink' ), - 'action=unblock&ip=' . urlencode( $s->log_title ) ) . ')'; - // show change protection link - } elseif ( ( $s->log_action == 'protect' || $s->log_action == 'modify' ) && $wgUser->isAllowed( 'protect' ) ) { - $revert = '(' . $skin->makeKnownLinkObj( $title, wfMsg( 'protect_change' ), 'action=unprotect' ) . ')'; - // Show unmerge link - } elseif ( $s->log_action == 'merge' ) { - $merge = SpecialPage::getTitleFor( 'Mergehistory' ); - $revert = '(' . $this->skin->makeKnownLinkObj( $merge, wfMsg('revertmerge'), - wfArrayToCGI( - array('target' => $paramArray[0], 'dest' => $title->getPrefixedText(), 'mergepoint' => $paramArray[1] ) - ) - ) . ')'; - } elseif ( wfRunHooks( 'LogLine', array( $s->log_type, $s->log_action, $title, $paramArray, &$comment, &$revert, $s->log_timestamp ) ) ) { - // wfDebug( "Invoked LogLine hook for " $s->log_type . ", " . $s->log_action . "\n" ); - // Do nothing. The implementation is handled by the hook modifiying the passed-by-ref parameters. - } - } - - $action = LogPage::actionText( $s->log_type, $s->log_action, $title, $this->skin, $paramArray, true ); - $out = "<li>$time $userLink $action $comment $revert</li>\n"; - return $out; - } - - /** - * @param OutputPage &$out where to send output - * @private - */ - function showHeader( &$out ) { - $type = $this->reader->queryType(); - if( LogPage::isLogType( $type ) ) { - $out->setPageTitle( LogPage::logName( $type ) ); - $out->addWikiText( LogPage::logHeader( $type ) ); - } - } - - /** - * @param OutputPage &$out where to send output - * @private - */ - function showOptions( &$out ) { - global $wgScript, $wgMiserMode; - $action = htmlspecialchars( $wgScript ); - $title = SpecialPage::getTitleFor( 'Log' ); - $special = htmlspecialchars( $title->getPrefixedDBkey() ); - $out->addHTML( "<form action=\"$action\" method=\"get\">\n" . - '<fieldset>' . - Xml::element( 'legend', array(), wfMsg( 'log' ) ) . - Xml::hidden( 'title', $special ) . "\n" . - $this->getTypeMenu() . "\n" . - $this->getUserInput() . "\n" . - $this->getTitleInput() . "\n" . - (!$wgMiserMode?($this->getTitlePattern()."\n"):"") . - Xml::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" . - "</fieldset></form>" ); - } - - /** - * @return string Formatted HTML - * @private - */ - function getTypeMenu() { - $out = "<select name='type'>\n"; - - $validTypes = LogPage::validTypes(); - $m = array(); // Temporary array - - // First pass to load the log names - foreach( $validTypes as $type ) { - $text = LogPage::logName( $type ); - $m[$text] = $type; - } - - // Second pass to sort by name - ksort($m); - - // Third pass generates sorted XHTML content - foreach( $m as $text => $type ) { - $selected = ($type == $this->reader->queryType()); - $out .= Xml::option( $text, $type, $selected ) . "\n"; - } - - $out .= '</select>'; - return $out; - } - - /** - * @return string Formatted HTML - * @private - */ - function getUserInput() { - $user = $this->reader->queryUser(); - return Xml::inputLabel( wfMsg( 'specialloguserlabel' ), 'user', 'user', 12, $user ); - } - - /** - * @return string Formatted HTML - * @private - */ - function getTitleInput() { - $title = $this->reader->queryTitle(); - return Xml::inputLabel( wfMsg( 'speciallogtitlelabel' ), 'page', 'page', 20, $title ); - } - - /** - * @return boolean Checkbox - * @private - */ - function getTitlePattern() { - $pattern = $this->reader->queryPattern(); - return Xml::checkLabel( wfMsg( 'log-title-wildcard' ), 'pattern', 'pattern', $pattern ); - } - - /** - * @param OutputPage &$out where to send output - * @private - */ - function showPrevNext( &$out ) { - global $wgContLang,$wgRequest; - $pieces = array(); - $pieces[] = 'type=' . urlencode( $this->reader->queryType() ); - $pieces[] = 'user=' . urlencode( $this->reader->queryUser() ); - $pieces[] = 'page=' . urlencode( $this->reader->queryTitle() ); - $pieces[] = 'pattern=' . urlencode( $this->reader->queryPattern() ); - $bits = implode( '&', $pieces ); - list( $limit, $offset ) = $wgRequest->getLimitOffset(); - - # TODO: use timestamps instead of offsets to make it more natural - # to go huge distances in time - $html = wfViewPrevNext( $offset, $limit, - $wgContLang->specialpage( 'Log' ), - $bits, - $this->numResults < $limit); - $out->addHTML( '<p>' . $html . '</p>' ); - } -} |