user = $context->getUser(); $this->context = $context; $this->specialPageFactory = $factory; $this->userOptionsLookup = $userOptionsLookup; } /** * Creates a login or logout button with a profile button. * * @param Group $group * @throws MWException */ public function insertAuthMenuItem( Group $group ) { $group->insertEntry( new AuthMenuEntry( $this->user, $this->context, $this->newLogInOutQuery( $this->newReturnToQuery() ) ) ); } /** * Perform message localization * @param string $key to localize * @return string */ public function msg( string $key ) { return $this->context->msg( $key ); } /** * If Nearby is supported, build and inject the Nearby link * @param Group $group * @throws MWException */ public function insertNearbyIfSupported( Group $group ) { // Nearby link (if supported) if ( $this->specialPageFactory->exists( 'Nearby' ) ) { $group->insert( 'nearby', $isJSOnly = true ) ->addComponent( $this->context->msg( 'mobile-frontend-main-menu-nearby' )->text(), SpecialPage::getTitleFor( 'Nearby' )->getLocalURL(), '', [ 'data-event-name' => 'menu.nearby' ], 'minerva-mapPin' ); } } /** * Build and insert the Settings link * @param Group $group * @throws MWException */ public function insertMobileOptionsItem( Group $group ) { $title = $this->context->getTitle(); $config = $this->context->getConfig(); $returnToTitle = $title->getPrefixedText(); $user = $this->user; $betaEnabled = $config->get( 'MFEnableBeta' ); /* * to avoid linking to an empty settings page we make this jsonly when: * - AMC and beta is disabled (if logged in there is nothing to show) * - user is logged out and beta is disabled (beta is the only thing a non-js user can do) * In future we might want to make this a static function on Special:MobileOptions. */ $jsonly = ( !$user->isRegistered() && !$betaEnabled ) || ( $user->isRegistered() && !$config->get( 'MFAdvancedMobileContributions' ) && !$betaEnabled ); $item = SingleMenuEntry::create( 'settings', $this->context->msg( 'mobile-frontend-main-menu-settings' )->text(), SpecialPage::getTitleFor( 'MobileOptions' ) ->getLocalURL( [ 'returnto' => $returnToTitle ] ) ); if ( $jsonly ) { $item->setJSOnly(); } $group->insertEntry( $item ); } /** * Build and insert the Preferences link * @param Group $group * @throws MWException */ public function insertPreferencesItem( Group $group ) { $entry = SingleMenuEntry::create( 'preferences', $this->context->msg( 'preferences' )->text(), SpecialPage::getTitleFor( 'Preferences' )->getLocalURL() ); $entry->setIcon( 'settings' ); $group->insertEntry( $entry ); } /** * Build and insert About page link * @param Group $group */ public function insertAboutItem( Group $group ) { $title = Title::newFromText( $this->context->msg( 'aboutpage' )->inContentLanguage()->text() ); $msg = $this->context->msg( 'aboutsite' ); if ( $title && !$msg->isDisabled() ) { $group->insert( 'about' ) ->addComponent( $msg->text(), $title->getLocalURL() ); } } /** * Build and insert Disclaimers link * @param Group $group */ public function insertDisclaimersItem( Group $group ) { $title = Title::newFromText( $this->context->msg( 'disclaimerpage' ) ->inContentLanguage()->text() ); $msg = $this->context->msg( 'disclaimers' ); if ( $title && !$msg->isDisabled() ) { $group->insert( 'disclaimers' ) ->addComponent( $msg->text(), $title->getLocalURL() ); } } /** * Build and insert the RecentChanges link * @param Group $group * @throws MWException */ public function insertRecentChanges( Group $group ) { $title = SpecialPage::getTitleFor( 'Recentchanges' ); $group->insert( 'recentchanges' ) ->addComponent( $this->context->msg( 'recentchanges' )->escaped(), $title->getLocalURL(), '', [ 'data-event-name' => 'menu.recentchanges' ], 'minerva-recentChanges' ); } /** * Build and insert the SpecialPages link * @param Group $group * @throws MWException */ public function insertSpecialPages( Group $group ) { $group->insertEntry( SingleMenuEntry::create( 'specialPages', $this->context->msg( 'specialpages' )->text(), SpecialPage::getTitleFor( 'Specialpages' )->getLocalURL() ) ); } /** * Build and insert the CommunityPortal link * @param Group $group * @throws MWException */ public function insertCommunityPortal( Group $group ) { $title = Title::newFromText( $this->context->msg( 'portal-url' ) ->inContentLanguage()->text() ); $msg = $this->context->msg( 'portal' ); if ( $title && !$msg->isDisabled() ) { $group->insertEntry( SingleMenuEntry::create( 'speechBubbles', $msg->text(), $title->getLocalURL() ) ); } } /** * @param array $returnToQuery * @return array */ private function newLogInOutQuery( array $returnToQuery ): array { $ret = []; $title = $this->context->getTitle(); if ( $title && !$title->isSpecial( 'Userlogin' ) ) { $ret[ 'returnto' ] = $title->getPrefixedText(); } if ( $this->user && !$this->user->isRegistered() ) { // unset campaign on login link so as not to interfere with A/B tests unset( $returnToQuery['campaign'] ); } if ( !empty( $returnToQuery ) ) { $ret['returntoquery'] = wfArrayToCgi( $returnToQuery ); } return $ret; } /** * Retrieve current query parameters from Request object so system can pass those * to the Login/logout links * Some parameters are disabled (like title), as the returnto will be replaced with * the current page. * @return array */ private function newReturnToQuery(): array { $returnToQuery = []; if ( !$this->context->getRequest()->wasPosted() ) { $returnToQuery = $this->context->getRequest()->getValues(); unset( $returnToQuery['title'] ); unset( $returnToQuery['returnto'] ); unset( $returnToQuery['returntoquery'] ); } return $returnToQuery; } /** * Insert the Donate Link in the Mobile Menu. * * @param Group $group * @throws MWException */ public function insertDonateItem( Group $group ) { $ctx = $this->context; if ( !$ctx->msg( 'sitesupport-url' )->exists() || $ctx->msg( 'sitesupport' )->isDisabled() ) { return; } // Add term field to allow distinguishing from other sidebars. // https://www.mediawiki.org/wiki/Wikimedia_Product/Analytics_Infrastructure/Schema_fragments#Campaign_Attribution $url = wfAppendQuery( $ctx->msg( 'sitesupport-url' )->text(), [ 'utm_key' => 'minerva' ] ); $group->insert( 'donate' )->addComponent( $ctx->msg( 'sitesupport' )->text(), $url, '', [ // for consistency with desktop 'id' => 'n-sitesupport', 'data-event-name' => 'menu.donate', ], 'minerva-heart' ); } }