Class: ProjectsController

Inherits:
ApplicationController show all
Includes:
ProjectsQueriesHelper, QueriesHelper
Defined in:
app/controllers/projects_controller.rb

Overview

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

Constant Summary

Constants included from ApplicationHelper

ApplicationHelper::ATTACHMENT_CONTAINER_LINK, ApplicationHelper::HEADING_RE, ApplicationHelper::LINKS_RE, ApplicationHelper::MACROS_RE, ApplicationHelper::MACRO_SUB_RE, ApplicationHelper::RECORD_LINK, ApplicationHelper::TOC_RE

Instance Method Summary collapse

Methods included from ProjectsQueriesHelper

#column_value, #csv_value

Methods included from ApplicationHelper

#accesskey, #actions_dropdown, #anchor, #api_meta, #authoring, #authorize_for, #autocomplete_data_sources, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #bulk_edit_error_messages, #calendar_for, #cancel_button_tag, #catch_macros, #check_all_links, #checked_image, #context_menu, #copy_object_url_link, #default_search_project_scope, #delete_link, #due_date_distance_in_words, #email_delivery_enabled?, #error_messages_for, #export_csv_encoding_select_tag, #favicon, #favicon_path, #favicon_url, #form_tag_html, #format_activity_day, #format_activity_description, #format_activity_title, #format_changeset_comments, #format_object, #format_version_name, #get_tab_action, #heads_for_auto_complete, #html_hours, #html_title, #image_tag, #include_calendar_headers_tags, #include_in_api_response?, #inject_macros, #javascript_heads, #javascript_include_tag, #labelled_fields_for, #labelled_form_for, #lang_options_for_select, #link_to_attachment, #link_to_attachment_container, #link_to_context_menu, #link_to_function, #link_to_group, #link_to_if_authorized, #link_to_issue, #link_to_message, #link_to_month, #link_to_next_month, #link_to_previous_month, #link_to_project, #link_to_project_settings, #link_to_record, #link_to_revision, #link_to_user, #link_to_version, #option_tag, #other_formats_links, #page_header_title, #parse_headings, #parse_hires_images, #parse_inline_attachments, #parse_non_pre_blocks, #parse_redmine_links, #parse_sections, #parse_wiki_links, #principals_check_box_tags, #principals_options_for_select, #progress_bar, #project_tree, #project_tree_options_for_select, #projects_for_jump_box, #raw_json, #render_error_messages, #render_flash_messages, #render_if_exist, #render_page_hierarchy, #render_project_jump_box, #render_project_nested_lists, #render_projects_for_jump_box, #render_tabs, #reorder_handle, #replace_toc, #robot_exclusion_tag, #sanitize_anchor_name, #sidebar_content?, #simple_format_without_paragraph, #stylesheet_link_tag, #syntax_highlight, #syntax_highlight_lines, #textilizable, #thumbnail_tag, #time_tag, #title, #to_path_param, #toggle_checkboxes_link, #toggle_link, #truncate_lines, #truncate_single_line_raw, #view_layouts_base_sidebar_hook_response, #wiki_page_path

Methods included from Redmine::Helpers::URL

#uri_with_safe_scheme?

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Themes::Helper

#current_theme, #heads_for_theme

Methods included from Redmine::SudoMode::Helper

#hash_to_hidden_fields

Methods included from Redmine::Pagination::Helper

#pagination_links_each, #pagination_links_full, #per_page_links, #per_page_options

Methods included from Redmine::I18n

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

Methods included from Redmine::WikiFormatting::Macros::Definitions

#exec_macro, #extract_macro_options, #macro_exists?

Methods included from QueriesHelper

#available_block_columns_tags, #available_display_types_tags, #available_totalable_columns_tags, #column_content, #column_header, #column_value, #csv_content, #csv_value, #filters_options_for_select, #group_by_column_select_tag, #grouped_query_results, #link_to_clear_query, #query_as_hidden_field_tags, #query_available_inline_columns_options, #query_columns_hidden_tags, #query_filters_hidden_tags, #query_hidden_sort_tag, #query_hidden_tags, #query_links, #query_selected_inline_columns_options, #query_to_csv, #render_query_columns_selection, #render_query_totals, #render_sidebar_queries, #retrieve_query, #retrieve_query_from_session, #sidebar_queries, #total_tag

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, #check_twofa_activation, #deny_access, #filename_for_content_disposition, #find_attachments, #find_current_user, #find_issue, #find_issues, #find_model_object, #find_optional_project, #find_optional_project_by_id, #find_project, #find_project_by_project_id, #find_project_from_association, #handle_unverified_request, #init_twofa_pairing_and_send_code_for, #logged_user=, #logout_user, #missing_template, model_object, #parse_params_for_bulk_update, #parse_qvalues, #per_page_option, #query_error, #query_statement_invalid, #record_project_usage, #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, included, #menu_items, #redirect_to_menu_item, #redirect_to_project_menu_item

Methods included from Redmine::Search::Controller

#default_search_scope, #default_search_scopes, included

Methods included from AvatarsHelper

#assignee_avatar, #author_avatar, #avatar, #avatar_edit_link

Methods included from GravatarHelper::PublicMethods

#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url

Methods included from RoutesHelper

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

Methods included from Redmine::Pagination

#paginate, #paginator

Instance Method Details

#archiveObject


234
235
236
237
238
239
# File 'app/controllers/projects_controller.rb', line 234

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


84
85
86
87
88
89
90
91
92
93
94
# File 'app/controllers/projects_controller.rb', line 84

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

#bookmarkObject


248
249
250
251
252
253
254
255
256
257
258
259
# File 'app/controllers/projects_controller.rb', line 248

def bookmark
  jump_box = Redmine::ProjectJumpBox.new User.current
  if request.delete?
    jump_box.delete_project_bookmark @project
  elsif request.post?
    jump_box.bookmark_project @project
  end
  respond_to do |format|
    format.js
    format.html {redirect_to project_path(@project)}
  end
end

#closeObject


261
262
263
264
# File 'app/controllers/projects_controller.rb', line 261

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

#copyObject


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

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


103
104
105
106
107
108
109
110
111
112
113
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
# File 'app/controllers/projects_controller.rb', line 103

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 do
        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
      end
      format.api do
        render(
          :action => 'show',
          :status => :created,
          :location => url_for(:controller => 'projects',
                               :action => 'show', :id => @project.id)
        )
      end
    end
  else
    respond_to do |format|
      format.html {render :action => 'new'}
      format.api  {render_validation_errors(@project)}
    end
  end
end

#destroyObject

Delete @project


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'app/controllers/projects_controller.rb', line 272

def destroy
  unless @project.deletable?
    deny_access
    return
  end

  @project_to_destroy = @project
  if api_request? || params[:confirm] == @project_to_destroy.identifier
    @project_to_destroy.destroy
    respond_to do |format|
      format.html do
        redirect_to(
          User.current.admin? ? admin_projects_path : projects_path
        )
      end
      format.api  {render_api_ok}
    end
  end
  # hide project in layout
  @project = nil
end

#editObject


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

def edit
end

#indexObject

Lists visible projects


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'app/controllers/projects_controller.rb', line 47

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

  retrieve_project_query
  scope = project_scope

  respond_to do |format|
    format.html do
      # TODO: see what to do with the board view and pagination
      if @query.display_type == 'board'
        @entries = scope.to_a
      else
        @entry_count = scope.count
        @entry_pages = Paginator.new @entry_count, per_page_option, params['page']
        @entries = scope.offset(@entry_pages.offset).limit(@entry_pages.per_page).to_a
      end
    end
    format.api do
      @offset, @limit = api_offset_and_limit
      @project_count = scope.count
      @projects = scope.offset(@offset).limit(@limit).to_a
    end
    format.atom do
      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
    format.csv do
      # Export all entries
      @entries = scope.to_a
      send_data(query_to_csv(@entries, @query, params), :type => 'text/csv; header=present', :filename => 'projects.csv')
    end
  end
end

#newObject


96
97
98
99
100
101
# File 'app/controllers/projects_controller.rb', line 96

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

#reopenObject


266
267
268
269
# File 'app/controllers/projects_controller.rb', line 266

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

#settingsObject


199
200
201
202
203
204
205
206
207
208
# File 'app/controllers/projects_controller.rb', line 199

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).sorted
end

#showObject

Show @project


169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# File 'app/controllers/projects_controller.rb', line 169

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

  @principals_by_role = @project.principals_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
  with_subprojects = Setting.display_subprojects_issues?
  @trackers = @project.rolled_up_trackers(with_subprojects).visible

  cond = @project.project_condition(with_subprojects)

  @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
    @total_estimated_hours = Issue.visible.where(cond).sum(:estimated_hours).to_f
  end

  @key = User.current.rss_key

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

#unarchiveObject


241
242
243
244
245
246
# File 'app/controllers/projects_controller.rb', line 241

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

#updateObject


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'app/controllers/projects_controller.rb', line 213

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