mFeatureMnu.data

<?php
/**
 *  mFeatureMnu.data
 *
 *  This script will accept requests from the presentation and interact with the database
 *  for those requests.  Some of those can be:
 *    Create
 *    Read
 *    Update
 *    Delete
 *
 *  ** ERROR STATES **
 *    900 - permissions failed for accessing this script
 *    910 - Invalid API action encountered
 *    950 - Transaction Failure
 *      951 - Unable to delete row
 *      952 - Unable to Relate Child to Parent
 *      953 - Unable to Insert Row
 *      954 - Unable to Commit Work
 *      955 - Error Response when throwing from Exception to ErrorException
 *
 *  MWS 10/24/2016
 *
 */

  /* *** FORM VARIABLES *** */
  $homecuSharedLibrary = dirname(__FILE__) . "/../../shared/library";
  $homecuMonitorLibrary = dirname(__FILE__) . "/../../monitor/library";

  $importValues = Array();

  /* *** */
  try {

  /* ** PREVENT UNAUTHORIZED USE ** */
    /* * Authenticate Session * */

    require_once("$homecuMonitorLibrary/cu_top.i");
    require_once("$homecuMonitorLibrary/ck_hticket.i");
    require_once("$homecuSharedLibrary/dms_imp_val.i");

    require_once("$homecuSharedLibrary/sFeatureMnu.i");

/*
    if (!CheckPerm($dbh, $Hu, basename($_SERVER['SCRIPT_NAME']), $_SERVER['REMOTE_ADDR'])) {
      // ** Permissions failed
      // ** this being a .data does not redirect

      throw new ErrorException ('Permissions Failed', '900');
    }
*/
    /* * IMPORT VARIABLES * */
    $importFieldAry = Array (
                          "cu" => array('filter' => FILTER_SANITIZE_STRING),
                          "api_action" => array('filter' => FILTER_VALIDATE_REGEXP, 'options' => array('options' => array('regexp' => '/ignore|update|read|delete|settings/')))
                            );
/*  OK TO REMOVE
 *                                 $input_array = array("col1"=>array('filter'=>FILTER_VALIDATE_INT),
 *                                                      "col2"=>array('filter'=>FILTER_SANITIZE_FULL_SPECIAL_CHARS),
 *                                                      "col3"=>array('filter'=>FILTER_VALIDATE_INT, 'flags'=>FILTER_REQUIRE_ARRAY),
 *                                                      "col4"=>array('filter'=>FILTER_VALIDATE_REGEXP), 'options'=>array('regexp'=>'/[0-9]* /'))
 *
 * @return true                 - Always returns true
 *
 */
    HCU_ImportVars($importValues, '', $importFieldAry);
    switch ($importValues['api_action']) {
      case 'settings':
        /*
         *  RETURN form SETTINGS for:
         *    Menu Icons
         *    Feature List
         *    Platform Types
         *    Script Names
         */
        $retVal = Array("homecuData"=>Array());

        /* ** Get Menu Icons ** */
        $iconListAry = GetFeatureMenuIcons();
        $retVal['homecuData']['menuicons'] = ($iconListAry['code'] == '000' ? $iconListAry['data'] : Array());

        /* ** Get Menu Platforms ** */
        $platformListAry = GetFeatureMenuPlatforms();
        $retVal['homecuData']['menuplatforms'] = ($platformListAry['code'] == '000' ? $platformListAry['data'] : Array());

        /* ** Get Feature List ** */
        $featureListAry = GetFeatureList($dbh);
        $retVal['homecuData']['features'] = ($featureListAry['code'] == '000' ? $featureListAry['data'] : Array());

        /* ** Get Banking Screen ** */
        $screenListAry = GetBankingScripts();
        $retVal['homecuData']['scripts'] = ($screenListAry['code'] == '000' ? $screenListAry['data'] : Array());

        /* ** Get Available Languages ** */
        $langListAry = GetSelectLang($dbh, $importValues['cu']);
        // ** For this option default the English language to ON
        $retVal['homecuData']['lang'] = ($langListAry['code'] == '000' ? $langListAry['data'] : Array("en_US" => true));
        /* ** DATA COLLECTED ** */
        /* ** RETURN RESULTS ** */
        LocalPrintJson($retVal);

        break;
      case 'read':
        $menuList    = Array();    // ** Menu List being built

        // ** Call the FetchFeatureMenu and return the results.  This will return all platform types
        $featureMenuResults = FetchFeatureMenu($dbh, $importValues['cu']);
        if ($featureMenuResults['code'] == '000') {
          if (count($featureMenuResults['data']) == 0) {
            $featureMenuResults = FetchDefaultFeatureMenu($dbh, $importValues['cu']);
            if ($featureMenuResults['code'] != '000') {
             // Default Data Should be loaded - otherwise throw error
             throw new ErrorException ("Unable to retrieve menu list");
            }
          }
        } else {
          // Default Data Should be loaded - otherwise throw error
          throw new ErrorException ("Unable to retrieve menu list");

        }


        if (is_array($featureMenuResults['data'])) {
          $dataStoreMenu = $featureMenuResults['data'];       // Menu as returned from the database or default template


          $gridOrder   = 0;          // ** Grid Order value
          $lastParentId = null;        //  Last Parent Group ID
          $lastItemType = '';       // ** Menu Item Type of the last Parent Group
          for ($menuIdx = 0; $menuIdx < count($dataStoreMenu); $menuIdx++) {
            // ** loop through the array and at the end of a "parent" group add a "add item link"
            $itemType  = HCU_array_key_value('MenuItemType', $dataStoreMenu[$menuIdx]);
            $menuItemId = HCU_array_key_value('MenuItemId', $dataStoreMenu[$menuIdx]);
            // For new groups we may need to add a previous "Add Item" record
            if ( $itemType != 'D' && $lastParentId !== $menuItemId ) {
              // ** Different Group -- Do we need to record an 'Add Item' record
              if ($lastItemType == 'H') {
                // ** ** ADD ITEM ** **
                $menuList[] = LocalAddItem($gridOrder++, -9999, $lastParentId);
              }

              // ** SET THE NEW VALUES
              $lastParentId = $menuItemId;
              $lastItemType = $itemType;
            }

            // ** ** ADD THE MENU ITEM ** **
            $newMenuItem = $dataStoreMenu[$menuIdx];
            //  ** Need to add Grid Order
            $newMenuItem['GridOrder'] = $gridOrder++;
            $menuList[] = $newMenuItem;
          }
          // ** After we're done
          // ** Do we add a new Group "add item"?
          if ($lastItemType == 'H') {
            // ** ** ADD ITEM ** **
            $menuList[] = LocalAddItem($gridOrder++, -9999, $lastParentId);
          }
          // ** ALWAYS ADD A add Menu group Item
          $menuList[] = LocalAddItem($gridOrder, -9999, null);
        }


        $retVal['homecuData']['featuremenu'] = $menuList;


        /* ** DATA COLLECTED ** */
        /* ** RETURN RESULTS ** */
        LocalPrintJson($retVal);

        break;
      case 'update':

        /*
         * Update Rules
         *
         * Structure of the update should have 4 elements
         * cu         - CU Code
         * api_action - What is being done (update)
         * data       - consists of
         *   deleted  - json string deleted rows
         *   updated  - json string of updated rows
         *
         * *** NOTE:: ****
         * Because I want to handle both updated and deleted at the same time, I am sending over the data
         * in a less traditional manner  The objects are being converted to json string and being sent as
         *      data_deleted
         *      data_udpated
         *
         * This is import as I will need to decode these values and json decode them before I can use them
         */
        try {
          $retVal = Array("homecuData"=>Array());

          $updateValues = Array();
          $importFieldAry = Array (
                                    "data_deleted" => array('filter' => FILTER_SANITIZE_STRING),
                                    "data_updated" => array('filter' => FILTER_SANITIZE_STRING)
                                  );
          HCU_ImportVars($updateValues, '', $importFieldAry);

          $recCountDel = 0;
          $recCountUpd = 0;
          $recCountIns = 0;


          $delRecords = HCU_JsonDecode(html_entity_decode($updateValues['data_deleted']));

          $updRecords = HCU_JsonDecode(html_entity_decode($updateValues['data_updated']));


          /* **** START TRANSACTION / WORK **** */
          if (!db_work($dbh, HOMECU_WORK_BEGIN)) {
            // ** This should bypass the first try/catch is it is only catching Exception
            throw new ErrorException ('Could not start transaction', 950);
          }


          /* **** DELETE RECORDS **** */
          if (count($delRecords) > 0) {

            // ** Loop through each record and record them
            for ($delIdx = 0; $delIdx < count($delRecords); $delIdx++) {

              if (HCU_array_key_exists("MenuItemId", $delRecords[$delIdx])) {
                // ** Found the MenuItemId in the row
                // ** make sure it is > 0
                $delMenuId = intval(HCU_array_key_value("MenuItemId", $delRecords[$delIdx]));
                if ($delMenuId > 0) {
                  $recordValues = Array(
                                        'cu' => $importValues['cu'],
                                        'menu_item_id' => $delMenuId
                                       ); /// ** SET RECORD VALUES FOR DELETE

                  // ** This appears to be a valid record ID.. Delete it
                  $updDel = FeatureMenuDeleteItem($dbh, $recordValues);
                  $recCountDel++;
                  if (!$updDel) {
                    throw new Exception ('Unable to delete MenuItemId ' . $delMenuId, 951);
                  }

                }
              }

            }
          }

          /* **** PASS ONE **** */
          /* *** ORDER ARRAY by GridOrder *** */
          usort($updRecords, function ($item1, $item2) {
            // ** This should order the results in order of GridOrder. (PHP 7 COMPAT ONLY)
              //** This should help maintain the order as new menu group/items are
              // ** added and the MenuItemId needs to be recorded
            return $item1['GridOrder'] <=> $item2['GridOrder'];

          });


          /* **** PASS TWO **** */
          /* *** LOOP THROUGH ARRAY *** */
          $newParentIdLookup = Array();           // ** Array for looking up the New Parent ID Sequence number
          $platformList      = Array("D" => "dsk", "M" => "mbl", "A" => "app");
          $cuLangOptions     = GetSelectLang($dbh, $importValues['cu']);
          $langList          = $cuLangOptions['data'];

          if (count($updRecords) > 0) {
            // * Update Records found
            for ($recIdx = 0; $recIdx < count($updRecords); $recIdx++) {
              if (HCU_array_key_exists("MenuItemId", $updRecords[$recIdx])) {
                $curRecord = $updRecords[$recIdx];
                /**
                 *  Do not update any MenuItemId with value -9999
                 *    // These are record holders for new rows
                 *
                 *
                 *
                 */
                $menuId = HCU_array_key_value("MenuItemId", $curRecord);
                $parentId = HCU_array_key_value("ParentId", $curRecord);

                if ($menuId != -9999) {
                  // ** Record the Current Payment Group
                  $recordValues = Array(); /// ** RESET RECORD VALUES

                  /* *** SET RECORD VALUES *** */
                    // ** The data being returned is not compatible with the database
                    // ** Need to evaluate the data being sent and convert into the record columns

                    /**
                     *  Notes on updating parent/child relationship
                     *  It is required that the parent child relationship must be in the order of Parent then Child
                     *  When a NEW Group is saved, it will record it's Old Parent ID, newParentId in an array
                     *    * any children that reference the old Parent ID, will change to the new Parent ID
                     */
                  /*
                   * ** COLUMNS
                   * ** ** menu_item_id
                   * ** ** cu
                   * ** ** display_order
                   * ** ** feature_code
                   * ** ** parent_item_id
                   * ** ** menu_item_type
                   * ** ** menu_item_platform
                   * ** ** menu_item_attr
                   */
                  /* ** menu_item_id ** */
                  if ($menuId < 0) {
                    $recordValues['menu_item_id'] = 'nextval';  // This will trigger the next function to use a SERIAL VALUES
                  } else {
                    $recordValues['menu_item_id'] = $menuId;
                  }

                  /* ** cu ** */
                  $recordValues['cu'] = $importValues['cu'];

                  /* ** display_order ** */
                  $recordValues['display_order'] = intval(HCU_array_key_value('DisplayOrder', $curRecord));

                  /* ** menu_item_type ** */
                  $recordValues['menu_item_type'] = HCU_array_key_value('MenuItemType', $curRecord);

                  /* ** feature_code ** */
                  $recordValues['feature_code'] = HCU_array_key_value('FeatureCode', $curRecord);

                  /* ** parent_item_id ** */
                  if ($recordValues['menu_item_type'] == 'D') {
                    /* * CHILD MENU ITEM */
                    $tempParentId = intval(HCU_array_key_value('ParentId', $curRecord));
                    if ($tempParentId < 0) {
                      // ** Need to lookup in the parent lookup list
                      if (HCU_array_key_exists($tempParentId, $newParentIdLookup)) {
                        $tempParentId = HCU_array_key_value($tempParentId, $newParentIdLookup);
                      } else {
                        // ** SOMETHING IS WRONG !!! -- There should have been a value -- FOR NOW EXIST
                        throw new Exception ('Unable to relate child to parent', 952);
                      }
                    }  // else  child already has correct parent id
                  } else {
                    /* * HEADER / STANDALONE MENU LINK * */
                    /* ALWAYS NULL */
                    $recordValues['parent_item_id'] = 'null';
                    $tempParentId = 'null';
                  }
                  $recordValues['parent_item_id'] = $tempParentId;

                  /* ** menu_item_platform ** */
                  // ** Build from details_platform_dsk, details_platform_mbl, details_platform_app
                  $tempMenuPlatform = Array();
                  reset($platformList);
                  foreach ($platformList as $platKey => $platField) {
                    $platFieldName = 'details_platform_' . $platField;
                    if (HCU_array_key_exists($platFieldName, $curRecord)) {
                      // ** Add if true
                      if (HCU_array_key_value($platFieldName, $curRecord)) {
                        $tempMenuPlatform[] = $platKey;
                      }
                    }
                  }

                  $recordValues['menu_item_platform'] = HCU_JsonEncode($tempMenuPlatform);

                  /* ** menu_item_attr ** */
                  $tempMenuAttr = Array();

                    /* ** Made up of the following; ** */

                  /* * display        * */
                  $tempLang = Array();
                  foreach ($langList as $langKey => $langVal) {
                    // ** Currently langVal is {true/false}, only evaluate if true
                    if ($langVal) {
                      $tempLang[$langKey] = HCU_array_key_value('details_display_' . $langKey, $curRecord);
                    }
                  }
                  $tempMenuAttr['display'] = $tempLang;

                  /* * fa-icon        * */
                    // ** ONLY FOR HEADER / MENU LEVEL LINKS (NO CHILDREN)
                  $tempIcon = '';
                  if ($recordValues['menu_item_type'] != 'D') {
                    $tempIcon = HCU_array_key_value('details_fa_icon', $curRecord);
                  }
                  $tempMenuAttr['fa-icon'] = $tempIcon;
                  $tempMenuAttr['collapseGroup'] = (HCU_array_key_value('details_collapse_group', $curRecord) == 1 ? 1 : 0);

                  $tempMenuAttr["memAcctFilter"]= HCU_array_key_exists("details_memacct_filter", $curRecord) ? $curRecord["details_memacct_filter"] : "";

                  /* *** THE FOLLOWING DO NOT APPLY TO HEADER *** */
                  if ($recordValues['menu_item_type'] != 'H') {
                    /* * href           * */
                    $tempMenuAttr['href'] = HCU_array_key_value('details_href', $curRecord);

                    /* * hrefUrlQuery   * */
                    $tempMenuAttr['hrefUrlQuery'] = (HCU_array_key_value('details_hrefUrlQuery', $curRecord) == 1 ? 1 : 0);

                    /* * target         * */
                    $tempMenuAttr['target'] = (HCU_array_key_value('details_target', $curRecord) == 1 ? 1 : 0);

                    /* * message         * */
                    $tempMenuAttr['externalMsg'] = (HCU_array_key_value('details_message', $curRecord) == 1 ? 1 : 0);

                    /* * hrefExtraParam * */
                    $tempMenuAttr['hrefExtraParam'] = HCU_array_key_value('details_hrefExtraParam', $curRecord);
                  }
                  /* ** menu_item_attr ** */
                  $recordValues['menu_item_attr'] = HCU_JsonEncode($tempMenuAttr);

                  // ** recordValues should now contain the updated values -- This will be passed to the appropriate function

                  /* *** INSERT / UPDATE RECORD *** */

                  $insertRow = FeatureMenuUpdateItem($dbh, ($menuId < 0 ? "INSERT" : "UPDATE"), $recordValues);
                  if ($insertRow === false) {
                    throw new Exception ('Unable to insert Menu Item', 953);
                  }
                  // ** insertRow will be the information returned, which will include the new menu_item_id column
                  $tempMenuId = intval(HCU_array_key_value('menu_item_id', $insertRow));


                  // * Create a lookup so we can translate the old id to new id
                    // ** INSERTED ITEMS ONLY
                    // ** This can be used by clien to update the screen
                  if ($menuId < 0) {
                    $newParentIdLookup[$menuId] = $tempMenuId;
                    $recCountIns++;
                  } else {
                    $recCountUpd++;
                  }

                }
              }
            }
          }

          /* ALL TRANSACTIONS ARE POSTED */
          /* **** COMMIT **** */

          if (db_work($dbh, HOMECU_WORK_COMMIT)) {
            $status = Array();
            $status[] = "Menu Updated";
            if ($recCountDel > 0) {
              $status[] = "$recCountDel Item(s) Deleted";
            }
            if ($recCountIns > 0) {
              $status[] = "$recCountIns Item(s) Inserted";
            }
            if ($recCountUpd > 0) {
              $status[] = "$recCountUpd Item(s) Updated";
            }
            $retVal['homecuData']['status'] = $status;

            $retVal['homecuData']['featuresave']['updateId'] = $newParentIdLookup;

            LocalPrintJson($retVal);   // Return success
          } else {
            throw new Exception ('Unable to commit!', 954);
          }

          /* **** END TRANSACTION / WORK **** */
        } catch (Exception $errWork) {
          // ** I want to trap Errors to the commit process separately
            // * If something goes wrong be sure to rollback
          $rollbackWork = db_work($dbh, HOMECU_WORK_ROLLBACK);
          throw new ErrorException ("Error during update!", 955);
        }
        break;
      case 'ignore':
        // ** Ignore this request ** //
        $retVal['homecuData']['featureignore'] = true;
        LocalPrintJson($retVal);   // Return success

        break;
      default:
        /* INVALID API ACTION */
        throw new ErrorException ('Invalid API Action', 910);
    }



  } catch ( Error $e) {



  } catch (ErrorException $e) {

    // ** All else fails
    $retVal['homecuData']  = Array();   // Zero out any information already in the array
    $retVal['homecuErrors'] = Array($e->getMessage());

    LocalPrintJson($retVal);
  }

  /**
   *  This will take the return array, json encode it, and print to stream and exit script
   *
   *  @param array $jsonDataArray  homecu array to be printed
   *
   *  @return none
   */
  function LocalPrintJson($jsonDataArray) {

    header('Content-type: application/json');

    print HCU_JsonEncode(Array("Results" => Array($jsonDataArray)));
    exit;
  }

  /**
   *  Returns a MenuItem row that is used to add a new menu item
   *
   * @param integer $pGridOrder    - Grid order to be assigned
   * @param integer $pMenuItemId   - The Menu Item Id to assign
   * @param mixed   $pParentId     - the parent id , this can be an integer for detail or null for adding menu group
   */
  function LocalAddItem($pGridOrder, $pMenuItemId, $pParentId) {

    return Array('GridOrder' => $pGridOrder, 'MenuItemId' => $pMenuItemId, 'ParentId' => $pParentId);

  }