123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517 |
- # redMine - project management software
- # Copyright (C) 2006-2007 Jean-Philippe Lang
- #
- # This program is free software; you can redistribute it and/or
- # modify it under the terms of the GNU General Public License
- # as published by the Free Software Foundation; either version 2
- # of the License, or (at your option) any later version.
- #
- # This program is distributed in the hope that it will be useful,
- # but WITHOUT ANY WARRANTY; without even the implied warranty of
- # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- # GNU General Public License for more details.
- #
- # You should have received a copy of the GNU General Public License
- # along with this program; if not, write to the Free Software
- # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-
- module ApplicationHelper
- include Redmine::WikiFormatting::Macros::Definitions
-
- def current_role
- @current_role ||= User.current.role_for_project(@project)
- end
-
- # Return true if user is authorized for controller/action, otherwise false
- def authorize_for(controller, action)
- User.current.allowed_to?({:controller => controller, :action => action}, @project)
- end
-
- # Display a link if user is authorized
- def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
- link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])
- end
-
- # Display a link to user's account page
- def link_to_user(user)
- user ? link_to(user, :controller => 'account', :action => 'show', :id => user) : 'Anonymous'
- end
-
- def link_to_issue(issue, options={})
- link_to "#{issue.tracker.name} ##{issue.id}", {:controller => "issues", :action => "show", :id => issue}, options
- end
-
- def toggle_link(name, id, options={})
- onclick = "Element.toggle('#{id}'); "
- onclick << (options[:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ")
- onclick << "return false;"
- link_to(name, "#", :onclick => onclick)
- end
-
- def show_and_goto_link(name, id, options={})
- onclick = "Element.show('#{id}'); "
- onclick << (options[:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ")
- onclick << "Element.scrollTo('#{id}'); "
- onclick << "return false;"
- link_to(name, "#", options.merge(:onclick => onclick))
- end
-
- def image_to_function(name, function, html_options = {})
- html_options.symbolize_keys!
- tag(:input, html_options.merge({
- :type => "image", :src => image_path(name),
- :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};"
- }))
- end
-
- def prompt_to_remote(name, text, param, url, html_options = {})
- html_options[:onclick] = "promptToRemote('#{text}', '#{param}', '#{url_for(url)}'); return false;"
- link_to name, {}, html_options
- end
-
- def format_date(date)
- return nil unless date
- # "Setting.date_format.size < 2" is a temporary fix (content of date_format setting changed)
- @date_format ||= (Setting.date_format.blank? || Setting.date_format.size < 2 ? l(:general_fmt_date) : Setting.date_format)
- date.strftime(@date_format)
- end
-
- def format_time(time, include_date = true)
- return nil unless time
- time = time.to_time if time.is_a?(String)
- zone = User.current.time_zone
- if time.utc?
- local = zone ? zone.adjust(time) : time.getlocal
- else
- local = zone ? zone.adjust(time.getutc) : time
- end
- @date_format ||= (Setting.date_format.blank? || Setting.date_format.size < 2 ? l(:general_fmt_date) : Setting.date_format)
- @time_format ||= (Setting.time_format.blank? ? l(:general_fmt_time) : Setting.time_format)
- include_date ? local.strftime("#{@date_format} #{@time_format}") : local.strftime(@time_format)
- end
-
- # Truncates and returns the string as a single line
- def truncate_single_line(string, *args)
- truncate(string, *args).gsub(%r{[\r\n]+}m, ' ')
- end
-
- def html_hours(text)
- text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>')
- end
-
- def authoring(created, author)
- time_tag = content_tag('acronym', distance_of_time_in_words(Time.now, created), :title => format_time(created))
- l(:label_added_time_by, author || 'Anonymous', time_tag)
- end
-
- def l_or_humanize(s)
- l_has_string?("label_#{s}".to_sym) ? l("label_#{s}".to_sym) : s.to_s.humanize
- end
-
- def day_name(day)
- l(:general_day_names).split(',')[day-1]
- end
-
- def month_name(month)
- l(:actionview_datehelper_select_month_names).split(',')[month-1]
- end
-
- def pagination_links_full(paginator, count=nil, options={})
- page_param = options.delete(:page_param) || :page
- url_param = params.dup
- # don't reuse params if filters are present
- url_param.clear if url_param.has_key?(:set_filter)
-
- html = ''
- html << link_to_remote(('« ' + l(:label_previous)),
- {:update => 'content',
- :url => url_param.merge(page_param => paginator.current.previous),
- :complete => 'window.scrollTo(0,0)'},
- {:href => url_for(:params => url_param.merge(page_param => paginator.current.previous))}) + ' ' if paginator.current.previous
-
- html << (pagination_links_each(paginator, options) do |n|
- link_to_remote(n.to_s,
- {:url => {:params => url_param.merge(page_param => n)},
- :update => 'content',
- :complete => 'window.scrollTo(0,0)'},
- {:href => url_for(:params => url_param.merge(page_param => n))})
- end || '')
-
- html << ' ' + link_to_remote((l(:label_next) + ' »'),
- {:update => 'content',
- :url => url_param.merge(page_param => paginator.current.next),
- :complete => 'window.scrollTo(0,0)'},
- {:href => url_for(:params => url_param.merge(page_param => paginator.current.next))}) if paginator.current.next
-
- unless count.nil?
- html << [" (#{paginator.current.first_item}-#{paginator.current.last_item}/#{count})", per_page_links(paginator.items_per_page)].compact.join(' | ')
- end
-
- html
- end
-
- def per_page_links(selected=nil)
- url_param = params.dup
- url_param.clear if url_param.has_key?(:set_filter)
-
- links = Setting.per_page_options_array.collect do |n|
- n == selected ? n : link_to_remote(n, {:update => "content", :url => params.dup.merge(:per_page => n)},
- {:href => url_for(url_param.merge(:per_page => n))})
- end
- links.size > 1 ? l(:label_display_per_page, links.join(', ')) : nil
- end
-
- def breadcrumb(*args)
- content_tag('p', args.join(' » ') + ' » ', :class => 'breadcrumb')
- end
-
- def html_title(*args)
- if args.empty?
- title = []
- title << @project.name if @project
- title += @html_title if @html_title
- title << Setting.app_title
- title.compact.join(' - ')
- else
- @html_title ||= []
- @html_title += args
- end
- end
-
- def accesskey(s)
- Redmine::AccessKeys.key_for s
- end
-
- # Formats text according to system settings.
- # 2 ways to call this method:
- # * with a String: textilizable(text, options)
- # * with an object and one of its attribute: textilizable(issue, :description, options)
- def textilizable(*args)
- options = args.last.is_a?(Hash) ? args.pop : {}
- case args.size
- when 1
- obj = nil
- text = args.shift
- when 2
- obj = args.shift
- text = obj.send(args.shift).to_s
- else
- raise ArgumentError, 'invalid arguments to textilizable'
- end
- return '' if text.blank?
-
- only_path = options.delete(:only_path) == false ? false : true
-
- # when using an image link, try to use an attachment, if possible
- attachments = options[:attachments] || (obj && obj.respond_to?(:attachments) ? obj.attachments : nil)
-
- if attachments
- text = text.gsub(/!((\<|\=|\>)?(\([^\)]+\))?(\[[^\]]+\])?(\{[^\}]+\})?)(\S+\.(gif|jpg|jpeg|png))!/) do |m|
- style = $1
- filename = $6
- rf = Regexp.new(filename, Regexp::IGNORECASE)
- # search for the picture in attachments
- if found = attachments.detect { |att| att.filename =~ rf }
- image_url = url_for :only_path => only_path, :controller => 'attachments', :action => 'download', :id => found
- desc = found.description.to_s.gsub(/^([^\(\)]*).*$/, "\\1")
- alt = desc.blank? ? nil : "(#{desc})"
- "!#{style}#{image_url}#{alt}!"
- else
- "!#{style}#{filename}!"
- end
- end
- end
-
- text = (Setting.text_formatting == 'textile') ?
- Redmine::WikiFormatting.to_html(text) { |macro, args| exec_macro(macro, obj, args) } :
- simple_format(auto_link(h(text)))
-
- # different methods for formatting wiki links
- case options[:wiki_links]
- when :local
- # used for local links to html files
- format_wiki_link = Proc.new {|project, title| "#{title}.html" }
- when :anchor
- # used for single-file wiki export
- format_wiki_link = Proc.new {|project, title| "##{title}" }
- else
- format_wiki_link = Proc.new {|project, title| url_for(:only_path => only_path, :controller => 'wiki', :action => 'index', :id => project, :page => title) }
- end
-
- project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
-
- # Wiki links
- #
- # Examples:
- # [[mypage]]
- # [[mypage|mytext]]
- # wiki links can refer other project wikis, using project name or identifier:
- # [[project:]] -> wiki starting page
- # [[project:|mytext]]
- # [[project:mypage]]
- # [[project:mypage|mytext]]
- text = text.gsub(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m|
- link_project = project
- esc, all, page, title = $1, $2, $3, $5
- if esc.nil?
- if page =~ /^([^\:]+)\:(.*)$/
- link_project = Project.find_by_name($1) || Project.find_by_identifier($1)
- page = $2
- title ||= $1 if page.blank?
- end
-
- if link_project && link_project.wiki
- # check if page exists
- wiki_page = link_project.wiki.find_page(page)
- link_to((title || page), format_wiki_link.call(link_project, Wiki.titleize(page)),
- :class => ('wiki-page' + (wiki_page ? '' : ' new')))
- else
- # project or wiki doesn't exist
- title || page
- end
- else
- all
- end
- end
-
- # Redmine links
- #
- # Examples:
- # Issues:
- # #52 -> Link to issue #52
- # Changesets:
- # r52 -> Link to revision 52
- # commit:a85130f -> Link to scmid starting with a85130f
- # Documents:
- # document#17 -> Link to document with id 17
- # document:Greetings -> Link to the document with title "Greetings"
- # document:"Some document" -> Link to the document with title "Some document"
- # Versions:
- # version#3 -> Link to version with id 3
- # version:1.0.0 -> Link to version named "1.0.0"
- # version:"1.0 beta 2" -> Link to version named "1.0 beta 2"
- # Attachments:
- # attachment:file.zip -> Link to the attachment of the current object named file.zip
- # Source files:
- # source:some/file -> Link to the file located at /some/file in the project's repository
- # source:some/file@52 -> Link to the file's revision 52
- # source:some/file#L120 -> Link to line 120 of the file
- # source:some/file@52#L120 -> Link to line 120 of the file's revision 52
- # export:some/file -> Force the download of the file
- text = text.gsub(%r{([\s\(,\-\>]|^)(!)?(attachment|document|version|commit|source|export)?((#|r)(\d+)|(:)([^"\s<>][^\s<>]*|"[^"]+"))(?=[[:punct:]]|\s|<|$)}) do |m|
- leading, esc, prefix, sep, oid = $1, $2, $3, $5 || $7, $6 || $8
- link = nil
- if esc.nil?
- if prefix.nil? && sep == 'r'
- if project && (changeset = project.changesets.find_by_revision(oid))
- link = link_to("r#{oid}", {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => oid},
- :class => 'changeset',
- :title => truncate_single_line(changeset.comments, 100))
- end
- elsif sep == '#'
- oid = oid.to_i
- case prefix
- when nil
- if issue = Issue.find_by_id(oid, :include => [:project, :status], :conditions => Project.visible_by(User.current))
- link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid},
- :class => (issue.closed? ? 'issue closed' : 'issue'),
- :title => "#{truncate(issue.subject, 100)} (#{issue.status.name})")
- link = content_tag('del', link) if issue.closed?
- end
- when 'document'
- if document = Document.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current))
- link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
- :class => 'document'
- end
- when 'version'
- if version = Version.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current))
- link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
- :class => 'version'
- end
- end
- elsif sep == ':'
- # removes the double quotes if any
- name = oid.gsub(%r{^"(.*)"$}, "\\1")
- case prefix
- when 'document'
- if project && document = project.documents.find_by_title(name)
- link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
- :class => 'document'
- end
- when 'version'
- if project && version = project.versions.find_by_name(name)
- link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
- :class => 'version'
- end
- when 'commit'
- if project && (changeset = project.changesets.find(:first, :conditions => ["scmid LIKE ?", "#{name}%"]))
- link = link_to h("#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.revision},
- :class => 'changeset',
- :title => truncate_single_line(changeset.comments, 100)
- end
- when 'source', 'export'
- if project && project.repository
- name =~ %r{^[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?$}
- path, rev, anchor = $1, $3, $5
- link = link_to h("#{prefix}:#{name}"), {:controller => 'repositories', :action => 'entry', :id => project, :path => path,
- :rev => rev,
- :anchor => anchor,
- :format => (prefix == 'export' ? 'raw' : nil)},
- :class => (prefix == 'export' ? 'source download' : 'source')
- end
- when 'attachment'
- if attachments && attachment = attachments.detect {|a| a.filename == name }
- link = link_to h(attachment.filename), {:only_path => only_path, :controller => 'attachments', :action => 'download', :id => attachment},
- :class => 'attachment'
- end
- end
- end
- end
- leading + (link || "#{prefix}#{sep}#{oid}")
- end
-
- text
- end
-
- # Same as Rails' simple_format helper without using paragraphs
- def simple_format_without_paragraph(text)
- text.to_s.
- gsub(/\r\n?/, "\n"). # \r\n and \r -> \n
- gsub(/\n\n+/, "<br /><br />"). # 2+ newline -> 2 br
- gsub(/([^\n]\n)(?=[^\n])/, '\1<br />') # 1 newline -> br
- end
-
- def error_messages_for(object_name, options = {})
- options = options.symbolize_keys
- object = instance_variable_get("@#{object_name}")
- if object && !object.errors.empty?
- # build full_messages here with controller current language
- full_messages = []
- object.errors.each do |attr, msg|
- next if msg.nil?
- msg = msg.first if msg.is_a? Array
- if attr == "base"
- full_messages << l(msg)
- else
- full_messages << "« " + (l_has_string?("field_" + attr) ? l("field_" + attr) : object.class.human_attribute_name(attr)) + " » " + l(msg) unless attr == "custom_values"
- end
- end
- # retrieve custom values error messages
- if object.errors[:custom_values]
- object.custom_values.each do |v|
- v.errors.each do |attr, msg|
- next if msg.nil?
- msg = msg.first if msg.is_a? Array
- full_messages << "« " + v.custom_field.name + " » " + l(msg)
- end
- end
- end
- content_tag("div",
- content_tag(
- options[:header_tag] || "span", lwr(:gui_validation_error, full_messages.length) + ":"
- ) +
- content_tag("ul", full_messages.collect { |msg| content_tag("li", msg) }),
- "id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation"
- )
- else
- ""
- end
- end
-
- def lang_options_for_select(blank=true)
- (blank ? [["(auto)", ""]] : []) +
- GLoc.valid_languages.collect{|lang| [ ll(lang.to_s, :general_lang_name), lang.to_s]}.sort{|x,y| x.last <=> y.last }
- end
-
- def label_tag_for(name, option_tags = nil, options = {})
- label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (options.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "")
- content_tag("label", label_text)
- end
-
- def labelled_tabular_form_for(name, object, options, &proc)
- options[:html] ||= {}
- options[:html][:class] = 'tabular' unless options[:html].has_key?(:class)
- form_for(name, object, options.merge({ :builder => TabularFormBuilder, :lang => current_language}), &proc)
- end
-
- def back_url_hidden_field_tag
- hidden_field_tag 'back_url', (params[:back_url] || request.env['HTTP_REFERER'])
- end
-
- def check_all_links(form_name)
- link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
- " | " +
- link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)")
- end
-
- def progress_bar(pcts, options={})
- pcts = [pcts, pcts] unless pcts.is_a?(Array)
- pcts[1] = pcts[1] - pcts[0]
- pcts << (100 - pcts[1] - pcts[0])
- width = options[:width] || '100px;'
- legend = options[:legend] || ''
- content_tag('table',
- content_tag('tr',
- (pcts[0] > 0 ? content_tag('td', '', :width => "#{pcts[0].floor}%;", :class => 'closed') : '') +
- (pcts[1] > 0 ? content_tag('td', '', :width => "#{pcts[1].floor}%;", :class => 'done') : '') +
- (pcts[2] > 0 ? content_tag('td', '', :width => "#{pcts[2].floor}%;", :class => 'todo') : '')
- ), :class => 'progress', :style => "width: #{width};") +
- content_tag('p', legend, :class => 'pourcent')
- end
-
- def context_menu_link(name, url, options={})
- options[:class] ||= ''
- if options.delete(:selected)
- options[:class] << ' icon-checked disabled'
- options[:disabled] = true
- end
- if options.delete(:disabled)
- options.delete(:method)
- options.delete(:confirm)
- options.delete(:onclick)
- options[:class] << ' disabled'
- url = '#'
- end
- link_to name, url, options
- end
-
- def calendar_for(field_id)
- include_calendar_headers_tags
- image_tag("calendar.png", {:id => "#{field_id}_trigger",:class => "calendar-trigger"}) +
- javascript_tag("Calendar.setup({inputField : '#{field_id}', ifFormat : '%Y-%m-%d', button : '#{field_id}_trigger' });")
- end
-
- def include_calendar_headers_tags
- unless @calendar_headers_tags_included
- @calendar_headers_tags_included = true
- content_for :header_tags do
- javascript_include_tag('calendar/calendar') +
- javascript_include_tag("calendar/lang/calendar-#{current_language}.js") +
- javascript_include_tag('calendar/calendar-setup') +
- stylesheet_link_tag('calendar')
- end
- end
- end
-
- def wikitoolbar_for(field_id)
- return '' unless Setting.text_formatting == 'textile'
-
- help_link = l(:setting_text_formatting) + ': ' +
- link_to(l(:label_help), compute_public_path('wiki_syntax', 'help', 'html'),
- :onclick => "window.open(\"#{ compute_public_path('wiki_syntax', 'help', 'html') }\", \"\", \"resizable=yes, location=no, width=300, height=640, menubar=no, status=no, scrollbars=yes\"); return false;")
-
- javascript_include_tag('jstoolbar/jstoolbar') +
- javascript_include_tag("jstoolbar/lang/jstoolbar-#{current_language}") +
- javascript_tag("var toolbar = new jsToolBar($('#{field_id}')); toolbar.setHelpLink('#{help_link}'); toolbar.draw();")
- end
-
- def content_for(name, content = nil, &block)
- @has_content ||= {}
- @has_content[name] = true
- super(name, content, &block)
- end
-
- def has_content?(name)
- (@has_content && @has_content[name]) || false
- end
- end
|