/usr/lib/bareos/plugins/BareosFdPluginLocalFileset.py is in bareos-filedaemon-python-plugin 16.2.4-3+deb9u2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
# BAREOS - Backup Archiving REcovery Open Sourced
#
# Copyright (C) 2014-2014 Bareos GmbH & Co. KG
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of version three of the GNU Affero General Public
# License as published by the Free Software Foundation, which is
# listed in the file LICENSE.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
# Author: Maik Aussendorf
#
# Bareos python plugins class that adds files from a local list to
# the backup fileset
import bareosfd
from bareos_fd_consts import bJobMessageType, bFileType, bRCs
import os
import re
import BareosFdPluginBaseclass
class BareosFdPluginLocalFileset(BareosFdPluginBaseclass.BareosFdPluginBaseclass): # noqa
'''
Simple Bareos-FD-Plugin-Class that parses a file and backups all files
listed there Filename is taken from plugin argument 'filename'
'''
def __init__(self, context, plugindef):
bareosfd.DebugMessage(
context, 100,
"Constructor called in module %s with plugindef=%s\n" %
(__name__, plugindef))
# Last argument of super constructor is a list of mandatory arguments
super(BareosFdPluginLocalFileset, self).__init__(context, plugindef, ['filename'])
self.files_to_backup = []
self.allow = None
self.deny = None
def filename_is_allowed(self, context, filename, allowregex, denyregex):
'''
Check, if filename is allowed.
True, if matches allowreg and not denyregex.
If allowreg is None, filename always matches
If denyreg is None, it never matches
'''
if allowregex is None or allowregex.search(filename):
allowed = True
else:
allowed = False
if denyregex is None or not denyregex.search(filename):
denied = False
else:
denied = True
if not allowed or denied:
bareosfd.DebugMessage(
context, 100,
"File %s denied by configuration\n" %
(filename))
bareosfd.JobMessage(
context, bJobMessageType['M_ERROR'],
"File %s denied by configuration\n" %
(filename))
return False
else:
return True
def start_backup_job(self, context):
'''
At this point, plugin options were passed and checked already.
We try to read from filename and setup the list of file to backup
in self.files_to_backup
'''
bareosfd.DebugMessage(
context, 100,
"Using %s to search for local files\n" %
(self.options['filename']))
if os.path.exists(self.options['filename']):
try:
config_file = open(self.options['filename'], 'rb')
except:
bareosfd.DebugMessage(
context, 100,
"Could not open file %s\n" %
(self.options['filename']))
return bRCs['bRC_Error']
else:
bareosfd.DebugMessage(
context, 100,
"File %s does not exist\n" %
(self.options['filename']))
return bRCs['bRC_Error']
# Check, if we have allow or deny regular expressions defined
if 'allow' in self.options:
self.allow = re.compile(self.options['allow'])
if 'deny' in self.options:
self.deny = re.compile(self.options['deny'])
for listItem in config_file.read().splitlines():
if (os.path.isfile(listItem) and self.filename_is_allowed
(context, listItem, self.allow, self.deny)):
self.files_to_backup.append(listItem)
if os.path.isdir(listItem):
for topdir, dirNames, fileNames in os.walk(listItem):
for fileName in fileNames:
if self.filename_is_allowed(context, os.path.join(topdir, fileName),
self.allow, self.deny):
self.files_to_backup.append(os.path.join(topdir, fileName))
if not self.files_to_backup:
bareosfd.JobMessage(
context, bJobMessageType['M_ERROR'],
"No (allowed) files to backup found\n")
return bRCs['bRC_Error']
else:
return bRCs['bRC_Cancel']
def start_backup_file(self, context, savepkt):
'''
Defines the file to backup and creates the savepkt. In this example
only files (no directories) are allowed
'''
bareosfd.DebugMessage(
context, 100,
"start_backup_file() called\n")
if not self.files_to_backup:
bareosfd.DebugMessage(
context, 100,
"No files to backup\n")
return bRCs['bRC_Skip']
file_to_backup = self.files_to_backup.pop()
bareosfd.DebugMessage(
context, 100,
"file: " + file_to_backup + "\n")
statp = bareosfd.StatPacket()
savepkt.statp = statp
savepkt.fname = file_to_backup
savepkt.type = bFileType['FT_REG']
bareosfd.JobMessage(
context, bJobMessageType['M_INFO'],
"Starting backup of %s\n" %
(file_to_backup))
return bRCs['bRC_OK']
def end_backup_file(self, context):
'''
Here we return 'bRC_More' as long as our list files_to_backup is not
empty and bRC_OK when we are done
'''
bareosfd.DebugMessage(
context, 100,
"end_backup_file() entry point in Python called\n")
if self.files_to_backup:
return bRCs['bRC_More']
else:
return bRCs['bRC_OK']
# vim: ts=4 tabstop=4 expandtab shiftwidth=4 softtabstop=4
|