Merge branch 'release/1.11.0'

Author: cliffparnitzky

CHANGELOG.md

@@ -1,6 +1,12 @@
 Contao Extension "Monitoring"
 =============================
 
+Version 1.11.0 (2019-12-19)
+--------------------------
+- added parameterization of colors to be color blind friendly (see #28)
+- added CSS for more space for the action buttons (see #25)
+- added sending mails via notification center (exclusively) (see #1)
+
 Version 1.10.0 (2018-03-20)
 --------------------------
 - added sending an email, when test result changes to OKAY again (see #14)

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -52,7 +52,7 @@ Dependency
 
 This extension is dependent on the following extensions:
 
-- [[menatwork/contao-multicolumnwizard]](https://packagist.org/packages/menatwork/contao-multicolumnwizard)
+- [[terminal42/notification_center]](https://packagist.org/packages/terminal42/notification_center)
 
 The following extensions are recommended:
 

composer.json

@@ -24,7 +24,8 @@
 	"require":{
 		"php":">=5.3",
 		"contao/core-bundle":"~3.2 || ~4.4",
-		"contao-community-alliance/composer-plugin":"~2.4 || ~3.0"
+		"contao-community-alliance/composer-plugin":"~2.4 || ~3.0",
+		"terminal42/notification_center":"~1.5"
 	},
 	"suggest" : {
 		"cliffparnitzky/backend-custom-startpage" : "Provides the possibility for each user to select an individual startpage in the backend."
@@ -36,7 +37,7 @@
 			}
 		},
 		"branch-alias": {
-			"dev-master": "1.9.x-dev"
+			"dev-master": "1.11.x-dev"
 		}
 	}
 }

system/modules/Monitoring/assets/styles.css

@@ -1,26 +1,33 @@
-a.tl_monitoring_check_all{ background-image: url('check_all.png'); } a.tl_monitoring_check_one{ background-image: url('check_one.png'); } .col_last_test_status { text-align: center; }
-
-
-.tl_message_monitoring_status_okay, .tl_message_monitoring_status_okay a {
-  color: #049f04;
+a.tl_monitoring_check_all{
+  background-image: url('check_all.png');
 }
-p.tl_message_monitoring_status_okay {
-  background: url("status_okay.png") no-repeat scroll 6px center #ceffce;
+a.tl_monitoring_check_one{
+  background-image: url('check_one.png');
 }
-.tl_message_monitoring_status_error, .tl_message_monitoring_status_error a {
-  color: #cb032b;
+.col_last_test_status {
+  text-align: center;
 }
-p.tl_message_monitoring_status_error {
-  background: url("status_error.png") no-repeat scroll 6px center #ffdcdc;
+p.tl_message_monitoring_status.monitoring_status_okay {
+  background-image: url("status_okay.png");
 }
-.tl_message_monitoring_status_incomplete, .tl_message_monitoring_status_incomplete a {
-  color: #bd9500;
+p.tl_message_monitoring_status.monitoring_status_incomplete {
+  background-image: url("status_incomplete.png");
 }
-p.tl_message_monitoring_status_incomplete {
-  background: url("status_incomplete.png") no-repeat scroll 6px center #ffffd2;
+p.tl_message_monitoring_status.monitoring_status_error {
+  background-image: url("status_error.png");
+}
+p.tl_message_monitoring_status,
+p.tl_message_monitoring_status a {
+  color: #ffffff;
 }
 p.tl_message_monitoring_status {
-    border-radius: 3px;
-    margin: 1px 0 0;
-    padding: 4px 5px 5px 25px;
+  border-radius: 3px;
+  margin: 1px 0 0;
+  padding: 4px 5px 5px 25px;
+  background-repeat: no-repeat;
+  background-position: 6px center;
+}
+#tl_buttons > a[class*="tl_monitoring"] {
+    margin-bottom: 5px;
+    display: inline-block;
 }

system/modules/Monitoring/classes/Monitoring.php

@@ -2,7 +2,7 @@
 
 /**
  * Contao Open Source CMS
- * Copyright (C) 2005-2017 Leo Feyer
+ * Copyright (C) 2005-2019 Leo Feyer
  *
  * Formerly known as TYPOlight Open Source CMS.
  *
@@ -21,7 +21,7 @@
  * Software Foundation website at <http://www.gnu.org/licenses/>.
  *
  * PHP version 5
- * @copyright  Cliff Parnitzky 2014-2017
+ * @copyright  Cliff Parnitzky 2014-2019
  * @author     Cliff Parnitzky
  * @package    Monitoring
  * @license    LGPL
@@ -37,7 +37,7 @@
  * Class Monitoring
  *
  * Read the text from the given url and compare with test string.
- * @copyright  Cliff Parnitzky 2014-2017
+ * @copyright  Cliff Parnitzky 2014-2019
  * @author     Cliff Parnitzky
  * @package    Controller
  */
@@ -51,12 +51,8 @@ class Monitoring extends \Backend
   const CHECK_TYPE_MANUAL = 'MANUAL';
   const CHECK_TYPE_AUTOMATIC = 'AUTOMATIC';
 
-  const EMAIL_SUBJECT_ERROR = 'Monitoring errors detected';
-  const EMAIL_SUBJECT_OKAY = 'Monitoring entries okay again';
-  const EMAIL_MESSAGE_START_ERROR = "Scheduled monitoring check ended.\n\nThe following checks ended erroneous:\n\n";
-  const EMAIL_MESSAGE_START_OKAY = "Scheduled monitoring check ended.\n\nThe following checks are okay again:\n\n";
-  const EMAIL_MESSAGE_ENTRY = "- %s %s %s [%s] (%s)\n";
-  const EMAIL_MESSAGE_END = "\nPlease check your system for further information: %s\n\nThis is an automatically generated email by Contao extension [Monitoring].";
+  const ERROR_MESSAGE_START = "Scheduled monitoring check ended.\n\nThe following checks ended erroneous:\n\n";
+  const ERROR_MESSAGE_ENTRY = "- %s %s %s [%s] (%s)\n";
 
   const TEST_CIRCULATION = 1;
   const TEST_CIRCULATION_DELAY = 10;
@@ -105,6 +101,8 @@ public function checkAll()
    */
   public function checkScheduled()
   {
+    $mailSender = new MonitoringMailSender();
+    
     $oldErroneousCheckEntries = $this->removeMailingDeactivatedEntries($this->getErroneousCheckEntries());
 
     $status = $this->checkMultiple(self::CHECK_TYPE_AUTOMATIC);
@@ -116,15 +114,15 @@ public function checkScheduled()
     // only needed when there where errors detected
     if ($status != self::STATUS_OKAY)
     {
-      $errorMsg = self::EMAIL_MESSAGE_START_ERROR . $this->getCheckEntriesAsString($allErroneousCheckEntries);
+      $errorMsg = self::ERROR_MESSAGE_START . $this->getCheckEntriesAsString($allErroneousCheckEntries);
       $this->log($errorMsg, __METHOD__, TL_ERROR);
 
       if (!empty($newErroneousCheckEntries) && \Config::get('monitoringMailingActive') && \Config::get('monitoringAdminEmail') != '')
       {
-        $objEmail = new \Email();
-        $objEmail->subject = self::EMAIL_SUBJECT_ERROR;
-        $objEmail->text = self::EMAIL_MESSAGE_START_ERROR . $this->getCheckEntriesAsString($newErroneousCheckEntries) . sprintf(self::EMAIL_MESSAGE_END, \Environment::get('base') . "contao");
-        $objEmail->sendTo(\Config::get('monitoringAdminEmail'));
+        foreach($newErroneousCheckEntries as $entry)
+        {
+          $mailSender->sendErrorEmail($entry);
+        }
         $this->logDebugMsg("Scheduled monitoring check ended. Some checks ended erroneous. The monitoring admin was informed via email (" . \Config::get('monitoringAdminEmail') . ").", __METHOD__);
       }
       else
@@ -137,10 +135,10 @@ public function checkScheduled()
     $againOkayCheckEntries = array_diff_key($oldErroneousCheckEntries, $newErroneousCheckEntries);
     if (!empty($againOkayCheckEntries) && \Config::get('monitoringMailingActive') && \Config::get('monitoringAdminEmail') != '')
     {
-      $objEmail = new \Email();
-      $objEmail->subject = self::EMAIL_SUBJECT_OKAY;
-      $objEmail->text = self::EMAIL_MESSAGE_START_OKAY . $this->getCheckEntriesAsString($againOkayCheckEntries, true) . sprintf(self::EMAIL_MESSAGE_END, \Environment::get('base') . "contao");
-      $objEmail->sendTo(\Config::get('monitoringAdminEmail'));
+      foreach($againOkayCheckEntries as $entry)
+      {
+        $mailSender->sendAgainOkayEmail($entry);
+      }
       $this->logDebugMsg("Scheduled monitoring check ended. Some checks are okay again. The monitoring admin was informed via email (" . \Config::get('monitoringAdminEmail') . ").", __METHOD__);
     }
   }
@@ -294,12 +292,12 @@ private function getErroneousCheckEntries()
   /**
    * Return the list of erroneous check entries as string
    */
-  private function getCheckEntriesAsString($arrErroneousCheckEntries, $blnOverwriteStatus=false)
+  private function getCheckEntriesAsString($arrErroneousCheckEntries)
   {
     $strReturn = '';
     foreach ($arrErroneousCheckEntries as $key=>$entry)
     {
-      $strReturn .= sprintf(self::EMAIL_MESSAGE_ENTRY, $entry->customer, $entry->website, $entry->system, $blnOverwriteStatus ? self::STATUS_OKAY : $entry->last_test_status, $entry->url);
+      $strReturn .= sprintf(self::ERROR_MESSAGE_ENTRY, $entry->customer, $entry->website, $entry->system, $entry->last_test_status, $entry->url);
     }
 
     return $strReturn;
@@ -412,7 +410,7 @@ private function logDebugMsg($msg, $origin)
    */
   private function addCheckMessage($intEntryId, $strStatus)
   {
-    $this->addRawMessage('<p class="tl_message_monitoring_status tl_message_monitoring_status_' . strtolower($strStatus) . '">' . sprintf($GLOBALS['TL_LANG']['MSC']['monitoringCheckResult'], $intEntryId, $GLOBALS['TL_LANG']['tl_monitoring']['statusTypes'][$strStatus][0]) . '</p>');
+    $this->addRawMessage('<p class="tl_message_monitoring_status monitoring_status_' . strtolower($strStatus) . '">' . sprintf($GLOBALS['TL_LANG']['MSC']['monitoringCheckResult'], $intEntryId, $GLOBALS['TL_LANG']['tl_monitoring']['statusTypes'][$strStatus][0]) . '</p>');
   }
 }
 ?>