Bump mediawiki/oauthclient to 2.0.* and set user agent in requests (x-tools#572)

The WMF cluster now requires a user agent, see https://w.wiki/4wJS
This gets set for all Guzzle requests, which is what we should use
instead of file_get_contents() etc. Later when we upgrade Symfony,
we'll move to Symfony's Guzzle-compatible HTTP client.

The host in the Guzzle user agent is hard-coded in YAML
configuration for now.

Bug: T400929

Author: MusikAnimal

composer.json

@@ -35,7 +35,7 @@
         "eightpoints/guzzle-bundle": "^8.0",
         "jms/serializer-bundle": "^3.4",
         "krinkle/intuition": "^2.3",
-        "mediawiki/oauthclient": "^1.2",
+        "mediawiki/oauthclient": "2.0.*",
         "nelmio/api-doc-bundle": "~4.11",
         "nelmio/cors-bundle": "^2.3",
         "phpdocumentor/reflection-docblock": "^5.3",

composer.lock

@@ -6,4 +6,5 @@ eight_points_guzzle:
             options:
                 headers:
                     Accept: "application/json"
+                    User-Agent: 'XTools/%env(APP_VERSION)% (https://xtools.wmcloud.org %env(MAILER_TO_EMAIL)%) GuzzleHttp'
                 timeout: 30

config/packages/eight_points_guzzle.yaml

@@ -42,6 +42,7 @@ parameters:
     enable.TopEdits: '%env(bool:APP_ENABLE_TOPEDITS)%'
     oauth_key: '%env(OAUTH_KEY)%'
     oauth_secret: '%env(OAUTH_SECRET)%'
+    mailer.to_email: '%env(MAILER_TO_EMAIL)%'
 
 services:
     _defaults:
@@ -107,7 +108,7 @@ services:
     # These need to not be public, but they are, for now...
     app.automated_edits_helper:
         class: App\Helper\AutomatedEditsHelper
-        arguments: ['@request_stack', '@cache.app']
+        arguments: ['@request_stack', '@cache.app', 'eight_points_guzzle.client.xtools']
         public: true
     app.i18n_helper:
         class: App\Helper\I18nHelper

config/services.yaml

@@ -18,6 +18,7 @@
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 /**
  * The DefaultController handles the homepage, about pages, and user authentication.
@@ -64,10 +65,12 @@ public function loginAction(
         Request $request,
         RequestStack $requestStack,
         ProjectRepository $projectRepo,
+        UrlGeneratorInterface $urlGenerator,
         string $centralAuthProject
     ): RedirectResponse {
         try {
-            [ $next, $token ] = $this->getOauthClient($request, $projectRepo, $centralAuthProject)->initiate();
+            [$next, $token] = $this->getOauthClient($request, $projectRepo, $urlGenerator, $centralAuthProject)
+                ->initiate();
         } catch (Exception $oauthException) {
             $this->addFlashMessage('notice', 'error-login');
             return $this->redirectToRoute('homepage');
@@ -84,12 +87,14 @@ public function loginAction(
      * @Route("/oauthredirector.php", name="old_oauth_callback")
      * @param RequestStack $requestStack
      * @param ProjectRepository $projectRepo
+     * @param UrlGeneratorInterface $urlGenerator
      * @param string $centralAuthProject
      * @return RedirectResponse
      */
     public function oauthCallbackAction(
         RequestStack $requestStack,
         ProjectRepository $projectRepo,
+        UrlGeneratorInterface $urlGenerator,
         string $centralAuthProject
     ): RedirectResponse {
         $request = $requestStack->getCurrentRequest();
@@ -100,7 +105,7 @@ public function oauthCallbackAction(
         }
 
         // Complete authentication.
-        $client = $this->getOauthClient($request, $projectRepo, $centralAuthProject);
+        $client = $this->getOauthClient($request, $projectRepo, $urlGenerator, $centralAuthProject);
         $token = $requestStack->getSession()->get('oauth_request_token');
 
         if (!is_a($token, Token::class)) {
@@ -136,13 +141,15 @@ public function oauthCallbackAction(
      * (This shouldn't really be in this class, but oh well.)
      * @param Request $request
      * @param ProjectRepository $projectRepo
+     * @param UrlGeneratorInterface $urlGenerator
      * @param string $centralAuthProject
      * @return Client
      * @codeCoverageIgnore
      */
     protected function getOauthClient(
         Request $request,
         ProjectRepository $projectRepo,
+        UrlGeneratorInterface $urlGenerator,
         string $centralAuthProject
     ): Client {
         if (isset($this->oauthClient)) {
@@ -156,6 +163,13 @@ protected function getOauthClient(
         $consumerKey = $this->getParameter('oauth_key');
         $consumerSecret =  $this->getParameter('oauth_secret');
         $conf->setConsumer(new Consumer($consumerKey, $consumerSecret));
+        $conf->setUserAgent(
+            'XTools/'.$this->getParameter('app.version').' ('.
+            rtrim(
+                $urlGenerator->generate($this->getIndexRoute(), [], UrlGeneratorInterface::ABSOLUTE_URL),
+                '/'
+            ).' '.$this->getParameter('mailer.to_email').')'
+        );
         $this->oauthClient = new Client($conf);
 
         // Set the callback URL if given. Used to redirect back to target page after logging in.

src/Controller/DefaultController.php

@@ -198,6 +198,7 @@ protected function maxLimit(): int
      * @param ProjectRepository $projectRepo
      * @param UserRepository $userRepo
      * @param PageRepository $pageRepo
+     * @param Environment $twig
      * @param bool $isWMF
      * @param string $defaultProject
      */

src/Controller/XtoolsController.php

@@ -16,7 +16,6 @@
  */
 class AutomatedEditsHelper
 {
-    protected CacheItemPoolInterface $cache;
     protected SessionInterface $session;
 
     /** @var array The list of tools that are considered reverting. */
@@ -29,11 +28,14 @@ class AutomatedEditsHelper
      * AutomatedEditsHelper constructor.
      * @param RequestStack $requestStack
      * @param CacheItemPoolInterface $cache
+     * @param \GuzzleHttp\Client $guzzle
      */
-    public function __construct(RequestStack $requestStack, CacheItemPoolInterface $cache)
-    {
+    public function __construct(
+        RequestStack $requestStack,
+        protected CacheItemPoolInterface $cache,
+        protected \GuzzleHttp\Client $guzzle
+    ) {
         $this->session = $requestStack->getSession();
-        $this->cache = $cache;
     }
 
     /**
@@ -99,7 +101,7 @@ public function getConfig(bool $useSandbox = false): array
                 $uri
             ));
         } else {
-            $resp = json_decode(file_get_contents($uri));
+            $resp = json_decode($this->guzzle->get($uri)->getBody()->getContents());
         }
 
         $ret = json_decode($resp->query->pages[0]->revisions[0]->slots->main->content, true);

src/Helper/AutomatedEditsHelper.php

@@ -70,7 +70,8 @@ protected function getAutomatedEditsHelper(?KernelBrowser $client = null): Autom
         $session = $this->createSession($client);
         return new AutomatedEditsHelper(
             $this->getRequestStack($session),
-            static::getContainer()->get('cache.app')
+            static::getContainer()->get('cache.app'),
+            static::getContainer()->get('eight_points_guzzle.client.xtools')
         );
     }
 }