openproject/lib/api/v3/backups/backups_api.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# 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-2013 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 docs/COPYRIGHT.rdoc for more details.
#++

module API
  module V3
    module Backups
      class BackupsAPI < ::API::OpenProjectAPI
        resources :backups do
          before do
            raise API::Errors::NotFound unless OpenProject::Configuration.backup_enabled?
          end

          after_validation do
            authorize Backup.permission, global: true
          end

          params do
            requires :backupToken, type: String

            optional(
              :attachments,
              type: Boolean,
              default: true,
              desc: 'Whether or not to include attachments (default: true)'
            )
          end
          post do
            service = ::Backups::CreateService.new(
              user: current_user,
              backup_token: params[:backupToken],
              include_attachments: params[:attachments]
            )
            call = service.call

            if call.failure?
              errors = call.errors.errors

              if err = errors.find { |e| e.type == :invalid_token || e.type == :token_cooldown }
                fail ::API::Errors::Unauthorized, message: err.full_message
              elsif err = errors.find { |e| e.type == :backup_pending }
                fail ::API::Errors::Conflict, message: err.full_message
              elsif err = errors.find { |e| e.type == :limit_reached }
                fail ::API::Errors::TooManyRequests, message: err.full_message
              end

              fail ::API::Errors::ErrorBase.create_and_merge_errors(call.errors)
            end

            status 202

            BackupRepresenter.new call.result, current_user: current_user
          end
        end
      end
    end
  end
end