Nemcio/CyberPanel
1
0
Fork 0
mirror of https://github.com/usmannasir/cyberpanel.git synced 2025-11-11 15:56:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Adding RClone to Incremental Backup

Browse Source 
Have overridden the sftp mechanism in order to add rclone to the incremental backup functionality, which will enable users to use over [40 different cloud storage providers](https://rclone.org/overview/), including SFTP. Though, it would be quite welcomed if you can add this as a new option in addition to SFTP, complete with menu dropdown items, text boxes for rclone remote details etc...
This commit is contained in:
nickchomey
2022-03-20 10:50:21 -06:00
committed by GitHub
parent 6fe52067ea
commit 278e040d9e
1 changed files with 73 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

161
IncBackups/IncBackupsControl.py
View File

@@ -43,6 +43,7 @@ class IncJobs(multi.Thread):
self.website = '' self.website = ''
self.backupDestinations = '' self.backupDestinations = ''
self.jobid = 0 self.jobid = 0
self.jobids = ''
self.metaPath = '' self.metaPath = ''
self.path = '' self.path = ''
self.reconstruct = '' self.reconstruct = ''
@@ -57,9 +58,9 @@ class IncJobs(multi.Thread):
self.restorePoint() self.restorePoint()
def getRemoteBackups(self): def getRemoteBackups(self):
if self.backupDestinations[:4] == 'sftp': if self.backupDestinations == 'onedrive':
path = '/home/backup/%s' % (self.website) path = '%s' % (self.website)
command = 'export RESTIC_PASSWORD=%s PATH=${PATH}:/usr/bin && restic -r %s:%s snapshots' % ( command = 'export RESTIC_PASSWORD=%s PATH=${PATH}:/usr/bin && restic -r rclone:%s:%s snapshots' % (
self.passwordFile, self.backupDestinations, path) self.passwordFile, self.backupDestinations, path)
return ProcessUtilities.outputExecutioner(command, self.externalApp).split('\n') return ProcessUtilities.outputExecutioner(command, self.externalApp).split('\n')
else: else:
@@ -184,8 +185,8 @@ class IncJobs(multi.Thread):
key, secret = self.getAWSData() key, secret = self.getAWSData()
command = 'export AWS_ACCESS_KEY_ID=%s AWS_SECRET_ACCESS_KEY=%s && restic -r s3:s3.amazonaws.com/%s forget %s --password-file %s' % ( command = 'export AWS_ACCESS_KEY_ID=%s AWS_SECRET_ACCESS_KEY=%s && restic -r s3:s3.amazonaws.com/%s forget %s --prune --password-file %s' % (
key, secret, self.website, snapshotID, self.passwordFile) key, secret, self.website, self.jobids, self.passwordFile)
result = ProcessUtilities.outputExecutioner(command, self.externalApp) result = ProcessUtilities.outputExecutioner(command, self.externalApp)
@@ -194,11 +195,6 @@ class IncJobs(multi.Thread):
else: else:
logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1) logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1)
return 0 return 0
command = 'export AWS_ACCESS_KEY_ID=%s AWS_SECRET_ACCESS_KEY=%s && restic -r s3:s3.amazonaws.com/%s prune --password-file %s' % (
key, secret, self.website, self.passwordFile)
ProcessUtilities.outputExecutioner(command, self.externalApp)
else: else:
self.backupDestinations = self.jobid.destination self.backupDestinations = self.jobid.destination
@@ -254,7 +250,7 @@ class IncJobs(multi.Thread):
repoLocation = '/home/%s/incbackup' % (self.website) repoLocation = '/home/%s/incbackup' % (self.website)
command = 'restic -r %s forget %s --password-file %s' % (repoLocation, self.jobid.snapshotid, self.passwordFile) command = 'restic -r %s forget %s --prune --password-file %s' % (repoLocation, self.jobids, self.passwordFile)
result = ProcessUtilities.outputExecutioner(command, self.externalApp) result = ProcessUtilities.outputExecutioner(command, self.externalApp)
if result.find('removed snapshot') > -1 or result.find('deleted') > -1: if result.find('removed snapshot') > -1 or result.find('deleted') > -1:
@@ -263,9 +259,6 @@ class IncJobs(multi.Thread):
logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1) logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1)
return 0 return 0
command = 'restic -r %s prune --password-file %s' % (repoLocation, self.passwordFile)
ProcessUtilities.outputExecutioner(command, self.externalApp)
return 1 return 1
else: else:
repoLocation = '/home/%s/incbackup' % (self.website) repoLocation = '/home/%s/incbackup' % (self.website)
@@ -283,17 +276,17 @@ class IncJobs(multi.Thread):
## Last argument delete is set when the snapshot is to be deleted from this repo, when this argument is set, any preceding argument is not used ## Last argument delete is set when the snapshot is to be deleted from this repo, when this argument is set, any preceding argument is not used
def sftpFunction(self, backupPath, type, restore=None, delete=None): def sftpFunction(self, backupPath, type, restore=None, delete=None):
return 0
if restore == None: if restore == None:
# Define our excludes file for use with restic # Define our excludes file for use with restic
backupExcludesFile = '/home/%s/backup-exclude.conf' % (self.website.domain) backupExcludesFile = '/home/%s/backup-exclude.conf' % (self.website.domain)
resticBackupExcludeCMD = ' --exclude-file=%s' % (backupExcludesFile) resticBackupExcludeCMD = ' --exclude-file=%s' % (backupExcludesFile)
remotePath = '/home/backup/%s' % (self.website.domain) remotePath = '%s' % (self.website.domain)
command = 'export PATH=${PATH}:/usr/bin && restic -r %s:%s backup %s --password-file %s --exclude %s --exclude /home/%s/backup' % ( command = 'export PATH=${PATH}:/usr/bin && restic -r rclone:%s:%s backup %s --password-file %s --exclude %s --exclude /home/%s/backup' % (
self.backupDestinations, remotePath, backupPath, self.passwordFile, self.repoPath, self.website.domain) self.backupDestinations, remotePath, backupPath, self.passwordFile, self.repoPath, self.website.domain)
# If /home/%s/backup-exclude.conf file exists lets pass this to restic by appending the command to end. # If /home/%s/backup-exclude.conf file exists lets pass this to restic by appending the command to end.
if os.path.isfile(backupExcludesFile): if os.path.isfile(backupExcludesFile):
command = command + resticBackupExcludeCMD command = command + resticBackupExcludeCMD
result = ProcessUtilities.outputExecutioner(command, self.externalApp) result = ProcessUtilities.outputExecutioner(command, self.externalApp)
if result.find('saved') == -1: if result.find('saved') == -1:
@@ -313,9 +306,9 @@ class IncJobs(multi.Thread):
newSnapshot.save() newSnapshot.save()
return 1 return 1
elif delete: elif delete:
repoLocation = '/home/backup/%s' % (self.website) repoLocation = '%s' % (self.website)
command = 'export PATH=${PATH}:/usr/bin && restic -r %s:%s forget %s --password-file %s' % ( command = 'export PATH=${PATH}:/usr/bin && restic -r rclone:%s:%s forget %s --prune --password-file %s' % (
self.jobid.destination, repoLocation, self.jobid.snapshotid, self.passwordFile) self.jobid.destination, repoLocation, self.jobids, self.passwordFile)
result = ProcessUtilities.outputExecutioner(command, self.externalApp) result = ProcessUtilities.outputExecutioner(command, self.externalApp)
if result.find('removed snapshot') > -1 or result.find('deleted') > -1: if result.find('removed snapshot') > -1 or result.find('deleted') > -1:
@@ -323,13 +316,10 @@ class IncJobs(multi.Thread):
else: else:
logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1) logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1)
return 0 return 0
command = 'export PATH=${PATH}:/usr/bin && restic -r %s:%s prune --password-file %s' % (self.jobid.destination, repoLocation, self.passwordFile)
ProcessUtilities.outputExecutioner(command, self.externalApp)
else: else:
if self.reconstruct == 'remote': if self.reconstruct == 'remote':
repoLocation = '/home/backup/%s' % (self.website) repoLocation = '%s' % (self.website)
command = 'export RESTIC_PASSWORD=%s PATH=${PATH}:/usr/bin && restic -r %s:%s restore %s --target %s' % ( command = 'export RESTIC_PASSWORD=%s PATH=${PATH}:/usr/bin && restic -r rclone:%s:%s restore %s --target %s' % (
self.passwordFile, self.passwordFile,
self.backupDestinations, repoLocation, self.jobid, self.restoreTarget) self.backupDestinations, repoLocation, self.jobid, self.restoreTarget)
result = ProcessUtilities.outputExecutioner(command, self.externalApp) result = ProcessUtilities.outputExecutioner(command, self.externalApp)
@@ -337,8 +327,8 @@ class IncJobs(multi.Thread):
logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1) logging.statusWriter(self.statusPath, 'Failed: %s. [5009]' % (result), 1)
return 0 return 0
else: else:
repoLocation = '/home/backup/%s' % (self.website) repoLocation = '%s' % (self.website)
command = 'export PATH=${PATH}:/usr/bin && restic -r %s:%s restore %s --target %s --password-file %s' % ( command = 'export PATH=${PATH}:/usr/bin && restic -r rclone:%s:%s restore %s --target %s --password-file %s' % (
self.jobid.destination, repoLocation, self.jobid.snapshotid, self.restoreTarget, self.passwordFile) self.jobid.destination, repoLocation, self.jobid.snapshotid, self.restoreTarget, self.passwordFile)
result = ProcessUtilities.outputExecutioner(command, self.externalApp) result = ProcessUtilities.outputExecutioner(command, self.externalApp)
if result.find('restoring') == -1: if result.find('restoring') == -1:
@@ -351,7 +341,7 @@ class IncJobs(multi.Thread):
try: try:
if self.reconstruct == 'remote': if self.reconstruct == 'remote':
if self.backupDestinations[:4] == 'sftp': if self.backupDestinations == 'onedrive':
self.sftpFunction('none', 'none', 1) self.sftpFunction('none', 'none', 1)
else: else:
if self.awsFunction('restore', '', self.jobid) == 0: if self.awsFunction('restore', '', self.jobid) == 0:
@@ -359,7 +349,7 @@ class IncJobs(multi.Thread):
else: else:
if self.jobid.destination == 'local': if self.jobid.destination == 'local':
return self.localFunction('none', 'none', 1) return self.localFunction('none', 'none', 1)
elif self.jobid.destination[:4] == 'sftp': elif self.jobid.destination == 'onedrive':
return self.sftpFunction('none', 'none', 1) return self.sftpFunction('none', 'none', 1)
else: else:
return self.awsFunction('restore', '', self.jobid.snapshotid) return self.awsFunction('restore', '', self.jobid.snapshotid)
@@ -374,7 +364,7 @@ class IncJobs(multi.Thread):
try: try:
if self.reconstruct == 'remote': if self.reconstruct == 'remote':
if self.backupDestinations[:4] == 'sftp': if self.backupDestinations == 'onedrive':
if self.sftpFunction('none', 'none', 1) == 0: if self.sftpFunction('none', 'none', 1) == 0:
return 0 return 0
else: else:
@@ -399,7 +389,7 @@ class IncJobs(multi.Thread):
if self.jobid.destination == 'local': if self.jobid.destination == 'local':
if self.localFunction('none', 'none', 1) == 0: if self.localFunction('none', 'none', 1) == 0:
return 0 return 0
elif self.jobid.destination[:4] == 'sftp': elif self.jobid.destination == 'onedrive':
if self.sftpFunction('none', 'none', 1) == 0: if self.sftpFunction('none', 'none', 1) == 0:
return 0 return 0
else: else:
@@ -430,7 +420,7 @@ class IncJobs(multi.Thread):
try: try:
if self.reconstruct == 'remote': if self.reconstruct == 'remote':
if self.backupDestinations[:4] == 'sftp': if self.backupDestinations == 'onedrive':
if self.sftpFunction('none', 'none', 1) == 0: if self.sftpFunction('none', 'none', 1) == 0:
return 0 return 0
else: else:
@@ -439,7 +429,7 @@ class IncJobs(multi.Thread):
else: else:
if self.jobid.destination == 'local': if self.jobid.destination == 'local':
return self.localFunction('none', 'none', 1) return self.localFunction('none', 'none', 1)
elif self.jobid.destination[:4] == 'sftp': elif self.jobid.destination == 'onedrive':
return self.sftpFunction('none', 'none', 1) return self.sftpFunction('none', 'none', 1)
else: else:
return self.awsFunction('restore', '', self.jobid.snapshotid) return self.awsFunction('restore', '', self.jobid.snapshotid)
@@ -454,7 +444,7 @@ class IncJobs(multi.Thread):
try: try:
if self.reconstruct == 'remote': if self.reconstruct == 'remote':
if self.backupDestinations[:4] == 'sftp': if self.backupDestinations == 'onedrive':
if self.sftpFunction('none', 'none', 1) == 0: if self.sftpFunction('none', 'none', 1) == 0:
return 0 return 0
else: else:
@@ -464,7 +454,7 @@ class IncJobs(multi.Thread):
if self.jobid.destination == 'local': if self.jobid.destination == 'local':
if self.localFunction('none', 'none', 1) == 0: if self.localFunction('none', 'none', 1) == 0:
return 0 return 0
elif self.jobid.destination[:4] == 'sftp': elif self.jobid.destination == 'onedrive':
if self.sftpFunction('none', 'none', 1) == 0: if self.sftpFunction('none', 'none', 1) == 0:
return 0 return 0
else: else:
@@ -619,7 +609,7 @@ class IncJobs(multi.Thread):
if self.backupDestinations == 'local': if self.backupDestinations == 'local':
if self.localFunction(backupPath, 'data') == 0: if self.localFunction(backupPath, 'data') == 0:
return 0 return 0
elif self.backupDestinations[:4] == 'sftp': elif self.backupDestinations == 'onedrive':
if self.sftpFunction(backupPath, 'data') == 0: if self.sftpFunction(backupPath, 'data') == 0:
return 0 return 0
else: else:
@@ -669,7 +659,7 @@ class IncJobs(multi.Thread):
if self.backupDestinations == 'local': if self.backupDestinations == 'local':
if self.localFunction(dbPathNew, 'database') == 0: if self.localFunction(dbPathNew, 'database') == 0:
return 0 return 0
elif self.backupDestinations[:4] == 'sftp': elif self.backupDestinations == 'onedrive':
if self.sftpFunction(dbPathNew, 'database') == 0: if self.sftpFunction(dbPathNew, 'database') == 0:
return 0 return 0
else: else:
@@ -700,7 +690,7 @@ class IncJobs(multi.Thread):
if self.backupDestinations == 'local': if self.backupDestinations == 'local':
if self.localFunction(backupPath, 'email') == 0: if self.localFunction(backupPath, 'email') == 0:
return 0 return 0
elif self.backupDestinations[:4] == 'sftp': elif self.backupDestinations == 'onedrive':
if self.sftpFunction(backupPath, 'email') == 0: if self.sftpFunction(backupPath, 'email') == 0:
return 0 return 0
else: else:
@@ -723,7 +713,7 @@ class IncJobs(multi.Thread):
if self.backupDestinations == 'local': if self.backupDestinations == 'local':
if self.localFunction(backupPath, 'meta') == 0: if self.localFunction(backupPath, 'meta') == 0:
return 0 return 0
elif self.backupDestinations[:4] == 'sftp': elif self.backupDestinations == 'onedrive':
if self.sftpFunction(backupPath, 'meta') == 0: if self.sftpFunction(backupPath, 'meta') == 0:
return 0 return 0
else: else:
@@ -738,44 +728,42 @@ class IncJobs(multi.Thread):
return 0 return 0
def initiateRepo(self): def initiateRepo(self):
try: try:
logging.statusWriter(self.statusPath, 'Will first initiate backup repo..', 1) logging.statusWriter(self.statusPath, 'Checking for backup repo..', 1)
if self.backupDestinations == 'local': if self.backupDestinations == 'local':
command = 'restic init --repo %s --password-file %s' % (self.repoPath, self.passwordFile) checkcommand = 'restic --repo %s snapshots --password-file %s' % (self.repoPath, self.passwordFile)
result = ProcessUtilities.outputExecutioner(command, self.externalApp) checkresult = ProcessUtilities.outputExecutioner(checkcommand)
if os.path.exists(ProcessUtilities.debugPath): if checkresult.find('Is there a repository at the following location') > -1:
logging.writeToFile(result) logging.statusWriter(self.statusPath, 'Initiating backup repo..', 1)
command = 'restic init --repo %s --password-file %s' % (self.repoPath, self.passwordFile)
if result.find('config file already exists') == -1: elif self.backupDestinations == 'onedrive':
logging.statusWriter(self.statusPath, result, 1) checkcommand = 'restic -r rclone:%s:%s snapshots --password-file %s ' % (self.backupDestinations, self.website.domain, self.passwordFile)
checkresult = ProcessUtilities.outputExecutioner(checkcommand)
elif self.backupDestinations[:4] == 'sftp':
remotePath = '/home/backup/%s' % (self.website.domain) if checkresult.find('Is there a repository at the following location') > -1:
command = 'export PATH=${PATH}:/usr/bin && restic init --repo %s:%s --password-file %s' % ( logging.statusWriter(self.statusPath, 'Initiating backup repo..', 1)
self.backupDestinations, remotePath, self.passwordFile) command = 'export PATH=${PATH}:/usr/bin && restic init --repo rclone:%s:%s --password-file %s' % (
result = ProcessUtilities.outputExecutioner(command, self.externalApp) self.backupDestinations, remotePath, self.passwordFile)
if os.path.exists(ProcessUtilities.debugPath):
logging.writeToFile(result)
if result.find('config file already exists') == -1:
logging.statusWriter(self.statusPath, result, 1)
else: else:
key, secret = self.getAWSData() checkcommand = 'export AWS_ACCESS_KEY_ID=%s AWS_SECRET_ACCESS_KEY=%s && restic -r s3:s3.amazonaws.com/%s snapshots --password-file %s' % (
command = 'export AWS_ACCESS_KEY_ID=%s AWS_SECRET_ACCESS_KEY=%s && restic -r s3:s3.amazonaws.com/%s init --password-file %s' % ( key, secret, self.website.domain, self.passwordFile)
key, secret, self.website.domain, self.passwordFile) checkresult = ProcessUtilities.outputExecutioner(checkcommand, self.externalApp)
result = ProcessUtilities.outputExecutioner(command, self.externalApp)
if checkresult.find('Is there a repository at the following location') > -1:
logging.statusWriter(self.statusPath, 'Initiating backup repo..', 1)
key, secret = self.getAWSData()
command = 'export AWS_ACCESS_KEY_ID=%s AWS_SECRET_ACCESS_KEY=%s && restic -r s3:s3.amazonaws.com/%s init --password-file %s' % (
key, secret, self.website.domain, self.passwordFile)
if checkresult.find('Is there a repository at the following location') > -1:
result = ProcessUtilities.outputExecutioner(command, self.externalApp)
if os.path.exists(ProcessUtilities.debugPath): if os.path.exists(ProcessUtilities.debugPath):
logging.writeToFile(result) logging.writeToFile(result)
logging.statusWriter(self.statusPath, 'Repo %s initiated for %s.' % (self.backupDestinations, self.website.domain), 1)
if result.find('config file already exists') == -1: else:
logging.statusWriter(self.statusPath, result, 1) logging.statusWriter(self.statusPath, 'OK', 1)
logging.statusWriter(self.statusPath,
'Repo %s initiated for %s.' % (self.backupDestinations, self.website.domain), 1)
return 1 return 1
except BaseException as msg: except BaseException as msg:
logging.statusWriter(self.statusPath, '%s. [IncJobs.initiateRepo.47][5009]' % str(msg), 1) logging.statusWriter(self.statusPath, '%s. [IncJobs.initiateRepo.47][5009]' % str(msg), 1)
@@ -811,9 +799,9 @@ Subject: %s
### Checking if restic is installed before moving on ### Checking if restic is installed before moving on
command = 'restic' command = 'restic version'
if ProcessUtilities.outputExecutioner(command).find('restic is a backup program which') == -1: if ProcessUtilities.outputExecutioner(command).find('compiled with') == -1:
try: try:
CentOSPath = '/etc/redhat-release' CentOSPath = '/etc/redhat-release'
@@ -870,7 +858,7 @@ Subject: %s
## Completed password generation ## Completed password generation
if self.initiateRepo() == 0: if self.initiateRepo() == 0:
return 0 return 0
if self.prepareBackupMeta() == 0: if self.prepareBackupMeta() == 0:
return 0 return 0
@@ -921,24 +909,21 @@ Subject: %s
self.website = job_snapshots[0].job.website.domain self.website = job_snapshots[0].job.website.domain
self.externalApp = job_snapshots[0].job.website.externalApp self.externalApp = job_snapshots[0].job.website.externalApp
self.passwordFile = '/home/%s/%s' % (self.website, self.website) self.passwordFile = '/home/%s/%s' % (self.website, self.website)
for job_snapshot in job_snapshots: for job_snapshot in job_snapshots:
## Functions above use the self.jobid varilable to extract information about this snapshot, so this below variable needs to be set ## Functions above use the self.jobid variable to extract information about this snapshot, so this below variable needs to be set
self.jobid = job_snapshot self.jobid = job_snapshot
self.jobids = self.jobids + job_snapshot.snapshotid + ' '
if self.jobid.destination == 'local': if self.jobid.destination == 'local':
self.localFunction('none', 'none', 0, 1) self.localFunction('none', 'none', 0, 1)
elif self.jobid.destination[:4] == 'sftp': elif self.jobid.destination == 'onedrive':
self.sftpFunction('none', 'none', 0, 1) self.sftpFunction('none', 'none', 0, 1)
else: else:
self.awsFunction('restore', '', self.jobid.snapshotid, None, 1) self.awsFunction('restore', '', 0, None, 1)
return 1 return 1
except BaseException as msg: except BaseException as msg:
logging.statusWriter(self.statusPath, "%s [903:DeleteSnapShot][5009]" % (str(msg)), 1) logging.statusWriter(self.statusPath, "%s [903:DeleteSnapShot][5009]" % (str(msg)), 1)
return 0 return 0