alcapon 0.3.2 → 0.4.0

data/README.md

@@ -10,6 +10,14 @@ it on a preproduction environment before going further. Please also do read the
 
 ## Changelog
 
+### 0.4.x
+
+ - added eZ Publish 5.x support for ezpublish_legacy. This means that version
+   of eZ Publish must be known by alcapon. You can either set ezpublish_version
+   (accepted values are 4 or 5) in your Capfile or add `-S ezpublish_version=4`
+   or `-S ezpublish_version=5` after your command line call, like this :
+   cap production deploy -S ezpublish_version=5
+
 ### 0.3.x
 
  - added the possibility to trigger rename and in-file replace operations

data/bin/capezit

@@ -41,6 +41,8 @@ end
 files = {
   "Capfile" => unindent(<<-FILE),
     set :alcapon_path, \"#{alcapon_path}\"
+    set :ezpublish_version, 4
+
     load 'deploy' if respond_to?(:namespace) # cap2 differentiator
     Dir['vendor/gems/*/recipes/*.rb','vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
 

data/lib/capez.rb

@@ -1,7 +1,20 @@
-load_paths.push File.expand_path('../', __FILE__)
-load 'db.rb'
 require 'colored'
-require 'md5'
+
+load_paths.push File.expand_path('../', __FILE__)
+load "utils"
+
+if( fetch( :ezpublish_version, nil ) == nil )
+  alcapon_message( "I am now able to manage versions 4 & 5 of eZ Publish but you
+          have to set :ezpublish_version
+          - in your Capfile like this : set :ezpublish_version, <ezpublish_version>
+          - as a command line option : -S ezpublish_version=<ezpublish_version>
+          where <ezpublish_version> can be either 4 or 5." )
+  abort
+else
+  fetch(:ezpublish_version) == 4 || fetch(:ezpublish_version) == 5 || abort( "Version #{ezpublish_version} not supported".red )
+  load "db"
+  load "ezpublish#{ezpublish_version}"
+end
 
 # This will simply do chmod g+w on all dir
 # See task :setup
@@ -42,10 +55,10 @@ before "deploy:finalize_update" do
   # Needed if you want to create extra shared directories under var/ with
   # set :shared_children, [ "var/something",
   #                         "var/something_else" ]
-  # Note that :shared_children creates a folder within shared which name is
+  # Note that :shared_children creates a folder within /shared which name is
   # the last path element (ie: something or something_else) => that's why
-  # we cannot use it to create siteaccess storages (var/siteaccess/storage)
-  run( "mkdir #{latest_release}/var" )
+  # we cannot use it to create siteaccess' storage folder (var/siteaccess/storage)
+  run( "mkdir -p #{latest_release}/#{ezp_legacy_path('var')}" )
 end
 
 after "deploy:finalize_update" do
@@ -118,7 +131,7 @@ namespace :capez do
 
       unless !(file_changes = get_file_changes) then
 
-        path = options[:locally] ? "" : "#{latest_release}/"
+        path = options[:locally] ? "" : fetch( :latest_release )
 
         changes = 0
         renames = 0
@@ -141,7 +154,7 @@ namespace :capez do
           if operations.has_key?("rename")
             if( target_filename != operations['rename'] )
               target_filename = operations['rename']
-              cmd = "if [ -f #{path}#{filename} ]; then cp #{path}#{filename} #{path}#{target_filename}; fi;"
+              cmd = "if [ -f #{path}/#{filename} ]; then cp #{path}/#{filename} #{path}/#{target_filename}; fi;"
               options[:locally] ? run_locally( "#{cmd}" ) : run( "#{cmd}" )
               renames += 1
             else
@@ -155,15 +168,14 @@ namespace :capez do
               when 'rename'
               when 'replace'
 
-                if( value.count > 0 )
+                if( value.count > 0 && !dry_run)
 
                   # download file if necessary
                   if options[:locally]
                     tmp_filename = target_filename
                   else
                     tmp_filename = target_filename+".tmp"
-                    tmp_filename = MD5.new( tmp_filename ).to_s
-                    get "#{path}#{target_filename}", tmp_filename
+                    get "#{path}/#{target_filename}", tmp_filename
                   end
 
                   text = File.read(tmp_filename)
@@ -176,7 +188,7 @@ namespace :capez do
                   # upload and remove temporary file
                   if !options[:locally]
                     run( "if [ -f #{target_filename} ]; then rm #{target_filename}; fi;" )
-                    upload( tmp_filename, "#{path}#{target_filename}" )
+                    upload( tmp_filename, "#{path}/#{target_filename}" )
                     run_locally( "rm #{tmp_filename}" )
                   end
                 end
@@ -230,7 +242,7 @@ namespace :capez do
       puts( "\n--> Clearing caches #{'with --purge'.red if cache_purge}" )
       cache_list.each { |cache_tag|
         print_dotted( "#{cache_tag}" )
-        capture "cd #{current_path} && sudo -u #{webserver_user} php bin/php/ezcache.php --clear-tag=#{cache_tag}#{' --purge' if cache_purge}"
+        capture "cd #{current_path}/#{ezpublish_legacy} && sudo -u #{webserver_user} php bin/php/ezcache.php --clear-tag=#{cache_tag}#{' --purge' if cache_purge}"
         puts( " OK".green )
       }
     end
@@ -267,18 +279,23 @@ namespace :capez do
     task :init_release, :roles => :web do
       puts( "\n--> Release directories" )
 
+      if( ezp5? )
+        run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{latest_release}/ezpublish/{cache,logs,config} web" )
+        run( "chmod -R g+wx #{latest_release}/ezpublish/{cache,logs} web" )
+      end
+
       # creates a storage dir for elements specified by :storage_directories
       storage_directories.each{ |sd|
         print_dotted( "var/#{sd}/storage" )
-        run( "mkdir #{latest_release}/var/#{sd}" )
+        run( "mkdir #{latest_release}/" + ezp_legacy_path( "var/#{sd}" ) )
         puts( " OK".green )
       }
 
       # makes sure the webserver can write into var/
-      run( "chmod -R g+w #{latest_release}/var")
-      run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{latest_release}/var")
+      run( "chmod -R g+w #{latest_release}/" + ezp_legacy_path( "var" ) )
+      run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{latest_release}/" + ezp_legacy_path( "var" ) )
       # needed even if we just want to run 'bin/php/ezpgenerateautoloads.php' with --extension
-      run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{latest_release}/autoload")
+      run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{latest_release}/" + ezp_legacy_path( "autoload" ) )
     end
 
     desc <<-DESC
@@ -288,17 +305,17 @@ namespace :capez do
       puts( "\n--> Symlinks" )
 
       print_dotted( "var/storage" )
-      run( "ln -s #{shared_path}/var/storage #{latest_release}/var/storage" )
+      run( "ln -s #{shared_path}/var/storage #{latest_release}/" + ezp_legacy_path( "var/storage" ) )
       puts( " OK".green )
 
       storage_directories.each{ |sd|
         print_dotted( "var/#{sd}/storage" )
-        run( "ln -s #{shared_path}/var/#{sd}/storage #{latest_release}/var/#{sd}/storage", :as => webserver_user )
+        run( "ln -s #{shared_path}/var/#{sd}/storage #{latest_release}/" + ezp_legacy_path( "var/#{sd}/storage" ), :as => webserver_user )
         #run( "chmod -h g+w #{latest_release}/var/#{sd}/storage")
         puts( " OK".green )
       }
 
-      run( "chmod -R g+w #{latest_release}/var")
+      run( "chmod -R g+w #{latest_release}/" + ezp_legacy_path( "var" ) )
       run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{shared_path}/var")
     end
 
@@ -319,7 +336,7 @@ namespace :capez do
         exclude_string << "--exclude '#{item}' "
       }
 
-      run_locally( "rsync -az #{exclude_string} #{user}@#{shared_host}:#{shared_path}/var/* var/" )
+      run_locally( "rsync -az #{exclude_string} #{user}@#{shared_host}:#{shared_path}/var/* " + ezp_legacy_path( "var/" ) )
     end
 
     desc <<-DESC
@@ -340,7 +357,7 @@ namespace :capez do
       }
 
       try_sudo( "chown -R #{user}:#{webserver_user} #{shared_path}/var/*" )
-      run_locally( "rsync -az #{exclude_string} var/* #{user}@#{shared_host}:#{shared_path}/var/ " )
+      run_locally( "rsync -az #{exclude_string} #{ezp_legacy_path('var')}/* #{user}@#{shared_host}:#{shared_path}/var/ " )
       try_sudo( "chown -R #{webserver_user} #{shared_path}/var/*" )
       try_sudo( "chmod -R ug+rwx #{shared_path}/var/*" )
     end
@@ -361,7 +378,7 @@ namespace :capez do
         puts( "\n--> eZ Publish autoloads " )
         autoload_list.each { |autoload|
           print_dotted( "#{autoload}" )
-          capture( "cd #{latest_release} && sudo -u #{webserver_user} php bin/php/ezpgenerateautoloads.php --#{autoload}" )
+          capture( "cd #{latest_release}/#{ezp_legacy_path} && sudo -u #{webserver_user} php bin/php/ezpgenerateautoloads.php --#{autoload}" )
           puts( " OK".green )
         }
       end
@@ -448,29 +465,4 @@ namespace :capez do
       end
   end
 
-
-end
-
-def print_dotted( message, options={} )
-  defaults_options = { :eol => false,
-                       :sol => false,
-                       :max_length => 40,
-                       :eol_msg => false }
-
-  options = defaults_options.merge( options )
-  message = "#{message} " + "." * [0,options[:max_length]-message.length-1].max
-
-  if options[:sol]
-    message = "\n#{message}"
-  end
-
-  if options[:eol_msg]
-    message += " #{options[:eol_msg]}"
-  end
-
-  if options[:eol]
-    puts message
-  else
-    print message
-  end
 end

data/lib/ezpublish4.rb

@@ -0,0 +1,3 @@
+puts "Running AlCapON for eZ Publish 4"
+
+set :ezp_legacy, ""

data/lib/ezpublish5.rb

@@ -0,0 +1,4 @@
+puts "Running AlCapON for eZ Publish 5"
+
+set :ezp_legacy, "ezpublish_legacy"
+set :ezp_app, "ezpublish"

data/lib/utils.rb

@@ -0,0 +1,50 @@
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+def print_dotted( message, options={} )
+  defaults_options = { :eol => false,
+                       :sol => false,
+                       :max_length => 40,
+                       :eol_msg => false }
+
+  options = defaults_options.merge( options )
+  message = "#{message} " + "." * [0,options[:max_length]-message.length-1].max
+
+  if options[:sol]
+    message = "\n#{message}"
+  end
+
+  if options[:eol_msg]
+    message += " #{options[:eol_msg]}"
+  end
+
+  if options[:eol]
+    puts message
+  else
+    print message
+  end
+end
+
+def ezp5?
+  return ( fetch( :ezpublish_version, nil ) == 5 )
+end
+
+def ezp_legacy_path(path='')
+  elements = Array.new
+
+  if( fetch( :ezp_legacy, "" ) != "" )
+    elements += [ "#{ezp_legacy}" ]
+  end
+
+  if( path != '' )
+    elements += [ "#{path}" ]
+  end
+
+  return File.join( elements )
+end
+
+def alcapon_message(string)
+  puts( "[alcapon]".green+" #{string}" )
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Arnaud Lafon
@@ -57,6 +57,9 @@ files:
 - lib/capez.rb
 - lib/db.rb
 - lib/ext/spinner.rb
+- lib/ezpublish4.rb
+- lib/ezpublish5.rb
+- lib/utils.rb
 - README.md
 - LICENSE.md
 has_rdoc: true