From bc7cadcc73b6009d85f994770ca49ff78e5f0a2f Mon Sep 17 00:00:00 2001
From: Andrew Bauer <zonexpertconsulting@outlook.com>
Date: Fri, 18 Sep 2020 08:35:21 -0500
Subject: [PATCH] convert optionhelp function to php file

---
 web/ajax/modal.php                       | 19 ++-----
 web/ajax/modals/filterdebug.php          | 68 +++++++++++++-----------
 web/ajax/modals/optionhelp.php           | 43 +++++++++++++++
 web/skins/classic/includes/functions.php | 36 -------------
 4 files changed, 86 insertions(+), 80 deletions(-)
 create mode 100644 web/ajax/modals/optionhelp.php

diff --git a/web/ajax/modal.php b/web/ajax/modal.php
index 885aedd56..7436548b6 100644
--- a/web/ajax/modal.php
+++ b/web/ajax/modal.php
@@ -1,24 +1,15 @@
 <?php
-// HOW TO IMPLEMENT A NEW MODAL
-// 1) Create a function in skins/classic/includes/functions that returns the desired modal HTML
-// 2) Add a new entry to the switch case below that calls the new HTML function
-// 3) Create a $j.getJSON Ajax call in js with the right parameters to retrieve the modal
-// 4) Open the modal with $j('#myModal').modal('show')
-// 
-// Should only report json
-error_reporting(0);
 
-if ( empty($_REQUEST['modal']) ) ajaxError('Modal Name Not Provided');
+if ( empty($_REQUEST['modal']) ) {
+  ajaxError('Modal Name Not Provided');
+  return;
+}
 
-global $OLANG;
+//global $OLANG;
 $modal = validJsStr($_REQUEST['modal']);
 $data = array();
 
 switch ( $modal ) {
-  case 'optionhelp' :
-    if ( empty($_REQUEST['ohndx']) ) ajaxError('Option Help Index Not Provided');
-    $data['html'] = getOptionHelpHTML($_REQUEST['ohndx'], $OLANG);
-    break;
   case 'enoperm' :
     $data['html'] = getENoPermHTML();
     break;
diff --git a/web/ajax/modals/filterdebug.php b/web/ajax/modals/filterdebug.php
index 725539a99..424354dd2 100644
--- a/web/ajax/modals/filterdebug.php
+++ b/web/ajax/modals/filterdebug.php
@@ -1,35 +1,43 @@
-<div class="modal fade" id="filterdebugModal" data-backdrop="static" data-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
-  <div class="modal-dialog">
-    <div class="modal-content">
-     <div class="modal-header">
-     <h5 class="modal-title"><?php echo translate('FilterDebug') ?></h5>
-       <button type="button" class="close" data-dismiss="modal" aria-label="Close">
-         <span aria-hidden="true">&times;</span>
-       </button>
-     </div>
-     <div class="modal-body">
 <?php
-  //require_once('includes/Filter.php');
-  $fid = validInt($_REQUEST['fid']);
-  if ( !$fid ) {
-    echo '<div class="error">No filter id specified.</div>';
-  } else {
-    $filter = new ZM\Filter($_REQUEST['fid']);
-    if ( ! $filter->Id() ) {
-      echo '<div class="error">Filter not found for id '.$_REQUEST['fid'].'</div>';
-    }
-  }
+
+// Returns the modal html representing the selected Option Help item
+if ( empty($_REQUEST['ohndx']) ) {
+  ajaxError('Option Help Index Not Provided');
+  return;
+}
+
+global $OLANG;
+$result = '';
+$optionHelpIndex = $_REQUEST['ohndx'];
+$ZMoptionHelpIndex = 'ZM_'.$optionHelpIndex;
+ 
+if ( !empty($OLANG[$optionHelpIndex]) ) {
+  $optionHelpText = $OLANG[$optionHelpIndex]['Help'];
+} else {
+  $optionHelpText = dbFetchOne('SELECT Help FROM Config WHERE Name=?', 'Help', array($optionHelpIndex));
+}
+$optionHelpText = validHtmlStr($optionHelpText);
+$optionHelpText = preg_replace('/~~/', '<br/>', $optionHelpText );
+$optionHelpText = preg_replace('/\[(.+)\]\((.+)\)/', '<a href="$2" target="_blank">$1</a>', $optionHelpText);
+
 ?>
-       <form name="contentForm" id="filterdebugForm" method="post" action="?">
-<?php 
-            // We have to manually insert the csrf key into the form when using a modal generated via ajax call
-            echo getCSRFinputHTML();
-?>
-          <p><label>SQL</label><?php echo $filter->sql() ?></p>
-         <div class="modal-footer">
-          <button type="button" class="btn btn-secondary" data-dismiss="modal"><?php echo translate('Cancel')?> </button>
-        </div>
-      </form>
+<div id="optionhelp" class="modal" tabindex="-1" role="dialog">
+  <div class="modal-dialog" role="document">
+    <div class="modal-content">
+      <div class="modal-header">
+        <h5 class="modal-title"><?php echo translate('OptionHelp') ?></h5>
+        <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+      <div class="modal-body">
+        <h3><?php echo validHtmlStr($optionHelpIndex) ?></h3>
+        <p class="textblock"><?php echo $optionHelpText ?></p>
+      </div>
+      <div class="modal-footer">
+        <button type="button" id="ohCloseBtn" class="btn btn-secondary" data-dismiss="modal">Close</button>
+      </div>
     </div>
   </div>
 </div>
+
diff --git a/web/ajax/modals/optionhelp.php b/web/ajax/modals/optionhelp.php
new file mode 100644
index 000000000..424354dd2
--- /dev/null
+++ b/web/ajax/modals/optionhelp.php
@@ -0,0 +1,43 @@
+<?php
+
+// Returns the modal html representing the selected Option Help item
+if ( empty($_REQUEST['ohndx']) ) {
+  ajaxError('Option Help Index Not Provided');
+  return;
+}
+
+global $OLANG;
+$result = '';
+$optionHelpIndex = $_REQUEST['ohndx'];
+$ZMoptionHelpIndex = 'ZM_'.$optionHelpIndex;
+ 
+if ( !empty($OLANG[$optionHelpIndex]) ) {
+  $optionHelpText = $OLANG[$optionHelpIndex]['Help'];
+} else {
+  $optionHelpText = dbFetchOne('SELECT Help FROM Config WHERE Name=?', 'Help', array($optionHelpIndex));
+}
+$optionHelpText = validHtmlStr($optionHelpText);
+$optionHelpText = preg_replace('/~~/', '<br/>', $optionHelpText );
+$optionHelpText = preg_replace('/\[(.+)\]\((.+)\)/', '<a href="$2" target="_blank">$1</a>', $optionHelpText);
+
+?>
+<div id="optionhelp" class="modal" tabindex="-1" role="dialog">
+  <div class="modal-dialog" role="document">
+    <div class="modal-content">
+      <div class="modal-header">
+        <h5 class="modal-title"><?php echo translate('OptionHelp') ?></h5>
+        <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+      <div class="modal-body">
+        <h3><?php echo validHtmlStr($optionHelpIndex) ?></h3>
+        <p class="textblock"><?php echo $optionHelpText ?></p>
+      </div>
+      <div class="modal-footer">
+        <button type="button" id="ohCloseBtn" class="btn btn-secondary" data-dismiss="modal">Close</button>
+      </div>
+    </div>
+  </div>
+</div>
+
diff --git a/web/skins/classic/includes/functions.php b/web/skins/classic/includes/functions.php
index aefa5f52c..29d4b9cbb 100644
--- a/web/skins/classic/includes/functions.php
+++ b/web/skins/classic/includes/functions.php
@@ -754,42 +754,6 @@ function runtimeStatus($running=null) {
   return $running ? ($state ? $state : translate('Running')) : translate('Stopped');
 }
 
-// Returns the modal html representing the selected Option Help item
-function getOptionHelpHTML($optionHelpIndex, $OLANG) {
-  $result = '';
-  $ZMoptionHelpIndex = 'ZM_'.$optionHelpIndex;
-  
-  if ( !empty($OLANG[$optionHelpIndex]) ) {
-    $optionHelpText = $OLANG[$optionHelpIndex]['Help'];
-  } else {
-    $optionHelpText = dbFetchOne('SELECT Help FROM Config WHERE Name=?', 'Help', array($optionHelpIndex));
-  }
-  $optionHelpText = validHtmlStr($optionHelpText);
-  $optionHelpText = preg_replace('/~~/', '<br/>', $optionHelpText );
-  $optionHelpText = preg_replace('/\[(.+)\]\((.+)\)/', '<a href="$2" target="_blank">$1</a>', $optionHelpText);
-
-  $result .= '<div id="optionhelp" class="modal" tabindex="-1" role="dialog">'.PHP_EOL;
-    $result .= '<div class="modal-dialog" role="document">'.PHP_EOL;
-      $result .= '<div class="modal-content">'.PHP_EOL;
-        $result .= '<div class="modal-header">'.PHP_EOL;
-          $result .= '<h5 class="modal-title">' .translate('OptionHelp'). '</h5>'.PHP_EOL;
-          $result .= '<button type="button" class="close" data-dismiss="modal" aria-label="Close">'.PHP_EOL;
-            $result .= '<span aria-hidden="true">&times;</span>'.PHP_EOL;
-          $result .= '</button>'.PHP_EOL;
-        $result .= '</div>'.PHP_EOL;
-        $result .= '<div class="modal-body">'.PHP_EOL;
-          $result .= '<h3>' .validHtmlStr($optionHelpIndex). '</h3>'.PHP_EOL;
-          $result .= '<p class="textblock">' .$optionHelpText. '</p>'.PHP_EOL;
-        $result .= '</div>'.PHP_EOL;
-        $result .= '<div class="modal-footer">'.PHP_EOL;
-          $result .= '<button type="button" id="ohCloseBtn" class="btn btn-secondary" data-dismiss="modal">Close</button>'.PHP_EOL;
-        $result .= '</div>'.PHP_EOL;
-      $result .= '</div>'.PHP_EOL;
-    $result .= '</div>'.PHP_EOL;
-  $result .= '</div>'.PHP_EOL;
-  return $result;
-}
-
 // Return an Error No Permissions Modal
 function getENoPermHTML() {
   $result = '';