openproject/db/migrate/20141215104802_migrate_attachments_to_carrier_wave.rb

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2015 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-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 doc/COPYRIGHT.rdoc for more details.
#++

class MigrateAttachmentsToCarrierWave < ActiveRecord::Migration
  def up
    add_column_if_missing :attachments, :file, :string

    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.connection.schema_cache.clear!
    Attachment.reset_column_information # make sure new column is visible

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

    puts 'Attachment migration complete.'
  end

  def down
    count = Attachment.count

    puts "Rolling back #{count} attachments from CarrierWave to legacy file-based storage."
    puts 'Depending on your configuration this can take a while.
          Especially if files are downloaded from S3.'.squish

    Attachment.all.each_with_index do |attachment, i|
      puts "Migrating attachment #{i + 1}/#{count} (#{attachment.file.path})"
      rollback_attachment attachment
    end

    remove_column :attachments, :file
  end

  ##
  # Adds a column to the a table unless the column already exists.
  def add_column_if_missing(table, column, type)
    add_column table, column, type unless column_exists?(table, column, type)
  end

  ##
  # In the olden times (pre 4.1) files were all saved under the configured storage path,
  # most likely `files`, with a timestamp attached to their name to avoid conflicts.
  #
  # e.g. `files/140917231758_openshift-setup.txt`
  #
  # The new approach is using CarrierWave for attachments. There the files will be stored
  # some place else. Where is not material for this migration.
  # It could be another directory or S3.
  #
  # The migration does the following:
  #
  # * rename the legacy files - it strips off the timestamps
  # * assign the renamed file to the CarrierWave uploader - this moves the file to
  #   the new location
  #
  # The rollback does the opposite using the remaining legacy column `disk_filename`
  # of Attachment. Meaning it adds the timestamp again and puts the files back into
  # the configured attachment storage path.
  #
  # This assumes that the attachment storage path is the same as before the migration
  # to CarrierWave and also that the legacy columns `filename` and `disk_filename`
  # are still present.
  module LegacyAttachment
    def migrate_attachment(attachment)
      file = legacy_file_name attachment.disk_filename
      new_file = strip_timestamp_from_filename(file)

      if File.readable? file
        FileUtils.move file, new_file
        attachment.file = File.open(new_file)
        attachment.filename = ''
        attachment.save!

        FileUtils.rm_f new_file

        File.readable? attachment.file.path
      else
        path = attachment.file.path
        if path && File.readable?(path)
          true # file has been migrated already
        else
          puts "Found corrupt attachment (#{attachment.id}) during migration: \
                '#{file}' does not exist".squish
          false
        end
      end
    end

    def rollback_attachment(attachment)
      return unless attachment.file.path

      old_file = rolled_back_file_name attachment

      unless File.readable? old_file
        file = attachment.diskfile.path

        FileUtils.move file, old_file
        attachment.update_column :file, nil
        attachment.update_column :filename, Pathname(file).basename.to_s

        # keep original disk filename if it was preserved
        if attachment.disk_filename.blank?
          attachment.update_column :disk_filename, Pathname(old_file).basename.to_s
        end

        FileUtils.rmdir Pathname(file).dirname
      end
    end

    ##
    # Returns rolled back file name for an attachment.
    # If an attachment was created after the migration to CarrierWave it doesn't have an original
    # legacy name. Instead one will be generated. Not with a timestamp, however, but with a
    # random hex string as a prefix.
    #
    # This way new attachments won't be lost when rolling back to an old version of OpenProject.
    def rolled_back_file_name(attachment)
      if attachment.disk_filename.blank?
        uuid = SecureRandom.hex 4
        name = Pathname(attachment.diskfile.path).basename
        legacy_file_name "#{uuid}_#{name}"
      else
        legacy_file_name attachment.disk_filename
      end
    end

    def legacy_file_name(file_name)
      Pathname(OpenProject::Configuration.attachments_storage_path).join file_name
    end

    ##
    # This method strips the leading timestamp from a given file name and returns the plain,
    # original file name.
    def strip_timestamp_from_filename(file)
      Pathname(file).dirname + Pathname(file).basename.to_s.gsub(/^[^_]+_/, '')
    end
  end

  include LegacyAttachment
end