Backups.py

#!/usr/bin/python3 -O
"""
 File: 				Backups.py
 Python Version:		3.12.11
 Author: 			Leon McClatchey
 Company:			Linktech Engineering LLC
 Date: 				2025-10-21

 Description: 	Back up system files, starting with the mariadb database

 """
# System Libraries
import argparse
import os, sys
import logging
import socket
import pathlib
import zipfile
from datetime import datetime
# Initialize Global Strings
MyScript = os.path.splitext(os.path.basename(sys.argv[0]))[0]
Config = {}
# Functions
# Backup Mysql Database
def BackupMysql(dbf='all-databases'):
	global Config
	LogPath = Config['Args']['log']['path']
	Mysql = {}
	User = Config['Args']['user']['mysql'] if 'mysql' in Config['Args']['user'].keys() else Config['Args']['user']['mariadb']
	Source = Config['Args']['source']
	Target = Config['Args']['target']
	FileTools.WriteLog(f'Start Mariadb Backup for {dbf} to {Target}',LogPath)
	Mysql['file']=f'{dbf}-{datetime.today().strftime("%Y%m%d")}.sql'
	Mysql['zip']=f'{dbf}-{datetime.today().strftime("%Y%m%d")}.zip'
	FileTools.CreateFolder(Target)
	cmd = f'{Source} -u{User["name"]} -p{User["passwd"]} --{dbf} >> {Target}/{dbf}-{datetime.today().strftime("%Y%m%d")}.sql'
	FileTools.WriteLog(cmd,LogPath)
	rc = NetTools.LocalCommand(cmd,LogPath)
	cdir = os.getcwd()
	if rc['code'] == 0:
		FileTools.WriteLog(f'Archiving {Mysql["file"]} to {Mysql["zip"]}',LogPath)
		os.chdir(Target)
		arch = zipfile.ZipFile(os.path.abspath(Mysql['zip']),"w",zipfile.ZIP_DEFLATED)
		arch.write(Mysql['file'])
		arch.close()
		if os.path.isfile(Mysql['zip']):
			FileTools.WriteLog(f'Archived {Mysql["file"]}({round(os.path.getsize(Mysql["file"])/10e6,3)})Mb to {Mysql["zip"]}({round(os.path.getsize(Mysql["zip"])/10e6,3)})Mb',LogPath)
			os.remove(Mysql["file"])
	FileTools.WriteLog(f'Completed Backup of Mariadb "{dbf}")',LogPath)
	os.chdir(cdir)
# Function to check the system Path
def CheckSysPath(target):
	npath = os.path.normcase(os.path.abspath(target))
	for p in sys.path:
	  nsys = os.path.normcase(os.path.abspath(p))
	  if npath == nsys: return True
	return False
# Function to get the Commandline arguments
def GetArguments():
	MyScript = f"{os.path.splitext(os.path.basename(sys.argv[0]))[0]}"
	parser = MyParser(
		prog=f"{MyScript}",
		description='Backup and Restores Linux Systems', 
		script=f"{MyScript}",
		script_version='1.0.0',
		include_python_version=True,
		usage = "%(prog)s [-e -f -v -H -P -l -L -u -k -a -s -T] \
			\n(-h displays help, --version displays version)",
		formatter_class=argparse.RawTextHelpFormatter
	)
	parser.add_argument('-a','--action',dest='action',type=str,help='Operation being performed:\n "backup", "restore", or "list" or "view"')
	parser.add_argument('-b','--backup',dest='backup',type=str,help="Backup Template: Format: 'src=path,depth=0,dst=path,type=[file/directory]'")
	parser.add_argument('-e','--engine',dest='engine',type=str,help='Database Engine being backed up (mariadb, mysql, postgresql, oracle), \nif empty, no database will be backed up')
	parser.add_argument('-f','--filter',dest='filter',type=str,help='Backup Filter => Formatted:\nfolder=[path],size=[max size],age=[max age],mask=[file mask]')
	parser.add_argument('-H','--host',dest='host',type=str,default='localhost',help='Name of Host being backed up, defaults to localhost')
	parser.add_argument('-s','--source',dest='source',type=str,required=False,help='Source to be backed up, or command with Database Engine')
	parser.add_argument('-t','--target',dest='target',type=str,help='Path to target folder to receive the backups')
	try:
		known,unknown = parser.parse_known_args()
		if '-h' in unknown or '--help' in unknown:
			help_text = parser.get_help_text()
			parser.print_help()
			sys.exit(2)
		args = vars(known)
		msg = None
		if args['engine'] is not None:
			if args['engine'].lower() not in ['mariadb', 'mysql', 'postgresql', 'oracle']:
				msg = "[engine] can only be 'mysql', 'postgresql', or 'oracle' or Not Specified!"
		#elif args['action'] is None and args['filter'] is None and args['target'] is None and args['source'] is None:
		#	msg = "An Action, Source (or File), and Target must be specified if a database engine is not specified!"
		elif args['action'].lower() not in ['backup','restore','list','view']:
			msg = f"Action must be backup,restore,list,or view\nNot {args['action']}!"
		elif args['action'].lower() == 'backup' and args['backup'] is None:
			msg = f"Missing Backup Template for {args['action']}" 
		args['backup'] = Tools.String2Dictionary(args['backup'],"=") if args['backup'] is not None else None
		args['user'] = Tools.ParseUsers(Tools.String2Dictionary(args['user'],'=','/')) if args['user'] is not None else None
		args['filter'] = Tools.String2Dictionary(args['filter'],"=") if args['filter'] is not None else None
		args['log']=Tools.String2Dictionary(args['log'],'=')
		if msg is None:
			if args['backup'] is not None:
				bkup = args['backup']
				bkup['depth'] = 0 if 'depth' not in bkup.keys() or bkup['depth'] is None else int(bkup['depth'].strip())
				if bkup['type'] not in ['directory','file']:
					msg = f"Backup type must be either 'directory' or 'file', not {bkup['type']}"
					FileTools.WriteLog(msg,args['log']['path']) if args['log']['path'] is not None else print(msg)
					raise argparse.ArgumentError(None,msg)
				args['backup'] = bkup
			FileTools.CreateFolder(args['log']['path'])
		if msg is not None:
			FileTools.WriteLog(msg,args['log']['path']) if args['log']['path'] is not None else print(msg)
			raise argparse.ArgumentError(None,msg)
		return args
	except argparse.ArgumentError as e:
		parser.error(str(e))
# Function to Find the local Common folder and append it to the library path
def InitializeModules():
	ScriptPath = pathlib.Path(__file__).parent.resolve()
	LibPath = f"{ScriptPath}/Lib"
	if not CheckSysPath(LibPath): sys.path.append(LibPath)
# Main Function
def main():
	global Config
	Config['Args'] = GetArguments()
	FileTools.ArchiveLog(Config['Args']['log'])
	logging.basicConfig(filename=Config['Args']['log']['path'],filemode='a',level=logging.WARN)
	if 'engine' in Config['Args'].keys():
		if Config['Args']['engine'] is not None:
			if Config['Args']['engine'].lower() in ['mariadb', 'mysql']:
				BackupMysql()
	#print(Config['Args'])
# Preload with User Libraries
InitializeModules()
import FileTools,NetTools,Tools
from MyParser import MyParser
# Execute Script
if __name__ =="__main__":
    main()