feat: add getArchivefileUrls and getArchivefileUrl to return the download link only

Author: kan-fu

src/onc/modules/_OncArchive.py

@@ -41,6 +41,18 @@ def getArchivefile(self, filters: dict, allPages: bool):
             allPages=allPages,
         )
 
+    def getArchivefileUrls(self, filters: dict, allPages: bool) -> list[str]:
+        file_list: list[str] = self.getArchivefile(filters, allPages)["files"]
+        return list(map(self.getArchivefileUrl, file_list))
+
+    def getArchivefileUrl(self, filename: str) -> str:
+        """
+        Return an archivefile absolute download URL for a filename
+        """
+        url = self._serviceUrl("archivefile")
+        token = self._config("token")
+        return f"{url}/download?filename={filename}&token={token}"
+
     def downloadArchivefile(self, filename: str = "", overwrite: bool = False):
         url = self._serviceUrl("archivefiles")
 
@@ -123,7 +135,7 @@ def downloadDirectArchivefile(
             else:
                 print(f'   Skipping "{filename}": File already exists.')
                 downInfo = {
-                    "url": self._getDownloadUrl(filename),
+                    "url": self.getArchivefileUrl(filename),
                     "status": "skipped",
                     "size": 0,
                     "downloadTime": 0,
@@ -139,15 +151,6 @@ def downloadDirectArchivefile(
             "stats": {"totalSize": size, "downloadTime": time, "fileCount": successes},
         }
 
-    def _getDownloadUrl(self, filename: str):
-        """
-        Returns an archivefile absolute download URL for a filename
-        """
-        url = self._serviceUrl("archivefiles")
-        return "{:s}?method=getFile&filename={:s}&token={:s}".format(
-            url, filename, self._config("token")
-        )
-
     def _getList(self, filters: dict, by: str = "location", allPages: bool = False):
         """
         Wraps archivefiles getArchivefileByLocation and getArchivefileByDevice methods

src/onc/modules/_OncService.py

@@ -77,6 +77,7 @@ def _serviceUrl(self, service: str):
             "properties",
             "dataProducts",
             "archivefiles",
+            "archivefile",
             "scalardata",
             "rawdata",
         ]:

src/onc/onc.py

@@ -1299,6 +1299,59 @@ def getArchivefile(self, filters: dict = None, allPages: bool = False):
         """  # noqa: E501
         return self.archive.getArchivefile(filters, allPages)
 
+    def getArchivefileUrls(
+        self,
+        filters: dict = None,
+        allPages: bool = False,
+        joinedWithNewline: bool = False,
+    ) -> list[str] | str:
+        """
+        Return a list of file URLs (or joined with a newline) available in Oceans 3.0 Archiving System by given query parameters.
+
+        A helper method for getting a list of archive files URLs without downloading them.
+        It can also return a single string that concatenates all the URLs in the list together with a newline,
+        which can be useful if you are using a download manager and it supports batch downloading multiple URLs
+        that expects all the URLs on a separate line from either a file or the clipboard.
+
+        Parameters
+        ----------
+        filters : dict, optional
+            Query string parameters in the API request.
+            See ``getArchivefileByLocation`` and ``getArchivefileByDevice`` for more information.
+        allPages : bool, default False
+            Whether the response concatenates data on all pages if there are more than one page due to rowLimit.
+        joinedWithNewline: bool, default False
+            Whether it returns a list of URLs or a single string that concatenates the list with a newline.
+
+        Returns
+        -------
+        list[str] | str
+            A list of file URLs or a single joined string.
+        """  # noqa: E501
+        file_urls = self.archive.getArchivefileUrls(filters, allPages)
+        if joinedWithNewline:
+            return "\n".join(file_urls)
+        else:
+            return file_urls
+
+    def getArchivefileUrl(self, filename: str = "") -> str:
+        """
+        Return a file URL from Oceans 3.0 Archiving System by specifying the file name.
+
+        A helper method for obtaining the archive file URL without actually downloading the file.
+
+        Parameters
+        ----------
+        filename : str, default ""
+            A valid name of a file in DMAS Archiving System.
+
+        Returns
+        -------
+        str:
+            A download URL for the given archive filename.
+        """  # noqa: E501
+        return self.archive.getArchivefileUrl(filename)
+
     def downloadArchivefile(self, filename: str = "", overwrite: bool = False):
         """
         Download a file from Oceans 3.0 Archiving System by specifying the file name.