hcuFunctions.i

<?php
/*
 * BIG NOTE: This script is intended as a replacement for cu_common_intl.i and has functions with the
 *           same name. BY ORDER OF THE KING: DO NOT INCLUDE IN THE SAME SCRIPT AS cu_common_intl.i.
 */
/*
 * Function:  setLoginScript
 * Purpose:   This function will determine set the loginscript will be
 *              as well as the information for the currentscript
 * Parameters:  p_hb_env  - this is a value by REFERENCE to HB_ENV value
 *
 * Returns:    no return -- Changes made within are the necessary changes
 */

function setLoginScript(&$p_hb_env) {

  $loginscript = 'hcuLogin.prg';

  $lEnvSet = HCU_array_key_value('SYSENV', $p_hb_env);

  // * Determine if protocol can be http (development env) or https (production)
  $lHttp = (HCU_array_key_value('require_encryption', $lEnvSet) == 0 && ($_SERVER['REQUEST_SCHEME'] != 'https' && HCU_array_key_value('HTTP_X_FORWARDED_PROTO', $_SERVER) != 'https') ? 'http://' : 'https://');

  $chome = HCU_array_key_value("chome", $p_hb_env);
  $p_hb_env['fi_path'] = $lHttp . $_SERVER['HTTP_HOST'] . '/fi/' . $chome . '/';

  $loginpath = $lHttp . $_SERVER['HTTP_HOST'] . dirname($_SERVER['SCRIPT_NAME']);

  $p_hb_env['loginscript'] = "${loginpath}/${loginscript}";
  $p_hb_env['loginpath'] = $loginpath;

  // ** Home Banking is the MAIN directory for HOMECU
    // ie https://www6.homecu.net/hculive7 or https://www5.homecu.net/hcubin7
  $p_hb_env['homebankingpath'] = $lHttp . $_SERVER['HTTP_HOST'] . "/" . returnBaseDirectory($_SERVER['SCRIPT_NAME']);

  // ** PARSE THE CURRENT
  parse_str($_SERVER['QUERY_STRING'], $get_vars);

  // ** SET THIS VALUE TO THE ELEMENTS I WILL USE ON THE COMMAND LINE FOR HOME BANKING
    // ** allow testmenu
  $cuAllowGet = array('cu'=>'CU', 'testmenu'=>'Show Test Menu');

  $cu_query = array_intersect_key($get_vars, $cuAllowGet);
  $p_hb_env['testmenu'] = intval(HCU_array_key_value('testmenu', $get_vars));
  // ** ADD A & at the end so I can just add new parameters to the end
  $p_hb_env['cuquery'] = http_build_query ($cu_query);

}

// Function: ReturnAddress
// Purpose:  To record the currently requested page so we can return here after
              /// a successful login.  This should ONLY be called when cookie
              // validation fails and we may redirect later
function recordCurrentAddress ($p_hb_env) {

// Called when the cookie is missing, expired, or damaged.  Sets return address
// to the name of the current script so cu_login knows where to go afterwards.


  $url_query_string = urlencode($_SERVER['QUERY_STRING']);

  setcookie("Tx_URI",
            "https://".$_SERVER['HTTP_HOST'] .
       $_SERVER['PHP_SELF'] . "?" . $url_query_string,
       0,
       "/",
       $p_hb_env['TicketDomain'],
       1);
}

/**
 * Note 04-2019 "aside" element changed to nav because it's not an aside
 * @param string $pType {menu, aside} - Do we create the 'menu' on top, or the 'aside' menu
 * @param array $pmenuDetail - This is the array value of the item to print
 *           menu - The MAIN header array value is passed in which will include all of it's details (the parent in a sense)
 *           aside - The SPECIFIC detail link to print should be passed in (the child)
 * @param array $phb_env - Current HB_ENV value
 * @param bool $pactiveLink - is THIS link the active item for it's type?  {true, false}
 *                true - the special class identifier should be used to highlight this menu option
 *                false - do nothing
 *
 * @return string - this will return the link to print on the screen
 *
 */
function buildMenuLinkOLD($pType, $pmenuDetail, $phb_env, $pactiveLink) {
  $menuLink = "";

  // ** Create the href
    // * href value always comes from the detail section
    // * for menu type -- FIND the default link
    // * for aside type -- USE what is passed in
  if ($pType == 'menu') {
    $useMenuDetail = $pmenuDetail['detail'][$pmenuDetail['default']];
  } else {
    $useMenuDetail = $pmenuDetail;
  }

  /*
   * SET the beginning of the link. There are issues using the relative URL
   * IF the href starts with http, then this is already an absolute path, NO
   * action needed
   * IF NO http then add the homebankingpath to the beginning
   *
   */
  if (substr($useMenuDetail['href'], 0, 4) != 'http') {

    $useLinkHref = $phb_env['homebankingpath'] . (substr($phb_env['homebankingpath'], -1) != '/' ? '/' : '') . $useMenuDetail['href'] . "?";
  } else {
    $useLinkHref = $useMenuDetail['href'] . "?";
  }
  // ** Do we add cuquery or extra parameters?
  if ($useMenuDetail['hrefUrlQuery'] == 1) {
    $useLinkHref .= $phb_env['cuquery'];
  }
  // * Extra parameters
  if ($useMenuDetail['hrefExtraParam'] != '') {
    $useLinkHref .= "&" . $useMenuDetail['hrefExtraParam'];
  }
  // ** If this menu option has hrefOverride set, then I need to pass this
    // * value on the URL so I can set it later
  if ($useMenuDetail['hrefMultiple'] != '') {
    $useLinkHref .= "&menuUniq=" . $useMenuDetail['hrefMultiple'];
  }
  // ** Create the target
  if ($useMenuDetail['target'] != '') {
    $useLinkTarget = $useMenuDetail['target'];
  }

  // ** Create the anchor DisplayValue
  // * menu type should always come from the 'parent' element,
  // * aside type should always come from the 'child' element
  // ** NOTE: in both cases this should be the first level 'display' element
  //
  // * The language is important here, en_US MUST be defined for proper logic
  // * if a specific menu item does NOT exist for an alternate language then
  // * the DEFAULT en_US will be used
  if ($pmenuDetail['display'][$phb_env['Flang']] != '') {
    $useLinkDisplay = hcu_displayHtml($pmenuDetail['display'][$phb_env['Flang']]);
  } else {
    // ** USE default menu option
    $useLinkDisplay = hcu_displayHtml($pmenuDetail['display']['en_US']);
  }

  // ** create the LINK!
  if ($pType == 'menu') {
    $menuLink = "<a href='{$useLinkHref}' target='{$useLinkTarget}'><span  class='button " . ($pactiveLink ? "item-active" : "") . "'>{$useLinkDisplay}</span></a>";
  } else {
    $menuLink =  "<li id='" . ($pactiveLink ? "submenu-active" : "") . "'><a href='{$useLinkHref}' target='{$useLinkTarget}'>{$useLinkDisplay}</a>" . ($pactiveLink ? '<span class="arrow"></span>' : '') . "</li>";
  }

  return $menuLink;
}

/**
 * This function is used to determine if the string that is passed in qualifies
 * as a valid PHP serialized value
 *
 * @param string $val
 * @return boolean
 *      true - The value appears to be a valid serialized string
 *      false - Something is wrong with the string
 */
function hcuIsSerializedString($val){
  if (!is_string($val)){ return false; }
  if (trim($val) == "") { return false; }
  if (preg_match("/^(i|s|a|o|d):(.*);/si",$val) !== false) { return true; }
  return false;
}

/**
 *
 * This function will change only the specified values within the Banking Ticket
 *
 * @param array  $pHbEnv This is the HB_ENV array for the current environment
 * @param string $cur  This is the current value of the Banking 'Ticket'
 * @param string $newset This is the string of new values to set.
 *                        They are passed into the function in the syntax "key1=val1&key2=val2"
 *
 *
 * @return string Returns the new Ticket value
 */
function SetTicket($pHbEnv, $cur, $newset) {

  $ResetTicket = BuildSessionTicketStr($pHbEnv, $cur, $newset);

  $lEnvSet = HCU_array_key_value('SYSENV', $pHbEnv);
  HCU_setcookie_env($lEnvSet, "Ticket", $ResetTicket, 0);

    return $ResetTicket;
}

/**
 *
 * Create the Banking Ticket string to be used by a cookie. The parameters are
 *  expected to be passed in as name=value pairs (e.g. name1=value1&name2=value2).
 *
 * @param array  $pHbEnv  This is the HB_ENV array for the current environment
 * @param string $currSet The current Home Banking 'Ticket' string
 * @param string $newSet  The string of new values to set
 *                        They are passed into the function in the syntax "key1=val1&key2=val2"
 *
 * @return string Returns the new Ticket session string value
 */
function BuildSessionTicketStr($pHbEnv, $currSet, $newSet) {

  $secret = HCU_array_key_value('secret', $pHbEnv);

  $cArray = array();
  $newArray = array();
  parse_str( urldecode($currSet), $cArray );
  parse_str( urldecode($newSet), $newArray );

  if ( count( $newArray) > 0 ) {
    foreach ( $newArray as $key => $value) {
      $cArray[$key] = $value;
    }
  }

  $cArray['Ch'] = MD5($secret . MD5(join(':',
    [
      $secret,
      $cArray['Ctime'], $cArray['Ce'], $cArray['Cu'], $cArray['Cn'], $cArray['Uid'],
      $cArray['Clw'], urlencode(trim($cArray['Clu'])),
      urlencode(trim($cArray['Fplog'])), urlencode(trim($cArray['Fflog'])),
      $cArray['Ffchg'], $cArray['Ffreset'],
      $cArray['Ffremain'], $cArray['Fmsg_tx'], $cArray['Fset'],
      $cArray['Fset2'], $cArray['Fset3'], $cArray['Fhdays'],
      urlencode($cArray['Ml']), trim($cArray["Ca"]), trim($cArray["platform"]), $cArray["sid"]
    ]
  )));

  $delim = '';
  $newTicket = '';
  foreach ($cArray as $key => $value) {
    $value = urlencode($value);
    $newTicket .="${delim}${key}=${value}";
    $delim = '&';
  }

  return $newTicket;
} // end BuildSessionTicketStr

/**
 *
 * Create the base Banking Ticket string to be used by a cookie. All the values
 *  this function builds are in HB_ENV.
 *
 * @param array  $pHbEnv  This is the HB_ENV array for the current environment
 * @param string $currSet The current Home Banking 'Ticket' string
 * @param string $newSet  The string of new values to set
 *                        They are passed into the function in the syntax "key1=val1&key2=val2"
 *
 * @return string Returns the new Ticket session string value
 */
function BuildBaseSessionTicket( $pHbEnv ) {

  $ticket = "Cu={$pHbEnv["cu"]}&Ce={$pHbEnv['Ce']}&Clw={$pHbEnv['Clw']}"
                    . "&Clu={$pHbEnv['Clu']}"
                    . "&Fplog={$pHbEnv['Fplog']}&Fflog={$pHbEnv['Fflog']}"
                    . "&Ffchg={$pHbEnv['Ffchg']}&Ffreset={$pHbEnv['Ffreset']}"
                    . "&Ffremain={$pHbEnv['Ffremain']}&Fmsg_tx={$pHbEnv['Fmsg_tx']}"
                    . "&Fset={$pHbEnv['Fset']}&Fset2={$pHbEnv['Fset2']}"
                    . "&Fhdays={$pHbEnv['Fhdays']}&Fset3={$pHbEnv['Fset3']}&Ca=";
  // these may not exist in HB_ENV yet
  $userName = isset( $pHbEnv["Cn"] ) ? $pHbEnv["Cn"] : "";
  $ticket .= "&Cn=$userName";

  $userId = isset( $pHbEnv["Uid"] ) ? $pHbEnv["Uid"] : "";
  $ticket .= "&Uid=$userId";

  $userEmail = isset( $pHbEnv["Ml"] ) ? $pHbEnv["Ml"] : "";
  $ticket .= "&Ml=$userEmail";

  // Add the platform to the Ticket cookie. Use the name "platform" so
  // it overwrites the HB_ENV value in scripts after login.
  $ticket .= "&platform={$pHbEnv["platform"]}";

  // Add the sid to the Ticket cookie.
  $ticket .= "&sid={$pHbEnv["sid"]}";

  return $ticket;
} // end BuildBaseSessionTicket

/**
 * ReturnUnconfirmedTransactions
 *
 * @uses    return all transactions awaiting confirmation
 * @param   pDbh      object    database access
 * @param   pHbEnv    object    banking environment values
 *
 * @return  retData   array     list of transactions awaiting
 * confirmation.
 */
function ReturnUnconfirmedTransactions($pDbh, $pHbEnv) {
  $retData = array();
  $uId = $pHbEnv["Uid"];
  $cu = $pHbEnv['Cu'];

  // posted/create _date is only selected so the UNION
  // will not combine multiple rows that have the same values;
  // i.e. multiple ACHPMT or TRN.
  $sql = "
    SELECT
      t.user_id AS user_id, t.approved_status, t.feature_code, t.create_date
    FROM cu_scheduledtxn t
    INNER JOIN {$cu}user u
      ON u.user_id = t.user_id
    WHERE
      u.group_id = (SElECT group_id FROM {$cu}user where user_id = $uId)
      AND
      u.user_id != $uId
      AND
      (t.approved_status IS NULL OR t.approved_status = 0)
    UNION
    SELECT
      h.posted_by AS user_id, h.approved_status, h.feature_code, h.posted_date
    FROM {$cu}transhdr h
    INNER JOIN {$cu}user u
      ON u.user_id = h.posted_by
    WHERE
      u.group_id = (SElECT group_id FROM {$cu}user where user_id = $uId)
      AND
      u.user_id != $uId
      AND
      (h.approved_status IS NULL OR h.approved_status = 0)";
  $sqlRs = db_query($sql, $pDbh);
  $retData = db_fetch_all($sqlRs);

  return $retData;
}

  function ReturnUnreadSecureMsg ($p_dbh, $p_hb_env) {
    $retValue = 0;

    $sql = "SELECT count(*) as UnreadMsgCount
            FROM cuadmeco
            WHERE cu = '{$p_hb_env['Cu']}'
                AND user_id = '{$p_hb_env['Uid']}'
              AND origination = 0
              AND unread;";

    $unreadRs = db_query($sql, $p_dbh);
    if($unreadRs) {
      list($retValue) =  db_fetch_array($unreadRs, 0);
    }
    return $retValue;
  }

  /**
   * Function: PostSecureMessage
   *  This function will get information for the secure form, build and place the file in the specified
   *  location, and send an email to the specfied address using the specified information.
   *  If no email then it won't be sent.
   *
   * @param array $formDataArray        - holds the information as described below
   * @param string $securePathFileName  - path and file name for secure message
   * @param string $secureFormTitle     - title for the form
   * @param array $emailData            - information to create and send the notification email
   * @param array $pHbEnv - The HB_ENV environment array
   *
   * $formDataArray has the following elements:
   *    class       - (optional) hold the class name for the <label>
   *    label       - holds the label the credit union member will see in the secure message
   *    value       - hold the value for the label
   *
   * $emailData has the following elements
   *    target      - (required) destination email address
   *    reply       - address for reply
   *    subject     - email subject (should have message code as part of it - eg ccpmt for Credit Card Payment)
   *    body        - (required) email body
   *
   * RETURN VALUE
   *  retVal - 0 on success, non-zero if error
   */
  function PostSecureMessage( $formDataArray, $securePathFileName, $secureFormTitle, $emailData, $pHbEnv ) {

    $retVal = 0;

    try {
      /*
       * Create the form string
       */
      // ** Write the header section of the file
      $secureFormData = <<< printblock
<?xml version="1.0"?><!doctype html>
<html  xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <title>$secureFormTitle</title>
    <link href="https://{$pHbEnv['cloudfrontDomainName']}/homecu/css/KendoUI/{$pHbEnv['homecuKendoVersion']}/kendo.common.min.css" rel="stylesheet">
    <link href="https://{$pHbEnv['cloudfrontDomainName']}/homecu/css/KendoUI/{$pHbEnv['homecuKendoVersion']}/kendo.default.min.css" rel="stylesheet">

    <script type="text/javascript" src="https://{$pHbEnv['cloudfrontDomainName']}/jquery/js/jquery-1.9.1.min.js.gz"></script>
    <script src="https://{$pHbEnv['cloudfrontDomainName']}/homecu/js/KendoUI/{$pHbEnv['homecuKendoVersion']}/kendo.web.min.js"></script>
  </head>
  <style>
    .k-block {width: 500px}
    .field-label-wrapper { margin: 0px 5px 5px 5px; padding: 0px 5px 5px 20px; border-radius: 5px; -moz-border-radius: 5px; -webkit-border-radius: 5px; }
    .field-label-wrapper label { display: block; padding: 10px 0 6px 4px; color: #333333; font-size:1.2em; margin-left: -10px; width: 100%; }
    .field-label-wrapper label.note {color: red;font-weight: bold;}
    .field-label-wrapper label.note:before {content: "NOTE: "}
    .field-label-wrapper label.field:after {content: ":"}
    .field-label-wrapper label hr { z-index: 0; display:inline-block; width: 100%; position:relative; top:-24px;background-color:#000000; }
  </style>
  <body>
    <div class='k-content'>
      <div class="k-block"><div class="k-header k-shadow">$secureFormTitle</div>
printblock;

      // ** Loop through the fields and print
      foreach ($formDataArray as $dataIdx => $dataAttr) {

        $printLabel = ($dataAttr['label'] != '' ? "<label class='{$dataAttr['type']}'>{$dataAttr['label']}</label>" : '');
        $secureFormData .= <<< printblock
          <div class='field-label-wrapper'>
            {$printLabel}
            <div class='field-value'>{$dataAttr['value']}</div>
          </div>
printblock;
      }
      // ** Set the ending of the file
      $secureFormData .= <<< printblock
        </div>
      </div>
    </body>
  </html>
printblock;

      /*
       * Open and Write the data to the secure form
       */
      $secureFormFileHdl = fopen($securePathFileName, 'w');
      if ($secureFormFileHdl) {
        fwrite($secureFormFileHdl, $secureFormData);
        fclose($secureFormFileHdl);
      } else {
        // ** ERROR
        throw new Exception();
      }

      // see if caller wants an email sent
      if ( $emailData && $emailData["target"] && $emailData["body"] ) {
        /*
         * SEND E-mail
         */
        $notify = new ErrorMail;
        $notify->mailto = $emailData["target"];
        $notify->replyto = $emailData["reply"];
        $notify->subject = $emailData["subject"];
        $notify->msgbody = $emailData["body"];
        $notify->callingfunction = __FUNCTION__;
        $notify->file = __FILE__;
        $notify->SendMail();
      }

    } catch (Exception $ex) {
      // some error occurred
      $retVal = 1;
    }


    return $retVal;
  }

  /**
   * Function: GetConfirmCode
   *  Generate a confirmation code based on the current time.
   * Confirmation code is julian day . Seconds since midnight as 7digits,
   * then converted to hex and formatted as 2-2-2-2 to minimize hex swearing.
   *
   * RETURN VALUE
   *  retVal - confirmation id
   */
function GetConfirmCode() {
  $conDate = getdate();
  $conCode = sprintf('%08s',dechex(($conDate['yday'] + 1 .
    sprintf('%07u',(
      $conDate['hours'] * 3600 +
      $conDate['minutes'] * 60 +
      $conDate['seconds'] )))));

  $confirmId = sprintf('%s-%s-%s-%s',substr($conCode,0,2),substr($conCode,2,2),substr($conCode,4,2),substr($conCode,6,2));

  return $confirmId;
}


  /*
    Purpose: This function will do double duty.  It will validate
                        a date that is passed in one variable such as MM/DD/YYYY
                        AND it should also be able to accept the date in pieces in
                        three separte parameters
*/
function validateDate() {
    # renamed copy of dms_checkdate out of cu_common_intl.i

    $retval = true;       // START THE FUNCTION TO RETURN TRUE

    // ** FIRST -- Determine if we are assuming 3 pieces or 1 full date piece
    if (func_num_args() == 1) {
        $date_arg = func_get_arg(0);
        // ** EXPECT THE DATE TO BE ONE FULL DATE in the month variable MM/DD/YYYY -- separator may be [/-.]
        // ** BREAK THE PIECES APART
        if (preg_match("#^([0-9]{1,2})[/-]{1}([0-9]{1,2})[/-]{1}([0-9]{2,4})$#", $date_arg, $regs)) {
            $m_val = $regs[1];
            $d_val = $regs[2];
            $y_val = $regs[3];
        } else {
            $retval = false;
        }
    } elseif (func_num_args() == 3) {
        $arg_date = func_get_args();
        // ** Expect the date to be parsed into the 3 different parameters -- verify the pieces match and contain no string
        if ((strval(intval($arg_date[0])) != strval($arg_date[0])) || (strval(intval($arg_date[1])) != strval($arg_date[1])) || (strval(intval($arg_date[2])) != strval($arg_date[2]))) {
            $retval = false;
        } else {
            $m_val = $arg_date[0];
            $d_val = $arg_date[1];
            $y_val = $arg_date[2];
        }
    } else {
        // ALL OTHER CASES -- RETURN FALSE
        $retval = false;
    }
    // ** If the return value is true then we have the values we want, now check the date
    if ($retval) {
        // Seemed to pass the first exercise, now test to see if the actual checkdate is correct
        $retval = checkdate(intval($m_val), intval($d_val), intval($y_val));
    }

    return $retval;
}

/**
 *
 * This function will expect a date in the pCalDate parameter and then it will convert
 * this into a timestamp and then in to a compatible string for the JSON date object.
 * AT THIS TIME, I believe I can simply add '000' to the end of a UNIX EPOCH for the
 *  valid JSON date value of the same day
 *
 * Need the timestamp returned in UTC -- To do this, I want to
 *     get the current timezone,
 *     set the timezone to UTC
 *     create the timestamp
 *     set the timezone back to current
 *
 * @param string $pCalDate
 *
 * returns string
 *
 */
function returnJsonDateValue($pCalDate) {

  // ** Get the CURRENT timezone
  $curTZ = date_default_timezone_get();
  // ** Set the timezone to UTC
  date_default_timezone_set('UTC');
  // * Get the EPOCH in UTC
  $strTimestamp = gmdate('U', strtotime($pCalDate)) * 1000;;
  // * Set the timezone back to what it was on entry of function
  date_default_timezone_set($curTZ);

  // * Return the result
  return $strTimestamp;
}

/**
 *
 * This function will encode the packetStatus array and store in a cookie
 *
 * @param array $phb_env - The HB_ENV environment array
 *
 * @return NO RETURN VALUE
 *
 */
function savePacketStatusCookie($phb_env) {
  $bolPacketMod = false;
    $logger = $phb_env['SYSENV']['logger'];
  /*
   * 3 array elements returned from the live appliance
   * status - The code to identify the current packet status
   * asofdate - This is the end date of the data in the packet.  a 1 is returned for bad packet
   * reason - For errors this will contain the error information from the appliance
   *
   * check the status is != 0, 0 is returned for the status when the request is processed too son
   *   The problem is the too soon response will return an 'asofdate', which is the last date of the data
   *   but this is not accurate and we do NOT want to update the status in this case
   *
   * This function will encode the values and save the information in
   *  the packet status cookie
   *
   */

  /*
   * Take a second to determine if the information has changed, if so, we notify
   * user -- ONLY checkthe asofdate -- This will help ensure we do NOT overwrite
   *        the status and reason when the result is 'too soon to ask again'
   */
  $curPktStatus = decodePacketStatusCookie($phb_env);
  if ((trim($curPktStatus['asofdate']) != trim($phb_env['packetStatus']['asofdate'])) && $phb_env['packetStatus']['status'] != '900') {
    $bolPacketMod = true;
    // ** ONLY save if different -- NOT found should come back as blank in curPktStatus
    // ** Also, when creating the the cookie, add another element 'r', the real
      // * purpose is to add a number that isn't shown anywhere in the system and is random
    $phb_env['packetStatus']['r'] = rand(11111, 99999);
    $encodedValue = hcu_encrypturl(json_encode($phb_env['packetStatus']), $phb_env['historyHash']);

        HCU_setcookie_env($phb_env['SYSENV'], $phb_env['livePacketStatusCookie'], $encodedValue, 0);

  }

  return $bolPacketMod;
}

/**
 *
 * This function will retrieve the packetStatus from the packetStatus Cookie
 *  and store in the HB_ENV packetStatus element.
 *
 * @param array $phb_env - Passed by reference, the HB_ENV environment array.
 *                          it will be directly modified if the status is found
 *
 * @return NO RETURN
 */
function retrievePacketStatusCookie(&$phb_env) {

    $logger = $phb_env['SYSENV']['logger'];

    if (HCU_array_key_value($phb_env['livePacketStatusCookie'], $_COOKIE)) {

    $phb_env['packetStatus'] = decodePacketStatusCookie($phb_env);
    $phb_env['lastupdate'] = $phb_env['packetStatus']['asofdate'];
  }
  // ** NO RETURN
}

/**
 *
 * Purpose: this function will return the decoded packetStatus array from the
 *  packetStatus cookie.  It will return an array of the form
 *     'status'
 *     'asofdate'
 *     'reason'
 *
 * @param type $phb_env
 *
 * @return array
      status - Code returned from the appliance
      asofdate - the date returned from the appliance
      reason - A description from appliance, normally used for errors

 */
function decodePacketStatusCookie($phb_env) {

  $retPktStatusAry = Array (
      'status' => '',
      'asofdate' => '',
      'reason' => ''
  );

    if (HCU_array_key_exists($phb_env['livePacketStatusCookie'], $_COOKIE)) {
        if ($_COOKIE[$phb_env['livePacketStatusCookie']]) {
            $cookieValue = $_COOKIE[$phb_env['livePacketStatusCookie']];
            $statusAry = json_decode(hcu_decrypturl($cookieValue, $phb_env['historyHash']), true);
            switch (json_last_error()) {
                    case JSON_ERROR_NONE:
                        /*
                         * SUCCESS
                         * Set the return array
                         */
                        // * Assign the values by array element
                        if (is_array($statusAry)) {
                            // ** Validate the decoded value is an array
                            if (array_key_exists('status', $statusAry) && array_key_exists('asofdate', $statusAry) && array_key_exists('reason', $statusAry)) {
                                $retPktStatusAry['status'] = substr(preg_replace('/[^0-9]/', '', $statusAry['status']), 0, 3);
                                $retPktStatusAry['asofdate'] = substr(preg_replace('/[^0-9A-Za-z:\s]/', '', $statusAry['asofdate']), 0, 30);
                                $retPktStatusAry['reason'] = substr(preg_replace('/[^0-9A-Za-z\s]/', '', $statusAry['reason']), 0, 30);
                            }
                        }
                        break;
            }
        }
    }
  return $retPktStatusAry;
}

/**
 *
 * This function is used to UPDATE the cookie and set the current HB_ENV['Fmsg_tx']
 * value. When calling TX_list, the function may return Fmsg_tx in the status
 *
 * This function is meant to evaluate the array RETURNED from TX_list, if the value
 * is set, then it will UPDATE the cookie and SET Fmsg_tx in HB_ENV
 *
 * @param aray $phb_env - HB_ENV environment array
 * @param array $pTransferListAry - This is the ARRAY that is returned from TX_list
 *
 * NO RETURN
 */
function setFmsgTxCookie(&$phb_env, $pTransferListAry) {

 /*
   * Process status TX_list
   *
   * The function TX_list can return back an extra element in [status]
   *    [Fmsg_tx]
   *    If this value is set AND the value is different than what I have in HB_ENV['Fmsg_tx']
   *    THEN
   *    Rebake the cookie with this new value, and UPDATE HB_ENV
   */
  if (isset($pTransferListAry['status']['Fmsg_tx']) && $phb_env['live']) {
    if (intval($pTransferListAry['status']['Fmsg_tx']) != $phb_env['Fmsg_tx']) {
      // We have a new value --
      // ** SET COOKIE
      SetTicket($phb_env, $_COOKIE['Ticket'],"Fmsg_tx=" . intval($pTransferListAry['status']['Fmsg_tx']));
      // ** SET HB_ENV
      $phb_env['Fmsg_tx'] = intval($pTransferListAry['status']['Fmsg_tx']);
    }
  }

}

/**
 *
 *  check_alias_format
 *
 *  This function will check the format of the alias to see if it meets the
 *  criteria
 *
 * @param string $p_useralias
 * @return boolean {True, False} Did the alias PASS verification
 */
function check_alias_format($p_useralias) {
  $pass_val = false;
  // The expression checks for starting with an alpha
  // followed by anything except the disallowed bad guys
  if (preg_match("/^[a-zA-Z][^\\`,\"'\+\&\s;]*$/", $p_useralias) && strlen($p_useralias) > 5) {
    $pass_val = true;
  } else {
    $pass_val = false;
  }
  return $pass_val;
}

/**
 *
 * hcu_array_key_exists
 *
 * This function will check if a key exists in an array. BUT first it makes sure
 *   the Haystack is a valid array.  If it is not, then the function will fail
 *
 * Returns:  true - the needle exists in the haystack
 *           false - the haystack was NOT an array, or the key does not exist
 *
 * @param string $pNeedleKey
 * @param array $pAryHaystack
 *
 * @return boolean
 *
 */
/**
  * 2/1 mws Deprecated -- moved to hcuCommon.i

function hcu_array_key_exists($pNeedleKey, $pAryHaystack) {
  $retVal = false;    // ** Assume, it is NOT found

  if (is_array($pAryHaystack)) {
    $retVal = array_key_exists($pNeedleKey, $pAryHaystack);
  }


  return $retVal;
}
*/
function validateEmail($email_addr) {
    # renamed copy of check_email out of cu_common_intl.i
    $pass_val = false;
    // Check the email for a qualified address
    // The first expression checks for double instances of @'s and .'s and other hard to express errors
    // The second expression checks for the common email syntax XYZ@host.gov -- the value host may be broken down with periods
    if (
        (!preg_match("/(@.*@)|(\.\.)|(@\.)|(\.@)|(^\.)/", $email_addr))
        &&
        (preg_match("/^.+\@(\[?)[a-zA-Z0-9\-\.]+\.([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$/", $email_addr))
    ) {
        $pass_val = true;
    } else {
        $pass_val = false;
    }
    return $pass_val;
}

/**
 *
 * Build up the payload and target for apps to call for if the menu item is
 *  "Open in a new window".
 *
 * @param array $pHBEnv - HB_ENV environment array
 * @param array $pMenuID - This is the ARRAY that is returned from TX_list
 * @param string $pCurrentTicketCookie - The current ticket cookie string
 *
 * @return string with complete url target and parameters
 */
function GetLandingMenuTarget( $pHBEnv, $pMenuID, $pCurrentTicketCookie ) {
  $target = "";

  try {
    // get the menu entry
    if ( $pMenuID > 0 ) {
      $menuInfo = FetchFeatureMenu( $pHBEnv["dbh"], $pHBEnv["Cu"] );
      if ( $menuInfo["code"] != "000" ) {
        throw new Exception("Error Reading Menu", 1);
      }

      // get the menu entry
      $menuEntry = array();
      for ( $i = 0; $i < count( $menuInfo["data"] ); $i++ ) {
        if ( $menuInfo["data"][$i]["MenuItemId"] == $pMenuID ) {
          $menuEntry = $menuInfo["data"][$i];
          break;
        }
      }

      if ( !count( $menuEntry ) ) {
        throw new Exception("Unable to find menu entry", 2);
      }

      // get what is needed to build up the parameter list
      // build this up as GET url parameters
      $params = "";
      if ( $menuEntry["details_hrefUrlQuery"] === 1 ) {
        $params .= ( strlen( $params ) > 0 ) ? "&" : "";

        $params .=  "cu=" . $pHBEnv['Cu'];
      }

      if ( strlen( $menuEntry["details_hrefExtraParam"] ) > 0 ) {
        $params .= ( strlen( $params ) > 0 ) ? "&" : "";

        $params .=  $menuEntry["details_hrefExtraParam"];
      }

      // set all the cookies
      $cookies = array( "Ticket" => $pCurrentTicketCookie );

      // build up the parts
      // NOTE: the cookie is already urlencoded but the parameters will need to be urlencoded
      $payload = array( "url" => $menuEntry["details_href"],
                        "parameters" => urlencode( $params ),
                        "cookies" => $cookies
                      );

      $payloadJSON = HCU_JsonEncode( $payload );

      // encrypt the string
      $payloadKey = GetPayloadEncryptionKey(32);

      $payloadEncrypted = EncryptPayloadData( $payloadJSON, $payloadKey );

      $payloadString = "&payload=$payloadEncrypted";

    } else {
      $payloadString = "";
    }

    // Set the "cu=" because the web landing page expects it. Return the target as one
    // complete string
    $target = $pHBEnv["homebankingpath"] . "/webLanding.prg?cu=" . $pHBEnv["Cu"] . $payloadString;
  } catch( Exception $e ) {
    // don't do anything since the default result will indicate an error without leaking info
  }

  return $target;
} // end GetLandingMenuTarget

/**
 *
 * Build up the payload and target for apps to call for if the menu item is
 *  "Open in a new window".
 *
 * @param array $pHBEnv - HB_ENV environment array
 * @param array $pMenuID - This is the ARRAY that is returned from TX_list
 * @param string $pCurrentTicketCookie - The current ticket cookie string
 *
 * @return string with complete url target and parameters
 */
function GetLandingURL( $pHBEnv, $pURL, $pCurrentTicketCookie ) {
  $target = "";

  try {
    if ( !empty($pURL) ) {

      // break the URL into component pieces
      $pURL = urldecode($pURL);
      $urlparts = parse_url($pURL);
      if ( !is_array($urlparts) || !count( $urlparts ) ) {
        throw new Exception("Invalid URL", 1);
      }
      if ( !HCU_array_key_value('scheme', $urlparts) ||
          !HCU_array_key_value('host', $urlparts) ||
          !HCU_array_key_value('path', $urlparts) ) {
        throw new Exception("Invalid URL", 1);
      }

      $url = $urlparts['scheme'] . "://" . $urlparts['host'];
      if (HCU_array_key_value('port', $urlparts) ) {
        $url .= ":{$urlparts['port']}";
      }
      $url .= $urlparts['path'];

      $params = HCU_array_key_value('query', $urlparts);
      // set all the cookies
      $cookies = array( "Ticket" => $pCurrentTicketCookie );

      // build up the parts
      // NOTE: the cookie is already urlencoded but the parameters will need to be urlencoded
      $payload = array( "url" => $url,
                        "parameters" => urlencode( $params ),
                        "cookies" => $cookies
                      );

      $payloadJSON = HCU_JsonEncode( $payload );

      // encrypt the string
      $payloadKey = GetPayloadEncryptionKey(32);

      $payloadEncrypted = EncryptPayloadData( $payloadJSON, $payloadKey );

      $payloadString = "&payload=$payloadEncrypted";

    } else {
      $payloadString = "";
    }

    // Set the "cu=" because the web landing page expects it. Return the target as one
    // complete string
    $target = $pHBEnv["homebankingpath"] . "/webLanding.prg?cu=" . $pHBEnv["Cu"] . $payloadString;
  } catch( Exception $e ) {
    // don't do anything since the default result will indicate an error without leaking info
  }

  return $target;
} // end GetLandingURL

/**
 *
 * Return the information used to build the message and links for user profile
 * updates. This is callable by browswer-based and apps, so don't include any
 * visual formatting. For the browswer-based we want a fully qualified path url;
 * for apps just the script name.
 *
 * @param array $pHBEnv - HB_ENV environment array
 *
 * @return JSON string with sections for email, password (optional), and security (optional)
 */
function GetUserProfileUpdates( $pHBEnv ) {
  // some globals
  global $MEM_FORCE_RESET;

  $returnInfo = array();

  // get a pointer to the dictionary
  $MC = $pHBEnv["MC"];

  // check if the password needs updating
  if ( HCU_array_key_exists("Ffchg", $pHBEnv) && $pHBEnv['Ffchg'] == 'Y' ) {
    if ( $pHBEnv['Ffremain'] > 1 ) {
      $expireMessage = $MC->combo_msg("Login Expiring", HCU_DISPLAY_AS_HTML, "#REMAIN#", $pHBEnv['Ffremain']);
      $icon = "exclamation";
      $level = "warning";
    } else {
      $expireMessage = $MC->combo_msg("Login Expired");
      $icon = "exclamation-triangle";
      $level = "error";
    }

    $url = $pHBEnv["platform"] == "ADA" || $pHBEnv["platform"] == "APP" ? "hcuProfilePwd.prg" : $pHBEnv['loginpath'] . "/hcuProfilePwd.prg?" . $pHBEnv['cuquery'];

    $returnInfo["password"] = array( "title" => $MC->msg("Important"),
                                     "message" => $expireMessage,
                                     "icon" => $icon,
                                     "level" => $level,
                                     "link" => $MC->msg("Update Now"),
                                     "url" => $url
                                   );
  }

  // check if the creds needs updating
  if ( HCU_array_key_exists("Ffreset", $pHBEnv) && (($pHBEnv['Ffreset'] & $MEM_FORCE_RESET) > 0) ) {
    if ( $pHBEnv['Ffremain'] > 1 ) {
      $expireMessage = $MC->combo_msg("Challenge Update", HCU_DISPLAY_AS_HTML, "#REMAIN#", $pHBEnv['Ffremain']);
      $icon = "exclamation";
      $level = "warning";
    } else {
      $expireMessage = $MC->combo_msg("Challenge Expired");
      $icon = "exclamation-triangle";
      $level = "error";
    }

    $url = $pHBEnv["platform"] == "ADA" || $pHBEnv["platform"] == "APP" ? "hcuProfileSecurity.prg" : $pHBEnv['loginpath'] . "/hcuProfileSecurity.prg?" . $pHBEnv['cuquery'];

    $returnInfo["security"] = array( "title" => $MC->msg("Important"),
                                     "message" => $expireMessage,
                                     "icon" => $icon,
                                     "level" => $level,
                                     "link" => $MC->msg("Update Now"),
                                     "url" => $url
                                   );
  }

  // either show the email or the update email
  if ( HCU_array_key_exists("Fmsg_tx", $pHBEnv) && (($pHBEnv['Fmsg_tx'] & GetMsgTxValue('MSGTX_FORCE_EM')) !== 0) ) {
    $emailTitle = $MC->msg("Bad Email Flag");
    $icon = "exclamation-triangle";
    $level = "warning";
  } else {
    $emailTitle = $MC->msg("Current email Part 1");
    $icon = "envelope";
    $level = "info";
  }

  $url = $pHBEnv["platform"] == "ADA" || $pHBEnv["platform"] == "APP" ? "hcuProfileEmail.prg" : $pHBEnv['loginpath'] . "/hcuProfileEmail.prg?" . $pHBEnv['cuquery'];

  $returnInfo["email"] = array( "title" => $emailTitle,
                                   "message" => HCU_array_key_exists("Ml", $pHBEnv) ? $pHBEnv['Ml'] : "",
                                   "icon" => $icon,
                                   "level" => $level,
                                   "link" => $MC->msg("Update Now"),
                                   "url" => $url
                                 );

  // make a JSON string
  $returnString = HCU_JsonEncode( $returnInfo );

  return $returnString;
} // end GetUserProfileUpdates

/**
 * #2647 Design JSON for Compass Menus to use. Composes a JSON string for digestion
 * by apps or web apps for the upper right menu represented by the "quick menu"
 * in the web app. Clients/consumers decide presentation.
 * https://docs.google.com/document/d/1I4f_uFYx03ZrZfl3YRhnEAjNG3XK-20B9Bjoy42lGMk
 * @param array $HB_ENV
 * @param object $dbh
 * @return string (JSON)
 *
 { "logout":{
    "display":"string",                   // dictionary entry
    "icon":"string",
    "action":"exit"
  },
  "activity":{
    "display":"string",                   // dictionary entry
    "icon":"string",
    "count":"number",
    "menuid":"number",
    "script":"script name",
    "action":"menu"
  },
  "messages":{
    "display":"string",                   // name from menu (monitor->banking menu)
    "icon":"string",
    "count":"number",
    "menuid":"number",
    "script":"script name",
    "action":"menu"
  },
  "status": {
    "display":"string",                   // dictionary entry
    "icon":"string",
    "count":"number",
    "endpoint":"url",                    // this url will return the formatted web content to display
    "action":"popup"
  },
  "user": {
    "display":"string",                   // dictionary entry
    "icon":"string",
    "count":"number",
    "action":"popup",
    "password": {
      "title": "string",
      "message": "string",
      "icon": "string",
      "level": "string",
      "link": "string",
      "script":"script name",
      "menuid":"number",
      "action":"menu"
    },
    "email": {
      "title": "string",
      "message": "string",
      "icon": "string",
      "level": "string",
      "link": "string",
      "script":"script name",
      "menuid":"number",
      "action":"menu"
    },
    "security": {
      "title": "string",
      "message": "string",
      "icon": "string",
      "level": "string",
      "link": "string",
      "script":"script name",
      "menuid":"number",
      "action":"menu"
    }
  }
}
 */
function CompassMenuJson($HB_ENV, $dbh) {

  $menu       = [];
  $items      = ['logout', 'activity', 'messages', 'status', 'user'];
  $menu_list  = CompassGetBankingMenu($HB_ENV, $dbh);

  foreach ($items as $item) {

    if (! CompassValidMenuItem($item, $HB_ENV, $dbh)) {
      continue;
    }

    $node = CompassMenuItem($item, $HB_ENV, $dbh, $menu_list);
    if ($item) {
      $menu[$item] = $node;
    }
  }

  return HCU_JsonEncode($menu);
}

/**
 * Get the banking menu configured in monitor ONCE as it is referred to for menu ID's and
 * titles throughout. We are doing an include here as it is only needed **here**, and
 * shouldn't be carried around by the other functions in this file.
 * @param array $HB_ENV
 * @param object $dbh
 * @return array
 */
function CompassGetBankingMenu($HB_ENV, $dbh) {

  require_once('sFeatureMnu.i');
  return FetchFeatureMenu($dbh, $HB_ENV['cu']);
}

/**
 * Don't show these items if they are not enabled.
 * @param string $item
 * @param array $HB_ENV
 * @param object $dbh
 * @return bool
 */
function CompassValidMenuItem($item, $HB_ENV, $dbh) {

  if ($item === 'messages') {
    return CompassValidateSecureMessages($HB_ENV);
  }

  if ($item == 'activity') {
    return CompassValidateUserMenu($HB_ENV, $dbh);
  }

  return true;
}

/**
 * Validate secure messages are enabled.
 * @param array $HB_ENV
 * @return bool
 */
function CompassValidateSecureMessages($HB_ENV) {

    if (
      ($HB_ENV['Fset2'] & GetFlagsetValue("CU2_ALLOWMESSAGE")) !=
      GetFlagsetValue("CU2_ALLOWMESSAGE")
    ) {
      return false;
    }

    return true;
}

/**
 * Validate transfers are enabled. This is all this menu node is for, AT's are account transfers.
 * @param object $dbh
 * @param array $HB_ENV
 * @return bool
 */
function CompassValidateUserMenu($HB_ENV, $dbh) {

  $tx_types = Get_HaveTrans($dbh,$HB_ENV);
  return in_array('AT', array_keys($tx_types));
}

/**
 * Call appropriate function to output menu item by key. This is loosely constructed after
 * the Mediator or Strategy pattern: give me the item name and I will return the
 * appropriate chunk of data for the node.
 * @param string $item
 * @param array $HB_ENV
 * @param object $dbh
 * @param array $menu_list, array of items from the monitor banking menu
 * @return array|null
 */
function CompassMenuItem($item, $HB_ENV, $dbh, $menu_list)
{
  switch ($item) {
    case 'logout':
      return CompassLogout($HB_ENV, $menu_list);
    case 'activity':
      return CompassActivity($HB_ENV, $dbh, $menu_list);
    case 'messages':
      return CompassMessages($HB_ENV, $dbh, $menu_list);
    case 'status':
      return CompassStatus($HB_ENV, $menu_list);
    case 'user':
      return CompassUser($HB_ENV, $menu_list);
    default:
      return null;
  }
}

/**
 * Helper for CompassMenuJson(), generate the logout node.
 * @param $HB_ENV
 * @param array $menu_list, array of banking items from monitor banking menu
 * @return array
 */
function CompassLogout($HB_ENV, $menu_list) {

  list (, $title) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, 'hcuLogout.prg', 'Sign Out');

  return [
    'display' => $title,
    'icon'    => 'power-off',
    'action'  => 'exit',
    // Useless to web front end without, ignore if not needed
    'script'  => 'hcuLogout.prg'
  ];
}

/**
 * Used by all Compass functions to set title and menu item ID. Returning an array so we only
 * walk through this large array once for each menu item. To get id and title individually
 * would require walking this large array twice.
 * @param array $HB_ENV
 * @param array $menu_list, array of banking menu items from monitor
 * @param string $script, the closest we get to a unique identifier for monitor banking menu
 * @param string $default
 * @param bool $banking_menu - if true = get from Monitor->Banking Menu, false = dictionary entry
 * @return array
 */
function CompassGetMenuIdAndTitle(
    $HB_ENV,
    $menu_list,
    $script = 'hcuAccounts.prg',
    $default = 'Menu Item',
    $banking_menu = false
  ) {

  $lang = ($HB_ENV['MC']->lang)?? ($HB_ENV['Flang'])?? 'en_US';

  if ($banking_menu) {
    return CompassBankingMenuTitle($menu_list, $script, $lang, $default);
  }

  if (isset($HB_ENV['MC'])) {

    $title = $HB_ENV['MC']->msg($default, HCU_DISPLAY_AS_HTML);

    if (empty($title)) {
      return [0, $default];
    }

    return [0,$title];
  }

  return [0, $default];
}

/**
 * A bit of fuzzy logic: there is no unique identifier in cu_featuremenu that is immutable
 * either by admin or by CU ID. The closest we have is a match on script (href) and
 * possibly extra params. In the context of the compass menu, this will work for
 * now,  but the possibility exists that future additions to the compass menu
 * may break it.
 * @param array $menu_list
 * @param string $script
 * @param string $lang
 * @param string $default (always overwritten; this placeholder alerts us to a problem
 *        without interruption of service)
 * @return array
 */
function CompassBankingMenuTitle($menu_list, $script, $lang = 'en_US', $default = 'Menu Item') {

  if (! isset($menu_list['data'])) {
    return [0, $default];
  }

  foreach ($menu_list['data'] as $menu_arr) {
    // @TODO: There is a typo in the DB JSON: for SCRUBCU 'Secure Message' instead of 'Secure Messages'
    // @TODO The fallout is that the Compass menu will now read singular and there will be no value
    // @TODO for Polish.
    $arr = [
      'en_US' => 'details_display_en_US',
      'es_US' => 'details_display_es_US',
      'pl_US' => 'details_display_pl_US'
    ];

    if ($menu_arr['details_href'] == $script) {
      return [$menu_arr['MenuItemId'], $menu_arr[$arr[$lang]]];
    }
  }

  return [0, $default];
}

/**
 * Helper for CompassMenuJson(), compose the user activity node.
 * @param array $HB_ENV
 * @param $dbh, database object
 * @param array $menu_list, monitor banking menu list.
 * @return array
 */
function CompassActivity($HB_ENV, $dbh, $menu_list) {

  list ($menu_id, $title) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, 'hcuUserActivity.prg', 'User Activity', true);
  return [
    'display' => $title,
    'icon'    => 'bell',
    'count'   => CompassCountUserActivity($HB_ENV, $dbh),
    'menuid'  => $menu_id,
    'script'  => 'hcuUserActivity.prg',
    'action'  => 'menu'
  ];
}

/**
 * Helper for CompassMenuJson(), count the relevant items for user activity.
 * Note that "count" should translate to "+9" in GUI if more than 8.
 * @param array $HB_ENV
 * @param $dbh, database object
 * @return int
 */
function CompassCountUserActivity($HB_ENV, $dbh)
{
  $count          = 0;
  $ucTransactions = ReturnUnconfirmedTransactions($dbh, $HB_ENV);

  if (is_array($ucTransactions)) {
    foreach ($ucTransactions as $key => $value) {

      $canConfirm = Perm_AccessRights($dbh, $HB_ENV, ["feature" => $value['feature_code']]);

      if ($canConfirm['confirm']) {
        $count++;
      }
    }
  }

  return $count;
}

/**
 * Helper for CompassMenuJson(), secure messages. Note that "count" should translate
 * to "+9" in the GUI if more than 8.
 * @param array $HB_ENV
 * @param $dbh, database object
 * @param array $menu_list, array of banking items from monitor banking menu
 * @return array
 */
function CompassMessages($HB_ENV, $dbh, $menu_list) {

  list ($menu_id, $title) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, 'hcuSecureMail.prg', 'Secure Messages', true);

  return [
    'display' => $title,
    'icon'    => 'comments',
    'count'   => ReturnUnreadSecureMsg($dbh, $HB_ENV),
    'menuid'  => $menu_id,
    'script'  => 'hcuSecureMail.prg',
    'action'  => 'menu'
  ];
}

/**
 * Helper for CompassMenuJson(), compose user status node.
 * @param array $HB_ENV
 * @param array $menu_list, array of banking items from monitor banking menu
 * @return array
 */
function CompassStatus($HB_ENV, $menu_list) {

  list ($menu_id, $title) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, 'hcuAccountStatus.prg', 'Login Status');

 $stat_arr   = [
    'display'   => $title,
    'icon'      => 'tasks',
    'count'     => 0,
    'endpoint'  => "{$HB_ENV['homebankingpath']}/hcuAccountStatus.prg?{$HB_ENV['cuquery']}",
    'action'    => 'popup'
  ];

  // These are not used by the mobile app, but are useFUL for the web render. They are
  // also used to update the parent status count.
  $failed     = CompassLastFailedLogin($HB_ENV, $menu_list);
  $prior      = CompassPriorLogin($HB_ENV, $menu_list);
  $sys        = CompassSystemStatus($HB_ENV, $menu_list);

  if ($prior) {
    $stat_arr['prior'] = $prior;
  }

  if ($failed) {
    $stat_arr['fail'] = $failed;
  }

  $stat_arr['system'] = $sys;

  // Update count after we've compiled the child arrays.
  $stat_arr['count'] = CompassCountWarnings($stat_arr);

  return $stat_arr;
}

/**
 * Helper for CompassStatus(), compose last failed login node.
 * @param array $HB_ENV
 * @param array $menu_list
 * @return array|null
 */
function CompassLastFailedLogin($HB_ENV, $menu_list) {

  list ($menu_id, $title) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, '', 'Failed Login');

  if (isset($HB_ENV['Fflog']) && ! empty($HB_ENV['Fflog'])) {

    $log_level = (isFailedExceedsPrior($HB_ENV))? 'error' : 'info';

    return [
      'title' => $title,
      'date'  => date("D M d, Y h:ia", strtotime($HB_ENV['Fflog'])),
      'level' => $log_level
    ];
  }

  return null;
}

/**
 * Helper for CompassLastFailedLogin(). If failed login exceeds previous successful login,
 * used to modify log level.
 * @param array $HB_ENV
 * @return bool
 */
function isFailedExceedsPrior($HB_ENV) {

  if (strtotime($HB_ENV['Fflog']) > strtotime($HB_ENV['Fplog'])) {
    return true;
  }

  return false;
}

/**
 * Helper for CompassStatus(), set prior successful login node.
 * @param array $HB_ENV
 * @param array $menu_list
 * @return array|null
 */
function CompassPriorLogin($HB_ENV, $menu_list) {

  list ($menu_id, $title) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, '', 'Last Login');

  if (isset($HB_ENV['Fplog']) && ! empty($HB_ENV['Fplog'])) {
    return [
      'title' => $title,
      'date'  => date("D M d, Y h:ia", strtotime($HB_ENV['Fplog'])),
      'level' => 'info'
    ];
  }

  return null;
}

/**
 * Helper for CompassStatus(), compose current user status node.
 * @param array $HB_ENV
 * @param array $menu_list
 * @return array
 */
function CompassSystemStatus($HB_ENV, $menu_list) {

  list ($sys_msg, $level) = DisplayLastDataMsg($HB_ENV);
  list (, $title) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, '', 'Account Status as of');
  return [
      'title' => $title,
      'date'  => $sys_msg,
      'level' => $level
    ];
}

/**
 * Nicked from hcuPreContent, display status message. Generally this will just
 * be a date.
 * @param array $HB_ENV
 * @return array
 */
function DisplayLastDataMsg($HB_ENV) {

  $level          = 'info';
  $infoDataNotify = GetInfoDataNotify($HB_ENV);

  if ($infoDataNotify) {
      $level = 'error';

    if ($HB_ENV['packetStatus']['status'] == '999') {

        $msg =
        <<< DATAMSG
          {$HB_ENV['MC']->msg('Unable to load')}:
          <!--<br/>
          {$HB_ENV['MC']->msg('Credit Union responded')}:
          {$HB_ENV['packetStatus']['reason']} ({$HB_ENV['packetStatus']['status']})-->
          <br>
          {$HB_ENV['MC']->msg('Please try again later')}
DATAMSG;
    } else {
      $msg = $HB_ENV['MC']->msg('Credit Union not responding');
    }
  } else {
    $msg = isset($HB_ENV['lastupdate']) ?date("D M d, Y h:ia", strtotime($HB_ENV['lastupdate'])) : null;
  }

  return [$msg, $level];
}

/**
 * Nicked from hcuPreContent, because there is no function for it.
 * @param array $HB_ENV
 * @return bool
 */
function GetInfoDataNotify($HB_ENV) {

  if ($HB_ENV['live']) {
    $curPacketStatusAry = HCU_array_key_value('packetStatus', $HB_ENV);
    if (in_array(HCU_array_key_value('status', $curPacketStatusAry), ['999'])) {
      return true;
    }
  }

  return false;
}

/**
 * Use GetUserProfileUpdates() to get items for the user node of the JSON.
 * @param $HB_ENV
 * @param array $menu_list, array of banking items from monitor banking menu
 * @return array
 */
function CompassUser($HB_ENV, $menu_list) {

  // Default URL for user profile is empty in DB, but we are using dictionary here.
  list ($menu_id, $utitle) = CompassGetMenuIdAndTitle($HB_ENV, $menu_list, '', 'User Info');
  $user_data = HCU_JsonDecode(GetUserProfileUpdates($HB_ENV));

  $nodes      = [
    'password'  => 'hcuProfilePwd.prg',
    'security'  => 'hcuProfileSecurity.prg',
    'email'     => 'hcuProfileEmail.prg',
  ];

  $user_arr   = [
    'display' => $utitle,
    'icon'    => 'user',
    'count'   => CompassCountWarnings($user_data),
    'action'  => 'popup'
  ];

  foreach ($nodes as $node => $script) {

    if (isset($user_data[$node])) {
      $user_arr[$node] = CompassUserSubItems($HB_ENV, $menu_list, $script, $node, $user_data);
    }
  }

  return $user_arr;
}

/**
 * Helper for CompassUser(), compile the child array members for the user node.
 * @param array $HB_ENV
 * @param array $menu_list
 * @param string $script
 * @param string $node password|email|security
 * @param array $user_data
 * @return array
 */
function CompassUserSubItems($HB_ENV, $menu_list, $script, $node, $user_data) {

  // Spec does not indicate using banking menu for title, but uses ID.
  // Leaving title from GetUserProfileUpdates(). To overwrite simply
  // add the line $user_arr['title'] = $title
  list ($menu_id, $title) = CompassGetMenuIdAndTitle(
    $HB_ENV,
    $menu_list,
    $script,
    ($user_data['email']['title'])?? null,
    true
  );

  // Don't need with scriptname in place
  unset($user_data['url']);

  $user_arr           = $user_data[$node];
  $user_arr['script'] = $script;
  $user_arr['menuid'] = $menu_id;
  $user_arr['action'] = 'menu';

  return $user_arr;
}

/**
 * Helper for Compass[x] functions, count warning messages to save to array. Used to
 * display the "badge" in the GUI (with count)
 * @param $data
 * @return int
 */
function CompassCountWarnings($data) {

    $count = 0;

    foreach ($data as $arr) {
      if (IsCompassErrorWarning($arr)) {
        $count++;
      }
    }

    return $count;
}

/**
 * Check the level array member, if there is one, for warning or error. Used to increment
 * the count of notices for each node to display the "badge" in the GUI (with count)
 * @param array $arr
 * @return bool
 */
function IsCompassErrorWarning($arr = [])
{
  return
    is_array($arr) &&
    isset($arr['level']) &&
    ! empty($arr['level']) &&
    in_array($arr['level'], ['warning', 'error']);
}