Send email if no tracked data within N days. (#13363)

* Remember user who created a site.

* Send email if no tracked data within N days.

* Add test and get to pass.

* Fixes after manual tests of emails

* Bump version & change column name to creator_login.

* Email tweaks.

* Rename Site::getCreationUserFor

* Modify Site:: access methiod name

* Applying PR feedback.

* Move email HTML content generation logic to separate class in DI.

* tweak translations

* Apply PR review feedback.

* Couple more tweaks.

* Make tracking code check a one time task + and save timetable when removing inactive tasks.

* Update save call.

* Apply more PR feedback.

* small performance tweak and put the site name in quotes

* Fixing tests.

* Update expected file.

1 files changed, 44 insertions, 0 deletions

diff --git a/core/Mail.php b/core/Mail.php
index a3771f536d..ab671b4010 100644
--- a/core/Mail.php
+++ b/core/Mail.php
@@ -9,8 +9,10 @@
 namespace Piwik;
 
 use Piwik\Container\StaticContainer;
+use Piwik\Email\ContentGenerator;
 use Piwik\Plugins\CoreAdminHome\CustomLogo;
 use Piwik\Translation\Translator;
+use Piwik\View\HtmlReportEmailHeaderView;
 use Zend_Mail;
 
 /**
@@ -52,6 +54,13 @@ class Mail extends Zend_Mail
         $this->setFrom($fromEmailAddress, $fromEmailName);
     }
 
+    public function setWrappedHtmlBody(View $body)
+    {
+        $contentGenerator = StaticContainer::get(ContentGenerator::class);
+        $bodyHtml = $contentGenerator->generateHtmlContent($body);
+        $this->setBodyHtml($bodyHtml);
+    }
+
     /**
      * Sets the sender.
      *
@@ -123,7 +132,25 @@ class Mail extends Zend_Mail
 
     public function send($transport = null)
     {
+        if (!$this->shouldSendMail()) {
+            return $this;
+        }
+
+        $mail = $this;
+
+        /**
+         * This event is posted right before an email is sent. You can use it to customize the email by, for example, replacing
+         * the subject/body, changing the from address, etc.
+         * TODO: changelog
+         * @param Mail $this The Mail instance that is about to be sent.
+         */
+        Piwik::postEvent('Mail.send', [$mail]);
+
         if (defined('PIWIK_TEST_MODE')) { // hack
+            /**
+             * @ignore
+             * @deprecated
+             */
             Piwik::postTestEvent("Test.Mail.send", array($this));
         } else {
             return parent::send($transport);
@@ -183,4 +210,21 @@ class Mail extends Zend_Mail
         $string = str_replace($search, $replace, $string);
         return $string;
     }
+
+    private function shouldSendMail()
+    {
+        $shouldSendMail = true;
+
+        $mail = $this;
+
+        /**
+         * This event is posted before sending an email. You can use it to abort sending a specific email, if you want.
+         * TODO: changelog
+         * @param bool &$shouldSendMail Whether to send this email or not. Set to false to skip sending.
+         * @param Mail $mail The Mail instance that will be sent.
+         */
+        Piwik::postEvent('Mail.shouldSend', [&$shouldSendMail, $mail]);
+
+        return $shouldSendMail;
+    }
 }