Noosfero: apply patch with backup and restore task

Alexandre Barbosa
1 parent 742fdfb6
Showing 2 changed files with 140 additions and 1 deletions Show diff stats
patches/noosfero/0001-Enhance-existing-backup-task-and-add-a-restore-one.patch
specs/noosfero/noosfero.spec
@@ -0,0 +1,137 @@
+From c1918dc6090c011a297bc470c04d4158410e61b8 Mon Sep 17 00:00:00 2001
+From: Antonio Terceiro <terceiro@colivre.coop.br>
+Date: Wed, 11 Feb 2015 19:55:30 -0200
+Subject: [PATCH] Enhance existing backup task and add a restore one
+
+- `rake backup` will now create a tarball with everything that needs to
+  be backed up (files + database dump)
+
+- `rake restore BACKUP=/path/to/(...).tar.gz` will restore that backup
+  over the current Noosfero instance.
+
+Multi-tenant setups are not supported yet.
+---
+ lib/tasks/backup.rake | 111 +++++++++++++++++++++++++++++++++++++++++++++++---
+ 1 file changed, 105 insertions(+), 6 deletions(-)
+
+diff --git a/lib/tasks/backup.rake b/lib/tasks/backup.rake
+index 849d4d6..7e64d17 100644
+--- a/lib/tasks/backup.rake
++++ b/lib/tasks/backup.rake
+@@ -1,8 +1,107 @@
+-desc "Creates a backup of the user files stored in public/"
+-task :backup do
+-  dirs = Dir.glob('public/images/[0-9][0-9][0-9][0-9]') + ['public/articles', 'public/thumbnails', 'public/user_themes'].select { |d| File.exists?(d) }
+-  tarball = 'backups/files-' + Time.now.strftime('%Y-%m-%d-%R') + '.tar'
++task :load_backup_config do
++  $config = YAML.load_file('config/database.yml')
++end
++
++task :check_backup_support => :load_backup_config do
++  if $config['production']['adapter'] != 'postgresql'
++    fail("Only PostgreSQL is supported for backups at the moment")
++  end
++end
++
++backup_dirs = [
++  'public/image_uploads',
++  'public/articles',
++  'public/thumbnails',
++  'public/user_themes',
++]
++
++desc "Creates a backup of the database and uploaded files"
++task :backup => :check_backup_support do
++  dirs = backup_dirs.select { |d| File.exists?(d) }
++
++  backup_name = Time.now.strftime('%Y-%m-%d-%R')
++  backup_file = File.join('tmp/backup', backup_name) + '.tar.gz'
++  mkdir_p 'tmp/backup'
++  dump = File.join('tmp/backup', backup_name) + '.sql'
++
++  database = $config['production']['database']
++  sh "pg_dump #{database} > #{dump}"
++
++  sh 'tar', 'caf', backup_file, dump, *dirs
++  rm_f dump
++
++  puts "****************************************************"
++  puts "Backup in #{backup_file} !"
++  puts
++  puts "To restore, use:"
++  puts "$ rake restore BACKUP=#{backup_file}"
++  puts "****************************************************"
++end
++
++def invalid_backup!(message, items=[])
++  puts "E: #{message}"
++  items.each do |i|
++    puts "E: - #{i}"
++  end
++  puts "E: Is this a backup archive created by Noosfero with \`rake backup\`?"
++  exit 1
++end
++
++desc "Restores a backup created previousy with \`rake backup\`"
++task :restore => :check_backup_support do
++  backup = ENV["BACKUP"]
++  unless backup
++    puts "usage: rake restore BACKUP=/path/to/backup"
++    exit 1
++  end
++
++  files = `tar taf #{backup}`.split
++
++  # validate files in the backup
++  invalid_files = []
++  files.each do |f|
++    if f !~ /tmp\/backup\// && (backup_dirs.none? { |d| f =~ /^#{d}\// })
++      invalid_files << f
++    end
++  end
++  if invalid_files.size > 0
++    invalid_backup!("Invalid files found in the backup archive", invalid_files)
++  end
++
++  # find database dump in the archive
++  dumps = files.select do |f|
++    File.dirname(f) == 'tmp/backup' && f =~ /\.sql$/
++  end
++  if dumps.size == 0
++    invalid_backup!("Could not find a database dump in the archive.")
++  elsif dumps.size > 1
++    invalid_backup!("Multiple database dumps found in the archive:", dumps)
++  end
++  dump = dumps.first
++
++  database = $config['production']['database']
++  username = $config['production']['username']
++
++  puts "WARNING: backups should be restored to an empty database, otherwise"
++  puts "data from the backup may not be loaded properly."
++  puts
++  puts 'You can remove the existing database and create a new one with:'
++  puts
++  puts "$ sudo -u postgres dropdb #{database}"
++  puts "$ sudo -u postgres createdb #{database} --owner #{username}"
++  puts
++  print "Are you sure you want to continue (y/N)? "
++  response = $stdin.gets.strip
++  unless ['y', 'yes'].include?(response.downcase)
++    puts "*** ABORTED."
++    exit 1
++  end
++
++  sh 'tar', 'xaf', backup
++  sh "rails dbconsole production < #{dump}"
++  rm_f dump
+ 
+-  mkdir_p(File.dirname(tarball))
+-  sh('tar', 'cf', tarball, *dirs)
++  puts "****************************************************"
++  puts "Backup restored!"
++  puts "****************************************************"
+ end
+-- 
+2.1.4
+
 %define writable_dirs javascripts/cache stylesheets/cache articles image_uploads thumbnails
 Name:    noosfero
-Version: 1.1~rc2.3
+Version: 1.1~rc2.4
 Release: 2%{?dist}
 Summary: Social Networking Platform
 Group:   Applications/Publishing
@@ -9,6 +9,7 @@ License: AGPLv3
 URL:     http://noosfero.org
 Source0: %{name}-%{version}.tar.gz
 Patch0: 0001-Use-as-placeholder-for-current-user-in-URLs.patch 
+Patch1: 0001-Enhance-existing-backup-task-and-add-a-restore-one.patch
 BuildArch: noarch
 BuildRequires: noosfero-deps, gettext, po4a
 Requires: noosfero-deps, po4a, tango-icon-theme, memcached
@@ -23,6 +24,7 @@ participate and contribute to this free software project!
 %setup -q
 %patch0 -p1
+%patch1 -p1
 %build
@@ -0,0 +1,137 @@		@@ -0,0 +1,137 @@
	1	+From c1918dc6090c011a297bc470c04d4158410e61b8 Mon Sep 17 00:00:00 2001
	2	+From: Antonio Terceiro <terceiro@colivre.coop.br>
	3	+Date: Wed, 11 Feb 2015 19:55:30 -0200
	4	+Subject: [PATCH] Enhance existing backup task and add a restore one
	5	+
	6	+- `rake backup` will now create a tarball with everything that needs to
	7	+ be backed up (files + database dump)
	8	+
	9	+- `rake restore BACKUP=/path/to/(...).tar.gz` will restore that backup
	10	+ over the current Noosfero instance.
	11	+
	12	+Multi-tenant setups are not supported yet.
	13	+---
	14	+ lib/tasks/backup.rake \| 111 +++++++++++++++++++++++++++++++++++++++++++++++---
	15	+ 1 file changed, 105 insertions(+), 6 deletions(-)
	16	+
	17	+diff --git a/lib/tasks/backup.rake b/lib/tasks/backup.rake
	18	+index 849d4d6..7e64d17 100644
	19	+--- a/lib/tasks/backup.rake
	20	++++ b/lib/tasks/backup.rake
	21	+@@ -1,8 +1,107 @@
	22	+-desc "Creates a backup of the user files stored in public/"
	23	+-task :backup do
	24	+- dirs = Dir.glob('public/images/[0-9][0-9][0-9][0-9]') + ['public/articles', 'public/thumbnails', 'public/user_themes'].select { \|d\| File.exists?(d) }
	25	+- tarball = 'backups/files-' + Time.now.strftime('%Y-%m-%d-%R') + '.tar'
	26	++task :load_backup_config do
	27	++ $config = YAML.load_file('config/database.yml')
	28	++end
	29	++
	30	++task :check_backup_support => :load_backup_config do
	31	++ if $config['production']['adapter'] != 'postgresql'
	32	++ fail("Only PostgreSQL is supported for backups at the moment")
	33	++ end
	34	++end
	35	++
	36	++backup_dirs = [
	37	++ 'public/image_uploads',
	38	++ 'public/articles',
	39	++ 'public/thumbnails',
	40	++ 'public/user_themes',
	41	++]
	42	++
	43	++desc "Creates a backup of the database and uploaded files"
	44	++task :backup => :check_backup_support do
	45	++ dirs = backup_dirs.select { \|d\| File.exists?(d) }
	46	++
	47	++ backup_name = Time.now.strftime('%Y-%m-%d-%R')
	48	++ backup_file = File.join('tmp/backup', backup_name) + '.tar.gz'
	49	++ mkdir_p 'tmp/backup'
	50	++ dump = File.join('tmp/backup', backup_name) + '.sql'
	51	++
	52	++ database = $config['production']['database']
	53	++ sh "pg_dump #{database} > #{dump}"
	54	++
	55	++ sh 'tar', 'caf', backup_file, dump, *dirs
	56	++ rm_f dump
	57	++
	58	++ puts "****************************************************"
	59	++ puts "Backup in #{backup_file} !"
	60	++ puts
	61	++ puts "To restore, use:"
	62	++ puts "$ rake restore BACKUP=#{backup_file}"
	63	++ puts "****************************************************"
	64	++end
	65	++
	66	++def invalid_backup!(message, items=[])
	67	++ puts "E: #{message}"
	68	++ items.each do \|i\|
	69	++ puts "E: - #{i}"
	70	++ end
	71	++ puts "E: Is this a backup archive created by Noosfero with \`rake backup\`?"
	72	++ exit 1
	73	++end
	74	++
	75	++desc "Restores a backup created previousy with \`rake backup\`"
	76	++task :restore => :check_backup_support do
	77	++ backup = ENV["BACKUP"]
	78	++ unless backup
	79	++ puts "usage: rake restore BACKUP=/path/to/backup"
	80	++ exit 1
	81	++ end
	82	++
	83	++ files = `tar taf #{backup}`.split
	84	++
	85	++ # validate files in the backup
	86	++ invalid_files = []
	87	++ files.each do \|f\|
	88	++ if f !~ /tmp\/backup\// && (backup_dirs.none? { \|d\| f =~ /^#{d}\// })
	89	++ invalid_files << f
	90	++ end
	91	++ end
	92	++ if invalid_files.size > 0
	93	++ invalid_backup!("Invalid files found in the backup archive", invalid_files)
	94	++ end
	95	++
	96	++ # find database dump in the archive
	97	++ dumps = files.select do \|f\|
	98	++ File.dirname(f) == 'tmp/backup' && f =~ /\.sql$/
	99	++ end
	100	++ if dumps.size == 0
	101	++ invalid_backup!("Could not find a database dump in the archive.")
	102	++ elsif dumps.size > 1
	103	++ invalid_backup!("Multiple database dumps found in the archive:", dumps)
	104	++ end
	105	++ dump = dumps.first
	106	++
	107	++ database = $config['production']['database']
	108	++ username = $config['production']['username']
	109	++
	110	++ puts "WARNING: backups should be restored to an empty database, otherwise"
	111	++ puts "data from the backup may not be loaded properly."
	112	++ puts
	113	++ puts 'You can remove the existing database and create a new one with:'
	114	++ puts
	115	++ puts "$ sudo -u postgres dropdb #{database}"
	116	++ puts "$ sudo -u postgres createdb #{database} --owner #{username}"
	117	++ puts
	118	++ print "Are you sure you want to continue (y/N)? "
	119	++ response = $stdin.gets.strip
	120	++ unless ['y', 'yes'].include?(response.downcase)
	121	++ puts "*** ABORTED."
	122	++ exit 1
	123	++ end
	124	++
	125	++ sh 'tar', 'xaf', backup
	126	++ sh "rails dbconsole production < #{dump}"
	127	++ rm_f dump
	128	+
	129	+- mkdir_p(File.dirname(tarball))
	130	+- sh('tar', 'cf', tarball, *dirs)
	131	++ puts "****************************************************"
	132	++ puts "Backup restored!"
	133	++ puts "****************************************************"
	134	+ end
	135	+--
	136	+2.1.4
	137	+