X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/30b02581c938c05b804f7510a1fc8e850830b9cd..c4fa80c6ed2445e1e384455944eb6c4108906cad:/apps/workbench/app/helpers/collections_helper.rb

diff --git a/apps/workbench/app/helpers/collections_helper.rb b/apps/workbench/app/helpers/collections_helper.rb
index 1f867a60b6..23a440ad1e 100644
--- a/apps/workbench/app/helpers/collections_helper.rb
+++ b/apps/workbench/app/helpers/collections_helper.rb
@@ -5,14 +5,47 @@ module CollectionsHelper
     end
   end
 
-  def self.match(uuid)
-    /^([a-f0-9]{32})(\+[0-9]+)?(\+.*?)?(\/.*)?$/.match(uuid.to_s)
+  ##
+  # Regex match for collection portable data hash, returns a regex match object with the
+  # hash in group 1, (optional) size in group 2, (optional) subsequent uuid
+  # fields in group 3, and (optional) file path within the collection as group
+  # 4
+  # returns nil for no match.
+  #
+  # +pdh+ the portable data hash string to match
+  #
+  def self.match(pdh)
+    /^([a-f0-9]{32})(\+\d+)(\+[^+]+)*?(\/.*)?$/.match(pdh.to_s)
   end
 
+  ##
+  # Regex match for collection UUIDs, returns a regex match object with the
+  # uuid in group 1, empty groups 2 and 3 (for consistency with the match
+  # method above), and (optional) file path within the collection as group
+  # 4.
+  # returns nil for no match.
+  #
+  def self.match_uuid_with_optional_filepath(uuid_with_optional_file)
+    /^([0-9a-z]{5}-4zz18-[0-9a-z]{15})()()(\/.*)?$/.match(uuid_with_optional_file.to_s)
+  end
+
+  ##
+  # Regex match for common image file extensions, returns a regex match object
+  # with the matched extension in group 1; or nil for no match.
+  #
+  # +file+ the file string to match
+  #
   def self.is_image file
     /\.(jpg|jpeg|gif|png|svg)$/i.match(file)
   end
 
+  ##
+  # Generates a relative file path than can be appended to the URL of a
+  # collection to get a file download link without adding a spurious ./ at the
+  # beginning for files in the default stream.
+  #
+  # +file+ an entry in the Collection.files list in the form [stream, name, size]
+  #
   def self.file_path file
     f0 = file[0]
     f0 = '' if f0 == '.'