1 # redMine - project management software
2 # Copyright (C) 2006-2007 Jean-Philippe Lang
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 require 'coderay/helpers/file_type'
23 module ApplicationHelper
24 include Redmine::WikiFormatting::Macros::Definitions
25 include GravatarHelper::PublicMethods
28 def_delegators :wiki_helper, :wikitoolbar_for, :heads_for_wiki_formatter
31 @current_role ||= User.current.role_for_project(@project)
34 # Return true if user is authorized for controller/action, otherwise false
35 def authorize_for(controller, action)
36 User.current.allowed_to?({:controller => controller, :action => action}, @project)
39 # Display a link if user is authorized
40 def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
41 link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])
44 # Display a link to remote if user is authorized
45 def link_to_remote_if_authorized(name, options = {}, html_options = nil)
46 url = options[:url] || {}
47 link_to_remote(name, options, html_options) if authorize_for(url[:controller] || params[:controller], url[:action])
50 # Display a link to user's account page
51 def link_to_user(user, options={})
52 (user && !user.anonymous?) ? link_to(user.name(options[:format]), :controller => 'account', :action => 'show', :id => user) : 'Anonymous'
55 def link_to_issue(issue, options={})
56 options[:class] ||= ''
57 options[:class] << ' issue'
58 options[:class] << ' closed' if issue.closed?
59 link_to "#{issue.tracker.name} ##{issue.id}", {:controller => "issues", :action => "show", :id => issue}, options
62 # Generates a link to an attachment.
64 # * :text - Link text (default to attachment filename)
65 # * :download - Force download (default: false)
66 def link_to_attachment(attachment, options={})
67 text = options.delete(:text) || attachment.filename
68 action = options.delete(:download) ? 'download' : 'show'
70 link_to(h(text), {:controller => 'attachments', :action => action, :id => attachment, :filename => attachment.filename }, options)
73 def toggle_link(name, id, options={})
74 onclick = "Element.toggle('#{id}'); "
75 onclick << (options[:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ")
76 onclick << "return false;"
77 link_to(name, "#", :onclick => onclick)
80 def image_to_function(name, function, html_options = {})
81 html_options.symbolize_keys!
82 tag(:input, html_options.merge({
83 :type => "image", :src => image_path(name),
84 :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};"
88 def prompt_to_remote(name, text, param, url, html_options = {})
89 html_options[:onclick] = "promptToRemote('#{text}', '#{param}', '#{url_for(url)}'); return false;"
90 link_to name, {}, html_options
94 return nil unless date
95 # "Setting.date_format.size < 2" is a temporary fix (content of date_format setting changed)
96 @date_format ||= (Setting.date_format.blank? || Setting.date_format.size < 2 ? l(:general_fmt_date) : Setting.date_format)
97 date.strftime(@date_format)
100 def format_time(time, include_date = true)
101 return nil unless time
102 time = time.to_time if time.is_a?(String)
103 zone = User.current.time_zone
104 local = zone ? time.in_time_zone(zone) : (time.utc? ? time.localtime : time)
105 @date_format ||= (Setting.date_format.blank? || Setting.date_format.size < 2 ? l(:general_fmt_date) : Setting.date_format)
106 @time_format ||= (Setting.time_format.blank? ? l(:general_fmt_time) : Setting.time_format)
107 include_date ? local.strftime("#{@date_format} #{@time_format}") : local.strftime(@time_format)
110 def format_activity_title(text)
111 h(truncate_single_line(text, 100))
114 def format_activity_day(date)
115 date == Date.today ? l(:label_today).titleize : format_date(date)
118 def format_activity_description(text)
119 h(truncate(text.to_s, 250).gsub(%r{<(pre|code)>.*$}m, '...'))
122 def distance_of_date_in_words(from_date, to_date = 0)
123 from_date = from_date.to_date if from_date.respond_to?(:to_date)
124 to_date = to_date.to_date if to_date.respond_to?(:to_date)
125 distance_in_days = (to_date - from_date).abs
126 lwr(:actionview_datehelper_time_in_words_day, distance_in_days)
129 def due_date_distance_in_words(date)
131 l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date))
135 def render_page_hierarchy(pages, node=nil)
138 content << "<ul class=\"pages-hierarchy\">\n"
139 pages[node].each do |page|
141 content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'index', :id => page.project, :page => page.title},
142 :title => (page.respond_to?(:updated_on) ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil))
143 content << "\n" + render_page_hierarchy(pages, page.id) if pages[page.id]
151 # Renders flash messages
152 def render_flash_messages
155 s << content_tag('div', v, :class => "flash #{k}")
160 # Truncates and returns the string as a single line
161 def truncate_single_line(string, *args)
162 truncate(string, *args).gsub(%r{[\r\n]+}m, ' ')
166 text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>')
169 def authoring(created, author, options={})
170 time_tag = @project.nil? ? content_tag('acronym', distance_of_time_in_words(Time.now, created), :title => format_time(created)) :
171 link_to(distance_of_time_in_words(Time.now, created),
172 {:controller => 'projects', :action => 'activity', :id => @project, :from => created.to_date},
173 :title => format_time(created))
174 author_tag = (author.is_a?(User) && !author.anonymous?) ? link_to(h(author), :controller => 'account', :action => 'show', :id => author) : h(author || 'Anonymous')
175 l(options[:label] || :label_added_time_by, author_tag, time_tag)
178 def l_or_humanize(s, options={})
179 k = "#{options[:prefix]}#{s}".to_sym
180 l_has_string?(k) ? l(k) : s.to_s.humanize
184 l(:general_day_names).split(',')[day-1]
187 def month_name(month)
188 l(:actionview_datehelper_select_month_names).split(',')[month-1]
191 def syntax_highlight(name, content)
192 type = CodeRay::FileType[name]
193 type ? CodeRay.scan(content, type).html : h(content)
196 def to_path_param(path)
197 path.to_s.split(%r{[/\\]}).select {|p| !p.blank?}
200 def pagination_links_full(paginator, count=nil, options={})
201 page_param = options.delete(:page_param) || :page
202 url_param = params.dup
203 # don't reuse params if filters are present
204 url_param.clear if url_param.has_key?(:set_filter)
207 html << link_to_remote(('« ' + l(:label_previous)),
208 {:update => 'content',
209 :url => url_param.merge(page_param => paginator.current.previous),
210 :complete => 'window.scrollTo(0,0)'},
211 {:href => url_for(:params => url_param.merge(page_param => paginator.current.previous))}) + ' ' if paginator.current.previous
213 html << (pagination_links_each(paginator, options) do |n|
214 link_to_remote(n.to_s,
215 {:url => {:params => url_param.merge(page_param => n)},
216 :update => 'content',
217 :complete => 'window.scrollTo(0,0)'},
218 {:href => url_for(:params => url_param.merge(page_param => n))})
221 html << ' ' + link_to_remote((l(:label_next) + ' »'),
222 {:update => 'content',
223 :url => url_param.merge(page_param => paginator.current.next),
224 :complete => 'window.scrollTo(0,0)'},
225 {:href => url_for(:params => url_param.merge(page_param => paginator.current.next))}) if paginator.current.next
228 html << [" (#{paginator.current.first_item}-#{paginator.current.last_item}/#{count})", per_page_links(paginator.items_per_page)].compact.join(' | ')
234 def per_page_links(selected=nil)
235 url_param = params.dup
236 url_param.clear if url_param.has_key?(:set_filter)
238 links = Setting.per_page_options_array.collect do |n|
239 n == selected ? n : link_to_remote(n, {:update => "content", :url => params.dup.merge(:per_page => n)},
240 {:href => url_for(url_param.merge(:per_page => n))})
242 links.size > 1 ? l(:label_display_per_page, links.join(', ')) : nil
245 def breadcrumb(*args)
246 elements = args.flatten
247 elements.any? ? content_tag('p', args.join(' » ') + ' » ', :class => 'breadcrumb') : nil
250 def html_title(*args)
253 title << @project.name if @project
254 title += @html_title if @html_title
255 title << Setting.app_title
256 title.compact.join(' - ')
264 Redmine::AccessKeys.key_for s
267 # Formats text according to system settings.
268 # 2 ways to call this method:
269 # * with a String: textilizable(text, options)
270 # * with an object and one of its attribute: textilizable(issue, :description, options)
271 def textilizable(*args)
272 options = args.last.is_a?(Hash) ? args.pop : {}
275 obj = options[:object]
279 text = obj.send(args.shift).to_s
281 raise ArgumentError, 'invalid arguments to textilizable'
283 return '' if text.blank?
285 only_path = options.delete(:only_path) == false ? false : true
287 # when using an image link, try to use an attachment, if possible
288 attachments = options[:attachments] || (obj && obj.respond_to?(:attachments) ? obj.attachments : nil)
291 attachments = attachments.sort_by(&:created_on).reverse
292 text = text.gsub(/!((\<|\=|\>)?(\([^\)]+\))?(\[[^\]]+\])?(\{[^\}]+\})?)(\S+\.(bmp|gif|jpg|jpeg|png))!/i) do |m|
295 rf = Regexp.new(Regexp.escape(filename), Regexp::IGNORECASE)
296 # search for the picture in attachments
297 if found = attachments.detect { |att| att.filename =~ rf }
298 image_url = url_for :only_path => only_path, :controller => 'attachments', :action => 'download', :id => found
299 desc = found.description.to_s.gsub(/^([^\(\)]*).*$/, "\\1")
300 alt = desc.blank? ? nil : "(#{desc})"
301 "!#{style}#{image_url}#{alt}!"
303 "!#{style}#{filename}!"
308 text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text) { |macro, args| exec_macro(macro, obj, args) }
310 # different methods for formatting wiki links
311 case options[:wiki_links]
313 # used for local links to html files
314 format_wiki_link = Proc.new {|project, title, anchor| "#{title}.html" }
316 # used for single-file wiki export
317 format_wiki_link = Proc.new {|project, title, anchor| "##{title}" }
319 format_wiki_link = Proc.new {|project, title, anchor| url_for(:only_path => only_path, :controller => 'wiki', :action => 'index', :id => project, :page => title, :anchor => anchor) }
322 project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
329 # wiki links can refer other project wikis, using project name or identifier:
330 # [[project:]] -> wiki starting page
331 # [[project:|mytext]]
333 # [[project:mypage|mytext]]
334 text = text.gsub(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m|
335 link_project = project
336 esc, all, page, title = $1, $2, $3, $5
338 if page =~ /^([^\:]+)\:(.*)$/
339 link_project = Project.find_by_name($1) || Project.find_by_identifier($1)
341 title ||= $1 if page.blank?
344 if link_project && link_project.wiki
347 if page =~ /^(.+?)\#(.+)$/
348 page, anchor = $1, $2
350 # check if page exists
351 wiki_page = link_project.wiki.find_page(page)
352 link_to((title || page), format_wiki_link.call(link_project, Wiki.titleize(page), anchor),
353 :class => ('wiki-page' + (wiki_page ? '' : ' new')))
355 # project or wiki doesn't exist
367 # #52 -> Link to issue #52
369 # r52 -> Link to revision 52
370 # commit:a85130f -> Link to scmid starting with a85130f
372 # document#17 -> Link to document with id 17
373 # document:Greetings -> Link to the document with title "Greetings"
374 # document:"Some document" -> Link to the document with title "Some document"
376 # version#3 -> Link to version with id 3
377 # version:1.0.0 -> Link to version named "1.0.0"
378 # version:"1.0 beta 2" -> Link to version named "1.0 beta 2"
380 # attachment:file.zip -> Link to the attachment of the current object named file.zip
382 # source:some/file -> Link to the file located at /some/file in the project's repository
383 # source:some/file@52 -> Link to the file's revision 52
384 # source:some/file#L120 -> Link to line 120 of the file
385 # source:some/file@52#L120 -> Link to line 120 of the file's revision 52
386 # export:some/file -> Force the download of the file
388 # message#1218 -> Link to message with id 1218
389 text = text.gsub(%r{([\s\(,\-\>]|^)(!)?(attachment|document|version|commit|source|export|message)?((#|r)(\d+)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]]\W)|\s|<|$)}) do |m|
390 leading, esc, prefix, sep, oid = $1, $2, $3, $5 || $7, $6 || $8
393 if prefix.nil? && sep == 'r'
394 if project && (changeset = project.changesets.find_by_revision(oid))
395 link = link_to("r#{oid}", {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => oid},
396 :class => 'changeset',
397 :title => truncate_single_line(changeset.comments, 100))
403 if issue = Issue.find_by_id(oid, :include => [:project, :status], :conditions => Project.visible_by(User.current))
404 link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid},
405 :class => (issue.closed? ? 'issue closed' : 'issue'),
406 :title => "#{truncate(issue.subject, 100)} (#{issue.status.name})")
407 link = content_tag('del', link) if issue.closed?
410 if document = Document.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current))
411 link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
415 if version = Version.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current))
416 link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
420 if message = Message.find_by_id(oid, :include => [:parent, {:board => :project}], :conditions => Project.visible_by(User.current))
421 link = link_to h(truncate(message.subject, 60)), {:only_path => only_path,
422 :controller => 'messages',
424 :board_id => message.board,
426 :anchor => (message.parent ? "message-#{message.id}" : nil)},
431 # removes the double quotes if any
432 name = oid.gsub(%r{^"(.*)"$}, "\\1")
435 if project && document = project.documents.find_by_title(name)
436 link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
440 if project && version = project.versions.find_by_name(name)
441 link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
445 if project && (changeset = project.changesets.find(:first, :conditions => ["scmid LIKE ?", "#{name}%"]))
446 link = link_to h("#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.revision},
447 :class => 'changeset',
448 :title => truncate_single_line(changeset.comments, 100)
450 when 'source', 'export'
451 if project && project.repository
452 name =~ %r{^[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?$}
453 path, rev, anchor = $1, $3, $5
454 link = link_to h("#{prefix}:#{name}"), {:controller => 'repositories', :action => 'entry', :id => project,
455 :path => to_path_param(path),
458 :format => (prefix == 'export' ? 'raw' : nil)},
459 :class => (prefix == 'export' ? 'source download' : 'source')
462 if attachments && attachment = attachments.detect {|a| a.filename == name }
463 link = link_to h(attachment.filename), {:only_path => only_path, :controller => 'attachments', :action => 'download', :id => attachment},
464 :class => 'attachment'
469 leading + (link || "#{prefix}#{sep}#{oid}")
475 # Same as Rails' simple_format helper without using paragraphs
476 def simple_format_without_paragraph(text)
478 gsub(/\r\n?/, "\n"). # \r\n and \r -> \n
479 gsub(/\n\n+/, "<br /><br />"). # 2+ newline -> 2 br
480 gsub(/([^\n]\n)(?=[^\n])/, '\1<br />') # 1 newline -> br
483 def error_messages_for(object_name, options = {})
484 options = options.symbolize_keys
485 object = instance_variable_get("@#{object_name}")
486 if object && !object.errors.empty?
487 # build full_messages here with controller current language
489 object.errors.each do |attr, msg|
491 msg = msg.first if msg.is_a? Array
493 full_messages << l(msg)
495 full_messages << "« " + (l_has_string?("field_" + attr) ? l("field_" + attr) : object.class.human_attribute_name(attr)) + " » " + l(msg) unless attr == "custom_values"
498 # retrieve custom values error messages
499 if object.errors[:custom_values]
500 object.custom_values.each do |v|
501 v.errors.each do |attr, msg|
503 msg = msg.first if msg.is_a? Array
504 full_messages << "« " + v.custom_field.name + " » " + l(msg)
510 options[:header_tag] || "span", lwr(:gui_validation_error, full_messages.length) + ":"
512 content_tag("ul", full_messages.collect { |msg| content_tag("li", msg) }),
513 "id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation"
520 def lang_options_for_select(blank=true)
521 (blank ? [["(auto)", ""]] : []) +
522 GLoc.valid_languages.collect{|lang| [ ll(lang.to_s, :general_lang_name), lang.to_s]}.sort{|x,y| x.last <=> y.last }
525 def label_tag_for(name, option_tags = nil, options = {})
526 label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (options.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "")
527 content_tag("label", label_text)
530 def labelled_tabular_form_for(name, object, options, &proc)
531 options[:html] ||= {}
532 options[:html][:class] = 'tabular' unless options[:html].has_key?(:class)
533 form_for(name, object, options.merge({ :builder => TabularFormBuilder, :lang => current_language}), &proc)
536 def back_url_hidden_field_tag
537 back_url = params[:back_url] || request.env['HTTP_REFERER']
538 back_url = CGI.unescape(back_url.to_s)
539 hidden_field_tag('back_url', CGI.escape(back_url)) unless back_url.blank?
542 def check_all_links(form_name)
543 link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
545 link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)")
548 def progress_bar(pcts, options={})
549 pcts = [pcts, pcts] unless pcts.is_a?(Array)
550 pcts[1] = pcts[1] - pcts[0]
551 pcts << (100 - pcts[1] - pcts[0])
552 width = options[:width] || '100px;'
553 legend = options[:legend] || ''
556 (pcts[0] > 0 ? content_tag('td', '', :style => "width: #{pcts[0].floor}%;", :class => 'closed') : '') +
557 (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1].floor}%;", :class => 'done') : '') +
558 (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2].floor}%;", :class => 'todo') : '')
559 ), :class => 'progress', :style => "width: #{width};") +
560 content_tag('p', legend, :class => 'pourcent')
563 def context_menu_link(name, url, options={})
564 options[:class] ||= ''
565 if options.delete(:selected)
566 options[:class] << ' icon-checked disabled'
567 options[:disabled] = true
569 if options.delete(:disabled)
570 options.delete(:method)
571 options.delete(:confirm)
572 options.delete(:onclick)
573 options[:class] << ' disabled'
576 link_to name, url, options
579 def calendar_for(field_id)
580 include_calendar_headers_tags
581 image_tag("calendar.png", {:id => "#{field_id}_trigger",:class => "calendar-trigger"}) +
582 javascript_tag("Calendar.setup({inputField : '#{field_id}', ifFormat : '%Y-%m-%d', button : '#{field_id}_trigger' });")
585 def include_calendar_headers_tags
586 unless @calendar_headers_tags_included
587 @calendar_headers_tags_included = true
588 content_for :header_tags do
589 javascript_include_tag('calendar/calendar') +
590 javascript_include_tag("calendar/lang/calendar-#{current_language}.js") +
591 javascript_include_tag('calendar/calendar-setup') +
592 stylesheet_link_tag('calendar')
597 def content_for(name, content = nil, &block)
599 @has_content[name] = true
600 super(name, content, &block)
603 def has_content?(name)
604 (@has_content && @has_content[name]) || false
607 # Returns the avatar image tag for the given +user+ if avatars are enabled
608 # +user+ can be a User or a string that will be scanned for an email address (eg. 'joe <joe@foo.bar>')
609 def avatar(user, options = { })
610 if Setting.gravatar_enabled?
612 if user.respond_to?(:mail)
614 elsif user.to_s =~ %r{<(.+?)>}
617 return gravatar(email.to_s.downcase, options) unless email.blank? rescue nil
624 helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)