openproject/app/controllers/api/v2/projects_controller.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2017 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2017 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# 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.
#
# See doc/COPYRIGHT.rdoc for more details.
#++

module Api
  module V2
    class ProjectsController < ::ProjectsController
      include ::Api::V2::ApiController

      before_action :find_project, except: [:index, :level_list]
      before_action :authorize, only: :show
      before_action :require_permissions, only: :planning_element_custom_fields

      def self.accept_key_auth_actions
        super + ['planning_element_custom_fields']
      end

      def index
        @projects = @base.visible
                         .includes(:types)
                         .order('lft')

        if params[:ids]
          @projects = @projects.where(ids_statement)
        end

        @projects_by_id = Hash[@projects.map { |p| [p.id, p] }]

        build_associations unless @projects.empty?

        respond_to do |format|
          format.api
        end
      end

      def show
        respond_to do |format|
          format.api
        end
      end

      def level_list
        @projects = Project.project_level_list(Project.visible)

        respond_to do |format|
          format.api
        end
      end

      def planning_element_custom_fields
        @custom_fields = @project.all_work_package_custom_fields include: [:projects, :types]

        respond_to do |format|
          format.api
        end
      end

      protected

      def find_project
        @project = Project
                   .includes(custom_values: :custom_field)
                   .find params[:id]
      end

      def build_associations
        association_attributes = ProjectAssociation.with_projects(@projects_by_id.keys)
                                 .map(&:attributes)

        associations = association_attributes.map { |attributes| OpenStruct.new(attributes) }

        @associations_by_id = {}
        associations.each do |a|
          @associations_by_id[a.project_a_id] ||= []
          @associations_by_id[a.project_a_id] << a

          @associations_by_id[a.project_b_id] ||= []
          @associations_by_id[a.project_b_id] << a
        end
      end

      # Helpers
      helper_method :has_associations?
      helper_method :associations_for_project

      def has_associations?(project)
        @associations_by_id[project.id].present?
      end

      def associations_for_project(project)
        @associations_by_id[project.id]
      end

      def require_permissions
        deny_access unless @project.visible?
      end

      def ids_statement
        ids, identifiers = params[:ids].split(/,/).map(&:strip).partition { |s| s =~ /\A\d*\z/ }

        projects_table = Project.arel_table

        projects_table[:id].in(ids).or(projects_table[:identifier].in(identifiers))
      end
    end
  end
end