grantsLocalization = $grantsLocalization; } public function doesWrites() { return true; } public function execute( $par ) { $user = $this->getUser(); $permissionManager = MediaWikiServices::getInstance()->getPermissionManager(); $this->setHeaders(); $this->getOutput()->disallowUserJs(); $this->addHelpLink( 'Help:OAuth' ); $this->requireNamedUser( 'mwoauth-available-only-to-registered' ); if ( !$permissionManager->userHasRight( $user, 'mwoauthmanageconsumer' ) ) { throw new PermissionsError( 'mwoauthmanageconsumer' ); } if ( $this->getConfig()->get( 'MWOAuthReadOnly' ) ) { throw new ErrorPageError( 'mwoauth-error', 'mwoauth-db-readonly' ); } // Format is Special:OAuthManageConsumers[/|/] // B/C format is Special:OAuthManageConsumers// $consumerKey = null; $navigation = $par !== null ? explode( '/', $par ) : []; if ( count( $navigation ) === 2 ) { $this->stage = false; $consumerKey = $navigation[1]; } elseif ( count( $navigation ) === 1 && $navigation[0] ) { $this->stage = array_search( $navigation[0], Consumer::$stageNames, true ); if ( $this->stage !== false ) { $this->stageKey = $navigation[0]; } else { $consumerKey = $navigation[0]; } } if ( $consumerKey ) { $this->handleConsumerForm( $consumerKey ); } elseif ( $this->stage !== false ) { $this->showConsumerList(); } else { $this->showMainHub(); } $this->addQueueSubtitleLinks( $consumerKey ); $this->getOutput()->addModuleStyles( 'ext.MWOAuth.styles' ); } /** * Show other sub-queue links. Grey out the current one. * When viewing a request, show them all and a link to current consumer view. * * @param string|null $consumerKey * @return void */ protected function addQueueSubtitleLinks( $consumerKey ) { $linkRenderer = $this->getLinkRenderer(); $listLinks = []; foreach ( self::$queueStages as $stage ) { $stageKey = Consumer::$stageNames[$stage]; if ( $consumerKey || $this->stageKey !== $stageKey ) { $listLinks[] = $linkRenderer->makeKnownLink( $this->getPageTitle( $stageKey ), // Messages: mwoauthmanageconsumers-showproposed, // mwoauthmanageconsumers-showrejected, mwoauthmanageconsumers-showexpired, $this->msg( 'mwoauthmanageconsumers-show' . $stageKey )->text() ); } else { $listLinks[] = $this->msg( 'mwoauthmanageconsumers-show' . $stageKey )->escaped(); } } if ( $consumerKey ) { $consumerViewLink = "[" . $linkRenderer->makeKnownLink( SpecialPage::getTitleFor( 'OAuthListConsumers', "view/$consumerKey" ), $this->msg( 'mwoauthconsumer-consumer-view' )->text() ) . "]"; } else { $consumerViewLink = ''; } $linkHtml = $this->getLanguage()->pipeList( $listLinks ); $viewall = $this->msg( 'parentheses' )->rawParams( $linkRenderer->makeKnownLink( $this->getPageTitle(), $this->msg( 'mwoauthmanageconsumers-main' )->text() ) )->escaped(); $this->getOutput()->setSubtitle( "" . $this->msg( 'mwoauthmanageconsumers-type' )->escaped() . " [{$linkHtml}] {$consumerViewLink} {$viewall}" ); } /** * Show the links to all the queues and how many requests are in each. * Also show the list of enabled and disabled consumers and how many there are of each. * * @return void */ protected function showMainHub() { $keyStageMapQ = array_intersect( array_flip( Consumer::$stageNames ), self::$queueStages ); $keyStageMapL = array_intersect( array_flip( Consumer::$stageNames ), self::$listStages ); $linkRenderer = $this->getLinkRenderer(); $out = $this->getOutput(); $out->addWikiMsg( 'mwoauthmanageconsumers-maintext' ); $counts = Utils::getConsumerStateCounts( Utils::getCentralDB( DB_REPLICA ) ); $out->wrapWikiMsg( "

$1

", 'mwoauthmanageconsumers-queues' ); $out->addHTML( '
    ' ); foreach ( $keyStageMapQ as $stageKey => $stage ) { $tag = ( $stage === Consumer::STAGE_EXPIRED ) ? 'i' : 'b'; $out->addHTML( '
  • ' . "<$tag>" . $linkRenderer->makeKnownLink( $this->getPageTitle( $stageKey ), // Messages: mwoauthmanageconsumers-q-proposed, mwoauthmanageconsumers-q-rejected, // mwoauthmanageconsumers-q-expired $this->msg( 'mwoauthmanageconsumers-q-' . $stageKey )->text() ) . " [$counts[$stage]]" . '
    • ' ); } $out->addHTML( '
' ); $out->wrapWikiMsg( "

$1

", 'mwoauthmanageconsumers-lists' ); $out->addHTML( '
    ' ); foreach ( $keyStageMapL as $stageKey => $stage ) { $out->addHTML( '
  • ' . $linkRenderer->makeKnownLink( $this->getPageTitle( $stageKey ), // Messages: mwoauthmanageconsumers-l-approved, mwoauthmanageconsumers-l-disabled $this->msg( 'mwoauthmanageconsumers-l-' . $stageKey )->text() ) . " [$counts[$stage]]" . '
    • ' ); } $out->addHTML( '
' ); } /** * Show the form to approve/reject/disable/re-enable consumers * * @param string $consumerKey * @throws PermissionsError */ protected function handleConsumerForm( $consumerKey ) { $user = $this->getUser(); $dbr = Utils::getCentralDB( DB_REPLICA ); $cmrAc = ConsumerAccessControl::wrap( Consumer::newFromKey( $dbr, $consumerKey ), $this->getContext() ); $permissionManager = MediaWikiServices::getInstance()->getPermissionManager(); if ( !$cmrAc ) { $this->getOutput()->addWikiMsg( 'mwoauth-invalid-consumer-key' ); return; } elseif ( $cmrAc->getDeleted() && !$permissionManager->userHasRight( $user, 'mwoauthviewsuppressed' ) ) { throw new PermissionsError( 'mwoauthviewsuppressed' ); } $startingStage = $cmrAc->getStage(); $pending = !in_array( $startingStage, [ Consumer::STAGE_APPROVED, Consumer::STAGE_DISABLED ] ); if ( $pending ) { $opts = [ $this->msg( 'mwoauthmanageconsumers-approve' )->escaped() => 'approve', $this->msg( 'mwoauthmanageconsumers-reject' )->escaped() => 'reject' ]; if ( $permissionManager->userHasRight( $this->getUser(), 'mwoauthsuppress' ) ) { $msg = $this->msg( 'mwoauthmanageconsumers-rsuppress' )->escaped(); $opts["$msg"] = 'rsuppress'; } } else { $opts = [ $this->msg( 'mwoauthmanageconsumers-disable' )->escaped() => 'disable', $this->msg( 'mwoauthmanageconsumers-reenable' )->escaped() => 'reenable' ]; if ( $permissionManager->userHasRight( $this->getUser(), 'mwoauthsuppress' ) ) { $msg = $this->msg( 'mwoauthmanageconsumers-dsuppress' )->escaped(); $opts["$msg"] = 'dsuppress'; } } $dbw = Utils::getCentralDB( DB_PRIMARY ); $control = new ConsumerSubmitControl( $this->getContext(), [], $dbw ); $form = HTMLForm::factory( 'ooui', $control->registerValidators( [ 'info' => [ 'type' => 'info', 'raw' => true, 'default' => UIUtils::generateInfoTable( $this->getInfoTableOptions( $cmrAc ), $this->getContext() ), ], 'action' => [ 'type' => 'radio', 'label-message' => 'mwoauthmanageconsumers-action', 'required' => true, 'options' => $opts, // no validate on GET 'default' => '', ], 'reason' => [ 'type' => 'text', 'label-message' => 'mwoauthmanageconsumers-reason', 'required' => true, ], 'consumerKey' => [ 'type' => 'hidden', 'default' => $cmrAc->getConsumerKey(), ], 'changeToken' => [ 'type' => 'hidden', 'default' => $cmrAc->getDAO()->getChangeToken( $this->getContext() ), ], ] ), $this->getContext() ); $form->setSubmitCallback( static function ( array $data, IContextSource $context ) use ( $control ) { $data['suppress'] = 0; if ( $data['action'] === 'dsuppress' ) { $data = [ 'action' => 'disable', 'suppress' => 1 ] + $data; } elseif ( $data['action'] === 'rsuppress' ) { $data = [ 'action' => 'reject', 'suppress' => 1 ] + $data; } $control->setInputParameters( $data ); return $control->submit(); } ); $form->setWrapperLegendMsg( 'mwoauthmanageconsumers-confirm-legend' ); $form->setSubmitTextMsg( 'mwoauthmanageconsumers-confirm-submit' ); $form->addPreHtml( $this->msg( 'mwoauthmanageconsumers-confirm-text' )->parseAsBlock() ); $status = $form->show(); if ( $status instanceof Status && $status->isOK() ) { /** @var Consumer $cmr */ // @phan-suppress-next-line PhanTypeArraySuspiciousNullable $cmr = $status->value['result']; '@phan-var Consumer $cmr'; $oldStageKey = Consumer::$stageNames[$startingStage]; $newStageKey = Consumer::$stageNames[$cmr->getStage()]; // Messages: mwoauthmanageconsumers-success-approved, mwoauthmanageconsumers-success-rejected, // mwoauthmanageconsumers-success-disabled $this->getOutput()->addWikiMsg( "mwoauthmanageconsumers-success-$newStageKey" ); $returnTo = Title::newFromText( 'Special:OAuthManageConsumers/' . $oldStageKey ); $this->getOutput()->addReturnTo( $returnTo, [], // Messages: mwoauthmanageconsumers-linkproposed, // mwoauthmanageconsumers-linkrejected, mwoauthmanageconsumers-linkexpired, // mwoauthmanageconsumers-linkapproved, mwoauthmanageconsumers-linkdisabled $this->msg( 'mwoauthmanageconsumers-link' . $oldStageKey )->text() ); } else { $out = $this->getOutput(); // Show all of the status updates $logPage = new LogPage( 'mwoauthconsumer' ); $out->addHTML( Xml::element( 'h2', null, $logPage->getName()->text() ) ); LogEventsList::showLogExtract( $out, 'mwoauthconsumer', '', '', [ 'conds' => [ 'ls_field' => 'OAuthConsumer', 'ls_value' => $cmrAc->getConsumerKey(), ], ] ); } } /** * @param ConsumerAccessControl $cmrAc * @return array */ protected function getInfoTableOptions( $cmrAc ) { $owner = $cmrAc->getUserName(); $lang = $this->getLanguage(); $link = $this->getLinkRenderer()->makeKnownLink( $title = SpecialPage::getTitleFor( 'OAuthListConsumers' ), $this->msg( 'mwoauthmanageconsumers-search-publisher' )->text(), [], [ 'publisher' => $owner ] ); $ownerLink = $cmrAc->escapeForHtml( $owner ) . ' ' . $this->msg( 'parentheses' )->rawParams( $link )->escaped(); $ownerOnly = $cmrAc->getDAO()->getOwnerOnly(); $restrictions = $cmrAc->getRestrictions(); $options = [ // Messages: mwoauth-consumer-stage-proposed, mwoauth-consumer-stage-rejected, // mwoauth-consumer-stage-expired, mwoauth-consumer-stage-approved, // mwoauth-consumer-stage-disabled 'mwoauth-consumer-stage' => $cmrAc->getDeleted() ? $this->msg( 'mwoauth-consumer-stage-suppressed' ) : $this->msg( 'mwoauth-consumer-stage-' . Consumer::$stageNames[$cmrAc->getStage()] ), 'mwoauth-consumer-key' => $cmrAc->getConsumerKey(), 'mwoauth-consumer-name' => new HtmlSnippet( $cmrAc->get( 'name', function ( $s ) { $link = $this->getLinkRenderer()->makeKnownLink( SpecialPage::getTitleFor( 'OAuthListConsumers' ), $this->msg( 'mwoauthmanageconsumers-search-name' )->text(), [], [ 'name' => $s ] ); return htmlspecialchars( $s ) . ' ' . $this->msg( 'parentheses' )->rawParams( $link )->escaped(); } ) ), 'mwoauth-consumer-version' => $cmrAc->getVersion(), 'mwoauth-oauth-version' => $cmrAc->getOAuthVersion() === Consumer::OAUTH_VERSION_2 ? $this->msg( 'mwoauth-oauth-version-2' ) : $this->msg( 'mwoauth-oauth-version-1' ), 'mwoauth-consumer-user' => new HtmlSnippet( $ownerLink ), 'mwoauth-consumer-description' => $cmrAc->getDescription(), 'mwoauth-consumer-owner-only-label' => $ownerOnly ? $this->msg( 'mwoauth-consumer-owner-only', $owner ) : null, 'mwoauth-consumer-callbackurl' => $ownerOnly ? null : $this->formatCallbackUrl( $cmrAc ), 'mwoauth-consumer-callbackisprefix' => $ownerOnly ? null : ( $cmrAc->getCallbackIsPrefix() ? $this->msg( 'htmlform-yes' ) : $this->msg( 'htmlform-no' ) ), 'mwoauth-consumer-grantsneeded' => $cmrAc->get( 'grants', function ( $grants ) use ( $lang ) { return $lang->semicolonList( $this->grantsLocalization->getGrantDescriptions( $grants, $lang ) ); } ), 'mwoauth-consumer-email' => $cmrAc->getEmail(), 'mwoauth-consumer-wiki' => $cmrAc->getWiki() ]; // Add OAuth2 specific parameters if ( $cmrAc->getOAuthVersion() === Consumer::OAUTH_VERSION_2 ) { /** @var ClientEntity $consumer */ $consumer = $cmrAc->getDAO(); $options += [ 'mwoauth-oauth2-is-confidential' => $consumer->isConfidential() ? $this->msg( 'htmlform-yes' ) : $this->msg( 'htmlform-no' ), 'mwoauth-oauth2-granttypes' => implode( ', ', array_map( function ( $grant ) { $map = [ 'authorization_code' => 'mwoauth-oauth2-granttype-auth-code', 'refresh_token' => 'mwoauth-oauth2-granttype-refresh-token', 'client_credentials' => 'mwoauth-oauth2-granttype-client-credentials' ]; return isset( $map[$grant] ) ? $this->msg( $map[$grant] ) : ''; }, $consumer->getAllowedGrants() ) ) ]; } // Add optional parameters $options += [ 'mwoauth-consumer-restrictions-json' => $restrictions instanceof MWRestrictions ? $restrictions->toJson( true ) : $restrictions, 'mwoauth-consumer-rsakey' => $cmrAc->getRsaKey(), ]; return $options; } /** * Format a callback URL. Usually this doesn't do anything nontrivial, but it adds a warning * to callback URLs with a special meaning. * @param ConsumerAccessControl $cmrAc * @return HtmlSnippet|string Formatted callback URL, as a plaintext or HTML string */ protected function formatCallbackUrl( ConsumerAccessControl $cmrAc ) { $url = $cmrAc->getCallbackUrl(); if ( $cmrAc->getDAO()->getCallbackIsPrefix() ) { $urlParts = wfParseUrl( $cmrAc->getDAO()->getCallbackUrl() ); if ( ( $urlParts['port'] ?? null ) === 1 ) { $warning = Html::element( 'span', [ 'class' => 'warning' ], $this->msg( 'mwoauth-consumer-callbackurl-warning' )->text() ); $url = new HtmlSnippet( $url . ' ' . $warning ); } } return $url; } /** * Show a paged list of consumers with links to details */ protected function showConsumerList() { $pager = new ManageConsumersPager( $this, [], $this->stage ); if ( $pager->getNumRows() ) { $this->getOutput()->addHTML( $pager->getNavigationBar() ); $this->getOutput()->addHTML( $pager->getBody() ); $this->getOutput()->addHTML( $pager->getNavigationBar() ); } else { // Messages: mwoauthmanageconsumers-none-proposed, mwoauthmanageconsumers-none-rejected, // mwoauthmanageconsumers-none-expired, mwoauthmanageconsumers-none-approved, // mwoauthmanageconsumers-none-disabled $this->getOutput()->addWikiMsg( "mwoauthmanageconsumers-none-{$this->stageKey}" ); } # Every 30th view, prune old deleted items if ( mt_rand( 0, 29 ) == 0 ) { Utils::runAutoMaintenance( Utils::getCentralDB( DB_PRIMARY ) ); } } /** * @param IDatabase $db * @param stdClass $row * @return string */ public function formatRow( IDatabase $db, $row ) { $cmrAc = ConsumerAccessControl::wrap( Consumer::newFromRow( $db, $row ), $this->getContext() ); $cmrKey = $cmrAc->getConsumerKey(); $stageKey = Consumer::$stageNames[$cmrAc->getStage()]; $link = $this->getLinkRenderer()->makeKnownLink( $this->getPageTitle( $cmrKey ), $this->msg( 'mwoauthmanageconsumers-review' )->text() ); $time = $this->getLanguage()->timeanddate( wfTimestamp( TS_MW, $cmrAc->getRegistration() ), true ); $encStageKey = htmlspecialchars( $stageKey ); $r = "
  • "; $r .= $time . " ({$link})"; // Show last log entry (@TODO: title namespace?) // @TODO: inject DB $logHtml = ''; LogEventsList::showLogExtract( $logHtml, 'mwoauthconsumer', '', '', [ 'action' => Consumer::$stageActionNames[$cmrAc->getStage()], 'conds' => [ 'ls_field' => 'OAuthConsumer', 'ls_value' => $cmrAc->getConsumerKey(), ], 'lim' => 1, 'flags' => LogEventsList::NO_EXTRA_USER_LINKS, ] ); $lang = $this->getLanguage(); $data = [ 'mwoauthmanageconsumers-name' => $cmrAc->escapeForHtml( $cmrAc->getNameAndVersion() ), 'mwoauthmanageconsumers-user' => $cmrAc->escapeForHtml( $cmrAc->getUserName() ), 'mwoauth-oauth-version' => $cmrAc->escapeForHtml( $cmrAc->getOAuthVersion() === Consumer::OAUTH_VERSION_2 ? $this->msg( 'mwoauth-oauth-version-2' ) : $this->msg( 'mwoauth-oauth-version-1' ) ), 'mwoauthmanageconsumers-description' => $cmrAc->escapeForHtml( $cmrAc->get( 'description', static function ( $s ) use ( $lang ) { return $lang->truncateForVisual( $s, 10024 ); } ) ), 'mwoauthmanageconsumers-email' => $cmrAc->escapeForHtml( $cmrAc->getEmail() ), 'mwoauthmanageconsumers-consumerkey' => $cmrAc->escapeForHtml( $cmrAc->getConsumerKey() ), 'mwoauthmanageconsumers-lastchange' => $logHtml, ]; $r .= ""; foreach ( $data as $msg => $encValue ) { $r .= '' . '' . '' . ''; } $r .= '
    ' . $this->msg( $msg )->escaped() . '' . $encValue . '
    '; $r .= '
    • '; return $r; } protected function getGroupName() { return 'users'; } }