Chris@909: # Redmine - project management software
Chris@909: # Copyright (C) 2006-2011  Jean-Philippe Lang
Chris@909: #
Chris@909: # This program is free software; you can redistribute it and/or
Chris@909: # modify it under the terms of the GNU General Public License
Chris@909: # as published by the Free Software Foundation; either version 2
Chris@909: # of the License, or (at your option) any later version.
Chris@909: #
Chris@909: # This program is distributed in the hope that it will be useful,
Chris@909: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@909: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@909: # GNU General Public License for more details.
Chris@909: #
Chris@909: # You should have received a copy of the GNU General Public License
Chris@909: # along with this program; if not, write to the Free Software
Chris@909: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@909: 
Chris@909: class TimelogController < ApplicationController
Chris@909:   menu_item :issues
Chris@909:   before_filter :find_project, :only => [:new, :create]
Chris@909:   before_filter :find_time_entry, :only => [:show, :edit, :update]
Chris@909:   before_filter :find_time_entries, :only => [:bulk_edit, :bulk_update, :destroy]
Chris@909:   before_filter :authorize, :except => [:index]
Chris@909:   before_filter :find_optional_project, :only => [:index]
Chris@909:   accept_rss_auth :index
Chris@909:   accept_api_auth :index, :show, :create, :update, :destroy
Chris@909: 
Chris@909:   helper :sort
Chris@909:   include SortHelper
Chris@909:   helper :issues
Chris@909:   include TimelogHelper
Chris@909:   helper :custom_fields
Chris@909:   include CustomFieldsHelper
Chris@909: 
Chris@909:   def index
Chris@909:     sort_init 'spent_on', 'desc'
Chris@909:     sort_update 'spent_on' => 'spent_on',
Chris@909:                 'user' => 'user_id',
Chris@909:                 'activity' => 'activity_id',
Chris@909:                 'project' => "#{Project.table_name}.name",
Chris@909:                 'issue' => 'issue_id',
Chris@909:                 'hours' => 'hours'
Chris@909: 
Chris@909:     cond = ARCondition.new
Chris@909:     if @issue
Chris@909:       cond << "#{Issue.table_name}.root_id = #{@issue.root_id} AND #{Issue.table_name}.lft >= #{@issue.lft} AND #{Issue.table_name}.rgt <= #{@issue.rgt}"
Chris@909:     elsif @project
Chris@909:       cond << @project.project_condition(Setting.display_subprojects_issues?)
Chris@909:     end
Chris@909: 
Chris@909:     retrieve_date_range
Chris@909:     cond << ['spent_on BETWEEN ? AND ?', @from, @to]
Chris@909: 
Chris@909:     respond_to do |format|
Chris@909:       format.html {
Chris@909:         # Paginate results
Chris@909:         @entry_count = TimeEntry.visible.count(:include => [:project, :issue], :conditions => cond.conditions)
Chris@909:         @entry_pages = Paginator.new self, @entry_count, per_page_option, params['page']
Chris@909:         @entries = TimeEntry.visible.find(:all,
Chris@909:                                   :include => [:project, :activity, :user, {:issue => :tracker}],
Chris@909:                                   :conditions => cond.conditions,
Chris@909:                                   :order => sort_clause,
Chris@909:                                   :limit  =>  @entry_pages.items_per_page,
Chris@909:                                   :offset =>  @entry_pages.current.offset)
Chris@909:         @total_hours = TimeEntry.visible.sum(:hours, :include => [:project, :issue], :conditions => cond.conditions).to_f
Chris@909: 
Chris@909:         render :layout => !request.xhr?
Chris@909:       }
Chris@909:       format.api  {
Chris@909:         @entry_count = TimeEntry.visible.count(:include => [:project, :issue], :conditions => cond.conditions)
Chris@909:         @offset, @limit = api_offset_and_limit
Chris@909:         @entries = TimeEntry.visible.find(:all,
Chris@909:                                   :include => [:project, :activity, :user, {:issue => :tracker}],
Chris@909:                                   :conditions => cond.conditions,
Chris@909:                                   :order => sort_clause,
Chris@909:                                   :limit  => @limit,
Chris@909:                                   :offset => @offset)
Chris@909:       }
Chris@909:       format.atom {
Chris@909:         entries = TimeEntry.visible.find(:all,
Chris@909:                                  :include => [:project, :activity, :user, {:issue => :tracker}],
Chris@909:                                  :conditions => cond.conditions,
Chris@909:                                  :order => "#{TimeEntry.table_name}.created_on DESC",
Chris@909:                                  :limit => Setting.feeds_limit.to_i)
Chris@909:         render_feed(entries, :title => l(:label_spent_time))
Chris@909:       }
Chris@909:       format.csv {
Chris@909:         # Export all entries
Chris@909:         @entries = TimeEntry.visible.find(:all,
Chris@909:                                   :include => [:project, :activity, :user, {:issue => [:tracker, :assigned_to, :priority]}],
Chris@909:                                   :conditions => cond.conditions,
Chris@909:                                   :order => sort_clause)
Chris@909:         send_data(entries_to_csv(@entries), :type => 'text/csv; header=present', :filename => 'timelog.csv')
Chris@909:       }
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def show
Chris@909:     respond_to do |format|
Chris@909:       # TODO: Implement html response
Chris@909:       format.html { render :nothing => true, :status => 406 }
Chris@909:       format.api
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def new
Chris@909:     @time_entry ||= TimeEntry.new(:project => @project, :issue => @issue, :user => User.current, :spent_on => User.current.today)
Chris@909:     @time_entry.attributes = params[:time_entry]
Chris@909: 
Chris@909:     call_hook(:controller_timelog_edit_before_save, { :params => params, :time_entry => @time_entry })
Chris@909:     render :action => 'edit'
Chris@909:   end
Chris@909: 
Chris@909:   verify :method => :post, :only => :create, :render => {:nothing => true, :status => :method_not_allowed }
Chris@909:   def create
Chris@909:     @time_entry ||= TimeEntry.new(:project => @project, :issue => @issue, :user => User.current, :spent_on => User.current.today)
Chris@909:     @time_entry.attributes = params[:time_entry]
Chris@909: 
Chris@909:     call_hook(:controller_timelog_edit_before_save, { :params => params, :time_entry => @time_entry })
Chris@909: 
Chris@909:     if @time_entry.save
Chris@909:       respond_to do |format|
Chris@909:         format.html {
Chris@909:           flash[:notice] = l(:notice_successful_update)
Chris@909:           redirect_back_or_default :action => 'index', :project_id => @time_entry.project
Chris@909:         }
Chris@909:         format.api  { render :action => 'show', :status => :created, :location => time_entry_url(@time_entry) }
Chris@909:       end
Chris@909:     else
Chris@909:       respond_to do |format|
Chris@909:         format.html { render :action => 'edit' }
Chris@909:         format.api  { render_validation_errors(@time_entry) }
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def edit
Chris@909:     @time_entry.attributes = params[:time_entry]
Chris@909: 
Chris@909:     call_hook(:controller_timelog_edit_before_save, { :params => params, :time_entry => @time_entry })
Chris@909:   end
Chris@909: 
Chris@909:   verify :method => :put, :only => :update, :render => {:nothing => true, :status => :method_not_allowed }
Chris@909:   def update
Chris@909:     @time_entry.attributes = params[:time_entry]
Chris@909: 
Chris@909:     call_hook(:controller_timelog_edit_before_save, { :params => params, :time_entry => @time_entry })
Chris@909: 
Chris@909:     if @time_entry.save
Chris@909:       respond_to do |format|
Chris@909:         format.html {
Chris@909:           flash[:notice] = l(:notice_successful_update)
Chris@909:           redirect_back_or_default :action => 'index', :project_id => @time_entry.project
Chris@909:         }
Chris@909:         format.api  { head :ok }
Chris@909:       end
Chris@909:     else
Chris@909:       respond_to do |format|
Chris@909:         format.html { render :action => 'edit' }
Chris@909:         format.api  { render_validation_errors(@time_entry) }
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def bulk_edit
Chris@909:     @available_activities = TimeEntryActivity.shared.active
Chris@909:     @custom_fields = TimeEntry.first.available_custom_fields
Chris@909:   end
Chris@909: 
Chris@909:   def bulk_update
Chris@909:     attributes = parse_params_for_bulk_time_entry_attributes(params)
Chris@909: 
Chris@909:     unsaved_time_entry_ids = []
Chris@909:     @time_entries.each do |time_entry|
Chris@909:       time_entry.reload
Chris@909:       time_entry.attributes = attributes
Chris@909:       call_hook(:controller_time_entries_bulk_edit_before_save, { :params => params, :time_entry => time_entry })
Chris@909:       unless time_entry.save
Chris@909:         # Keep unsaved time_entry ids to display them in flash error
Chris@909:         unsaved_time_entry_ids << time_entry.id
Chris@909:       end
Chris@909:     end
Chris@909:     set_flash_from_bulk_time_entry_save(@time_entries, unsaved_time_entry_ids)
Chris@909:     redirect_back_or_default({:controller => 'timelog', :action => 'index', :project_id => @projects.first})
Chris@909:   end
Chris@909: 
Chris@909:   verify :method => :delete, :only => :destroy, :render => {:nothing => true, :status => :method_not_allowed }
Chris@909:   def destroy
Chris@909:     @time_entries.each do |t|
Chris@909:       begin
Chris@909:         unless t.destroy && t.destroyed?
Chris@909:           respond_to do |format|
Chris@909:             format.html {
Chris@909:               flash[:error] = l(:notice_unable_delete_time_entry)
Chris@909:               redirect_to :back
Chris@909:             }
Chris@909:             format.api  { render_validation_errors(t) }
Chris@909:           end
Chris@909:           return
Chris@909:         end
Chris@909:       rescue ::ActionController::RedirectBackError
Chris@909:         redirect_to :action => 'index', :project_id => @projects.first
Chris@909:         return
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     respond_to do |format|
Chris@909:       format.html {
Chris@909:         flash[:notice] = l(:notice_successful_delete)
Chris@909:         redirect_back_or_default(:action => 'index', :project_id => @projects.first)
Chris@909:       }
Chris@909:       format.api  { head :ok }
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909: private
Chris@909:   def find_time_entry
Chris@909:     @time_entry = TimeEntry.find(params[:id])
Chris@909:     unless @time_entry.editable_by?(User.current)
Chris@909:       render_403
Chris@909:       return false
Chris@909:     end
Chris@909:     @project = @time_entry.project
Chris@909:   rescue ActiveRecord::RecordNotFound
Chris@909:     render_404
Chris@909:   end
Chris@909: 
Chris@909:   def find_time_entries
Chris@909:     @time_entries = TimeEntry.find_all_by_id(params[:id] || params[:ids])
Chris@909:     raise ActiveRecord::RecordNotFound if @time_entries.empty?
Chris@909:     @projects = @time_entries.collect(&:project).compact.uniq
Chris@909:     @project = @projects.first if @projects.size == 1
Chris@909:   rescue ActiveRecord::RecordNotFound
Chris@909:     render_404
Chris@909:   end
Chris@909: 
Chris@909:   def set_flash_from_bulk_time_entry_save(time_entries, unsaved_time_entry_ids)
Chris@909:     if unsaved_time_entry_ids.empty?
Chris@909:       flash[:notice] = l(:notice_successful_update) unless time_entries.empty?
Chris@909:     else
Chris@909:       flash[:error] = l(:notice_failed_to_save_time_entries,
Chris@909:                         :count => unsaved_time_entry_ids.size,
Chris@909:                         :total => time_entries.size,
Chris@909:                         :ids => '#' + unsaved_time_entry_ids.join(', #'))
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def find_project
Chris@909:     if (issue_id = (params[:issue_id] || params[:time_entry] && params[:time_entry][:issue_id])).present?
Chris@909:       @issue = Issue.find(issue_id)
Chris@909:       @project = @issue.project
Chris@909:     elsif (project_id = (params[:project_id] || params[:time_entry] && params[:time_entry][:project_id])).present?
Chris@909:       @project = Project.find(project_id)
Chris@909:     else
Chris@909:       render_404
Chris@909:       return false
Chris@909:     end
Chris@909:   rescue ActiveRecord::RecordNotFound
Chris@909:     render_404
Chris@909:   end
Chris@909: 
Chris@909:   def find_optional_project
Chris@909:     if !params[:issue_id].blank?
Chris@909:       @issue = Issue.find(params[:issue_id])
Chris@909:       @project = @issue.project
Chris@909:     elsif !params[:project_id].blank?
Chris@909:       @project = Project.find(params[:project_id])
Chris@909:     end
Chris@909:     deny_access unless User.current.allowed_to?(:view_time_entries, @project, :global => true)
Chris@909:   end
Chris@909: 
Chris@909:   # Retrieves the date range based on predefined ranges or specific from/to param dates
Chris@909:   def retrieve_date_range
Chris@909:     @free_period = false
Chris@909:     @from, @to = nil, nil
Chris@909: 
Chris@909:     if params[:period_type] == '1' || (params[:period_type].nil? && !params[:period].nil?)
Chris@909:       case params[:period].to_s
Chris@909:       when 'today'
Chris@909:         @from = @to = Date.today
Chris@909:       when 'yesterday'
Chris@909:         @from = @to = Date.today - 1
Chris@909:       when 'current_week'
Chris@909:         @from = Date.today - (Date.today.cwday - 1)%7
Chris@909:         @to = @from + 6
Chris@909:       when 'last_week'
Chris@909:         @from = Date.today - 7 - (Date.today.cwday - 1)%7
Chris@909:         @to = @from + 6
Chris@909:       when '7_days'
Chris@909:         @from = Date.today - 7
Chris@909:         @to = Date.today
Chris@909:       when 'current_month'
Chris@909:         @from = Date.civil(Date.today.year, Date.today.month, 1)
Chris@909:         @to = (@from >> 1) - 1
Chris@909:       when 'last_month'
Chris@909:         @from = Date.civil(Date.today.year, Date.today.month, 1) << 1
Chris@909:         @to = (@from >> 1) - 1
Chris@909:       when '30_days'
Chris@909:         @from = Date.today - 30
Chris@909:         @to = Date.today
Chris@909:       when 'current_year'
Chris@909:         @from = Date.civil(Date.today.year, 1, 1)
Chris@909:         @to = Date.civil(Date.today.year, 12, 31)
Chris@909:       end
Chris@909:     elsif params[:period_type] == '2' || (params[:period_type].nil? && (!params[:from].nil? || !params[:to].nil?))
Chris@909:       begin; @from = params[:from].to_s.to_date unless params[:from].blank?; rescue; end
Chris@909:       begin; @to = params[:to].to_s.to_date unless params[:to].blank?; rescue; end
Chris@909:       @free_period = true
Chris@909:     else
Chris@909:       # default
Chris@909:     end
Chris@909: 
Chris@909:     @from, @to = @to, @from if @from && @to && @from > @to
Chris@909:     @from ||= (TimeEntry.earilest_date_for_project(@project) || Date.today)
Chris@909:     @to   ||= (TimeEntry.latest_date_for_project(@project) || Date.today)
Chris@909:   end
Chris@909: 
Chris@909:   def parse_params_for_bulk_time_entry_attributes(params)
Chris@909:     attributes = (params[:time_entry] || {}).reject {|k,v| v.blank?}
Chris@909:     attributes.keys.each {|k| attributes[k] = '' if attributes[k] == 'none'}
Chris@909:     attributes[:custom_field_values].reject! {|k,v| v.blank?} if attributes[:custom_field_values]
Chris@909:     attributes
Chris@909:   end
Chris@909: end