dkdeploy-typo3-cms 7.0.0

data/lib/dkdeploy/typo3/cms/dsl.rb

@@ -0,0 +1,27 @@
+module Dkdeploy
+  module Typo3
+    # TYPO3 dsl api
+    module DSL
+      # Execute a rake/capistrano task only for given server
+      #
+      # @param server [Capistrano::Configuration::Server] Server to execute task
+      # @param task [String] Name of rake/capistrano task
+      # @param args [Array] Arguments of rake/capistrano task
+      def invoke_for_server(server, task, *args)
+        backup_filter = fetch :filter, {}
+        begin
+          new_server_filter = Marshal.load(Marshal.dump(backup_filter))
+          new_server_filter[:host] = server.hostname
+          set :filter, new_server_filter
+          env.setup_filters
+          info I18n.t('dsl.invoke_for_server.set_filter', task: task, host: server.hostname, scope: :dkdeploy)
+          invoke task, *args
+          Rake::Task[task].reenable
+        ensure
+          set :filter, backup_filter
+          env.setup_filters
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/typo3/cms/helpers/cli.rb

@@ -0,0 +1,165 @@
+module Dkdeploy
+  module Typo3
+    module Cms
+      module Helpers
+        # TYPO3 cli helpers
+        module Cli
+          # Execute a task typo3/cli_dispatch.phpsh cli_params
+          #
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [Boolean] returns true/false as success of execution
+          def typo3_cli(*cli_params)
+            path_to_cli_dispatch = File.join(current_path, 'typo3', 'cli_dispatch.phpsh')
+            run_script(current_path, path_to_cli_dispatch, cli_params)
+          end
+
+          # Execute a task typo3/cli_dispatch.phpsh cli_params in a specific directory
+          #
+          # @param path [String] file path where task is to be executed
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [Boolean] returns true/false as success of execution
+          def typo3_cli_in_path(path, *cli_params)
+            path_to_cli_dispatch = File.join(path, 'typo3', 'cli_dispatch.phpsh')
+            run_script(path, path_to_cli_dispatch, cli_params)
+          end
+
+          # Returns the last results of invocations of a task typo3/cli_dispatch.phpsh cli_params
+          # Invocation can be controlled by the result of a given block.
+          # True repeats the invocation until maximum_loop_count is reached.
+          # False stops invocation regardless of loop count.
+          #
+          # @param maximum_loop_count [Integer] number of maximum attempts to run task
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [String] returns the last result of executing task
+          def capture_typo3_cli_in_loop(maximum_loop_count, *cli_params, &block)
+            path_to_cli_dispatch = File.join(current_path, 'typo3', 'cli_dispatch.phpsh')
+            capture_script_in_loop(current_path, path_to_cli_dispatch, maximum_loop_count, cli_params, &block)
+          end
+
+          # Returns the last results of invocations of a task typo3/cli_dispatch.phpsh cli_params
+          # Invocation can be controlled by the result of a given block.
+          # True repeats the invocation until maximum_loop_count is reached.
+          # False stops invocation regardless of loop count.
+          #
+          # @param path [String] file path where task is to be executed
+          # @param maximum_loop_count [Integer] number of maximum attempts to run task
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [String] returns the last result of executing task
+          def capture_typo3_cli_in_path_in_loop(path, maximum_loop_count, *cli_params, &block)
+            path_to_cli_dispatch = File.join(path, 'typo3', 'cli_dispatch.phpsh')
+            capture_script_in_loop(path, path_to_cli_dispatch, maximum_loop_count, cli_params, &block)
+          end
+
+          # Execute a typo3_console task with cli_params
+          #
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [Boolean] returns true/false as success of execution
+          def typo3_console(*cli_params)
+            path_to_typo3_console = File.join(current_path, fetch(:path_to_typo3_console))
+            run_script(current_path, path_to_typo3_console, cli_params)
+          end
+
+          # Execute a typo3_console task with cli_params in a specific directory
+          #
+          # @param path [String] file path where task is to be executed
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [Boolean] returns true/false as success of execution
+          def typo3_console_in_path(path, *cli_params)
+            path_to_typo3_console = File.join(path, fetch(:path_to_typo3_console))
+            run_script(path, path_to_typo3_console, cli_params)
+          end
+
+          # Returns the last results of invocations of a a typo3_console task with cli_params
+          # Invocation can be controlled by the result of a given block.
+          # True repeats the invocation until maximum_loop_count is reached.
+          # False stops invocation regardless of loop count.
+          #
+          # @param maximum_loop_count [Integer] number of maximum attempts to run task
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [String] returns the last result of executing task
+          def capture_typo3_console_in_loop(maximum_loop_count, *cli_params, &block)
+            path_to_typo3_console = File.join(current_path, fetch(:path_to_typo3_console))
+            capture_script_in_loop(current_path, path_to_typo3_console, maximum_loop_count, cli_params, &block)
+          end
+
+          # Returns the last results of invocations of a typo3_console task with cli_params
+          # Invocation can be controlled by the result of a given block.
+          # True repeats the invocation until maximum_loop_count is reached.
+          # False stops invocation regardless of loop count.
+          #
+          # @param path [String] file path where task is to be executed
+          # @param maximum_loop_count [Integer] number of maximum attempts to run task
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [String] returns the last result of executing task
+          def capture_typo3_console_in_path_in_loop(path, maximum_loop_count, *cli_params, &block)
+            path_to_typo3_console = File.join(path, fetch(:path_to_typo3_console))
+            capture_script_in_loop(path, path_to_typo3_console, maximum_loop_count, cli_params, &block)
+          end
+
+          # Execute a script with cli_params in a specific directory
+          #
+          # @param path [String] file path where task is to be executed
+          # @param script [String] path to script
+          # @param cli_params [Array] list of arguments for typo3/cli_dispatch.phpsh
+          # @return [Boolean] returns true/false as success of execution
+          def run_script(path, script, *cli_params)
+            on primary :backend do |host|
+              within path do
+                unless test " [ -e #{script} ] "
+                  error I18n.t('resource.not_exists_on_host', resource: script, host: host.hostname, scope: :dkdeploy)
+                  next
+                end
+
+                with fetch(:typo3_environment_cli) do
+                  execute :php, script, *cli_params
+                end
+              end
+            end
+          end
+
+          # Returns the last results of invocations of a script
+          # Invocation can be controlled by the result of a given block.
+          # True repeats the invocation until maximum_loop_count is reached.
+          # False stops invocation regardless of loop count.
+          #
+          # @param path [String] file path where task is to be executed
+          # @param script [String] path to script
+          # @param maximum_loop_count [Integer] number of maximum attempts to run task
+          # @param cli_params [Array] list of arguments for the script
+          # @return [String] returns the last result of executing task
+          def capture_script_in_loop(path, script, maximum_loop_count, *cli_params)
+            output = nil
+
+            on primary :backend do |host|
+              within path do
+                unless test "[ -e #{script} ]"
+                  error I18n.t('resource.not_exists_on_host', resource: script, host: host.hostname, scope: :dkdeploy)
+                  next
+                end
+
+                loop_counter = 1
+
+                while loop_counter <= maximum_loop_count
+                  info I18n.t('tasks.cli.show_loop_counter', loop_counter: loop_counter, scope: :dkdeploy)
+                  with fetch(:typo3_environment_cli) do
+                    output = capture :php, script, *cli_params
+                  end
+                  if block_given?
+                    unless yield(output, loop_counter, self)
+                      info I18n.t('tasks.cli.block_yields_false', loop_counter: loop_counter, scope: :dkdeploy)
+                      break
+                    end
+                  end
+                  loop_counter += 1
+                end
+                info I18n.t('tasks.cli.maximum_calls_reached', scope: :dkdeploy) if loop_counter > maximum_loop_count
+              end
+            end
+
+            output
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/typo3/cms/helpers/erb.rb

@@ -0,0 +1,25 @@
+module Dkdeploy
+  module Typo3
+    module Cms
+      module Helpers
+        # Erb related helpers
+        module Erb
+          # Remove "<?php" at beginning and "?>" at end of string
+          #
+          # @param php_code [String] PHP Code to sanitize
+          # @return [String]
+          def sanitize_php(php_code)
+            php_code.strip.reverse.chomp('php?<').reverse.chomp('?>').strip.concat("\n")
+          end
+
+          # Return path to default template file for "AdditionalConfiguration.php" at gem
+          #
+          # @return [String]
+          def default_template_file
+            File.join(__dir__, '..', '..', '..', '..', '..', 'vendor', 'AdditionalConfiguration.php.erb')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/typo3/cms/i18n.rb

@@ -0,0 +1,111 @@
+require 'i18n'
+
+en = {
+  questions: {
+    create_new_keys: "Please enter 'yes' to create new Caretaker keys (everything else will not touch existing keys)",
+    additional_configuration_template: 'Please specify the location for the additional configuration file (e.g. vendor/AdditionalConfiguration.php.erb)',
+    typo3_languages_to_translate: 'Please specify the languages you wish to translate',
+    path: 'please specify the path'
+  },
+  dsl: {
+    invoke_for_server: {
+      set_filter: "Invoking task '%{task}' for server '%{host}'"
+    }
+  },
+  tasks: {
+    caretaker: {
+      errors: {
+        public_key_not_found: 'Public key at %{public_key_path} on %{host} not found!',
+        creating_keys_failed: 'Could not create Caretaker SSL keys on %{host}!',
+        configuring_keys_failed: 'Could not configure Caretaker SSL keys on %{host}!'
+      },
+      info: {
+        output_file: 'Output file %{output_file} (%{host}):',
+        output_file_one_liner: 'One line public key (%{host}):'
+      }
+    },
+    cli: {
+      show_loop_counter: 'Running cli task for the %{loop_counter}. time',
+      maximum_calls_reached: 'Maximum number of cli calls reached!',
+      block_yields_false: 'Breaking loop after %{loop_counter} run because block yields false'
+    },
+    db: {
+      username: 'Please enter TYPO3 admin username',
+      password: 'Please enter TYPO3 admin password'
+    },
+    fetch_extension: {
+      extension_name: 'Please enter name of extension',
+      extension_not_found: "Extension '%{extension}' not found!",
+      download: 'Downloading %{extension}...',
+      rsync: 'Rsyncing %{extension}...'
+    },
+    clear_temp: {
+      clear: 'Clearing typo3temp directory...'
+    },
+    install_tool: {
+      enable: 'Enabling install tool...',
+      disable: 'Disabling install tool...'
+    },
+    fetch_localconf: {
+      fetch: 'Fetching localconf...'
+    },
+    typoscript: {
+      copy_source: 'Please enter a common prefix for all config paths:',
+      config_paths: 'Please enter a space separated list of remote config paths:',
+      pagets_paths: 'Please enter a space separated list of remote PageTS paths:',
+      userts_paths: 'Please enter a space separated list of remote UserTS paths:',
+      config_file: 'Please enter the name of the config file:',
+      pagets_file: 'Please enter the name of the PageTS file:',
+      userts_file: 'Please enter the name of the UserTS file:',
+      typoscript_config_base_path: 'Please enter the base path of config files:',
+      typoscript_pagets_base_path: 'Please enter the base path of PageTS files:',
+      typoscript_userts_base_path: 'Please enter the base path of UserTS files:',
+      skipping: 'Skipping %{file_or_directory} because it does not exist...',
+      uploading: 'Uploading %{local_file} to %{remote_file}...',
+      uploaded: 'Uploaded %{local_file} to %{remote_file}.',
+      merged: 'Merged %{source_file} with %{target_file}.'
+    },
+    encryption_key: {
+      enter_key: 'Enter an encryption key (should be at least 9 characters):',
+      validation_error: 'Encryption key is empty or less than 9 characters.'
+    },
+    install_tool_password: {
+      enter_password: 'Install tool password:',
+      validation_error: 'Install tool password is empty.'
+    },
+    processed_file_checksums: {
+      typo3_version: 'Running TYPO3 CMS Version %{typo3_version}',
+      task_does_not_apply: 'This task does not apply!',
+      nothing_to_do: 'No updates to perform. All processed files checksums have already been updated.',
+      all_done: 'All processed file checksums updated!'
+    },
+    typo3: {
+      cms: {
+        v6: {
+          generate_additional_configuration_template: {
+            info: 'No need to generate template. There already is one in %{local_configuration_template}'
+          },
+          setup_additional_configuration: {
+            no_template_found: 'Can not find "AdditionalConfiguration.php" template at "%{configuration_template}"',
+            upload_info: 'Uploading merged AdditionalConfiguration to %{remote_configuration_file}',
+            no_local_file_info: '%{local_configuration_template} does not exist. File upload cancelled.',
+            file_not_found_and_ignored: 'Configuration file %{file} does not exist. File ignored.'
+          },
+          remove_extensions: {
+            info: 'The following extensions were removed: %{removed_extensions}',
+            no_extension_found: 'No installed extension found'
+          }
+        },
+        update_database: {
+          still_updates_available: 'Still database schema updates available. See log for details.'
+        }
+      }
+    }
+  }
+}
+
+I18n.backend.store_translations(:en, dkdeploy: en)
+
+if I18n.respond_to?(:enforce_available_locales=)
+  I18n.enforce_available_locales = true
+end

data/lib/dkdeploy/typo3/cms/tasks/cache.rake

@@ -0,0 +1,18 @@
+include Capistrano::DSL
+
+namespace :typo3 do
+  namespace :cms do
+    namespace :cache do
+      desc 'Clear TYPO3 file cache directory'
+      task :clear_file_cache do |task|
+        on release_roles :app do
+          cache_path = File.join release_path, 'typo3temp', 'Cache'
+          execute :rm, '-rf', cache_path if test "[ -d #{cache_path} ]"
+        end
+
+        # Reenable Task to allow multiple invokation
+        task.reenable
+      end
+    end
+  end
+end

data/lib/dkdeploy/typo3/cms/tasks/caretaker_key_management.rake

@@ -0,0 +1,60 @@
+require 'erb'
+require 'capistrano/i18n'
+require 'dkdeploy/typo3/cms/i18n'
+require 'dkdeploy/typo3/cms/helpers/cli'
+
+include Dkdeploy::Typo3::Cms::Helpers::Cli
+
+namespace :caretaker do
+  desc 'Create - if necessary or configured - and configure TYPO3 Caretaker SSL keys'
+  task :create_keys, :create_new_caretaker_keys do |_, args|
+    create_new_keys = 'yes' == ask_variable(args, :create_new_caretaker_keys, 'questions.create_new_keys')
+
+    on roles :app do |server|
+      key_is_missing = !test("[ -f #{fetch(:caretaker_private_key_path)} ]")
+
+      if create_new_keys || key_is_missing
+        begin
+          execute :mkdir, '-p', File.join(shared_path, 'config')
+          execute :openssl, 'genrsa', '-out', fetch(:caretaker_private_key_path), '2048', '2>/dev/null'
+          execute :openssl, 'rsa', '-in', fetch(:caretaker_private_key_path), '-pubout', '-out', fetch(:caretaker_public_key_path), '2>&1'
+        rescue SSHKit::Command::Failed
+          error I18n.t('tasks.caretaker.errors.creating_keys_failed', host: server.hostname, scope: :dkdeploy)
+          execute :rm, '-f', fetch(:caretaker_private_key_path)
+          execute :rm, '-f', fetch(:caretaker_public_key_path)
+          exit 1
+        end
+      end
+
+      begin
+        create_caretaker_instance_keys_template = ERB.new(File.read(fetch(:create_caretaker_instance_keys_template)), nil, '>')
+        create_caretaker_instance_keys_content = create_caretaker_instance_keys_template.result(binding)
+        upload! StringIO.new(create_caretaker_instance_keys_content), fetch(:create_caretaker_instance_keys_path), scp: true
+        execute :php, '-f', fetch(:create_caretaker_instance_keys_path)
+        execute :rm, '-f', fetch(:create_caretaker_instance_keys_path)
+      rescue SSHKit::Command::Failed
+        error I18n.t('tasks.caretaker.errors.configuring_keys_failed', host: server.hostname, scope: :dkdeploy)
+        execute :rm, '-r', fetch(:create_caretaker_instance_keys_path)
+        execute :rm, '-r', fetch(:caretaker_instance_keys_path)
+        exit 1
+      end
+    end
+  end
+
+  desc 'Display Caretaker SSL public key'
+  task :show_public_key do
+    on roles :app do |server|
+      if test("[ -f #{fetch(:caretaker_public_key_path)} ]")
+        public_key = capture :cat, fetch(:caretaker_public_key_path)
+      else
+        error I18n.t('tasks.caretaker.errors.public_key_not_found', public_key_path: fetch(:caretaker_public_key_path), host: server.hostname, scope: :dkdeploy)
+        exit 1
+      end
+
+      info I18n.t('tasks.caretaker.info.output_file', output_file: fetch(:caretaker_public_key_path), host: server.hostname, scope: :dkdeploy)
+      info public_key
+      info I18n.t('tasks.caretaker.info.output_file_one_liner', output_file: fetch(:caretaker_public_key_path), host: server.hostname, scope: :dkdeploy)
+      info public_key.gsub(/\n/m, '|')
+    end
+  end
+end

data/lib/dkdeploy/typo3/cms/tasks/cli.rake

@@ -0,0 +1,45 @@
+require 'json'
+require 'dkdeploy/typo3/cms/helpers/cli'
+
+include Capistrano::DSL
+include Dkdeploy::Typo3::Cms::Helpers::Cli
+
+namespace :typo3 do
+  namespace :cms do
+    namespace :cli do
+      desc 'Execute TYPO3 cli task'
+      task :run do |task, args|
+        typo3_cli(args.extras)
+
+        # Reenable Task to allow multiple invokation
+        task.reenable
+      end
+
+      desc 'Execute a typo3_console task'
+      task :typo3_console do |task, args|
+        typo3_console(args.extras)
+
+        # Reenable Task to allow multiple invokation
+        task.reenable
+      end
+
+      desc 'Uploads wrapper script to initialize PHP with environment variables'
+      task :upload_wrapper do
+        path_to_typo_cms_cli_dispatch = File.join release_path, 'typo3_cms_cli_dispatch.sh'
+        path_to_cli_dispatch = File.join release_path, 'typo3', 'cli_dispatch.phpsh'
+
+        bash_path = SSHKit.config.command_map[:bash]
+        wrapper_file_content = "#!#{bash_path}\n"
+        fetch(:typo3_environment_cli).each do |variable_name, variable_value|
+          wrapper_file_content << "#{variable_name.to_s.upcase}='#{variable_value}' "
+        end
+
+        php_interpreter_path = SSHKit.config.command_map[:php]
+        wrapper_file_content << "#{php_interpreter_path} #{path_to_cli_dispatch} $@\n"
+        on release_roles :backend do
+          upload! StringIO.new(wrapper_file_content), path_to_typo_cms_cli_dispatch
+        end
+      end
+    end
+  end
+end