Page MenuHomeWickedGov Phorge
Files F4139744

ClientHints.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ClientHints.php
View Options

<?php
namespace MediaWiki\CheckUser\HookHandler;
use MediaWiki\Config\Config;
use MediaWiki\Output\Hook\BeforePageDisplayHook;
use MediaWiki\SpecialPage\Hook\SpecialPageBeforeExecuteHook;
/**
* HookHandler for entry points related to requesting User-Agent Client Hints data.
*/
class ClientHints implements SpecialPageBeforeExecuteHook, BeforePageDisplayHook {
private Config $config;
/**
* @param Config $config
*/
public function __construct( Config $config ) {
$this->config = $config;
}
/** @inheritDoc */
public function onSpecialPageBeforeExecute( $special, $subPage ) {
if ( !$this->config->get( 'CheckUserClientHintsEnabled' ) ) {
return;
}
$request = $special->getRequest();
if ( $request->wasPosted() ) {
// It's too late to ask for client hints when a user is POST'ing a form.
if ( $this->config->get( 'CheckUserClientHintsUnsetHeaderWhenPossible' ) ) {
$request->response()->header( $this->getEmptyClientHintsHeaderString() );
}
return;
}
if ( in_array( $special->getName(), $this->config->get( 'CheckUserClientHintsSpecialPages' ) ) ) {
$request->response()->header( $this->getClientHintsHeaderString() );
} elseif ( $this->config->get( 'CheckUserClientHintsUnsetHeaderWhenPossible' ) ) {
$request->response()->header( $this->getEmptyClientHintsHeaderString() );
}
}
/** @inheritDoc */
public function onBeforePageDisplay( $out, $skin ): void {
// We handle special pages in BeforeSpecialPageBeforeExecute.
if ( $out->getTitle()->isSpecialPage() ||
// ClientHints is globally disabled
!$this->config->get( 'CheckUserClientHintsEnabled' )
) {
return;
}
$out->addJsConfigVars( [
// Roundabout way to ensure we have a list of values like "architecture", "bitness"
// etc for use with the client-side JS API. Make sure we get 1) just the values
// from the configuration, 2) filter out any empty entries, 3) convert to a list
'wgCheckUserClientHintsHeadersJsApi' => array_values( array_filter( array_values(
$this->config->get( 'CheckUserClientHintsHeaders' )
) ) ),
] );
$out->addModules( 'ext.checkUser.clientHints' );
if ( $this->config->get( 'CheckUserClientHintsUnsetHeaderWhenPossible' ) ) {
$request = $out->getRequest();
$request->response()->header( $this->getEmptyClientHintsHeaderString() );
}
}
/**
* Get the list of headers to use with Accept-CH.
*
* @return string
*/
private function getClientHintsHeaderString(): string {
$headers = implode(
', ',
array_filter( array_keys( $this->config->get( 'CheckUserClientHintsHeaders' ) ) )
);
return "Accept-CH: $headers";
}
/**
* Get an Accept-CH header string to tell the client to stop sending client-hint data.
*
* @return string
*/
private function getEmptyClientHintsHeaderString(): string {
return "Accept-CH: ";
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 15:12 (3 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
6d/4a/ce609607266efcdfb68a1b4fa8d1
Default Alt Text
ClientHints.php (2 KB)

Event Timeline