2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
3 # http://www.mediawiki.org/
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 # http://www.gnu.org/copyleft/gpl.html
23 * @subpackage SpecialPage
29 function wfSpecialLog( $par = '' ) {
31 $logReader =& new LogReader( $wgRequest );
32 if( $wgRequest->getVal( 'type' ) == '' && $par != '' ) {
33 $logReader->limitType( $par );
35 $logViewer =& new LogViewer( $logReader );
42 * @subpackage SpecialPage
45 var $db, $joinClauses, $whereClauses;
46 var $type = '', $user = '', $title = null;
49 * @param WebRequest $request For internal use use a FauxRequest object to pass arbitrary parameters.
51 function LogReader( $request ) {
52 $this->db
=& wfGetDB( DB_SLAVE
);
53 $this->setupQuery( $request );
57 * Basic setup and applies the limiting factors from the WebRequest object.
58 * @param WebRequest $request
61 function setupQuery( $request ) {
62 $page = $this->db
->tableName( 'page' );
63 $user = $this->db
->tableName( 'user' );
64 $this->joinClauses
= array( "LEFT OUTER JOIN $page ON log_namespace=page_namespace AND log_title=page_title" );
65 $this->whereClauses
= array( 'user_id=log_user' );
67 $this->limitType( $request->getVal( 'type' ) );
68 $this->limitUser( $request->getText( 'user' ) );
69 $this->limitTitle( $request->getText( 'page' ) );
70 $this->limitTime( $request->getVal( 'from' ), '>=' );
71 $this->limitTime( $request->getVal( 'until' ), '<=' );
73 list( $this->limit
, $this->offset
) = $request->getLimitOffset();
77 * Set the log reader to return only entries of the given type.
78 * @param string $type A log type ('upload', 'delete', etc)
81 function limitType( $type ) {
82 if( empty( $type ) ) {
86 $safetype = $this->db
->strencode( $type );
87 $this->whereClauses
[] = "log_type='$safetype'";
91 * Set the log reader to return only entries by the given user.
92 * @param string $name (In)valid user name
95 function limitUser( $name ) {
98 $title = Title
::makeTitle( NS_USER
, $name );
99 if ( is_null( $title ) )
101 $this->user
= $title->getText();
102 $safename = $this->db
->strencode( $this->user
);
103 $user = $this->db
->tableName( 'user' );
104 $this->whereClauses
[] = "user_name='$safename'";
108 * Set the log reader to return only entries affecting the given page.
109 * (For the block and rights logs, this is a user page.)
110 * @param string $page Title name as text
113 function limitTitle( $page ) {
114 $title = Title
::newFromText( $page );
115 if( empty( $page ) ||
is_null( $title ) ) {
118 $this->title
=& $title;
119 $safetitle = $this->db
->strencode( $title->getDBkey() );
120 $ns = $title->getNamespace();
121 $this->whereClauses
[] = "log_namespace=$ns AND log_title='$safetitle'";
125 * Set the log reader to return only entries in a given time range.
126 * @param string $time Timestamp of one endpoint
127 * @param string $direction either ">=" or "<=" operators
130 function limitTime( $time, $direction ) {
131 # Direction should be a comparison operator
132 if( empty( $time ) ) {
135 $safetime = $this->db
->strencode( wfTimestamp( TS_MW
, $time ) );
136 $this->whereClauses
[] = "log_timestamp $direction '$safetime'";
140 * Build an SQL query from all the set parameters.
141 * @return string the SQL query
144 function getQuery() {
145 $logging = $this->db
->tableName( "logging" );
146 $user = $this->db
->tableName( 'user' );
147 $sql = "SELECT log_type, log_action, log_timestamp,
149 log_namespace, log_title, page_id,
150 log_comment, log_params FROM $user, $logging ";
151 if ($this->type
=="" && $this->db
->indexExists('logging','times')) {
152 $sql .= ' /*! FORCE INDEX (times) */ ';
154 if( !empty( $this->joinClauses
) ) {
155 $sql .= implode( ',', $this->joinClauses
);
157 if( !empty( $this->whereClauses
) ) {
158 $sql .= " WHERE " . implode( ' AND ', $this->whereClauses
);
160 $sql .= " ORDER BY log_timestamp DESC ";
161 $sql = $this->db
->limitResult($sql, $this->limit
, $this->offset
);
166 * Execute the query and start returning results.
167 * @return ResultWrapper result object to return the relevant rows
170 $res = $this->db
->query( $this->getQuery() );
171 return $this->db
->resultObject( $res );
175 * @return string The query type that this LogReader has been limited to.
177 function queryType() {
182 * @return string The username type that this LogReader has been limited to, if any.
184 function queryUser() {
189 * @return string The text of the title that this LogReader has been limited to.
191 function queryTitle() {
192 if( is_null( $this->title
) ) {
195 return $this->title
->getPrefixedText();
203 * @subpackage SpecialPage
207 * @var LogReader $reader
213 * @param LogReader &$reader where to get our data from
215 function LogViewer( &$reader ) {
217 $this->skin
=& $wgUser->getSkin();
218 $this->reader
=& $reader;
222 * Take over the whole output page in $wgOut with the log display.
226 $this->showHeader( $wgOut );
227 $this->showOptions( $wgOut );
228 $result = $this->getLogRows();
229 $this->showPrevNext( $wgOut );
230 $this->doShowList( $wgOut, $result );
231 $this->showPrevNext( $wgOut );
235 * Load the data from the linked LogReader
236 * Preload the link cache
237 * Initialise numResults
239 * Must be called before calling showPrevNext
241 * @return object database result set
243 function getLogRows() {
245 $result = $this->reader
->getRows();
246 $this->numResults
= 0;
248 // Fetch results and form a batch link existence query
249 $batch = new LinkBatch
;
250 while ( $s = $result->fetchObject() ) {
252 $title = Title
::makeTitleSafe( NS_USER
, $s->user_name
);
253 $batch->addObj( $title );
255 // Move destination link
256 if ( $s->log_type
== 'move' ) {
257 $paramArray = LogPage
::extractParams( $s->log_params
);
258 $title = Title
::newFromText( $paramArray[0] );
259 $batch->addObj( $title );
263 $batch->execute( $wgLinkCache );
270 * Output just the list of entries given by the linked LogReader,
271 * with extraneous UI elements. Use for displaying log fragments in
272 * another page (eg at Special:Undelete)
273 * @param OutputPage $out where to send output
275 function showList( &$out ) {
276 $this->doShowList( $out, $this->getLogRows() );
279 function doShowList( &$out, $result ) {
280 // Rewind result pointer and go through it again, making the HTML
281 if ($this->numResults
> 0) {
284 while( $s = $result->fetchObject() ) {
285 $html .= $this->logLine( $s );
287 $html .= "\n</ul>\n";
288 $out->addHTML( $html );
290 $out->addWikiText( wfMsg( 'logempty' ) );
296 * @param Object $s a single row from the result set
297 * @return string Formatted HTML list item
300 function logLine( $s ) {
301 global $wgLang, $wgLinkCache;
302 $title = Title
::makeTitle( $s->log_namespace
, $s->log_title
);
303 $user = Title
::makeTitleSafe( NS_USER
, $s->user_name
);
304 $time = $wgLang->timeanddate( wfTimestamp(TS_MW
, $s->log_timestamp
), true );
306 // Enter the existence or non-existence of this page into the link cache,
307 // for faster makeLinkObj() in LogPage::actionText()
309 $wgLinkCache->addGoodLinkObj( $s->page_id
, $title );
311 $wgLinkCache->addBadLinkObj( $title );
314 $userLink = $this->skin
->makeLinkObj( $user, htmlspecialchars( $s->user_name
) );
315 $comment = $this->skin
->commentBlock( $s->log_comment
);
316 $paramArray = LogPage
::extractParams( $s->log_params
);
318 if ( $s->log_type
== 'move' && isset( $paramArray[0] ) ) {
319 $specialTitle = Title
::makeTitle( NS_SPECIAL
, 'Movepage' );
320 $destTitle = Title
::newFromText( $paramArray[0] );
322 $revert = '(' . $this->skin
->makeKnownLinkObj( $specialTitle, wfMsg( 'revertmove' ),
323 'wpOldTitle=' . urlencode( $destTitle->getPrefixedDBkey() ) .
324 '&wpNewTitle=' . urlencode( $title->getPrefixedDBkey() ) .
325 '&wpReason=' . urlencode( wfMsgForContent( 'revertmove' ) ) .
326 '&wpMovetalk=0' ) . ')';
330 $action = LogPage
::actionText( $s->log_type
, $s->log_action
, $title, $this->skin
, $paramArray, true, true );
331 $out = "<li>$time $userLink $action $comment $revert</li>\n";
336 * @param OutputPage &$out where to send output
339 function showHeader( &$out ) {
340 $type = $this->reader
->queryType();
341 if( LogPage
::isLogType( $type ) ) {
342 $out->setPageTitle( LogPage
::logName( $type ) );
343 $out->addWikiText( LogPage
::logHeader( $type ) );
348 * @param OutputPage &$out where to send output
351 function showOptions( &$out ) {
353 $action = htmlspecialchars( $wgScript );
354 $title = Title
::makeTitle( NS_SPECIAL
, 'Log' );
355 $special = htmlspecialchars( $title->getPrefixedDBkey() );
356 $out->addHTML( "<form action=\"$action\" method=\"get\">\n" .
357 "<input type='hidden' name='title' value=\"$special\" />\n" .
358 $this->getTypeMenu() .
359 $this->getUserInput() .
360 $this->getTitleInput() .
361 "<input type='submit' value=\"" . wfMsg( 'allpagessubmit' ) . "\" />" .
366 * @return string Formatted HTML
369 function getTypeMenu() {
370 $out = "<select name='type'>\n";
371 foreach( LogPage
::validTypes() as $type ) {
372 $text = htmlspecialchars( LogPage
::logName( $type ) );
373 $selected = ($type == $this->reader
->queryType()) ?
' selected="selected"' : '';
374 $out .= "<option value=\"$type\"$selected>$text</option>\n";
376 $out .= "</select>\n";
381 * @return string Formatted HTML
384 function getUserInput() {
385 $user = htmlspecialchars( $this->reader
->queryUser() );
386 return wfMsg('specialloguserlabel') . "<input type='text' name='user' size='12' value=\"$user\" />\n";
390 * @return string Formatted HTML
393 function getTitleInput() {
394 $title = htmlspecialchars( $this->reader
->queryTitle() );
395 return wfMsg('speciallogtitlelabel') . "<input type='text' name='page' size='20' value=\"$title\" />\n";
399 * @param OutputPage &$out where to send output
402 function showPrevNext( &$out ) {
403 global $wgContLang,$wgRequest;
405 $pieces[] = 'type=' . urlencode( $this->reader
->queryType() );
406 $pieces[] = 'user=' . urlencode( $this->reader
->queryUser() );
407 $pieces[] = 'page=' . urlencode( $this->reader
->queryTitle() );
408 $bits = implode( '&', $pieces );
409 list( $limit, $offset ) = $wgRequest->getLimitOffset();
411 # TODO: use timestamps instead of offsets to make it more natural
412 # to go huge distances in time
413 $html = wfViewPrevNext( $offset, $limit,
414 $wgContLang->specialpage( 'Log' ),
416 $this->numResults
< $limit);
417 $out->addHTML( '<p>' . $html . '</p>' );