Merge branch 'nagios-implementation' into 'master'

Till Brehm · Till Brehm · commit d803c0307ffb · 2016-09-05T11:22:30.000+02:00
Nagios implementation

Adds compatibility to include nagios or check_mk (nagios add on) data in ispc's monitoring-module.

URL must containg /check_mk for cmk-detection to work. This makes OMD (current official cmk setup method) fully compatible.
Further oldschool manual CMK-Setups are also working as long as you keep the default /check_mk (if you did not you can add an alias or simply build the correct autologin url on your own and leave login data blank)

Further a requirement is that your URL is HTTPS and using the same domain! E.g. ISPC is on panel.example.com you can have monitoring on moni.example.com but not moni.otherdomain.org. This is a browser limitation to iframes.

For Check_MK you have to use Cookie Based authentication. This is default since OMD is out... If you did not change yet, blame yourself :) Workaround: manually add Basic Auth data to the URL. I really mean not to support this.


Btw: I also plan on building a nagios plugin or some other way to check ISPC's health using Nagios but I need much more time for this so probably this will come as a request for 3.2 then.

See merge request !434
diff --git a/docs/autoinstall_samples/autoinstall.conf_sample.php b/docs/autoinstall_samples/autoinstall.conf_sample.php
@@ -49,4 +49,14 @@
 $autoupdate['ispconfig_port'] = '8080'; // default: 8080
 $autoupdate['create_new_ispconfig_ssl_cert'] = 'no'; // no (default), yes
 $autoupdate['reconfigure_crontab'] = 'yes'; // yes (default), no
+
+/* These are for service-detection (defaulting to old behaviour where alle changes were automatically accepted) */
+$autoupdate['svc_detect_change_mail_server'] = 'yes'; // yes (default), no
+$autoupdate['svc_detect_change_web_server'] = 'yes'; // yes (default), no
+$autoupdate['svc_detect_change_dns_server'] = 'yes'; // yes (default), no
+$autoupdate['svc_detect_change_xmpp_server'] = 'yes'; // yes (default), no
+$autoupdate['svc_detect_change_firewall_server'] = 'yes'; // yes (default), no
+$autoupdate['svc_detect_change_vserver_server'] = 'yes'; // yes (default), no
+$autoupdate['svc_detect_change_db_server'] = 'yes'; // yes (default), no
+
 ?>
diff --git a/docs/autoinstall_samples/autoinstall.ini.sample b/docs/autoinstall_samples/autoinstall.ini.sample
@@ -47,4 +47,13 @@ reconfigure_permissions_in_master_database=no
 reconfigure_services=yes
 ispconfig_port=8080
 create_new_ispconfig_ssl_cert=no
-reconfigure_crontab=yes
+reconfigure_crontab=yes
+
+; These are for service-detection (defaulting to old behaviour where alle changes were automatically accepted)
+svc_detect_change_mail_server=yes
+svc_detect_change_web_server=yes
+svc_detect_change_dns_server=yes
+svc_detect_change_xmpp_server=yes
+svc_detect_change_firewall_server=yes
+svc_detect_change_vserver_server=yes
+svc_detect_change_db_server=yes
diff --git a/install/lib/update.lib.php b/install/lib/update.lib.php
@@ -418,4 +418,22 @@ function setDefaultServers(){
 	
 }
 
+
+
+/** Checks if a detected service differs from db setup and asks the user what to do
+ *	@param $servicename string the name of the Database-Field in "servers" for this service
+ *	@param $detected_value boolean The result of service detection
+ */
+function check_service_config_state($servicename, $detected_value) {
+	global $current_svc_config, $inst, $conf;
+	
+	if ($current_svc_config[$servicename] == 1) $current_state = 1;
+	else $current_state = 0;
+	
+	if ($detected_value != $current_state) {
+		if ($inst->simple_query('Service \''.$servicename.'\' '.($detected_value ? 'has been' : 'has not been').' detected ('.($current_state ? 'strongly recommended, currently enabled' : 'currently disabled').') do you want to '.($detected_value ? 'enable and configure' : 'disable').' it? ', array('yes', 'no'), ($current_state ? 'yes' : 'no'), 'svc_detect_change_'.$servicename) == 'yes') return $detected_value;
+		else return $current_state;
+	} else return $current_state;
+}
+
 ?>
diff --git a/install/update.php b/install/update.php
@@ -304,13 +304,18 @@
 //** Detect the installed applications
 $inst->find_installed_apps();
 
-$conf['services']['mail'] = $conf['postfix']['installed'];
-if ($conf['powerdns']['installed'] || $conf['bind']['installed'] || $conf['mydns']['installed']) $conf['services']['dns'] = true;
-if ($conf['apache']['installed'] || $conf['nginx']['installed']) $conf['services']['web'] = true;
-$conf['services']['xmpp'] =  $conf['xmpp']['installed'];;
-if ($conf['ufw']['installed'] || $conf['firewall']['installed']) $conf['services']['firewall'] = true;
-$conf['services']['vserver'] = $conf['services']['vserver'];
+//** Check for current service config state and compare to our results
+if ($conf['mysql']['master_slave_setup'] == 'y') $current_svc_config = $inst->dbmaster->queryOneRecord("SELECT mail_server,web_server,dns_server,xmpp_server,firewall_server,vserver_server,db_server FROM ?? WHERE server_id=?", $conf['mysql']['master_database'] . '.server', $conf['server_id']);
+else $current_svc_config = $inst->db->queryOneRecord("SELECT mail_server,web_server,dns_server,xmpp_server,firewall_server,vserver_server,db_server FROM ?? WHERE server_id=?", $conf["mysql"]["database"] . '.server', $conf['server_id']);
+$conf['postfix']['installed'] = check_service_config_state('mail_server', $conf['postfix']['installed']);
+$conf['services']['dns'] = check_service_config_state('dns_server', ($conf['powerdns']['installed'] || $conf['bind']['installed'] || $conf['mydns']['installed']));
+$conf['services']['web'] = check_service_config_state('web_server', ($conf['apache']['installed'] || $conf['nginx']['installed']));
+$conf['services']['xmpp'] = check_service_config_state('xmpp_server', $conf['xmpp']['installed']);
+$conf['services']['firewall'] = check_service_config_state('firewall_server', ($conf['ufw']['installed'] || $conf['firewall']['installed']));
+$conf['services']['vserver'] = check_service_config_state('vserver_server', $conf['services']['vserver']);
+//** vv is this intended??? If you want to check adapt the lines above... vv
 $conf['services']['db'] = true;
+unset($current_svc_config);
 
 
 //** Shall the services be reconfigured during update
diff --git a/interface/lib/classes/remoting.inc.php b/interface/lib/classes/remoting.inc.php
@@ -37,7 +37,7 @@
 class remoting {
 
 	//* remote session timeout in seconds
-	private $session_timeout = 600;
+	private $session_timeout = 1800;
 
 	public $oldDataRecord;
 	public $dataRecord;
diff --git a/interface/web/admin/form/server_config.tform.php b/interface/web/admin/form/server_config.tform.php
@@ -357,6 +357,34 @@
 			'width' => '40',
 			'maxlength' => '255'
 		),
+		'nagios_url' => array(
+			'datatype' => 'VARCHAR',
+			'formtype' => 'TEXT',
+			'default' => '',
+			'validators' => array ( 0 => array ( 'type' => 'REGEX',
+					'regex' => '/(^$)|(^((?:http|https)(?::\\/{2}[\\w]+)(?:[\\/|\\.]?)(?:[^\\s"]*))$)/',
+					'errmsg'=> 'nagios_url_error_regex'),
+			),
+			'value' => '',
+			'width' => '40',
+			'maxlength' => '255'
+		),
+		'nagios_user' => array(
+			'datatype' => 'VARCHAR',
+			'formtype' => 'TEXT',
+			'default' => '',
+			'value' => '',
+			'width' => '40',
+			'maxlength' => '255'
+		),
+		'nagios_password' => array(
+			'datatype' => 'VARCHAR',
+			'formtype' => 'TEXT',
+			'default' => '',
+			'value' => '',
+			'width' => '40',
+			'maxlength' => '255'
+		),
 		'monitor_system_updates' => array(
 			'datatype' => 'VARCHAR',
 			'formtype' => 'CHECKBOX',
diff --git a/interface/web/admin/lib/lang/de_server_config.lng b/interface/web/admin/lib/lang/de_server_config.lng
@@ -198,6 +198,11 @@ $wb['munin_user_txt'] = 'Munin-Benutzer';
 $wb['munin_password_txt'] = 'Munin-Passwort';
 $wb['munin_url_error_regex'] = 'Ungültige Munin-URL';
 $wb['munin_url_note_txt'] = 'Platzhalter:';
+$wb['nagios_url_txt'] = 'Nagios/Check_MK-URL';
+$wb['nagios_user_txt'] = 'Nagios/Check_MK-Benutzer';
+$wb['nagios_password_txt'] = 'Nagios/Check_MK-Passwort';
+$wb['nagios_url_error_regex'] = 'Ungültige Nagios/Check_MK-URL';
+$wb['nagios_url_note_txt'] = 'Check_MK wird automatisch erkannt. Platzhalter:';
 $wb['backup_dir_is_mount_txt'] = 'Backupverzeichnis ist ein eigener Mount?';
 $wb['backup_dir_mount_cmd_txt'] = 'Mount-Befehl, falls Backupverzeichnis nicht gemountet';
 $wb['backup_delete_txt'] = 'Backups loeschen wenn eine Domain / Webseite geloescht wird';
diff --git a/interface/web/admin/lib/lang/en_server_config.lng b/interface/web/admin/lib/lang/en_server_config.lng
@@ -199,6 +199,11 @@ $wb['munin_user_txt'] = 'Munin User';
 $wb['munin_password_txt'] = 'Munin Password';
 $wb['munin_url_error_regex'] = 'Invalid Munin URL';
 $wb['munin_url_note_txt'] = 'Placeholder:';
+$wb['nagios_url_txt'] = 'Nagios/Check_MK URL';
+$wb['nagios_user_txt'] = 'Nagios/Check_MK User';
+$wb['nagios_password_txt'] = 'Nagios/Check_MK Password';
+$wb['nagios_url_error_regex'] = 'Invalid Nagios/Check_MK URL';
+$wb['nagios_url_note_txt'] = 'Check_MK is being autodetected. Placeholder:';
 $wb["v6_prefix_txt"] = 'IPv6 Prefix';
 $wb["vhost_rewrite_v6_txt"] = 'Rewrite IPv6 on Mirror';
 $wb["v6_prefix_length"] = 'Prefix too long according to defined IPv6 ';
diff --git a/interface/web/admin/templates/server_config_server_edit.htm b/interface/web/admin/templates/server_config_server_edit.htm
@@ -96,6 +96,16 @@ <h1><tmpl_var name="list_head_txt"></h1>
                 <label for="munin_password" class="col-sm-3 control-label">{tmpl_var name='munin_password_txt'}</label>
                 <div class="col-sm-9"><input type="text" name="munin_password" id="munin_password" value="{tmpl_var name='munin_password'}" class="form-control" /></div></div>
 			<div class="form-group">
+                <label for="nagios_url" class="col-sm-3 control-label">{tmpl_var name='nagios_url_txt'}</label>
+                <div class="col-sm-6"><input type="text" name="nagios_url" id="nagios_url" value="{tmpl_var name='nagios_url'}" class="form-control" />&nbsp;{tmpl_var name='nagios_url_note_txt'} <a href="javascript:void(0);" class="addPlaceholder">[SERVERNAME]</a></div>
+            </div>
+			<div class="form-group">
+                <label for="nagios_user" class="col-sm-3 control-label">{tmpl_var name='nagios_user_txt'}</label>
+                <div class="col-sm-9"><input type="text" name="nagios_user" id="nagios_user" value="{tmpl_var name='nagios_user'}" class="form-control" /></div></div>
+			<div class="form-group">
+                <label for="nagios_password" class="col-sm-3 control-label">{tmpl_var name='nagios_password_txt'}</label>
+                <div class="col-sm-9"><input type="text" name="nagios_password" id="nagios_password" value="{tmpl_var name='nagios_password'}" class="form-control" /></div></div>
+			<div class="form-group">
                 <label class="col-sm-3 control-label">{tmpl_var name='monitor_system_updates_txt'}</label>
                 <div class="col-sm-9">
                     {tmpl_var name='monitor_system_updates'}
diff --git a/interface/web/monitor/lib/lang/de.lng b/interface/web/monitor/lib/lang/de.lng
@@ -155,6 +155,10 @@ $wb['no_permissions_to_view_monit_txt'] = 'Sie haben nicht die Berechtigung, auf
 $wb['Show Munin'] = 'Munin anzeigen';
 $wb['no_munin_url_defined_txt'] = 'Keine Munin-URL definiert.';
 $wb['no_permissions_to_view_munin_txt'] = 'Sie haben nicht die Berechtigung, auf Munin zuzugreifen.';
+$wb['Show Nagios/Check_MK'] = 'Nagios/Check_MK anzeigen';
+$wb['no_nagios_url_defined_txt'] = 'Keine Nagios-URL definiert.';
+$wb['no_permissions_to_view_nagios_txt'] = 'Sie haben nicht die Berechtigung, auf Nagios bzw. Check_MK zuzugreifen.';
+$wb['go_to_nagios_txt'] = 'Diese Anzeige in einem eigenen Fenster öffnen';
 $wb['no_data_database_size_txt'] = 'Derzeit stehen keine Daten über die Speicherverbrauch der Datenbanken zur Verfügung. Bitte später erneut Ãrüfen..';
 $wb['monitor_database_name_txt'] = 'Database';
 $wb['monitor_database_size_txt'] = 'Size';
diff --git a/interface/web/monitor/lib/lang/en.lng b/interface/web/monitor/lib/lang/en.lng
@@ -160,4 +160,8 @@ $wb['no_permissions_to_view_monit_txt'] = 'You are not allowed to access Monit.'
 $wb['Show Munin'] = 'Show Munin';
 $wb['no_munin_url_defined_txt'] = 'No Munin URL defined.';
 $wb['no_permissions_to_view_munin_txt'] = 'You are not allowed to access Munin.';
+$wb['Show Nagios/Check_MK'] = 'Show Nagios';
+$wb['no_nagios_url_defined_txt'] = 'No Nagios URL defined.';
+$wb['no_permissions_to_view_nagios_txt'] = 'You are not allowed to access Nagios/Check_MK.';
+$wb['go_to_nagios_txt'] = 'Open a new window containing this view';
 ?>
diff --git a/interface/web/monitor/lib/module.conf.php b/interface/web/monitor/lib/module.conf.php
@@ -121,6 +121,11 @@
 	'target'  => 'content',
 	'link' => 'monitor/show_data.php?type=services',
 	'html_id' => 'services');
+	
+$items[] = array( 'title'  => "Show Nagios/Check_MK",
+	'target'  => 'content',
+	'link' => 'monitor/show_nagios.php',
+	'html_id' => 'nagios');
 
 $items[] = array( 'title'  => "Show Monit",
 	'target'  => 'content',
@@ -135,7 +140,7 @@
 $items[] = array( 'title'  => "Show Munin",
 	'target'  => 'content',
 	'link' => 'monitor/show_munin.php',
-	'html_id' => 'monit');
+	'html_id' => 'munin');
 
 $module["nav"][] = array( 'title' => 'Server State',
 	'open'  => 1,
diff --git a/interface/web/monitor/show_nagios.php b/interface/web/monitor/show_nagios.php
@@ -0,0 +1,106 @@
+<?php
+
+/*
+Copyright (c) 2007-2008, Till Brehm, projektfarm Gmbh and Oliver Vogel www.muv.com
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of ISPConfig nor the names of its contributors
+      may be used to endorse or promote products derived from this software without
+      specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+require_once '../../lib/config.inc.php';
+require_once '../../lib/app.inc.php';
+
+//* Check permissions for module
+$app->auth->check_module_permissions('monitor');
+
+$app->uses('tools_monitor');
+
+// Loading the template
+$app->uses('tpl');
+$app->tpl->newTemplate("form.tpl.htm");
+$app->tpl->setInclude('content_tpl', 'templates/show_nagios.htm');
+
+$monTransSrv = $app->lng("monitor_settings_server_txt");
+$title = 'Nagios ('. $monTransSrv .' : ' . $_SESSION['monitor']['server_name'] . ')';
+
+$app->tpl->setVar("list_head_txt", $title);
+
+if($_SESSION["s"]["user"]["typ"] == 'admin'){
+
+	$app->uses('getconf');
+	$server_config = $app->getconf->get_server_config($_SESSION['monitor']['server_id'], 'server');
+
+	$nagios_url = trim($server_config['nagios_url']);
+	if($nagios_url != ''){
+		$nagios_url = str_replace('[SERVERNAME]', $_SESSION['monitor']['server_name'], $nagios_url);
+		$nagios_user = trim($server_config['nagios_user']);
+		$nagios_password = trim($server_config['nagios_password']);
+		$nagios_url_parts = parse_url($nagios_url);
+		if (strpos($nagios_url, '/check_mk') !== false) {
+			//** Check_MK
+			if($nagios_user != ''){
+				$nagios_url = $nagios_url_parts['scheme'].'://'.$auth_string.$nagios_url_parts['host'].(isset($nagios_url_parts['port']) ? ':' . $nagios_url_parts['port'] : '');
+				$pathparts = explode('/check_mk', $nagios_url_parts['path'], 2);
+				$nagios_url .= $pathparts[0].'/check_mk/login.py?_login=1&_password='.rawurlencode($nagios_password).'&_username='.rawurlencode($nagios_user);
+				if (strlen(@$pathparts[1]) > 0) {
+					if (substr($pathparts[1], 0, 1) == '/') $pathparts[1] = substr($pathparts[1], 1, strlen($pathparts[1])-1);
+					$nagios_url .= '&_origtarget='.rawurlencode($pathparts[1]);
+				}
+				if (isset($nagios_url_parts['query'])) $nagios_url .= '?'.rawurlencode($nagios_url_parts['query']);
+				
+			} else {
+				$nagios_url = $nagios_url_parts['scheme'].'://'.$auth_string.$nagios_url_parts['host'].(isset($nagios_url_parts['port']) ? ':' . $nagios_url_parts['port'] : '');
+				$pathparts = explode('/check_mk', $nagios_url_parts['path'], 2);
+				$nagios_url .= $pathparts[0].'/check_mk/login.py';
+				if (strlen(@$pathparts[1]) > 0) {
+					if (substr($pathparts[1], 0, 1) == '/') $pathparts[1] = substr($pathparts[1], 1, strlen($pathparts[1])-1);
+					$nagios_url .= '?_origtarget='.rawurlencode($pathparts[1]);
+				}
+				if (isset($nagios_url_parts['query'])) $nagios_url .= '?'.rawurlencode($nagios_url_parts['query']);
+			}
+
+		} else {
+			//** Nagios
+			$auth_string = '';
+			if($nagios_user != ''){
+				$auth_string = rawurlencode($nagios_user);
+			}
+			if($nagios_user != '' && $nagios_password != ''){
+				$auth_string .= ':'.rawurlencode($nagios_password);
+			}
+			if($auth_string != '') $auth_string .= '@';
+			$nagios_url = $nagios_url_parts['scheme'].'://'.$auth_string.$nagios_url_parts['host'].(isset($nagios_url_parts['port']) ? ':' . $nagios_url_parts['port'] : '').(isset($nagios_url_parts['path']) ? $nagios_url_parts['path'] : '').(isset($nagios_url_parts['query']) ? '?' . $nagios_url_parts['query'] : '').(isset($nagios_url_parts['fragment']) ? '#' . $nagios_url_parts['fragment'] : '');
+		}
+
+		$app->tpl->setVar("nagios_url", $nagios_url);
+	} else {
+		$app->tpl->setVar("no_nagios_url_defined_txt", $app->lng("no_nagios_url_defined_txt"));
+	}
+} else {
+	$app->tpl->setVar("no_permissions_to_view_nagios_txt", $app->lng("no_permissions_to_view_nagios_txt"));
+}
+
+$app->tpl_defaults();
+$app->tpl->pparse();
+?>
diff --git a/interface/web/monitor/templates/show_nagios.htm b/interface/web/monitor/templates/show_nagios.htm
@@ -0,0 +1,12 @@
+<div class='page-header'>
+	<h1><tmpl_var name="list_head_txt"></h1>
+</div>
+<p><tmpl_var name="list_desc_txt"></p>
+
+<div class="panel panel_system">
+<tmpl_if name='nagios_url'>
+    <iframe src="{tmpl_var name='nagios_url'}" width="100%" height="1000" frameborder="0" style="overflow:visible;"></iframe>
+<tmpl_else>
+	<div id="errorMsg"><h3>ERROR</h3><ol><li>{tmpl_var name="no_nagios_url_defined_txt"} {tmpl_var name="no_permissions_to_view_nagios_txt"}<br></li></ol></div>
+</tmpl_if>
+</div>
diff --git a/server/lib/classes/cron.d/300-quota_notify.inc.php b/server/lib/classes/cron.d/300-quota_notify.inc.php
@@ -442,7 +442,7 @@ public function onRunJob() {
 								else $used_ratio = 0;
 
 								//* send notifications only if 90% or more of the quota are used
-								if($used_ratio > 0.9 && $user_ratio != 0) {
+								if($used_ratio > 0.9 && $used_ratio != 0) {
 
 									//* could a notification be sent?
 									$send_notification = false;
