SoundSoftware Code Site

# 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.

class ProjectsController < ApplicationController

  menu_item :overview

  menu_item :roadmap, :only => :roadmap

  menu_item :settings, :only => :settings

  before_filter :find_project, :except => [ :index, :list, :explore, :new, :create, :copy ]

  before_filter :authorize, :except => [ :index, :list, :explore, :new, :create, :copy, :archive, :unarchive, :destroy]

  before_filter :authorize_global, :only => [:new, :create]

  before_filter :require_admin, :only => [ :copy, :archive, :unarchive, :destroy ]

  accept_rss_auth :index

  accept_api_auth :index, :show, :create, :update, :destroy

  after_filter :only => [:create, :edit, :update, :archive, :unarchive, :destroy] do |controller|

    if controller.request.post?

      controller.send :expire_action, :controller => 'welcome', :action => 'robots.txt'

    end

  end

  helper :sort

  include SortHelper

  helper :custom_fields

  include CustomFieldsHelper

  helper :issues

  helper :queries

  include QueriesHelper

  helper :repositories

  include RepositoriesHelper

  include ProjectsHelper

  include ActivitiesHelper

  helper :activities

  # Lists visible projects. Paginator is for top-level projects only

  # (subprojects belong to them)

  def index

    respond_to do |format|

      format.html {

        sort_init 'name'

        sort_update %w(name lft created_on updated_on)

        @limit = per_page_option

        @project_count = Project.visible_roots.count

        @project_pages = Paginator.new self, @project_count, @limit, params['page']

        @offset ||= @project_pages.current.offset

        @projects = Project.visible_roots.all(:offset => @offset, :limit => @limit, :order => sort_clause)

        if User.current.logged?

          # seems sort_by gives us case-sensitive ordering, which we don't want

#          @user_projects = User.current.projects.sort_by(&:name)

          @user_projects = User.current.projects.all(:order => :name)

        end

        render :template => 'projects/index.html.erb', :layout => !request.xhr?

      }

      format.api  {

        @offset, @limit = api_offset_and_limit

        @project_count = Project.visible.count

        @projects = Project.visible.all(:offset => @offset, :limit => @limit, :order => 'lft')

      }

      format.atom {

        projects = Project.visible.find(:all, :order => 'created_on DESC',

                                              :limit => Setting.feeds_limit.to_i)

        render_feed(projects, :title => "#{Setting.app_title}: #{l(:label_project_latest)}")

      }

    end

  end

  # A different view of projects using explore boxes

  def explore

    respond_to do |format|

      format.html {

        @projects = Project.visible

        render :template => 'projects/explore.html.erb', :layout => !request.xhr?

      }

    end

  end

  def new

    @issue_custom_fields = IssueCustomField.find(:all, :order => "#{CustomField.table_name}.position")

    @trackers = Tracker.all

    @project = Project.new

    @project.safe_attributes = params[:project]

  end

  verify :method => :post, :only => :create, :render => {:nothing => true, :status => :method_not_allowed }

  def create

    @issue_custom_fields = IssueCustomField.find(:all, :order => "#{CustomField.table_name}.position")

    @trackers = Tracker.all

    @project = Project.new

    @project.safe_attributes = params[:project]

    # todo: luisf: this should be removed from here...

    if params && params[:project] && !params[:project][:tag_list].nil?

      new_tags = params[:project][:tag_list].to_s.downcase

      @project.tag_list = ActionController::Base.helpers.strip_tags(new_tags)

    end

    # end of code to be removed

    if validate_is_public_key && validate_parent_id && @project.save

      @project.set_allowed_parent!(params[:project]['parent_id']) if params[:project].has_key?('parent_id')

      # Add current user as a project member if he is not admin

      unless User.current.admin?

        r = Role.givable.find_by_id(Setting.new_project_user_role_id.to_i) || Role.givable.first

        m = Member.new(:user => User.current, :roles => [r])

        @project.members << m

      end

      respond_to do |format|

        format.html {

          flash[:notice] = l(:notice_successful_create)

          redirect_to(params[:continue] ?

            {:controller => 'projects', :action => 'new', :project => {:parent_id => @project.parent_id}.reject {|k,v| v.nil?}} :

            {:controller => 'projects', :action => 'settings', :id => @project}

          )

        }

        format.api  { render :action => 'show', :status => :created, :location => url_for(:controller => 'projects', :action => 'show', :id => @project.id) }

      end

    else

      respond_to do |format|

        format.html { render :action => 'new' }

        format.api  { render_validation_errors(@project) }

      end

    end

  end

  def copy

    @issue_custom_fields = IssueCustomField.find(:all, :order => "#{CustomField.table_name}.position")

    @trackers = Tracker.all

    @root_projects = Project.find(:all,

                                  :conditions => "parent_id IS NULL AND status = #{Project::STATUS_ACTIVE}",

                                  :order => 'name')

    @source_project = Project.find(params[:id])

    if request.get?

      @project = Project.copy_from(@source_project)

      if @project

        @project.identifier = Project.next_identifier if Setting.sequential_project_identifiers?

      else

        redirect_to :controller => 'admin', :action => 'projects'

      end

    else

      Mailer.with_deliveries(params[:notifications] == '1') do

        @project = Project.new

        @project.safe_attributes = params[:project]

        if validate_parent_id && @project.copy(@source_project, :only => params[:only])

          @project.set_allowed_parent!(params[:project]['parent_id']) if params[:project].has_key?('parent_id')

          flash[:notice] = l(:notice_successful_create)

          redirect_to :controller => 'projects', :action => 'settings', :id => @project

        elsif !@project.new_record?

          # Project was created

          # But some objects were not copied due to validation failures

          # (eg. issues from disabled trackers)

          # TODO: inform about that

          redirect_to :controller => 'projects', :action => 'settings', :id => @project

        end

      end

    end

  rescue ActiveRecord::RecordNotFound

    redirect_to :controller => 'admin', :action => 'projects'

  end

  # Show @project

  def show

    if params[:jump]

      # try to redirect to the requested menu item

      redirect_to_project_menu_item(@project, params[:jump]) && return

    end

    @users_by_role = @project.users_by_role

    @subprojects = @project.children.visible.all

    @news = @project.news.find(:all, :limit => 5, :include => [ :author, :project ], :order => "#{News.table_name}.created_on DESC")

    @trackers = @project.rolled_up_trackers

    cond = @project.project_condition(Setting.display_subprojects_issues?)

    @open_issues_by_tracker = Issue.visible.count(:group => :tracker,

                                            :include => [:project, :status, :tracker],

                                            :conditions => ["(#{cond}) AND #{IssueStatus.table_name}.is_closed=?", false])

    @total_issues_by_tracker = Issue.visible.count(:group => :tracker,

                                            :include => [:project, :status, :tracker],

                                            :conditions => cond)

    if User.current.allowed_to?(:view_time_entries, @project)

      @total_hours = TimeEntry.visible.sum(:hours, :include => :project, :conditions => cond).to_f

    end

    @key = User.current.rss_key

    respond_to do |format|

      format.html

      format.api

    end

  end

  def settings

    @issue_custom_fields = IssueCustomField.find(:all, :order => "#{CustomField.table_name}.position")

    @issue_category ||= IssueCategory.new

    @member ||= @project.members.new

    @trackers = Tracker.all

    @repository ||= @project.repository

    @wiki ||= @project.wiki

  end

  def edit

  end

  # TODO: convert to PUT only

  verify :method => [:post, :put], :only => :update, :render => {:nothing => true, :status => :method_not_allowed }

  def update

    @project.safe_attributes = params[:project]

    if validate_parent_id && @project.save

      @project.set_allowed_parent!(params[:project]['parent_id']) if params[:project].has_key?('parent_id')

      respond_to do |format|

        format.html {

          flash[:notice] = l(:notice_successful_update)

          redirect_to :action => 'settings', :id => @project

        }

        format.api  { head :ok }

      end

    else

      respond_to do |format|

        format.html {

          settings

          render :action => 'settings'

        }

        format.api  { render_validation_errors(@project) }

      end

    end

  end

  verify :method => :post, :only => :modules, :render => {:nothing => true, :status => :method_not_allowed }

  def overview

    @project.has_welcome_page = params[:has_welcome_page]

    if @project.save

      flash[:notice] = l(:notice_successful_update)

    end

    redirect_to :action => 'settings', :id => @project, :tab => 'overview'

  end

  def modules

    @project.enabled_module_names = params[:enabled_module_names]

    flash[:notice] = l(:notice_successful_update)

    redirect_to :action => 'settings', :id => @project, :tab => 'modules'

  end

  def archive

    if request.post?

      unless @project.archive

        flash[:error] = l(:error_can_not_archive_project)

      end

    end

    redirect_to(url_for(:controller => 'admin', :action => 'projects', :status => params[:status]))

  end

  def unarchive

    @project.unarchive if request.post? && !@project.active?

    redirect_to(url_for(:controller => 'admin', :action => 'projects', :status => params[:status]))

  end

  # Delete @project

  def destroy

    @project_to_destroy = @project

    if request.get?

      # display confirmation view

    else

      if api_request? || params[:confirm]

        @project_to_destroy.destroy

        respond_to do |format|

          format.html { redirect_to :controller => 'admin', :action => 'projects' }

          format.api  { head :ok }

        end

      end

    end

    # hide project in layout

    @project = nil

  end

private

  def find_optional_project

    return true unless params[:id]

    @project = Project.find(params[:id])

    authorize

  rescue ActiveRecord::RecordNotFound

    render_404

  end

  def validate_is_public_key

    # Although is_public isn't mandatory in the project model (it gets

    # defaulted), it must be present in params -- it can be true or

    # false, but it must be there. This permits us to make forms in

    # which the user _has_ to select public or private (rather than

    # defaulting it) if we want to

    if params.nil? || params[:project].nil? || !params[:project].has_key?(:is_public)

      @project.errors.add :is_public, :public_or_private

      return false

    end

    true

  end

  # Validates parent_id param according to user's permissions

  # TODO: move it to Project model in a validation that depends on User.current

  def validate_parent_id

    return true if User.current.admin?

    parent_id = params[:project] && params[:project][:parent_id]

    if parent_id || @project.new_record?

      parent = parent_id.blank? ? nil : Project.find_by_id(parent_id.to_i)

      unless @project.allowed_parents.include?(parent)

        @project.errors.add :parent_id, :invalid

        return false

      end

    end

    true

  end

end