Separate archive from database export

Author: marcjamot

api/restapi.py

@@ -472,14 +472,24 @@ def get_node(node):
         self.kserver.resolve(seller_guid).addCallback(get_node)
         return server.NOT_DONE_YET
 
-    @POST('^/api/v1/backup')
-    def backup(self, request):
-        tablesAndColumns = request.args["tablesAndColumns"][0]
+    @POST('^/api/v1/backup_files')
+    def backup_files(self, request):
         output = request.args["output"][0]
-        return backupTool.backup(tablesAndColumns, output)
+        return backupTool.backupFiles(output)
 
-    @POST('^/api/v1/restore')
-    def restore(self, request):
+    @POST('^/api/v1/export_database')
+    def export_database(self, request):
+        tables_and_columns = request.args["tables_and_columns"][0]
+        remove_previous = request.args["remove_previous"][0]
+        return backupTool.exportDatabase(tables_and_columns, remove_previous)
+
+    @POST('^/api/v1/restore_files')
+    def restore_files(self, request):
         input = request.args["input"][0]
-        deleteTableDataFirst = request.args["deleteTableDataFirst"][0]
-        return backupTool.restore(input, deleteTableDataFirst)
+        remove_previous_database_files = request.args["remove_previous_database_files"][0]
+        return backupTool.restoreFiles(input, remove_previous_database_files)
+
+    @POST('^/api/v1/import_database')
+    def import_database(self, request):
+        remove_previous = request.args["remove_previous"][0]
+        return backupTool.importDatabase(remove_previous)

backup.html

@@ -3,33 +3,44 @@
 <u>Underscored fields are required</u><br />
 Example data is provided below each input<br />
 <br />
-<b>Backup</b><br />
-<br />
-<form action="http://localhost:18469/api/v1/backup/" method="post">
-List of tables to backup (comma separated):<br />
-<input type="text" name="tablesAndColumns"><br>
-hashmap, profile, listings<br />
-<br />
+
+<b>Backup files</b><br /><br />
+<form action="http://localhost:18469/api/v1/backup_files/" method="post">
 Name of file to create (don't forget to add .tar.gz), leave empty for todays date:<br />
-<input type="text" name="output"><br>
-myveryspecialbackup.tar.gz<br />
-<br />
-<input type="submit" value="Backup" />
-</form>
-<br />
-<br />
-<b>Restore</b><br />
-<br />
-<form action="http://localhost:18469/api/v1/restore/" method="post">
+<input type="text" name="output"><br />
+myveryspecialbackup.tar.gz<br /><br />
+<input type="submit" value="Backup files" />
+</form><br /><br />
+
+<b>Export database</b><br /><br />
+<form action="http://localhost:18469/api/v1/export_database/" method="post">
+List of tables to backup (comma separated):<br />
+<input type="text" name="tables_and_columns"><br />
+hashmap, profile, listings<br /><br />
+If previous table files should be removed before export:<br />
+<input type="text" name="remove_previous"><br />
+True / False (default)<br /><br />
+<input type="submit" value="Export database" />
+</form><br /><br />
+
+<b>Restore Files</b><br /><br />
+<form action="http://localhost:18469/api/v1/restore_files/" method="post">
 <u>Input file</u>:<br />
 <input type="text" name="input"><br>
-myveryspecialbackup.tar.gz<br />
-<br />
-Boolean, if data should be removed in the table before input:<br />
-<input type="text" name="deleteTableDataFirst"><br>
-True for delete, False or empty for append<br />
-<br />
+myveryspecialbackup.tar.gz<br /><br />
+If data should be removed in the table before input:<br />
+<input type="text" name="remove_previous_database_files"><br>
+True / False (default)<br /><br />
 <input type="submit" value="Restore" />
+</form><br /><br />
+
+<b>Import database</b><br /><br />
+<form action="http://localhost:18469/api/v1/import_database/" method="post">
+If previous table files should be removed before import:<br />
+<input type="text" name="remove_previous"><br />
+True / False (default)<br /><br />
+<input type="submit" value="Import database" />
+</form><br /><br />
 
 </body>
 </html> 

backupTool.py

@@ -2,14 +2,15 @@
 from constants import DATA_FOLDER
 import csv
 import db.datastore as db
+import errno
 import os
 import re
 import shutil
 import sqlite3 as lite
 import tarfile
 import time
 
-TABLES = {
+_TABLES = {
 	'hashmap': ['hash', 'filepath'],
 	'profile': ['id', 'serializedUserInfo'],
 	'listings': ['id', 'serializedListings'],
@@ -26,9 +27,18 @@
 }
 
 def _getDatabase():
+	"""Retrieves the OpenBazaar database file."""
 	Database = db.Database()
 	return Database.DATABASE
 
+def silentRemove(filename):
+	"""Silently removes a file if it exists."""
+	try:
+		os.remove(filename)
+	except OSError as e:
+		if e.errno != errno.ENOENT: # ENOENT: no such file or directory
+			raise
+
 def _exportDatabaseToCsv(tablesAndColumns):
 	"""Reads the database for all given tables and stores them as CSV files."""
 	dbFile = _getDatabase()
@@ -48,36 +58,40 @@ def _exportDatabaseToCsv(tablesAndColumns):
 				writer.writerows(data)
 	return result
 
-def backup(tableList=None, output=None):
-	"""Archives given tables and files in a single tar archive."""
+def backupFiles(output=None):
+	"""Archives OpenBazaar files in a single tar archive."""
 	os.chdir(DATA_FOLDER)
 
-	if tableList:
-		# Parse table list
-		tableList = tableList.replace(' ', '').split(',')
-		tablesAndColumns = []
-		for table in tableList:
-			if table in TABLES:
-				tablesAndColumns.append((table, TABLES[table]))
-			else:
-				return 'ERROR, Table not found: {0}'.format(table)
-
-		# Remove existing database files and re-make them
-		if os.path.exists('backup'):
-			shutil.rmtree('backup')
-		os.makedirs('backup')
-		_exportDatabaseToCsv(tablesAndColumns)
-
 	# Archive files
 	files = os.listdir(DATA_FOLDER)
 	if not output:
 		output = 'backup_{0}.tar.gz'.format(time.strftime('%Y-%m-%d'))
+	silentRemove(output)
 	with tarfile.open(output, 'w:gz') as tar:
 		for f in files:
 			tar.add(f)
 		tar.close()
 	return 'Success'
 
+def exportDatabase(tableList, removePrevious=False):
+	"""Exports given tables to the OpenBazaar folder."""
+	# Parse table list
+	tableList = tableList.replace(' ', '').split(',')
+	tablesAndColumns = []
+	for table in tableList:
+		if table in _TABLES:
+			tablesAndColumns.append((table, _TABLES[table]))
+		else:
+			return 'ERROR, Table not found: {0}'.format(table)
+
+	# Remove existing database files and re-make them
+	if removePrevious and os.path.exists('backup'):
+		shutil.rmtree('backup')
+	if not os.path.exists('backup'):
+		os.makedirs('backup')
+	_exportDatabaseToCsv(tablesAndColumns)
+	return 'Success'
+
 def _importCsvToTable(fileName, deleteDataFirst=False):
 	"""Imports given CSV file to the database."""
 	tableName = re.search('table_(\w+).csv', fileName).group(1)
@@ -101,27 +115,30 @@ def _importCsvToTable(fileName, deleteDataFirst=False):
 						cursor.execute(insertsql, row)
 
 
-def restore(input, deleteTableDataFirst=False):
-	"""Restores files and tables of given archive."""
+def restoreFiles(input, removePreviousDatabaseFiles=False):
+	"""Restores files of given archive to OpenBazaar folder."""
 	if not input:
 		return 'Input path is needed'
 	os.chdir(DATA_FOLDER)
 
 	# Remove existing database files if any
-	if os.path.exists('backup'):
+	if removePreviousDatabaseFiles and os.path.exists('backup'):
 		shutil.rmtree('backup')
 
 	# Unarchive files
 	with tarfile.open(input, 'r:gz') as tar:
 		tar.extractall()
 
+	return 'Success'
+
+if __name__ == '__main__':
+	print 'Backup tool works as a library.'
+
+def importDatabase(deletePreviousData=False):
+	"""Imports table files from the OpenBazaar folder."""
 	# Restore database files to the database
 	if os.path.exists('backup'):
 		files = ['backup/{0}'.format(f) for f in os.listdir('backup')]
 		for f in files:
-			_importCsvToTable(f, deleteTableDataFirst)
-
+			_importCsvToTable(f, deletePreviousData)
 	return 'Success'
-
-if __name__ == '__main__':
-	print 'Backup tool works as a library.'