StarCitizenTools/mediawiki-skins-Citizen
1
0
Fork 0
mirror of https://github.com/StarCitizenTools/mediawiki-skins-Citizen.git synced 2024-11-28 08:10:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #243 from octfx/feature/class-update

Browse source 
Update Classes
This commit is contained in:
alistair3149 2021-01-28 14:53:26 -05:00 committed by GitHub
parent 0cbf11b545 190d00dd0f
commit f4108050cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 1485 additions and 948 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

216
includes/CitizenHooks.php
View file

@ -1,216 +0,0 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
*/
namespace Citizen;
use ConfigException;
use MediaWiki\MediaWikiServices;
use RequestContext;
use ResourceLoaderContext;
use ThumbnailImage;
use User;
/**
* Hook handlers for Citizen skin.
*
* Hook handler method names should be in the form of:
* on<HookName>()
*/
class CitizenHooks {
/**
* ResourceLoaderGetConfigVars hook handler for setting a config variable
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars
*
* @param array &$vars Array of variables to be added into the output of the startup module.
* @return bool
*/
public static function onResourceLoaderGetConfigVars( &$vars ) {
try {
$vars['wgCitizenSearchDescriptionSource'] = self::getSkinConfig( 'CitizenSearchDescriptionSource' );
} catch ( ConfigException $e ) {
// Should not happen
$vars['wgCitizenSearchDescriptionSource'] = 'textextracts';
}
try {
$vars['wgCitizenMaxSearchResults'] = self::getSkinConfig( 'CitizenMaxSearchResults' );
} catch ( ConfigException $e ) {
// Should not happen
$vars['wgCitizenMaxSearchResults'] = 6;
}
try {
$vars['wgCitizenEnableSearch'] = self::getSkinConfig( 'CitizenEnableSearch' );
} catch ( ConfigException $e ) {
// Should not happen
$vars['wgCitizenEnableSearch'] = true;
}
return true;
}
/**
* SkinPageReadyConfig hook handler
*
* Replace searchModule provided by skin.
*
* @since 1.35
* @param ResourceLoaderContext $context
* @param mixed[] &$config Associative array of configurable options
* @return void This hook must not abort, it must return no value
*/
public static function onSkinPageReadyConfig(
ResourceLoaderContext $context,
array &$config
) {
// It's better to exit before any additional check
if ( $context->getSkin() !== 'citizen' ) {
return;
}
// Tell the `mediawiki.page.ready` module not to wire up search.
$config['search'] = false;
}
/**
* Lazyload images
* Modified from the Lazyload extension
* Looks for thumbnail and swap src to data-src
*
* @param ThumbnailImage $thumbnail
* @param array &$attribs
* @param array &$linkAttribs
* @return bool
*/
public static function onThumbnailBeforeProduceHTML( $thumbnail, &$attribs, &$linkAttribs ) {
try {
$lazyloadEnabled = self::getSkinConfig( 'CitizenEnableLazyload' );
} catch ( ConfigException $e ) {
$lazyloadEnabled = false;
}
// Replace thumbnail if lazyload is enabled
if ( $lazyloadEnabled === true ) {
$file = $thumbnail->getFile();
if ( $file !== null ) {
$request = RequestContext::getMain()->getRequest();
if ( defined( 'MW_API' ) && $request->getVal( 'action' ) === 'parse' ) {
return true;
}
// Set lazy class for the img
if ( isset( $attribs['class'] ) ) {
$attribs['class'] .= ' lazy';
} else {
$attribs['class'] = 'lazy';
}
// Native API
$attribs['loading'] = 'lazy';
$attribs['data-src'] = $attribs['src'];
$attribs['src'] = 'data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs%3D';
if ( isset( $attribs['srcset'] ) ) {
$attribs['data-srcset'] = $attribs['srcset'];
$attribs['srcset'] = '';
}
}
}
return true;
}
/**
* Get a skin configuration variable.
*
* @param string $name Name of configuration option.
* @return mixed Value configured.
* @throws \ConfigException
*/
private static function getSkinConfig( $name ) {
return MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'Citizen' )->get( $name );
}
/**
* Add Citizen preferences to the user's Special:Preferences page directly underneath skins.
* Based on Vector's implementation
*
* @param User $user User whose preferences are being modified.
* @param array[] &$prefs Preferences description array, to be fed to a HTMLForm object.
*/
public static function onGetPreferences( $user, &$prefs ) {
// Preferences to add.
$citizenPrefs = [
'CitizenThemeUser' => [
'type' => 'select',
// Droptown title
'label-message' => 'prefs-citizen-theme-label',
// The tab location and title of the section to insert the checkbox. The bit after the slash
// indicates that a prefs-skin-prefs string will be provided.
'section' => 'rendering/skin/skin-prefs',
'options' => [
wfMessage( 'prefs-citizen-theme-option-auto' )->escaped() => 'auto',
wfMessage( 'prefs-citizen-theme-option-light' )->escaped() => 'light',
wfMessage( 'prefs-citizen-theme-option-dark' )->escaped() => 'dark',
],
'default' => MediaWikiServices::getInstance()->getUserOptionsLookup()->getOption( $user, 'CitizenThemeUser' ) ?? 'auto',
// Only show this section when the Citizen skin is checked. The JavaScript client also uses
// this state to determine whether to show or hide the whole section.
'hide-if' => [ '!==', 'wpskin', 'citizen' ],
],
];
// Seek the skin preference section to add Citizen preferences just below it.
$skinSectionIndex = array_search( 'skin', array_keys( $prefs ) );
if ( $skinSectionIndex !== false ) {
// Skin preference section found. Inject Citizen skin-specific preferences just below it.
// This pattern can be found in Popups too. See T246162.
$citizenSectionIndex = $skinSectionIndex + 1;
$prefs = array_slice( $prefs, 0, $citizenSectionIndex, true )
+ $citizenPrefs
+ array_slice( $prefs, $citizenSectionIndex, null, true );
} else {
// Skin preference section not found. Just append Citizen skin-specific preferences.
$prefs += $citizenPrefs;
}
}
/**
* Delete the override cookie if the theme was changed through the user preferences
*
* @param array $formData Array of user submitted data
* @param \HTMLForm $form HTMLForm object, also a ContextSource
* @param User $user User with preferences to be saved
* @param bool &$result Boolean indicating success
* @param array $oldUserOptions Array with user's old options (before save)
* @return bool|void True or no return value to continue or false to abort
*/
public static function onPreferencesFormPreSave( $formData, $form, $user, &$result, $oldUserOptions ) {
if ( isset( $formData['CitizenThemeUser'] ) && $formData['CitizenThemeUser'] !== 'auto' ) {
// Reset override cookie from theme toggle
$form->getOutput()->getRequest()->response()->setCookie( 'skin-citizen-theme-override', null );
}
}
}

59
includes/GetConfigTrait.php Normal file
View file

@ -0,0 +1,59 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen;
use ConfigException;
use OutputPage;
trait GetConfigTrait {
/**
* getConfig() wrapper to catch exceptions.
* Returns null on exception
*
* @param string $key
* @param OutputPage|null $out
* @return mixed|null
* @see SkinTemplate::getConfig()
*/
protected function getConfigValue( $key, $out = null ) {
if ( isset( $this->out ) ) {
$out = $this->out;
}
if ( is_callable( [ $this, 'getOutput' ] ) ) {
$out = $this->getOutput();
}
try {
$value = $out->getConfig()->get( $key );
} catch ( ConfigException $e ) {
$value = null;
}
return $value;
}
}

102
includes/Hooks/PreferenceHooks.php Normal file
View file

@ -0,0 +1,102 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Hooks;
use HTMLForm;
use MediaWiki\MediaWikiServices;
use MediaWiki\Preferences\Hook\GetPreferencesHook;
use MediaWiki\Preferences\Hook\PreferencesFormPreSaveHook;
use User;
/**
* Hooks to run relating to user preferences
*/
class PreferenceHooks implements PreferencesFormPreSaveHook, GetPreferencesHook {
/**
* Delete the override cookie if the theme was changed through the user preferences
*
* @param array $formData Array of user submitted data
* @param HTMLForm $form HTMLForm object, also a ContextSource
* @param User $user User with preferences to be saved
* @param bool &$result Boolean indicating success
* @param array $oldUserOptions Array with user's old options (before save)
* @return bool|void True or no return value to continue or false to abort
*/
public function onPreferencesFormPreSave( $formData, $form, $user, &$result, $oldUserOptions ) {
if ( isset( $formData['CitizenThemeUser'] ) && $formData['CitizenThemeUser'] !== 'auto' ) {
// Reset override cookie from theme toggle
$form->getOutput()->getRequest()->response()->setCookie( 'skin-citizen-theme-override', null );
}
}
/**
* Add Citizen preferences to the user's Special:Preferences page directly underneath skins.
* Based on Vector's implementation
*
* @param User $user User whose preferences are being modified.
* @param array[] &$preferences Preferences description array, to be fed to a HTMLForm object.
*/
public function onGetPreferences( $user, &$preferences ) {
// Preferences to add.
$citizenPrefs = [
'CitizenThemeUser' => [
'type' => 'select',
// Droptown title
'label-message' => 'prefs-citizen-theme-label',
// The tab location and title of the section to insert the checkbox. The bit after the slash
// indicates that a prefs-skin-prefs string will be provided.
'section' => 'rendering/skin/skin-prefs',
'options' => [
wfMessage( 'prefs-citizen-theme-option-auto' )->escaped() => 'auto',
wfMessage( 'prefs-citizen-theme-option-light' )->escaped() => 'light',
wfMessage( 'prefs-citizen-theme-option-dark' )->escaped() => 'dark',
],
'default' => MediaWikiServices::getInstance()->getUserOptionsLookup()->getOption(
$user,
'CitizenThemeUser'
) ?? 'auto',
// Only show this section when the Citizen skin is checked. The JavaScript client also uses
// this state to determine whether to show or hide the whole section.
'hide-if' => [ '!==', 'wpskin', 'citizen' ],
],
];
// Seek the skin preference section to add Citizen preferences just below it.
$skinSectionIndex = array_search( 'skin', array_keys( $preferences ) );
if ( $skinSectionIndex !== false ) {
// Skin preference section found. Inject Citizen skin-specific preferences just below it.
// This pattern can be found in Popups too. See T246162.
$citizenSectionIndex = $skinSectionIndex + 1;
$preferences = array_slice( $preferences, 0, $citizenSectionIndex, true )
+ $citizenPrefs
+ array_slice( $preferences, $citizenSectionIndex, null, true );
} else {
// Skin preference section not found. Just append Citizen skin-specific preferences.
$preferences += $citizenPrefs;
}
}
}

79
includes/Hooks/ResourceLoaderHooks.php Normal file
View file

@ -0,0 +1,79 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Hooks;
use Config;
use ConfigException;
use MediaWiki\MediaWikiServices;
use MediaWiki\ResourceLoader\Hook\ResourceLoaderGetConfigVarsHook;
use Skin;
/**
* Hooks to run relating to the resource loader
*/
class ResourceLoaderHooks implements ResourceLoaderGetConfigVarsHook {
/**
* ResourceLoaderGetConfigVars hook handler for setting a config variable
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars
* @param array &$vars
* @param Skin $skin
* @param Config $config
*/
public function onResourceLoaderGetConfigVars( array &$vars, $skin, Config $config ): void {
try {
$vars['wgCitizenSearchDescriptionSource'] = self::getSkinConfig( 'CitizenSearchDescriptionSource' );
} catch ( ConfigException $e ) {
// Should not happen
$vars['wgCitizenSearchDescriptionSource'] = 'textextracts';
}
try {
$vars['wgCitizenMaxSearchResults'] = self::getSkinConfig( 'CitizenMaxSearchResults' );
} catch ( ConfigException $e ) {
// Should not happen
$vars['wgCitizenMaxSearchResults'] = 6;
}
try {
$vars['wgCitizenEnableSearch'] = self::getSkinConfig( 'CitizenEnableSearch' );
} catch ( ConfigException $e ) {
// Should not happen
$vars['wgCitizenEnableSearch'] = true;
}
}
/**
* Get a skin configuration variable.
*
* @param string $name Name of configuration option.
* @return mixed Value configured.
* @throws ConfigException
*/
private static function getSkinConfig( $name ) {
return MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'Citizen' )->get( $name );
}
}

55
includes/Hooks/SkinHooks.php Normal file
View file

@ -0,0 +1,55 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Hooks;
use MediaWiki\Skins\Hook\SkinPageReadyConfigHook;
use ResourceLoaderContext;
/**
* Hooks to run relating the skin
*/
class SkinHooks implements SkinPageReadyConfigHook {
/**
* SkinPageReadyConfig hook handler
*
* Replace searchModule provided by skin.
*
* @since 1.35
* @param ResourceLoaderContext $context
* @param mixed[] &$config Associative array of configurable options
* @return void This hook must not abort, it must return no value
*/
public function onSkinPageReadyConfig( ResourceLoaderContext $context, array &$config ): void {
// It's better to exit before any additional check
if ( $context->getSkin() !== 'citizen' ) {
return;
}
// Tell the `mediawiki.page.ready` module not to wire up search.
$config['search'] = false;
}
}

100
includes/Hooks/ThumbnailHooks.php Normal file
View file

@ -0,0 +1,100 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Hooks;
use ConfigException;
use MediaWiki\Hook\ThumbnailBeforeProduceHTMLHook;
use MediaWiki\MediaWikiServices;
use RequestContext;
use ThumbnailImage;
/**
* Hooks to tun relating thumbnails
*/
class ThumbnailHooks implements ThumbnailBeforeProduceHTMLHook {
/**
* Lazyload images
* Modified from the Lazyload extension
* Looks for thumbnail and swap src to data-src
*
* @param ThumbnailImage $thumbnail
* @param array &$attribs
* @param array &$linkAttribs
* @return bool
*/
public function onThumbnailBeforeProduceHTML( $thumbnail, &$attribs, &$linkAttribs ) {
try {
$lazyloadEnabled = self::getSkinConfig( 'CitizenEnableLazyload' );
} catch ( ConfigException $e ) {
$lazyloadEnabled = false;
}
// Replace thumbnail if lazyload is enabled
if ( $lazyloadEnabled === true ) {
$file = $thumbnail->getFile();
if ( $file !== null ) {
$request = RequestContext::getMain()->getRequest();
if ( defined( 'MW_API' ) && $request->getVal( 'action' ) === 'parse' ) {
return true;
}
// Set lazy class for the img
if ( isset( $attribs['class'] ) ) {
$attribs['class'] .= ' lazy';
} else {
$attribs['class'] = 'lazy';
}
// Native API
$attribs['loading'] = 'lazy';
$attribs['data-src'] = $attribs['src'];
$attribs['src'] = 'data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs%3D';
if ( isset( $attribs['srcset'] ) ) {
$attribs['data-srcset'] = $attribs['srcset'];
$attribs['srcset'] = '';
}
}
}
return true;
}
/**
* Get a skin configuration variable.
*
* @param string $name Name of configuration option.
* @return mixed Value configured.
* @throws ConfigException
*/
private static function getSkinConfig( $name ) {
return MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'Citizen' )->get( $name );
}
}

166
includes/Partials/Drawer.php Normal file
View file

@ -0,0 +1,166 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
use Exception;
use ResourceLoaderSkinModule;
use Skin;
/**
* Drawer partial of Skin Citizen
* Generates the following partials:
* - Logo
* - Drawer
* + Special Pages Link
* + Upload Link
*/
final class Drawer extends Partial {
/**
* Get and pick the correct logo based on types and variants
* Based on getLogoData() in MW 1.36
*
* @return array
*/
public function getLogoData() : array {
$logoData = ResourceLoaderSkinModule::getAvailableLogos( $this->skin->getConfig() );
// check if the logo supports variants
$variantsLogos = $logoData['variants'] ?? null;
if ( $variantsLogos ) {
$preferred = $this->skin->getOutput()->getTitle()
->getPageViewLanguage()->getCode();
$variantOverrides = $variantsLogos[$preferred] ?? null;
// Overrides the logo
if ( $variantOverrides ) {
foreach ( $variantOverrides as $key => $val ) {
$logoData[$key] = $val;
}
}
}
return $logoData;
}
/**
* Render the navigation drawer
* Based on buildSidebar()
*
* @return array
* @throws Exception
*/
public function buildDrawer() {
$portals = $this->skin->buildSidebar();
$props = [];
$languages = null;
// Render portals
foreach ( $portals as $name => $content ) {
if ( $content === false ) {
continue;
}
// Numeric strings gets an integer when set as key, cast back - T73639
$name = (string)$name;
switch ( $name ) {
case 'SEARCH':
case 'TOOLBOX':
break;
case 'LANGUAGES':
$languages = $this->skin->getLanguages();
$portal = $this->skin->getMenuData( 'lang', $content );
// The language portal will be added provided either
// languages exist or there is a value in html-after-portal
// for example to show the add language wikidata link (T252800)
if ( count( $content ) || $portal['html-after-portal'] ) {
$languages = $portal;
}
break;
default:
// Historically some portals have been defined using HTML rather than arrays.
// Let's move away from that to a uniform definition.
if ( !is_array( $content ) ) {
$html = $content;
$content = [];
wfDeprecated(
"`content` field in portal $name must be array."
. "Previously it could be a string but this is no longer supported.",
'1.35.0'
);
} else {
$html = false;
}
$portal = $this->skin->getMenuData( $name, $content );
if ( $html ) {
$portal['html-items'] .= $html;
}
$props[] = $portal;
break;
}
}
$firstPortal = $props[0] ?? null;
if ( $firstPortal ) {
$firstPortal[ 'class' ] .= ' portal-first';
// Hide label for first portal
$firstPortal[ 'label-class' ] .= 'screen-reader-text';
if ( isset( $firstPortal['html-items'] ) ) {
$this->addToolboxLinksToDrawer( $firstPortal['html-items'] );
}
}
return [
'msg-citizen-drawer-toggle' => $this->skin->msg( 'citizen-drawer-toggle' )->text(),
'data-portals-first' => $firstPortal,
'array-portals-rest' => array_slice( $props, 1 ),
'data-portals-languages' => $languages,
];
}
/**
* Add a link to special pages and the upload form to the first portal in the drawer
*
* @param string &$htmlItems
*
* @return void
*/
private function addToolboxLinksToDrawer( &$htmlItems ) {
// First add a link to special pages
$htmlItems .= $this->skin->makeListItem( 'specialpages', [
'href' => Skin::makeSpecialUrl( 'Specialpages' ),
'id' => 't-specialpages'
] );
// Then add a link to the upload form
$htmlItems .= $this->skin->makeListItem( 'upload', [
'href' => Skin::makeSpecialUrl( 'Upload' ),
'id' => 't-upload'
] );
}
}

156
includes/Partials/Footer.php Normal file
View file

@ -0,0 +1,156 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
/**
* Footer partial of Skin Citizen
*/
final class Footer extends Partial {
/**
* Get rows that make up the footer
* @return array for use in Mustache template describing the footer elements.
*/
public function getFooterData(): array {
$footerLinks = $this->skin->getFooterLinks();
$lastMod = null;
// Get last modified message
if ( $footerLinks['info']['lastmod'] && isset( $footerLinks['info']['lastmod'] ) ) {
$lastMod = $footerLinks['info']['lastmod'];
}
return [
'html-lastmodified' => $lastMod,
'array-footer-rows' => $this->getFooterRows( $footerLinks ),
'array-footer-icons' => $this->getFooterIcons(),
'msg-citizen-footer-desc' => $this->skin->msg( 'citizen-footer-desc' )->text(),
'msg-citizen-footer-tagline' => $this->skin->msg( 'citizen-footer-tagline' )->text(),
];
}
/**
* The footer rows
*
* @param array $footerLinks
* @return array
*/
private function getFooterRows( array $footerLinks ) {
$footerRows = [];
foreach ( $footerLinks as $category => $links ) {
$items = [];
$rowId = "footer-$category";
// Unset footer-info
if ( $category === 'info' ) {
continue;
}
foreach ( $links as $key => $link ) {
// Link may be null. If so don't include it.
if ( $link ) {
$items[] = [
'id' => "$rowId-$key",
'html' => $link,
];
}
}
$footerRows[] = [
'id' => $rowId,
'className' => null,
'array-items' => $items
];
}
// Append footer-info after links
if ( isset( $footerLinks['info'] ) ) {
$items = [];
$rowId = "footer-info";
foreach ( $footerLinks['info'] as $key => $link ) {
// Don't include lastmod and null link
if ( $key !== 'lastmod' && $link ) {
$items[] = [
'id' => "$rowId-$key",
'html' => $link,
];
}
}
$footerRows[] = [
'id' => $rowId,
'className' => null,
'array-items' => $items
];
}
return $footerRows;
}
/**
* Footer Icons
*
* @return array|array[]
*/
private function getFooterIcons() {
// If footer icons are enabled append to the end of the rows
$footerIcons = $this->skin->getFooterIcons();
if ( empty( $footerIcons ) ) {
return [];
}
$items = [];
foreach ( $footerIcons as $blockName => $blockIcons ) {
$html = '';
foreach ( $blockIcons as $icon ) {
// Only output icons which have an image.
// For historic reasons this mimics the `icononly` option
// for BaseTemplate::getFooterIcons.
if ( is_string( $icon ) || isset( $icon['src'] ) ) {
$html .= $this->skin->makeFooterIcon( $icon );
}
}
// For historic reasons this mimics the `icononly` option
// for BaseTemplate::getFooterIcons. Empty rows should not be output.
if ( $html ) {
$items[] = [
'id' => 'footer-' . htmlspecialchars( $blockName ) . 'ico',
'html' => $html,
];
}
}
return [
[
'id' => 'footer-icons',
'className' => 'noprint',
'array-items' => $items,
]
];
}
}

200
includes/Partials/Header.php Normal file
View file

@ -0,0 +1,200 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
use Linker;
use MediaWiki\MediaWikiServices;
use MWException;
use Skin;
use SpecialPage;
use Title;
/**
* Header partial of Skin Citizen
* Generates the following partials:
* - Personal Menu
* - Extra Tools
* - Search
* - Theme Toggle
*/
final class Header extends Partial {
/**
* Build Personal Tools menu
*
* @return array
*/
public function buildPersonalMenu(): array {
$personalTools = $this->skin->getPersonalToolsForMakeListItem(
$this->skin->buildPersonalUrls()
);
// Move the Echo badges and ULS out of default list
if ( isset( $personalTools['notifications-alert'] ) ) {
unset( $personalTools['notifications-alert'] );
}
if ( isset( $personalTools['notifications-notice'] ) ) {
unset( $personalTools['notifications-notice'] );
}
if ( isset( $personalTools['uls'] ) ) {
unset( $personalTools['uls'] );
}
if ( $this->skin->getUser()->isLoggedIn() ) {
$personalTools = $this->addUserGroupsToMenu( $personalTools );
}
$personalMenu = $this->skin->getMenuData( 'personal', $personalTools );
// Hide label for personal tools
$personalMenu[ 'label-class' ] .= 'screen-reader-text';
return [
'msg-citizen-personalmenu-toggle' => $this->skin->msg( 'citizen-personalmenu-toggle' )->text(),
'data-personal-menu-list' => $personalMenu,
];
}
/**
* Echo notification badges and ULS button
*
* @return array
*/
public function getExtratools(): array {
$personalTools = $this->skin->getPersonalToolsForMakeListItem(
$this->skin->buildPersonalUrls()
);
// Create the Echo badges and ULS
$extraTools = [];
if ( isset( $personalTools['notifications-alert'] ) ) {
$extraTools['notifications-alert'] = $personalTools['notifications-alert'];
}
if ( isset( $personalTools['notifications-notice'] ) ) {
$extraTools['notifications-notice'] = $personalTools['notifications-notice'];
}
if ( isset( $personalTools['uls'] ) ) {
$extraTools['uls'] = $personalTools['uls'];
}
$html = $this->skin->getMenuData( 'personal-extra', $extraTools );
// Hide label for extra tools
$html[ 'label-class' ] .= 'screen-reader-text';
return $html;
}
/**
* Render the search box
*
* @return array
* @throws MWException
*/
public function buildSearchProps() : array {
$toggleMsg = $this->skin->msg( 'citizen-search-toggle' )->text();
$accessKey = Linker::accesskey( 'search' );
return [
'msg-citizen-search-toggle' => $toggleMsg,
'msg-citizen-search-toggle-shortcut' => $toggleMsg . ' [alt-shift-' . $accessKey . ']',
'form-action' => $this->getConfigValue( 'Script' ),
'html-input' => $this->skin->makeSearchInput( [ 'id' => 'searchInput' ] ),
'msg-search' => $this->skin->msg( 'search' ),
'page-title' => SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey(),
'html-random-href' => Skin::makeSpecialUrl( 'Randompage' ),
'msg-random' => $this->skin->msg( 'Randompage' )->text(),
];
}
/**
* Render the theme toggle
*
* @return array
*/
public function buildThemeToggleProps() : array {
$toggleMsg = $this->skin->msg( 'citizen-theme-toggle' )->text();
return [
'msg-citizen-theme-toggle-shortcut' => $toggleMsg,
];
}
/**
* This adds all explicit user groups as links to the personal menu
* Links are added right below the user page link
* Wrapped in an <li> element with id 'pt-usergroups'
*
* @param array $originalUrls The original personal tools urls
*
* @return array
*/
private function addUserGroupsToMenu( $originalUrls ) {
$personalTools = [];
// This does not return implicit groups
$groups = MediaWikiServices::getInstance()->getUserGroupManager()->getUserGroups( $this->skin->getUser() );
// If the user has only implicit groups return early
if ( empty( $groups ) ) {
return $originalUrls;
}
$userPage = array_shift( $originalUrls );
$groupLinks = [];
$msgName = 'group-%s';
foreach ( $groups as $group ) {
$groupPage = Title::newFromText(
$this->skin->msg( sprintf( $msgName, $group ) )->text(),
NS_PROJECT
);
$groupLinks[$group] = [
'msg' => sprintf( $msgName, $group ),
// Nullpointer should not happen
'href' => $groupPage->getLinkURL(),
'tooltiponly' => true,
'id' => sprintf( $msgName, $group ),
// 'exists' => $groupPage->exists() - This will add an additional DB call
];
}
$userGroups = [
'id' => 'pt-usergroups',
'links' => $groupLinks
];
// The following defines the order of links added
$personalTools['userpage'] = $userPage;
$personalTools['usergroups'] = $userGroups;
foreach ( $originalUrls as $key => $url ) {
$personalTools[$key] = $url;
}
return $personalTools;
}
}

203
includes/Partials/Metadata.php Normal file
View file

@ -0,0 +1,203 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
use Exception;
final class Metadata extends Partial {
/**
* Adds metadata to the output page
*/
public function addMetadata() {
// Responsive layout
// Replace with core responsive option if it is implemented in 1.36+
$this->out->addMeta( 'viewport', 'width=device-width, initial-scale=1.0' );
// Theme color
$this->out->addMeta( 'theme-color', $this->getConfigValue( 'CitizenThemeColor' ) ?? '' );
// Generate webapp manifest
$this->addManifest();
// Preconnect origin
$this->addPreConnect();
// HTTP headers
// CSP
$this->addCSP();
// HSTS
$this->addHSTS();
// Deny X-Frame-Options
$this->addXFrameOptions();
// X-XSS-Protection
$this->addXXSSProtection();
// Referrer policy
$this->addStrictReferrerPolicy();
// Feature policy
$this->addFeaturePolicy();
}
/**
* Adds the manifest if enabled in 'CitizenEnableManifest'.
* Manifest link will be empty if wfExpandUrl throws an exception.
*/
private function addManifest() {
if ( $this->getConfigValue( 'CitizenEnableManifest' ) !== true ) {
return;
}
try {
$href =
wfExpandUrl( wfAppendQuery( wfScript( 'api' ),
[ 'action' => 'webapp-manifest' ] ), PROTO_RELATIVE );
} catch ( Exception $e ) {
$href = '';
}
$this->out->addLink( [
'rel' => 'manifest',
'href' => $href,
] );
}
/**
* Adds a preconnect header if enabled in 'CitizenEnablePreconnect'
*/
private function addPreConnect() {
if ( $this->getConfigValue( 'CitizenEnablePreconnect' ) !== true ) {
return;
}
$this->out->addLink( [
'rel' => 'preconnect',
'href' => $this->getConfigValue( 'CitizenPreconnectURL' ),
] );
}
/**
* Adds the csp directive if enabled in 'CitizenEnableCSP'.
* Directive holds the content of 'CitizenCSPDirective'.
*/
private function addCSP() {
if ( $this->getConfigValue( 'CitizenEnableCSP' ) !== true ) {
return;
}
$cspDirective = $this->getConfigValue( 'CitizenCSPDirective' ) ?? '';
$cspMode = 'Content-Security-Policy';
// Check if report mode is enabled
if ( $this->getConfigValue( 'CitizenEnableCSPReportMode' ) === true ) {
$cspMode = 'Content-Security-Policy-Report-Only';
}
$this->out->getRequest()->response()->header( sprintf( '%s: %s', $cspMode, $cspDirective ) );
}
/**
* Adds the HSTS Header. If no max age or an invalid max age is set a default of 300 will be
* applied.
* Preload and Include Subdomains can be enabled by setting 'CitizenHSTSIncludeSubdomains'
* and/or 'CitizenHSTSPreload' to true.
*/
private function addHSTS() {
if ( $this->getConfigValue( 'CitizenEnableHSTS' ) !== true ) {
return;
}
$maxAge = $this->getConfigValue( 'CitizenHSTSMaxAge' );
$includeSubdomains = $this->getConfigValue( 'CitizenHSTSIncludeSubdomains' ) ?? false;
$preload = $this->getConfigValue( 'CitizenHSTSPreload' ) ?? false;
// HSTS max age
if ( is_int( $maxAge ) ) {
$maxAge = max( $maxAge, 0 );
} else {
// Default to 5 mins if input is invalid
$maxAge = 300;
}
$hstsHeader = 'Strict-Transport-Security: max-age=' . $maxAge;
if ( $includeSubdomains ) {
$hstsHeader .= '; includeSubDomains';
}
if ( $preload ) {
$hstsHeader .= '; preload';
}
$this->out->getRequest()->response()->header( $hstsHeader );
}
/**
* Adds the X-Frame-Options header if set in 'CitizenEnableDenyXFrameOptions'
*/
private function addXFrameOptions() {
if ( $this->getConfigValue( 'CitizenEnableDenyXFrameOptions' ) === true ) {
$this->out->getRequest()->response()->header( 'X-Frame-Options: deny' );
}
}
/**
* Adds the X-XSS-Protection header if set in 'CitizenEnableXXSSProtection'
*/
private function addXXSSProtection() {
if ( $this->getConfigValue( 'CitizenEnableXXSSProtection' ) === true ) {
$this->out->getRequest()->response()->header( 'X-XSS-Protection: 1; mode=block' );
}
}
/**
* Adds the referrer header if enabled in 'CitizenEnableStrictReferrerPolicy'
*/
private function addStrictReferrerPolicy() {
if ( $this->getConfigValue( 'CitizenEnableStrictReferrerPolicy' ) === true ) {
// iOS Safari, IE, Edge compatiblity
$this->out->getRequest()->response()->header( 'Referrer-Policy: strict-origin' );
$this->out->getRequest()->response()->header( 'Referrer-Policy: strict-origin-when-cross-origin' );
}
}
/**
* Adds the Feature policy header to the response if enabled in 'CitizenFeaturePolicyDirective'
*/
private function addFeaturePolicy() {
if ( $this->getConfigValue( 'CitizenEnableFeaturePolicy' ) === true ) {
$featurePolicy = $this->getConfigValue( 'CitizenFeaturePolicyDirective' ) ?? '';
$this->out->getRequest()->response()->header( sprintf( 'Feature-Policy: %s',
$featurePolicy ) );
}
}
}

54
includes/Partials/PageLinks.php Normal file
View file

@ -0,0 +1,54 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
final class PageLinks extends Partial {
/**
* Render page-related links at the bottom
*
* @return array html
*/
public function buildPageLinks() : array {
$contentNavigation = $this->skin->buildContentNavigationUrls();
$namespaceshtml = $this->skin->getMenuData( 'namespaces', $contentNavigation[ 'namespaces' ] ?? [] );
$variantshtml = $this->skin->getMenuData( 'variants', $contentNavigation[ 'variants' ] ?? [] );
if ( $namespaceshtml ) {
$namespaceshtml[ 'label-class' ] .= 'screen-reader-text';
}
if ( $variantshtml ) {
$variantshtml[ 'label-class' ] .= 'screen-reader-text';
}
return [
'data-namespaces' => $namespaceshtml,
'data-variants' => $variantshtml,
];
}
}

88
includes/Partials/PageTools.php Normal file
View file

@ -0,0 +1,88 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
use MediaWiki\MediaWikiServices;
final class PageTools extends Partial {
/**
* Render page-related tools
* Possible visibility conditions:
* * true: always visible (bool)
* * false: never visible (bool)
* * 'login': only visible if logged in (string)
* * 'permission-*': only visible if user has permission
* e.g. permission-edit = only visible if user can edit pages
*
* @return array html
*/
public function buildPageTools(): array {
$condition = $this->getConfigValue( 'CitizenShowPageTools' );
$contentNavigation = $this->skin->buildContentNavigationUrls();
$portals = $this->skin->buildSidebar();
$props = [];
// Login-based condition, return true if condition is met
if ( $condition === 'login' ) {
$condition = $this->skin->getUser()->isLoggedIn();
}
// Permission-based condition, return true if condition is met
if ( is_string( $condition ) && strpos( $condition, 'permission' ) === 0 ) {
$permission = substr( $condition, 11 );
try {
$condition = MediaWikiServices::getInstance()->getPermissionManager()->userCan(
$permission, $this->skin->getUser(), $this->skin->getTitle() );
} catch ( \Exception $e ) {
$condition = false;
}
}
if ( $condition === true ) {
$viewshtml = $this->skin->getMenuData( 'views', $contentNavigation[ 'views' ] ?? [] );
$actionshtml = $this->skin->getMenuData( 'actions', $contentNavigation[ 'actions' ] ?? [] );
$toolboxhtml = $this->skin->getMenuData( 'tb', $portals['TOOLBOX'] ?? [] );
if ( $viewshtml ) {
$viewshtml[ 'label-class' ] .= 'screen-reader-text';
}
if ( $actionshtml ) {
$actionshtml[ 'label-class' ] .= 'screen-reader-text';
}
$props = [
'data-page-views' => $viewshtml,
'data-page-actions' => $actionshtml,
'data-page-toolbox' => $toolboxhtml,
];
}
return $props;
}
}

59
includes/Partials/Partial.php Normal file
View file

@ -0,0 +1,59 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
use Citizen\GetConfigTrait;
use OutputPage;
use SkinCitizen;
/**
* The base class for all skin partials
*/
abstract class Partial {
use GetConfigTrait;
/**
* @var SkinCitizen
*/
protected $skin;
/**
* Needed for trait
*
* @var OutputPage
*/
protected $out;
/**
* Drawer constructor.
* @param SkinCitizen $skin
*/
public function __construct( SkinCitizen $skin ) {
$this->skin = $skin;
$this->out = $skin->getOutput();
}
}

85
includes/Partials/Theme.php Normal file
View file

@ -0,0 +1,85 @@
<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
declare( strict_types=1 );
namespace Citizen\Partials;
use MediaWiki\MediaWikiServices;
/**
* Theme switcher partial of Skin Citizen
*/
final class Theme extends Partial {
/**
* Sets the corresponding theme class on the <html> element
* If the theme is set to auto, the theme switcher script will be added
*
* @param array &$options
*/
public function setSkinTheme( array &$options ) {
// Set theme to site theme
$theme = $this->getConfigValue( 'CitizenThemeDefault' ) ?? 'auto';
// Set theme to user theme if registered
if ( $this->out->getUser()->isRegistered() ) {
$theme = MediaWikiServices::getInstance()->getUserOptionsLookup()->getOption(
$this->out->getUser(),
'CitizenThemeUser',
'auto'
);
}
$cookieTheme = $this->out->getRequest()->getCookie( 'skin-citizen-theme', null, 'auto' );
if ( $cookieTheme !== 'auto' ) {
$theme = $cookieTheme;
}
// Add HTML class based on theme set
$this->out->addHtmlClasses( 'skin-citizen-' . $theme );
if ( $this->out->getRequest()->getCookie( 'skin-citizen-theme-override' ) === null ) {
// Only set the theme cookie if the theme wasn't overridden by the user through the button
$this->out->getRequest()->response()->setCookie( 'skin-citizen-theme', $theme, 0, [
'httpOnly' => false,
] );
}
// Script content at 'skins.citizen.scripts.theme/inline.js
// @phpcs:ignore Generic.Files.LineLength.TooLong
$this->out->getOutput()->addHeadItem( 'theme-switcher', '<script>window.switchTheme=(()=>{try{const t=document.cookie.match(/skin-citizen-theme=(dark|light|auto)/),e=null!==t?t.pop():null;null!==e&&(document.documentElement.classList.remove(...["auto","dark","light"].map(t=>"skin-citizen-"+t)),document.documentElement.classList.add("skin-citizen-"+e))}catch(t){}}),window.switchTheme();</script>' );
// Add styles and scripts module
if ( $theme === 'auto' ) {
$options['scripts'] = array_merge(
$options['scripts'],
[ 'skins.citizen.scripts.theme' ]
);
}
$options['styles'] = array_merge(
$options['styles'],
[ 'skins.citizen.styles.theme' ]
);
}
}

786
includes/SkinCitizen.php
View file

@ -21,13 +21,22 @@
* @ingroup Skins
*/
use MediaWiki\MediaWikiServices;
use Citizen\GetConfigTrait;
use Citizen\Partials\Drawer;
use Citizen\Partials\Footer;
use Citizen\Partials\Header;
use Citizen\Partials\Metadata;
use Citizen\Partials\PageLinks;
use Citizen\Partials\PageTools;
use Citizen\Partials\Theme;
/**
* Skin subclass for Citizen
* @ingroup Skins
*/
class SkinCitizen extends SkinMustache {
use GetConfigTrait;
/** @var array of alternate message keys for menu labels */
private const MENU_LABEL_KEYS = [
'tb' => 'toolbox',
@ -44,15 +53,13 @@ class SkinCitizen extends SkinMustache {
$skin = $this;
$out = $skin->getOutput();
$metadata = new Metadata( $this );
$skinTheme = new Theme( $this );
$metadata->addMetadata();
// Theme handler
$skin->setSkinTheme( $out, $options );
// Responsive layout
// Replace with core responsive option if it is implemented in 1.36+
$out->addMeta( 'viewport', 'width=device-width, initial-scale=1.0' );
// Theme color
$out->addMeta( 'theme-color', $this->getConfigValue( 'CitizenThemeColor' ) ?? '' );
$skinTheme->setSkinTheme( $options );
// Load Citizen search suggestion styles if enabled
if ( $this->getConfigValue( 'CitizenEnableSearch' ) === true ) {
@ -88,43 +95,24 @@ class SkinCitizen extends SkinMustache {
);
}
// Generate webapp manifest
$skin->addManifest();
// Preconnect origin
$skin->addPreConnect();
// HTTP headers
// CSP
$skin->addCSP();
// HSTS
$skin->addHSTS();
// Deny X-Frame-Options
$skin->addXFrameOptions();
// X-XSS-Protection
$skin->addXXSSProtection();
// Referrer policy
$skin->addStrictReferrerPolicy();
// Feature policy
$skin->addFeaturePolicy();
$options['templateDirectory'] = __DIR__ . '/templates';
parent::__construct( $options );
}
/**
* @return array Returns an array of data used by Citizen skin.
* @throws MWException
*/
public function getTemplateData() : array {
$skin = $this;
$out = $skin->getOutput();
$out = $this->getOutput();
$title = $out->getTitle();
$header = new Header( $this );
$drawer = new Drawer( $this );
$footer = new Footer( $this );
$links = new PageLinks( $this );
$tools = new PageTools( $this );
// Naming conventions for Mustache parameters.
//
// Value type (first segment):
@ -141,26 +129,26 @@ class SkinCitizen extends SkinMustache {
// It should be followed by the name of the hook in hyphenated lowercase.
//
// Conditionally used values must use null to indicate absence (not false or '').
$newTalksHtml = $skin->getNewtalks() ?: null;
$newTalksHtml = $this->getNewtalks() ?: null;
$skinData = parent::getTemplateData() + [
'msg-sitetitle' => $skin->msg( 'sitetitle' )->text(),
return parent::getTemplateData() + [
'msg-sitetitle' => $this->msg( 'sitetitle' )->text(),
'html-mainpage-attributes' => Xml::expandAttributes(
Linker::tooltipAndAccesskeyAttribs( 'p-logo' ) + [
'href' => Skin::makeMainPageUrl(),
]
),
'data-logos' => $this->getLogoData(),
'data-logos' => $drawer->getLogoData(),
'data-header' => [
'data-drawer' => $this->buildDrawer(),
'data-extratools' => $this->getExtraTools(),
'data-personal-menu' => $this->buildPersonalMenu(),
'data-theme-toggle' => $this->buildThemeToggleProps(),
'data-search-box' => $this->buildSearchProps(),
'data-drawer' => $drawer->buildDrawer(),
'data-extratools' => $header->getExtraTools(),
'data-personal-menu' => $header->buildPersonalMenu(),
'data-theme-toggle' => $header->buildThemeToggleProps(),
'data-search-box' => $header->buildSearchProps(),
],
'data-pagetools' => $this->buildPageTools(),
'data-pagetools' => $tools->buildPageTools(),
'html-newtalk' => $newTalksHtml ? '<div class="usermessage">' . $newTalksHtml . '</div>' : '',
'page-langcode' => $title->getPageViewLanguage()->getHtmlCode(),
@ -169,506 +157,50 @@ class SkinCitizen extends SkinMustache {
// From OutputPage::getPageTitle, via ::setPageTitle().
'html-title' => $out->getPageTitle(),
'msg-tagline' => $skin->msg( 'tagline' )->text(),
'msg-tagline' => $this->msg( 'tagline' )->text(),
'data-pagelinks' => $this->buildPageLinks(),
'data-pagelinks' => $links->buildPageLinks(),
'html-categories' => $skin->getCategories(),
'html-categories' => $this->getCategories(),
'data-footer' => $this->getFooterData(),
];
return $skinData;
}
/**
* Get rows that make up the footer
* @return array for use in Mustache template describing the footer elements.
*/
private function getFooterData() : array {
$skin = $this;
$footerLinks = $this->getFooterLinks();
$lastMod = null;
$footerRows = [];
$footerIconRows = [];
// Get last modified message
if ( $footerLinks['info']['lastmod'] && isset( $footerLinks['info']['lastmod'] ) ) {
$lastMod = $footerLinks['info']['lastmod'];
}
foreach ( $footerLinks as $category => $links ) {
$items = [];
$rowId = "footer-$category";
// Unset footer-info
if ( $category !== 'info' ) {
foreach ( $links as $key => $link ) {
// Link may be null. If so don't include it.
if ( $link ) {
$items[] = [
'id' => "$rowId-$key",
'html' => $link,
];
}
}
$footerRows[] = [
'id' => $rowId,
'className' => null,
'array-items' => $items
];
}
}
// Append footer-info after links
if ( isset( $footerLinks['info'] ) ) {
$items = [];
$rowId = "footer-info";
foreach ( $footerLinks['info'] as $key => $link ) {
// Don't include lastmod and null link
if ( $key !== 'lastmod' && $link ) {
$items[] = [
'id' => "$rowId-$key",
'html' => $link,
];
}
}
$footerRows[] = [
'id' => $rowId,
'className' => null,
'array-items' => $items
];
}
// If footer icons are enabled append to the end of the rows
$footerIcons = $this->getFooterIcons();
if ( count( $footerIcons ) > 0 ) {
$items = [];
foreach ( $footerIcons as $blockName => $blockIcons ) {
$html = '';
foreach ( $blockIcons as $icon ) {
// Only output icons which have an image.
// For historic reasons this mimics the `icononly` option
// for BaseTemplate::getFooterIcons.
if ( is_string( $icon ) || isset( $icon['src'] ) ) {
$html .= $skin->makeFooterIcon( $icon );
}
}
// For historic reasons this mimics the `icononly` option
// for BaseTemplate::getFooterIcons. Empty rows should not be output.
if ( $html ) {
$items[] = [
'id' => 'footer-' . htmlspecialchars( $blockName ) . 'ico',
'html' => $html,
];
}
}
$footerIconRows[] = [
'id' => 'footer-icons',
'className' => 'noprint',
'array-items' => $items,
];
}
$data = [
'html-lastmodified' => $lastMod,
'array-footer-rows' => $footerRows,
'array-footer-icons' => $footerIconRows,
'msg-citizen-footer-desc' => $skin->msg( 'citizen-footer-desc' )->text(),
'msg-citizen-footer-tagline' => $skin->msg( 'citizen-footer-tagline' )->text(),
];
return $data;
}
/**
* Get and pick the correct logo based on types and variants
* Based on getLogoData() in MW 1.36
*
* @return array
*/
private function getLogoData() : array {
$logoData = ResourceLoaderSkinModule::getAvailableLogos( $this->getConfig() );
// check if the logo supports variants
$variantsLogos = $logoData['variants'] ?? null;
if ( $variantsLogos ) {
$preferred = $this->getOutput()->getTitle()
->getPageViewLanguage()->getCode();
$variantOverrides = $variantsLogos[$preferred] ?? null;
// Overrides the logo
if ( $variantOverrides ) {
foreach ( $variantOverrides as $key => $val ) {
$logoData[$key] = $val;
}
}
}
return $logoData;
}
/**
* Render the navigation drawer
* Based on buildSidebar()
*
* @return array
* @throws MWException
* @throws Exception
*/
public function buildDrawer() {
$skin = $this;
$portals = parent::buildSidebar();
$props = [];
$languages = null;
// Render portals
foreach ( $portals as $name => $content ) {
if ( $content === false ) {
continue;
}
// Numeric strings gets an integer when set as key, cast back - T73639
$name = (string)$name;
switch ( $name ) {
case 'SEARCH':
case 'TOOLBOX':
break;
case 'LANGUAGES':
$languages = $skin->getLanguages();
$portal = $this->getMenuData( 'lang', $content );
// The language portal will be added provided either
// languages exist or there is a value in html-after-portal
// for example to show the add language wikidata link (T252800)
if ( count( $content ) || $portal['html-after-portal'] ) {
$languages = $portal;
}
break;
default:
// Historically some portals have been defined using HTML rather than arrays.
// Let's move away from that to a uniform definition.
if ( !is_array( $content ) ) {
$html = $content;
$content = [];
wfDeprecated(
"`content` field in portal $name must be array."
. "Previously it could be a string but this is no longer supported.",
'1.35.0'
);
} else {
$html = false;
}
$portal = $this->getMenuData( $name, $content );
if ( $html ) {
$portal['html-items'] .= $html;
}
$props[] = $portal;
break;
}
}
$firstPortal = $props[0] ?? null;
if ( $firstPortal ) {
$firstPortal[ 'class' ] .= ' portal-first';
// Hide label for first portal
$firstPortal[ 'label-class' ] .= 'screen-reader-text';
if ( isset( $firstPortal['html-items'] ) ) {
$this->addToolboxLinksToDrawer( $firstPortal['html-items'] );
}
}
return [
'msg-citizen-drawer-toggle' => $skin->msg( 'citizen-drawer-toggle' )->text(),
'data-portals-first' => $firstPortal,
'array-portals-rest' => array_slice( $props, 1 ),
'data-portals-languages' => $languages,
'data-footer' => $footer->getFooterData(),
];
}
/**
* @inheritDoc
*
* Manually disable links to upload and speacial pages
* as they are moved from the toolbox to the drawer
* Change access to public, as it is used in partials
*
* @return array
*/
protected function buildNavUrls() {
$urls = parent::buildNavUrls();
$urls['upload'] = false;
$urls['specialpages'] = false;
return $urls;
final public function buildPersonalUrls() {
return parent::buildPersonalUrls();
}
/**
* Add a link to special pages and the upload form to the first portal in the drawer
*
* @param string &$htmlItems
*
* @return void
*/
private function addToolboxLinksToDrawer( &$htmlItems ) {
// First add a link to special pages
$htmlItems .= $this->makeListItem( 'specialpages', [
'href' => self::makeSpecialUrl( 'Specialpages' ),
'id' => 't-specialpages'
] );
// Then add a link to the upload form
$htmlItems .= $this->makeListItem( 'upload', [
'href' => self::makeSpecialUrl( 'Upload' ),
'id' => 't-upload'
] );
}
/**
* Build Personal Tools menu
* Change access to public, as it is used in partials
*
* @return array
*/
private function buildPersonalMenu(): array {
$skin = $this;
$personalTools = $this->getPersonalToolsForMakeListItem(
$this->buildPersonalUrls()
);
// Move the Echo badges and ULS out of default list
if ( isset( $personalTools['notifications-alert'] ) ) {
unset( $personalTools['notifications-alert'] );
}
if ( isset( $personalTools['notifications-notice'] ) ) {
unset( $personalTools['notifications-notice'] );
}
if ( isset( $personalTools['uls'] ) ) {
unset( $personalTools['uls'] );
}
if ( $this->getUser()->isLoggedIn() ) {
$personalTools = $this->addUserGroupsToMenu( $personalTools );
}
$personalMenu = $this->getMenuData( 'personal', $personalTools );
// Hide label for personal tools
$personalMenu[ 'label-class' ] .= 'screen-reader-text';
return [
'msg-citizen-personalmenu-toggle' => $skin->msg( 'citizen-personalmenu-toggle' )->text(),
'data-personal-menu-list' => $personalMenu,
];
final public function getFooterLinks() {
return parent::getFooterLinks();
}
/**
* This adds all explicit user groups as links to the personal menu
* Links are added right below the user page link
* Wrapped in an <li> element with id 'pt-usergroups'
*
* @param array $originalUrls The original personal tools urls
* Change access to public, as it is used in partials
*
* @return array
*/
private function addUserGroupsToMenu( $originalUrls ) {
$personalTools = [];
// This does not return implicit groups
$groups = MediaWikiServices::getInstance()->getUserGroupManager()->getUserGroups( $this->getUser() );
// If the user has only implicit groups return early
if ( empty( $groups ) ) {
return $originalUrls;
}
$userPage = array_shift( $originalUrls );
$groupLinks = [];
$msgName = 'group-%s';
foreach ( $groups as $group ) {
$groupPage = Title::newFromText(
$this->msg( sprintf( $msgName, $group ) )->text(),
NS_PROJECT
);
$groupLinks[$group] = [
'msg' => sprintf( $msgName, $group ),
'href' => $groupPage->getLinkURL(), // Nullpointer should not happen
'tooltiponly' => true,
'id' => sprintf( $msgName, $group ),
// 'exists' => $groupPage->exists() - This will add an additional DB call
];
}
$userGroups = [
'id' => 'pt-usergroups',
'links' => $groupLinks
];
// The following defines the order of links added
$personalTools['userpage'] = $userPage;
$personalTools['usergroups'] = $userGroups;
foreach ( $originalUrls as $key => $url ) {
$personalTools[$key] = $url;
}
return $personalTools;
final public function getFooterIcons() {
return parent::getFooterIcons();
}
/**
* Echo notification badges and ULS button
* Change access to public, as it is used in partials
*
* @return array
*/
private function getExtratools(): array {
$personalTools = $this->getPersonalToolsForMakeListItem(
$this->buildPersonalUrls()
);
// Create the Echo badges and ULS
$extraTools = [];
if ( isset( $personalTools['notifications-alert'] ) ) {
$extraTools['notifications-alert'] = $personalTools['notifications-alert'];
}
if ( isset( $personalTools['notifications-notice'] ) ) {
$extraTools['notifications-notice'] = $personalTools['notifications-notice'];
}
if ( isset( $personalTools['uls'] ) ) {
$extraTools['uls'] = $personalTools['uls'];
}
$html = $this->getMenuData( 'personal-extra', $extraTools );
// Hide label for extra tools
$html[ 'label-class' ] .= 'screen-reader-text';
return $html;
}
/**
* Render the search box
*
* @return array
* @throws MWException
*/
private function buildSearchProps() : array {
$skin = $this->getSkin();
$toggleMsg = $skin->msg( 'citizen-search-toggle' )->text();
$accessKey = Linker::accesskey( 'search' );
return [
'msg-citizen-search-toggle' => $toggleMsg,
'msg-citizen-search-toggle-shortcut' => $toggleMsg . ' [alt-shift-' . $accessKey . ']',
'form-action' => $this->getConfigValue( 'Script' ),
'html-input' => $this->makeSearchInput( [ 'id' => 'searchInput' ] ),
'msg-search' => $skin->msg( 'search' ),
'page-title' => SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey(),
'html-random-href' => Skin::makeSpecialUrl( 'Randompage' ),
'msg-random' => $skin->msg( 'Randompage' )->text(),
];
}
/**
* Render the theme toggle
*
* @return array
* @throws MWException
*/
private function buildThemeToggleProps() : array {
$skin = $this->getSkin();
$toggleMsg = $skin->msg( 'citizen-theme-toggle' )->text();
return [
'msg-citizen-theme-toggle-shortcut' => $toggleMsg,
];
}
/**
* Render page-related tools
* Possible visibility conditions:
* * true: always visible (bool)
* * false: never visible (bool)
* * 'login': only visible if logged in (string)
* * 'permission-*': only visible if user has permission
* e.g. permission-edit = only visible if user can edit pages
*
* @return array html
*/
protected function buildPageTools(): array {
$skin = $this;
$condition = $this->getConfigValue( 'CitizenShowPageTools' );
$contentNavigation = parent::buildContentNavigationUrls();
$portals = parent::buildSidebar();
$props = [];
// Login-based condition, return true if condition is met
if ( $condition === 'login' ) {
$condition = $skin->getUser()->isLoggedIn();
}
// Permission-based condition, return true if condition is met
if ( is_string( $condition ) && strpos( $condition, 'permission' ) === 0 ) {
$permission = substr( $condition, 11 );
try {
$condition = MediaWikiServices::getInstance()->getPermissionManager()->userCan(
$permission, $skin->getUser(), $skin->getTitle() );
} catch ( Exception $e ) {
$condition = false;
}
}
if ( $condition === true ) {
$viewshtml = $this->getMenuData( 'views', $contentNavigation[ 'views' ] ?? [] );
$actionshtml = $this->getMenuData( 'actions', $contentNavigation[ 'actions' ] ?? [] );
$toolboxhtml = $this->getMenuData( 'tb', $portals['TOOLBOX'] ?? [] );
if ( $viewshtml ) {
$viewshtml[ 'label-class' ] .= 'screen-reader-text';
}
if ( $actionshtml ) {
$actionshtml[ 'label-class' ] .= 'screen-reader-text';
}
$props = [
'data-page-views' => $viewshtml,
'data-page-actions' => $actionshtml,
'data-page-toolbox' => $toolboxhtml,
];
}
return $props;
}
/**
* Render page-related links at the bottom
*
* @return array html
*/
private function buildPageLinks() : array {
$contentNavigation = $this->buildContentNavigationUrls();
$namespaceshtml = $this->getMenuData( 'namespaces', $contentNavigation[ 'namespaces' ] ?? [] );
$variantshtml = $this->getMenuData( 'variants', $contentNavigation[ 'variants' ] ?? [] );
if ( $namespaceshtml ) {
$namespaceshtml[ 'label-class' ] .= 'screen-reader-text';
}
if ( $variantshtml ) {
$variantshtml[ 'label-class' ] .= 'screen-reader-text';
}
return [
'data-namespaces' => $namespaceshtml,
'data-variants' => $variantshtml,
];
final public function buildContentNavigationUrls() {
return parent::buildContentNavigationUrls();
}
/**
@ -679,7 +211,7 @@ class SkinCitizen extends SkinMustache {
* @param array $options (optional) to be passed to makeListItem
* @return array
*/
private function getMenuData(
public function getMenuData(
string $label,
array $urls = [],
array $options = []
@ -713,217 +245,19 @@ class SkinCitizen extends SkinMustache {
}
/**
* getConfig() wrapper to catch exceptions.
* Returns null on exception
* @inheritDoc
*
* @param string $key
* @return mixed|null
* @see SkinTemplate::getConfig()
*/
private function getConfigValue( $key ) {
try {
$value = $this->getConfig()->get( $key );
} catch ( ConfigException $e ) {
$value = null;
}
return $value;
}
/**
* Adds the manifest if enabled in 'CitizenEnableManifest'.
* Manifest link will be empty if wfExpandUrl throws an exception.
*/
private function addManifest() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnableManifest' ) === true ) {
try {
$href =
wfExpandUrl( wfAppendQuery( wfScript( 'api' ),
[ 'action' => 'webapp-manifest' ] ), PROTO_RELATIVE );
} catch ( Exception $e ) {
$href = '';
}
$out->addLink( [
'rel' => 'manifest',
'href' => $href,
] );
}
}
/**
* Adds a preconnect header if enabled in 'CitizenEnablePreconnect'
*/
private function addPreConnect() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnablePreconnect' ) === true ) {
$out->addLink( [
'rel' => 'preconnect',
'href' => $this->getConfigValue( 'CitizenPreconnectURL' ),
] );
}
}
/**
* Adds the csp directive if enabled in 'CitizenEnableCSP'.
* Directive holds the content of 'CitizenCSPDirective'.
*/
private function addCSP() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnableCSP' ) === true ) {
$cspDirective = $this->getConfigValue( 'CitizenCSPDirective' ) ?? '';
$cspMode = 'Content-Security-Policy';
// Check if report mode is enabled
if ( $this->getConfigValue( 'CitizenEnableCSPReportMode' ) === true ) {
$cspMode = 'Content-Security-Policy-Report-Only';
}
$out->getRequest()->response()->header( sprintf( '%s: %s', $cspMode,
$cspDirective ) );
}
}
/**
* Adds the HSTS Header. If no max age or an invalid max age is set a default of 300 will be
* applied.
* Preload and Include Subdomains can be enabled by setting 'CitizenHSTSIncludeSubdomains'
* and/or 'CitizenHSTSPreload' to true.
*/
private function addHSTS() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnableHSTS' ) === true ) {
$maxAge = $this->getConfigValue( 'CitizenHSTSMaxAge' );
$includeSubdomains = $this->getConfigValue( 'CitizenHSTSIncludeSubdomains' ) ?? false;
$preload = $this->getConfigValue( 'CitizenHSTSPreload' ) ?? false;
// HSTS max age
if ( is_int( $maxAge ) ) {
$maxAge = max( $maxAge, 0 );
} else {
// Default to 5 mins if input is invalid
$maxAge = 300;
}
$hstsHeader = 'Strict-Transport-Security: max-age=' . $maxAge;
if ( $includeSubdomains ) {
$hstsHeader .= '; includeSubDomains';
}
if ( $preload ) {
$hstsHeader .= '; preload';
}
$out->getRequest()->response()->header( $hstsHeader );
}
}
/**
* Adds the X-Frame-Options header if set in 'CitizenEnableDenyXFrameOptions'
*/
private function addXFrameOptions() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnableDenyXFrameOptions' ) === true ) {
$out->getRequest()->response()->header( 'X-Frame-Options: deny' );
}
}
/**
* Adds the X-XSS-Protection header if set in 'CitizenEnableXXSSProtection'
*/
private function addXXSSProtection() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnableXXSSProtection' ) === true ) {
$out->getRequest()->response()->header( 'X-XSS-Protection: 1; mode=block' );
}
}
/**
* Adds the referrer header if enabled in 'CitizenEnableStrictReferrerPolicy'
*/
private function addStrictReferrerPolicy() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnableStrictReferrerPolicy' ) === true ) {
// iOS Safari, IE, Edge compatiblity
$out->getRequest()->response()->header( 'Referrer-Policy: strict-origin' );
$out->getRequest()->response()->header( 'Referrer-Policy: strict-origin-when-cross-origin' );
}
}
/**
* Adds the Feature policy header to the response if enabled in 'CitizenFeaturePolicyDirective'
*/
private function addFeaturePolicy() {
$out = $this->getOutput();
if ( $this->getConfigValue( 'CitizenEnableFeaturePolicy' ) === true ) {
$featurePolicy = $this->getConfigValue( 'CitizenFeaturePolicyDirective' ) ?? '';
$out->getRequest()->response()->header( sprintf( 'Feature-Policy: %s',
$featurePolicy ) );
}
}
/**
* Sets the corresponding theme class on the <html> element
* If the theme is set to auto, the theme switcher script will be added
* Manually disable links to upload and special pages
* as they are moved from the toolbox to the drawer
*
* @param OutputPage $out
* @param array &$options
* @return array
*/
private function setSkinTheme( OutputPage $out, array &$options ) {
// Set theme to site theme
$theme = $this->getConfigValue( 'CitizenThemeDefault' ) ?? 'auto';
protected function buildNavUrls() {
$urls = parent::buildNavUrls();
// Set theme to user theme if registered
if ( $this->getUser()->isRegistered() ) {
$theme = MediaWikiServices::getInstance()->getUserOptionsLookup()->getOption(
$this->getUser(),
'CitizenThemeUser',
'auto'
);
}
$urls['upload'] = false;
$urls['specialpages'] = false;
$cookieTheme = $this->getRequest()->getCookie( 'skin-citizen-theme', null, 'auto' );
if ( $cookieTheme !== 'auto' ) {
$theme = $cookieTheme;
}
// Add HTML class based on theme set
$out->addHtmlClasses( 'skin-citizen-' . $theme );
if ( $this->getRequest()->getCookie( 'skin-citizen-theme-override' ) === null ) {
// Only set the theme cookie if the theme wasn't overridden by the user through the button
$this->getRequest()->response()->setCookie( 'skin-citizen-theme', $theme, 0, [
'httpOnly' => false,
] );
}
// Script content at 'skins.citizen.scripts.theme/inline.js
$this->getOutput()->addHeadItem( 'theme-switcher', '<script>window.switchTheme=(()=>{try{const t=document.cookie.match(/skin-citizen-theme=(dark|light|auto)/),e=null!==t?t.pop():null;null!==e&&(document.documentElement.classList.remove(...["auto","dark","light"].map(t=>"skin-citizen-"+t)),document.documentElement.classList.add("skin-citizen-"+e))}catch(t){}}),window.switchTheme();</script>' );
// Add styles and scripts module
if ( $theme === 'auto' ) {
$options['scripts'] = array_merge(
$options['scripts'],
[ 'skins.citizen.scripts.theme' ]
);
}
$options['styles'] = array_merge(
$options['styles'],
[ 'skins.citizen.styles.theme' ]
);
return $urls;
}
}

25
skin.json
View file

@ -50,7 +50,6 @@
},
"AutoloadClasses": {
"SkinCitizen": "includes/SkinCitizen.php",
"Citizen\\CitizenHooks": "includes/CitizenHooks.php",
"Citizen\\ApiWebappManifest": "includes/api/ApiWebappManifest.php"
},
"AutoloadNamespaces": {
@ -64,12 +63,26 @@
"class": "Citizen\\ApiWebappManifest"
}
},
"HookHandlers": {
"PreferenceHooks": {
"class": "Citizen\\Hooks\\PreferenceHooks"
},
"ResourceLoaderHooks": {
"class": "Citizen\\Hooks\\ResourceLoaderHooks"
},
"SkinHooks": {
"class": "Citizen\\Hooks\\SkinHooks"
},
"ThumbnailHooks": {
"class": "Citizen\\Hooks\\ThumbnailHooks"
}
},
"Hooks": {
"ResourceLoaderGetConfigVars": "Citizen\\CitizenHooks::onResourceLoaderGetConfigVars",
"SkinPageReadyConfig": "Citizen\\CitizenHooks::onSkinPageReadyConfig",
"ThumbnailBeforeProduceHTML": "Citizen\\CitizenHooks::onThumbnailBeforeProduceHTML",
"GetPreferences": "Citizen\\CitizenHooks::onGetPreferences",
"PreferencesFormPreSave": "Citizen\\CitizenHooks::onPreferencesFormPreSave"
"ResourceLoaderGetConfigVars": "ResourceLoaderHooks",
"SkinPageReadyConfig": "SkinHooks",
"ThumbnailBeforeProduceHTML": "ThumbnailHooks",
"GetPreferences": "PreferenceHooks",
"PreferencesFormPreSave": "PreferenceHooks"
},
"ResourceModules": {
"skins.citizen.styles": {