Swap the two parameters of getWopiClientURL().

Author: donquixote

collabora_online.module

@@ -123,7 +123,7 @@ function collabora_online_entity_operation(EntityInterface $entity): array {
     $discovery_fetcher = \Drupal::service(DiscoveryFetcherInterface::class);
     try {
       $discovery = $discovery_fetcher->getDiscovery();
-      $wopi_client_edit_url = $discovery->getWopiClientURL($type, 'edit');
+      $wopi_client_edit_url = $discovery->getWopiClientURL('edit', $type);
       if ($wopi_client_edit_url !== NULL) {
         $entries['collabora_online_edit'] = [
           'title' => t("Edit in Collabora Online"),

src/Controller/ViewerController.php

@@ -71,13 +71,13 @@ public function editor(MediaInterface $media, Request $request, $edit = FALSE):
       // @todo Get client url for the correct MIME type.
       $discovery = $this->discoveryFetcher->getDiscovery();
       $wopi_client_url = $edit
-        ? $discovery->getWopiClientURL(action: 'edit')
-        : ($discovery->getWopiClientURL(action: 'view')
+        ? $discovery->getWopiClientURL('edit')
+        : ($discovery->getWopiClientURL('view')
           // With the typical discovery.xml from Collabora, some MIME types that
           // are viewable have an 'edit' or 'view_comment' action but no 'view'
           // action.
-          ?? $discovery->getWopiClientURL(action: 'edit')
-          ?? $discovery->getWopiClientURL(action: 'view_comment'));
+          ?? $discovery->getWopiClientURL('edit')
+          ?? $discovery->getWopiClientURL('view_comment'));
     }
     catch (CollaboraNotAvailableException $e) {
       $this->logger->warning(

src/Discovery/Discovery.php

@@ -32,7 +32,7 @@ public function __construct(
   /**
    * {@inheritdoc}
    */
-  public function getWopiClientURL(string $mimetype = 'text/plain', string $action = 'view'): ?string {
+  public function getWopiClientURL(string $action = 'view', string $mimetype = 'text/plain'): ?string {
     $result = $this->parsedXml->xpath(sprintf(
       "/wopi-discovery/net-zone/app[@name='%s']/action[@name='%s']",
       $mimetype,

src/Discovery/DiscoveryInterface.php

@@ -22,18 +22,18 @@ interface DiscoveryInterface {
   /**
    * Gets the URL for the WOPI client.
    *
-   * @param string $mimetype
-   *   Mime type for which to get the WOPI client URL.
-   *   This refers to config entries in the discovery.xml file.
    * @param string $action
    *   Name of the action/operation for which to get the url.
    *   Typical values are 'view', 'edit' or 'view_comment'.
+   * @param string $mimetype
+   *   Mime type for which to get the WOPI client URL.
+   *   This refers to config entries in the discovery.xml file.
    *
    * @return string|null
    *   The WOPI client URL, or NULL if none provided for the MIME type and
    *   operation.
    */
-  public function getWopiClientURL(string $mimetype = 'text/plain', string $action = 'view'): ?string;
+  public function getWopiClientURL(string $action = 'view', string $mimetype = 'text/plain'): ?string;
 
   /**
    * Gets the public key used for proofing.

tests/src/Unit/CollaboraDiscoveryTest.php

@@ -29,27 +29,27 @@ public function testWopiClientUrl(): void {
     );
     $this->assertSame(
       'http://spreadsheet.collabora.test:9980/browser/61cf2b4/cool.html?',
-      $discovery->getWopiClientURL('text/spreadsheet', 'edit'),
+      $discovery->getWopiClientURL('edit', 'text/spreadsheet'),
     );
     // Test unknown mime type.
-    $this->assertNull($discovery->getWopiClientURL('text/unknown', 'view'));
+    $this->assertNull($discovery->getWopiClientURL('view', 'text/unknown'));
     $this->assertSame(
       'http://csv.collabora.test:9980/browser/61cf2b4/cool.html?',
-      $discovery->getWopiClientURL('text/csv', 'edit'),
+      $discovery->getWopiClientURL('edit', 'text/csv'),
     );
     $this->assertSame(
       'http://view.csv.collabora.test:9980/browser/61cf2b4/cool.html?',
-      $discovery->getWopiClientURL('text/csv', 'view'),
+      $discovery->getWopiClientURL('view', 'text/csv'),
     );
     // Test the default MIME type 'text/plain' which has only 'edit' action in
     // the example file, but no 'view' action.
-    $this->assertNull($discovery->getWopiClientURL(action: 'edit'));
-    $this->assertNotNull($discovery->getWopiClientURL(action: 'view'));
+    $this->assertNull($discovery->getWopiClientURL('edit'));
+    $this->assertNotNull($discovery->getWopiClientURL('view'));
     // Test a MIME type with no action name specified.
     // This does not occur in the known discovery.xml, but we still want a
     // well-defined behavior in that case.
-    $this->assertNull($discovery->getWopiClientURL('image/png', 'edit'));
-    $this->assertNull($discovery->getWopiClientURL('image/png', 'view'));
+    $this->assertNull($discovery->getWopiClientURL('edit', 'image/png'));
+    $this->assertNull($discovery->getWopiClientURL('view', 'image/png'));
   }
 
   /**
@@ -72,7 +72,7 @@ public function testRealisticDiscoveryXml(): void {
     foreach ($mimetypes as $mimetype) {
       $type_supported_actions = [];
       foreach (['edit', 'view_comment', 'view'] as $action) {
-        $url = $discovery->getWopiClientURL($mimetype, $action);
+        $url = $discovery->getWopiClientURL($action, $mimetype);
         if ($url !== NULL) {
           $this->assertSame($known_url, $url);
           $type_supported_actions[] = $action;