* to be passed to the template engine.
*
* @private
- * @addtogroup Skins
+ * @ingroup Skins
*/
class MediaWiki_I18N {
var $_context = array();
}
function translate($value) {
- $fname = 'SkinTemplate-translate';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
// Hack for i18n:attributes in PHPTAL 1.0.0 dev version as of 2004-10-23
$value = preg_replace( '/^string:/', '', $value );
wfRestoreWarnings();
$value = str_replace($src, $varValue, $value);
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $value;
}
}
* to the computations individual esi snippets need. Most importantly no body
* parsing for most of those of course.
*
- * @addtogroup Skins
+ * @ingroup Skins
*/
class SkinTemplate extends Skin {
/**#@+
*/
var $template;
+ /**
+ * An array of stylesheet filenames (relative from skins path), with options
+ * for CSS media, IE conditions, and RTL/LTR direction.
+ * For internal use; add settings in the skin via $this->addStyle()
+ */
+ var $styles = array();
+
/**#@-*/
/**
$this->skinname = 'monobook';
$this->stylename = 'monobook';
$this->template = 'QuickTemplate';
+
+ $this->addStyle( 'common/shared.css', 'screen' );
+ $this->addStyle( 'common/commonPrint.css', 'print' );
}
/**
global $wgDisableCounters, $wgLogo, $action, $wgFeedClasses, $wgHideInterlanguageLinks;
global $wgMaxCredits, $wgShowCreditsIfMax;
global $wgPageShowWatchingUsers;
- global $wgUseTrackbacks;
+ global $wgUseTrackbacks, $wgUseSiteJs;
global $wgArticlePath, $wgScriptPath, $wgServer, $wgLang, $wgCanonicalNamespaceNames;
- $fname = 'SkinTemplate::outputPage';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
$oldid = $wgRequest->getVal( 'oldid' );
$diff = $wgRequest->getVal( 'diff' );
- wfProfileIn( "$fname-init" );
+ wfProfileIn( __METHOD__."-init" );
$this->initPage( $out );
$this->mTitle =& $wgTitle;
#if ( $wgUseDatabaseMessages ) { // uncomment this to fall back to GetText
$tpl->setTranslator(new MediaWiki_I18N());
#}
- wfProfileOut( "$fname-init" );
+ wfProfileOut( __METHOD__."-init" );
- wfProfileIn( "$fname-stuff" );
+ wfProfileIn( __METHOD__."-stuff" );
$this->thispage = $this->mTitle->getPrefixedDbKey();
$this->thisurl = $this->mTitle->getPrefixedURL();
$this->loggedin = $wgUser->isLoggedIn();
}
$this->usercss = $this->userjs = $this->userjsprev = false;
- $this->setupUserCss();
+ $this->setupUserCss( $out->getExtStyle() );
$this->setupUserJs( $out->isUserJsAllowed() );
$this->titletxt = $this->mTitle->getPrefixedText();
- wfProfileOut( "$fname-stuff" );
+ wfProfileOut( __METHOD__."-stuff" );
- wfProfileIn( "$fname-stuff2" );
+ wfProfileIn( __METHOD__."-stuff2" );
$tpl->set( 'title', $wgOut->getPageTitle() );
$tpl->set( 'pagetitle', $wgOut->getHTMLTitle() );
$tpl->set( 'displaytitle', $wgOut->mPageLinkTitle );
- $tpl->set( 'pageclass', Sanitizer::escapeClass( 'page-'.$this->mTitle->getPrefixedText() ) );
+ $tpl->set( 'pageclass', $this->getPageClasses( $this->mTitle ) );
+ $tpl->set( 'skinnameclass', ( "skin-" . Sanitizer::escapeClass( $this->getSkinName ( ) ) ) );
$nsname = isset( $wgCanonicalNamespaceNames[ $this->mTitle->getNamespace() ] ) ?
$wgCanonicalNamespaceNames[ $this->mTitle->getNamespace() ] :
$tpl->set( 'skinclass', get_class( $this ) );
$tpl->setRef( 'stylename', $this->stylename );
$tpl->set( 'printable', $wgRequest->getBool( 'printable' ) );
+ $tpl->set( 'handheld', $wgRequest->getBool( 'handheld' ) );
+ $tpl->set( 'csslinks', $this->buildCssLinks() );
$tpl->setRef( 'loggedin', $this->loggedin );
- $tpl->set('nsclass', 'ns-'.$this->mTitle->getNamespace());
$tpl->set('notspecialpage', $this->mTitle->getNamespace() != NS_SPECIAL);
/* XXX currently unused, might get useful later
$tpl->set( "editable", ($this->mTitle->getNamespace() != NS_SPECIAL ) );
$tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href']);
$tpl->set( 'userlang', $wgLang->getCode() );
$tpl->set( 'pagecss', $this->setupPageCss() );
- $tpl->set( 'printcss', $this->getPrintCss() );
$tpl->setRef( 'usercss', $this->usercss);
$tpl->setRef( 'userjs', $this->userjs);
$tpl->setRef( 'userjsprev', $this->userjsprev);
- global $wgUseSiteJs;
- if ($wgUseSiteJs) {
+ if( $wgUseSiteJs ) {
$jsCache = $this->loggedin ? '&smaxage=0' : '';
$tpl->set( 'jsvarurl',
self::makeUrl('-',
} else {
$ntl = '';
}
- wfProfileOut( "$fname-stuff2" );
+ wfProfileOut( __METHOD__."-stuff2" );
- wfProfileIn( "$fname-stuff3" );
+ wfProfileIn( __METHOD__."-stuff3" );
$tpl->setRef( 'newtalk', $ntl );
- $tpl->setRef( 'skin', $this);
+ $tpl->setRef( 'skin', $this );
$tpl->set( 'logo', $this->logoText() );
if ( $wgOut->isArticle() and (!isset( $oldid ) or isset( $diff )) and
$wgArticle and 0 != $wgArticle->getID() )
$this->credits = false;
- if (isset($wgMaxCredits) && $wgMaxCredits != 0) {
- require_once("Credits.php");
- $this->credits = getCredits($wgArticle, $wgMaxCredits, $wgShowCreditsIfMax);
+ if( $wgMaxCredits != 0 ){
+ $this->credits = Credits::getCredits( $wgArticle, $wgMaxCredits, $wgShowCreditsIfMax );
} else {
- $tpl->set('lastmod', $this->lastModified());
+ $tpl->set( 'lastmod', $this->lastModified() );
}
$tpl->setRef( 'credits', $this->credits );
$tpl->set('credits', false);
$tpl->set('numberofwatchingusers', false);
}
- wfProfileOut( "$fname-stuff3" );
+ wfProfileOut( __METHOD__."-stuff3" );
- wfProfileIn( "$fname-stuff4" );
+ wfProfileIn( __METHOD__."-stuff4" );
$tpl->set( 'copyrightico', $this->getCopyrightIcon() );
$tpl->set( 'poweredbyico', $this->getPoweredBy() );
$tpl->set( 'disclaimer', $this->disclaimerLink() );
} else {
$tpl->set('language_urls', false);
}
- wfProfileOut( "$fname-stuff4" );
+ wfProfileOut( __METHOD__."-stuff4" );
# Personal toolbar
$tpl->set('personal_urls', $this->buildPersonalUrls());
} else {
$tpl->set('body_ondblclick', false);
}
- if( $this->iseditable && $wgUser->getOption( 'editsectiononrightclick' ) ) {
- $tpl->set( 'body_onload', 'setupRightClickEdit()' );
- } else {
- $tpl->set( 'body_onload', false );
- }
+ $tpl->set( 'body_onload', false );
$tpl->set( 'sidebar', $this->buildSidebar() );
$tpl->set( 'nav_urls', $this->buildNavUrls() );
wfDebug( __METHOD__ . ': Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!' );
}
+ // allow extensions adding stuff after the page content.
+ // See Skin::afterContentHook() for further documentation.
+ $tpl->set ('dataAfterContent', $this->afterContentHook());
+
// execute template
- wfProfileIn( "$fname-execute" );
+ wfProfileIn( __METHOD__."-execute" );
$res = $tpl->execute();
- wfProfileOut( "$fname-execute" );
+ wfProfileOut( __METHOD__."-execute" );
// result may be an error
$this->printOrError( $res );
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
}
/**
function buildPersonalUrls() {
global $wgTitle, $wgRequest;
- $fname = 'SkinTemplate::buildPersonalUrls';
$pageurl = $wgTitle->getLocalURL();
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
/* set up the default links for the personal toolbar */
$personal_urls = array();
}
wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$wgTitle ) );
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $personal_urls;
}
*/
function buildContentActionUrls () {
global $wgContLang, $wgLang, $wgOut;
- $fname = 'SkinTemplate::buildContentActionUrls';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
global $wgUser, $wgRequest;
$action = $wgRequest->getText( 'action' );
'',
true);
- wfProfileIn( "$fname-edit" );
+ wfProfileIn( __METHOD__."-edit" );
if ( $this->mTitle->quickUserCan( 'edit' ) && ( $this->mTitle->exists() || $this->mTitle->quickUserCan( 'create' ) ) ) {
$istalk = $this->mTitle->isTalkPage();
$istalkclass = $istalk?' istalk':'';
'href' => $this->mTitle->getLocalUrl( $this->editUrlOptions() )
);
}
- wfProfileOut( "$fname-edit" );
+ wfProfileOut( __METHOD__."-edit" );
- wfProfileIn( "$fname-live" );
- if ( $this->mTitle->getArticleId() ) {
+ wfProfileIn( __METHOD__."-live" );
+ if ( $this->mTitle->exists() ) {
$content_actions['history'] = array(
'class' => ($action == 'history') ? 'selected' : false,
}
if ( $this->mTitle->getNamespace() !== NS_MEDIAWIKI && $wgUser->isAllowed( 'protect' ) ) {
- if(!$this->mTitle->isProtected()){
+ if( !$this->mTitle->isProtected() ){
$content_actions['protect'] = array(
'class' => ($action == 'protect') ? 'selected' : false,
'text' => wfMsg('protect'),
}
}
- wfProfileOut( "$fname-live" );
+ wfProfileOut( __METHOD__."-live" );
if( $this->loggedin ) {
if( !$this->mTitle->userIsWatching()) {
wfRunHooks( 'SkinTemplateContentActions', array( &$content_actions ) );
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $content_actions;
}
global $wgUseTrackbacks, $wgTitle, $wgUser, $wgRequest;
global $wgEnableUploads, $wgUploadNavigationUrl;
- $fname = 'SkinTemplate::buildNavUrls';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
$action = $wgRequest->getText( 'action' );
'href' => self::makeSpecialUrlSubpage( 'Emailuser', $this->mTitle->getText() )
);
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $nav_urls;
}
/**
* @private
*/
- function setupUserCss() {
- $fname = 'SkinTemplate::setupUserCss';
- wfProfileIn( $fname );
-
+ function setupUserCss( $extCSS = array() ) {
global $wgRequest, $wgAllowUserCss, $wgUseSiteCss, $wgContLang, $wgSquidMaxage, $wgStylePath, $wgUser;
- $sitecss = '';
- $usercss = '';
- $siteargs = '&maxage=' . $wgSquidMaxage;
+ wfProfileIn( __METHOD__ );
+
+ $siteargs = array(
+ 'action' => 'raw',
+ 'maxage' => $wgSquidMaxage,
+ );
if( $this->loggedin ) {
// Ensure that logged-in users' generated CSS isn't clobbered
// by anons' publicly cacheable generated CSS.
- $siteargs .= '&smaxage=0';
+ $siteargs['smaxage'] = '0';
+ $siteargs['ts'] = $wgUser->mTouched;
+ }
+
+ // Add any extension CSS
+ foreach( $extCSS as $tag ) {
+ $this->addStyle( $tag['href'] );
+ }
+
+ // If we use the site's dynamic CSS, throw that in, too
+ // Per-site custom styles
+ if ( $wgUseSiteCss ) {
+ $query = wfArrayToCGI( array(
+ 'usemsgcache' => 'yes',
+ 'ctype' => 'text/css',
+ 'smaxage' => $wgSquidMaxage
+ ) + $siteargs );
+ $this->addStyle( self::makeNSUrl( 'Common.css', $query, NS_MEDIAWIKI ) );
+ $this->addStyle( self::makeNSUrl( ucfirst( $this->skinname ) . '.css', $query, NS_MEDIAWIKI ),
+ 'screen' );
}
- # Add user-specific code if this is a user and we allow that kind of thing
+ // Per-user styles based on preferences
+ $siteargs['gen'] = 'css';
+ if( ( $us = $wgRequest->getVal( 'useskin', '' ) ) !== '' )
+ $siteargs['useskin'] = $us;
+ $this->addStyle( self::makeUrl( '-', wfArrayToCGI( $siteargs ) ), 'screen' );
+ // Per-user custom style pages
if ( $wgAllowUserCss && $this->loggedin ) {
- $action = $wgRequest->getText('action');
+ $action = $wgRequest->getVal('action');
# if we're previewing the CSS page, use it
- if( $this->mTitle->isCssSubpage() and $this->userCanPreview( $action ) ) {
- $siteargs = "&smaxage=0&maxage=0";
- $usercss = $wgRequest->getText('wpTextbox1');
+ if( $this->mTitle->isCssSubpage() && $this->userCanPreview( $action ) ) {
+ $previewCss = $wgRequest->getText('wpTextbox1');
+
+ /// @fixme properly escape the cdata!
+ $this->usercss = "/*<![CDATA[*/\n" .
+ $previewCss .
+ "/*]]>*/";
} else {
- $usercss = '@import "' .
- self::makeUrl($this->userpage . '/'.$this->skinname.'.css',
- 'action=raw&ctype=text/css') . '";' ."\n";
+ $this->addStyle( self::makeUrl($this->userpage . '/'.$this->skinname.'.css',
+ 'action=raw&ctype=text/css'), 'screen' );
}
-
- $siteargs .= '&ts=' . $wgUser->mTouched;
- }
-
- if( $wgContLang->isRTL() ) {
- global $wgStyleVersion;
- $sitecss .= "@import \"$wgStylePath/$this->stylename/rtl.css?$wgStyleVersion\";\n";
}
- # If we use the site's dynamic CSS, throw that in, too
- if ( $wgUseSiteCss ) {
- $query = "usemsgcache=yes&action=raw&ctype=text/css&smaxage=$wgSquidMaxage";
- $skinquery = '';
- if (($us = $wgRequest->getVal('useskin', '')) !== '')
- $skinquery = "&useskin=$us";
- $sitecss .= '@import "' . self::makeNSUrl( 'Common.css', $query, NS_MEDIAWIKI) . '";' . "\n";
- $sitecss .= '@import "' . self::makeNSUrl( ucfirst( $this->skinname ) . '.css', $query, NS_MEDIAWIKI ) . '";' . "\n";
- $sitecss .= '@import "' . self::makeUrl( '-', "action=raw&gen=css$siteargs$skinquery" ) . '";' . "\n";
- }
-
- # If we use any dynamic CSS, make a little CDATA block out of it.
-
- if ( !empty($sitecss) || !empty($usercss) ) {
- $this->usercss = "/*<![CDATA[*/\n" . $sitecss . $usercss . '/*]]>*/';
- }
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
}
/**
* @private
*/
function setupUserJs( $allowUserJs ) {
- $fname = 'SkinTemplate::setupUserJs';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
global $wgRequest, $wgJsMimeType;
$action = $wgRequest->getText('action');
# XXX: additional security check/prompt?
$this->userjsprev = '/*<![CDATA[*/ ' . $wgRequest->getText('wpTextbox1') . ' /*]]>*/';
} else {
- $this->userjs = self::makeUrl($this->userpage.'/'.$this->skinname.'.js', 'action=raw&ctype='.$wgJsMimeType.'&dontcountme=s');
+ $this->userjs = self::makeUrl($this->userpage.'/'.$this->skinname.'.js', 'action=raw&ctype='.$wgJsMimeType);
}
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
}
/**
* @private
*/
function setupPageCss() {
- $fname = 'SkinTemplate::setupPageCss';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
$out = false;
wfRunHooks( 'SkinTemplateSetupPageCss', array( &$out ) );
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $out;
}
* returns css with user-specific options
*/
public function getUserStylesheet() {
- $fname = 'SkinTemplate::getUserStylesheet';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
$s = "/* generated user stylesheet */\n";
$s .= $this->reallyDoGetUserStyles();
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $s;
}
- /**
- * Returns the print stylesheet for this skin. In all default skins this
- * is just commonPrint.css, but third-party skins may want to modify it.
- *
- * @return string
- */
- public function getPrintCss() {
- global $wgStylePath;
- return $wgStylePath . "/common/commonPrint.css";
- }
-
/**
* This returns MediaWiki:Common.js and MediaWiki:[Skinname].js concate-
* nated together. For some bizarre reason, it does *not* return any
* @return string
*/
public function getUserJs() {
- $fname = 'SkinTemplate::getUserJs';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
$s = parent::getUserJs();
- $s .= "\n\n/* MediaWiki:".ucfirst($this->skinname).".js (deprecated; migrate to Common.js!) */\n";
+ $s .= "\n\n/* MediaWiki:".ucfirst($this->skinname).".js */\n";
// avoid inclusion of non defined user JavaScript (with custom skins only)
// by checking for default message content
$s .= $userJS;
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $s;
}
+
+ /**
+ * Add a local or specified stylesheet, with the given media options.
+ * Meant primarily for internal use...
+ *
+ * @param $media -- to specify a media type, 'screen', 'printable', 'handheld' or any.
+ * @param $conditional -- for IE conditional comments, specifying an IE version
+ * @param $dir -- set to 'rtl' or 'ltr' for direction-specific sheets
+ */
+ public function addStyle( $style, $media='', $condition='', $dir='' ) {
+ $options = array();
+ if( $media )
+ $options['media'] = $media;
+ if( $condition )
+ $options['condition'] = $condition;
+ if( $dir )
+ $options['dir'] = $dir;
+ $this->styles[$style] = $options;
+ }
+
+ /**
+ * Build a set of <link>s for the stylesheets specified in the $this->styles array.
+ * These will be applied to various media & IE conditionals.
+ */
+ protected function buildCssLinks() {
+ $links = array();
+ foreach( $this->styles as $file => $options ) {
+ $link = $this->styleLink( $file, $options );
+ if( $link )
+ $links[] = $link;
+ }
+
+ return implode( "\n\t\t", $links );
+ }
+
+ protected function styleLink( $style, $options ) {
+ global $wgRequest;
+
+ if( isset( $options['dir'] ) ) {
+ global $wgContLang;
+ $siteDir = $wgContLang->isRTL() ? 'rtl' : 'ltr';
+ if( $siteDir != $options['dir'] )
+ return '';
+ }
+
+ if( isset( $options['media'] ) ) {
+ $media = $this->transformCssMedia( $options['media'] );
+ if( is_null( $media ) ) {
+ return '';
+ }
+ } else {
+ $media = '';
+ }
+
+ if( substr( $style, 0, 1 ) == '/' ||
+ substr( $style, 0, 5 ) == 'http:' ||
+ substr( $style, 0, 6 ) == 'https:' ) {
+ $url = $style;
+ } else {
+ global $wgStylePath, $wgStyleVersion;
+ $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
+ }
+
+ $attribs = array(
+ 'rel' => 'stylesheet',
+ 'href' => $url,
+ 'type' => 'text/css' );
+ if( $media ) {
+ $attribs['media'] = $media;
+ }
+
+ $link = Xml::element( 'link', $attribs );
+
+ if( isset( $options['condition'] ) ) {
+ $condition = htmlspecialchars( $options['condition'] );
+ $link = "<!--[if $condition]>$link<![endif]-->";
+ }
+ return $link;
+ }
+
+ function transformCssMedia( $media ) {
+ global $wgRequest, $wgHandheldForIPhone;
+
+ // Switch in on-screen display for media testing
+ $switches = array(
+ 'printable' => 'print',
+ 'handheld' => 'handheld',
+ );
+ foreach( $switches as $switch => $targetMedia ) {
+ if( $wgRequest->getBool( $switch ) ) {
+ if( $media == $targetMedia ) {
+ $media = '';
+ } elseif( $media == 'screen' ) {
+ return null;
+ }
+ }
+ }
+
+ // Expand longer media queries as iPhone doesn't grok 'handheld'
+ if( $wgHandheldForIPhone ) {
+ $mediaAliases = array(
+ 'screen' => 'screen and (min-device-width: 481px)',
+ 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
+ );
+
+ if( isset( $mediaAliases[$media] ) ) {
+ $media = $mediaAliases[$media];
+ }
+ }
+
+ return $media;
+ }
+
}
/**
* Generic wrapper for template functions, with interface
* compatible with what we use of PHPTAL 0.7.
- * @addtogroup Skins
+ * @ingroup Skins
*/
class QuickTemplate {
/**