itgwiki_mirror 0.0.18.pre

data/bin/itgwiki_mirror_backup

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'itgwiki_mirror'
+require 'itgwiki_mirror/backuper'
+require 'optparse'
+
+USAGE = 'Usage: itgwiki_mirror_backup [options] user@host[:port]'
+
+def usage
+  puts USAGE
+end
+
+options = {}
+OptionParser.new do |opts|
+
+  opts.banner = USAGE
+
+  opts.on '-v', '--verbose', 'Run verbosely (off by default)' do |v|
+    options[:verbose] = v
+  end
+
+  opts.on '-u', '--db-username USERNAME', 'USERNAME for mysqldump' do |u|
+    options[:db_user] = u
+  end
+
+  opts.on '-p', '--dp-password PASSWORD', 'PASSWORD for mysqldump' do |p|
+    options[:db_pass] = p
+  end
+
+  opts.on '-d', '--db-name NAME', 'NAME of the database for mysqldump' do |d|
+    options[:db_name] = d
+  end
+
+  opts.on '-w', '--wiki-root ROOT', 'The ROOT of the wiki (e.g. /var/www/w)' do |w|
+    options[:wiki_root] = w.sub(/\/$/, '') # remove trailing slash
+  end
+
+  opts.on '-t', '--remote-rsync-target TARGET', 'The remote rsync TARGET (i.e. destination directory)' do |t|
+    options[:rsync_target] = t
+  end
+
+end.parse!
+
+# set user, host, and port from ARGV (port is optional)
+#
+begin
+  options[:user] = /^(.+)@/.match(ARGV[0])[1]
+  options[:host] = /@([^:]+)/.match(ARGV[0])[1]
+  options[:port] = /:(\d+)/.match(ARGV[0])[1].to_i if /:/.match ARGV[0]
+rescue
+  usage
+  exit 1
+end
+
+if $DEBUG
+  p options
+end
+
+if ITGwikiMirror::Backuper.new(options).backup
+  puts 'Success! No problems encountered during backup.' if options[:verbose]
+else
+  STDERR.puts 'Errors were encountered. Backup was not completed.'
+end
+

data/bin/itgwiki_mirror_deploy

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'itgwiki_mirror'
+require 'itgwiki_mirror/deployer'
+require 'optparse'
+
+USAGE = 'Usage: itgwiki_mirror_backup [options] user@host[:port]'
+
+def usage
+  puts USAGE
+end
+
+options = {}
+OptionParser.new do |opts|
+
+  opts.banner = USAGE
+
+  opts.on '-v', '--verbose', 'Run verbosely (off by default)' do |v|
+    options[:verbose] = v
+  end
+
+  opts.on '-u', '--db-username USERNAME', 'USERNAME for mysql import' do |u|
+    options[:db_user] = u
+  end
+
+  opts.on '-p', '--dp-password PASSWORD', 'PASSWORD for mysql import' do |p|
+    options[:db_pass] = p
+  end
+
+  opts.on '-d', '--db-name NAME', 'NAME of the database for mysql import' do |d|
+    options[:db_name] = d
+  end
+
+  opts.on '-w', '--wiki-root ROOT', 'The ROOT of the wiki (e.g. /var/www/w)' do |w|
+    options[:wiki] = w.sub(/\/$/, '') # remove trailing slash
+  end
+
+  opts.on '-m', '--mirror-directory DIRECTORY', 'Target of rsync from ITGwiki' do |m|
+    options[:mirror] = m
+  end
+
+  opts.on '-f', '--foreground', '--no-daemon', 'Run in foreground (do not daemonize)' do |f|
+    options[:foreground] = f
+  end
+
+end.parse!
+
+if $DEBUG
+  p options
+end
+
+#
+# FIXME should this have some kind of "exec" or something? Ready about threads
+# in Ruby. Be sure to handle signal processing (kill, term, etc.)
+#
+ITGwikiMirror::Deployer.new(options).run
+

data/lib/itgwiki_mirror.rb

@@ -0,0 +1,3 @@
+module ITGwikiMirror
+end
+

data/lib/itgwiki_mirror/backuper.rb

@@ -0,0 +1,163 @@
+require 'tempfile'
+
+module ITGwikiMirror
+
+
+  class Backuper
+
+
+    def initialize opts
+
+      # verbose mode
+      #
+      @verbose = opts[:verbose]
+
+      # mysql options
+      #
+      @db_user = opts[:db_user]
+      @db_pass = opts[:db_pass]
+      @db_name = opts[:db_name]
+
+      # ssh options
+      #
+      @user = opts[:user]
+      @host = opts[:host]
+      @port = opts[:port]
+
+      # MediaWiki root
+      #
+      @wiki_root = opts[:wiki_root]
+
+      # rsync target
+      #
+      @rsync_target = opts[:rsync_target]
+      
+      # mysqldump temporary file
+      #
+      @dumpfile = Tempfile.new('itgwiki_mirror_mysqldump').path
+    end
+
+
+    #
+    # Perform the backup
+    #
+    # Dump the database, rsync the database, the wiki directory, and any other
+    # specified files (configuration, etc.) to the remote host. If any of these
+    # steps fails, stop and return false. If they're all successful, return
+    # true.
+    #
+    def backup
+
+      #
+      # FIXME I repeat the $?.success? block over and over. Probably extract to a method.
+      #
+
+      # print immediately so we get the nice 'msg...' -> 'msg...OK' transition
+      # instead of waiting until the jobs is finished to print the message.
+      #
+      STDOUT.sync = true
+
+
+      print 'mysqldump...' if @verbose
+      mysqldump
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'mysqldump failed'
+        return false
+      end
+
+      print 'rsyncing mysqldump...' if @verbose
+      rsync_mysqldump
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'rsyncing mysqldump failed'
+        return false
+      end
+
+
+      print 'rsyncing wiki directory...' if @verbose
+      rsync_wiki_dir
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'rsyncing wiki directory failed'
+        return false
+      end
+
+      print 'Notifying mirror that backup is complete...' if @verbose
+      notify_complete
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'Notifying mirror failed'
+        return false
+      end
+
+      return true
+    end
+
+
+    private
+
+
+    def mysqldump
+
+      # XXX You CANNOT have a space between -p and the password
+      #
+      %x( mysqldump -u#{@db_user} -p#{@db_pass} #{@db_name} > #{@dumpfile} )
+
+      puts %( mysqldump -u#{@db_user} -p#{@db_pass} #{@db_name} > #{@dumpfile} ) if $DEBUG
+    end
+
+
+    #
+    # rsync from src to dst with options
+    #   -a (archive mode)
+    #   -vP (verbose mode along with partial and progress display) if @verbose
+    #   --rsh='ssh -p###' (use ### as ssh port for rsync ) if an alternate port is defined
+    #
+    def rsync src, dst
+
+      # archive mode
+      #
+      opts = '-a'
+      
+      # verbose transfer if requested
+      #
+      opts += ' -vP' if @verbose
+
+      # specify an alternate port if requested
+      #
+      opts += " --rsh='ssh -p#{@port}'" if @port
+
+      puts %( rsync #{opts} #{src} #{dst} ) if $DEBUG
+
+      %x( rsync #{opts} #{src} #{dst} )
+    end
+
+
+    def rsync_mysqldump
+      rsync @dumpfile, "#{@user}@#{@host}:#{@rsync_target}/itgwiki.mysqldump"
+    end
+
+
+    def rsync_wiki_dir
+      rsync @wiki_root, "#{@user}@#{@host}:#{@rsync_target}"
+    end
+
+
+    def notify_complete
+
+      # specify port if defined
+      #
+      port = "-p#{@port}" if @port
+      
+      # just touch a file called "complete" in the mirror target
+      #
+      %x( ssh #{@user}@#{@host} #{port} touch #{@rsync_target}/complete )
+    end
+  end
+end
+

data/lib/itgwiki_mirror/deployer.rb

@@ -0,0 +1,211 @@
+module ITGwikiMirror
+   
+  class Deployer < SimpleDaemon::Base
+
+
+    READ_ONLY_MSG = 'This is a mirror of the wiki. Visit the live site to make changes.'
+
+
+    def initialize opts
+
+      # verbose mode
+      #
+      @verbose    = opts[:verbose]
+
+      # mysql options
+      #
+      @db_user = opts[:db_user]
+      @db_pass = opts[:db_pass]
+      @db_name = opts[:db_name]
+
+      # MediaWiki root
+      #
+      @wiki  = opts[:wiki]
+
+      # mirror directory (target of rsync from ITGwiki)
+      #
+      @mirror = opts[:mirror]
+    end
+
+    def run
+
+      # Watch the complete file. When it's touched, deploy again.
+      notifier = INotify:Notifier.new
+      notifier.watch("#{@wiki}/complete", :modify) { deploy }
+    end
+
+
+    private 
+
+
+    def success
+      puts 'Success! No problems encountered during deployment.' if @verbose
+    end
+
+
+    def failure
+      STDERR.puts 'Errors were encountered. Deployment was not completed.'
+    end
+
+    #
+    # Deploy the newly synced content to the mirror server
+    #
+    # Drop the old database, create a new one, import the mysqldump, modify the
+    # local MediaWiki configuration:
+    # 
+    #  * disable the $wgServer string
+    #  * disable Sphinx search
+    #  * set maintenance mode (read-only)
+    #
+    # Finally, rsync the local modified version into the live mirror MediaWiki
+    # root.
+    #
+    def deploy
+
+      #
+      # FIXME I repeat the $?.success? block over and over. Probably extract to a method.
+      #
+      
+      # print immediately so we get the nice 'msg...' -> 'msg...OK' transition
+      # instead of waiting until the jobs is finished to print the message.
+      #
+      STDOUT.sync = true
+
+      print 'Dropping database...' if @verbose
+      drop_db
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'Dropping database failed'
+        failure
+      end
+
+      print 'Creating database...' if @verbose
+      create_db
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'Creating database failed'
+        failure
+      end
+
+      print 'Importing mysqldump...' if @verbose
+      import_mysqldump
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'Importing mysqldump failed'
+        failure
+      end
+
+      print 'Disabling $wgServer string...' if @verbose
+      disable_server_string
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'Disabling $wgServer string failed'
+        failure
+      end
+
+      print 'Disabling sphinx search...' if @verbose
+      disable_sphinx_search
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'Disabling sphinx search failed'
+        failure
+      end
+
+      print 'Setting maintenance mode...' if @verbose
+      set_maintenance_mode
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'Setting maintenance mode failed'
+        failure
+      end
+
+      print 'rsyncing modified mirror content to mirror site content...' if @verbose
+      rsync
+      if $?.success?
+        puts 'OK' if @verbose
+      else
+        STDERR.puts 'rsyncing modified mirror content to mirror site content failed' if @verbose
+        failure
+      end
+
+      success
+    end
+
+
+    def drop_db
+
+      # XXX no space allowed between -p and password
+      #
+      %x( mysql -u#{@db_user} -p#{@db_pass} -e 'drop database #{@db_name}' )
+    end
+
+
+    def create_db
+
+      # XXX no space allowed between -p and password
+      #
+      %x( mysql -u#{@db_user} -p#{@db_pass} -e 'create database #{@db_name}' )
+    end
+
+
+    def import_mysqldump
+
+      # XXX no space allowed between -p and password
+      #
+      %x( mysql -u#{@db_user} -p#{@db_pass} #{@db_name} < #{@mirror}/itgwiki.mysqldump )
+    end
+
+
+    def disable_server_string
+
+      #
+      # The server string is necessary in the production instance because it's
+      # the only way to tell the service which is behind a proxy that it should
+      # have a certain domain name and that it should use https. For the mirror,
+      # it can successfully be ascertained automatically by the MediaWiki
+      # software.
+      #
+
+      # comment the wgServer line
+      #
+      %x( sed -i '/wgServer/ s/^/#/' #{@mirror}/w/LocalSettings.php )
+    end
+
+
+    def disable_sphinx_search
+
+      # comment lines with the word sphinx (case insensitive) in them that are
+      # not already commented
+      #
+      %x( sed -i '/^[^#].*sphinx/I s/^/#/' #{@mirror}/w/LocalSettings.php )
+    end
+
+
+    def set_maintenance_mode
+
+      # append readonly message to config file
+      #
+      %x( echo '$wgReadOnly = "#{READ_ONLY_MSG}";' >> #{@mirror}/w/LocalSettings.php )
+    end
+
+
+    def rsync
+
+      # XXX being a local rsync (a simple file copy) we're not going to bother with
+      # allowing verbose mode or other options. Just a straight archive (-a)
+      # copy.
+      #
+      # XXX There is a trailing slash on the rsync source because we want to
+      # sync the contents of the directory into the wiki directory. `man rsync`
+      # for more details.
+      #
+      %x( rsync -a #{@mirror}/w/ #{@wiki} )
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: itgwiki_mirror
+version: !ruby/object:Gem::Version
+  version: 0.0.18.pre
+  prerelease: 7
+platform: ruby
+authors:
+- Justin Force
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &78672600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *78672600
+description: ! "\n    Use two scripts, itgwiki_mirror_backup and itgwiki_mirror_deploy,
+  to\n    maintain a read-only mirror of ITGwiki. itgwiki_mirror_backup runs\n    periodically
+  and automatically on the live instance of ITGwiki to create a\n    backup and copy
+  it to the mirror. itgwiki_mirror_deploy runs on the mirror\n    and is triggered
+  by itgwiki_mirror_backup, imports and adjusts the backup\n    to be read-only, then
+  deploys it on the mirror server. Requires rsync and\n    mysqldump.\n  "
+email: justin.force@gmail.com
+executables:
+- itgwiki_mirror_backup
+- itgwiki_mirror_deploy
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/itgwiki_mirror.rb
+- lib/itgwiki_mirror/backuper.rb
+- lib/itgwiki_mirror/deployer.rb
+- bin/itgwiki_mirror_backup
+- bin/itgwiki_mirror_deploy
+homepage: https://github.com/sidewaysmilk/itgwiki_mirror
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- mysqldump
+- rsync
+- sed
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Maintain a read-only mirror of ITGwiki
+test_files: []