Update README.md

README.md

@@ -1,10 +1,16 @@
-## mailGraph (v1.26)
+## mailGraph (v1.28)
 Zabbix Media module and scripts for sending e-mail alerts with graphs.
 
 **Please use the Wiki for information on how to install, configure and use MailGraph in Zabbix.**
 
-## Upgrade notes
-Per v1.25 and higher the template data provisioning and code has fundamentally changed. If you upgrade from an earlier version as v1.25, make sure you understand the changes in templates/html.template (now making use of arrays for lists of items).
+## UPGRADE NOTES
+### v1.27
+If you upgrade to v1.27 please be aware of the additional features for adding Tags to Trigger and Host to add additional graphs and the associated `html.template` updates that come alone with it (otherwise the new graphs will not show ...).
+
+### v1.25 and higher
+Template data provisioning and code has fundamentally changed. If you upgrade from an earlier version as v1.25, make sure you understand the changes in templates/html.template (now making use of arrays for lists of items).
 
 ## Example message
+The below message is just an example of what MailGraph is capable of. The template engine used ("Twig") however allows for a fully customized message creation to your needs!
+
 [![](images/Example-mail-message-v122.png?raw=true)](images/Example-mail-message-v122.png)

mailGraph.php

@@ -33,6 +33,9 @@
     // 1.25 2021/03/16 - Mark Oudsen - Refactoring for optimized flow and relevant data retrieval
     // 1.26 2021/03/19 - Mark Oudsen - Bugfixes after refactor (wrong itemId and incorrect eventValue)
     //                                 Suppressing Zabbix username-password in log
+    // 1.27 2021/03/19 - Mark Oudsen - Added ability to define "mailGraph.screen" tag to embed graphs from
+    //                                 Added PHP informational and warnings to log for easier debug/spotting
+    // 1.28 2021/03/24 - Mark Oudsen - Added ability to specify username/password for TLS/SSL
     // ------------------------------------------------------------------------------------------------------
     //
     // (C) M.J.Oudsen, mark.oudsen@puzzl.nl
@@ -55,14 +58,15 @@
 
     // CONSTANTS
 
-    $cVersion = 'v1.26';
+    $cVersion = 'v1.28';
     $cCRLF = chr(10).chr(13);
     $maskDateTime = 'Y-m-d H:i:s';
+    $maxGraphs = 4;
 
     // DEBUG SETTINGS
     // -- Should be FALSE for production level use
 
-    $cDebug = FALSE;          // Extended debug logging mode
+    $cDebug = TRUE;          // Extended debug logging mode
     $cDebugMail = FALSE;      // If TRUE, includes log in the mail message (html and plain text attachments)
     $showLog = FALSE;         // Display the log - !!! only use in combination with CLI mode !!!
 
@@ -268,6 +272,22 @@
         if ($showLog) { echo $logString.$cCRLF; }
     }
 
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////
+    // Catch PHP warnings/notices/errors
+
+    function catchPHPerrors($errno, $errstr, $errfile, $errline)
+    {
+        // --- Just log ...
+
+        _log('!! ('.$errno.') "'.$errstr.'" at line #'.$errline.' of "'.$errfile.'"');
+
+        // --- We do not take care of any errors, etc.
+        return FALSE;
+    }
+
+    set_error_handler("catchPHPerrors");
+
     /////////////////////////////////////////////////////////////////////////////////////////////////////////
     /////////////////////////////////////////////////////////////////////////////////////////////////////////
     // Read configuration file
@@ -409,7 +429,8 @@
         }
     }
 
-    _log('# Data passed to MailGraph main routine and used for processing'.$cCRLF.json_encode($problemData,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
+    _log('# Data passed to MailGraph main routine and used for processing'.
+         $cCRLF.json_encode($problemData,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
 
     // --- CHECK AND SET P_ VARIABLES ---
     // FROM POST OR CLI DATA
@@ -468,6 +489,12 @@
     $p_smtp_strict = 'yes';
     if ((isset($config['smtp_strict'])) && ($config['smtp_strict']=='no')) { $p_smtp_strict = 'no'; }
 
+    $p_smtp_username = '';
+    if (isset($config['smtp_username'])) { $p_smtp_username = $config['smtp_username']; }
+
+    $p_smtp_password = '';
+    if (isset($config['smtp_password'])) { $p_smtp_password = $config['smtp_password']; }
+
     $p_graph_match = 'any';
     if ((isset($config['graph_match'])) && ($config['graph_match']=='exact')) { $p_graph_match = 'exact'; }
 
@@ -613,6 +640,9 @@
     // --- Custom settings?
 
     $forceGraph = 0;
+    $triggerScreen = 0;
+    $triggerScreenPeriod = '';
+    $triggerScreenPeriodHeader = '';
 
     foreach($thisTrigger['result'][0]['tags'] as $aTag)
     {
@@ -662,6 +692,21 @@
                 $problemData['debug'] = 1;
                 _log('+ Mail debug log enabled');
                 break;
+
+            case 'mailGraph.screen':
+                $triggerScreen = intval($aTag['value']);
+                _log('+ Trigger screen = '.$triggerScreen);
+                break;
+
+            case 'mailGraph.screenPeriod':
+                $triggerScreenPeriod = $aTag['value'];
+                _log('+ Trigger screen period = '.$triggerScreenPeriod);
+                break;
+
+            case 'mailGraph.screenPeriodHeader':
+                $triggerScreenPeriodHeader = $aTag['value'];
+                _log('+ Trigger screen header = '.$triggerScreenPeriodHeader);
+                break;
         }
     }
 
@@ -709,7 +754,8 @@
     $request = array('jsonrpc'=>'2.0',
                      'method'=>'host.get',
                      'params'=>array('hostids'=>$hostId,
-                                     'output'=>'extend'),
+                                     'output'=>'extend',
+                                     'selectTags'=>'extend'),
                      'auth'=>$token,
                      'id'=>nextRequestID());
 
@@ -723,6 +769,33 @@
     $mailData['HOST_ERROR'] = $thisHost['result'][0]['error'];
     $mailData['HOST_DESCRIPTION'] = $thisHost['result'][0]['description'];
 
+    // --- Custom settings?
+
+    $hostScreen = 0;
+    $hostScreenPeriod = '';
+    $hostScreenPeriodHeader = '';
+
+    foreach($thisHost['result'][0]['tags'] as $aTag)
+    {
+        switch ($aTag['tag'])
+        {
+            case 'mailGraph.screen':
+                $hostScreen = intval($aTag['value']);
+                _log('+ Host screen (from TAG) = '.$hostScreen);
+                break;
+
+            case 'mailGraph.screenPeriod':
+                $hostScreenPeriod = $aTag['value'];
+                _log('+ Host screen period (from TAG) = '.$hostScreenPeriod);
+                break;
+
+            case 'mailGraph.screenPeriodHeader':
+                $hostScreenPeriodHeader = $aTag['value'];
+                _log('+ Host screen period header (from TAG) = '.$hostScreenPeriodHeader);
+                break;
+        }
+    }
+
     _log('# Retreive HOST macro information');
 
     $request = array('jsonrpc'=>'2.0',
@@ -735,9 +808,30 @@
     $thisMacros = postJSON($z_url_api,$request);
     _log('> Host macro data'.$cCRLF.json_encode($thisMacros,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
 
-    // --------------------------------------------
-    // --- GET GRAPHS ASSOCIATED WITH THIS HOST ---
-    // --------------------------------------------
+    foreach($thisMacros['result'] as $aMacro)
+    {
+        switch($aMacro['macro'])
+        {
+            case 'mailGraph.screen':
+                $hostScreen = intval($aMacro['value']);
+                _log('+ Host screen (from MACRO) = '.$hostScreen);
+                break;
+
+            case 'mailGraph.screenPeriod':
+                $hostScreenPeriod = $aMacro['value'];
+                _log('+ Host screen period (from MACRO) = '.$hostScreenPeriod);
+                break;
+
+            case 'mailGraph.screenPeriodHeader':
+                $hostScreenPeriodHeader = $aMacro['value'];
+                _log('+ Host screen header (from MACRO) = '.$hostScreenPeriodHeader);
+                break;
+        }
+    }
+
+    // ------------------------------------------------------------------
+    // --- GET GRAPHS ASSOCIATED WITH THIS HOST AND THE TRIGGER ITEMS ---
+    // ------------------------------------------------------------------
 
     _log('# Retrieve associated graphs to this HOST and the TRIGGER ITEMS');
 
@@ -781,7 +875,8 @@
                          'id'=>nextRequestID());
 
         $forceGraphInfo = postJSON($z_url_api,$request);
-        _log('> Forced graph data'.$cCRLF.json_encode($forceGraphInfo,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
+        _log('> Forced graph data'.$cCRLF.
+             json_encode($forceGraphInfo,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
 
         if (!isset($forceGraphInfo['result'][0]))
         {
@@ -840,11 +935,95 @@
 
     _log('> Graphs found (matching/partial) = '.sizeof($matchedGraphs).' / '.sizeof($otherGraphs));
 
+    // ---------------------------------------------------------------------------
+    // --- FIND MATCHING GRAPH ITEMS WITH TRIGGER AND/OR HOST SCREEN REFERENCE ---
+    // ---------------------------------------------------------------------------
+
+    function _sort($a,$b)
+    {
+        if ($a['screen']['y']>$b['screen']['y']) { return(1); }
+        if ($a['screen']['y']<$b['screen']['y']) { return(-1); }
+        if ($a['screen']['x']>$b['screen']['x']) { return(1); }
+        if ($a['screen']['x']<$b['screen']['x']) { return(-1); }
+        return(0);
+    }
+
+    function fetchGraphsFromScreen($screenId)
+    {
+        global $token;
+        global $z_url_api;
+        global $cCRLF;
+
+        // --- Pick up the SCREEN ITEMS associated to the SCREEN
+
+        $request = array('jsonrpc'=>'2.0',
+                         'method'=>'screen.get',
+                         'params'=>array('screenids'=>$screenId,
+                                         'output'=>'extend',
+                                         'selectScreenItems'=>'extend'),
+                         'auth'=>$token,
+                         'id'=>nextRequestID());
+
+        $screenGraphs = postJSON($z_url_api,$request);
+        _log('> Screen items data for screen #'.$screenId.$cCRLF.json_encode($screenGraphs,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
+
+        // --- Filter on specific type(s) and enrich the graph data
+
+        $result = array();
+
+        foreach($screenGraphs['result'][0]['screenitems'] as $anItem)
+        {
+            switch($anItem['resourcetype'])
+            {
+                case 0: // Graph
+                    $request = array('jsonrpc'=>'2.0',
+                                     'method'=>'graph.get',
+                                     'params'=>array('graphids'=>$anItem['resourceid'],
+                                                     'expandName'=>1,
+                                                     'output'=>'extend'),
+                                     'auth'=>$token,
+                                     'id'=>nextRequestID());
+
+                    $screenGraph = postJSON($z_url_api,$request);
+                    _log('+ Graph data for screen item #'.$anItem['screenitemid'].$cCRLF.
+                         json_encode($screenGraph,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
+
+                    $result[] = array('screen'=>$anItem,'name'=>$screenGraphs['result'][0]['name'],'graph'=>$screenGraph['result'][0]);
+                    break;
+            }
+        }
+
+        // --- Sort the result according to SCREEN x,y position
+
+        usort($result,"_sort");
+
+        // --- Done
+
+        return($result);
+    }
+
+    $triggerGraphs = array();
+
+    if ($triggerScreen>0)
+    {
+        _log('# Fetching graph information for TRIGGER for screen #'.$hostScreen);
+        $triggerGraphs = fetchGraphsFromScreen($triggerScreen);
+        _log('> Graphs found = '.sizeof($triggerGraphs));
+    }
+
+
+    if ($hostScreen>0)
+    {
+        _log('# Fetching graph information for HOST for screen #'.$hostScreen);
+        $hostGraphs = fetchGraphsFromScreen($hostScreen);
+        _log('> Graphs found = '.sizeof($hostGraphs));
+    }
+
     /////////////////////////////////////////////////////////////////////////////////////////////////////////
-    // Fetch Graph //////////////////////////////////////////////////////////////////////////////////////////
+    // Fetch Graph(s) ///////////////////////////////////////////////////////////////////////////////////////
     /////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-    // Determine number of periods for this graph
+    // Determine number of periods for the ITEM graphs
 
     $p_periods = array();
     $p_periods_headers = array();
@@ -883,8 +1062,12 @@
         }
     }
 
-    while (sizeof($p_periods)>4) { array_pop($p_periods); }
-    while (sizeof($p_periods_headers)>4) { array_pop($p_periods_headers); }
+    // Strip off any excessive elements from the end
+
+    while (sizeof($p_periods)>$maxGraphs) { array_pop($p_periods); }
+    while (sizeof($p_periods_headers)>$maxGraphs) { array_pop($p_periods_headers); }
+
+    // Fetching of the ITEM graphs
 
     $graphFiles = array();
     $graphURL = '';
@@ -930,14 +1113,78 @@
 
             $graphFiles[] = $graphFile;
 
-            $mailData['GRAPHS'][$aKey]['URL'] = $z_url_image . $graphFile;
-            $mailData['GRAPHS'][$aKey]['HEADER'] = $p_periods_headers[$aKey];
+            $mailData['GRAPHS_I'][$aKey]['PATH'] = $z_images_path . $graphFile;
+            $mailData['GRAPHS_I'][$aKey]['URL'] = $z_url_image . $graphFile;
+            $mailData['GRAPHS_I'][$aKey]['HEADER'] = $p_periods_headers[$aKey];
         }
 
         $mailData['GRAPH_ZABBIXLINK'] = $z_server.'graphs.php?form=update&graphid='.$mailData['GRAPH_ID'];
     }
 
-    // Prepare HTML LOG content
+    // Fetch graphs associated to TRIGGER or HOST screen references obtained earlier
+
+    function addGraphs($varName,$info,$period,$periodHeader)
+    {
+        global $p_graphWidth;
+        global $p_graphHeight;
+        global $p_showLegend;
+        global $z_url_image;
+        global $z_images_path;
+        global $z_server;
+        global $mailData;
+
+        $files = array();
+
+        foreach($info as $aKey=>$anItem)
+        {
+            $graphFile = GraphImageById($anItem['graph']['graphid'],
+                                        $p_graphWidth,$p_graphHeight,
+                                        $anItem['graph']['graphtype'],
+                                        $p_showLegend,$period);
+
+            $mailData['GRAPHS_'.$varName][$aKey]['URL'] = $z_url_image . $graphFile;
+            $mailData['GRAPHS_'.$varName][$aKey]['PATH'] = $z_images_path . $graphFile;
+        }
+
+        $mailData['GRAPHS_'.$varName.'_LINK'] = $z_server.'screens.php?elementid='.$info[0]['screen']['screenid'];
+        $mailData['GRAPHS_'.$varName.'_HEADER'] = $info[0]['name'];
+        $mailData['GRAPHS_'.$varName.'_PERIODHEADER'] = $periodHeader;
+
+    }
+
+    if (sizeof($triggerGraphs)>0)
+    {
+        if ($triggerScreenPeriod=='')
+        {
+            $triggerScreenPeriod = $p_periods[0];
+            $triggerScreenPeriodHeader = $p_periods_headers[0];
+        }
+
+        if ($triggerScreenPeriodHeader=='') { $triggerScreenPeriodHeader = $triggerScreenPeriod; }
+
+        addGraphs('T',$triggerGraphs,$triggerScreenPeriod,$triggerScreenPeriodHeader);
+
+        $mailData['TRIGGER_SCREEN'] = $triggerScreen;
+    }
+
+    if (sizeof($hostGraphs)>0)
+    {
+        if ($hostScreenPeriod=='')
+        {
+            $hostScreenPeriod = $p_periods[0];
+            $hostScreenPeriodHeader = $p_periods_headers[0];
+        }
+
+        if ($hostScreenPeriodHeader=='') { $hostScreenPeriodHeader = $hostScreenPeriod; }
+
+        addGraphs('H',$hostGraphs,$hostScreenPeriod,$hostScreenPeriodHeader);
+
+        $mailData['HOST_SCREEN'] = $hostScreen;
+    }
+
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////
+    // Prepare HTML LOG content /////////////////////////////////////////////////////////////////////////////
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////
 
     $mailData['LOG_HTML'] = implode('</br/>',$logging);
     $mailData['LOG_HTML'] = str_replace($cCRLF,'<br/>',$mailData['LOG_HTML']);
@@ -1002,11 +1249,18 @@
         $transport = (new Swift_SmtpTransport($p_smtp_server, $p_smtp_port));
     }
 
+    // Username/password?
+
+    if ($p_smtp_username!='') { $transport->setUsername($p_smtp_username); }
+    if ($p_smtp_password!='') { $transport->setPassword($p_smtp_password); }
+
+    // Start actual mail(er)
+
     $mailer = new Swift_Mailer($transport);
 
     $message = (new Swift_Message());
 
-    // Fetch mailer ID from this message (no Swift function available for it ...)
+    // --- Fetch mailer ID from this message (no Swift function available for it ...)
     // --- "Message-ID: <...id...@swift.generated>"
 
     $content = $message->toString();
@@ -1031,19 +1285,26 @@
 
     $twig = new \Twig\Environment($loader);
 
-    if (sizeof($graphFiles)>0)
-    {
-        // Embed the image(s)
+    // --- Embed the images
 
-        $graphReference = 0;
-
-        foreach($graphFiles as $graphFile)
+    function embedGraphs($graphs,$varName,$type)
     {
-            $mailData['GRAPHS'][$graphReference++]['CID'] = $message->embed(Swift_Image::fromPath($z_images_path.$graphFile));
-            _log('> Embedded graph image '.$z_images_path.$graphFile);
+        global $message;
+        global $mailData;
+
+        foreach($graphs as $aKey=>$anItem)
+        {
+            $mailData['GRAPHS_'.$varName][$aKey]['CID'] = $message->embed(Swift_Image::fromPath($mailData['GRAPHS_'.$varName][$aKey]['PATH']));
+            _log('> Embedded graph image ('.$type.') '.$mailData['GRAPHS_'.$varName][$aKey]['PATH']);
         }
     }
 
+    embedGraphs($graphFiles,'I','ITEM');
+    embedGraphs($triggerGraphs,'T','TRIGGER');
+    embedGraphs($hostGraphs,'H','HOST');
+
+    // --- Render the content
+
     $bodyHTML = $twig->render('html', $mailData);
     $bodyPlain = $twig->render('plain', $mailData);
     $mailSubject = $twig->render('subject', $mailData);
@@ -1076,6 +1337,10 @@
     $response = array('messageId.mailGraph'=>$messageId);
     echo json_encode($response).$cCRLF;
 
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////
+    // Wrap up //////////////////////////////////////////////////////////////////////////////////////////////
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////
+
     // Store log?
 
     if (($cDebug) || (isset($problemData['debug'])))

templates/html.template

@@ -114,16 +114,6 @@
                 </table>
             </td>
         </tr>
-{% for aGraph in GRAPHS %}
-        <tr>
-            <div align=justify>
-                <td align="center">
-                    <span class="graphHeader">{{ aGraph.HEADER }}</span><br/>
-                    <img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
-                </td>
-            </div>
-        </tr>
-{% endfor %}
         <tr>
             <td class="links">
                 <div align=center>
@@ -137,6 +127,66 @@
                 </div>
             </td>
         </tr>
+{% for aGraph in GRAPHS_I %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <span class="graphHeader">{{ aGraph.HEADER }}</span><br/>
+                    <img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
+                </td>
+            </div>
+        </tr>
+{% endfor %}
+{% if TRIGGER_SCREEN > 0 %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <span class="graphHeader">{{ GRAPHS_T_HEADER }} - {{ GRAPHS_T_PERIODHEADER }}</span>
+                </td>
+            </div>
+        </tr>
+        <tr>
+            <td class="links">
+                <div align="center">
+                    Screen ID: <a href="{{ GRAPHS_T_LINK }}">{{ TRIGGER_SCREEN }}</a>
+                </div>
+            </td>
+        </tr>
+    {% for aGraph in GRAPHS_T %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
+                </td>
+            </div>
+        </tr>
+    {% endfor %}
+{% endif %}
+{% if HOST_SCREEN > 0 %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <span class="graphHeader">{{ GRAPHS_H_HEADER }} - {{ GRAPHS_H_PERIODHEADER }}</span>
+                </td>
+            </div>
+        </tr>
+        <tr>
+            <td class="links">
+                <div align="center">
+                    Screen ID: <a href="{{ GRAPHS_H_LINK }}">{{ HOST_SCREEN }}</a>
+                </div>
+            </td>
+        </tr>
+    {% for aGraph in GRAPHS_H %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
+                </td>
+            </div>
+        </tr>
+    {% endfor %}
+{% endif %}
     </table>
 </body>
 </html>