Fix 2.4.2 upgrade notes formatting refs #19330
[arvados.git] / apps / workbench / app / controllers / collections_controller.rb
index 515cdf1867fba103fce298daf7cf2ecd755d1f8d..9073d06c178c3edeb23bee3b3d16cfcafca5f4ff 100644 (file)
@@ -1,3 +1,7 @@
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: AGPL-3.0
+
 require "arvados/keep"
 require "arvados/collection"
 require "uri"
@@ -5,17 +9,17 @@ require "uri"
 class CollectionsController < ApplicationController
   include ActionController::Live
 
-  skip_around_filter :require_thread_api_token, if: proc { |ctrl|
-    Rails.configuration.anonymous_user_token and
+  skip_around_action :require_thread_api_token, if: proc { |ctrl|
+    !Rails.configuration.Users.AnonymousUserToken.empty? and
     'show' == ctrl.action_name
   }
-  skip_around_filter(:require_thread_api_token,
+  skip_around_action(:require_thread_api_token,
                      only: [:show_file, :show_file_links])
-  skip_before_filter(:find_object_by_uuid,
+  skip_before_action(:find_object_by_uuid,
                      only: [:provenance, :show_file, :show_file_links])
   # We depend on show_file to display the user agreement:
-  skip_before_filter :check_user_agreements, only: :show_file
-  skip_before_filter :check_user_profile, only: :show_file
+  skip_before_action :check_user_agreements, only: :show_file
+  skip_before_action :check_user_profile, only: :show_file
 
   RELATION_LIMIT = 5
 
@@ -32,7 +36,7 @@ class CollectionsController < ApplicationController
                                    ['link_class', '=', 'resources'],
                                    ['name', '=', 'wants'],
                                    ['tail_uuid', '=', current_user.uuid],
-                                   ['head_uuid', '=', @object.uuid]])
+                                   ['head_uuid', '=', @object.uuid]]).with_count("none")
       logger.debug persist_links.inspect
     else
       return unprocessable "Invalid value #{value.inspect}"
@@ -61,7 +65,7 @@ class CollectionsController < ApplicationController
     @select ||= Collection.columns.map(&:name)
     base_search = Collection.select(@select)
     if params[:search].andand.length.andand > 0
-      tags = Link.where(any: ['contains', params[:search]])
+      tags = Link.where(any: ['contains', params[:search]]).with_count("none")
       @objects = (base_search.where(uuid: tags.collect(&:head_uuid)) |
                       base_search.where(any: ['contains', params[:search]])).
         uniq { |c| c.uuid }
@@ -80,7 +84,7 @@ class CollectionsController < ApplicationController
 
       @objects = base_search.limit(limit).offset(offset)
     end
-    @links = Link.where(head_uuid: @objects.collect(&:uuid))
+    @links = Link.where(head_uuid: @objects.collect(&:uuid)).with_count("none")
     @collection_info = {}
     @objects.each do |c|
       @collection_info[c.uuid] = {
@@ -111,22 +115,17 @@ class CollectionsController < ApplicationController
   end
 
   def show_file_links
-    Thread.current[:reader_tokens] = [params[:reader_token]]
-    return if false.equal?(find_object_by_uuid)
-    render layout: false
+    return show_file
   end
 
   def show_file
-    # We pipe from arv-get to send the file to the user.  Before we start it,
-    # we ask the API server if the file actually exists.  This serves two
-    # purposes: it lets us return a useful status code for common errors, and
-    # helps us figure out which token to provide to arv-get.
     # The order of searched tokens is important: because the anonymous user
     # token is passed along with every API request, we have to check it first.
     # Otherwise, it's impossible to know whether any other request succeeded
     # because of the reader token.
     coll = nil
-    tokens = [(Rails.configuration.anonymous_user_token || nil),
+    tokens = [(if !Rails.configuration.Users.AnonymousUserToken.empty? then
+                Rails.configuration.Users.AnonymousUserToken else nil end),
               params[:reader_token],
               Thread.current[:arvados_api_token]].compact
     usable_token = find_usable_token(tokens) do
@@ -137,62 +136,18 @@ class CollectionsController < ApplicationController
       return
     end
 
-    # If we are configured to use a keep-web server, just redirect to
-    # the appropriate URL.
-    if Rails.configuration.keep_web_url or
-        Rails.configuration.keep_web_download_url
-      opts = {}
-      if usable_token == params[:reader_token]
-        opts[:path_token] = usable_token
-      elsif usable_token == Rails.configuration.anonymous_user_token
-        # Don't pass a token at all
-      else
-        # We pass the current user's real token only if it's necessary
-        # to read the collection.
-        opts[:query_token] = usable_token
-      end
-      opts[:disposition] = params[:disposition] if params[:disposition]
-      return redirect_to keep_web_url(params[:uuid], params[:file], opts)
-    end
-
-    # No keep-web server available. Get the file data with arv-get,
-    # and serve it through Rails.
-
-    file_name = params[:file].andand.sub(/^(\.\/|\/|)/, './')
-    if file_name.nil? or not coll.manifest.has_file?(file_name)
-      return render_not_found
-    end
-
-    opts = params.merge(arvados_api_token: usable_token)
-
-    # Handle Range requests. Currently we support only 'bytes=0-....'
-    if request.headers.include? 'HTTP_RANGE'
-      if m = /^bytes=0-(\d+)/.match(request.headers['HTTP_RANGE'])
-        opts[:maxbytes] = m[1]
-        size = params[:size] || '*'
-        self.response.status = 206
-        self.response.headers['Content-Range'] = "bytes 0-#{m[1]}/#{size}"
-      end
-    end
-
-    ext = File.extname(params[:file])
-    self.response.headers['Content-Type'] =
-      Rack::Mime::MIME_TYPES[ext] || 'application/octet-stream'
-    if params[:size]
-      size = params[:size].to_i
-      if opts[:maxbytes]
-        size = [size, opts[:maxbytes].to_i].min
-      end
-      self.response.headers['Content-Length'] = size.to_s
-    end
-    self.response.headers['Content-Disposition'] = params[:disposition] if params[:disposition]
-    begin
-      file_enumerator(opts).each do |bytes|
-        response.stream.write bytes
-      end
-    ensure
-      response.stream.close
+    opts = {}
+    if usable_token == params[:reader_token]
+      opts[:path_token] = usable_token
+    elsif usable_token == Rails.configuration.Users.AnonymousUserToken
+      # Don't pass a token at all
+    else
+      # We pass the current user's real token only if it's necessary
+      # to read the collection.
+      opts[:query_token] = usable_token
     end
+    opts[:disposition] = params[:disposition] if params[:disposition]
+    return redirect_to keep_web_url(params[:uuid], params[:file], opts)
   end
 
   def sharing_scopes
@@ -221,7 +176,7 @@ class CollectionsController < ApplicationController
     if params["tab_pane"] == "Provenance_graph"
       @prov_svg = ProvenanceHelper::create_provenance_graph(@object.provenance, "provenance_svg",
                                                             {:request => request,
-                                                             :direction => :top_down,
+                                                             :direction => "RL",
                                                              :combine_jobs => :script_only}) rescue nil
     end
 
@@ -242,19 +197,19 @@ class CollectionsController < ApplicationController
       else
         if Job.api_exists?(:index)
           jobs_with = lambda do |conds|
-            Job.limit(RELATION_LIMIT).where(conds)
+            Job.limit(RELATION_LIMIT).with_count("none").where(conds)
               .results.sort_by { |j| j.finished_at || j.created_at }
           end
           @output_of = jobs_with.call(output: @object.portable_data_hash)
           @log_of = jobs_with.call(log: @object.portable_data_hash)
         end
 
-        @project_links = Link.limit(RELATION_LIMIT).order("modified_at DESC")
+        @project_links = Link.limit(RELATION_LIMIT).with_count("none").order("modified_at DESC")
           .where(head_uuid: @object.uuid, link_class: 'name').results
-        project_hash = Group.where(uuid: @project_links.map(&:tail_uuid)).to_hash
+        project_hash = Group.where(uuid: @project_links.map(&:tail_uuid)).with_count("none").to_hash
         @projects = project_hash.values
 
-        @permissions = Link.limit(RELATION_LIMIT).order("modified_at DESC")
+        @permissions = Link.limit(RELATION_LIMIT).with_count("none").order("modified_at DESC")
           .where(head_uuid: @object.uuid, link_class: 'permission',
                  name: 'can_read').results
         @search_sharing = search_scopes
@@ -262,7 +217,7 @@ class CollectionsController < ApplicationController
         if params["tab_pane"] == "Used_by"
           @used_by_svg = ProvenanceHelper::create_provenance_graph(@object.used_by, "used_by_svg",
                                                                    {:request => request,
-                                                                    :direction => :top_down,
+                                                                    :direction => "LR",
                                                                     :combine_jobs => :script_only,
                                                                     :pdata_only => true}) rescue nil
         end
@@ -279,7 +234,8 @@ class CollectionsController < ApplicationController
   helper_method :download_link
 
   def download_link
-    collections_url + "/download/#{@object.uuid}/#{@search_sharing.first.api_token}/"
+    token = @search_sharing.first.api_token
+    keep_web_url(@object.uuid, nil, {path_token: token})
   end
 
   def share
@@ -310,7 +266,7 @@ class CollectionsController < ApplicationController
   end
 
   def update
-    updated_attr = params[:collection].each.select {|a| a[0].andand.start_with? 'rename-file-path:'}
+    updated_attr = params[:collection].to_unsafe_hash.each.select {|a| a[0].andand.start_with? 'rename-file-path:'}
 
     if updated_attr.size > 0
       # Is it file rename?
@@ -345,30 +301,6 @@ class CollectionsController < ApplicationController
     end
   end
 
-  def tags
-    render
-  end
-
-  def save_tags
-    tags_param = params['tag_data']
-    if tags_param
-      if tags_param.is_a?(String) && tags_param == "empty"
-        tags = {}
-      else
-        tags = tags_param
-      end
-    end
-
-    if tags
-      if @object.update_attributes properties: tags
-        @saved_tags = true
-        render
-      else
-        self.render_error status: 422
-      end
-    end
-  end
-
   protected
 
   def find_usable_token(token_list)
@@ -403,24 +335,25 @@ class CollectionsController < ApplicationController
 
   def keep_web_url(uuid_or_pdh, file, opts)
     munged_id = uuid_or_pdh.sub('+', '-')
-    fmt = {uuid_or_pdh: munged_id}
 
-    tmpl = Rails.configuration.keep_web_url
-    if Rails.configuration.keep_web_download_url and
-        (!tmpl or opts[:disposition] == 'attachment')
+    tmpl = Rails.configuration.Services.WebDAV.ExternalURL.to_s
+
+    if Rails.configuration.Services.WebDAVDownload.ExternalURL != URI("") and
+        (tmpl.empty? or opts[:disposition] == 'attachment')
       # Prefer the attachment-only-host when we want an attachment
       # (and when there is no preview link configured)
-      tmpl = Rails.configuration.keep_web_download_url
-    elsif not Rails.configuration.trust_all_content
-      check_uri = URI.parse(tmpl % fmt)
+      tmpl = Rails.configuration.Services.WebDAVDownload.ExternalURL.to_s
+    elsif not Rails.configuration.Collections.TrustAllContent
+      check_uri = URI.parse(tmpl.sub("*", munged_id))
       if opts[:query_token] and
+        (check_uri.host.nil? or (
           not check_uri.host.start_with?(munged_id + "--") and
-          not check_uri.host.start_with?(munged_id + ".")
+          not check_uri.host.start_with?(munged_id + ".")))
         # We're about to pass a token in the query string, but
         # keep-web can't accept that safely at a single-origin URL
         # template (unless it's -attachment-only-host).
-        tmpl = Rails.configuration.keep_web_download_url
-        if not tmpl
+        tmpl = Rails.configuration.Services.WebDAVDownload.ExternalURL.to_s
+        if tmpl.empty?
           raise ArgumentError, "Download precluded by site configuration"
         end
         logger.warn("Using download link, even though inline content " \
@@ -428,19 +361,22 @@ class CollectionsController < ApplicationController
       end
     end
 
-    if tmpl == Rails.configuration.keep_web_download_url
+    if tmpl == Rails.configuration.Services.WebDAVDownload.ExternalURL.to_s
       # This takes us to keep-web's -attachment-only-host so there is
       # no need to add ?disposition=attachment.
       opts.delete :disposition
     end
 
-    uri = URI.parse(tmpl % fmt)
+    uri = URI.parse(tmpl.sub("*", munged_id))
+    if tmpl.index("*").nil?
+      uri.path = "/c=#{munged_id}"
+    end
     uri.path += '/' unless uri.path.end_with? '/'
     if opts[:path_token]
       uri.path += 't=' + opts[:path_token] + '/'
     end
     uri.path += '_/'
-    uri.path += URI.escape(file)
+    uri.path += URI.escape(file) if file
 
     query = Hash[URI.decode_www_form(uri.query || '')]
     { query_token: 'api_token',
@@ -455,43 +391,4 @@ class CollectionsController < ApplicationController
 
     uri.to_s
   end
-
-  # Note: several controller and integration tests rely on stubbing
-  # file_enumerator to return fake file content.
-  def file_enumerator opts
-    FileStreamer.new opts
-  end
-
-  class FileStreamer
-    include ArvadosApiClientHelper
-    def initialize(opts={})
-      @opts = opts
-    end
-    def each
-      return unless @opts[:uuid] && @opts[:file]
-
-      env = Hash[ENV].dup
-
-      require 'uri'
-      u = URI.parse(arvados_api_client.arvados_v1_base)
-      env['ARVADOS_API_HOST'] = "#{u.host}:#{u.port}"
-      env['ARVADOS_API_TOKEN'] = @opts[:arvados_api_token]
-      env['ARVADOS_API_HOST_INSECURE'] = "true" if Rails.configuration.arvados_insecure_https
-
-      bytesleft = @opts[:maxbytes].andand.to_i || 2**16
-      io = IO.popen([env, 'arv-get', "#{@opts[:uuid]}/#{@opts[:file]}"], 'rb')
-      while bytesleft > 0 && (buf = io.read([bytesleft, 2**16].min)) != nil
-        # shrink the bytesleft count, if we were given a maximum byte
-        # count to read
-        if @opts.include? :maxbytes
-          bytesleft = bytesleft - buf.length
-        end
-        yield buf
-      end
-      io.close
-      # "If ios is opened by IO.popen, close sets $?."
-      # http://www.ruby-doc.org/core-2.1.3/IO.html#method-i-close
-      Rails.logger.warn("#{@opts[:uuid]}/#{@opts[:file]}: #{$?}") if $? != 0
-    end
-  end
 end