skadategems-dev 0.0.9

data/lib/skadategems/dev/cli/skadate.rb

@@ -0,0 +1,184 @@
+require 'time'
+require 'uri'
+require 'thor'
+require 'execphp'
+require 'skadategems/dev/skadate'
+require 'skadategems/dev/bundle'
+require 'skadategems/dev/cli/remote'
+
+module SkadateGems::Dev
+  module CLI
+
+    class Skadate < Thor
+      namespace 'skadate'
+
+      desc 'version [ list | [ about ] | number | build ]',
+           'Display Skadate software version information'
+      long_desc <<-LONGDESC
+To detect the version of the software that is located under the current working directory:
+\x5
+\x5  $> skadate version
+\x5
+
+To list all versions supported by the tool:
+\x5
+\x5  $> skadate version list
+\x5
+\x5
+      LONGDESC
+      def version(section = 'about')
+        section =
+          case section[0]
+            when 'l'
+              :list
+            when 'a'
+              :about
+            when 'n'
+              :number
+            when 'b'
+              :build
+            else
+              say "Error: `skadate version` unrecognized info section `#{section}`", :red
+              return help('version')
+          end
+
+        if section == :list
+          current_version = current.source.version
+
+          SoftwareVersion::LIST.each do |version|
+            if version == current_version
+              say('* ', version_status(current_version)[0], false)
+            else
+              say '  ', nil, false
+            end
+
+            say "skadate-#{version} [#{version.release_date.strftime('%Y-%m-%d')}]"
+          end
+
+          return
+        end
+
+        version = current.source.version!
+        color, status = version_status(version)
+
+        case section
+          when :about
+            say 'Skadate Software '
+            say("#{version} ", :bold)
+
+            if version.codename
+              say('(', :white, false)
+              say("#{version.codename}", :cyan, false)
+              say ') '
+            end
+
+            say('[', :white, false)
+            say(status, color, false)
+            say ']'
+
+            if version.release_date
+              say "Release date: #{version.release_date.strftime('%B %e, %Y')}"
+            end
+
+            say 'Copyright (c) 2004-2014 Skalfa LLC'
+
+          when :number
+            say(version, color)
+
+          when :build
+            say(version.build, color)
+
+          else
+            raise "unexpected case :#{section}"
+        end
+      end
+
+      desc 'init', 'Initialize Skadate development project'
+
+      option :remote_url, type: :string,
+                          banner: 'URL',
+                          aliases: :r,
+                          desc: 'Remote application server url'
+
+      def init
+        source = current.source
+
+        dev_dir = source.filename('.dev')
+        FileUtils.mkdir(dev_dir) unless File.exists?(dev_dir)
+
+        htaccess_file_path = source.filename('.dev/.htaccess')
+        unless File.exists?(htaccess_file_path)
+          File.write(htaccess_file_path, <<-HTACCESS)
+Order Deny,Allow
+Deny from all
+          HTACCESS
+        end
+
+        if options[:remote_url]
+          execphp = ExecPHP::ServerSideAccessor.new
+
+          rs_config = ExecPHP::RemoteServer.new(
+            URI.join(options[:remote_url], 'exec.php').to_s,
+            execphp.access_token
+          )
+
+          rs_config.save_as source.filename('.dev/remote-server.json')
+          execphp.generate source.filename('exec.php')
+        end
+      end
+
+      desc 'export [FILENAME]',
+           'Export source files for deployment'
+
+      option :layout_theme, type: :string,
+                            desc: 'Exclude all themes except a specified one from being bundled',
+                            banner: 'NAME',
+                            aliases: '-l'
+
+      long_desc <<-LONGDESC
+Export current project source files as an archive for deployment.
+
+To save the largest part of disk space,
+it's recommended to specify layout theme name using the `--layout-theme` switch,
+that will exclude all unnecessary `layout/themes` from being bundled.
+
+For example:
+\x5
+\x5  $> skadate export --layout-theme stencil
+\x5
+\x5
+      LONGDESC
+      def export(filename = nil)
+        version = current.source.version!
+
+        filename ||= "./skadate-#{version}-#{Time.now.to_i}.tar.gz"
+
+        bundle = Bundle.new(current)
+        bundle.layout_theme = options[:layout_theme] if options[:layout_theme]
+        bundle.gzip(filename)
+      end
+
+      register Remote, :remote,
+               'remote < ping | exec | clone | config | ... > [OPTIONS]',
+               'Remote application control'
+
+    protected
+      def current
+        @current ||= SkadateGems::Dev::Skadate.new(Dir.pwd)
+      end
+
+      def version_status(version)
+        return :red, 'unknown' unless version.supported?
+
+        list = SoftwareVersion::LIST
+
+        case version
+          when list[-1] then [:green, 'latest']
+          when list[-2] then [:yellow, 'previous']
+          else [:red, 'outdated']
+        end
+      end
+    end
+
+  end
+end

data/lib/skadategems/dev/remote.rb

@@ -0,0 +1,170 @@
+require 'execphp'
+require 'skadategems/dev/remote/directory'
+require 'skadategems/dev/remote/configs'
+
+module SkadateGems
+  module Dev
+
+    # Represents remote Skadate-driven application.
+    class Remote
+
+      attr_reader :accessor
+
+      def initialize(config_filename)
+        @accessor = ExecPHP::RemoteServer.from_file(config_filename)
+      end
+
+      def exec(options = {}, &block)
+        batch = ScriptBatch.new
+
+        if options[:include]
+          [*options[:include]].each do |include_name|
+            batch.include_file ::File.join(__dir__, "remote/includes/#{include_name}.php")
+          end
+        end
+
+        block.call(batch)
+
+        @accessor.exec(batch)
+      end
+
+      # @return [Remote::Directory] remote source directory accessor
+      def directory(path)
+        Directory.new(self, path, 0)
+      end
+
+      # @return [Remote::Directory] remote source root directory
+      def root
+        @root ||= directory '/'
+      end
+
+      # @return [Remote::Configs] remote application configs accessor
+      def configs
+        @config ||= Configs.new(self)
+      end
+
+      def create_mysql_dump(&block)
+        response = exec do |script|
+          script << <<-PHPSCRIPT
+require_once DIR_INTERNALS . 'system.const.php';
+
+if (strpos(DIR_INTERNAL_C, DIR_SITE_ROOT) !== 0) {
+  header('HTTP/1.1 500 Internal Server Error');
+  exit('Error: unable to detect path to `internal_c/`.');
+}
+
+function program_available($bin) {
+  $output = null;
+  $result = -1;
+  exec("type $bin>/dev/null 2>&1", $output, $result);
+  return $result === 0;
+}
+
+if (!program_available('mysqldump')) {
+  header('HTTP/1.1 500 Internal Server Error');
+  exit('Error: `mysqldump` is not available');
+}
+
+$tmp_dir = DIR_INTERNAL_C;
+$tmp_dir_path = substr($tmp_dir, strlen(DIR_SITE_ROOT));
+
+$uniqid = uniqid();
+$sql_filename = "$uniqid.sql";
+
+$db_host = DB_HOST;
+$db_user = DB_USER;
+$db_pass = DB_PASS;
+$db_name = DB_NAME;
+
+$output = null;
+$result = -1;
+exec("cd '$tmp_dir' && mysqldump --host='$db_host' --user='$db_user' --password='$db_pass' '$db_name' > '$sql_filename'", $output, $result);
+if (!file_exists($tmp_dir . $sql_filename)) {
+  header('HTTP/1.1 500 Internal Server Error');
+  exit('`mysqldump` error: ' . join($output, "\n"));
+}
+
+if (program_available('tar')) {
+  $tar_filename = "$uniqid.tar.gz";
+
+  $output = null;
+  $result = -1;
+  exec("cd '$tmp_dir' && tar -czf '$tar_filename' '$sql_filename'", $output, $result);
+  if (file_exists($tmp_dir . $tar_filename)) {
+    unlink($tmp_dir . $sql_filename);
+    exit('["' . $tmp_dir_path . $tar_filename . '", ' . filesize($tmp_dir . $tar_filename) . ']');
+  }
+}
+
+exit('["' . $tmp_dir_path . $sql_filename . '", ' . filesize($tmp_dir . $sql_filename) . ']');
+          PHPSCRIPT
+        end
+
+        raise "#{response.code} [#{response.message}]:\n >> #{response.body}" if response.code != '200'
+
+        path, size = JSON.parse(response.body)
+        block.call File.new(self, path, size)
+
+        response = exec do |script|
+          script << <<-PHPSCRIPT
+echo unlink(DIR_SITE_ROOT . '#{path}') ? '1' : '0';
+          PHPSCRIPT
+        end
+
+        raise "#{response.code} [#{response.message}]:\n >> #{response.body}" if response.code != '200'
+
+        response.body == '1'
+      end
+
+      # Detect the name of the `userfiles` directory requesting a remote application.
+      # @return [Remote::Directory] remote `userfiles` directory
+      def userfiles
+        response = exec do |script|
+          script << <<-PHPSCRIPT
+require_once DIR_INTERNALS . 'system.const.php';
+
+if (strpos(DIR_USERFILES, DIR_SITE_ROOT) !== 0) {
+  header('HTTP/1.1 500 Internal Server Error');
+  exit('Error: unable to detect path to `/userfiles`.');
+}
+
+echo substr(DIR_USERFILES, strlen(DIR_SITE_ROOT) - 1, -1);
+          PHPSCRIPT
+        end
+
+        raise "#{response.code} [#{response.message}]:\n >> #{response.body}" if response.code != '200'
+
+        directory(response.body)
+      end
+
+      # PHP script batch.
+      class ScriptBatch < ExecPHP::ScriptBatch
+
+        # Initializes a remote script batch which automatically
+        # finds and requires Skadate's `config.php` file.
+        def initialize
+          super do |script|
+            script << <<-PHPSCRIPT
+$try_dir = dirname(__FILE__);
+while (!(file_exists($config_file = $try_dir . '/internals/config.php')
+	|| file_exists($config_file = $try_dir . '/internals/$config.php')))
+{
+	$prev_dir = $try_dir;
+	if ($prev_dir == ($try_dir = dirname($try_dir))) {
+		throw new Exception('Error: unable to find a config file');
+	}
+}
+
+require_once $config_file;
+
+define('DIR_INTERNALS', dirname($config_file) . DIRECTORY_SEPARATOR);
+            PHPSCRIPT
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/skadategems/dev/remote/clone_logger.rb

@@ -0,0 +1,118 @@
+require 'skadategems/dev/remote/directory'
+require 'skadategems/dev/remote/file'
+require 'thor/shell'
+
+module SkadateGems::Dev
+  class Remote
+
+    class CloneLogger < Thor::Base.shell
+
+      def self.start(log_file_path, &block)
+        ::File.open(log_file_path, 'w') do |file_io|
+          block.call new(file_io)
+        end
+      end
+
+      def initialize(file_io)
+        @file_io = file_io
+        super()
+      end
+
+      # @param entry [Remote::Entry] remote fs entry
+      # @param status [Symbol] log entry status
+      # @param label [String] log entry badge label
+      # @yield if block is given expecting that it returns an entry processing status
+      def entry(entry, status = nil, label = nil)
+        icon = if status == :skipped
+          '*'
+        elsif entry.is_a?(Directory)
+          '='
+        elsif entry.is_a?(File)
+          '~'
+        end
+
+        prefix = "#{'  ' * padding}#{icon}>"
+
+        print(if entry.is_a?(Directory)
+                "#{prefix} #{set_color(entry.path, :blue)}"
+              elsif entry.is_a?(File)
+                "#{prefix} #{set_color(entry.basename, :white)} (#{set_color(entry.friendly_size, :cyan)})"
+              else
+                "#{prefix} #{set_color(entry.to_s, :on_black)}"
+              end)
+
+        write(if entry.is_a?(Directory)
+                "#{prefix} #{entry.path}"
+              elsif entry.is_a?(File)
+                "#{prefix} #{entry.basename} (#{entry.friendly_size})"
+              else
+                "#{prefix} #{entry}"
+              end)
+
+        if status == :skipped
+          label ||= 'skipped'
+          print(" [#{set_color(label, :magenta)}]")
+          write(" [#{label}]")
+        end
+
+        if block_given?
+          print ' ...'
+          stdout.flush
+
+          status = yield
+
+          label, color =
+            case status
+              when :downloaded
+                ['downloaded', :green]
+              when :unchanged
+                ['unchanged', :cyan]
+              else
+                # no status badge
+            end
+
+          if label
+            print "\b" * 4 if can_display_colors?
+            print(" [#{set_color(label, color)}]")
+            write(" [#{label}]")
+          end
+        end
+
+      rescue
+        print "\b" * 4 if can_display_colors?
+        print " [#{set_color('error', :red)}]"
+        write " [error]\n#{'>' * 30}\n[#{$!.class.name}]: #{$!.message}\n#{'-' * 30}"
+        raise $!
+      ensure
+        print "\n"
+        write "\n"
+        stdout.flush
+      end
+
+      # @param line [String] string line to log
+      # @param color [Symbol] string color to colorize if supported
+      def puts(line, color = nil)
+        unless mute?
+          super set_color(line, color)
+          stdout.flush
+        end
+
+        write "#{line}\n"
+      end
+
+      def set_color(string, *colors)
+        can_display_colors? ? super(string, *colors) : string
+      end
+
+      def print(obj, *rest)
+        super unless mute?
+      end
+
+      def write(string)
+        @file_io << string if @file_io
+      end
+
+    end
+
+  end
+end