openproject/lib/tasks/attachment_migrations.rake

#-- encoding: UTF-8
#-- 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.
#++

require_relative 'shared/user_feedback'

require 'tasks/shared/legacy_attachment'
require 'tasks/shared/attachment_migration'

module Migrations
  ##
  # We create a separate classes as this is most likely to be used during
  # the migration of an ChiliProject (2.x or 3.x) which lacks a couple
  # of columns models have in OpenProject >6.
  module Attachments
    class CurrentWikiPage < ::ActiveRecord::Base
      self.table_name = "wiki_pages"

      has_one :content, class_name: 'WikiContent', foreign_key: 'page_id', dependent: :destroy
    end

    class CurrentWikiContent < ::ActiveRecord::Base
      self.table_name = "wiki_contents"
    end
  end
end

namespace :migrations do
  namespace :attachments do
    include ::Tasks::Shared::UserFeedback
    include ::Tasks::Shared::AttachmentMigration

    desc 'Removes all attachments from versions and projects'
    task delete_from_projects_and_versions: :environment do |_task|
      try_delete_attachments_from_projects_and_versions
    end

    desc 'Creates special wiki pages for each project and version moving the attachments there.'
    task move_to_wiki: :environment do |_task|
      Project.transaction do
        if Journal.count > 0
          raise(
            "Expected there to be no existing journals at this point before " +
            "the legacy journal migration. Aborting."
          )
        end

        move_obsolete_attachments_to_wiki!
      end
    end

    desc 'Moves old attachment files to their correct new path under carrierwave.'
    task move_old_files: :environment do |_task|
      count = Attachment.count

      puts "Migrating #{count} attachments to CarrierWave."
      puts 'Depending on your configuration this can take a while.
            Especially if files are uploaded to S3.'.squish

      Attachment.all.each_with_index do |attachment, i|
        puts "Migrating attachment #{i + 1}/#{count} (#{attachment.disk_filename})"
        Tasks::Shared::LegacyAttachment.migrate_attachment attachment
      end
    end
  end
end