redmine-installer 1.0.0

data/lib/redmine-installer/steps/base.rb

@@ -0,0 +1,60 @@
+module Redmine::Installer::Step
+  class Base
+
+    include Redmine::Installer::Utils
+
+    attr_accessor :index
+    attr_accessor :base
+    attr_accessor :ran
+
+    def initialize(index, base)
+      self.index = index
+      self.base = base
+      self.ran = false
+    end
+
+    def print_title
+      title  = '<bright><on_black><white>'
+      title << "#{index}. "
+      title << translate("step.#{self.class.class_name.underscore}.title"
+        )
+      title <<'</white></on_black></bright>'
+
+      say(title, 1)
+    end
+
+    def print_header
+    end
+
+    def print_footer
+    end
+
+    def final_step
+    end
+
+    def up
+    end
+
+    def down
+    end
+
+    def save(*)
+    end
+
+    def load(*)
+    end
+
+    def redmine_plugins
+      @redmine_plugins ||= _redmine_plugins
+    end
+
+    private
+
+      def _redmine_plugins
+        Dir.glob(File.join(base.redmine_root, 'plugins', '*')).select do |entry|
+          File.directory?(entry)
+        end
+      end
+
+  end
+end

data/lib/redmine-installer/steps/database_config.rb

@@ -0,0 +1,15 @@
+module Redmine::Installer::Step
+  class DatabaseConfig < Base
+
+    include Redmine::Installer::Helper::GenerateConfig
+
+    def up
+      if create_for(plugin::Database)
+        # continue
+      else
+        base.settings[:skip_migration] = true
+      end
+    end
+
+  end
+end

data/lib/redmine-installer/steps/email_config.rb

@@ -0,0 +1,11 @@
+module Redmine::Installer::Step
+  class EmailConfig < Base
+
+    include Redmine::Installer::Helper::GenerateConfig
+
+    def up
+      create_for(plugin::EmailSending)
+    end
+
+  end
+end

data/lib/redmine-installer/steps/install.rb

@@ -0,0 +1,21 @@
+module Redmine::Installer::Step
+  class Install < Base
+
+    def up
+      Dir.chdir(base.tmp_redmine_root) do
+        command.bundle_install(base.env)
+
+        return if base.settings[:skip_migration]
+
+        command.rake_db_create(base.env)
+        command.rake_db_migrate(base.env)
+        command.rake_redmine_plugin_migrate(base.env) if some_plugins?
+        command.rake_generate_secret_token(base.env)
+
+        # Other plugins can have post-install procedure
+        plugin::RedminePlugin.all.each(&:install)
+      end
+    end
+
+  end
+end

data/lib/redmine-installer/steps/load_package.rb

@@ -0,0 +1,180 @@
+require 'rubygems/package'
+require 'ruby-progressbar'
+require 'fileutils'
+require 'zip'
+require 'tmpdir'
+require 'zlib'
+
+module Redmine::Installer::Step
+  class LoadPackage < Base
+
+    SUPPORTED_ARCHIVE_FORMATS = ['.zip', '.gz', '.tgz']
+    TAR_LONGLINK = '././@LongLink'
+    PROGRESSBAR_FORMAT = '%a [%b>%i] %p%% %t'
+
+    def up
+      case base.options[:source]
+      when 'file'
+        load_file
+      when 'git'
+        load_git
+      else
+        error :error_unsupported_source, source: base.options[:source]
+      end
+    end
+
+    def final_step
+      # Delete tmp_redmine_root
+      FileUtils.remove_entry_secure(@tmpdir) if @tmpdir
+    end
+
+    private
+
+      # =======================================================================
+      # General
+
+      def create_tmp_dir
+        @tmpdir = Dir.mktmpdir
+      rescue
+        FileUtils.remove_entry_secure(@tmpdir)
+      end
+
+      # Move files from temp dir to target. First check
+      # if folder contains redmine or contains
+      # folder which contains redmine :-)
+      #
+      # Package can have format:
+      # |-- redmine-2
+      #     |-- app
+      #     `-- config
+      # ...
+      #
+      def get_tmp_redmine_root
+        base.tmp_redmine_root = @tmpdir
+
+        loop {
+          ls = Dir.glob(File.join(base.tmp_redmine_root, '*'))
+
+          if ls.size == 1
+            base.tmp_redmine_root = ls.first
+          else
+            break
+          end
+        }
+      end
+
+
+      # =======================================================================
+      # File
+
+      def load_file
+        unless File.exist?(base.package)
+          error :file_not_exist, file: base.package
+        end
+
+        @type = File.extname(base.package)
+        unless SUPPORTED_ARCHIVE_FORMATS.include?(@type)
+          error :file_must_have_format, file: base.package, formats: SUPPORTED_ARCHIVE_FORMATS.join(', ')
+        end
+
+        # Make temp directory and extract archive + move it to the redmine_folder
+        extract_to_tmp
+
+        # Locate redmine_root in tmpdir
+        get_tmp_redmine_root
+      end
+
+      def extract_to_tmp
+        create_tmp_dir
+
+        case @type
+        when '.zip'
+          extract_zip
+        when '.gz', '.tgz'
+          extract_tar_gz
+        end
+      end
+
+      def extract_zip
+        Zip::File.open(base.package) do |zip_file|
+          # Progressbar
+          progressbar = ProgressBar.create(format: PROGRESSBAR_FORMAT, total: zip_file.size)
+
+          zip_file.each do |entry|
+            dest_file = File.join(@tmpdir, entry.name)
+            FileUtils.mkdir_p(File.dirname(dest_file))
+
+            entry.extract(dest_file)
+            progressbar.increment
+          end
+        end
+      end
+
+      # Extract .tar.gz archive
+      # based on http://dracoater.blogspot.cz/2013/10/extracting-files-from-targz-with-ruby.html
+      # 
+      # Originally tar did not support paths longer than 100 chars. GNU tar is better and they 
+      # implemented support for longer paths, but it was made through a hack called ././@LongLink. 
+      # Shortly speaking, if you stumble upon an entry in tar archive which path equals to above 
+      # mentioned ././@LongLink, that means that the following entry path is longer than 100 chars and
+      # is truncated. The full path of the following entry is actually the value of the current entry.
+      #
+      def extract_tar_gz
+        Gem::Package::TarReader.new(Zlib::GzipReader.open(base.package)) do |tar|
+
+          # Progressbar
+          progressbar = ProgressBar.create(format: PROGRESSBAR_FORMAT, total: tar.count)
+
+          # tar.count move position pointer to end
+          tar.rewind
+
+          dest_file = nil
+          tar.each do |entry|
+            if entry.full_name == TAR_LONGLINK
+              dest_file = File.join(@tmpdir, entry.read.strip)
+              next
+            end
+            dest_file ||= File.join(@tmpdir, entry.full_name)
+            if entry.directory?
+              FileUtils.rm_rf(dest_file) unless File.directory?(dest_file)
+              FileUtils.mkdir_p(dest_file, mode: entry.header.mode, verbose: false)
+            elsif entry.file?
+              FileUtils.rm_rf(dest_file) unless File.file?(dest_file)
+              File.open(dest_file, 'wb') do |f|
+                f.write(entry.read)
+              end
+              FileUtils.chmod(entry.header.mode, dest_file, verbose: false)
+            elsif entry.header.typeflag == '2' # symlink
+              File.symlink(entry.header.linkname, dest_file)
+            end
+
+            dest_file = nil
+            progressbar.increment
+          end
+        end
+      end
+
+
+      # =======================================================================
+      # Git
+
+      def load_git
+        create_tmp_dir
+
+        # Package is remote url to git repository
+        remote = base.package
+
+        if remote
+          # Clone repository
+          Git.clone(remote, @tmpdir, base.options['branch'])
+        else
+          # Copy current repository to tmp and run pull
+          Git.copy_and_fetch(base.redmine_root, @tmpdir)
+        end
+
+        # Locate redmine_root in tmpdir
+        get_tmp_redmine_root
+      end
+
+  end
+end

data/lib/redmine-installer/steps/move_redmine.rb

@@ -0,0 +1,22 @@
+require 'fileutils'
+
+module Redmine::Installer::Step
+  class MoveRedmine < Base
+
+    def up
+      # Move all files from tmp_redmine_root to redmine_root
+      Dir.chdir(base.tmp_redmine_root) do
+        Dir.glob('{*,.*}') do |entry|
+          next if entry.end_with?('.') || entry.end_with?('..')
+
+          FileUtils.mv(entry, base.redmine_root)
+        end
+      end
+    end
+
+    def print_footer
+      say '<green>... OK</green>', 1
+    end
+
+  end
+end

data/lib/redmine-installer/steps/redmine_root.rb

@@ -0,0 +1,29 @@
+module Redmine::Installer::Step
+  class RedmineRoot < Base
+
+    def up
+      # Get redmine root
+      base.redmine_root ||= ask(:path_for_redmine_root, default: '.')
+
+      # Make absolute path
+      base.redmine_root = File.expand_path(base.redmine_root)
+
+      unless Dir.exist?(base.redmine_root)
+        try_create_dir(base.redmine_root)
+      end
+
+      unless File.writable?(base.redmine_root)
+        error t(:dir_is_not_writeable, dir: base.redmine_root)
+      end
+    end
+
+    def save(configuration)
+      configuration['redmine_root'] = base.redmine_root
+    end
+
+    def load(configuration)
+      base.redmine_root = configuration['redmine_root']
+    end
+
+  end
+end

data/lib/redmine-installer/steps/upgrade.rb

@@ -0,0 +1,55 @@
+require 'fileutils'
+
+module Redmine::Installer::Step
+  class Upgrade < Base
+
+    def up
+      # Copy database.yml
+      copy_config_file(plugin::Database::DATABASE_YML_PATH)
+
+      # Copy configuration.yml
+      copy_config_file(plugin::EmailSending::CONFIGURATION_YML_PATH)
+
+      # Copy files
+      FileUtils.cp_r(File.join(base.redmine_root, 'files'), base.tmp_redmine_root)
+
+      # Copy plugins
+      tmp_plugin_dir = File.join(base.tmp_redmine_root, 'plugins')
+      redmine_plugins.each do |plugin|
+        # Copy only plugins which are not part of package
+        # - this is a upgrade so package should contains newer version
+        unless Dir.exist?(File.join(tmp_plugin_dir, File.basename(plugin)))
+          FileUtils.cp_r(plugin, tmp_plugin_dir)
+        end
+      end
+
+      Dir.chdir(base.tmp_redmine_root) do
+        command.bundle_install(base.env)
+        command.rake_db_migrate(base.env)
+        command.rake_redmine_plugin_migrate(base.env) if some_plugins?
+        command.rake_generate_secret_token(base.env)
+
+        # Other plugins can have post-install procedure
+        plugin::RedminePlugin.all.each(&:upgrade)
+      end
+
+      # Delete content of redmine_root
+      Dir.glob(File.join(base.redmine_root, '{*,.*}')) do |entry|
+        next if entry.end_with?('.') || entry.end_with?('..')
+
+        FileUtils.remove_entry_secure(entry)
+      end
+    end
+
+    private
+
+      def copy_config_file(relative_path)
+        file = File.join(base.redmine_root, relative_path)
+
+        if File.exist?(file)
+          FileUtils.cp(file, File.join(base.tmp_redmine_root, 'config'))
+        end
+      end
+
+  end
+end

data/lib/redmine-installer/steps/validation.rb

@@ -0,0 +1,38 @@
+##
+# Validate redmine folder
+#
+module Redmine::Installer::Step
+  class Validation < Base
+
+    REDMINE_SHOULD_CONTAINS = [
+      'app', 'lib', 'config', 'public', 'db',
+      'Gemfile', 'Rakefile', 'config.ru',
+      File.join('lib', 'redmine'),
+      File.join('lib', 'redmine', 'core_ext'),
+      File.join('lib', 'redmine', 'helpers'),
+      File.join('lib', 'redmine', 'views'),
+      File.join('lib', 'redmine.rb'),
+    ].sort
+
+    def up
+      Dir.chdir(base.redmine_root) do
+        @records = Dir.glob(File.join('**', '*')).sort
+      end
+
+      # Is this redmine
+      unless (@records & REDMINE_SHOULD_CONTAINS) == REDMINE_SHOULD_CONTAINS
+        error :error_redmine_not_contains_all, records: REDMINE_SHOULD_CONTAINS.join(', ')
+      end
+
+      # Plugins are in righ dir
+      if @records.select{|x| x.start_with?('vendor/plugins')}.size > 1
+        error :error_plugins_should_be_on_plugins
+      end
+    end
+
+    def print_footer
+      say '<green>... OK</green>', 1
+    end
+
+  end
+end

data/lib/redmine-installer/steps/webserver_config.rb

@@ -0,0 +1,22 @@
+module Redmine::Installer::Step
+  class WebserverConfig < Base
+
+    def up
+      choices = {}
+      plugin::WebServer.all.each do |m|
+        choices[m] = m.title
+      end
+      choices[nil] = t(:skip)
+
+      answer = choose(:"what_web_server_do_you_want", choices, default: nil)
+
+      # Skip
+      return if answer.nil?
+
+      say("(#{answer.title  })", 5)
+
+      say(answer.generate_config(base.redmine_root))
+    end
+
+  end
+end