Add parameter for view/edit in Disdcovery->getWopiClientURL().

Author: donquixote

src/Discovery/Discovery.php

@@ -32,8 +32,16 @@ public function __construct(
   /**
    * {@inheritdoc}
    */
-  public function getWopiClientURL(string $mimetype = 'text/plain'): ?string {
-    $result = $this->parsedXml->xpath(sprintf('/wopi-discovery/net-zone/app[@name=\'%s\']/action', $mimetype));
+  public function getWopiClientURL(string $mimetype = 'text/plain', ?bool $edit = NULL): ?string {
+    $result = $this->parsedXml->xpath(sprintf(
+      '/wopi-discovery/net-zone/app[@name=\'%s\']/action%s',
+      $mimetype,
+      match ($edit) {
+        TRUE => "[@name='edit']",
+        FALSE => "[@name='view']",
+        NULL => '',
+      }
+    ));
     if (empty($result[0]['urlsrc'][0])) {
       return NULL;
     }

src/Discovery/DiscoveryInterface.php

@@ -25,11 +25,16 @@ interface DiscoveryInterface {
    * @param string $mimetype
    *   Mime type for which to get the WOPI client URL.
    *   This refers to config entries in the discovery.xml file.
+   * @param bool|null $edit
+   *   TRUE to get the edit url, FALSE to get the view url, NULL to get
+   *   whichever url comes first, no matter if it has 'view' or 'edit' or none.
+   *   In Collabora, this parameter makes little difference.
    *
    * @return string|null
-   *   The WOPI client URL, or NULL if none provided for the MIME type.
+   *   The WOPI client URL, or NULL if none provided for the MIME type and
+   *   operation.
    */
-  public function getWopiClientURL(string $mimetype = 'text/plain'): ?string;
+  public function getWopiClientURL(string $mimetype = 'text/plain', ?bool $edit = NULL): ?string;
 
   /**
    * Gets the public key used for proofing.

tests/fixtures/discovery.mimetypes.xml

@@ -7,8 +7,14 @@
     <app name="text/csv">
       <action default="true" ext="" name="edit" urlsrc="http://csv.collabora.test:9980/browser/61cf2b4/cool.html?"/>
     </app>
+    <app name="text/csv">
+      <action default="true" ext="" name="view" urlsrc="http://view.csv.collabora.test:9980/browser/61cf2b4/cool.html?"/>
+    </app>
     <app name="text/plain">
-      <action default="true" ext="" name="edit" urlsrc="http://collabora.test:9980/browser/61cf2b4/cool.html?"/>
+      <action default="true" ext="" name="view" urlsrc="http://collabora.test:9980/browser/61cf2b4/cool.html?"/>
+    </app>
+    <app name="image/png">
+      <action urlsrc="http://png.collabora.test:9980/browser/61cf2b4/cool.html?"/>
     </app>
   </net-zone>
 </wopi-discovery>

tests/src/Unit/CollaboraDiscoveryTest.php

@@ -34,6 +34,24 @@ public function testWopiClientUrl(): void {
     $this->assertNull(
       $discovery->getWopiClientURL('text/unknown'),
     );
+    $this->assertSame(
+      'http://csv.collabora.test:9980/browser/61cf2b4/cool.html?',
+      $discovery->getWopiClientURL('text/csv', TRUE),
+    );
+    $this->assertSame(
+      'http://view.csv.collabora.test:9980/browser/61cf2b4/cool.html?',
+      $discovery->getWopiClientURL('text/csv', FALSE),
+    );
+    // Test the default MIME type 'text/plain' which has only 'edit' action in
+    // the example file, but no 'view' action.
+    $this->assertNull($discovery->getWopiClientURL(edit: TRUE));
+    $this->assertNotNull($discovery->getWopiClientURL(edit: FALSE));
+    // 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', TRUE));
+    $this->assertNull($discovery->getWopiClientURL('image/png', FALSE));
+    $this->assertNotNull($discovery->getWopiClientURL('image/png'));
   }
 
   /**