Page MenuHomeWickedGov Phorge
Files F5967697

SpecialHideBanners.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

SpecialHideBanners.php
View Options

<?php
use MediaWiki\Extension\CentralAuth\User\CentralAuthUser;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\SpecialPage\UnlistedSpecialPage;
/**
* Unlisted Special Page which sets a cookie for hiding banners across all languages of a project.
* This is typically used on donation thank-you pages so that users who have donated will no longer
* see fundrasing banners.
*/
class SpecialHideBanners extends UnlistedSpecialPage {
// Cache this blank response for a day or so (60 * 60 * 24 s.)
private const CACHE_EXPIRY = 86400;
private const P3P_SUBPAGE = 'P3P';
public function __construct() {
parent::__construct( 'HideBanners' );
}
/** @inheritDoc */
public function execute( $par ) {
$config = $this->getConfig();
// Handle /P3P subpage with explanation of invalid P3P header
if ( ( strval( $par ) === self::P3P_SUBPAGE ) &&
!$config->get( 'CentralNoticeHideBannersP3P' )
) {
$this->setHeaders();
$this->getOutput()->addWikiMsg( 'centralnotice-specialhidebanners-p3p' );
return;
}
$reason = $this->getRequest()->getText( 'reason', 'donate' );
// No duration parameter for a custom reason is not expected; we have a
// fallback value, but we log that this happened.
$duration = $this->getRequest()->getInt( 'duration', 0 );
if ( !$duration ) {
$noticeCookieDurations = $config->get( 'NoticeCookieDurations' );
if ( isset( $noticeCookieDurations[$reason] ) ) {
$duration = $noticeCookieDurations[$reason];
} else {
$duration = $config->get( 'CentralNoticeFallbackHideCookieDuration' );
wfLogWarning( 'Missing or 0 duration for hide cookie reason '
. $reason . '.' );
}
}
$category = $this->getRequest()->getText( 'category', 'fundraising' );
$category = Banner::sanitizeRenderedCategory( $category );
$this->setHideCookie( $category, $duration, $reason );
$this->setP3P();
$this->getOutput()->disable();
wfResetOutputBuffers();
header( 'Content-Type: image/png' );
if ( !$this->getUser()->isRegistered() ) {
$expiry = self::CACHE_EXPIRY;
header( "Cache-Control: public, s-maxage={$expiry}, max-age=0" );
}
}
/**
* Set the cookie for hiding fundraising banners.
* @param string $category
* @param int $duration
* @param string $reason
*/
private function setHideCookie( $category, $duration, $reason ) {
$created = time();
$exp = $created + $duration;
$value = [
'v' => 1,
'created' => $created,
'reason' => $reason
];
if ( ExtensionRegistry::getInstance()->isLoaded( 'CentralAuth' ) ) {
$cookieDomain = CentralAuthUser::getCookieDomain();
} else {
$cookieDomain = $this->getConfig()->get( 'NoticeCookieDomain' );
}
setcookie(
"centralnotice_hide_{$category}",
json_encode( $value ),
[
'expires' => $exp,
'path' => '/',
'domain' => $cookieDomain,
'secure' => true,
'httponly' => false,
'samesite' => 'None',
]
);
}
/**
* Set an invalid P3P policy header to make IE accept third-party hide cookies.
*/
private function setP3P() {
$centralNoticeHideBannersP3P = $this->getConfig()->get( 'CentralNoticeHideBannersP3P' );
if ( !$centralNoticeHideBannersP3P ) {
$url = SpecialPage::getTitleFor(
'HideBanners', self::P3P_SUBPAGE )
->getCanonicalURL();
$p3p = "CP=\"This is not a P3P policy! See $url for more info.\"";
} else {
$p3p = $centralNoticeHideBannersP3P;
}
header( "P3P: $p3p", true );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 12:34 (2 d, 23 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
5d/ca/3e377dc884cb6436cd160fa89915
Default Alt Text
SpecialHideBanners.php (3 KB)

Event Timeline