API: Requesting a token you aren't allowed to request no longer dies with an error...
[lhc/web/wiklou.git] / includes / SpecialNewpages.php
index 8fe496d..a9f58b2 100644 (file)
 <?php
 /**
- *
- * @addtogroup SpecialPage
+ * @file
+ * @ingroup SpecialPage
  */
 
 
 /**
  * Start point
  */
-function wfSpecialNewPages( $par ) {
+function wfSpecialNewPages( $par, $sp ) {
        $page = new NewPagesForm();
-       
-       $page->showList( $par );
+       $page->execute( $par, $sp->including() );
 }
 
 /**
  * implements Special:Newpages
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class NewPagesForm {
+
+       // Stored objects
+       protected $opts, $title, $skin;
+
+       // Some internal settings
+       protected $showNavigation = false;
+
+       protected function setup( $par ) {
+               global $wgRequest, $wgUser, $wgEnableNewpagesUserFilter;
+
+               // Options
+               $opts = new FormOptions();
+               $this->opts = $opts; // bind
+               $opts->add( 'hideliu', false );
+               $opts->add( 'hidepatrolled', false );
+               $opts->add( 'hidebots', false );
+               $opts->add( 'limit', 50 );
+               $opts->add( 'offset', '' );
+               $opts->add( 'namespace', '0' );
+               $opts->add( 'username', '' );
+               $opts->add( 'feed', '' );
+
+               // Set values
+               $opts->fetchValuesFromRequest( $wgRequest );
+               if ( $par ) $this->parseParams( $par );
+
+               // Validate
+               $opts->validateIntBounds( 'limit', 0, 5000 );
+               if( !$wgEnableNewpagesUserFilter ) {
+                       $opts->setValue( 'username', '' );
+               }
+
+               // Store some objects
+               $this->skin = $wgUser->getSkin();
+               $this->title = SpecialPage::getTitleFor( 'NewPages' );
+       }
+
+       protected function parseParams( $par ) {
+               global $wgLang;
+               $bits = preg_split( '/\s*,\s*/', trim( $par ) );
+               foreach ( $bits as $bit ) {
+                       if ( 'shownav' == $bit )
+                               $this->showNavigation = true;
+                       if ( 'hideliu' === $bit )
+                               $this->opts->setValue( 'hideliu', true );
+                       if ( 'hidepatrolled' == $bit )
+                               $this->opts->setValue( 'hidepatrolled', true );
+                       if ( 'hidebots' == $bit )
+                               $this->opts->setValue( 'hidebots', true );
+                       if ( is_numeric( $bit ) )
+                               $this->opts->setValue( 'limit', intval( $bit ) );
+
+                       $m = array();
+                       if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) )
+                               $this->opts->setValue( 'limit', intval($m[1]) );
+                       // PG offsets not just digits!
+                       if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) )
+                               $this->opts->setValue( 'offset',  intval($m[1]) );
+                       if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
+                               $ns = $wgLang->getNsIndex( $m[1] );
+                               if( $ns !== false ) {
+                                       $this->opts->setValue( 'namespace',  $ns );
+                               }
+                       }
+               }
+       }
+
        /**
         * Show a form for filtering namespace and username
         *
+        * @param string $par
+        * @param bool $including true if the page is being included with {{Special:Newpages}}
         * @return string
         */
-       public function showList() {
-               global $wgScript, $wgContLang, $wgGroupPermissions, $wgRequest, $wgUser, $wgOut;
-               $sk = $wgUser->getSkin();
-               $align = $wgContLang->isRTL() ? 'left' : 'right';
-               $self = SpecialPage::getTitleFor( 'NewPages' );
+       public function execute( $par, $including ) {
+               global $wgLang, $wgGroupPermissions, $wgUser, $wgOut;
 
-               // show/hide links
-               $showhide = array( wfMsgHtml( 'show' ), wfMsgHtml( 'hide' ));
+               $this->showNavigation = !$including; // Maybe changed in setup
+               $this->setup( $par );
 
-               $hidelinks = array();
+               if( !$including ) {
+                       // Settings
+                       $this->form();
 
-               if ( $wgGroupPermissions['*']['createpage'] === true ) {
-                       $hidelinks['hideliu'] = 'rcshowhideliu';
-               }
-               if ( $wgUser->useNPPatrol() ) {
-                       $hidelinks['hidepatrolled'] = 'rcshowhidepatr';
+                       $this->setSyndicated();
+                       $feedType = $this->opts->getValue( 'feed' );
+                       if( $feedType ) {
+                               return $this->feed( $feedType, $options );
+                       }
                }
-               $hidelinks['hidebots'] = 'rcshowhidebots';
-
-               $defaults = array(
-            /* bool */ 'hideliu' => false,
-            /* bool */ 'hidepatrolled' => false,
-            /* bool */ 'hidebots' => false,
-            /* text */ 'namespace' => "0",
-            /* text */ 'username' => '',
-            /* int  */ 'offset' => 0,
-            /* int  */ 'limit' => 50,
-        );
-               $options = $defaults;
-               
-               // Override all values from requests, if specified
-        foreach ( $defaults as $v => $t ) {
-            if ( is_bool($t) ) {
-                $options[$v] = $wgRequest->getBool( $v, $options[$v] );
-            } elseif( is_int($t) ) {
-                $options[$v] = $wgRequest->getInt( $v, $options[$v] );
-            } elseif( is_string($t) ) {
-                $options[$v] = $wgRequest->getText( $v, $options[$v] );
-            }
-        }
-               
-               $wgOut->setSyndicated( true );
-               $wgOut->setFeedAppendQuery( "namespace={$options['namespace']}&username={$options['username']}" );
 
-               $feedType = $wgRequest->getVal( 'feed' );
-               if( $feedType ) {
-                       wfProfileOut( __METHOD__ );
-                       return $this->feed( $feedType, $options );
+               $pager = new NewPagesPager( $this, $this->opts );
+               $pager->mLimit = $this->opts->getValue( 'limit' );
+               $pager->mOffset = $this->opts->getValue( 'offset' );
+
+               if( $pager->getNumRows() ) {
+                       $navigation = '';
+                       if ( $this->showNavigation ) $navigation = $pager->getNavigationBar();
+                       $wgOut->addHTML( $navigation . $pager->getBody() . $navigation );
+               } else {
+                       $wgOut->addWikiMsg( 'specialpage-empty' );
                }
+       }
+
+       protected function filterLinks() {
+               global $wgGroupPermissions, $wgUser;
+
+               // show/hide links
+               $showhide = array( wfMsgHtml( 'show' ), wfMsgHtml( 'hide' ) );
 
-               $nondefaults = array();
-        foreach ( $options as $v => $t ) {
-            if ( $v === 'offset' ) continue; # Reset offset if parameters change
-            wfAppendToArrayIfNotDefault( $v, $t, $defaults, $nondefaults );
-        }
+               // Option value -> message mapping
+               $filters = array(
+                       'hideliu' => 'rcshowhideliu',
+                       'hidepatrolled' => 'rcshowhidepatr',
+                       'hidebots' => 'rcshowhidebots'
+               );
+
+               // Disable some if needed
+               if ( $wgGroupPermissions['*']['createpage'] !== true )
+                       unset($filters['hideliu']);
+
+               if ( !$wgUser->useNPPatrol() )
+                       unset($filters['hidepatrolled']);
 
                $links = array();
-               foreach ( $hidelinks as $key => $msg ) {
-                       $reversed = 1 - $options[$key];
-                       $link = $sk->makeKnownLinkObj( $self, $showhide[$reversed],
-                               wfArrayToCGI( array( $key => $reversed ), $nondefaults )
+               $changed = $this->opts->getChangedValues();
+               unset($changed['offset']); // Reset offset if query type changes
+
+               foreach ( $filters as $key => $msg ) {
+                       $onoff = 1 - $this->opts->getValue($key);
+                       $link = $this->skin->makeKnownLinkObj( $this->title, $showhide[$onoff],
+                               wfArrayToCGI( array( $key => $onoff ), $changed )
                        );
                        $links[$key] = wfMsgHtml( $msg, $link );
                }
 
-               $hl = implode( ' | ', $links );
+               return implode( ' | ', $links );
+       }
+
+       protected function form() {
+               global $wgOut, $wgEnableNewpagesUserFilter, $wgScript;
+
+               // Consume values
+               $this->opts->consumeValue( 'offset' ); // don't carry offset, DWIW
+               $namespace = $this->opts->consumeValue( 'namespace' );
+               $username = $this->opts->consumeValue( 'username' );
+
+               // Check username input validity
+               $ut = Title::makeTitleSafe( NS_USER, $username );
+               $userText = $ut ? $ut->getText() : '';
 
                // Store query values in hidden fields so that form submission doesn't lose them
                $hidden = array();
-               foreach ( $nondefaults as $key => $value ) {
-                       if ( $key === 'namespace' ) continue;
-                       if ( $key === 'username' ) continue;
+               foreach ( $this->opts->getUnconsumedValues() as $key => $value ) {
                        $hidden[] = Xml::hidden( $key, $value );
                }
                $hidden = implode( "\n", $hidden );
 
-               $form = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) .
-                       Xml::hidden( 'title', $self->getPrefixedDBkey() ) .
-                       Xml::openElement( 'fieldset' ) .
-                       Xml::element( 'legend', null, wfMsg( 'newpages' ) ) .
+               $form = Xml::openElement( 'form', array( 'action' => $wgScript ) ) .
+                       Xml::hidden( 'title', $this->title->getPrefixedDBkey() ) .
+                       Xml::fieldset( wfMsg( 'newpages' ) ) .
                        Xml::openElement( 'table', array( 'id' => 'mw-newpages-table' ) ) .
                        "<tr>
-                               <td align=\"$align\">" .
+                               <td class='mw-label'>" .
                                        Xml::label( wfMsg( 'namespace' ), 'namespace' ) .
                                "</td>
-                               <td>" .
-                                       Xml::namespaceSelector( $options['namespace'], 'all' ) .
+                               <td class='mw-input'>" .
+                                       Xml::namespaceSelector( $namespace, 'all' ) .
                                "</td>
-                       </tr>
-                       <tr>
-                               <td align=\"$align\">" .
+                       </tr>" .
+                       ($wgEnableNewpagesUserFilter ?
+                       "<tr>
+                               <td class='mw-label'>" .
                                        Xml::label( wfMsg( 'newpages-username' ), 'mw-np-username' ) .
                                "</td>
-                               <td>" .
-                                       Xml::input( 'username', 30, $options['username'], array( 'id' => 'mw-np-username' ) ) .
+                               <td class='mw-input'>" .
+                                       Xml::input( 'username', 30, $userText, array( 'id' => 'mw-np-username' ) ) .
                                "</td>
-                       </tr>
-                       <tr> <td></td>
-                               <td>" .
+                       </tr>" : "" ) .
+                       "<tr> <td></td>
+                               <td class='mw-submit'>" .
                                        Xml::submitButton( wfMsg( 'allpagessubmit' ) ) .
                                "</td>
                        </tr>" .
                        "<tr>
                                <td></td>
-                               <td>" .
-                                       $hl .
+                               <td class='mw-input'>" .
+                                       $this->filterLinks() .
                                "</td>
                        </tr>" .
                        Xml::closeElement( 'table' ) .
@@ -138,21 +214,18 @@ class NewPagesForm {
                        Xml::closeElement( 'form' );
 
                $wgOut->addHTML( $form );
+       }
 
-               $pager = new NewPagesPager( $this, array(), $options['namespace'], $options['hideliu'], 
-                       $options['hidepatrolled'], $options['hidebots'], $options['username'] );        
-
-               if( $pager->getNumRows() ) {
-                       $wgOut->addHTML( $pager->getNavigationBar() .
-                               $pager->getStartBody() .
-                               $pager->getBody() .
-                               $pager->getEndBody() .
-                               $pager->getNavigationBar() );
-               } else {
-                       $wgOut->addHTML( '<p>' . wfMsgHtml( 'specialpage-empty' ) . '</p>' );
-               }
+       protected function setSyndicated() {
+               global $wgOut;
+               $queryParams = array(
+                       'namespace' => $this->opts->getValue( 'namespace' ),
+                       'username' => $this->opts->getValue( 'username' )
+               );
+               $wgOut->setSyndicated( true );
+               $wgOut->setFeedAppendQuery( wfArrayToCGI( $queryParams ) );
        }
-       
+
        /**
         * Format a row, providing the timestamp, links to the page/history, size, user links, and a comment
         *
@@ -163,24 +236,19 @@ class NewPagesForm {
        public function formatRow( $result ) {
                global $wgLang, $wgContLang, $wgUser;
                $dm = $wgContLang->getDirMark();
-               
-               static $skin=null;
-
-               if( is_null( $skin ) )
-                       $skin = $wgUser->getSkin();
 
                $title = Title::makeTitleSafe( $result->rc_namespace, $result->rc_title );
                $time = $wgLang->timeAndDate( $result->rc_timestamp, true );
-               $plink = $skin->makeKnownLinkObj( $title, '', $this->patrollable( $result ) ? 'rcid=' . $result->rc_id : '' );
-               $hist = $skin->makeKnownLinkObj( $title, wfMsgHtml( 'hist' ), 'action=history' );
-               $length = wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ), 
-                       $wgLang->formatNum( htmlspecialchars( $result->length ) ) );
-               $ulink = $skin->userLink( $result->rc_user, $result->rc_user_text ) . ' ' . 
-                       $skin->userToolLinks( $result->rc_user, $result->rc_user_text );
-               $comment = $skin->commentBlock( $result->rc_comment );
-               $css = $this->patrollable( $result ) ? 'not-patrolled' : '';
-
-               return "<li class='$css'>{$time} {$dm}{$plink} ({$hist}) {$dm}[{$length}] {$dm}{$ulink} {$comment}</li>";
+               $plink = $this->skin->makeKnownLinkObj( $title, '', $this->patrollable( $result ) ? 'rcid=' . $result->rc_id : '' );
+               $hist = $this->skin->makeKnownLinkObj( $title, wfMsgHtml( 'hist' ), 'action=history' );
+               $length = wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ),
+                       $wgLang->formatNum( $result->length ) );
+               $ulink = $this->skin->userLink( $result->rc_user, $result->rc_user_text ) . ' ' .
+                       $this->skin->userToolLinks( $result->rc_user, $result->rc_user_text );
+               $comment = $this->skin->commentBlock( $result->rc_comment );
+               $css = $this->patrollable( $result ) ? " class='not-patrolled'" : '';
+
+               return "<li{$css}>{$time} {$dm}{$plink} ({$hist}) {$dm}[{$length}] {$dm}{$ulink} {$comment}</li>\n";
        }
 
        /**
@@ -193,37 +261,41 @@ class NewPagesForm {
                global $wgUser;
                return ( $wgUser->useNPPatrol() && !$result->rc_patrolled );
        }
-       
+
        /**
         * Output a subscription feed listing recent edits to this page.
         * @param string $type
         */
        protected function feed( $type, $options ) {
                require_once 'SpecialRecentchanges.php';
-               
+
                global $wgFeed, $wgFeedClasses;
-               
+
                if ( !$wgFeed ) {
                        global $wgOut;
                        $wgOut->addWikiMsg( 'feed-unavailable' );
                        return;
                }
-               
+
                if( !isset( $wgFeedClasses[$type] ) ) {
                        global $wgOut;
                        $wgOut->addWikiMsg( 'feed-invalid' );
                        return;
                }
-               
-               $self = SpecialPage::getTitleFor( 'NewPages' );
+
                $feed = new $wgFeedClasses[$type](
                        $this->feedTitle(),
                        wfMsg( 'tagline' ),
-                       $self->getFullUrl() );
+                       $this->title->getFullUrl() );
+
+               $pager = new NewPagesPager( $this, $this->opts );
+               $limit = $this->opts->getValue( 'limit' );
+               global $wgFeedLimit;
+               if( $limit > $wgFeedLimit ) {
+                       $limit = $wgFeedLimit;
+               }
+               $pager->mLimit = $limit;
 
-               $pager = new NewPagesPager( $this, array(), $options['namespace'], $options['hideliu'], 
-                       $options['hidepatrolled'], $options['hidebots'], $options['username'] );        
-               
                $feed->outHeader();
                if( $pager->getNumRows() > 0 ) {
                        while( $row = $pager->mResult->fetchObject() ) {
@@ -232,7 +304,7 @@ class NewPagesForm {
                }
                $feed->outFooter();
        }
-       
+
        protected function feedTitle() {
                global $wgContLanguageCode, $wgSitename;
                $page = SpecialPage::getPage( 'Newpages' );
@@ -257,84 +329,87 @@ class NewPagesForm {
                        return NULL;
                }
        }
-       
+
        /**
         * Quickie hack... strip out wikilinks to more legible form from the comment.
         */
-       function stripComment( $text ) {
+       protected function stripComment( $text ) {
                return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
        }
-       
-       function feedItemAuthor( $row ) {
+
+       protected function feedItemAuthor( $row ) {
                return isset( $row->rc_user_text ) ? $row->rc_user_text : '';
        }
-       
+
        protected function feedItemDesc( $row ) {
-               if( isset( $row->rev_id ) ) {
-                       $revision = Revision::newFromId( $row->rev_id );
-                       if( $revision ) {
-                               return '<p>' . htmlspecialchars( wfMsg( 'summary' ) ) . ': ' .
-                                       htmlspecialchars( $revision->getComment() ) . "</p>\n<hr />\n<div>" .
-                                       nl2br( htmlspecialchars( $revision->getText() ) ) . "</div>";
-                       }
+               $revision = Revision::newFromId( $row->rev_id );
+               if( $revision ) {
+                       return '<p>' . htmlspecialchars( $revision->getUserText() ) . ': ' .
+                               htmlspecialchars( $revision->getComment() ) . 
+                               "</p>\n<hr />\n<div>" .
+                               nl2br( htmlspecialchars( $revision->getText() ) ) . "</div>";
                }
                return '';
        }
 }
 
 /**
- * @addtogroup Pager
+ * @ingroup SpecialPage Pager
  */
 class NewPagesPager extends ReverseChronologicalPager {
-       private $hideliu, $hidepatrolled, $hidebots, $namespace, $user;
-       
-       function __construct( $form, $conds=array(), $namespace, $hliu=false, $hpatrolled=false, $hbots=1, $user='' ) {
+       // Stored opts
+       protected $opts, $mForm;
+
+       private $hideliu, $hidepatrolled, $hidebots, $namespace, $user, $spTitle;
+
+       function __construct( $form, FormOptions $opts ) {
                parent::__construct();
                $this->mForm = $form;
-               $this->mConds = $conds;
-               
-               $this->namespace = ($namespace === "all") ? false : intval($namespace);
-               $this->user = $user;
-               
-               $this->hideliu = (bool)$hliu;
-               $this->hidepatrolled = (bool)$hpatrolled;
-               $this->hidebots = (bool)$hbots;
+               $this->opts = $opts;
+       }
+
+       function getTitle(){
+               static $title = null;
+               if ( $title === null )
+                       $title = SpecialPage::getTitleFor( 'Newpages' );
+               return $title;
        }
 
        function getQueryInfo() {
-               $conds = $this->mConds;
+               global $wgEnableNewpagesUserFilter, $wgGroupPermissions, $wgUser;
+               $conds = array();
                $conds['rc_new'] = 1;
-               if( $this->namespace !== false ) {
-                       $conds['rc_namespace'] = $this->namespace;
-                       $rcIndexes = array( 'new_name_timestamp', 'rc_timestamp', 'rc_user_text' );
+
+               $namespace = $this->opts->getValue( 'namespace' );
+               $namespace = ( $namespace === 'all' ) ? false : intval( $namespace );
+
+               $username = $this->opts->getValue( 'username' );
+               $user = Title::makeTitleSafe( NS_USER, $username );
+
+               if( $namespace !== false ) {
+                       $conds['rc_namespace'] = $namespace;
+                       $rcIndexes = array( 'new_name_timestamp' );
                } else {
-                       $rcIndexes = array( 'rc_timestamp', 'rc_user_text' );
+                       $rcIndexes = array( 'rc_timestamp' );
                }
                $conds[] = 'page_id = rc_cur_id';
                $conds['page_is_redirect'] = 0;
-               
-               global $wgGroupPermissions, $wgUser;
-               # If anons cannot make new pages, don't query for it!
-               if( $wgGroupPermissions['*']['createpage'] && $this->hideliu ) {
+               # $wgEnableNewpagesUserFilter - temp WMF hack
+               if( $wgEnableNewpagesUserFilter && $user ) {
+                       $conds['rc_user_text'] = $user->getText();
+                       $rcIndexes = 'rc_user_text';
+               # If anons cannot make new pages, don't "exclude logged in users"!
+               } elseif( $wgGroupPermissions['*']['createpage'] && $this->opts->getValue( 'hideliu' ) ) {
                        $conds['rc_user'] = 0;
-               } else {
-                       $title = Title::makeTitleSafe( NS_USER, $this->user );
-                       if( $title ) {
-                               $conds['rc_user_text'] = $title->getText();
-                       }
                }
                # If this user cannot see patrolled edits or they are off, don't do dumb queries!
-               if( $this->hidepatrolled && $wgUser->useNPPatrol() ) {
+               if( $this->opts->getValue( 'hidepatrolled' ) && $wgUser->useNPPatrol() ) {
                        $conds['rc_patrolled'] = 0;
                }
-               if( $this->hidebots ) {
+               if( $this->opts->getValue( 'hidebots' ) ) {
                        $conds['rc_bot'] = 0;
                }
 
-               if( $this->user ) {
-                       $conds['rc_user_text'] = $this->user;
-               }
-
                return array(
                        'tables' => array( 'recentchanges', 'page' ),
                        'fields' => 'rc_namespace,rc_title, rc_cur_id, rc_user,rc_user_text,rc_comment,
@@ -351,7 +426,7 @@ class NewPagesPager extends ReverseChronologicalPager {
        function formatRow( $row ) {
                return $this->mForm->formatRow( $row );
        }
-       
+
        function getStartBody() {
                # Do a batch existence check on pages
                $linkBatch = new LinkBatch();