Minor - Update documentation and code style

Author: ywarnier

CHANGELOG.md

@@ -1,3 +1,7 @@
+Chamilo Munin 2.0 (20160714)
+============================
+* Update for Chamilo 1.10 and PHP 7
+
 Chamilo Munin 0.6 (20141009)
 ============================
 * Fix issue with script name in new feature of get_connected_users_x

README.md

@@ -1,18 +1,26 @@
-# Munin scripts for Chamilo 1.9.x #
+# Munin scripts for Chamilo 1.11.x #
 
 This repository contains a few interesting scripts for Chamilo administrators
-who use [Munin](https://github.com/munin-monitoring/munin "Munin on Github") want to be informed about what's going on in their Chamilo portals.
-Feel free to download, extend, and contribute back by forking this repository and sending pull requests!
+who use [Munin](https://github.com/munin-monitoring/munin "Munin on Github") 
+and want to be informed about what's going on in their Chamilo portals.
+Feel free to download, extend, and contribute back by forking this repository
+and sending pull requests!
 
-Ideally, once working, the Munin chart will look something like this (here with more than 20 portals on the same server).
+Ideally, once working, the Munin chart will look something like this (here 
+with more than 20 portals on the same server).
 
 ![Munin chart for active users by portal](chamilo_active_users-day.png "Munin chart for active users by portal")
 
 # Licensing #
 
 These scripts are available under the GNU/AGPL license. Check the LICENSE file
 for details.
-Between other things, it is expected for you to contribute any modification or derived work from these scripts you made for yourself, to anyone able to access the resulting charts and kindly asking you to provide the code for the modifications. This is to ensure a snowball effect whereby you save some time downloading these scripts, and in return make others save time by sharing your own work.
+Between other things, it is expected for you to contribute any modification 
+or derived work from these scripts you made for yourself, to anyone able to 
+access the resulting charts and kindly asking you to provide the code for 
+the modifications. This is to ensure a snowball effect whereby you save some 
+time downloading these scripts, and in return make others save time by sharing
+your own work.
 
 # Installation #
 
@@ -23,10 +31,14 @@ To install, please follow the few steps below...
 To run the following scripts, you will need:
 * a working munin-node installation
 * the PHP CLI (Command Line Interface) interpreter installed (check that just by launching "php -m" from the command line - if it gives you a list of modules, you're good to go)
+* support for PHP's PDO extension
 * Chamilo 1.9.x, 1.10.x or 1.11.x folders (should work with version 2.0 as well, but not guaranteed) located in /var/www/[something]/www/. If this isn't the structure of your directories, you'll have to change the first variables in all _munin.php files) 
 * to be logged in as administrator (root) or issue all commands with the "sudo" prefix. This is because most of the commands below are actually administration commands, so most of them require administrator privileges
 
-If your configuration doesn't put the Chamilo folders in /var/www/[something]/www/, at this stage, you will have to hack the "_munin.php" scripts below to make sure the $bd and $sub variables (around line 50) are configured correctly.
+If your configuration does not put the Chamilo folders in
+ /var/www/[something]/www/, at this stage, you will have to hack the 
+ "_munin.php" scripts below to make sure the $bd and $sub variables 
+ (around line 50) are configured correctly.
 
 ## Store this folder somewhere ##
 
@@ -138,14 +150,16 @@ For example:
 
 ## Checking your setup ##
 
-If you have configured everything correctly, you should now be able to issue a munin-run command and get results:
+If you have configured everything correctly, you should now be able to issue 
+a munin-run command and get results:
 
     $ munin-run chamilo-connected-users
     portal/portal1.chamilo.org.value 15
     portal/portal2.chamilo.org.value 214
     portal/portal3.chamilo.org.value 28
 
-If you got this, then it is likely all your scripts will start drawing charts in the next 5-10 minutes. Well done!
+If you got this, then it is likely all your scripts will start drawing charts 
+in the next 5-10 minutes. Well done!
 
 ## Contact info ##
 

get_connected_users_5_munin.php

@@ -47,98 +47,102 @@
 =cut
 CUT;
 
-ini_set('error_reporting','E_ALL & ~E_WARNING & ~E_NOTICE');
+ini_set('error_reporting', 'E_ALL & ~E_WARNING & ~E_NOTICE');
 $bd = '/var/www';
 $sub = '/www';
 // Get the number of minutes from the name of this script
 // (this requires maintaining the same name structure)
 $scriptNameParts = preg_split('/_/', __FILE__);
-$last_connect_minutes = $scriptNameParts[count($scriptNameParts)-2];
+$last_connect_minutes = $scriptNameParts[count($scriptNameParts) - 2];
 if (intval($last_connect_minutes) != $last_connect_minutes) {
     $last_connect_minutes = 5;
 }
-$connections = get_connections($bd, $sub, $last_connect_minutes); 
+$connections = get_connections($bd, $sub, $last_connect_minutes);
 $output = '';
-if ( !empty($argv[1]) && $argv[1] == 'config') {
-  // Global Munin attr., see http://munin-monitoring.org/wiki/protocol-config
-  $output .= "graph_title Chamilo active users v2\n";
-  $output .= "graph_args --lower-limit 0\n";
-  $output .= "graph_category chamilo\n";
-  $output .= "graph_info This graph shows the number of connected users on Chamilo portals over time.\n";
-  $output .= "graph_vlabel Users in last $last_connect_minutes min\n";
-  $output .= "graph_scale off\n";
-  foreach ($connections as $portal => $num) {
-    $output .= "portal$portal.label Host $portal\n";
+if (!empty($argv[1]) && $argv[1] == 'config') {
+    // Global Munin attr., see http://munin-monitoring.org/wiki/protocol-config
+    $output .= "graph_title Chamilo active users v2\n";
+    $output .= "graph_args --lower-limit 0\n";
+    $output .= "graph_category chamilo\n";
+    $output .= "graph_info This graph shows the number of connected users on Chamilo portals over time.\n";
+    $output .= "graph_vlabel Users in last $last_connect_minutes min\n";
+    $output .= "graph_scale off\n";
+    foreach ($connections as $portal => $num) {
+        $output .= "portal$portal.label Host $portal\n";
 //    echo "portal$portal.type DERIVE\n";
-    //echo "portal$portal.max 500\n";
+        //echo "portal$portal.max 500\n";
 //    echo "portal$portal.min 0\n";
 //    echo "portal$portal.max 500\n";
-    $output .= "portal$portal.warning 8000\n";
-    $output .= "portal$portal.critical 12500\n";
-    $output .= "portal$portal.draw LINE2\n";
-  }
-  file_put_contents('/tmp/get_connected_users_config_'.$last_connect_minutes, $output);
-  exit;
+        $output .= "portal$portal.warning 8000\n";
+        $output .= "portal$portal.critical 12500\n";
+        $output .= "portal$portal.draw LINE2\n";
+    }
+    file_put_contents('/tmp/get_connected_users_config_'.$last_connect_minutes, $output);
+    exit;
 }
-if (is_array($connections) && count($connections)>0) {
-  foreach ($connections as $portal => $num) {
-    $output .= "portal$portal.value $num\n";
-  }
+if (is_array($connections) && count($connections) > 0) {
+    foreach ($connections as $portal => $num) {
+        $output .= "portal$portal.value $num\n";
+    }
 }
 file_put_contents('/tmp/get_connected_users_'.$last_connect_minutes, $output);
 
-function get_connections($bd, $sub, $last_connect_minutes) {
-  $match_count=0;
-  $connections = array();
-  $list = scandir($bd);
-  foreach ($list as $dir) {
-    //skip system directories
-    if (substr($dir,0,1)=='.' or $dir == 'lost+found') continue;
-    //check the existence of configuration.php
-    $config_file = '';
-    if (is_file($bd.'/'.$dir.$sub.'/app/config/configuration.php')) {
-        // Chamilo 1.10
-        $config_file = $bd.'/'.$dir.$sub.'/app/config/configuration.php';
-    } elseif (is_file($bd.'/'.$dir.$sub.'/main/inc/conf/configuration.php')) {
-        // Chamilo 1.9
-        $config_file = $bd.'/'.$dir.$sub.'/main/inc/conf/configuration.php';
-    }
-    if (!empty($config_file)) {
-  	$inc = include_once($config_file);
-	$dbh = mysqli_connect($_configuration['db_host'],$_configuration['db_user'],$_configuration['db_password']);
-	if ($inc!==false && $dbh!==false) {
+function get_connections($bd, $sub, $last_connect_minutes)
+{
+    $match_count = 0;
+    $connections = array();
+    $list = scandir($bd);
+    foreach ($list as $dir) {
+        //skip system directories
+        if (substr($dir, 0, 1) == '.' or $dir == 'lost+found') {
+            continue;
+        }
+        //check the existence of configuration.php
+        $config_file = '';
+        if (is_file($bd.'/'.$dir.$sub.'/app/config/configuration.php')) {
+            // Chamilo 1.10
+            $config_file = $bd.'/'.$dir.$sub.'/app/config/configuration.php';
+        } elseif (is_file($bd.'/'.$dir.$sub.'/main/inc/conf/configuration.php')) {
+            // Chamilo 1.9
+            $config_file = $bd.'/'.$dir.$sub.'/main/inc/conf/configuration.php';
+        }
+        if (!empty($config_file)) {
+            $inc = include_once($config_file);
+            $dbh = mysqli_connect($_configuration['db_host'], $_configuration['db_user'],
+                $_configuration['db_password']);
+            if ($inc !== false && $dbh !== false) {
                 $db = $_configuration['main_database'];
                 $sql = "SELECT CONCAT(UTC_DATE(),' ',UTC_TIME())";
-                $res = mysqli_query($dbh,$sql);
+                $res = mysqli_query($dbh, $sql);
                 $row = mysqli_fetch_row($res);
                 $current_date = $row[0];
-		$track_online_table = $db.'.track_e_online';
-		$query = "SELECT count(login_user_id) ".
-                    " FROM ".$track_online_table .
+                $track_online_table = $db.'.track_e_online';
+                $query = "SELECT count(login_user_id) ".
+                    " FROM ".$track_online_table.
                     " WHERE DATE_ADD(login_date, ".
-              "INTERVAL $last_connect_minutes MINUTE) >= '".$current_date."'  ";
-		//echo $query."\n";
-		$res = mysqli_query($dbh, $query);
-		if ( $res === false ) {
-			$num = 0;
-			//echo "          There was a query error for the following portal\n";
-		} else {
-			$row = mysqli_fetch_row($res);
-			$num = $row[0];
-		}
-		//echo sprintf("[%7d]",$num)." users connected to ".$_configuration['root_web']." last $last_connect_minutes'\n";
+                    "INTERVAL $last_connect_minutes MINUTE) >= '".$current_date."'  ";
+                //echo $query."\n";
+                $res = mysqli_query($dbh, $query);
+                if ($res === false) {
+                    $num = 0;
+                    //echo "          There was a query error for the following portal\n";
+                } else {
+                    $row = mysqli_fetch_row($res);
+                    $num = $row[0];
+                }
+                //echo sprintf("[%7d]",$num)." users connected to ".$_configuration['root_web']." last $last_connect_minutes'\n";
                 $cut_point = 7;
-                if (substr($_configuration['root_web'],0,5) == 'https') {
+                if (substr($_configuration['root_web'], 0, 5) == 'https') {
                     $cut_point = 8;
                 }
-                $connections[str_replace('.','_',substr($_configuration['root_web'],$cut_point,-1))] = $num;
-		$match_count += $num;
-		mysqli_close($dbh);
-	} else {
-		//echo "$bd/$dir$sub:could not open configuration.php or database:\n";
-	}
+                $connections[str_replace('.', '_', substr($_configuration['root_web'], $cut_point, -1))] = $num;
+                $match_count += $num;
+                mysqli_close($dbh);
+            } else {
+                //echo "$bd/$dir$sub:could not open configuration.php or database:\n";
+            }
+        }
     }
-  }
-  return $connections;
+    return $connections;
 }
 

get_connected_users_5_munin_proxy.php

@@ -50,20 +50,20 @@
 // Get the number of minutes from the name of this script
 // (this requires maintaining the same name structure)
 $scriptNameParts = preg_split('/_/', __FILE__);
-$last_connect_minutes = $scriptNameParts[count($scriptNameParts)-3];
+$last_connect_minutes = $scriptNameParts[count($scriptNameParts) - 3];
 if (intval($last_connect_minutes) != $last_connect_minutes) {
     $last_connect_minutes = 5;
 }
-if ( !empty($argv[1]) && $argv[1] == 'config') {
-  // Global Munin attr., see http://munin-monitoring.org/wiki/protocol-config
-  if (!is_file('/tmp/get_connected_users_config_'.$last_connect_minutes)) {
-    @exec(__DIR__.'/get_connected_users_'.$last_connect_minutes.'_munin.php config');
-  }
-  readfile('/tmp/get_connected_users_config_'.$last_connect_minutes);
-  exit;
+if (!empty($argv[1]) && $argv[1] == 'config') {
+    // Global Munin attr., see http://munin-monitoring.org/wiki/protocol-config
+    if (!is_file('/tmp/get_connected_users_config_'.$last_connect_minutes)) {
+        @exec(__DIR__.'/get_connected_users_'.$last_connect_minutes.'_munin.php config');
+    }
+    readfile('/tmp/get_connected_users_config_'.$last_connect_minutes);
+    exit;
 }
 if (!is_file('/tmp/get_connected_users_'.$last_connect_minutes)) {
-  @exec(__DIR__.'/get_connected_users_'.$last_connect_minutes.'_munin.php');
+    @exec(__DIR__.'/get_connected_users_'.$last_connect_minutes.'_munin.php');
 }
 readfile('/tmp/get_connected_users_'.$last_connect_minutes);