12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130 |
- # encoding: utf-8
- #
- # Redmine - project management software
- # Copyright (C) 2006-2011 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.
-
- require 'forwardable'
- require 'cgi'
-
- module ApplicationHelper
- include Redmine::WikiFormatting::Macros::Definitions
- include Redmine::I18n
- include GravatarHelper::PublicMethods
-
- extend Forwardable
- def_delegators :wiki_helper, :wikitoolbar_for, :heads_for_wiki_formatter
-
- # 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
- #
- # @param [String] name Anchor text (passed to link_to)
- # @param [Hash] options Hash params. This will checked by authorize_for to see if the user is authorized
- # @param [optional, Hash] html_options Options passed to link_to
- # @param [optional, Hash] parameters_for_method_reference Extra parameters for link_to
- 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 remote if user is authorized
- def link_to_remote_if_authorized(name, options = {}, html_options = nil)
- url = options[:url] || {}
- link_to_remote(name, options, html_options) if authorize_for(url[:controller] || params[:controller], url[:action])
- end
-
- # Displays a link to user's account page if active
- def link_to_user(user, options={})
- if user.is_a?(User)
- name = h(user.name(options[:format]))
- if user.active?
- link_to name, :controller => 'users', :action => 'show', :id => user
- else
- name
- end
- else
- h(user.to_s)
- end
- end
-
- # Displays a link to +issue+ with its subject.
- # Examples:
- #
- # link_to_issue(issue) # => Defect #6: This is the subject
- # link_to_issue(issue, :truncate => 6) # => Defect #6: This i...
- # link_to_issue(issue, :subject => false) # => Defect #6
- # link_to_issue(issue, :project => true) # => Foo - Defect #6
- #
- def link_to_issue(issue, options={})
- title = nil
- subject = nil
- if options[:subject] == false
- title = truncate(issue.subject, :length => 60)
- else
- subject = issue.subject
- if options[:truncate]
- subject = truncate(subject, :length => options[:truncate])
- end
- end
- s = link_to "#{h(issue.tracker)} ##{issue.id}", {:controller => "issues", :action => "show", :id => issue},
- :class => issue.css_classes,
- :title => title
- s << h(": #{subject}") if subject
- s = h("#{issue.project} - ") + s if options[:project]
- s
- end
-
- # Generates a link to an attachment.
- # Options:
- # * :text - Link text (default to attachment filename)
- # * :download - Force download (default: false)
- def link_to_attachment(attachment, options={})
- text = options.delete(:text) || attachment.filename
- action = options.delete(:download) ? 'download' : 'show'
- opt_only_path = {}
- opt_only_path[:only_path] = (options[:only_path] == false ? false : true)
- options.delete(:only_path)
- link_to(h(text),
- {:controller => 'attachments', :action => action,
- :id => attachment, :filename => attachment.filename}.merge(opt_only_path),
- options)
- end
-
- # Generates a link to a SCM revision
- # Options:
- # * :text - Link text (default to the formatted revision)
- def link_to_revision(revision, repository, options={})
- if repository.is_a?(Project)
- repository = repository.repository
- end
- text = options.delete(:text) || format_revision(revision)
- rev = revision.respond_to?(:identifier) ? revision.identifier : revision
- link_to(
- h(text),
- {:controller => 'repositories', :action => 'revision', :id => repository.project, :repository_id => repository.identifier_param, :rev => rev},
- :title => l(:label_revision_id, format_revision(revision))
- )
- end
-
- # Generates a link to a message
- def link_to_message(message, options={}, html_options = nil)
- link_to(
- h(truncate(message.subject, :length => 60)),
- { :controller => 'messages', :action => 'show',
- :board_id => message.board_id,
- :id => message.root,
- :r => (message.parent_id && message.id),
- :anchor => (message.parent_id ? "message-#{message.id}" : nil)
- }.merge(options),
- html_options
- )
- end
-
- # Generates a link to a project if active
- # Examples:
- #
- # link_to_project(project) # => link to the specified project overview
- # link_to_project(project, :action=>'settings') # => link to project settings
- # link_to_project(project, {:only_path => false}, :class => "project") # => 3rd arg adds html options
- # link_to_project(project, {}, :class => "project") # => html options with default url (project overview)
- #
- def link_to_project(project, options={}, html_options = nil)
- if project.active?
- url = {:controller => 'projects', :action => 'show', :id => project}.merge(options)
- link_to(h(project), url, html_options)
- else
- h(project)
- end
- 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 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_activity_title(text)
- h(truncate_single_line(text, :length => 100))
- end
-
- def format_activity_day(date)
- date == Date.today ? l(:label_today).titleize : format_date(date)
- end
-
- def format_activity_description(text)
- h(truncate(text.to_s, :length => 120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')
- ).gsub(/[\r\n]+/, "<br />").html_safe
- end
-
- def format_version_name(version)
- if version.project == @project
- h(version)
- else
- h("#{version.project} - #{version}")
- end
- end
-
- def due_date_distance_in_words(date)
- if date
- l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date))
- end
- end
-
- def render_page_hierarchy(pages, node=nil, options={})
- content = ''
- if pages[node]
- content << "<ul class=\"pages-hierarchy\">\n"
- pages[node].each do |page|
- content << "<li>"
- content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title},
- :title => (options[:timestamp] && page.updated_on ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil))
- content << "\n" + render_page_hierarchy(pages, page.id, options) if pages[page.id]
- content << "</li>\n"
- end
- content << "</ul>\n"
- end
- content.html_safe
- end
-
- # Renders flash messages
- def render_flash_messages
- s = ''
- flash.each do |k,v|
- s << (content_tag('div', v.html_safe, :class => "flash #{k}"))
- end
- s.html_safe
- end
-
- # Renders tabs and their content
- def render_tabs(tabs)
- if tabs.any?
- render :partial => 'common/tabs', :locals => {:tabs => tabs}
- else
- content_tag 'p', l(:label_no_data), :class => "nodata"
- end
- end
-
- # Renders the project quick-jump box
- def render_project_jump_box
- return unless User.current.logged?
- projects = User.current.memberships.collect(&:project).compact.uniq
- if projects.any?
- s = '<select onchange="if (this.value != \'\') { window.location = this.value; }">' +
- "<option value=''>#{ l(:label_jump_to_a_project) }</option>" +
- '<option value="" disabled="disabled">---</option>'
- s << project_tree_options_for_select(projects, :selected => @project) do |p|
- { :value => url_for(:controller => 'projects', :action => 'show', :id => p, :jump => current_menu_item) }
- end
- s << '</select>'
- s.html_safe
- end
- end
-
- def project_tree_options_for_select(projects, options = {})
- s = ''
- project_tree(projects) do |project, level|
- name_prefix = (level > 0 ? (' ' * 2 * level + '» ').html_safe : '')
- tag_options = {:value => project.id}
- if project == options[:selected] || (options[:selected].respond_to?(:include?) && options[:selected].include?(project))
- tag_options[:selected] = 'selected'
- else
- tag_options[:selected] = nil
- end
- tag_options.merge!(yield(project)) if block_given?
- s << content_tag('option', name_prefix + h(project), tag_options)
- end
- s.html_safe
- end
-
- # Yields the given block for each project with its level in the tree
- #
- # Wrapper for Project#project_tree
- def project_tree(projects, &block)
- Project.project_tree(projects, &block)
- end
-
- def project_nested_ul(projects, &block)
- s = ''
- if projects.any?
- ancestors = []
- projects.sort_by(&:lft).each do |project|
- if (ancestors.empty? || project.is_descendant_of?(ancestors.last))
- s << "<ul>\n"
- else
- ancestors.pop
- s << "</li>"
- while (ancestors.any? && !project.is_descendant_of?(ancestors.last))
- ancestors.pop
- s << "</ul></li>\n"
- end
- end
- s << "<li>"
- s << yield(project).to_s
- ancestors << project
- end
- s << ("</li></ul>\n" * ancestors.size)
- end
- s.html_safe
- end
-
- def principals_check_box_tags(name, principals)
- s = ''
- principals.sort.each do |principal|
- s << "<label>#{ check_box_tag name, principal.id, false } #{h principal}</label>\n"
- end
- s.html_safe
- end
-
- # Returns a string for users/groups option tags
- def principals_options_for_select(collection, selected=nil)
- s = ''
- if collection.include?(User.current)
- s << content_tag('option', "<< #{l(:label_me)} >>".html_safe, :value => User.current.id)
- end
- groups = ''
- collection.sort.each do |element|
- selected_attribute = ' selected="selected"' if option_value_selected?(element, selected)
- (element.is_a?(Group) ? groups : s) << %(<option value="#{element.id}"#{selected_attribute}>#{h element.name}</option>)
- end
- unless groups.empty?
- s << %(<optgroup label="#{h(l(:label_group_plural))}">#{groups}</optgroup>)
- end
- s
- end
-
- # Truncates and returns the string as a single line
- def truncate_single_line(string, *args)
- truncate(string.to_s, *args).gsub(%r{[\r\n]+}m, ' ')
- end
-
- # Truncates at line break after 250 characters or options[:length]
- def truncate_lines(string, options={})
- length = options[:length] || 250
- if string.to_s =~ /\A(.{#{length}}.*?)$/m
- "#{$1}..."
- else
- string
- end
- end
-
- def anchor(text)
- text.to_s.gsub(' ', '_')
- end
-
- def html_hours(text)
- text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>').html_safe
- end
-
- def authoring(created, author, options={})
- l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe
- end
-
- def time_tag(time)
- text = distance_of_time_in_words(Time.now, time)
- if @project
- link_to(text, {:controller => 'activities', :action => 'index', :id => @project, :from => time.to_date}, :title => format_time(time))
- else
- content_tag('acronym', text, :title => format_time(time))
- end
- end
-
- def syntax_highlight_lines(name, content)
- lines = []
- syntax_highlight(name, content).each_line { |line| lines << line }
- lines
- end
-
- def syntax_highlight(name, content)
- Redmine::SyntaxHighlighting.highlight_by_filename(content, name)
- end
-
- def to_path_param(path)
- path.to_s.split(%r{[/\\]}).select {|p| !p.blank?}
- end
-
- def pagination_links_full(paginator, count=nil, options={})
- page_param = options.delete(:page_param) || :page
- per_page_links = options.delete(:per_page_links)
- url_param = params.dup
-
- html = ''
- if paginator.current.previous
- # \xc2\xab(utf-8) = «
- html << link_to_content_update(
- "\xc2\xab " + l(:label_previous),
- url_param.merge(page_param => paginator.current.previous)) + ' '
- end
-
- html << (pagination_links_each(paginator, options) do |n|
- link_to_content_update(n.to_s, url_param.merge(page_param => n))
- end || '')
-
- if paginator.current.next
- # \xc2\xbb(utf-8) = »
- html << ' ' + link_to_content_update(
- (l(:label_next) + " \xc2\xbb"),
- url_param.merge(page_param => paginator.current.next))
- end
-
- unless count.nil?
- html << " (#{paginator.current.first_item}-#{paginator.current.last_item}/#{count})"
- if per_page_links != false && links = per_page_links(paginator.items_per_page)
- html << " | #{links}"
- end
- end
-
- html.html_safe
- end
-
- def per_page_links(selected=nil)
- links = Setting.per_page_options_array.collect do |n|
- n == selected ? n : link_to_content_update(n, params.merge(:per_page => n))
- end
- links.size > 1 ? l(:label_display_per_page, links.join(', ')) : nil
- end
-
- def reorder_links(name, url, method = :post)
- link_to(image_tag('2uparrow.png', :alt => l(:label_sort_highest)),
- url.merge({"#{name}[move_to]" => 'highest'}),
- :method => method, :title => l(:label_sort_highest)) +
- link_to(image_tag('1uparrow.png', :alt => l(:label_sort_higher)),
- url.merge({"#{name}[move_to]" => 'higher'}),
- :method => method, :title => l(:label_sort_higher)) +
- link_to(image_tag('1downarrow.png', :alt => l(:label_sort_lower)),
- url.merge({"#{name}[move_to]" => 'lower'}),
- :method => method, :title => l(:label_sort_lower)) +
- link_to(image_tag('2downarrow.png', :alt => l(:label_sort_lowest)),
- url.merge({"#{name}[move_to]" => 'lowest'}),
- :method => method, :title => l(:label_sort_lowest))
- end
-
- def breadcrumb(*args)
- elements = args.flatten
- elements.any? ? content_tag('p', (args.join(" \xc2\xbb ") + " \xc2\xbb ").html_safe, :class => 'breadcrumb') : nil
- end
-
- def other_formats_links(&block)
- concat('<p class="other-formats">'.html_safe + l(:label_export_to))
- yield Redmine::Views::OtherFormatsBuilder.new(self)
- concat('</p>'.html_safe)
- end
-
- def page_header_title
- if @project.nil? || @project.new_record?
- h(Setting.app_title)
- else
- b = []
- ancestors = (@project.root? ? [] : @project.ancestors.visible.all)
- if ancestors.any?
- root = ancestors.shift
- b << link_to_project(root, {:jump => current_menu_item}, :class => 'root')
- if ancestors.size > 2
- b << "\xe2\x80\xa6"
- ancestors = ancestors[-2, 2]
- end
- b += ancestors.collect {|p| link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor') }
- end
- b << h(@project)
- b.join(" \xc2\xbb ").html_safe
- end
- end
-
- def html_title(*args)
- if args.empty?
- title = @html_title || []
- title << @project.name if @project
- title << Setting.app_title unless Setting.app_title == title.last
- title.select {|t| !t.blank? }.join(' - ')
- else
- @html_title ||= []
- @html_title += args
- end
- end
-
- # Returns the theme, controller name, and action as css classes for the
- # HTML body.
- def body_css_classes
- css = []
- if theme = Redmine::Themes.theme(Setting.ui_theme)
- css << 'theme-' + theme.name
- end
-
- css << 'controller-' + controller_name
- css << 'action-' + action_name
- css.join(' ')
- 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 = options[:object]
- text = args.shift
- when 2
- obj = args.shift
- attr = args.shift
- text = obj.send(attr).to_s
- else
- raise ArgumentError, 'invalid arguments to textilizable'
- end
- return '' if text.blank?
- project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
- only_path = options.delete(:only_path) == false ? false : true
-
- text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text, :object => obj, :attribute => attr)
-
- @parsed_headings = []
- @heading_anchors = {}
- @current_section = 0 if options[:edit_section_links]
-
- parse_sections(text, project, obj, attr, only_path, options)
- text = parse_non_pre_blocks(text) do |text|
- [:parse_inline_attachments, :parse_wiki_links, :parse_redmine_links, :parse_macros].each do |method_name|
- send method_name, text, project, obj, attr, only_path, options
- end
- end
- parse_headings(text, project, obj, attr, only_path, options)
-
- if @parsed_headings.any?
- replace_toc(text, @parsed_headings)
- end
-
- text.html_safe
- end
-
- def parse_non_pre_blocks(text)
- s = StringScanner.new(text)
- tags = []
- parsed = ''
- while !s.eos?
- s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im)
- text, full_tag, closing, tag = s[1], s[2], s[3], s[4]
- if tags.empty?
- yield text
- end
- parsed << text
- if tag
- if closing
- if tags.last == tag.downcase
- tags.pop
- end
- else
- tags << tag.downcase
- end
- parsed << full_tag
- end
- end
- # Close any non closing tags
- while tag = tags.pop
- parsed << "</#{tag}>"
- end
- parsed
- end
-
- def parse_inline_attachments(text, project, obj, attr, only_path, options)
- # when using an image link, try to use an attachment, if possible
- if options[:attachments] || (obj && obj.respond_to?(:attachments))
- attachments = options[:attachments] || obj.attachments
- text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m|
- filename, ext, alt, alttext = $1.downcase, $2, $3, $4
- # search for the picture in attachments
- if found = Attachment.latest_attach(attachments, filename)
- image_url = url_for :only_path => only_path, :controller => 'attachments',
- :action => 'download', :id => found
- desc = found.description.to_s.gsub('"', '')
- if !desc.blank? && alttext.blank?
- alt = " title=\"#{desc}\" alt=\"#{desc}\""
- end
- "src=\"#{image_url}\"#{alt}"
- else
- m
- end
- end
- end
- end
-
- # 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]]
- def parse_wiki_links(text, project, obj, attr, only_path, options)
- 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_identifier($1) || Project.find_by_name($1)
- page = $2
- title ||= $1 if page.blank?
- end
-
- if link_project && link_project.wiki
- # extract anchor
- anchor = nil
- if page =~ /^(.+?)\#(.+)$/
- page, anchor = $1, $2
- end
- anchor = sanitize_anchor_name(anchor) if anchor.present?
- # check if page exists
- wiki_page = link_project.wiki.find_page(page)
- url = if anchor.present? && wiki_page.present? && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)) && obj.page == wiki_page
- "##{anchor}"
- else
- case options[:wiki_links]
- when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')
- when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export
- else
- wiki_page_id = page.present? ? Wiki.titleize(page) : nil
- parent = wiki_page.nil? && obj.is_a?(WikiContent) && obj.page && project == link_project ? obj.page.title : nil
- url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project,
- :id => wiki_page_id, :anchor => anchor, :parent => parent)
- end
- end
- link_to(title.present? ? title.html_safe : h(page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new')))
- else
- # project or wiki doesn't exist
- all
- end
- else
- all
- end
- 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
- # Forum messages:
- # message#1218 -> Link to message with id 1218
- #
- # Links can refer other objects from other projects, using project identifier:
- # identifier:r52
- # identifier:document:"Some document"
- # identifier:version:1.0.0
- # identifier:source:some/file
- def parse_redmine_links(text, project, obj, attr, only_path, options)
- text.gsub!(%r{([\s\(,\-\[\>]|^)(!)?(([a-z0-9\-_]+):)?(attachment|document|version|forum|news|message|project|commit|source|export)?(((#)|((([a-z0-9\-]+)\|)?(r)))((\d+)((#note)?-(\d+))?)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]][^A-Za-z0-9_/])|,|\s|\]|<|$)}) do |m|
- leading, esc, project_prefix, project_identifier, prefix, repo_prefix, repo_identifier, sep, identifier, comment_suffix, comment_id = $1, $2, $3, $4, $5, $10, $11, $8 || $12 || $18, $14 || $19, $15, $17
- link = nil
- if project_identifier
- project = Project.visible.find_by_identifier(project_identifier)
- end
- if esc.nil?
- if prefix.nil? && sep == 'r'
- if project
- repository = nil
- if repo_identifier
- repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
- else
- repository = project.repository
- end
- # project.changesets.visible raises an SQL error because of a double join on repositories
- if repository && (changeset = Changeset.visible.find_by_repository_id_and_revision(repository.id, identifier))
- link = link_to(h("#{project_prefix}#{repo_prefix}r#{identifier}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :repository_id => repository.identifier_param, :rev => changeset.revision},
- :class => 'changeset',
- :title => truncate_single_line(changeset.comments, :length => 100))
- end
- end
- elsif sep == '#'
- oid = identifier.to_i
- case prefix
- when nil
- if issue = Issue.visible.find_by_id(oid, :include => :status)
- anchor = comment_id ? "note-#{comment_id}" : nil
- link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid, :anchor => anchor},
- :class => issue.css_classes,
- :title => "#{truncate(issue.subject, :length => 100)} (#{issue.status.name})")
- end
- when 'document'
- if document = Document.visible.find_by_id(oid)
- link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
- :class => 'document'
- end
- when 'version'
- if version = Version.visible.find_by_id(oid)
- link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
- :class => 'version'
- end
- when 'message'
- if message = Message.visible.find_by_id(oid, :include => :parent)
- link = link_to_message(message, {:only_path => only_path}, :class => 'message')
- end
- when 'forum'
- if board = Board.visible.find_by_id(oid)
- link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project},
- :class => 'board'
- end
- when 'news'
- if news = News.visible.find_by_id(oid)
- link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news},
- :class => 'news'
- end
- when 'project'
- if p = Project.visible.find_by_id(oid)
- link = link_to_project(p, {:only_path => only_path}, :class => 'project')
- end
- end
- elsif sep == ':'
- # removes the double quotes if any
- name = identifier.gsub(%r{^"(.*)"$}, "\\1")
- case prefix
- when 'document'
- if project && document = project.documents.visible.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.visible.find_by_name(name)
- link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
- :class => 'version'
- end
- when 'forum'
- if project && board = project.boards.visible.find_by_name(name)
- link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project},
- :class => 'board'
- end
- when 'news'
- if project && news = project.news.visible.find_by_title(name)
- link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news},
- :class => 'news'
- end
- when 'commit', 'source', 'export'
- if project
- repository = nil
- if name =~ %r{^(([a-z0-9\-]+)\|)(.+)$}
- repo_prefix, repo_identifier, name = $1, $2, $3
- repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
- else
- repository = project.repository
- end
- if prefix == 'commit'
- if repository && (changeset = Changeset.visible.find(:first, :conditions => ["repository_id = ? AND scmid LIKE ?", repository.id, "#{name}%"]))
- link = link_to h("#{project_prefix}#{repo_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :repository_id => repository.identifier_param, :rev => changeset.identifier},
- :class => 'changeset',
- :title => truncate_single_line(h(changeset.comments), :length => 100)
- end
- else
- if repository && User.current.allowed_to?(:browse_repository, project)
- name =~ %r{^[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?$}
- path, rev, anchor = $1, $3, $5
- link = link_to h("#{project_prefix}#{prefix}:#{repo_prefix}#{name}"), {:controller => 'repositories', :action => 'entry', :id => project, :repository_id => repository.identifier_param,
- :path => to_path_param(path),
- :rev => rev,
- :anchor => anchor,
- :format => (prefix == 'export' ? 'raw' : nil)},
- :class => (prefix == 'export' ? 'source download' : 'source')
- end
- end
- repo_prefix = nil
- end
- when 'attachment'
- attachments = options[:attachments] || (obj && obj.respond_to?(:attachments) ? obj.attachments : nil)
- 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
- when 'project'
- if p = Project.visible.find(:first, :conditions => ["identifier = :s OR LOWER(name) = :s", {:s => name.downcase}])
- link = link_to_project(p, {:only_path => only_path}, :class => 'project')
- end
- end
- end
- end
- (leading + (link || "#{project_prefix}#{prefix}#{repo_prefix}#{sep}#{identifier}#{comment_suffix}"))
- end
- end
-
- HEADING_RE = /(<h(1|2|3|4)( [^>]+)?>(.+?)<\/h(1|2|3|4)>)/i unless const_defined?(:HEADING_RE)
-
- def parse_sections(text, project, obj, attr, only_path, options)
- return unless options[:edit_section_links]
- text.gsub!(HEADING_RE) do
- heading = $1
- @current_section += 1
- if @current_section > 1
- content_tag('div',
- link_to(image_tag('edit.png'), options[:edit_section_links].merge(:section => @current_section)),
- :class => 'contextual',
- :title => l(:button_edit_section)) + heading.html_safe
- else
- heading
- end
- end
- end
-
- # Headings and TOC
- # Adds ids and links to headings unless options[:headings] is set to false
- def parse_headings(text, project, obj, attr, only_path, options)
- return if options[:headings] == false
-
- text.gsub!(HEADING_RE) do
- level, attrs, content = $2.to_i, $3, $4
- item = strip_tags(content).strip
- anchor = sanitize_anchor_name(item)
- # used for single-file wiki export
- anchor = "#{obj.page.title}_#{anchor}" if options[:wiki_links] == :anchor && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version))
- @heading_anchors[anchor] ||= 0
- idx = (@heading_anchors[anchor] += 1)
- if idx > 1
- anchor = "#{anchor}-#{idx}"
- end
- @parsed_headings << [level, anchor, item]
- "<a name=\"#{anchor}\"></a>\n<h#{level} #{attrs}>#{content}<a href=\"##{anchor}\" class=\"wiki-anchor\">¶</a></h#{level}>"
- end
- end
-
- MACROS_RE = /
- (!)? # escaping
- (
- \{\{ # opening tag
- ([\w]+) # macro name
- (\(([^\}]*)\))? # optional arguments
- \}\} # closing tag
- )
- /x unless const_defined?(:MACROS_RE)
-
- # Macros substitution
- def parse_macros(text, project, obj, attr, only_path, options)
- text.gsub!(MACROS_RE) do
- esc, all, macro = $1, $2, $3.downcase
- args = ($5 || '').split(',').each(&:strip)
- if esc.nil?
- begin
- exec_macro(macro, obj, args)
- rescue => e
- "<div class=\"flash error\">Error executing the <strong>#{macro}</strong> macro (#{e})</div>"
- end || all
- else
- all
- end
- end
- end
-
- TOC_RE = /<p>\{\{([<>]?)toc\}\}<\/p>/i unless const_defined?(:TOC_RE)
-
- # Renders the TOC with given headings
- def replace_toc(text, headings)
- text.gsub!(TOC_RE) do
- if headings.empty?
- ''
- else
- div_class = 'toc'
- div_class << ' right' if $1 == '>'
- div_class << ' left' if $1 == '<'
- out = "<ul class=\"#{div_class}\"><li>"
- root = headings.map(&:first).min
- current = root
- started = false
- headings.each do |level, anchor, item|
- if level > current
- out << '<ul><li>' * (level - current)
- elsif level < current
- out << "</li></ul>\n" * (current - level) + "</li><li>"
- elsif started
- out << '</li><li>'
- end
- out << "<a href=\"##{anchor}\">#{item}</a>"
- current = level
- started = true
- end
- out << '</li></ul>' * (current - root)
- out << '</li></ul>'
- end
- end
- 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
- html_safe
- end
-
- def lang_options_for_select(blank=true)
- (blank ? [["(auto)", ""]] : []) +
- 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(*args, &proc)
- ActiveSupport::Deprecation.warn "ApplicationHelper#labelled_tabular_form_for is deprecated and will be removed in Redmine 1.5. Use #labelled_form_for instead."
- args << {} unless args.last.is_a?(Hash)
- options = args.last
- options[:html] ||= {}
- options[:html][:class] = 'tabular' unless options[:html].has_key?(:class)
- options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
- form_for(*args, &proc)
- end
-
- def labelled_form_for(*args, &proc)
- args << {} unless args.last.is_a?(Hash)
- options = args.last
- options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
- form_for(*args, &proc)
- end
-
- def labelled_fields_for(*args, &proc)
- args << {} unless args.last.is_a?(Hash)
- options = args.last
- options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
- fields_for(*args, &proc)
- end
-
- def labelled_remote_form_for(*args, &proc)
- args << {} unless args.last.is_a?(Hash)
- options = args.last
- options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
- remote_form_for(*args, &proc)
- end
-
- def error_messages_for(*objects)
- html = ""
- objects = objects.map {|o| o.is_a?(String) ? instance_variable_get("@#{o}") : o}.compact
- errors = objects.map {|o| o.errors.full_messages}.flatten
- if errors.any?
- html << "<div id='errorExplanation'><ul>\n"
- errors.each do |error|
- html << "<li>#{h error}</li>\n"
- end
- html << "</ul></div>\n"
- end
- html.html_safe
- end
-
- def back_url_hidden_field_tag
- back_url = params[:back_url] || request.env['HTTP_REFERER']
- back_url = CGI.unescape(back_url.to_s)
- hidden_field_tag('back_url', CGI.escape(back_url), :id => nil) unless back_url.blank?
- end
-
- def check_all_links(form_name)
- link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
- " | ".html_safe +
- 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 = pcts.collect(&:round)
- 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', '', :style => "width: #{pcts[0]}%;", :class => 'closed') : ''.html_safe) +
- (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1]}%;", :class => 'done') : ''.html_safe) +
- (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2]}%;", :class => 'todo') : ''.html_safe)
- ), :class => 'progress', :style => "width: #{width};").html_safe +
- content_tag('p', legend, :class => 'pourcent').html_safe
- end
-
- def checked_image(checked=true)
- if checked
- image_tag 'toggle_check.png'
- end
- end
-
- def context_menu(url)
- unless @context_menu_included
- content_for :header_tags do
- javascript_include_tag('context_menu') +
- stylesheet_link_tag('context_menu')
- end
- if l(:direction) == 'rtl'
- content_for :header_tags do
- stylesheet_link_tag('context_menu_rtl')
- end
- end
- @context_menu_included = true
- end
- javascript_tag "new ContextMenu('#{ url_for(url) }')"
- 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
- start_of_week = case Setting.start_of_week.to_i
- when 1
- 'Calendar._FD = 1;' # Monday
- when 7
- 'Calendar._FD = 0;' # Sunday
- when 6
- 'Calendar._FD = 6;' # Saturday
- else
- '' # use language
- end
-
- javascript_include_tag('calendar/calendar') +
- javascript_include_tag("calendar/lang/calendar-#{current_language.to_s.downcase}.js") +
- javascript_tag(start_of_week) +
- javascript_include_tag('calendar/calendar-setup') +
- stylesheet_link_tag('calendar')
- end
- end
- 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
-
- def email_delivery_enabled?
- !!ActionMailer::Base.perform_deliveries
- end
-
- # Returns the avatar image tag for the given +user+ if avatars are enabled
- # +user+ can be a User or a string that will be scanned for an email address (eg. 'joe <joe@foo.bar>')
- def avatar(user, options = { })
- if Setting.gravatar_enabled?
- options.merge!({:ssl => (defined?(request) && request.ssl?), :default => Setting.gravatar_default})
- email = nil
- if user.respond_to?(:mail)
- email = user.mail
- elsif user.to_s =~ %r{<(.+?)>}
- email = $1
- end
- return gravatar(email.to_s.downcase, options) unless email.blank? rescue nil
- else
- ''
- end
- end
-
- def sanitize_anchor_name(anchor)
- anchor.gsub(%r{[^\w\s\-]}, '').gsub(%r{\s+(\-+\s*)?}, '-')
- end
-
- # Returns the javascript tags that are included in the html layout head
- def javascript_heads
- tags = javascript_include_tag(:defaults)
- unless User.current.pref.warn_on_leaving_unsaved == '0'
- tags << "\n".html_safe + javascript_tag("Event.observe(window, 'load', function(){ new WarnLeavingUnsaved('#{escape_javascript( l(:text_warn_on_leaving_unsaved) )}'); });")
- end
- tags
- end
-
- def favicon
- "<link rel='shortcut icon' href='#{image_path('/favicon.ico')}' />".html_safe
- end
-
- def robot_exclusion_tag
- '<meta name="robots" content="noindex,follow,noarchive" />'.html_safe
- end
-
- # Returns true if arg is expected in the API response
- def include_in_api_response?(arg)
- unless @included_in_api_response
- param = params[:include]
- @included_in_api_response = param.is_a?(Array) ? param.collect(&:to_s) : param.to_s.split(',')
- @included_in_api_response.collect!(&:strip)
- end
- @included_in_api_response.include?(arg.to_s)
- end
-
- # Returns options or nil if nometa param or X-Redmine-Nometa header
- # was set in the request
- def api_meta(options)
- if params[:nometa].present? || request.headers['X-Redmine-Nometa']
- # compatibility mode for activeresource clients that raise
- # an error when unserializing an array with attributes
- nil
- else
- options
- end
- end
-
- private
-
- def wiki_helper
- helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)
- extend helper
- return self
- end
-
- def link_to_content_update(text, url_params = {}, html_options = {})
- link_to(text, url_params, html_options)
- end
- end
|