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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
|
"""
Utility functions for dbbackup.
"""
import gzip
import logging
import os
import re
import sys
import tempfile
import traceback
from datetime import datetime
from functools import wraps
from getpass import getpass
from shlex import quote
from shutil import copyfileobj
from django.core.mail import EmailMultiAlternatives
from django.db import connection
from django.http import HttpRequest
from django.utils import timezone
from . import settings
FAKE_HTTP_REQUEST = HttpRequest()
FAKE_HTTP_REQUEST.META["SERVER_NAME"] = ""
FAKE_HTTP_REQUEST.META["SERVER_PORT"] = ""
FAKE_HTTP_REQUEST.META["HTTP_HOST"] = settings.HOSTNAME
FAKE_HTTP_REQUEST.path = "/DJANGO-DBBACKUP-EXCEPTION"
BYTES = (
("PiB", 1125899906842624.0),
("TiB", 1099511627776.0),
("GiB", 1073741824.0),
("MiB", 1048576.0),
("KiB", 1024.0),
("B", 1.0),
)
REG_FILENAME_CLEAN = re.compile(r"-+")
class EncryptionError(Exception):
pass
class DecryptionError(Exception):
pass
def bytes_to_str(byteVal, decimals=1):
"""
Convert bytes to a human readable string.
:param byteVal: Value to convert in bytes
:type byteVal: int or float
:param decimal: Number of decimal to display
:type decimal: int
:returns: Number of byte with the best unit of measure
:rtype: str
"""
for unit, byte in BYTES:
if byteVal >= byte:
if decimals == 0:
return f"{int(round(byteVal / byte, 0))} {unit}"
return f"{round(byteVal / byte, decimals)} {unit}"
return f"{byteVal} B"
def handle_size(filehandle):
"""
Get file's size to a human readable string.
:param filehandle: File to handle
:type filehandle: file
:returns: File's size with the best unit of measure
:rtype: str
"""
if hasattr(filehandle, "size"):
return bytes_to_str(filehandle.size)
filehandle.seek(0, 2)
return bytes_to_str(filehandle.tell())
def mail_admins(
subject, message, fail_silently=False, connection=None, html_message=None
):
"""Sends a message to the admins, as defined by the DBBACKUP_ADMINS setting."""
if not settings.ADMINS:
return
mail = EmailMultiAlternatives(
f"{settings.EMAIL_SUBJECT_PREFIX}{subject}",
message,
settings.SERVER_EMAIL,
[a[1] for a in settings.ADMINS],
connection=connection,
)
if html_message:
mail.attach_alternative(html_message, "text/html")
mail.send(fail_silently=fail_silently)
def email_uncaught_exception(func):
"""
Function decorator for send email with uncaught exceptions to admins.
Email is sent to ``settings.DBBACKUP_FAILURE_RECIPIENTS``
(``settings.ADMINS`` if not defined). The message contains a traceback
of error.
"""
@wraps(func)
def wrapper(*args, **kwargs):
try:
func(*args, **kwargs)
except Exception:
logger = logging.getLogger("dbbackup")
exc_type, exc_value, tb = sys.exc_info()
tb_str = "".join(traceback.format_tb(tb))
msg = f"{exc_type.__name__}: {exc_value}\n{tb_str}"
logger.error(msg)
raise
finally:
connection.close()
return wrapper
def create_spooled_temporary_file(filepath=None, fileobj=None):
"""
Create a spooled temporary file. if ``filepath`` or ``fileobj`` is
defined its content will be copied into temporary file.
:param filepath: Path of input file
:type filepath: str
:param fileobj: Input file object
:type fileobj: file
:returns: Spooled temporary file
:rtype: :class:`tempfile.SpooledTemporaryFile`
"""
spooled_file = tempfile.SpooledTemporaryFile(
max_size=settings.TMP_FILE_MAX_SIZE, dir=settings.TMP_DIR
)
if filepath:
fileobj = open(filepath, "r+b")
if fileobj is not None:
fileobj.seek(0)
copyfileobj(fileobj, spooled_file, settings.TMP_FILE_READ_SIZE)
return spooled_file
def encrypt_file(inputfile, filename):
"""
Encrypt input file using GPG and remove .gpg extension to its name.
:param inputfile: File to encrypt
:type inputfile: ``file`` like object
:param filename: File's name
:type filename: ``str``
:returns: Tuple with file and new file's name
:rtype: :class:`tempfile.SpooledTemporaryFile`, ``str``
"""
import gnupg
tempdir = tempfile.mkdtemp(dir=settings.TMP_DIR)
try:
filename = f"{filename}.gpg"
filepath = os.path.join(tempdir, filename)
try:
inputfile.seek(0)
always_trust = settings.GPG_ALWAYS_TRUST
g = gnupg.GPG()
result = g.encrypt_file(
inputfile,
output=filepath,
recipients=settings.GPG_RECIPIENT,
always_trust=always_trust,
)
inputfile.close()
if not result:
msg = f"Encryption failed; status: {result.status}"
raise EncryptionError(msg)
return create_spooled_temporary_file(filepath), filename
finally:
if os.path.exists(filepath):
os.remove(filepath)
finally:
os.rmdir(tempdir)
def unencrypt_file(inputfile, filename, passphrase=None):
"""
Unencrypt input file using GPG and remove .gpg extension to its name.
:param inputfile: File to encrypt
:type inputfile: ``file`` like object
:param filename: File's name
:type filename: ``str``
:param passphrase: Passphrase of GPG key, if equivalent to False, it will
be asked to user. If user answer an empty pass, no
passphrase will be used.
:type passphrase: ``str`` or ``None``
:returns: Tuple with file and new file's name
:rtype: :class:`tempfile.SpooledTemporaryFile`, ``str``
"""
import gnupg
def get_passphrase(passphrase=passphrase):
return passphrase or getpass("Input Passphrase: ") or None
temp_dir = tempfile.mkdtemp(dir=settings.TMP_DIR)
try:
new_basename = os.path.basename(filename).replace(".gpg", "")
temp_filename = os.path.join(temp_dir, new_basename)
try:
inputfile.seek(0)
g = gnupg.GPG()
result = g.decrypt_file(
fileobj_or_path=inputfile,
passphrase=get_passphrase(),
output=temp_filename,
)
if not result:
raise DecryptionError("Decryption failed; status: %s" % result.status)
outputfile = create_spooled_temporary_file(temp_filename)
finally:
if os.path.exists(temp_filename):
os.remove(temp_filename)
finally:
os.rmdir(temp_dir)
return outputfile, new_basename
def compress_file(inputfile, filename):
"""
Compress input file using gzip and change its name.
:param inputfile: File to compress
:type inputfile: ``file`` like object
:param filename: File's name
:type filename: ``str``
:returns: Tuple with compressed file and new file's name
:rtype: :class:`tempfile.SpooledTemporaryFile`, ``str``
"""
outputfile = create_spooled_temporary_file()
new_filename = f"{filename}.gz"
zipfile = gzip.GzipFile(filename=filename, fileobj=outputfile, mode="wb")
try:
inputfile.seek(0)
copyfileobj(inputfile, zipfile, settings.TMP_FILE_READ_SIZE)
finally:
zipfile.close()
return outputfile, new_filename
def uncompress_file(inputfile, filename):
"""
Uncompress this file using gzip and change its name.
:param inputfile: File to compress
:type inputfile: ``file`` like object
:param filename: File's name
:type filename: ``str``
:returns: Tuple with file and new file's name
:rtype: :class:`tempfile.SpooledTemporaryFile`, ``str``
"""
zipfile = gzip.GzipFile(fileobj=inputfile, mode="rb")
try:
inputfile.seek(0)
outputfile = create_spooled_temporary_file(fileobj=zipfile)
finally:
zipfile.close()
new_basename = os.path.basename(filename).replace(".gz", "")
return outputfile, new_basename
def timestamp(value):
"""
Return the timestamp of a datetime.datetime object.
:param value: a datetime object
:type value: datetime.datetime
:return: the timestamp
:rtype: str
"""
value = value if timezone.is_naive(value) else timezone.localtime(value)
return value.strftime(settings.DATE_FORMAT)
def filename_details(filepath):
# TODO: What was this function made for ?
return ""
PATTERN_MATCHNG = (
("%a", r"[A-Z][a-z]+"),
("%A", r"[A-Z][a-z]+"),
("%w", r"\d"),
("%d", r"\d{2}"),
("%b", r"[A-Z][a-z]+"),
("%B", r"[A-Z][a-z]+"),
("%m", r"\d{2}"),
("%y", r"\d{2}"),
("%Y", r"\d{4}"),
("%H", r"\d{2}"),
("%I", r"\d{2}"),
# ('%p', r'(?AM|PM|am|pm)'),
("%M", r"\d{2}"),
("%S", r"\d{2}"),
("%f", r"\d{6}"),
# ('%z', r'\+\d{4}'),
# ('%Z', r'(?|UTC|EST|CST)'),
("%j", r"\d{3}"),
("%U", r"\d{2}"),
("%W", r"\d{2}"),
# ('%c', r'[A-Z][a-z]+ [A-Z][a-z]{2} \d{2} \d{2}:\d{2}:\d{2} \d{4}'),
# ('%x', r'd{2}/d{2}/d{4}'),
# ('%X', r'd{2}:d{2}:d{2}'),
# ('%%', r'%'),
)
def datefmt_to_regex(datefmt):
"""
Convert a strftime format string to a regex.
:param datefmt: strftime format string
:type datefmt: ``str``
:returns: Equivalent regex
:rtype: ``re.compite``
"""
new_string = datefmt
for pat, reg in PATTERN_MATCHNG:
new_string = new_string.replace(pat, reg)
return re.compile(f"({new_string})")
def filename_to_datestring(filename, datefmt=None):
"""
Return the date part of a file name.
:param datefmt: strftime format string, ``settings.DATE_FORMAT`` is used
if is ``None``
:type datefmt: ``str`` or ``None``
:returns: Date part or nothing if not found
:rtype: ``str`` or ``NoneType``
"""
datefmt = datefmt or settings.DATE_FORMAT
regex = datefmt_to_regex(datefmt)
search = regex.search(filename)
if search:
return search.groups()[0]
def filename_to_date(filename, datefmt=None):
"""
Return a datetime from a file name.
:param datefmt: strftime format string, ``settings.DATE_FORMAT`` is used
if is ``None``
:type datefmt: ``str`` or ``NoneType``
:returns: Date guessed or nothing if no date found
:rtype: ``datetime.datetime`` or ``NoneType``
"""
datefmt = datefmt or settings.DATE_FORMAT
datestring = filename_to_datestring(filename, datefmt)
if datestring is not None:
return datetime.strptime(datestring, datefmt)
def filename_generate(
extension, database_name="", servername=None, content_type="db", wildcard=None
):
"""
Create a new backup filename.
:param extension: Extension of backup file
:type extension: ``str``
:param database_name: If it is database backup specify its name
:type database_name: ``str``
:param servername: Specify server name or by default ``settings.DBBACKUP_HOSTNAME``
:type servername: ``str``
:param content_type: Content type to backup, ``'media'`` or ``'db'``
:type content_type: ``str``
:param wildcard: Replace datetime with this wilecard regex
:type content_type: ``str``
:returns: Computed file name
:rtype: ``str`
"""
if content_type == "db":
if "/" in database_name:
database_name = os.path.basename(database_name)
if "." in database_name:
database_name = database_name.split(".")[0]
template = settings.FILENAME_TEMPLATE
elif content_type == "media":
template = settings.MEDIA_FILENAME_TEMPLATE
else:
template = settings.FILENAME_TEMPLATE
params = {
"servername": servername or settings.HOSTNAME,
"datetime": wildcard or datetime.now().strftime(settings.DATE_FORMAT),
"databasename": database_name,
"extension": extension,
"content_type": content_type,
}
if callable(template):
filename = template(**params)
else:
filename = template.format(**params)
filename = REG_FILENAME_CLEAN.sub("-", filename)
filename = filename[1:] if filename.startswith("-") else filename
return filename
def get_escaped_command_arg(arg):
return quote(arg)
|