Moved some of the functionality from mediawiki.legacy.prefs into mediawiki.specials...
[lhc/web/wiklou.git] / includes / specials / SpecialProtectedpages.php
index 2ff423b..2b01412 100644 (file)
@@ -1,24 +1,45 @@
 <?php
 /**
+ * Implements Special:Protectedpages
+ *
+ * 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
  * @ingroup SpecialPage
  */
 
 /**
- * @todo document
+ * A special page that lists protected pages
+ *
  * @ingroup SpecialPage
  */
-class ProtectedPagesForm {
+class SpecialProtectedpages extends SpecialPage {
 
        protected $IdLevel = 'level';
        protected $IdType  = 'type';
 
-       public function showList( $msg = '' ) {
+       public function __construct() {
+               parent::__construct( 'Protectedpages' );
+       }
+
+       public function execute( $par ) {
                global $wgOut, $wgRequest;
 
-               if( "" != $msg ) {
-                       $wgOut->setSubtitle( $msg );
-               }
+               $this->setHeaders();
+               $this->outputHeader();
 
                // Purge expired entries on one in every 10 queries
                if( !mt_rand( 0, 10 ) ) {
@@ -65,7 +86,7 @@ class ProtectedPagesForm {
                        $skin = $wgUser->getSkin();
 
                $title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
-               $link = $skin->makeLinkObj( $title );
+               $link = $skin->link( $title );
 
                $description_items = array ();
 
@@ -86,7 +107,7 @@ class ProtectedPagesForm {
                        $expiry_description = wfMsg( 'protect-expiring' , $wgLang->timeanddate( $expiry ) , 
                                $wgLang->date( $expiry ) , $wgLang->time( $expiry ) );
 
-                       $description_items[] = $expiry_description;
+                       $description_items[] = htmlspecialchars($expiry_description);
                }
 
                if(!is_null($size = $row->page_len)) {
@@ -95,46 +116,60 @@ class ProtectedPagesForm {
 
                # Show a link to the change protection form for allowed users otherwise a link to the protection log
                if( $wgUser->isAllowed( 'protect' ) ) {
-                       $changeProtection = ' (' . $skin->makeKnownLinkObj( $title, wfMsgHtml( 'protect_change' ),
-                               'action=unprotect' ) . ')';
+                       $changeProtection = ' (' . $skin->linkKnown(
+                               $title,
+                               wfMsgHtml( 'protect_change' ),
+                               array(),
+                               array( 'action' => 'unprotect' )
+                       ) . ')';
                } else {
                        $ltitle = SpecialPage::getTitleFor( 'Log' );
-                       $changeProtection = ' (' . $skin->makeKnownLinkObj( $ltitle, wfMsgHtml( 'protectlogpage' ), 
-                               'type=protect&page=' . $title->getPrefixedUrl() ) . ')';
+                       $changeProtection = ' (' . $skin->linkKnown(
+                               $ltitle,
+                               wfMsgHtml( 'protectlogpage' ),
+                               array(),
+                               array(
+                                       'type' => 'protect',
+                                       'page' => $title->getPrefixedText()
+                               )
+                       ) . ')';
                }
 
                wfProfileOut( __METHOD__ );
 
-               return '<li>' . wfSpecialList( $link . $stxt, implode( $description_items, ', ' ) ) . $changeProtection . "</li>\n";
+               return Html::rawElement(
+                       'li',
+                       array(),
+                       wfSpecialList( $link . $stxt, $wgLang->commaList( $description_items ) ) . $changeProtection ) . "\n";
        }
 
        /**
-        * @param $namespace int
-        * @param $type string
-        * @param $level string
-        * @param $minsize int
-        * @param $indefOnly bool
-        * @param $cascadeOnly bool
-        * @return string Input form
-        * @private
+        * @param $namespace Integer
+        * @param $type String: restriction type
+        * @param $level String: restriction level
+        * @param $sizetype String: "min" or "max"
+        * @param $size Integer
+        * @param $indefOnly Boolean: only indefinie protection
+        * @param $cascadeOnly Boolean: only cascading protection
+        * @return String: input form
         */
        protected function showOptions( $namespace, $type='edit', $level, $sizetype, $size, $indefOnly, $cascadeOnly ) {
                global $wgScript;
-               $title = SpecialPage::getTitleFor( 'ProtectedPages' );
+               $title = SpecialPage::getTitleFor( 'Protectedpages' );
                return Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) .
                        Xml::openElement( 'fieldset' ) .
                        Xml::element( 'legend', array(), wfMsg( 'protectedpages' ) ) .
                        Xml::hidden( 'title', $title->getPrefixedDBkey() ) . "\n" .
-                       $this->getNamespaceMenu( $namespace ) . "&nbsp;\n" .
-                       $this->getTypeMenu( $type ) . "&nbsp;\n" .
-                       $this->getLevelMenu( $level ) . "&nbsp;\n" .
-                       "<br/><span style='white-space: nowrap'>" .
-                       $this->getExpiryCheck( $indefOnly ) . "&nbsp;\n" .
-                       $this->getCascadeCheck( $cascadeOnly ) . "&nbsp;\n" .
-                       "</span><br/><span style='white-space: nowrap'>" .
-                       $this->getSizeLimit( $sizetype, $size ) . "&nbsp;\n" .
+                       $this->getNamespaceMenu( $namespace ) . "&#160;\n" .
+                       $this->getTypeMenu( $type ) . "&#160;\n" .
+                       $this->getLevelMenu( $level ) . "&#160;\n" .
+                       "<br /><span style='white-space: nowrap'>" .
+                       $this->getExpiryCheck( $indefOnly ) . "&#160;\n" .
+                       $this->getCascadeCheck( $cascadeOnly ) . "&#160;\n" .
+                       "</span><br /><span style='white-space: nowrap'>" .
+                       $this->getSizeLimit( $sizetype, $size ) . "&#160;\n" .
                        "</span>" .
-                       "&nbsp;" . Xml::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" .
+                       "&#160;" . Xml::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" .
                        Xml::closeElement( 'fieldset' ) .
                        Xml::closeElement( 'form' );
        }
@@ -143,12 +178,12 @@ class ProtectedPagesForm {
         * Prepare the namespace filter drop-down; standard namespace
         * selector, sans the MediaWiki namespace
         *
-        * @param mixed $namespace Pre-select namespace
-        * @return string
+        * @param $namespace Mixed: pre-select namespace
+        * @return String
         */
        protected function getNamespaceMenu( $namespace = null ) {
                return "<span style='white-space: nowrap'>" .
-                       Xml::label( wfMsg( 'namespace' ), 'namespace' ) . '&nbsp;'
+                       Xml::label( wfMsg( 'namespace' ), 'namespace' ) . '&#160;'
                        . Xml::namespaceSelector( $namespace, '' ) . "</span>";
        }
 
@@ -176,15 +211,17 @@ class ProtectedPagesForm {
 
                return
                        Xml::radioLabel( wfMsg('minimum-size'), 'sizetype', 'min', 'wpmin', !$max ) .
-                       '&nbsp;' .
+                       '&#160;' .
                        Xml::radioLabel( wfMsg('maximum-size'), 'sizetype', 'max', 'wpmax', $max ) .
-                       '&nbsp;' .
+                       '&#160;' .
                        Xml::input( 'size', 9, $size, array( 'id' => 'wpsize' ) ) .
-                       '&nbsp;' .
+                       '&#160;' .
                        Xml::label( wfMsg('pagesize'), 'wpsize' );
        }
 
        /**
+        * Creates the input label of the restriction type
+        * @param $pr_type string Protection type
         * @return string Formatted HTML
         */
        protected function getTypeMenu( $pr_type ) {
@@ -206,13 +243,15 @@ class ProtectedPagesForm {
                }
 
                return "<span style='white-space: nowrap'>" .
-                       Xml::label( wfMsg('restriction-type') , $this->IdType ) . '&nbsp;' .
+                       Xml::label( wfMsg('restriction-type') , $this->IdType ) . '&#160;' .
                        Xml::tags( 'select',
                                array( 'id' => $this->IdType, 'name' => $this->IdType ),
                                implode( "\n", $options ) ) . "</span>";
        }
 
        /**
+        * Creates the input label of the restriction level
+        * @param $pr_level string Protection level
         * @return string Formatted HTML
         */
        protected function getLevelMenu( $pr_level ) {
@@ -223,6 +262,7 @@ class ProtectedPagesForm {
 
                // First pass to load the log names
                foreach( $wgRestrictionLevels as $type ) {
+                       // Messages used can be 'restriction-level-sysop' and 'restriction-level-autoconfirmed'
                        if( $type !='' && $type !='*') {
                                $text = wfMsg("restriction-level-$type");
                                $m[$text] = $type;
@@ -235,11 +275,11 @@ class ProtectedPagesForm {
                        $options[] = Xml::option( $text, $type, $selected );
                }
 
-               return
-                       Xml::label( wfMsg('restriction-level') , $this->IdLevel ) . '&nbsp;' .
+               return "<span style='white-space: nowrap'>" .
+                       Xml::label( wfMsg( 'restriction-level' ) , $this->IdLevel ) . ' ' .
                        Xml::tags( 'select',
                                array( 'id' => $this->IdLevel, 'name' => $this->IdLevel ),
-                               implode( "\n", $options ) );
+                               implode( "\n", $options ) ) . "</span>";
        }
 }
 
@@ -282,7 +322,8 @@ class ProtectedPagesPager extends AlphabeticPager {
 
        function getQueryInfo() {
                $conds = $this->mConds;
-               $conds[] = 'pr_expiry>' . $this->mDb->addQuotes( $this->mDb->timestamp() );
+               $conds[] = '(pr_expiry>' . $this->mDb->addQuotes( $this->mDb->timestamp() ) .
+                               'OR pr_expiry IS NULL)';
                $conds[] = 'page_id=pr_page';
                $conds[] = 'pr_type=' . $this->mDb->addQuotes( $this->type );
                
@@ -314,11 +355,3 @@ class ProtectedPagesPager extends AlphabeticPager {
                return 'pr_id';
        }
 }
-
-/**
- * Constructor
- */
-function wfSpecialProtectedpages() {
-       $ppForm = new ProtectedPagesForm();
-       $ppForm->showList();
-}