apps/workbench/app/helpers/application_helper.rb

   1 module ApplicationHelper
   2   def current_user
   3     controller.current_user
   4   end
   5
   6   def self.match_uuid(uuid)
   7     /^([0-9a-z]{5})-([0-9a-z]{5})-([0-9a-z]{15})$/.match(uuid.to_s)
   8   end
   9
  10   def current_api_host
  11     Rails.configuration.arvados_v1_base.gsub /https?:\/\/|\/arvados\/v1/,''
  12   end
  13
  14   def render_markup(markup)
  15     raw RedCloth.new(markup.to_s).to_html(:refs_arvados, :textile) if markup
  16   end
  17
  18   def human_readable_bytes_html(n)
  19     return h(n) unless n.is_a? Fixnum
  20     return "0 bytes" if (n == 0)
  21
  22     orders = {
  23       1 => "bytes",
  24       1024 => "KiB",
  25       (1024*1024) => "MiB",
  26       (1024*1024*1024) => "GiB",
  27       (1024*1024*1024*1024) => "TiB"
  28     }
  29
  30     orders.each do |k, v|
  31       sig = (n.to_f/k)
  32       if sig >=1 and sig < 1024
  33         if v == 'bytes'
  34           return "%i #{v}" % sig
  35         else
  36           return "%0.1f #{v}" % sig
  37         end
  38       end
  39     end
  40
  41     return h(n)
  42     #raw = n.to_s
  43     #cooked = ''
  44     #while raw.length > 3
  45     #  cooked = ',' + raw[-3..-1] + cooked
  46     #  raw = raw[0..-4]
  47     #end
  48     #cooked = raw + cooked
  49   end
  50
  51   def resource_class_for_uuid(attrvalue, opts={})
  52     ArvadosBase::resource_class_for_uuid(attrvalue, opts)
  53   end
  54
  55   # When using {remote:true}, or using {method:...} to use an HTTP
  56   # method other than GET, move the target URI from href to
  57   # data-remote-href. Otherwise, browsers offer features like "open in
  58   # new window" and "copy link address" which bypass Rails' click
  59   # handler and therefore end up at incorrect/nonexistent routes (by
  60   # ignoring data-method) and expect to receive pages rather than
  61   # javascript responses.
  62   #
  63   # See assets/javascripts/link_to_remote.js for supporting code.
  64   def link_to *args, &block
  65     if (args.last and args.last.is_a? Hash and
  66         (args.last[:remote] or
  67          (args.last[:method] and
  68           args.last[:method].to_s.upcase != 'GET')))
  69       if Rails.env.test?
  70         # Capybara/phantomjs can't click_link without an href, even if
  71         # the click handler means it never gets used.
  72         raw super.gsub(' href="', ' href="#" data-remote-href="')
  73       else
  74         # Regular browsers work as desired: users can click A elements
  75         # without hrefs, and click handlers fire; but there's no "copy
  76         # link address" option in the right-click menu.
  77         raw super.gsub(' href="', ' data-remote-href="')
  78       end
  79     else
  80       super
  81     end
  82   end
  83
  84   ##
  85   # Returns HTML that links to the Arvados object specified in +attrvalue+
  86   # Provides various output control and styling options.
  87   #
  88   # +attrvalue+ an Arvados model object or uuid
  89   #
  90   # +opts+ a set of flags to control output:
  91   #
  92   # [:link_text] the link text to use (may include HTML), overrides everything else
  93   #
  94   # [:friendly_name] whether to use the "friendly" name in the link text (by
  95   # calling #friendly_link_name on the object), otherwise use the uuid
  96   #
  97   # [:with_class_name] prefix the link text with the class name of the model
  98   #
  99   # [:no_tags] disable tags in the link text (default is to show tags).
 100   # Currently tags are only shown for Collections.
 101   #
 102   # [:thumbnail] if the object is a collection, show an image thumbnail if the
 103   # collection consists of a single image file.
 104   #
 105   # [:no_link] don't create a link, just return the link text
 106   #
 107   # +style_opts+ additional HTML properties for the anchor tag, passed to link_to
 108   #
 109   def link_to_if_arvados_object(attrvalue, opts={}, style_opts={})
 110     if (resource_class = resource_class_for_uuid(attrvalue, opts))
 111       if attrvalue.is_a? ArvadosBase
 112         object = attrvalue
 113         link_uuid = attrvalue.uuid
 114       else
 115         object = nil
 116         link_uuid = attrvalue
 117       end
 118       link_name = opts[:link_text]
 119       tags = ""
 120       if !link_name
 121         link_name = object.andand.default_name || resource_class.default_name
 122
 123         if opts[:friendly_name]
 124           if attrvalue.respond_to? :friendly_link_name
 125             link_name = attrvalue.friendly_link_name opts[:lookup]
 126           else
 127             begin
 128               if resource_class.name == 'Collection'
 129                 link_name = collections_for_object(link_uuid).andand.first.andand.friendly_link_name
 130               else
 131                 link_name = object_for_dataclass(resource_class, link_uuid).andand.friendly_link_name
 132               end
 133             rescue ArvadosApiClient::NotFoundException
 134               # If that lookup failed, the link will too. So don't make one.
 135               return attrvalue
 136             end
 137           end
 138         end
 139         if link_name.nil? or link_name.empty?
 140           link_name = attrvalue
 141         end
 142         if opts[:with_class_name]
 143           link_name = "#{resource_class.to_s}: #{link_name}"
 144         end
 145         if !opts[:no_tags] and resource_class == Collection
 146           links_for_object(link_uuid).each do |tag|
 147             if tag.link_class.in? ["tag", "identifier"]
 148               tags += ' <span class="label label-info">'
 149               tags += link_to tag.name, controller: "links", filters: [["link_class", "=", "tag"], ["name", "=", tag.name]].to_json
 150               tags += '</span>'
 151             end
 152           end
 153         end
 154         if opts[:thumbnail] and resource_class == Collection
 155           # add an image thumbnail if the collection consists of a single image file.
 156           collections_for_object(link_uuid).each do |c|
 157             if c.files.length == 1 and CollectionsHelper::is_image c.files.first[1]
 158               link_name += " "
 159               link_name += image_tag "#{url_for c}/#{CollectionsHelper::file_path c.files.first}", style: "height: 4em; width: auto"
 160             end
 161           end
 162         end
 163       end
 164       style_opts[:class] = (style_opts[:class] || '') + ' nowrap'
 165       if opts[:no_link] or (resource_class == User && !current_user)
 166         raw(link_name)
 167       else
 168         (link_to raw(link_name), { controller: resource_class.to_s.tableize, action: 'show', id: ((opts[:name_link].andand.uuid) || link_uuid) }, style_opts) + raw(tags)
 169       end
 170     else
 171       # just return attrvalue if it is not recognizable as an Arvados object or uuid.
 172       if attrvalue.nil? or (attrvalue.is_a? String and attrvalue.empty?)
 173         "(none)"
 174       else
 175         attrvalue
 176       end
 177     end
 178   end
 179
 180   def link_to_arvados_object_if_readable(attrvalue, link_text, link_text_if_not_readable, use_friendly_name=false)
 181     resource_class = resource_class_for_uuid(attrvalue)
 182     if !resource_class
 183       return link_text_if_not_readable
 184     end
 185
 186     if resource_class.to_s == 'Collection'
 187       if CollectionsHelper.match(attrvalue)
 188         readable = collection_for_pdh(attrvalue).any?
 189       else
 190         readable = collections_for_object(attrvalue).any?
 191       end
 192     else
 193       readable = object_for_dataclass(resource_class, attrvalue)
 194     end
 195
 196     if readable
 197       if use_friendly_name
 198         link_to_if_arvados_object attrvalue, friendly_name: true
 199       else
 200         link_to_if_arvados_object attrvalue, link_text: link_text
 201       end
 202     else
 203       link_text_if_not_readable
 204     end
 205   end
 206
 207   def render_editable_attribute(object, attr, attrvalue=nil, htmloptions={})
 208     attrvalue = object.send(attr) if attrvalue.nil?
 209     if not object.attribute_editable?(attr)
 210       if attrvalue && attrvalue.length > 0
 211         return render_attribute_as_textile( object, attr, attrvalue, false )
 212       else
 213         return (attr == 'name' and object.andand.default_name) ||
 214                 '(none)'
 215       end
 216     end
 217
 218     input_type = 'text'
 219     attrtype = object.class.attribute_info[attr.to_sym].andand[:type]
 220     if attrtype == 'text' or attr == 'description'
 221       input_type = 'textarea'
 222     elsif attrtype == 'datetime'
 223       input_type = 'date'
 224     else
 225       input_type = 'text'
 226     end
 227
 228     attrvalue = attrvalue.to_json if attrvalue.is_a? Hash or attrvalue.is_a? Array
 229     rendervalue = render_attribute_as_textile( object, attr, attrvalue, false )
 230
 231     ajax_options = {
 232       "data-pk" => {
 233         id: object.uuid,
 234         key: object.class.to_s.underscore
 235       }
 236     }
 237     if object.uuid
 238       ajax_options['data-url'] = url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore)
 239     else
 240       ajax_options['data-url'] = url_for(action: "create", controller: object.class.to_s.pluralize.underscore)
 241       ajax_options['data-pk'][:defaults] = object.attributes
 242     end
 243     ajax_options['data-pk'] = ajax_options['data-pk'].to_json
 244     @unique_id ||= (Time.now.to_f*1000000).to_i
 245     span_id = object.uuid.to_s + '-' + attr.to_s + '-' + (@unique_id += 1).to_s
 246
 247     span_tag = content_tag 'span', rendervalue, {
 248       "data-emptytext" => '(none)',
 249       "data-placement" => "bottom",
 250       "data-type" => input_type,
 251       "data-title" => "Edit #{attr.to_s.gsub '_', ' '}",
 252       "data-name" => attr,
 253       "data-object-uuid" => object.uuid,
 254       "data-toggle" => "manual",
 255       "data-value" => attrvalue,
 256       "id" => span_id,
 257       :class => "editable #{is_textile?( object, attr ) ? 'editable-textile' : ''}"
 258     }.merge(htmloptions).merge(ajax_options)
 259     edit_tiptitle = 'edit'
 260     edit_tiptitle = 'Warning: do not use hyphens in the repository name as they will be stripped' if (object.class.to_s == 'Repository' and attr == 'name')
 261     edit_button = raw('<a href="#" class="btn btn-xs btn-default btn-nodecorate" data-toggle="x-editable tooltip" data-toggle-selector="#' + span_id + '" data-placement="top" title="' + (htmloptions[:tiptitle] || edit_tiptitle) + '"><i class="fa fa-fw fa-pencil"></i></a>')
 262     if htmloptions[:btnplacement] == :left
 263       edit_button + ' ' + span_tag
 264     else
 265       span_tag + ' ' + edit_button
 266     end
 267   end
 268
 269   def render_pipeline_component_attribute(object, attr, subattr, value_info, htmloptions={})
 270     datatype = nil
 271     required = true
 272     attrvalue = value_info
 273
 274     if value_info.is_a? Hash
 275       if value_info[:output_of]
 276         return raw("<span class='label label-default'>#{value_info[:output_of]}</span>")
 277       end
 278       if value_info[:dataclass]
 279         dataclass = value_info[:dataclass]
 280       end
 281       if value_info[:optional] != nil
 282         required = (value_info[:optional] != "true")
 283       end
 284       if value_info[:required] != nil
 285         required = value_info[:required]
 286       end
 287
 288       # Pick a suitable attrvalue to show as the current value (i.e.,
 289       # the one that would be used if we ran the pipeline right now).
 290       if value_info[:value]
 291         attrvalue = value_info[:value]
 292       elsif value_info[:default]
 293         attrvalue = value_info[:default]
 294       else
 295         attrvalue = ''
 296       end
 297       preconfigured_search_str = value_info[:search_for]
 298     end
 299
 300     if not object.andand.attribute_editable?(attr)
 301       return link_to_if_arvados_object attrvalue
 302     end
 303
 304     if dataclass
 305       begin
 306         dataclass = dataclass.constantize
 307       rescue NameError
 308       end
 309     else
 310       dataclass = ArvadosBase.resource_class_for_uuid(attrvalue)
 311     end
 312
 313     id = "#{object.uuid}-#{subattr.join('-')}"
 314     dn = "[#{attr}]"
 315     subattr.each do |a|
 316       dn += "[#{a}]"
 317     end
 318     if value_info.is_a? Hash
 319       dn += '[value]'
 320     end
 321
 322     if (dataclass == Collection) or (dataclass == File)
 323       selection_param = object.class.to_s.underscore + dn
 324       display_value = attrvalue
 325       if value_info.is_a?(Hash)
 326         if (link = Link.find? value_info[:link_uuid])
 327           display_value = link.name
 328         elsif value_info[:link_name]
 329           display_value = value_info[:link_name]
 330         elsif value_info[:selection_name]
 331           display_value = value_info[:selection_name]
 332         end
 333       end
 334       if (attr == :components) and (subattr.size > 2)
 335         chooser_title = "Choose a #{dataclass == Collection ? 'dataset' : 'file'} for #{object.component_input_title(subattr[0], subattr[2])}:"
 336       else
 337         chooser_title = "Choose a #{dataclass == Collection ? 'dataset' : 'file'}:"
 338       end
 339       modal_path = choose_collections_path \
 340       ({ title: chooser_title,
 341          filters: [['owner_uuid', '=', object.owner_uuid]].to_json,
 342          action_name: 'OK',
 343          action_href: pipeline_instance_path(id: object.uuid),
 344          action_method: 'patch',
 345          preconfigured_search_str: (preconfigured_search_str || ""),
 346          action_data: {
 347            merge: true,
 348            use_preview_selection: dataclass == File ? true : nil,
 349            selection_param: selection_param,
 350            success: 'page-refresh'
 351          }.to_json,
 352         })
 353       return content_tag('div', :class => 'input-group') do
 354         html = text_field_tag(dn, display_value,
 355                               :class =>
 356                               "form-control #{'required' if required}")
 357         html + content_tag('span', :class => 'input-group-btn') do
 358           link_to('Choose',
 359                   modal_path,
 360                   { :class => "btn btn-primary",
 361                     :remote => true,
 362                     :method => 'get',
 363                   })
 364         end
 365       end
 366     end
 367
 368     if attrvalue.is_a? String
 369       datatype = 'text'
 370     elsif attrvalue.is_a?(Array) or dataclass.andand.is_a?(Class)
 371       # TODO: find a way to edit with x-editable
 372       return attrvalue
 373     end
 374
 375     # When datatype is a String or Fixnum, link_to the attrvalue
 376     lt = link_to attrvalue, '#', {
 377       "data-emptytext" => "none",
 378       "data-placement" => "bottom",
 379       "data-type" => datatype,
 380       "data-url" => url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore, merge: true),
 381       "data-title" => "Set value for #{subattr[-1].to_s}",
 382       "data-name" => dn,
 383       "data-pk" => "{id: \"#{object.uuid}\", key: \"#{object.class.to_s.underscore}\"}",
 384       "data-value" => attrvalue,
 385       # "clear" button interferes with form-control's up/down arrows
 386       "data-clear" => false,
 387       :class => "editable #{'required' if required} form-control",
 388       :id => id
 389     }.merge(htmloptions)
 390
 391     lt
 392   end
 393
 394   def render_arvados_object_list_start(list, button_text, button_href,
 395                                        params={}, *rest, &block)
 396     show_max = params.delete(:show_max) || 3
 397     params[:class] ||= 'btn btn-xs btn-default'
 398     list[0...show_max].each { |item| yield item }
 399     unless list[show_max].nil?
 400       link_to(h(button_text) +
 401               raw(' &nbsp; <i class="fa fa-fw fa-arrow-circle-right"></i>'),
 402               button_href, params, *rest)
 403     end
 404   end
 405
 406   def render_controller_partial partial, opts
 407     cname = opts.delete :controller_name
 408     begin
 409       render opts.merge(partial: "#{cname}/#{partial}")
 410     rescue ActionView::MissingTemplate
 411       render opts.merge(partial: "application/#{partial}")
 412     end
 413   end
 414
 415   RESOURCE_CLASS_ICONS = {
 416     "Collection" => "fa-archive",
 417     "Group" => "fa-users",
 418     "Human" => "fa-male",  # FIXME: Use a more inclusive icon.
 419     "Job" => "fa-gears",
 420     "KeepDisk" => "fa-hdd-o",
 421     "KeepService" => "fa-exchange",
 422     "Link" => "fa-arrows-h",
 423     "Node" => "fa-cloud",
 424     "PipelineInstance" => "fa-gears",
 425     "PipelineTemplate" => "fa-gears",
 426     "Repository" => "fa-code-fork",
 427     "Specimen" => "fa-flask",
 428     "Trait" => "fa-clipboard",
 429     "User" => "fa-user",
 430     "VirtualMachine" => "fa-terminal",
 431   }
 432   DEFAULT_ICON_CLASS = "fa-cube"
 433
 434   def fa_icon_class_for_class(resource_class, default=DEFAULT_ICON_CLASS)
 435     RESOURCE_CLASS_ICONS.fetch(resource_class.to_s, default)
 436   end
 437
 438   def fa_icon_class_for_uuid(uuid, default=DEFAULT_ICON_CLASS)
 439     fa_icon_class_for_class(resource_class_for_uuid(uuid), default)
 440   end
 441
 442   def fa_icon_class_for_object(object, default=DEFAULT_ICON_CLASS)
 443     case class_name = object.class.to_s
 444     when "Group"
 445       object.group_class ? 'fa-folder' : 'fa-users'
 446     else
 447       RESOURCE_CLASS_ICONS.fetch(class_name, default)
 448     end
 449   end
 450
 451   def chooser_preview_url_for object, use_preview_selection=false
 452     case object.class.to_s
 453     when 'Collection'
 454       polymorphic_path(object, tab_pane: 'chooser_preview', use_preview_selection: use_preview_selection)
 455     else
 456       nil
 457     end
 458   end
 459
 460   def render_attribute_as_textile( object, attr, attrvalue, truncate )
 461     if attrvalue && (is_textile? object, attr)
 462       markup = render_markup attrvalue
 463       markup = markup[0,markup.index('</p>')+4] if (truncate && markup.index('</p>'))
 464       return markup
 465     else
 466       return attrvalue
 467     end
 468   end
 469
 470   def render_localized_date(date, opts="")
 471     raw("<span class='utc-date' data-utc-date='#{date}' data-utc-date-opts='noseconds'>#{date}</span>")
 472   end
 473
 474 private
 475   def is_textile?( object, attr )
 476     is_textile = object.textile_attributes.andand.include?(attr)
 477   end
 478 end