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         controller_class = resource_class.to_s.tableize
 169         if controller_class.eql?('groups') and object.andand.group_class.eql?('project')
 170           controller_class = 'projects'
 171         end
 172         (link_to raw(link_name), { controller: controller_class, action: 'show', id: ((opts[:name_link].andand.uuid) || link_uuid) }, style_opts) + raw(tags)
 173       end
 174     else
 175       # just return attrvalue if it is not recognizable as an Arvados object or uuid.
 176       if attrvalue.nil? or (attrvalue.is_a? String and attrvalue.empty?)
 177         "(none)"
 178       else
 179         attrvalue
 180       end
 181     end
 182   end
 183
 184   def link_to_arvados_object_if_readable(attrvalue, link_text_if_not_readable, opts={})
 185     resource_class = resource_class_for_uuid(attrvalue.split('/')[0]) if attrvalue
 186     if !resource_class
 187       return link_to_if_arvados_object attrvalue, opts
 188     end
 189
 190     readable = object_readable attrvalue, resource_class
 191     if readable
 192       link_to_if_arvados_object attrvalue, opts
 193     elsif opts[:required] and current_user # no need to show this for anonymous user
 194       raw('<div><input type="text" style="border:none;width:100%;background:#ffdddd" disabled=true class="required unreadable-input" value="') + link_text_if_not_readable + raw('" ></input></div>')
 195     else
 196       link_text_if_not_readable
 197     end
 198   end
 199
 200   # This method takes advantage of preloaded collections and objects.
 201   # Hence you can improve performance by first preloading objects
 202   # related to the page context before using this method.
 203   def object_readable attrvalue, resource_class=nil
 204     # if it is a collection filename, check readable for the locator
 205     attrvalue = attrvalue.split('/')[0] if attrvalue
 206
 207     resource_class = resource_class_for_uuid(attrvalue) if resource_class.nil?
 208     return if resource_class.nil?
 209
 210     return_value = nil
 211     if resource_class.to_s == 'Collection'
 212       if CollectionsHelper.match(attrvalue)
 213         found = collection_for_pdh(attrvalue)
 214         return_value = found.first if found.any?
 215       else
 216         found = collections_for_object(attrvalue)
 217         return_value = found.first if found.any?
 218       end
 219     else
 220       return_value = object_for_dataclass(resource_class, attrvalue)
 221     end
 222     return_value
 223   end
 224
 225   def render_editable_attribute(object, attr, attrvalue=nil, htmloptions={})
 226     attrvalue = object.send(attr) if attrvalue.nil?
 227     if not object.attribute_editable?(attr)
 228       if attrvalue && attrvalue.length > 0
 229         return render_attribute_as_textile( object, attr, attrvalue, false )
 230       else
 231         return (attr == 'name' and object.andand.default_name) ||
 232                 '(none)'
 233       end
 234     end
 235
 236     input_type = 'text'
 237     attrtype = object.class.attribute_info[attr.to_sym].andand[:type]
 238     if attrtype == 'text' or attr == 'description'
 239       input_type = 'textarea'
 240     elsif attrtype == 'datetime'
 241       input_type = 'date'
 242     else
 243       input_type = 'text'
 244     end
 245
 246     attrvalue = attrvalue.to_json if attrvalue.is_a? Hash or attrvalue.is_a? Array
 247     rendervalue = render_attribute_as_textile( object, attr, attrvalue, false )
 248
 249     ajax_options = {
 250       "data-pk" => {
 251         id: object.uuid,
 252         key: object.class.to_s.underscore
 253       }
 254     }
 255     if object.uuid
 256       ajax_options['data-url'] = url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore)
 257     else
 258       ajax_options['data-url'] = url_for(action: "create", controller: object.class.to_s.pluralize.underscore)
 259       ajax_options['data-pk'][:defaults] = object.attributes
 260     end
 261     ajax_options['data-pk'] = ajax_options['data-pk'].to_json
 262     @unique_id ||= (Time.now.to_f*1000000).to_i
 263     span_id = object.uuid.to_s + '-' + attr.to_s + '-' + (@unique_id += 1).to_s
 264
 265     span_tag = content_tag 'span', rendervalue, {
 266       "data-emptytext" => '(none)',
 267       "data-placement" => "bottom",
 268       "data-type" => input_type,
 269       "data-title" => "Edit #{attr.to_s.gsub '_', ' '}",
 270       "data-name" => attr,
 271       "data-object-uuid" => object.uuid,
 272       "data-toggle" => "manual",
 273       "data-value" => attrvalue,
 274       "id" => span_id,
 275       :class => "editable #{is_textile?( object, attr ) ? 'editable-textile' : ''}"
 276     }.merge(htmloptions).merge(ajax_options)
 277     edit_tiptitle = 'edit'
 278     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')
 279     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>')
 280     if htmloptions[:btnplacement] == :left
 281       edit_button + ' ' + span_tag
 282     else
 283       span_tag + ' ' + edit_button
 284     end
 285   end
 286
 287   def render_pipeline_component_attribute(object, attr, subattr, value_info, htmloptions={})
 288     datatype = nil
 289     required = true
 290     attrvalue = value_info
 291
 292     if value_info.is_a? Hash
 293       if value_info[:output_of]
 294         return raw("<span class='label label-default'>#{value_info[:output_of]}</span>")
 295       end
 296       if value_info[:dataclass]
 297         dataclass = value_info[:dataclass]
 298       end
 299       if value_info[:optional] != nil
 300         required = (value_info[:optional] != "true")
 301       end
 302       if value_info[:required] != nil
 303         required = value_info[:required]
 304       end
 305
 306       # Pick a suitable attrvalue to show as the current value (i.e.,
 307       # the one that would be used if we ran the pipeline right now).
 308       if value_info[:value]
 309         attrvalue = value_info[:value]
 310       elsif value_info[:default]
 311         attrvalue = value_info[:default]
 312       else
 313         attrvalue = ''
 314       end
 315       preconfigured_search_str = value_info[:search_for]
 316     end
 317
 318     if not object.andand.attribute_editable?(attr)
 319       return link_to_arvados_object_if_readable(attrvalue, attrvalue, {friendly_name: true, required: required})
 320     end
 321
 322     if dataclass
 323       begin
 324         dataclass = dataclass.constantize
 325       rescue NameError
 326       end
 327     else
 328       dataclass = ArvadosBase.resource_class_for_uuid(attrvalue)
 329     end
 330
 331     id = "#{object.uuid}-#{subattr.join('-')}"
 332     dn = "[#{attr}]"
 333     subattr.each do |a|
 334       dn += "[#{a}]"
 335     end
 336     if value_info.is_a? Hash
 337       dn += '[value]'
 338     end
 339
 340     if (dataclass == Collection) or (dataclass == File)
 341       selection_param = object.class.to_s.underscore + dn
 342       display_value = attrvalue
 343       if value_info.is_a?(Hash)
 344         if (link = Link.find? value_info[:link_uuid])
 345           display_value = link.name
 346         elsif value_info[:link_name]
 347           display_value = value_info[:link_name]
 348         elsif value_info[:selection_name]
 349           display_value = value_info[:selection_name]
 350         end
 351       end
 352       if (attr == :components) and (subattr.size > 2)
 353         chooser_title = "Choose a #{dataclass == Collection ? 'dataset' : 'file'} for #{object.component_input_title(subattr[0], subattr[2])}:"
 354       else
 355         chooser_title = "Choose a #{dataclass == Collection ? 'dataset' : 'file'}:"
 356       end
 357       modal_path = choose_collections_path \
 358       ({ title: chooser_title,
 359          filters: [['owner_uuid', '=', object.owner_uuid]].to_json,
 360          action_name: 'OK',
 361          action_href: pipeline_instance_path(id: object.uuid),
 362          action_method: 'patch',
 363          preconfigured_search_str: (preconfigured_search_str || ""),
 364          action_data: {
 365            merge: true,
 366            use_preview_selection: dataclass == File ? true : nil,
 367            selection_param: selection_param,
 368            success: 'page-refresh'
 369          }.to_json,
 370         })
 371       is_readable_input = attrvalue.present? and object_readable attrvalue, Collection
 372       return content_tag('div', :class => 'input-group') do
 373         html = text_field_tag(dn, display_value,
 374                               :class =>
 375                               "form-control #{'required' if required} #{'unreadable-input' if !attrvalue.andand.empty? and !is_readable_input}")
 376         html + content_tag('span', :class => 'input-group-btn') do
 377           link_to('Choose',
 378                   modal_path,
 379                   { :class => "btn btn-primary",
 380                     :remote => true,
 381                     :method => 'get',
 382                   })
 383         end
 384       end
 385     end
 386
 387     if attrvalue.is_a? String
 388       datatype = 'text'
 389     elsif attrvalue.is_a?(Array) or dataclass.andand.is_a?(Class)
 390       # TODO: find a way to edit with x-editable
 391       return attrvalue
 392     end
 393
 394     # When datatype is a String or Fixnum, link_to the attrvalue
 395     lt = link_to attrvalue, '#', {
 396       "data-emptytext" => "none",
 397       "data-placement" => "bottom",
 398       "data-type" => datatype,
 399       "data-url" => url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore, merge: true),
 400       "data-title" => "Set value for #{subattr[-1].to_s}",
 401       "data-name" => dn,
 402       "data-pk" => "{id: \"#{object.uuid}\", key: \"#{object.class.to_s.underscore}\"}",
 403       "data-value" => attrvalue,
 404       # "clear" button interferes with form-control's up/down arrows
 405       "data-clear" => false,
 406       :class => "editable #{'required' if required} form-control",
 407       :id => id
 408     }.merge(htmloptions)
 409
 410     lt
 411   end
 412
 413   def render_arvados_object_list_start(list, button_text, button_href,
 414                                        params={}, *rest, &block)
 415     show_max = params.delete(:show_max) || 3
 416     params[:class] ||= 'btn btn-xs btn-default'
 417     list[0...show_max].each { |item| yield item }
 418     unless list[show_max].nil?
 419       link_to(h(button_text) +
 420               raw(' &nbsp; <i class="fa fa-fw fa-arrow-circle-right"></i>'),
 421               button_href, params, *rest)
 422     end
 423   end
 424
 425   def render_controller_partial partial, opts
 426     cname = opts.delete :controller_name
 427     begin
 428       render opts.merge(partial: "#{cname}/#{partial}")
 429     rescue ActionView::MissingTemplate
 430       render opts.merge(partial: "application/#{partial}")
 431     end
 432   end
 433
 434   RESOURCE_CLASS_ICONS = {
 435     "Collection" => "fa-archive",
 436     "Group" => "fa-users",
 437     "Human" => "fa-male",  # FIXME: Use a more inclusive icon.
 438     "Job" => "fa-gears",
 439     "KeepDisk" => "fa-hdd-o",
 440     "KeepService" => "fa-exchange",
 441     "Link" => "fa-arrows-h",
 442     "Node" => "fa-cloud",
 443     "PipelineInstance" => "fa-gears",
 444     "PipelineTemplate" => "fa-gears",
 445     "Repository" => "fa-code-fork",
 446     "Specimen" => "fa-flask",
 447     "Trait" => "fa-clipboard",
 448     "User" => "fa-user",
 449     "VirtualMachine" => "fa-terminal",
 450   }
 451   DEFAULT_ICON_CLASS = "fa-cube"
 452
 453   def fa_icon_class_for_class(resource_class, default=DEFAULT_ICON_CLASS)
 454     RESOURCE_CLASS_ICONS.fetch(resource_class.to_s, default)
 455   end
 456
 457   def fa_icon_class_for_uuid(uuid, default=DEFAULT_ICON_CLASS)
 458     fa_icon_class_for_class(resource_class_for_uuid(uuid), default)
 459   end
 460
 461   def fa_icon_class_for_object(object, default=DEFAULT_ICON_CLASS)
 462     case class_name = object.class.to_s
 463     when "Group"
 464       object.group_class ? 'fa-folder' : 'fa-users'
 465     else
 466       RESOURCE_CLASS_ICONS.fetch(class_name, default)
 467     end
 468   end
 469
 470   def chooser_preview_url_for object, use_preview_selection=false
 471     case object.class.to_s
 472     when 'Collection'
 473       polymorphic_path(object, tab_pane: 'chooser_preview', use_preview_selection: use_preview_selection)
 474     else
 475       nil
 476     end
 477   end
 478
 479   def render_attribute_as_textile( object, attr, attrvalue, truncate )
 480     if attrvalue && (is_textile? object, attr)
 481       markup = render_markup attrvalue
 482       markup = markup[0,markup.index('</p>')+4] if (truncate && markup.index('</p>'))
 483       return markup
 484     else
 485       return attrvalue
 486     end
 487   end
 488
 489   def render_localized_date(date, opts="")
 490     raw("<span class='utc-date' data-utc-date='#{date}' data-utc-date-opts='noseconds'>#{date}</span>")
 491   end
 492
 493 private
 494   def is_textile?( object, attr )
 495     is_textile = object.textile_attributes.andand.include?(attr)
 496   end
 497 end