Merge pull request #6 from py-package/feature/email

added email backup feature

Author: yubarajshrestha

.gitignore

@@ -14,4 +14,6 @@ dist
 .env
 *.db
 src/masonite_backup.egg-info
-storage
+storage
+*.gz
+*.zip

README.md

@@ -23,8 +23,7 @@ Backup solution for Masonite.
 - [x] Backup Database
 - [x] Backup Files
 - [x] Store Backup Locally in the filesystem
-- [ ] Send Backup Notifications
-- [ ] Email Backup
+- [x] Email Backup
 - [ ] Store Backup in other Masonite Supported Storage Drivers [s3]
 
 
@@ -78,6 +77,20 @@ SOURCE = {
         # add more...
     ],
 }
+
+EMAIL_BACKUP = False  # Whether or not to email the backup.
+EMAIL_BACKUP_TO = ""  # The email address to send the backup to.
+EMAIL_SUBJECT = "System Backup"  # The email subject.
+```
+> Note: Make sure you have `EMAIL_BACKUP` set to `True` and `EMAIL_BACKUP_TO` set to a valid email address, to send the backup via email. Also don't forget to setup SMTP in `config/mail.py` configuration file or in `.env` file.
+
+```sh
+MAIL_DRIVER=smtp
+MAIL_FROM=
+MAIL_HOST=
+MAIL_PORT=
+MAIL_USERNAME=
+MAIL_PASSWORD=
 ```
 
 **Backup Database and Files**

setup.py

@@ -8,10 +8,11 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version="0.0.2",
+    version="0.0.3",
     packages=[
         "backup",
         "backup.commands",
+        "backup.mailables",
         "backup.providers",
         "backup.config",
     ],

src/backup/Backup.py

@@ -9,13 +9,18 @@
 from masonite.utils.location import base_path
 import subprocess
 import gzip
+from masonite.facades import Mail
+from .mailables.Backup import Backup as BackupMailable
 
 
 class Backup:
     def __init__(self, application) -> None:
         self.app = application
         self.backup_config = config("backup")
 
+        self.db_file_path = None
+        self.archive_file_path = None
+
     def accept(self, path):
         for pattern in self.backup_config.get("source").get("excludes"):
             if pattern in path:
@@ -32,7 +37,7 @@ def database(self):
         connection = db_config.get(default)
         driver = connection.get("driver")
 
-        db_file_path = base_path(
+        self.db_file_path = base_path(
             "{}.gz".format("database-" + str(datetime.timestamp(datetime.now())))
         )
 
@@ -54,7 +59,7 @@ def database(self):
             command_str = f"sqlplus -S{connection.get('user')}/{connection.get('password')}@{connection.get('host')}:{connection.get('port')}/{connection.get('database')}"
 
         if command_str:
-            with gzip.open(db_file_path, "wb") as f:
+            with gzip.open(self.db_file_path, "wb") as f:
                 popen = subprocess.Popen(
                     [command_str],
                     stdout=subprocess.PIPE,
@@ -65,7 +70,7 @@ def database(self):
                     f.write(stdout_line.encode("utf-8"))
                 popen.stdout.close()
                 popen.wait()
-        return db_file_path
+        return self.db_file_path
 
     def files(self):
         """
@@ -82,7 +87,7 @@ def files(self):
         if not pathlib.Path(output_dir).exists():
             pathlib.Path(output_dir).mkdir(parents=True, exist_ok=True)
 
-        path_to_archive = pathlib.Path(output_dir).joinpath(filename)
+        self.archive_file_path = pathlib.Path(output_dir).joinpath(filename)
 
         with tempfile.TemporaryDirectory() as tmp:
             shutil.copytree(
@@ -92,5 +97,36 @@ def files(self):
             )
 
             with patch("os.path.isfile", side_effect=self.accept):
-                make_archive(path_to_archive, "zip", tmp)
-        return path_to_archive
+                make_archive(self.archive_file_path, "zip", tmp)
+
+        return f"{self.archive_file_path}.zip"
+
+    def email(self):
+        """
+        Email the backup.
+        """
+
+        if not self.backup_config.get("email_backup", False):
+            return
+
+        if self.archive_file_path != None and pathlib.Path(f"{self.archive_file_path}.zip").exists():
+            Mail.mailable(
+                BackupMailable().attach(f"System Backup.zip", f"{self.archive_file_path}.zip")
+            ).send()
+
+        if self.db_file_path != None and pathlib.Path(self.db_file_path).exists():
+            ext = self.db_file_path.split(".")[-1]
+            Mail.mailable(
+                BackupMailable().attach(f"Database Backup.{ext}", self.db_file_path)
+            ).send()
+
+        self.cleanup()
+
+    def cleanup(self):
+        """
+        Cleanup the backup files.
+        """
+        if self.archive_file_path != None and pathlib.Path(self.archive_file_path).exists():
+            pathlib.Path(self.archive_file_path).unlink()
+        if self.db_file_path != None and pathlib.Path(self.db_file_path).exists():
+            pathlib.Path(self.db_file_path).unlink()

src/backup/commands/BackupRunCommand.py

@@ -15,24 +15,32 @@ class BackupRunCommand(Command):
     def __init__(self, application):
         super().__init__()
         self.app = application
+        self.database_file_path = None
+        self.assets_file_path = None
 
     def handle(self):
+        backup = self.app.make("backup")
+
         if not self.validate_options():
             return
 
+        self.info("============ Backup starting ============")
+
         if self.option("only-db"):
-            self.app.make("backup").database()
+            self.database_file_path = backup.database()
         elif self.option("only-files"):
-            self.app.make("backup").files()
+            self.assets_file_path = backup.files()
         else:
             self.info("Backuping database...")
-            database_file_path = self.app.make("backup").database()
+            self.database_file_path = backup.database()
             self.info("Backuping files...")
-            self.app.make("backup").files()
+            self.assets_file_path = backup.files()
 
             # delete the database file
-            os.remove(database_file_path)
+            os.remove(self.database_file_path)
+            self.database_file_path = None
 
+        backup.email()
         self.info("============ Backup complete ============")
 
     def validate_options(self):

src/backup/config/backup.py

@@ -24,3 +24,6 @@
         "__pycache__",
     ],
 }
+EMAIL_BACKUP = False  # Whether or not to email the backup.
+EMAIL_BACKUP_TO = ""  # The email address to send the backup to.
+EMAIL_SUBJECT = "System Backup"  # The email subject.

src/backup/mailables/Backup.py

@@ -0,0 +1,30 @@
+# flake8: noqa F501
+from masonite.mail import Mailable
+from masonite.configuration import config
+from masonite.environment import env
+
+
+class Backup(Mailable):
+    def build(self):
+        backup_config = config("backup")
+        email = backup_config.get("email_backup_to")
+
+        if not email:
+            raise Exception("No email address found in backup config.")
+
+        return (
+            self.to(email)
+            .subject(backup_config.get("email_subject"))
+            .from_(env("MAIL_FROM"))
+            .html(
+                """
+                <div>
+                    <h2 style="margin-bottom: 24px">Backup Complete</h2>
+                    <p style="margin-bottom: 24px">
+                    Your backup has been completed and is now available for download.<br />Please, find the file attached here within.
+                    </p><br />
+                    <i>Thanks,<br /> <strong>Masonite Backup</strong></i>
+                </div>
+            """
+            )
+        )

src/backup/mailables/__init__.py

@@ -0,0 +1,2 @@
+# flake8: noqa F401
+from .Backup import Backup

tests/integrations/config/backup.py

@@ -24,3 +24,6 @@
         "__pycache__",
     ],
 }
+EMAIL_BACKUP = True  # Whether or not to email the backup.
+EMAIL_BACKUP_TO = "yubara@pypackage.com" # The email address to send the backup to.
+EMAIL_SUBJECT = "System Backup" # The email subject.

tests/integrations/templates/welcome.html

@@ -31,4 +31,4 @@
   </nav>
 
 </div>
-{% endblock %}
+{% endblock %}