capistrano-cul 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d6f1d8ac159b847e770218d83097d4782343fd8
-  data.tar.gz: 70b6955e0fb79af666ef1be11a5fdd37b9965d17
+  metadata.gz: bdf61bf425466ac1f834abf8e1b58c343d6ba6d9
+  data.tar.gz: e4f56d47ce5e62884e0c4e3f9d695fdd09fa040f
 SHA512:
-  metadata.gz: 5003a04adabee6b5f27a5ecf1459316b55e38da245ed955b5063813a968649f389efa62f28065bd88452175cde869aecbe11d55ee4d02233e0141a1ee7e53bee
-  data.tar.gz: d1e5a70270dadb22f34ebde7480a1ea501f116f307a276e6137a6e7b6a639d990619cf031049d59ff95ea17c3e1a846e64840b548e403ea08815b259328f7009
+  metadata.gz: e44a48f6094f3a73191ee75b321d2ab069b089404a56f00d484606614d3c5acd3d535c1721c41f50819710f2e385cc3306ce63b7331bb2b054bd0b55ace71189
+  data.tar.gz: 8d256b5e8d83985d222b0dcd1522a3bac57cfbc146c7ef418c9232700152c9a76f7c6563e986474a7462bd7a1ba2f1249c9b97a738bd50405b80b4558541c6da

data/README.md

@@ -60,16 +60,19 @@ require 'capistrano/cul/wp'
 4. `cap {env} cul:wp:searchreplace`
 
    Runs a search and replace operation on the tables in a WordPress installation.
-5. `cap {env} cul:wp:update:core`
+5. `cap {env} cul:wp:migrate:copy_from`
+
+   Copies the WordPress installation from one environment to another (e.g. prod to dev)
+6. `cap {env} cul:wp:update:core`
 
    Updates WordPress core to the latest version.
-6. `cap {env} cul:wp:update:plugins`
+7. `cap {env} cul:wp:update:plugins`
 
    Updates non-repo-managed plugins to the latest version.
-7. `cap {env} cul:wp:update:themes`
+8. `cap {env} cul:wp:update:themes`
 
    Updates non-repo-managed themes to the latest version.
-8. `cap {env} cul:wp:update:all`
+9. `cap {env} cul:wp:update:all`
 
    Updates WordPress core, plugins, and themes (in that order) by calling update:core, update:plugins and update:themes tasks.
 

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.13

data/lib/capistrano/tasks/wp.cap

@@ -1,6 +1,51 @@
+CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME = 'cul-allowed-upload-types'
+CUL_ALLOWED_UPLOAD_TYPES_REPO_URL = "https://github.com/cul/#{CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME}"
+
+# Set cul_allowed_uplaod_types_version here so it can be overridden by env config
+set :cul_allowed_uplaod_types_version, 'v0.2.0'
+
 namespace :cul do
   namespace :wp do
+    before 'deploy:starting', 'cul:wp:display_maintenance_mode_warning'
+    after 'deploy:starting', 'cul:wp:enable_maintenance_mode'
+    after 'deploy:starting', 'cul:wp:update_cul_allowed_upload_types_plugin'
     after :deploy, 'cul:wp:symlink_custom_plugins_and_themes'
+    after :deploy, 'cul:wp:disable_maintenance_mode'
+
+    desc "Displays a message to the deploying user about how to disable maintenance mode"
+    task :display_maintenance_mode_warning do
+      puts color_text("WARNING: Starting a deployment will set WordPress to maintenance mode.  If you cancel deployment mid-way through, you'll need to manually disable maintenance mode by running: cap [env] cul:wp:disable_maintenance_mode")
+    end
+
+    desc "Enables maintenance mode for the WordPress site in the deploy environment"
+    task :enable_maintenance_mode do
+      path_to_maintenance_file = maintenance_file_path # save path to local variable because we can't call method inside `on roles(:web)`
+      on roles(:web) do
+        within fetch(:wp_docroot) do
+          # Set maintenance $upgrading value to current time.
+          # Note that WordPress will ignore maintenance mode file
+          # after 10 minutes have passed after the maintenance time
+          # we set in the file.
+          execute :echo, "'<?php $upgrading = #{Time.now.to_i};'", '>', path_to_maintenance_file
+        end
+      end
+      puts color_text("Maintenance mode enabled!")
+    end
+
+    desc "Disable maintenance mode for the WordPress site in the deploy environment"
+    task :disable_maintenance_mode do
+      path_to_maintenance_file = maintenance_file_path # save path to local variable because we can't call method inside `on roles(:web)`
+      on roles(:web) do
+        within fetch(:wp_docroot) do
+          if test("[ -f #{path_to_maintenance_file} ]")
+            execute :rm, path_to_maintenance_file
+          else
+            puts "No maintenance file found, so there's nothing to delete."
+          end
+        end
+      end
+      puts color_text("Maintenance mode disabled!")
+    end
 
     desc "Creates symlinks for custom plugins and themes as part of a WordPress deployment. Generally run as an `after :deploy` hook."
     task :symlink_custom_plugins_and_themes do
@@ -77,7 +122,6 @@ namespace :cul do
         # Create symlink for wp_document_root wp-content to wp_content_path
         execute :ln, '-sf', wp_content_path, wp_docroot_wp_content_path
       end
-
       symlink_custom_plugins_and_themes
     end
 
@@ -119,17 +163,17 @@ namespace :cul do
 
         if test("[ -d #{wp_content_path} ]")
 
-          # Create necessary directories
+          ### Create necessary directories
           execute :mkdir, '-p', wp_content_plugin_path
           execute :mkdir, '-p', wp_content_mu_plugin_path
           execute :mkdir, '-p', wp_content_themes_path
 
-          # Remove old symlinks
+          ### Remove old symlinks
           [wp_content_plugin_path, wp_content_mu_plugin_path, wp_content_themes_path].each do |dir|
             execute :find, dir, '-maxdepth 1', '-type l', '-exec rm {} \;'
           end
 
-          # Add latest symlinks
+          ### Add latest symlinks
           fetch(:wp_custom_plugins, {}).each do |plugin, repo_relative_path|
             execute :ln, '-sf', File.join(current_path, repo_relative_path), File.join(wp_content_plugin_path, plugin)
           end
@@ -141,6 +185,43 @@ namespace :cul do
           fetch(:wp_custom_themes, {}).each do |theme, repo_relative_path|
             execute :ln, '-sf', File.join(current_path, repo_relative_path), File.join(wp_content_themes_path, theme)
           end
+
+          ### Also symlink to cul-allowed-upload-types plugin files
+          within deploy_path do
+            cul_allowed_upload_types_plugin_top_level_files_and_dirs = capture(:find, CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME, '-mindepth', '2', '-maxdepth', '2').split("\n")
+            # Symlink all plugin files and directories
+            cul_allowed_upload_types_plugin_top_level_files_and_dirs.each do |plugin_file_or_directory_path|
+              #puts 'Run: ' + [:ln, '-sf', File.join(deploy_path, plugin_file_or_directory_path), File.join(wp_content_mu_plugin_path, File.basename(plugin_file_or_directory_path))].join(' ')
+              execute :ln, '-sf', File.join(deploy_path, plugin_file_or_directory_path), File.join(wp_content_mu_plugin_path, File.basename(plugin_file_or_directory_path))
+            end
+          end
+
+        end
+      end
+    end
+
+    desc "Downloads the latest version of the cul-allowed-upload-types plugin"
+    task :update_cul_allowed_upload_types_plugin do
+      # Download plugin to deploy_path
+      on roles(:web) do
+        within deploy_path do
+          # Clear out old plugin directory if it exists
+          execute :rm, '-rf', CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME
+          # Re-create plugin directory and temp dir inside of it
+          allowed_upload_types_tempdir = File.join(CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME, 'tmp')
+          execute :mkdir, '-p', allowed_upload_types_tempdir
+
+          # Download and unzip plugin
+          allowed_upload_types_temp_zipfile = File.join(allowed_upload_types_tempdir, 'plugin.zip')
+          zip_file_name = "#{fetch(:cul_allowed_uplaod_types_version)}.zip"
+          execute :curl, '-L', '--silent', '-o', allowed_upload_types_temp_zipfile, "#{CUL_ALLOWED_UPLOAD_TYPES_REPO_URL}/archive/#{zip_file_name}"
+          execute :unzip, allowed_upload_types_temp_zipfile, '-d', CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME
+
+          # Delete temp dir after unzip
+          execute :rm, '-rf', allowed_upload_types_tempdir
+
+          # Remove .gitignore file from plugin directory so we don't symlink to it later
+          execute :find, CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME, '-name', '.gitignore', '-delete'
         end
       end
     end
@@ -176,5 +257,19 @@ namespace :cul do
       end
     end
 
+    def self.cul_allowed_upload_types_plugin_path
+      File.join('mu-plugins', CUL_ALLOWED_UPLOAD_TYPES_PLUGIN_NAME)
+    end
+
+    def self.maintenance_file_path
+      File.join(fetch(:wp_docroot), '.maintenance')
+    end
+
+    def self.color_text(message, color_number=35)
+      text_color = "\e[#{color_number}m"
+      default_color = "\e[0m"
+      text_color + message + default_color
+    end
+
   end
 end

data/lib/capistrano/tasks/wp/migrate.cap

@@ -1,4 +1,5 @@
 require 'tempfile'
+require 'json'
 
 namespace :cul do
   namespace :wp do
@@ -6,6 +7,8 @@ namespace :cul do
 
       desc "Copies the WordPress installation from one environment to another (e.g. prod to dev)"
       task :copy_from do
+        # Need to store path as local variable so it can be referenced in `on roles(:web) do` portion of script
+        path_to_allowed_upload_types_plugin = cul_allowed_upload_types_plugin_path
 
         require_cap_params!([:wp_docroot, :wp_content_path])
 
@@ -33,31 +36,121 @@ namespace :cul do
           next
         end
 
+        # Enter maintenance mode
+        invoke 'cul:wp:enable_maintenance_mode'
+
         # Check WP version on source and destination WordPress instances
+        failure = false
         on roles(:web) do
           within fetch(:src_wp_docroot) do
             # Ensure that source WordPress is running the latest version
             result = capture :wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'core', 'check-update'
             unless result.index('Success')
               puts 'Could not copy from source WordPress because it is not running the latest version of WordPress. Please update source before running a copy operation.'
+              failure = true
             end
           end
-
           within fetch(:wp_docroot) do
             # Ensure that destination WordPress is running the latest version
             result = capture :wp, (fetch(:multisite, false) ? "--url=#{fetch(:destination_site_multisite_url)}" : ''), 'core', 'check-update'
             unless result.index('Success')
               puts "Could not copy TO destination [#{fetch(:stage)}] WordPress because it is not running the latest version of WordPress. Please update [#{fetch(:stage)}] before running a copy operation."
+              failure = true
             end
           end
         end
+        next if failure # End if the previous checks failed
+
+        path_to_list_of_files_to_copy = ''
+
         on roles(:web) do
+          # In source site's wp-content directory, generate file list to copy
+          within File.join(fetch(:src_wp_docroot), 'wp-content') do
+            # We're going to be copying wp-content in two parts
+            # 1. Everything else under wp-content EXCEPT uploads, blogs.dir,
+            # plugins, themes, mu-plugins
+            # 2. Everything under uploads AND wpblogs.dir with
+            # cul-allowed-upload-types file extension filter applied
+
+            # Generate two find commands for the above searches
+            find_non_upload_dirs = '. -type f ' +
+              # EXCLUDE plugins, themes, mu-plugins, uploads, and blogs.dir
+              "-not \\( -path './plugins/*' -o -path './mu-plugins/*' -o -path './themes/*' -o -path './uploads/*' -o -path './blogs.dir/*' \\) " +
+              # EXCLUDE certain unwanted files and paths
+              "-a -not \\( -name '.nfs*' \\) " +
+              "-a -not \\( -path '*/.git*' -o -path '*/.svn*' -o -path '*/.hg*' \\) "
+
+            find_upload_dirs = '. -type f ' +
+              # INCLUDE ONLY uploads and blogs.dir
+              "\\( -path './uploads/*' -o -path './blogs.dir/*' \\) " +
+              # EXCLUDE certain unwanted files and paths
+              "-a -not \\( -name '.nfs*' \\) " +
+              "-a -not \\( -path '*/.git*' -o -path '*/.svn*' -o -path '*/.hg*' \\) " +
+              # INCLUDE ONLY certain file extensions
+              "-a \\( " + JSON.parse(capture(:wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'eval', '"echo cul_allowed_upload_file_extensions_as_json();"')).map{ |allowed_file_extension|
+                "-iname '*.#{allowed_file_extension}'"
+              }.join(' -o ') + " \\) "
+
+            path_to_list_of_files_to_copy = '/tmp/WP' + fetch(:wp_docroot).gsub('/', '-') + '-' + Time.now.to_i.to_s + '-files.txt'
+            execute :find, find_non_upload_dirs, ' > ', path_to_list_of_files_to_copy
+            execute :find, find_upload_dirs, ' >> ', path_to_list_of_files_to_copy
+
+            # Print out which files won't be copied
+            files_not_copied = capture(:comm, '-23', "<(find . -type f -path './uploads/*' -o -path './blogs.dir/*' | sort)", "<(find #{find_upload_dirs} | sort)")
+
+            puts (
+              "The following files will not be copied:\n" +
+              "-------------------------\n" +
+              "./plugins\n" +
+              "./mu-plugins\n" +
+              "./themes\n" +
+              files_not_copied + "\n" +
+              "-------------------------"
+            )
+          end
+
+          # For destination wordpress, delete and recreate the wp-content directory
+          execute :rm, '-rf', fetch(:wp_content_path)
+          execute :mkdir, fetch(:wp_content_path)
+
+          # Copy wp-content files (from path_to_list_of_files_to_copy) from source WP to destination WP
+          # Note that because we have the '--copy-links' flag below, we're transforming all symlinks into real file copies
+          rsync_params = [
+            '--recursive',
+            '--perms',
+            '--times',
+            '--devices',
+            '--specials',
+            '--copy-links',
+            '--prune-empty-dirs'
+          ]
+
+          # we're only copying files from the given file list
+          rsync_params << "--files-from=#{path_to_list_of_files_to_copy}"
+          # src directory (--files-from values are relative to this src directory)
+          rsync_params << File.join(fetch(:src_wp_docroot), 'wp-content/')
+          # dest directory
+          rsync_params << fetch(:wp_content_path) + '/'
+
+          puts 'Copying wp-content. This may take a while for sites with a lot of uploads...'
+
+          execute :rsync, *rsync_params
+
+          # Next, create symlinks to repo-managed plugins and themes, which will also recreate plugins, mu-plugins, and themes directories
+
+          within fetch(:wp_docroot) do
+            # Regenerate symlinks
+            invoke 'cul:wp:symlink_custom_plugins_and_themes'
+          end
+
+          # Now it's time to copy the database
 
           db_export_tempfile_path = ''
 
           within fetch(:src_wp_docroot) do
             # On source WordPress...
 
+            puts 'Exporting database from source site. This may take a while for large sites...'
             # Export source WP DB to a temporary file
             db_export_tempfile_path = Dir::Tmpname.make_tmpname '/tmp/', 'db_export_tempfile.sql'
             execute :wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'db', 'export', db_export_tempfile_path
@@ -66,6 +159,8 @@ namespace :cul do
           within fetch(:wp_docroot) do
             # On destination WordPress...
 
+            puts 'Importing database. This may take a while for large sites...'
+
             # Drop all tables
             execute :wp, 'db', 'reset', '--yes'
 
@@ -75,78 +170,84 @@ namespace :cul do
             # Delete db file now that we're done with it
             execute :rm, db_export_tempfile_path
 
-            # Delete and recreate the wp-content directory
-            execute :rm, '-rf', fetch(:wp_content_path)
-            execute :mkdir, fetch(:wp_content_path)
-
-            # Copy wp content from source, ignoring .nfs* lock files
-            # Note that because we have the '--copy-links' flag below, we're transforming all symlinks into real file copies
-            rsync_params = [
-              '--recursive',
-              '--perms',
-              '--times',
-              '--devices',
-              '--specials',
-              '--copy-links'
-            ]
-            # Exclude all repo-managed plugins, mu_plugins and themes
-            fetch(:wp_custom_plugins, {}).each do |plugin, repo_relative_path|
-              rsync_params << "--exclude plugins/#{plugin}"
-            end
-            fetch(:wp_custom_mu_plugins, {}).each do |mu_plugin, repo_relative_path|
-              rsync_params << "--exclude mu-plugins/#{mu_plugin}"
-            end
-
-            fetch(:wp_custom_themes, {}).each do |theme, repo_relative_path|
-              rsync_params << "--exclude themes/#{theme}"
+            # Invoke searchreplace task to update URL
+            puts "\nYou'll probably want to run the cul:wp:searchreplace command now, since it's likely that your WP URL differs between environments."
+            puts "Do you want to run a search and replace operation?"
+            set :confirm_searchreplace, ask('"y" or "yes" to continue')
+            if ['y', 'yes'].include?(fetch(:confirm_searchreplace))
+              invoke 'cul:wp:searchreplace'
+            else
+              puts '- Skipping search and replace because neither "y" nor "yes" were entered.'
             end
 
-            # Exclude .nfs* lock files
-            rsync_params << '--exclude .nfs*'
-
-            # Exclude Wordfence wflogs directory, if present
-            rsync_params << '--exclude wflogs'
-
-            # Exclude repository directories
-            rsync_params << '--exclude .svn'
-            rsync_params << '--exclude .git'
-            rsync_params << '--exclude .hg'
+            puts "\nCopy operation complete!"
+          end
 
-            # Define copy src
-            rsync_params << File.join(fetch(:src_wp_docroot), 'wp-content/')
+          # Next, install all plugins and themes from src wordpress, matching all versions and active vs. inactive plugin and theme states
 
-            # Define copy dest
-            rsync_params << fetch(:wp_content_path) + '/'
+          data_for_plugins = []
+          data_for_themes = []
 
-            puts 'Copying wp-content. This may take a while for sites with a lot of uploads, plugins or themes...'
+          # Within src wp instance, get list of all plugins and themes with version
+          within File.join(fetch(:src_wp_docroot)) do
+            data_for_plugins = JSON.parse(capture(:wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'plugin', 'list', '--fields=name,version,status', '--format=json'))
+            data_for_themes = JSON.parse(capture(:wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'theme', 'list', '--fields=name,version,status', '--format=json'))
+          end
 
-            execute :rsync, *rsync_params
+          # Within dest wp instance, install specifically versioned plugins and themes
+          within File.join(fetch(:wp_docroot)) do
+            # Get list of already-installed plugins and themes (from dest instance) so that we don't attempt to reinstall them
+            already_installed_plugin_names = JSON.parse(capture(:wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'plugin', 'list', '--fields=name,version,status', '--format=json')).map{|plugin_info| plugin_info['name']}
+            already_installed_theme_names = JSON.parse(capture(:wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'theme', 'list', '--fields=name,version,status', '--format=json')).map{|theme_info| theme_info['name']}
+
+            puts 'Already installed plugins: ' + already_installed_plugin_names.inspect
+            puts 'Already installed themes: ' + already_installed_theme_names.inspect
+
+            data_for_plugins.delete_if{|plugin_info| already_installed_plugin_names.include?(plugin_info['name']) }.each do |plugin_info|
+              name = plugin_info['name']
+              version = plugin_info['version']
+              status = plugin_info['status']
+
+              case status
+              when 'active'
+                execute :wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'plugin', 'install', name, "--version=#{version}", '--activate'
+              when 'active-network'
+                execute :wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'plugin', 'install', name, "--version=#{version}", '--activate-network'
+              when 'inactive'
+                execute :wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'plugin', 'install', name, "--version=#{version}"
+              when 'must-use'
+                puts "--- WARNING: must-use plugin #{name} was not migrated over.  It should be put in your blog's repository and deployed through a regular deployment."
+              end
+            end
 
-            # Regenerate symlinks
-            invoke 'cul:wp:symlink_custom_plugins_and_themes'
+            data_for_themes.delete_if{|theme_info| already_installed_theme_names.include?(theme_info['name']) }.each do |theme_info|
+              name = theme_info['name']
+              version = theme_info['version']
+              status = theme_info['status']
+
+              case status
+              when 'active'
+                execute :wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'theme', 'install', name, "--version=#{version}", '--activate'
+              when 'inactive'
+                execute :wp, (fetch(:multisite, false) ? "--url=#{fetch(:source_site_multisite_url)}" : ''), 'theme', 'install', name, "--version=#{version}"
+              end
+            end
+          end
 
+          within fetch(:wp_docroot) do
             # Make docroot readable and executable for "other" user so nginx, which runs as "nobody", can read
             # Use -L flag because we want to follow symlinks. The whole deployment relies on symlinks.
             execute :find, '-L', File.join(fetch(:wp_docroot), 'wp-content'), '-type d -exec chmod o+rx "{}" \;'
             execute :find, '-L', File.join(fetch(:wp_docroot), 'wp-content'), '-type f -exec chmod o+r "{}" \;'
-
-            # Invoke searchreplace task to update URL
-            puts "\nYou'll probably want to run the cul:wp:searchreplace command now, since it's likely that your WP URL differs between environments."
-            puts "Do you want to run a search and replace operation?"
-            set :confirm_searchreplace, ask('"y" or "yes" to continue')
-            if ['y', 'yes'].include?(fetch(:confirm_searchreplace))
-              invoke 'cul:wp:searchreplace'
-            else
-              puts '- Skipping search and replace because neither "y" nor "yes" were entered.'
-            end
-
-            puts "\nCopy operation complete!"
+            # Make sure that wp-config file is not world readable
+            execute :chmod, 'o-r', shared_path.join('wp-config.php')
           end
 
         end
-
       end
 
+      after 'cul:wp:migrate:copy_from', 'cul:wp:disable_maintenance_mode'
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-cul
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Carla Galarza
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Common capistrano tasks shared across projects at CUL