From 1f6c569d44e2f0eaf58a172dc8190682e0093a06 Mon Sep 17 00:00:00 2001
From: dg9vh <kim@huebel-online.de>
Date: Tue, 10 May 2016 21:50:33 +0200
Subject: [PATCH] improved commenting and code-cleanup

---
 config/config.php        |  9 +++++++++
 include/functions.php    | 11 ++++++++++-
 include/lh.php           |  4 ----
 include/repeaterinfo.php |  5 +----
 index.php                |  2 ++
 5 files changed, 22 insertions(+), 9 deletions(-)

diff --git a/config/config.php b/config/config.php
index aaa39a3..b31d919 100644
--- a/config/config.php
+++ b/config/config.php
@@ -71,9 +71,18 @@ switch (DISTRIBUTION) {
 define("CONFIGFILENAME", "ircddbgateway");
 define("GATEWAYCONFIGPATH", CONFIGPATH . "/" . CONFIGFILENAME);
 
+// set time to refresh page
 define("REFRESHAFTER", "60");
+
+// enables CPU-temperature alert
 define("TEMPERATUREALERT", true);
+
+// defines temperature of warning
 define("TEMPERATUREHIGHLEVEL", 60);
+
+// enables progress-bars
 define("SHOWPROGRESSBARS", true);
+
+// defines number of lines in last heard list
 define("LHLINES", 20);
 ?>
\ No newline at end of file
diff --git a/include/functions.php b/include/functions.php
index 7e75d20..9f7baae 100644
--- a/include/functions.php
+++ b/include/functions.php
@@ -1,6 +1,7 @@
 <?php
 
 function getMMDVMHostVersion() {
+	// returns creation-time of MMDVMHost as version-number
 	$filename = MMDVMHOSTPATH . "MMDVMHost";
 	if (file_exists($filename)) {
 	    return date("Y-m-d", filectime($filename));
@@ -8,6 +9,7 @@ function getMMDVMHostVersion() {
 }	
 	
 function getMMDVMConfig() {
+	// loads MMDVM.ini into array for further use
 	$mmdvmconfigs = array();
 	if ($configs = fopen(MMDVMINIPATH."MMDVM.ini", 'r')) {
 		while ($config = fgets($configs)) {
@@ -19,10 +21,12 @@ function getMMDVMConfig() {
 }
 
 function getCallsign($mmdvmconfigs) {
+	// returns Callsign from MMDVM-config
 	return getConfigItem("General", "Callsign", $mmdvmconfigs);
 }
 
 function getConfigItem($section, $key, $configs) {
+	// retrieves the corresponding config-entry within a [section]
 	$sectionpos = array_search("[" . $section . "]", $configs) + 1;
 	$len = count($configs);
 	while(startsWith($configs[$sectionpos],$key."=") === false && $sectionpos <= ($len) ) {
@@ -36,11 +40,12 @@ function getConfigItem($section, $key, $configs) {
 }
 
 function getEnabled ($mode, $mmdvmconfigs) {
+	// returns enabled/disabled-State of mode
 	return getConfigItem($mode, "Enable", $mmdvmconfigs);
-	
 }
 
 function showMode($mode, $mmdvmconfigs) {
+	// shows if mode is enabled or not.
 ?>
       <td><span class="label <?php 
 	if (getEnabled($mode, $mmdvmconfigs) == 1) {
@@ -191,6 +196,7 @@ function getHeardList($logLines) {
 }
 
 function getLastHeard($logLines) {
+	//returns last heard list from log
 	$lastHeard = array();
 	$heardCalls = array();
 	$heardList = getHeardList($logLines);
@@ -206,6 +212,7 @@ function getLastHeard($logLines) {
 }
 
 function getActualMode($logLines) {
+	// returns mode of repeater actual working in
 	array_multisort($logLines,SORT_DESC);
 	foreach ($logLines as $logLine) {
 		if (strpos($logLine, "Mode set to")) {
@@ -216,6 +223,7 @@ function getActualMode($logLines) {
 }
 
 function getDSTARLinks() {
+	// returns link-states of all D-Star-modules
 	$out = "<table>";
 	if ($linkLog = fopen(LINKLOGPATH,'r')) {
 		while ($linkLine = fgets($linkLog)) {
@@ -266,6 +274,7 @@ function getDSTARLinks() {
 }
 
 function getActualLink($logLines, $mode) {
+	// returns actual link state of specific mode
 //M: 2016-05-02 07:04:10.504 D-Star link status set to "Verlinkt zu DCS002 S"
 //M: 2016-04-03 16:16:18.638 DMR Slot 2, received network voice header from 4000 to 2625094
 //M: 2016-04-03 19:30:03.099 DMR Slot 2, received network voice header from 4020 to 2625094
diff --git a/include/lh.php b/include/lh.php
index 9cec26b..7582014 100644
--- a/include/lh.php
+++ b/include/lh.php
@@ -4,10 +4,6 @@ $lastHeard = getLastHeard($logLines);
   <div class="panel panel-default">
   <!-- Standard-Panel-Inhalt -->
   <div class="panel-heading">Last Heard List of today's <?php echo LHLINES; ?> callsigns.</div>
-  <!--<div class="panel-body">
-    <p>In the following table you will find a maximum of the last <?php echo LHLINES; ?> callsigns heard on this repeater for the current day</p>
-  </div>-->
-
   <!-- Tabelle -->
   <table class="table">
     <tr>
diff --git a/include/repeaterinfo.php b/include/repeaterinfo.php
index 2cd3ab7..87c7584 100644
--- a/include/repeaterinfo.php
+++ b/include/repeaterinfo.php
@@ -1,10 +1,7 @@
   <div class="panel panel-default">
   <!-- Standard-Panel-Inhalt -->
   <div class="panel-heading">Repeater Info</div>
-  <!--<div class="panel-body">
-    <p>Some info about link states</p>
-  </div>-->
-
+  
   <!-- Tabelle -->
   <table class="table">
     <tr>
diff --git a/index.php b/index.php
index d58e39d..c2fc3c1 100644
--- a/index.php
+++ b/index.php
@@ -4,6 +4,7 @@ $time = explode(' ', $time);
 $time = $time[1] + $time[0];
 $start = $time;
 
+// do not touch this includes!!! Never ever!!!
 include "config/config.php";
 include "include/tools.php";
 include "include/functions.php";
@@ -29,6 +30,7 @@ include "include/functions.php";
   <h4>MMDVMHost v<?php echo getMMDVMHostVersion() ?> by G4KLX</h4>
 </div>
 <?php
+// Here you can feel free to disable info-sections by commenting out with // before include
 include "include/sysinfo.php";
 include "include/repeaterinfo.php";
 include "include/modes.php";