Merge branch 'add-configurable-include-files-to-attachments'

samsonasik · samsonasik · commit ce07e9f9240a · 2020-05-20T21:45:16.000+07:00
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ Features
 - [x] Provide request information ( http method, raw data, body data, query data, files data, cookie data, and ip address).
 - [x] Send Mail
   - [x] many receivers to listed configured email
-  - [x] with include $_FILES into attachments on upload error.
+  - [x] with include $_FILES into attachments on upload error (configurable to be included or not).
 
 Installation
 ------------
@@ -286,6 +286,9 @@ json
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/config/error-hero-module.local.php.dist b/config/error-hero-module.local.php.dist
@@ -124,6 +124,9 @@ json
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/config/mezzio-error-hero-module.local.php.dist b/config/mezzio-error-hero-module.local.php.dist
@@ -129,6 +129,9 @@ json
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload-for-cannot-connect-to-db/error-hero-module.local.php b/spec/Fixture/config/autoload-for-cannot-connect-to-db/error-hero-module.local.php
@@ -93,6 +93,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload-for-enable-display-errors/error-hero-module.local.php b/spec/Fixture/config/autoload-for-enable-display-errors/error-hero-module.local.php
@@ -94,6 +94,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload-for-specific-error-and-exception/error-hero-module.local.php b/spec/Fixture/config/autoload-for-specific-error-and-exception/error-hero-module.local.php
@@ -96,6 +96,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload-for-xmlhttprequest-with-non-json-message/error-hero-module.local.php b/spec/Fixture/config/autoload-for-xmlhttprequest-with-non-json-message/error-hero-module.local.php
@@ -87,6 +87,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload-for-xmlhttprequest/error-hero-module.local.php b/spec/Fixture/config/autoload-for-xmlhttprequest/error-hero-module.local.php
@@ -94,6 +94,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload-with-doctrine/error-hero-module.local.php b/spec/Fixture/config/autoload-with-doctrine/error-hero-module.local.php
@@ -91,6 +91,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload-with-enable-sendmail-with-empty-email-receivers/error-hero-module.local.php b/spec/Fixture/config/autoload-with-enable-sendmail-with-empty-email-receivers/error-hero-module.local.php
@@ -93,6 +93,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 // no email in the list
             ],
diff --git a/spec/Fixture/config/autoload-with-enable-sendmail/error-hero-module.local.php b/spec/Fixture/config/autoload-with-enable-sendmail/error-hero-module.local.php
@@ -93,6 +93,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Fixture/config/autoload/error-hero-module.local.php b/spec/Fixture/config/autoload/error-hero-module.local.php
@@ -83,6 +83,9 @@
             // email sender
             'email-from'    => 'Sender Name <sender@host.com>',
 
+            // to include or not $_FILES on send mail
+            'include-files-to-attachments' => true,
+
             'email-to-send' => [
                 'developer1@foo.com',
                 'developer2@foo.com',
diff --git a/spec/Handler/LoggingFactorySpec.php b/spec/Handler/LoggingFactorySpec.php
@@ -89,6 +89,9 @@
                     // email sender
                     'email-from'    => 'Sender Name <sender@host.com>',
 
+                    // to include or not $_FILES on send mail
+                    'include-files-to-attachments' => true,
+
                     'email-to-send' => [
                         'developer1@foo.com',
                         'developer2@foo.com',
diff --git a/spec/Handler/LoggingSpec.php b/spec/Handler/LoggingSpec.php
@@ -61,6 +61,9 @@
                 // email sender
                 'email-from'    => 'Sender Name <sender@host.com>',
 
+                // to include or not $_FILES on send mail
+                'include-files-to-attachments' => true,
+
                 'email-to-send' => [
                     'developer1@foo.com',
                     'developer2@foo.com',
diff --git a/src/Handler/Logging.php b/src/Handler/Logging.php
@@ -52,20 +52,25 @@ class Logging
     /** @var string */
     private $emailSender;
 
+    /** @var bool */
+    private $includeFilesToAttachments;
+
     public function __construct(
         Logger $logger,
         array $errorHeroModuleLocalConfig,
         array $logWritersConfig,
         ?Message $mailMessageService = null,
-        ?TransportInterface $mailMessageTransport = null
+        ?TransportInterface $mailMessageTransport = null,
+        bool $includeFilesToAttachments = true
     ) {
-        $this->logger                = $logger;
-        $this->configLoggingSettings = $errorHeroModuleLocalConfig['logging-settings'];
-        $this->logWritersConfig      = $logWritersConfig;
-        $this->mailMessageService    = $mailMessageService;
-        $this->mailMessageTransport  = $mailMessageTransport;
-        $this->emailReceivers        = $errorHeroModuleLocalConfig['email-notification-settings']['email-to-send'];
-        $this->emailSender           = $errorHeroModuleLocalConfig['email-notification-settings']['email-from'];
+        $this->logger                    = $logger;
+        $this->configLoggingSettings     = $errorHeroModuleLocalConfig['logging-settings'];
+        $this->logWritersConfig          = $logWritersConfig;
+        $this->mailMessageService        = $mailMessageService;
+        $this->mailMessageTransport      = $mailMessageTransport;
+        $this->emailReceivers            = $errorHeroModuleLocalConfig['email-notification-settings']['email-to-send'];
+        $this->emailSender               = $errorHeroModuleLocalConfig['email-notification-settings']['email-from'];
+        $this->includeFilesToAttachments = $includeFilesToAttachments;
     }
 
     /**
@@ -113,7 +118,9 @@ private function getRequestData(RequestInterface $request): array
         $request_method = $request->getMethod();
         $body_data      = $request->getPost()->toArray();
         $raw_data       = str_replace(PHP_EOL, '', $request->getContent());
-        $files_data     = $request->getFiles()->toArray();
+        $files_data     = $this->includeFilesToAttachments
+            ? $request->getFiles()->toArray()
+            : [];
         $cookie         = $request->getCookie();
         $cookie_data    = $cookie instanceof Cookie
             ? $cookie->getArrayCopy()
diff --git a/src/Handler/LoggingFactory.php b/src/Handler/LoggingFactory.php
@@ -47,12 +47,15 @@ public function __invoke(ContainerInterface $container): Logging
             }
         }
 
+        $includeFilesToAttachments = $mailConfig['include-files-to-attachments'] ?? true;
+
         return new Logging(
             $errorHeroModuleLogger,
             $errorHeroModuleLocalConfig,
             $logWritersConfig,
             $mailMessageService,
-            $mailMessageTransport
+            $mailMessageTransport,
+            $includeFilesToAttachments
         );
     }
 }

-Original file line number
+Diff line change
             // email sender
             'email-from'    => 'Sender Name <[email protected]>',
 +            // to include or not $_FILES on send mail
 +            'include-files-to-attachments' => true,
++
             'email-to-send' => [
                 '[email protected]',
                 '[email protected]',