]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/parser/CoreParserFunctions.php
MediaWiki 1.16.0
[autoinstallsdev/mediawiki.git] / includes / parser / CoreParserFunctions.php
index a3b5189a31489a5ad138288c42e76ec81363da1f..8abcc04f404f2aae3dc1afcbfee982eeb4edd1b6 100644 (file)
@@ -16,6 +16,7 @@ class CoreParserFunctions {
 
                $parser->setFunctionHook( 'int',              array( __CLASS__, 'intFunction'      ), SFH_NO_HASH );
                $parser->setFunctionHook( 'ns',               array( __CLASS__, 'ns'               ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'nse',              array( __CLASS__, 'nse'              ), SFH_NO_HASH );
                $parser->setFunctionHook( 'urlencode',        array( __CLASS__, 'urlencode'        ), SFH_NO_HASH );
                $parser->setFunctionHook( 'lcfirst',          array( __CLASS__, 'lcfirst'          ), SFH_NO_HASH );
                $parser->setFunctionHook( 'ucfirst',          array( __CLASS__, 'ucfirst'          ), SFH_NO_HASH );
@@ -27,9 +28,11 @@ class CoreParserFunctions {
                $parser->setFunctionHook( 'fullurle',         array( __CLASS__, 'fullurle'         ), SFH_NO_HASH );
                $parser->setFunctionHook( 'formatnum',        array( __CLASS__, 'formatnum'        ), SFH_NO_HASH );
                $parser->setFunctionHook( 'grammar',          array( __CLASS__, 'grammar'          ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'gender',           array( __CLASS__, 'gender'           ), SFH_NO_HASH );
                $parser->setFunctionHook( 'plural',           array( __CLASS__, 'plural'           ), SFH_NO_HASH );
                $parser->setFunctionHook( 'numberofpages',    array( __CLASS__, 'numberofpages'    ), SFH_NO_HASH );
                $parser->setFunctionHook( 'numberofusers',    array( __CLASS__, 'numberofusers'    ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'numberofactiveusers', array( __CLASS__, 'numberofactiveusers' ), SFH_NO_HASH );
                $parser->setFunctionHook( 'numberofarticles', array( __CLASS__, 'numberofarticles' ), SFH_NO_HASH );
                $parser->setFunctionHook( 'numberoffiles',    array( __CLASS__, 'numberoffiles'    ), SFH_NO_HASH );
                $parser->setFunctionHook( 'numberofadmins',   array( __CLASS__, 'numberofadmins'   ), SFH_NO_HASH );
@@ -45,7 +48,27 @@ class CoreParserFunctions {
                $parser->setFunctionHook( 'filepath',         array( __CLASS__, 'filepath'         ), SFH_NO_HASH );
                $parser->setFunctionHook( 'pagesincategory',  array( __CLASS__, 'pagesincategory'  ), SFH_NO_HASH );
                $parser->setFunctionHook( 'pagesize',         array( __CLASS__, 'pagesize'         ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'protectionlevel',  array( __CLASS__, 'protectionlevel'  ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'namespace',        array( __CLASS__, 'mwnamespace'      ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'namespacee',       array( __CLASS__, 'namespacee'       ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'talkspace',        array( __CLASS__, 'talkspace'        ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'talkspacee',       array( __CLASS__, 'talkspacee'       ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'subjectspace',     array( __CLASS__, 'subjectspace'     ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'subjectspacee',    array( __CLASS__, 'subjectspacee'    ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'pagename',         array( __CLASS__, 'pagename'         ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'pagenamee',        array( __CLASS__, 'pagenamee'        ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'fullpagename',     array( __CLASS__, 'fullpagename'     ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'fullpagenamee',    array( __CLASS__, 'fullpagenamee'    ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'basepagename',     array( __CLASS__, 'basepagename'     ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'basepagenamee',    array( __CLASS__, 'basepagenamee'    ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'subpagename',      array( __CLASS__, 'subpagename'      ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'subpagenamee',     array( __CLASS__, 'subpagenamee'     ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'talkpagename',     array( __CLASS__, 'talkpagename'     ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'talkpagenamee',    array( __CLASS__, 'talkpagenamee'    ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'subjectpagename',  array( __CLASS__, 'subjectpagename'  ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'subjectpagenamee', array( __CLASS__, 'subjectpagenamee' ), SFH_NO_HASH );
                $parser->setFunctionHook( 'tag',              array( __CLASS__, 'tagObj'           ), SFH_OBJECT_ARGS );
+               $parser->setFunctionHook( 'formatdate',       array( __CLASS__, 'formatDate'       ) );
 
                if ( $wgAllowDisplayTitle ) {
                        $parser->setFunctionHook( 'displaytitle', array( __CLASS__, 'displaytitle' ), SFH_NO_HASH );
@@ -67,6 +90,22 @@ class CoreParserFunctions {
                }
        }
 
+       static function formatDate( $parser, $date, $defaultPref = null ) {
+               $df = DateFormatter::getInstance();
+
+               $date = trim( $date );
+
+               $pref = $parser->mOptions->getDateFormat();
+
+               // Specify a different default date format other than the the normal default
+               // iff the user has 'default' for their setting
+               if ( $pref == 'default' && $defaultPref )
+                       $pref = $defaultPref;
+
+               $date = $df->reformat( $pref, $date, array( 'match-whole' ) );
+               return $date;
+       }
+
        static function ns( $parser, $part1 = '' ) {
                global $wgContLang;
                if ( intval( $part1 ) || $part1 == "0" ) {
@@ -81,6 +120,10 @@ class CoreParserFunctions {
                }
        }
 
+       static function nse( $parser, $part1 = '' ) {
+               return wfUrlencode( str_replace( ' ', '_', self::ns( $parser, $part1 ) ) );
+       }
+
        static function urlencode( $parser, $s = '' ) {
                return urlencode( $s );
        }
@@ -125,11 +168,11 @@ class CoreParserFunctions {
                # and the variable will fail. If we can't get a decent title from the first
                # attempt, url-decode and try for a second.
                if( is_null( $title ) )
-                       $title = Title::newFromUrl( urldecode( $s ) );
+                       $title = Title::newFromURL( urldecode( $s ) );
                if( !is_null( $title ) ) {
                        # Convert NS_MEDIA -> NS_FILE
                        if( $title->getNamespace() == NS_MEDIA ) {
-                               $title = Title::makeTitle( NS_FILE, $title->getDBKey() );
+                               $title = Title::makeTitle( NS_FILE, $title->getDBkey() );
                        }
                        if( !is_null( $arg ) ) {
                                $text = $title->$func( $arg );
@@ -154,8 +197,33 @@ class CoreParserFunctions {
                return $parser->getFunctionLang()->convertGrammar( $word, $case );
        }
 
-       static function plural( $parser, $text = '') {
+       static function gender( $parser, $user ) {
+               wfProfileIn( __METHOD__ );
                $forms = array_slice( func_get_args(), 2);
+
+               // default
+               $gender = User::getDefaultOption( 'gender' );
+
+               // allow prefix.
+               $title = Title::newFromText( $user );
+
+               if ( is_object( $title ) && $title->getNamespace() == NS_USER )
+                       $user = $title->getText();
+
+               // check parameter, or use $wgUser if in interface message
+               $user = User::newFromName( $user );
+               if ( $user ) {
+                       $gender = $user->getOption( 'gender' );
+               } elseif ( $parser->mOptions->getInterfaceMessage() ) {
+                       global $wgUser;
+                       $gender = $wgUser->getOption( 'gender' );
+               }
+               $ret = $parser->getFunctionLang()->gender( $gender, $forms );
+               wfProfileOut( __METHOD__ );
+               return $ret;
+       }
+       static function plural( $parser, $text = '' ) {
+               $forms = array_slice( func_get_args(), 2 );
                $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
                return $parser->getFunctionLang()->convertPlural( $text, $forms );
        }
@@ -164,21 +232,39 @@ class CoreParserFunctions {
         * Override the title of the page when viewed, provided we've been given a
         * title which will normalise to the canonical title
         *
-        * @param Parser $parser Parent parser
-        * @param string $text Desired title text
-        * @return string
+        * @param $parser Parser: parent parser
+        * @param $text String: desired title text
+        * @return String
         */
        static function displaytitle( $parser, $text = '' ) {
                global $wgRestrictDisplayTitle;
-               $text = trim( Sanitizer::decodeCharReferences( $text ) );
 
-               if ( !$wgRestrictDisplayTitle ) {
+               #parse a limited subset of wiki markup (just the single quote items)
+               $text = $parser->doQuotes( $text );
+
+               #remove stripped text (e.g. the UNIQ-QINU stuff) that was generated by tag extensions/whatever
+               $text = preg_replace( '/' . preg_quote( $parser->uniqPrefix(), '/' ) . '.*?'
+                       . preg_quote( Parser::MARKER_SUFFIX, '/' ) . '/', '', $text );
+
+               #list of disallowed tags for DISPLAYTITLE
+               #these will be escaped even though they are allowed in normal wiki text
+               $bad = array( 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'div', 'blockquote', 'ol', 'ul', 'li', 'hr',
+                       'table', 'tr', 'th', 'td', 'dl', 'dd', 'caption', 'p', 'ruby', 'rb', 'rt', 'rp', 'br' );
+
+               #only requested titles that normalize to the actual title are allowed through
+               #if $wgRestrictDisplayTitle is true (it is by default)
+               #mimic the escaping process that occurs in OutputPage::setPageTitle
+               $text = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $text, null, array(), array(), $bad ) );
+               $title = Title::newFromText( Sanitizer::stripAllTags( $text ) );
+
+               if( !$wgRestrictDisplayTitle ) {
                        $parser->mOutput->setDisplayTitle( $text );
                } else {
-                       $title = Title::newFromText( $text );
-                       if( $title instanceof Title && $title->getFragment() == '' && $title->equals( $parser->mTitle ) )
+                       if ( $title instanceof Title && $title->getFragment() == '' && $title->equals( $parser->mTitle ) ) {
                                $parser->mOutput->setDisplayTitle( $text );
+                       }
                }
+
                return '';
        }
 
@@ -208,6 +294,9 @@ class CoreParserFunctions {
        static function numberofusers( $parser, $raw = null ) {
                return self::formatRaw( SiteStats::users(), $raw );
        }
+       static function numberofactiveusers( $parser, $raw = null ) {
+               return self::formatRaw( SiteStats::activeUsers(), $raw );
+       }
        static function numberofarticles( $parser, $raw = null ) {
                return self::formatRaw( SiteStats::articles(), $raw );
        }
@@ -228,7 +317,127 @@ class CoreParserFunctions {
        }
        static function numberingroup( $parser, $name = '', $raw = null) {
                return self::formatRaw( SiteStats::numberingroup( strtolower( $name ) ), $raw );
-       } 
+       }
+
+
+       /**
+        * Given a title, return the namespace name that would be given by the
+        * corresponding magic word
+        * Note: function name changed to "mwnamespace" rather than "namespace"
+        * to not break PHP 5.3
+        */
+       static function mwnamespace( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return str_replace( '_', ' ', $t->getNsText() );
+       }
+       static function namespacee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return wfUrlencode( $t->getNsText() );
+       }
+       static function talkspace( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) || !$t->canTalk() )
+                       return '';
+               return str_replace( '_', ' ', $t->getTalkNsText() );
+       }
+       static function talkspacee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) || !$t->canTalk() )
+                       return '';
+               return wfUrlencode( $t->getTalkNsText() );
+       }
+       static function subjectspace( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return str_replace( '_', ' ', $t->getSubjectNsText() );
+       }
+       static function subjectspacee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return wfUrlencode( $t->getSubjectNsText() );
+       }
+       /*
+        * Functions to get and normalize pagenames, corresponding to the magic words
+        * of the same names
+       */
+       static function pagename( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return wfEscapeWikiText( $t->getText() );
+       }
+       static function pagenamee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return $t->getPartialURL();
+       }
+       static function fullpagename( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) || !$t->canTalk() )
+                       return '';
+               return wfEscapeWikiText( $t->getPrefixedText() );
+       }
+       static function fullpagenamee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) || !$t->canTalk() )
+                       return '';
+               return $t->getPrefixedURL();
+       }
+       static function subpagename( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return $t->getSubpageText();
+       }
+       static function subpagenamee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return $t->getSubpageUrlForm();
+       }
+       static function basepagename( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return $t->getBaseText();
+       }
+       static function basepagenamee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return wfUrlEncode( str_replace( ' ', '_', $t->getBaseText() ) );
+       }
+       static function talkpagename( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) || !$t->canTalk() )
+                       return '';
+               return wfEscapeWikiText( $t->getTalkPage()->getPrefixedText() );
+       }
+       static function talkpagenamee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) || !$t->canTalk() )
+                       return '';
+               return $t->getTalkPage()->getPrefixedUrl();
+       }
+       static function subjectpagename( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedText() );
+       }
+       static function subjectpagenamee( $parser, $title = null ) {
+               $t = Title::newFromText( $title );
+               if ( is_null( $t ) )
+                       return '';
+               return $t->getSubjectPage()->getPrefixedUrl();
+       }
 
        /**
         * Return the number of pages in the given category, or 0 if it's nonexis-
@@ -260,16 +469,16 @@ class CoreParserFunctions {
         * Return the size of the given page, or 0 if it's nonexistent.  This is an
         * expensive parser function and can't be called too many times per page.
         *
-        * @FIXME This doesn't work correctly on preview for getting the size of
-        *   the current page.
-        * @FIXME Title::getLength() documentation claims that it adds things to
-        *   the link cache, so the local cache here should be unnecessary, but in
-        *   fact calling getLength() repeatedly for the same $page does seem to
+        * @todo Fixme: This doesn't work correctly on preview for getting the size
+        *   of the current page.
+        * @todo Fixme: Title::getLength() documentation claims that it adds things
+        *   to the link cache, so the local cache here should be unnecessary, but
+        *   in fact calling getLength() repeatedly for the same $page does seem to
         *   run one query for each call?
         */
        static function pagesize( $parser, $page = '', $raw = null ) {
                static $cache = array();
-               $title = Title::newFromText($page);
+               $title = Title::newFromText( $page );
 
                if( !is_object( $title ) ) {
                        $cache[$page] = 0;
@@ -283,36 +492,64 @@ class CoreParserFunctions {
                if( isset( $cache[$page] ) ) {
                        $length = $cache[$page];
                } elseif( $parser->incrementExpensiveFunctionCount() ) {
-                       $rev = Revision::newFromTitle($title);
+                       $rev = Revision::newFromTitle( $title );
                        $id = $rev ? $rev->getPage() : 0;
                        $length = $cache[$page] = $rev ? $rev->getSize() : 0;
-       
+
                        // Register dependency in templatelinks
                        $parser->mOutput->addTemplate( $title, $id, $rev ? $rev->getId() : 0 );
-               }       
+               }
                return self::formatRaw( $length, $raw );
        }
 
+       /**
+       * Returns the requested protection level for the current page
+       */
+       static function protectionlevel( $parser, $type = '' ) {
+               $restrictions = $parser->mTitle->getRestrictions( strtolower( $type ) );
+               # Title::getRestrictions returns an array, its possible it may have
+               # multiple values in the future
+               return implode( $restrictions, ',' );
+       }
+
        static function language( $parser, $arg = '' ) {
                global $wgContLang;
                $lang = $wgContLang->getLanguageName( strtolower( $arg ) );
                return $lang != '' ? $lang : $arg;
        }
 
-       static function pad( $string = '', $length = 0, $char = 0, $direction = STR_PAD_RIGHT ) {
-               $length = min( max( $length, 0 ), 500 );
-               $char = substr( $char, 0, 1 );
-               return ( $string !== '' && (int)$length > 0 && strlen( trim( (string)$char ) ) > 0 )
-                               ? str_pad( $string, $length, (string)$char, $direction )
-                               : $string;
+       /**
+        * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
+        */
+       static function pad( $string, $length, $padding = '0', $direction = STR_PAD_RIGHT ) {
+               $lengthOfPadding = mb_strlen( $padding );
+               if ( $lengthOfPadding == 0 ) return $string;
+
+               # The remaining length to add counts down to 0 as padding is added
+               $length = min( $length, 500 ) - mb_strlen( $string );
+               # $finalPadding is just $padding repeated enough times so that
+               # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
+               $finalPadding = '';
+               while ( $length > 0 ) {
+                       # If $length < $lengthofPadding, truncate $padding so we get the
+                       # exact length desired.
+                       $finalPadding .= mb_substr( $padding, 0, $length );
+                       $length -= $lengthOfPadding;
+               }
+
+               if ( $direction == STR_PAD_LEFT ) {
+                       return $finalPadding . $string;
+               } else {
+                       return $string . $finalPadding;
+               }
        }
 
-       static function padleft( $parser, $string = '', $length = 0, $char = 0 ) {
-               return self::pad( $string, $length, $char, STR_PAD_LEFT );
+       static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
+               return self::pad( $string, $length, $padding, STR_PAD_LEFT );
        }
 
-       static function padright( $parser, $string = '', $length = 0, $char = 0 ) {
-               return self::pad( $string, $length, $char );
+       static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
+               return self::pad( $string, $length, $padding );
        }
 
        static function anchorencode( $parser, $text ) {