Merge branch '3859-crunch-job-use-lock' closes #3859
[arvados.git] / 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   ##
56   # Returns HTML that links to the Arvados object specified in +attrvalue+
57   # Provides various output control and styling options.
58   #
59   # +attrvalue+ an Arvados model object or uuid
60   #
61   # +opts+ a set of flags to control output:
62   #
63   # [:link_text] the link text to use (may include HTML), overrides everything else
64   #
65   # [:friendly_name] whether to use the "friendly" name in the link text (by
66   # calling #friendly_link_name on the object), otherwise use the uuid
67   #
68   # [:with_class_name] prefix the link text with the class name of the model
69   #
70   # [:no_tags] disable tags in the link text (default is to show tags).
71   # Currently tags are only shown for Collections.
72   #
73   # [:thumbnail] if the object is a collection, show an image thumbnail if the
74   # collection consists of a single image file.
75   #
76   # [:no_link] don't create a link, just return the link text
77   #
78   # +style_opts+ additional HTML properties for the anchor tag, passed to link_to
79   #
80   def link_to_if_arvados_object(attrvalue, opts={}, style_opts={})
81     if (resource_class = resource_class_for_uuid(attrvalue, opts))
82       if attrvalue.is_a? ArvadosBase
83         object = attrvalue
84         link_uuid = attrvalue.uuid
85       else
86         object = nil
87         link_uuid = attrvalue
88       end
89       link_name = opts[:link_text]
90       tags = ""
91       if !link_name
92         link_name = object.andand.default_name || resource_class.default_name
93
94         if opts[:friendly_name]
95           if attrvalue.respond_to? :friendly_link_name
96             link_name = attrvalue.friendly_link_name opts[:lookup]
97           else
98             begin
99               if resource_class.name == 'Collection'
100                 link_name = collections_for_object(link_uuid).andand.first.andand.friendly_link_name
101               else
102                 link_name = object_for_dataclass(resource_class, link_uuid).andand.friendly_link_name
103               end
104             rescue ArvadosApiClient::NotFoundException
105               # If that lookup failed, the link will too. So don't make one.
106               return attrvalue
107             end
108           end
109         end
110         if link_name.nil? or link_name.empty?
111           link_name = attrvalue
112         end
113         if opts[:with_class_name]
114           link_name = "#{resource_class.to_s}: #{link_name}"
115         end
116         if !opts[:no_tags] and resource_class == Collection
117           links_for_object(link_uuid).each do |tag|
118             if tag.link_class.in? ["tag", "identifier"]
119               tags += ' <span class="label label-info">'
120               tags += link_to tag.name, controller: "links", filters: [["link_class", "=", "tag"], ["name", "=", tag.name]].to_json
121               tags += '</span>'
122             end
123           end
124         end
125         if opts[:thumbnail] and resource_class == Collection
126           # add an image thumbnail if the collection consists of a single image file.
127           collections_for_object(link_uuid).each do |c|
128             if c.files.length == 1 and CollectionsHelper::is_image c.files.first[1]
129               link_name += " "
130               link_name += image_tag "#{url_for c}/#{CollectionsHelper::file_path c.files.first}", style: "height: 4em; width: auto"
131             end
132           end
133         end
134       end
135       style_opts[:class] = (style_opts[:class] || '') + ' nowrap'
136       if opts[:no_link]
137         raw(link_name)
138       else
139         (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)
140       end
141     else
142       # just return attrvalue if it is not recognizable as an Arvados object or uuid.
143       if attrvalue.nil? or (attrvalue.is_a? String and attrvalue.empty?)
144         "(none)"
145       else
146         attrvalue
147       end
148     end
149   end
150
151   def render_editable_attribute(object, attr, attrvalue=nil, htmloptions={})
152     attrvalue = object.send(attr) if attrvalue.nil?
153     if !object.attribute_editable?(attr, :ever) or
154         (!object.editable? and
155          !object.owner_uuid.in?(my_projects.collect(&:uuid)))
156       if attrvalue && attrvalue.length > 0
157         return render_attribute_as_textile( object, attr, attrvalue, false )
158       else
159         return (attr == 'name' and object.andand.default_name) ||
160                 '(none)'
161       end
162     end
163
164     input_type = 'text'
165     case object.class.attribute_info[attr.to_sym].andand[:type]
166     when 'text'
167       input_type = 'textarea'
168     when 'datetime'
169       input_type = 'date'
170     else
171       input_type = 'text'
172     end
173
174     attrvalue = attrvalue.to_json if attrvalue.is_a? Hash or attrvalue.is_a? Array
175     rendervalue = render_attribute_as_textile( object, attr, attrvalue, false )
176
177     ajax_options = {
178       "data-pk" => {
179         id: object.uuid,
180         key: object.class.to_s.underscore
181       }
182     }
183     if object.uuid
184       ajax_options['data-url'] = url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore)
185     else
186       ajax_options['data-url'] = url_for(action: "create", controller: object.class.to_s.pluralize.underscore)
187       ajax_options['data-pk'][:defaults] = object.attributes
188     end
189     ajax_options['data-pk'] = ajax_options['data-pk'].to_json
190     @unique_id ||= (Time.now.to_f*1000000).to_i
191     span_id = object.uuid.to_s + '-' + attr.to_s + '-' + (@unique_id += 1).to_s
192
193     span_tag = content_tag 'span', rendervalue, {
194       "data-emptytext" => '(none)',
195       "data-placement" => "bottom",
196       "data-type" => input_type,
197       "data-title" => "Edit #{attr.to_s.gsub '_', ' '}",
198       "data-name" => attr,
199       "data-object-uuid" => object.uuid,
200       "data-toggle" => "manual",
201       "data-value" => attrvalue,
202       "id" => span_id,
203       :class => "editable #{is_textile?( object, attr ) ? 'editable-textile' : ''}"
204     }.merge(htmloptions).merge(ajax_options)
205     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') + '"><i class="fa fa-fw fa-pencil"></i></a>')
206     if htmloptions[:btnplacement] == :left
207       edit_button + ' ' + span_tag
208     else
209       span_tag + ' ' + edit_button
210     end
211   end
212
213   def render_pipeline_component_attribute(object, attr, subattr, value_info, htmloptions={})
214     datatype = nil
215     required = true
216     attrvalue = value_info
217
218     if value_info.is_a? Hash
219       if value_info[:output_of]
220         return raw("<span class='label label-default'>#{value_info[:output_of]}</span>")
221       end
222       if value_info[:dataclass]
223         dataclass = value_info[:dataclass]
224       end
225       if value_info[:optional] != nil
226         required = (value_info[:optional] != "true")
227       end
228       if value_info[:required] != nil
229         required = value_info[:required]
230       end
231
232       # Pick a suitable attrvalue to show as the current value (i.e.,
233       # the one that would be used if we ran the pipeline right now).
234       if value_info[:value]
235         attrvalue = value_info[:value]
236       elsif value_info[:default]
237         attrvalue = value_info[:default]
238       else
239         attrvalue = ''
240       end
241       preconfigured_search_str = value_info[:search_for]
242     end
243
244     if !object or
245         !object.attribute_editable?(attr, :ever) or
246         (!object.editable? and
247          !object.owner_uuid.in?(my_projects.collect(&:uuid)))
248       return link_to_if_arvados_object attrvalue
249     end
250
251     if dataclass
252       begin
253         dataclass = dataclass.constantize
254       rescue NameError
255       end
256     else
257       dataclass = ArvadosBase.resource_class_for_uuid(attrvalue)
258     end
259
260     id = "#{object.uuid}-#{subattr.join('-')}"
261     dn = "[#{attr}]"
262     subattr.each do |a|
263       dn += "[#{a}]"
264     end
265     if value_info.is_a? Hash
266       dn += '[value]'
267     end
268
269     if dataclass == Collection
270       selection_param = object.class.to_s.underscore + dn
271       display_value = attrvalue
272       if value_info.is_a?(Hash)
273         if (link = Link.find? value_info[:link_uuid])
274           display_value = link.name
275         elsif value_info[:link_name]
276           display_value = value_info[:link_name]
277         end
278       end
279       if (attr == :components) and (subattr.size > 2)
280         chooser_title = "Choose a dataset for #{object.component_input_title(subattr[0], subattr[2])}:"
281       else
282         chooser_title = "Choose a dataset:"
283       end
284       modal_path = choose_collections_path \
285       ({ title: chooser_title,
286          filters: [['owner_uuid', '=', object.owner_uuid]].to_json,
287          action_name: 'OK',
288          action_href: pipeline_instance_path(id: object.uuid),
289          action_method: 'patch',
290          preconfigured_search_str: (preconfigured_search_str || ""),
291          action_data: {
292            merge: true,
293            selection_param: selection_param,
294            success: 'page-refresh'
295          }.to_json,
296         })
297       return content_tag('div', :class => 'input-group') do
298         html = text_field_tag(dn, display_value,
299                               :class =>
300                               "form-control #{'required' if required}")
301         html + content_tag('span', :class => 'input-group-btn') do
302           link_to('Choose',
303                   modal_path,
304                   { :class => "btn btn-primary",
305                     :remote => true,
306                     :method => 'get',
307                   })
308         end
309       end
310     end
311
312     if dataclass.andand.is_a?(Class)
313       datatype = 'select'
314     elsif dataclass == 'number'
315       datatype = 'number'
316     elsif attrvalue.is_a? Array
317       # TODO: find a way to edit arrays with x-editable
318       return attrvalue
319     elsif attrvalue.is_a? Fixnum or attrvalue.is_a? Float
320       datatype = 'number'
321     elsif attrvalue.is_a? String
322       datatype = 'text'
323     end
324
325     # preload data
326     preload_uuids = []
327     items = []
328     selectables = []
329
330     attrtext = attrvalue
331     if dataclass.is_a? Class and dataclass < ArvadosBase
332       objects = get_n_objects_of_class dataclass, 10
333       objects.each do |item|
334         items << item
335         preload_uuids << item.uuid
336       end
337       if attrvalue and !attrvalue.empty?
338         preload_uuids << attrvalue
339       end
340       preload_links_for_objects preload_uuids
341
342       if attrvalue and !attrvalue.empty?
343         links_for_object(attrvalue).each do |link|
344           if link.link_class.in? ["tag", "identifier"]
345             attrtext += " [#{link.name}]"
346           end
347         end
348         selectables.append({name: attrtext, uuid: attrvalue, type: dataclass.to_s})
349       end
350       itemuuids = []
351       items.each do |item|
352         itemuuids << item.uuid
353         selectables.append({name: item.uuid, uuid: item.uuid, type: dataclass.to_s})
354       end
355
356       itemuuids.each do |itemuuid|
357         links_for_object(itemuuid).each do |link|
358           if link.link_class.in? ["tag", "identifier"]
359             selectables.each do |selectable|
360               if selectable['uuid'] == link.head_uuid
361                 selectable['name'] += ' [' + link.name + ']'
362               end
363             end
364           end
365         end
366       end
367     end
368
369     lt = link_to attrtext, '#', {
370       "data-emptytext" => "none",
371       "data-placement" => "bottom",
372       "data-type" => datatype,
373       "data-url" => url_for(action: "update", id: object.uuid, controller: object.class.to_s.pluralize.underscore, merge: true),
374       "data-title" => "Set value for #{subattr[-1].to_s}",
375       "data-name" => dn,
376       "data-pk" => "{id: \"#{object.uuid}\", key: \"#{object.class.to_s.underscore}\"}",
377       "data-value" => attrvalue,
378       # "clear" button interferes with form-control's up/down arrows
379       "data-clear" => false,
380       :class => "editable #{'required' if required} form-control",
381       :id => id
382     }.merge(htmloptions)
383
384     lt += raw("\n<script>")
385
386     if selectables.any?
387       lt += raw("add_form_selection_sources(#{selectables.to_json});\n")
388     end
389
390     lt += raw("$('[data-name=\"#{dn}\"]').editable({source: function() { return select_form_sources('#{dataclass}'); } });\n")
391
392     lt += raw("</script>")
393
394     lt
395   end
396
397   def render_arvados_object_list_start(list, button_text, button_href,
398                                        params={}, *rest, &block)
399     show_max = params.delete(:show_max) || 3
400     params[:class] ||= 'btn btn-xs btn-default'
401     list[0...show_max].each { |item| yield item }
402     unless list[show_max].nil?
403       link_to(h(button_text) +
404               raw(' &nbsp; <i class="fa fa-fw fa-arrow-circle-right"></i>'),
405               button_href, params, *rest)
406     end
407   end
408
409   def render_controller_partial partial, opts
410     cname = opts.delete :controller_name
411     begin
412       render opts.merge(partial: "#{cname}/#{partial}")
413     rescue ActionView::MissingTemplate
414       render opts.merge(partial: "application/#{partial}")
415     end
416   end
417
418   RESOURCE_CLASS_ICONS = {
419     "Collection" => "fa-archive",
420     "Group" => "fa-users",
421     "Human" => "fa-male",  # FIXME: Use a more inclusive icon.
422     "Job" => "fa-gears",
423     "KeepDisk" => "fa-hdd-o",
424     "KeepService" => "fa-exchange",
425     "Link" => "fa-arrows-h",
426     "Node" => "fa-cloud",
427     "PipelineInstance" => "fa-gears",
428     "PipelineTemplate" => "fa-gears",
429     "Repository" => "fa-code-fork",
430     "Specimen" => "fa-flask",
431     "Trait" => "fa-clipboard",
432     "User" => "fa-user",
433     "VirtualMachine" => "fa-terminal",
434   }
435   DEFAULT_ICON_CLASS = "fa-cube"
436
437   def fa_icon_class_for_class(resource_class, default=DEFAULT_ICON_CLASS)
438     RESOURCE_CLASS_ICONS.fetch(resource_class.to_s, default)
439   end
440
441   def fa_icon_class_for_uuid(uuid, default=DEFAULT_ICON_CLASS)
442     fa_icon_class_for_class(resource_class_for_uuid(uuid), default)
443   end
444
445   def fa_icon_class_for_object(object, default=DEFAULT_ICON_CLASS)
446     case class_name = object.class.to_s
447     when "Group"
448       object.group_class ? 'fa-folder' : 'fa-users'
449     else
450       RESOURCE_CLASS_ICONS.fetch(class_name, default)
451     end
452   end
453
454   def chooser_preview_url_for object
455     case object.class.to_s
456     when 'Collection'
457       polymorphic_path(object, tab_pane: 'chooser_preview')
458     else
459       nil
460     end
461   end
462
463   def render_attribute_as_textile( object, attr, attrvalue, truncate )
464     if attrvalue && (is_textile? object, attr)
465       markup = render_markup attrvalue
466       markup = markup[0,markup.index('</p>')+4] if (truncate && markup.index('</p>'))
467       return markup
468     else
469       return attrvalue
470     end
471   end
472
473   def render_localized_date(date, opts="")
474     raw("<span class='utc-date' data-utc-date='#{date}' data-utc-date-opts='noseconds'>#{date}</span>")
475   end
476
477 private
478   def is_textile?( object, attr )
479     is_textile = object.textile_attributes.andand.include?(attr)
480   end
481 end