SoundSoftware Code Site

# encoding: utf-8

#

# Helpers to sort tables using clickable column headers.

#

# Author:  Stuart Rackham <srackham@methods.co.nz>, March 2005.

#          Jean-Philippe Lang, 2009

# License: This source code is released under the MIT license.

#

# - Consecutive clicks toggle the column's sort order.

# - Sort state is maintained by a session hash entry.

# - CSS classes identify sort column and state.

# - Typically used in conjunction with the Pagination module.

#

# Example code snippets:

#

# Controller:

#

#   helper :sort

#   include SortHelper

#

#   def list

#     sort_init 'last_name'

#     sort_update %w(first_name last_name)

#     @items = Contact.find_all nil, sort_clause

#   end

#

# Controller (using Pagination module):

#

#   helper :sort

#   include SortHelper

#

#   def list

#     sort_init 'last_name'

#     sort_update %w(first_name last_name)

#     @contact_pages, @items = paginate :contacts,

#       :order_by => sort_clause,

#       :per_page => 10

#   end

#

# View (table header in list.rhtml):

#

#   <thead>

#     <tr>

#       <%= sort_header_tag('id', :title => 'Sort by contact ID') %>

#       <%= sort_header_tag('last_name', :caption => 'Name') %>

#       <%= sort_header_tag('phone') %>

#       <%= sort_header_tag('address', :width => 200) %>

#     </tr>

#   </thead>

#

# - Introduces instance variables: @sort_default, @sort_criteria

# - Introduces param :sort

#

module SortHelper

  class SortCriteria

    def initialize

      @criteria = []

    end

    def available_criteria=(criteria)

      unless criteria.is_a?(Hash)

        criteria = criteria.inject({}) {|h,k| h[k] = k; h}

      end

      @available_criteria = criteria

    end

    def from_param(param)

      @criteria = param.to_s.split(',').collect {|s| s.split(':')[0..1]}

      normalize!

    end

    def criteria=(arg)

      @criteria = arg

      normalize!

    end

    def to_param

      @criteria.collect {|k,o| k + (o ? '' : ':desc')}.join(',')

    end

    # Returns an array of SQL fragments used to sort the list

    def to_sql

      sql = @criteria.collect do |k,o|

        if s = @available_criteria[k]

          (o ? s.to_a : s.to_a.collect {|c| append_desc(c)})

        end

      end.flatten.compact

      sql.blank? ? nil : sql

    end

    def to_a

      @criteria.dup

    end

    def add!(key, asc)

      @criteria.delete_if {|k,o| k == key}

      @criteria = [[key, asc]] + @criteria

      normalize!

    end

    def add(*args)

      r = self.class.new.from_param(to_param)

      r.add!(*args)

      r

    end

    def first_key

      @criteria.first && @criteria.first.first

    end

    def first_asc?

      @criteria.first && @criteria.first.last

    end

    def empty?

      @criteria.empty?

    end

    private

    def normalize!

      @criteria ||= []

      @criteria = @criteria.collect {|s| s = s.to_a; [s.first, (s.last == false || s.last == 'desc') ? false : true]}

      @criteria = @criteria.select {|k,o| @available_criteria.has_key?(k)} if @available_criteria

      @criteria.slice!(3)

      self

    end

    # Appends DESC to the sort criterion unless it has a fixed order

    def append_desc(criterion)

      if criterion =~ / (asc|desc)$/i

        criterion

      else

        "#{criterion} DESC"

      end

    end

  end

  def sort_name

    controller_name + '_' + action_name + '_sort'

  end

  # Initializes the default sort.

  # Examples:

  #

  #   sort_init 'name'

  #   sort_init 'id', 'desc'

  #   sort_init ['name', ['id', 'desc']]

  #   sort_init [['name', 'desc'], ['id', 'desc']]

  #

  def sort_init(*args)

    case args.size

    when 1

      @sort_default = args.first.is_a?(Array) ? args.first : [[args.first]]

    when 2

      @sort_default = [[args.first, args.last]]

    else

      raise ArgumentError

    end

  end

  # Updates the sort state. Call this in the controller prior to calling

  # sort_clause.

  # - criteria can be either an array or a hash of allowed keys

  #

  def sort_update(criteria, sort_name=nil)

    sort_name ||= self.sort_name

    @sort_criteria = SortCriteria.new

    @sort_criteria.available_criteria = criteria

    @sort_criteria.from_param(params[:sort] || session[sort_name])

    @sort_criteria.criteria = @sort_default if @sort_criteria.empty?

    session[sort_name] = @sort_criteria.to_param

  end

  # Clears the sort criteria session data

  #

  def sort_clear

    session[sort_name] = nil

  end

  # Returns an SQL sort clause corresponding to the current sort state.

  # Use this to sort the controller's table items collection.

  #

  def sort_clause()

    @sort_criteria.to_sql

  end

  def sort_criteria

    @sort_criteria

  end

  # Returns a link which sorts by the named column.

  #

  # - column is the name of an attribute in the sorted record collection.

  # - the optional caption explicitly specifies the displayed link text.

  # - 2 CSS classes reflect the state of the link: sort and asc or desc

  #

  def sort_link(column, caption, default_order)

    css, order = nil, default_order

    if column.to_s == @sort_criteria.first_key

      if @sort_criteria.first_asc?

        css = 'sort asc'

        order = 'desc'

      else

        css = 'sort desc'

        order = 'asc'

      end

    end

    caption = column.to_s.humanize unless caption

    sort_options = { :sort => @sort_criteria.add(column.to_s, order).to_param }

    url_options = params.merge(sort_options)

     # Add project_id to url_options

    url_options = url_options.merge(:project_id => params[:project_id]) if params.has_key?(:project_id)

    link_to_content_update(h(caption), url_options, :class => css)

  end

  # Returns a table header <th> tag with a sort link for the named column

  # attribute.

  #

  # Options:

  #   :caption     The displayed link name (defaults to titleized column name).

  #   :title       The tag's 'title' attribute (defaults to 'Sort by :caption').

  #

  # Other options hash entries generate additional table header tag attributes.

  #

  # Example:

  #

  #   <%= sort_header_tag('id', :title => 'Sort by contact ID', :width => 40) %>

  #

  def sort_header_tag(column, options = {})

    caption = options.delete(:caption) || column.to_s.humanize

    default_order = options.delete(:default_order) || 'asc'

    options[:title] = l(:label_sort_by, "\"#{caption}\"") unless options[:title]

    content_tag('th', sort_link(column, caption, default_order), options)

  end

end

# Redmine - project management software

# Copyright (C) 2006-2013  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.

class CommentObserver < ActiveRecord::Observer

  def after_create(comment)

    if comment.commented.is_a?(News) && Setting.notified_events.include?('news_comment_added')

      Mailer.news_comment_added(comment).deliver

    end

  end

end

# encoding: utf-8

#

# Redmine - project management software

# Copyright (C) 2006-2013  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 QueriesHelper

  def filters_options_for_select(query)

    options_for_select(filters_options(query))

  end

  def filters_options(query)

    options = [[]]

    options += query.available_filters.map do |field, field_options|

      [field_options[:name], field]

    end

  end

  def query_filters_hidden_tags(query)

    tags = ''.html_safe

    query.filters.each do |field, options|

      tags << hidden_field_tag("f[]", field, :id => nil)

      tags << hidden_field_tag("op[#{field}]", options[:operator], :id => nil)

      options[:values].each do |value|

        tags << hidden_field_tag("v[#{field}][]", value, :id => nil)

      end

    end

    tags

  end

  def query_columns_hidden_tags(query)

    tags = ''.html_safe

    query.columns.each do |column|

      tags << hidden_field_tag("c[]", column.name, :id => nil)

    end

    tags

  end

  def query_hidden_tags(query)

    query_filters_hidden_tags(query) + query_columns_hidden_tags(query)

  end

  def available_block_columns_tags(query)

    tags = ''.html_safe

    query.available_block_columns.each do |column|

      tags << content_tag('label', check_box_tag('c[]', column.name.to_s, query.has_column?(column)) + " #{column.caption}", :class => 'inline')

    end

    tags

  end

  def query_available_inline_columns_options(query)

    (query.available_inline_columns - query.columns).reject(&:frozen?).collect {|column| [column.caption, column.name]}

  end

  def query_selected_inline_columns_options(query)

    (query.inline_columns & query.available_inline_columns).reject(&:frozen?).collect {|column| [column.caption, column.name]}

  end

  def render_query_columns_selection(query, options={})

    tag_name = (options[:name] || 'c') + '[]'

    render :partial => 'queries/columns', :locals => {:query => query, :tag_name => tag_name}

  end

  def column_header(column)

    column.sortable ? sort_header_tag(column.name.to_s, :caption => column.caption,

                                                        :default_order => column.default_order) :

                      content_tag('th', h(column.caption))

  end

  def column_content(column, issue)

    value = column.value(issue)

    if value.is_a?(Array)

      value.collect {|v| column_value(column, issue, v)}.compact.join(', ').html_safe

    else

      column_value(column, issue, value)

    end

  end

  def column_value(column, issue, value)

    case value.class.name

    when 'String'

      if column.name == :subject

        link_to(h(value), :controller => 'issues', :action => 'show', :id => issue)

      elsif column.name == :description

        issue.description? ? content_tag('div', textilizable(issue, :description), :class => "wiki") : ''

      else

        h(value)

      end

    when 'Time'

      format_time(value)

    when 'Date'

      format_date(value)

    when 'Fixnum'

      if column.name == :id

        link_to value, issue_path(issue)

      elsif column.name == :done_ratio

        progress_bar(value, :width => '80px')

      else

        value.to_s

      end

    when 'Float'

      sprintf "%.2f", value

    when 'User'

      link_to_user value

    when 'Project'

      link_to_project value

    when 'Version'

      link_to(h(value), :controller => 'versions', :action => 'show', :id => value)

    when 'TrueClass'

      l(:general_text_Yes)

    when 'FalseClass'

      l(:general_text_No)

    when 'Issue'

      value.visible? ? link_to_issue(value) : "##{value.id}"

    when 'IssueRelation'

      other = value.other_issue(issue)

      content_tag('span',

        (l(value.label_for(issue)) + " " + link_to_issue(other, :subject => false, :tracker => false)).html_safe,

        :class => value.css_classes_for(issue))

    else

      h(value)

    end

  end

  def csv_content(column, issue)

    value = column.value(issue)

    if value.is_a?(Array)

      value.collect {|v| csv_value(column, issue, v)}.compact.join(', ')

    else

      csv_value(column, issue, value)

    end

  end

  def csv_value(column, issue, value)

    case value.class.name

    when 'Time'

      format_time(value)

    when 'Date'

      format_date(value)

    when 'Float'

      sprintf("%.2f", value).gsub('.', l(:general_csv_decimal_separator))

    when 'IssueRelation'

      other = value.other_issue(issue)

      l(value.label_for(issue)) + " ##{other.id}"

    else

      value.to_s

    end

  end

  def query_to_csv(items, query, options={})

    encoding = l(:general_csv_encoding)

    columns = (options[:columns] == 'all' ? query.available_inline_columns : query.inline_columns)

    query.available_block_columns.each do |column|

      if options[column.name].present?

        columns << column

      end

    end

    export = FCSV.generate(:col_sep => l(:general_csv_separator)) do |csv|

      # csv header fields

      csv << columns.collect {|c| Redmine::CodesetUtil.from_utf8(c.caption.to_s, encoding) }

      # csv lines

      items.each do |item|

        csv << columns.collect {|c| Redmine::CodesetUtil.from_utf8(csv_content(c, item), encoding) }

      end

    end

    export

  end

  # Retrieve query from session or build a new query

  def retrieve_query

    if !params[:query_id].blank?

      cond = "project_id IS NULL"

      cond << " OR project_id = #{@project.id}" if @project

      @query = IssueQuery.find(params[:query_id], :conditions => cond)

      raise ::Unauthorized unless @query.visible?

      @query.project = @project

      session[:query] = {:id => @query.id, :project_id => @query.project_id}

      sort_clear

    elsif api_request? || params[:set_filter] || session[:query].nil? || session[:query][:project_id] != (@project ? @project.id : nil)

      # Give it a name, required to be valid

      @query = IssueQuery.new(:name => "_")

      @query.project = @project

      @query.build_from_params(params)

      session[:query] = {:project_id => @query.project_id, :filters => @query.filters, :group_by => @query.group_by, :column_names => @query.column_names}

    else

      # retrieve from session

      @query = IssueQuery.find_by_id(session[:query][:id]) if session[:query][:id]

      @query ||= IssueQuery.new(:name => "_", :filters => session[:query][:filters], :group_by => session[:query][:group_by], :column_names => session[:query][:column_names])

      @query.project = @project

    end

  end

  def retrieve_query_from_session

    if session[:query]

      if session[:query][:id]

        @query = IssueQuery.find_by_id(session[:query][:id])

        return unless @query

      else

        @query = IssueQuery.new(:name => "_", :filters => session[:query][:filters], :group_by => session[:query][:group_by], :column_names => session[:query][:column_names])

      end

      if session[:query].has_key?(:project_id)

        @query.project_id = session[:query][:project_id]

      else

        @query.project = @project

      end

      @query

    end

  end

end