loggingReport.prg

<?php
/**
 * @author Samuel Bennett <samuel@homecu.net>
 * @package loggingReport
 * Shows the most recent logging records from trusted vendors.  Using in-house for debugging purposes.
 */

  $monLibrary = dirname(__FILE__) . "/../library";
  $sharedLibrary = dirname(__FILE__) . "/../../shared/library";
  $bankingLibrary = dirname(__FILE__) . "/../../banking/library";
  require_once("$monLibrary/cu_top.i");
  require_once("$monLibrary/monitorView.i");
  require_once("$sharedLibrary/reporting.i");
  require_once("$sharedLibrary/commonJsFunctions.i");
  require_once("$sharedLibrary/commonPhpFunctions.i");

// if (!CheckPerm($link, $Hu, basename($_SERVER['SCRIPT_NAME']), $_SERVER['REMOTE_ADDR']))
// {
//     // ** Permissions failed
//     // ** redirect to new page
//     header("Location: /hcuadm/hcu_noperm.prg");
//     exit;
// }

$parameters = array("a" => array("operation" => "", "cu" => ""));
$string = array("filter" => FILTER_SANITIZE_STRING);
HCU_ImportVars($parameters, "a", array("operation" => $string, "cu" => $string));

$operation = HCU_array_key_exists("operation", $parameters["a"]) ? trim($parameters["a"]["operation"]) : "";
$cu = HCU_array_key_exists("cu", $parameters["a"]) ? strtoupper(trim($parameters["a"]["cu"])) : "";

$report = "logging";
$pageSize = 20;

/**
 * This might seem stupid but it is defined to use reports.i which is designed to have a whole list of possible reports.
 * @see the info block at the top of {@link hcuinc/reports.i}
 */
$sql = "select null, entry, cu, user_id, service, sub_service, session_id, txn_id, user_ip, request, response from cu_vendorlog";
$reportList = array("logging" => array("title" => "Trusted Vendor Logging Report", "sql" => $sql, "defaultSort" => array("field" => "entry", "dir" => "desc"),
                    "cols" => array("Details" => "string", "Entry" => "date", "CU" => "string","User" => "string", "Service" => "string","Sub Service" => "string", "Session" => "string",
                                    "TXN" => "string",
                      "IP" => "string","Request" => "ignore", "Response" => "ignore")));

// Configuration for data operations & presentation layer.
$dataFile = $_SERVER["PHP_SELF"];
$presentationFile = $dataFile;
$defaultDateFormat = "MM/dd/yyyy HH:mm:ss";

// DATABASE
if ($operation != "") {
  switch ($operation) {
    case "readReport":
      ReadReport($cu, $dbh, $reportList, $defaultDateFormat);
      break;
    default: // Won't get here
      header('Content-type: application/json');
      $returnArray = array("error" => array("Operation not specified: '$operation'"), "record" => "", "operation" => "");
      print HCU_JsonEncode($returnArray);
  }
} else {
// PRESENTATION
// Page for displaying the reports.
// **************************************************************
  $reportRecord = $reportList[$report];
  $title = !isset($reportRecord) ? "Unrecognized Report" : (isset($reportRecord["title"]) ? $reportRecord["title"] : $report);
  printMonitorPageTop($title, $homecuKendoVersion, $cloudfrontDomainName, $bootstrapVersion, $fontawesomeVersion, true);

  $filter = $cu == "" ? "" : HCU_JsonEncode(array("field" => "cu", "operator" => "eq", "value" => $cu));
?>

<style>
  .k-notification-wrap {
    overflow-x: scroll;
    overflow-y: visible;
  }

  .loggingArea {
    margin-left: 10px;
  }
  .loggingInfo {
    white-space: pre-wrap;
    width: 100%;
    margin-left: 10px;
  }
</style>

<script type="text/javascript">

<?php
// Include common functions
getShowWaitFunctions();
GetIsFilterChanged();
InitReport($presentationFile, $report, $reportList, $defaultDateFormat, true, $pageSize, false, "", $filter);
?>

var inNotification = true;
var inShowClick = true;

<?php
/**
 * Creates a notification popup for the logging details.
 * @param HTMLElement tr-- the table row that the notification is opened on
 * @param string info-- the display message
 * @return void
 */
?>
function InitNotification(tr, info) {
    var notification = $("<div></div>").kendoNotification({
    position: {
      pinned: false,
        top: $(tr).offset().top - $("body").scrollTop(),
        left: $(tr).offset().left - $("body").scrollLeft()
    },
    autoHideAfter: 0,
    width: 600,
    hideOnClick: false,
    show: function () {
      $(tr).data("hasNotification", true);
      $(".k-i.notification:not(:last)").remove();
      $(".k-i.notification .k-icon").remove();

      inNotification = $(".k-notification:hover").length != 0;
      inShowClick = true; // This is needed or it will close right away because it starts with a click.

      // Want mouseover, mouseout here not mouseenter, mouseleave.  mouseover and mouseout include entering, leaving descendants.  USUALLY want mouseenter, mouseleave.
      $(".k-notification").mouseover(function () {
        inNotification = true;
      });
      $(".k-notification").mouseout(function () {
        inNotification = false;
      });

      $("body").on("click.tr-" + $(tr).data("uid"), function() {
          if (inShowClick) {
            inShowClick = false;
          } else if (!inNotification) {
            notification.hide();
          }
          return false;
      });

      $(".closeBtn").click(function() {
        notification.hide();
        return false;
      })

    },
    hide: function () {
      $(tr).data("hasNotification", false);
      $("body").off("click.tr-" + $(tr).data("uid"));
    }
  }).data("kendoNotification");

    notification.info(info);
}

<?php
/**
 * @param KendoGrid grid-- the logging report grid.
 * @param HTMLElement tr-- the row clicked.  This is necessary to get the details from the dataItem.
 * @return void
 */
?>
function ShowDefaultNotification(grid, tr) {
    var dataItem = grid.dataItem($(tr));
    var template = "<div class='loggingArea'><a href='\\#' class='closeBtn'>Close</a><br><br>";
    template += "<b>Request:</b><br><div class='loggingInfo'>#: request #</div>";
    template += "<br><b>Response:</b><br><div class='loggingInfo'>#: response #</div>";
    template += "<br><br><a href='\\#' class='closeBtn'>Close</a></div>";
    var template = kendo.template(template);
    InitNotification($(tr), template(dataItem));
}

/**
 * This makes sure that the count is included in the case that more records are being added to list, previously it would subbornly assert that there are no new records.
 */
var inRefresh = false;
function ForceRefresh(data, parameters, filterChanged) {
  if (inRefresh) {
    parameters.includeCount = "Y";
    inRefresh = false;
  }
  <?php if ($cu == "") { ?>
    parameters.saveFilter = "Y";
  <?php } ?>
}

$(document).ready(function () {
  InitReport({parameterMapFunc: ForceRefresh, preInitFunc: function(gridDefinition) {
    gridDefinition.columns[0] = {command: [{name: "details", text: "Details"}], width: "30px"};
    <?php if ($cu != "") { // Cannot unfilter CU if coming in through the CU ?>
    gridDefinition.columns[2].filterable = false;
    gridDefinition.columns[2].sortable = false;
  <?php } ?>
  }});

  $("#refreshBtn").click(function() {
    var grid = $("#reportGrid").data("kendoGrid");
    inRefresh = true;
    grid.dataSource.read();
    return false;
  });

  $("#clearAllBtn").click(function() {
    var grid = $("#reportGrid").data("kendoGrid");
    // If you clear the sort and then the filter, it is two calls versus one here.
    // The cookie will be changed in the call.
    inRefresh = true;
    grid.dataSource.query({
      sort: {field:"entry", dir:"desc"},
      <?php if ($cu == "") { ?>
      filter: [],
      <?php } else { ?>
      filter: {field: "cu", operator: "eq", value: "<?php echo $cu; ?>"},
      <?php } ?>
      pageSize: <?php echo $pageSize; ?>,
      page: 1
    });
    return false;
  });

  $("#reportGrid").on("click", ".k-grid-details", function() {
    var grid = $("#reportGrid").data("kendoGrid");
    ShowDefaultNotification(grid, $(this).closest("tr"));
  });
});
</script>
<?php printMonitorPageMiddle($title, array("Refresh" => array("id" => "refreshBtn"), "Clear All" => array("id" => "clearAllBtn"))); ?>

  <div class="loggingReportDiv container hcu-all-100 vsgPrimary" id="loggingReportDiv">

    <div id="notification"></div>

    <div class="row hcuSpacer">
      <div class="col-xs-12">
        <div id="formValidateMainDiv" class="k-block k-error-colored formValidateDiv" style="display:none;"></div>
      </div>
    </div>

    <div class="row hcuSpacer">
      <div class="col-xs-12">
        <div class="reportGridOverflow">
          <div id="reportGrid"></div>
        </div>
      </div>
    </div>
  </div>
<?php printMonitorPageBottom();
} // No operation

// FUNCTIONS

/**
 * function ReadReport($dbh, $reportList, $defaultDateFormat)
 * Returns the data needed from the parameters for the report:
 *
 * "report" -- the report to read.  Refers to the $reportKey in the function getReportList().  The frontend sends the variable down as a javascript literal.
 * "initial" -- {true/false}  If initial, then also figure out the boolean DDLs and send those to the frontend to recreate the grid with those parameters.  (There is no re-read.)
 * "limit" -- How many records to return.
 * "offset" -- Where to start in the resultset.
 * "newFilter" -- {true/false}  If newFilter, then also find out the count of the resultset.  Also, ignore the offset.  It will get the first page.
 * "sort" -- This is a json encoded string of the current sort in the grid.
 * "filter" -- This is a json encoded string of the current filter in the grid.
 * "printerFriendly" -- printer friendly doesn't have paging.
 *
 * @param $Cu -- the credit union
 * @param $dbh -- the database connection
 * @param $reportList -- the reportList from the getReportList() above.
 * @param $defaultDateFormat -- This is what the date will be formatted as.
 */
function ReadReport($Cu, $dbh, $reportList, $defaultDateFormat) {
  $parameters = array("a" => array("report" => "", "initial" => "", "limit" => "", "offset" => "", "newFilter" => "", "sort" => "", "filter" => "", "printerFriendly" => ""));
  $string = array("filter" => HCUFILTER_INPUT_STRING);
  HCU_ImportVars($parameters, "a", array("report" => $string, "initial" => $string, "limit" => $string, "offset" => $string, "newFilter" => $string, "sort" => $string,
    "filter" => $string, "printerFriendly" => $string));

  $report = HCU_array_key_exists("report", $parameters["a"]) ? trim($parameters["a"]["report"]) : "";
  $initial = HCU_array_key_exists("initial", $parameters["a"]) ? trim($parameters["a"]["initial"]) == "true" : false;
  $limit = HCU_array_key_exists("limit", $parameters["a"]) ? intval($parameters["a"]["limit"]) : -1;
  $offset = HCU_array_key_exists("offset", $parameters["a"]) ? intval($parameters["a"]["offset"]) : 0;
  $newFilter = HCU_array_key_exists("newFilter", $parameters["a"]) ? trim($parameters["a"]["newFilter"]) == "true" : false;
  $sort = HCU_array_key_exists("sort", $parameters["a"]) ? trim($parameters["a"]["sort"]) : "";
  $filter = HCU_array_key_exists("filter", $parameters["a"]) ? trim($parameters["a"]["filter"]) : "";
  $printerFriendly = HCU_array_key_exists("printerFriendly", $parameters["a"]) ? trim($parameters["a"]["printerFriendly"]) == "true" : false;

  $includeCount = !$printerFriendly && $newFilter;
  $limit = $printerFriendly ? -1 : $limit;
  $offset = $printerFriendly || $newFilter ? 0 : $offset;

  $returnArray = ReadReportData($Cu, $reportList[$report], $dbh, $limit, $offset, $includeCount, false, $initial, false, $sort, $filter, $report, "loggingReport");

  header('Content-type: application/json');
  print HCU_JsonEncode($returnArray);
}