Class: ProjectsController

Inherits:
ApplicationController show all
Defined in:
app/controllers/projects_controller.rb

Overview

Redmine - project management software Copyright (C) 2006-2017 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.

Since:

  • 0.4.0

Instance Method Summary collapse

Methods inherited from ApplicationController

#_include_layout?, accept_api_auth, #accept_api_auth?, accept_rss_auth, #accept_rss_auth?, #api_key_from_request, #api_offset_and_limit, #api_request?, #api_switch_user_from_request, #authorize, #authorize_global, #autologin_cookie_name, #back_url, #check_if_login_required, #check_password_change, #check_project_privacy, #deny_access, #filename_for_content_disposition, #find_attachments, #find_current_user, #find_issue, #find_issues, #find_model_object, #find_optional_project, #find_project, #find_project_by_project_id, #find_project_from_association, #handle_unverified_request, #logged_user=, #logout_user, #missing_template, model_object, #parse_params_for_bulk_update, #parse_qvalues, #per_page_option, #query_statement_invalid, #redirect_back_or_default, #redirect_to_referer_or, #render_403, #render_404, #render_api_errors, #render_api_head, #render_api_ok, #render_attachment_warning_if_needed, #render_error, #render_feed, #render_validation_errors, #require_admin, #require_admin_or_api_request, #require_login, #session_expiration, #session_expired?, #set_localization, #start_user_session, #try_to_autologin, #use_layout, #user_setup, #verify_authenticity_token

Methods included from Redmine::SudoMode::Controller

#process_sudo_form, #render_sudo_form, #require_sudo_mode, #sudo_mode, #sudo_timestamp_valid?, #update_sudo_timestamp!

Methods included from Redmine::MenuManager::MenuController

#current_menu, #current_menu_item, #menu_items, #redirect_to_menu_item, #redirect_to_project_menu_item

Methods included from Redmine::Search::Controller

#default_search_scope, #default_search_scopes

Methods included from RoutesHelper

#_new_project_issue_path, #_new_time_entry_path, #_project_calendar_path, #_project_gantt_path, #_project_issues_path, #_project_news_path, #_report_time_entries_path, #_time_entries_path, #board_path

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Pagination

#paginate, #paginator

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #set_language_if_valid, #valid_languages

Instance Method Details

#archiveObject

Since:

  • 0.5.1



213
214
215
216
217
218
# File 'app/controllers/projects_controller.rb', line 213

def archive
  unless @project.archive
    flash[:error] = l(:error_can_not_archive_project)
  end
  redirect_to_referer_or admin_projects_path(:status => params[:status])
end

#autocompleteObject

Since:

  • 3.4.0



65
66
67
68
69
70
71
72
73
74
75
# File 'app/controllers/projects_controller.rb', line 65

def autocomplete
  respond_to do |format|
    format.js {
      if params[:q].present?
        @projects = Project.visible.like(params[:q]).to_a
      else
        @projects = User.current.projects.to_a
      end
    }
  end
end

#closeObject

Since:

  • 2.1.0



227
228
229
230
# File 'app/controllers/projects_controller.rb', line 227

def close
  @project.close
  redirect_to project_path(@project)
end

#copyObject

Since:

  • 0.9.0



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'app/controllers/projects_controller.rb', line 114

def copy
  @issue_custom_fields = IssueCustomField.sorted.to_a
  @trackers = Tracker.sorted.to_a
  @source_project = Project.find(params[:id])
  if request.get?
    @project = Project.copy_from(@source_project)
    @project.identifier = Project.next_identifier if Setting.sequential_project_identifiers?
  else
    Mailer.with_deliveries(params[:notifications] == '1') do
      @project = Project.new
      @project.safe_attributes = params[:project]
      if @project.copy(@source_project, :only => params[:only])
        flash[:notice] = l(:notice_successful_create)
        redirect_to settings_project_path(@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 settings_project_path(@project)
      end
    end
  end
rescue ActiveRecord::RecordNotFound
  # source_project not found
  render_404
end

#createObject

Since:

  • 1.0.2



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'app/controllers/projects_controller.rb', line 84

def create
  @issue_custom_fields = IssueCustomField.sorted.to_a
  @trackers = Tracker.sorted.to_a
  @project = Project.new
  @project.safe_attributes = params[:project]

  if @project.save
    unless User.current.admin?
      @project.add_default_member(User.current)
    end
    respond_to do |format|
      format.html {
        flash[:notice] = l(:notice_successful_create)
        if params[:continue]
          attrs = {:parent_id => @project.parent_id}.reject {|k,v| v.nil?}
          redirect_to new_project_path(attrs)
        else
          redirect_to settings_project_path(@project)
        end
      }
      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

#destroyObject

Delete @project



238
239
240
241
242
243
244
245
246
247
248
249
# File 'app/controllers/projects_controller.rb', line 238

def destroy
  @project_to_destroy = @project
  if api_request? || params[:confirm]
    @project_to_destroy.destroy
    respond_to do |format|
      format.html { redirect_to admin_projects_path }
      format.api  { render_api_ok }
    end
  end
  # hide project in layout
  @project = nil
end

#editObject



183
184
# File 'app/controllers/projects_controller.rb', line 183

def edit
end

#indexObject

Lists visible projects



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'app/controllers/projects_controller.rb', line 38

def index
  # try to redirect to the requested menu item
  if params[:jump] && redirect_to_menu_item(params[:jump])
    return
  end

  scope = Project.visible.sorted

  respond_to do |format|
    format.html {
      unless params[:closed]
        scope = scope.active
      end
      @projects = scope.to_a
    }
    format.api  {
      @offset, @limit = api_offset_and_limit
      @project_count = scope.count
      @projects = scope.offset(@offset).limit(@limit).to_a
    }
    format.atom {
      projects = scope.reorder(:created_on => :desc).limit(Setting.feeds_limit.to_i).to_a
      render_feed(projects, :title => "#{Setting.app_title}: #{l(:label_project_latest)}")
    }
  end
end

#modulesObject

Deprecated.

Removed at 4.0.0

Since:

  • 0.6.0



207
208
209
210
211
# File 'app/controllers/projects_controller.rb', line 207

def modules
  @project.enabled_module_names = params[:enabled_module_names]
  flash[:notice] = l(:notice_successful_update)
  redirect_to settings_project_path(@project, :tab => 'modules')
end

#newObject

Since:

  • 1.0.2



77
78
79
80
81
82
# File 'app/controllers/projects_controller.rb', line 77

def new
  @issue_custom_fields = IssueCustomField.sorted.to_a
  @trackers = Tracker.sorted.to_a
  @project = Project.new
  @project.safe_attributes = params[:project]
end

#reopenObject

Since:

  • 2.1.0



232
233
234
235
# File 'app/controllers/projects_controller.rb', line 232

def reopen
  @project.reopen
  redirect_to project_path(@project)
end

#settingsObject



171
172
173
174
175
176
177
178
179
180
181
# File 'app/controllers/projects_controller.rb', line 171

def settings
  @issue_custom_fields = IssueCustomField.sorted.to_a
  @issue_category ||= IssueCategory.new
  @member ||= @project.members.new
  @trackers = Tracker.sorted.to_a

  @version_status = params[:version_status] || 'open'
  @version_name = params[:version_name]
  @versions = @project.shared_versions.status(@version_status).like(@version_name)
  @wiki ||= @project.wiki || Wiki.new(:project => @project)
end

#showObject

Show @project



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'app/controllers/projects_controller.rb', line 143

def show
  # try to redirect to the requested menu item
  if params[:jump] && redirect_to_project_menu_item(@project, params[:jump])
    return
  end

  @users_by_role = @project.users_by_role
  @subprojects = @project.children.visible.to_a
  @news = @project.news.limit(5).includes(:author, :project).reorder("#{News.table_name}.created_on DESC").to_a
  @trackers = @project.rolled_up_trackers.visible

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

  @open_issues_by_tracker = Issue.visible.open.where(cond).group(:tracker).count
  @total_issues_by_tracker = Issue.visible.where(cond).group(:tracker).count

  if User.current.allowed_to_view_all_time_entries?(@project)
    @total_hours = TimeEntry.visible.where(cond).sum(:hours).to_f
  end

  @key = User.current.rss_key

  respond_to do |format|
    format.html
    format.api
  end
end

#unarchiveObject

Since:

  • 0.5.1



220
221
222
223
224
225
# File 'app/controllers/projects_controller.rb', line 220

def unarchive
  unless @project.active?
    @project.unarchive
  end
  redirect_to_referer_or admin_projects_path(:status => params[:status])
end

#updateObject

Since:

  • 1.0.2



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'app/controllers/projects_controller.rb', line 186

def update
  @project.safe_attributes = params[:project]
  if @project.save
    respond_to do |format|
      format.html {
        flash[:notice] = l(:notice_successful_update)
        redirect_to settings_project_path(@project)
      }
      format.api  { render_api_ok }
    end
  else
    respond_to do |format|
      format.html {
        settings
        render :action => 'settings'
      }
      format.api  { render_validation_errors(@project) }
    end
  end
end