Added missing GPLv2 headers in some places.
[lhc/web/wiklou.git] / includes / SkinTemplate.php
index ff76653..9807237 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * Base class for template-based skins
+ * Base class for template-based skins.
  *
  * 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
@@ -177,7 +177,6 @@ class SkinTemplate extends Skin {
                $this->thisquery = wfArrayToCGI( $query );
                $this->loggedin = $user->isLoggedIn();
                $this->username = $user->getName();
-               $this->userdisplayname = $user->getDisplayName();
 
                if ( $this->loggedin || $this->showIPinHeader() ) {
                        $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
@@ -217,7 +216,7 @@ class SkinTemplate extends Skin {
                $tpl->setRef( 'thispage', $this->thispage );
                $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
                $tpl->set( 'titletext', $title->getText() );
-               $tpl->set( 'articleid', $title->getArticleId() );
+               $tpl->set( 'articleid', $title->getArticleID() );
 
                $tpl->set( 'isarticle', $out->isArticle() );
 
@@ -288,7 +287,6 @@ class SkinTemplate extends Skin {
                $tpl->set( 'capitalizeallnouns', $lang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
                $tpl->set( 'showjumplinks', $user->getOption( 'showjumplinks' ) );
                $tpl->set( 'username', $this->loggedin ? $this->username : null );
-               $tpl->set( 'userdisplayname', $this->loggedin ? $this->userdisplayname : null );
                $tpl->setRef( 'userpage', $this->userpage );
                $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
                $tpl->set( 'userlang', $userlang );
@@ -399,18 +397,23 @@ class SkinTemplate extends Skin {
                $tpl->set( 'bottomscripts', $this->bottomScripts() );
                $tpl->set( 'printfooter', $this->printSource() );
 
-               # Add a <div class="mw-content-ltr/rtl"> around the body text
+               # An ID that includes the actual body text; without categories, contentSub, ...
+               $realBodyAttribs = array( 'id' => 'mw-content-text' );
+
+               # Add a mw-content-ltr/rtl class to be able to style based on text direction
+               # when the content is different from the UI language, i.e.:
                # not for special pages or file pages AND only when viewing AND if the page exists
                # (or is in MW namespace, because that has default content)
                if( !in_array( $title->getNamespace(), array( NS_SPECIAL, NS_FILE ) ) &&
                        in_array( $request->getVal( 'action', 'view' ), array( 'view', 'historysubmit' ) ) &&
                        ( $title->exists() || $title->getNamespace() == NS_MEDIAWIKI ) ) {
                        $pageLang = $title->getPageLanguage();
-                       $realBodyAttribs = array( 'lang' => $pageLang->getHtmlCode(), 'dir' => $pageLang->getDir(),
-                               'class' => 'mw-content-'.$pageLang->getDir() );
-                       $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
+                       $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
+                       $realBodyAttribs['dir'] = $pageLang->getDir();
+                       $realBodyAttribs['class'] = 'mw-content-'.$pageLang->getDir();
                }
 
+               $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
                $tpl->setRef( 'bodytext', $out->mBodytext );
 
                # Language links
@@ -425,8 +428,8 @@ class SkinTemplate extends Skin {
                                if ( $nt ) {
                                        $language_urls[] = array(
                                                'href' => $nt->getFullURL(),
-                                               'text' => ( $wgContLang->getLanguageName( $nt->getInterwiki() ) != '' ?
-                                                                       $wgContLang->getLanguageName( $nt->getInterwiki() ) : $l ),
+                                               'text' => ( Language::fetchLanguageName( $nt->getInterwiki() ) != '' ?
+                                                                       Language::fetchLanguageName( $nt->getInterwiki() ) : $l ),
                                                'title' => $nt->getText(),
                                                'class' => $class,
                                                'lang' => $nt->getInterwiki(),
@@ -457,7 +460,7 @@ class SkinTemplate extends Skin {
                if ( $this->useHeadElement ) {
                        $tpl->set( 'headelement', $out->headElement( $this ) );
                } else {
-                       $tpl->set( 'headscripts', $out->getScript() );
+                       $tpl->set( 'headscripts', $out->getHeadScripts() . $out->getHeadItems() );
                }
 
                $tpl->set( 'debughtml', $this->generateDebugHTML() );
@@ -515,6 +518,7 @@ class SkinTemplate extends Skin {
         * This is setup as a method so that like with $wgLogo and getLogo() a skin
         * can override this setting and always output one or the other if it has
         * a reason it can't output one of the two modes.
+        * @return bool
         */
        function useCombinedLoginLink() {
                global $wgUseCombinedLoginLink;
@@ -551,7 +555,7 @@ class SkinTemplate extends Skin {
                $returnto = wfArrayToCGI( $a );
                if( $this->loggedin ) {
                        $personal_urls['userpage'] = array(
-                               'text' => $this->userdisplayname,
+                               'text' => $this->username,
                                'href' => &$this->userpageUrlDetails['href'],
                                'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
                                'active' => ( $this->userpageUrlDetails['href'] == $pageurl )
@@ -577,10 +581,12 @@ class SkinTemplate extends Skin {
                        );
 
                        # We need to do an explicit check for Special:Contributions, as we
-                       # have to match both the title, and the target (which could come
-                       # from request values or be specified in "sub page" form. The plot
-                       # thickens, because $wgTitle is altered for special pages, so doesn't
-                       # contain the original alias-with-subpage.
+                       # have to match both the title, and the target, which could come
+                       # from request values (Special:Contributions?target=Jimbo_Wales)
+                       # or be specified in "sub page" form
+                       # (Special:Contributions/Jimbo_Wales). The plot
+                       # thickens, because the Title object is altered for special pages,
+                       # so it doesn't contain the original alias-with-subpage.
                        $origTitle = Title::newFromText( $request->getText( 'title' ) );
                        if( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
                                list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
@@ -646,7 +652,7 @@ class SkinTemplate extends Skin {
                        if( $this->showIPinHeader() ) {
                                $href = &$this->userpageUrlDetails['href'];
                                $personal_urls['anonuserpage'] = array(
-                                       'text' => $this->userdisplayname,
+                                       'text' => $this->username,
                                        'href' => $href,
                                        'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
                                        'active' => ( $pageurl == $href )
@@ -871,7 +877,7 @@ class SkinTemplate extends Skin {
                                                'href' => $title->getLocalURL( $this->editUrlOptions() ),
                                                'primary' => true, // don't collapse this in vector
                                        );
-
+                                       
                                        // section link
                                        if ( $showNewSection ) {
                                                // Adds new section link
@@ -980,7 +986,7 @@ class SkinTemplate extends Skin {
                                // Checks that language conversion is enabled and variants exist
                                // And if it is not in the special namespace
                                if( count( $variants ) > 1 ) {
-                                       // Gets preferred variant (note that user preference is
+                                       // Gets preferred variant (note that user preference is 
                                        // only possible for wiki content language variant)
                                        $preferred = $pageLang->getPreferredVariant();
                                        // Loops over each variant
@@ -996,7 +1002,9 @@ class SkinTemplate extends Skin {
                                                $content_navigation['variants'][] = array(
                                                        'class' => ( $code == $preferred ) ? 'selected' : false,
                                                        'text' => $varname,
-                                                       'href' => $title->getLocalURL( array( 'variant' => $code ) )
+                                                       'href' => $title->getLocalURL( array( 'variant' => $code ) ),
+                                                       'lang' => $code,
+                                                       'hreflang' => $code
                                                );
                                        }
                                }
@@ -1167,7 +1175,7 @@ class SkinTemplate extends Skin {
                        $nav_urls['whatlinkshere'] = array(
                                'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalUrl()
                        );
-                       if ( $this->getTitle()->getArticleId() ) {
+                       if ( $this->getTitle()->getArticleID() ) {
                                $nav_urls['recentchangeslinked'] = array(
                                        'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalUrl()
                                );
@@ -1182,12 +1190,10 @@ class SkinTemplate extends Skin {
                                'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
                        );
 
-                       if ( $user->isLoggedIn() ) {
-                               $logPage = SpecialPage::getTitleFor( 'Log' );
-                               $nav_urls['log'] = array(
-                                       'href' => $logPage->getLocalUrl( array( 'user' => $rootUser ) )
-                               );
-                       }
+                       $logPage = SpecialPage::getTitleFor( 'Log' );
+                       $nav_urls['log'] = array(
+                               'href' => $logPage->getLocalUrl( array( 'user' => $rootUser ) )
+                       );
 
                        if ( $this->getUser()->isAllowed( 'block' ) ) {
                                $nav_urls['blockip'] = array(
@@ -1312,6 +1318,7 @@ abstract class QuickTemplate {
 
        /**
         * @private
+        * @return bool
         */
        function haveData( $str ) {
                return isset( $this->data[$str] );
@@ -1347,7 +1354,7 @@ abstract class BaseTemplate extends QuickTemplate {
        /**
         * Get a Message object with its context set
         *
-        * @param $name Str message name
+        * @param $name string message name
         * @return Message
         */
        public function getMsg( $name ) {
@@ -1371,6 +1378,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * stored by SkinTemplate.
         * The resulting array is built acording to a format intended to be passed
         * through makeListItem to generate the html.
+        * @return array
         */
        function getToolbox() {
                wfProfileIn( __METHOD__ );
@@ -1465,7 +1473,7 @@ abstract class BaseTemplate extends QuickTemplate {
                if ( !isset( $sidebar['LANGUAGES'] ) ) {
                        $sidebar['LANGUAGES'] = true;
                }
-
+               
                if ( !isset( $options['search'] ) || $options['search'] !== true ) {
                        unset( $sidebar['SEARCH'] );
                }
@@ -1475,7 +1483,7 @@ abstract class BaseTemplate extends QuickTemplate {
                if ( isset( $options['languages'] ) && $options['languages'] === false ) {
                        unset( $sidebar['LANGUAGES'] );
                }
-
+               
                $boxes = array();
                foreach ( $sidebar as $boxName => $content ) {
                        if ( $content === false ) {
@@ -1509,7 +1517,7 @@ abstract class BaseTemplate extends QuickTemplate {
                                                'generated' => false,
                                                'content'   => $this->data['language_urls'],
                                        );
-                               }
+                               } 
                                break;
                        default:
                                $msgObj = $this->getMsg( $boxName );
@@ -1522,7 +1530,7 @@ abstract class BaseTemplate extends QuickTemplate {
                                break;
                        }
                }
-
+               
                // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
                $hookContents = null;
                if ( isset( $boxes['TOOLBOX'] ) ) {
@@ -1537,7 +1545,7 @@ abstract class BaseTemplate extends QuickTemplate {
                        }
                }
                // END hack
-
+               
                if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
                        foreach ( $boxes as $boxName => $box ) {
                                if ( is_array( $box['content'] ) ) {
@@ -1547,7 +1555,7 @@ abstract class BaseTemplate extends QuickTemplate {
                                        }
                                        // HACK, shove the toolbox end onto the toolbox if we're rendering itself
                                        if ( $hookContents ) {
-                                               $content .= "\n $hookContents";
+                                               $content .= "\n $hookContents"; 
                                        }
                                        // END hack
                                        $content .= "\n</ul>\n";
@@ -1577,7 +1585,7 @@ abstract class BaseTemplate extends QuickTemplate {
                                // END hack
                        }
                }
-
+               
                return $boxes;
        }
 
@@ -1605,6 +1613,7 @@ abstract class BaseTemplate extends QuickTemplate {
         *   A link-fallback can be used to specify a tag to use instead of <a> if there is
         *   no link. eg: If you specify 'link-fallback' => 'span' than any non-link will
         *   output a <span> instead of just text.
+        * @return string
         */
        function makeLink( $key, $item, $options = array() ) {
                if ( isset( $item['text'] ) ) {
@@ -1683,6 +1692,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * If you need an id or class on a single link you should include a "links"
         * array with just one link item inside of it.
         * $options is also passed on to makeLink calls
+        * @return string
         */
        function makeListItem( $key, $item, $options = array() ) {
                if ( isset( $item['links'] ) ) {
@@ -1777,6 +1787,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * If you pass "flat" as an option then the returned array will be a flat array
         * of footer icons instead of a key/value array of footerlinks arrays broken
         * up into categories.
+        * @return array|mixed
         */
        function getFooterLinks( $option = null ) {
                $footerlinks = $this->data['footerlinks'];
@@ -1815,6 +1826,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * in the list of footer icons. This is mostly useful for skins which only
         * display the text from footericons instead of the images and don't want a
         * duplicate copyright statement because footerlinks already rendered one.
+        * @return
         */
        function getFooterIcons( $option = null ) {
                // Generate additional footer icons