mFeature.data

<?php
/**
 * @package mFeature.data
 * Purpose: Handle the CRUD portion of the Features feature in Monitor.  Return any requested data
 *            in a JSON format, for the client to display accordingly.
 *
 * Call this script with the following parameters
 * @param string $action : requested database action
 * @param string $featureList : comma separated list of features for multiple update
 * @param string $featureCode : single featureCode for create/update
 * @param string $featureDescription : single description for create/update
 * @param string $featureLimit : single limit_type for create/update
 *
 *
 * @return JSON OBJECT.
 */
header('Content-Type: application/json');

try {
  $monLibrary= dirname(__FILE__) . "/../library";
  require_once("$monLibrary/cu_top.i");

  $var_ok = array(
    "action" => array('filter' => FILTER_SANITIZE_STRING),
    "featureList" => array('filter' => FILTER_SANITIZE_STRING),
    "featureCode" => array('filter' => FILTER_SANITIZE_STRING),
    "featureDescription" => array('filter' => FILTER_SANITIZE_STRING),
    "featureLimit" => array('filter' => FILTER_SANITIZE_STRING),
  );

  HCU_ImportVars($MON_VARS, "", $var_ok );

  $action = isset($MON_VARS['action']) ? $MON_VARS['action'] : null;
  $featureList = isset($MON_VARS['featureList']) ? $MON_VARS['featureList'] : null;
  $featureCode = isset($MON_VARS['featureCode']) ? $MON_VARS['featureCode'] : null;
  $featureDescription = isset($MON_VARS['featureDescription']) ? $MON_VARS['featureDescription'] : null;
  $featureLimit = isset($MON_VARS['featureLimit']) ? $MON_VARS['featureLimit'] : null;

  $aryResult = array();
  $aryReply = array();

  switch ($action) {

    case "feature_create":

      // CREATE NEW FEATURE
      $aryResult = FeatureCreate($SYSENV, $dbh, $featureCode, $featureDescription, $featureLimit);
      break;

    case "feature_read":

      // GET FEATURE LIST
      $aryResult = FeatureReadList($SYSENV, $dbh);
      break;

    case "feature_edit":

      // EDIT FEATURE
      $aryResult = FeatureEdit($SYSENV, $dbh, $featureCode, $featureDescription, $featureLimit);
      break;

    case "feature_delete":

      // ENABLE FEATURES
      $aryResult = FeatureDelete($SYSENV, $dbh, $featureList);
      break;

    case "feature_enable":

      // ENABLE FEATURES
      $aryResult = FeatureEnable($SYSENV, $dbh, $featureList);
      break;

    case "feature_disable":

      // DISABLE FEATURES
      $aryResult = FeatureDisable($SYSENV, $dbh, $featureList);
      break;

    default:

      // ACTION UNKNOWN
      throw new Exception("Feature Action: ( $action ) unknown");
      break;
  }

} catch (Exception $e) {

  // ONLY SUPPLY ERRORS
  $aryReply['errors'] = $e->getMessage();

  $aryResult['data'] = array();
  $aryResult['info'] = array();
}

$aryReply['action'] = $action;
if (isset($aryResult['data']) && count($aryResult['data'])) $aryReply['data'] = $aryResult['data'];
if (isset($aryResult['info']) && count($aryResult['info'])) $aryReply['info'] = $aryResult['info'];

print json_encode(Array("Results" => $aryReply));

/**
 *  FeatureSetup:
 *  - format the data being returned to the client side code
 *
 *  @param array $pQuery : query result containing rows of data for setup
 *
 *  @return array $sqlReturn : formatted data
 */
function FeatureSetup($pData) {
  // BUILD RETURN DATA
  $dataReturn = array();

  if ($pData == null) { return $dataReturn; }

  foreach ($pData as $key => $value) {

    $feature = array();
    $feature['featureCode'] = trim($value['feature_code']);
    $feature['featureDescription'] = trim($value['description']);
    $feature['featureLimit'] = trim($value['limit_type']);
    $feature['featureEnabled'] = $value['enabled'] == 't' ? true : false;

    $dataReturn[] = $feature;
  }

  return $dataReturn;
}

/**
 *  FeatureInUse:
 *  - this function used to determine featureCode dependancy, if a feature is
 *    currently being used by a CU
 *
 *  @param object $pDbh : database reference for access and manipulation of data
 *  @param string $pFeature : featureCode to be checked
 *
 *  @return array $numSelectRs : 0: no rows found, not in use, 1: rows have been found, in use
 */
function FeatureInUse($pDbh, $pFeature) {

  // SQL STRING FOR cu_featuremenu
  $sqlSelectFm = "SELECT feature_code FROM cu_featuremenu
    WHERE btrim(feature_code) = $pFeature";

  // QUERY
  $sqlSelectRs = db_query($sqlSelectFm, $pDbh);
  $numSelectRs = pg_num_rows($sqlSelectRs);

  return $numSelectRs != 0;
}

/**
 *  FeatureDelete:
 *  - delete a list of user defined global features, these features can only be deleted
 *    if they are not currently in use by a CU. These features will be permanently deleted
 *    from the database table.
 *
 *  @param object $pDbh : database reference for access and manipulation of data
 *  @param string $pFeatures : comma-separated list of featureCode to be deleted
 *
 *  @return array $sqlReturn : array containing the list of deleted featureCode and success information
 */
function FeatureDelete($pEnv, $pDbh, $pFeatures) {

  $sqlReturn = array();

  // EXPLODE DATA
  $features = "";
  $featureAry = array();
  $featureList = explode(',', $pFeatures);

  foreach ($featureList as $key => $value) {
    // PREP_SAVE
    $feature = "'" . prep_save($value, 10) . "'";
    $inUse = FeatureInUse($pDbh, $feature);

    if ($inUse) {
      // CANNOT DELETE, FEATURE IS IN USE
      $sqlReturn['info'][] = "( $feature ) cannot be deleted, it is currently in use\n";
    } else {
      array_push($featureAry, $feature);
      $sqlReturn['info'][] = "( $feature ) was deleted successfully\n";
    }
  }

  // IMPLODE FOR DELETE
  $features  = implode(",", $featureAry);

  // SQL STRING FOR DELETE
  $sqlDelete = "DELETE FROM cu_feature
    WHERE feature_code IN ($features)
    RETURNING feature_code, description, limit_type, enabled";

  // QUERY
  $sqlDeleteRs = db_query($sqlDelete, $pDbh);
  if (!$sqlDeleteRs) {
    $pEnv['logger']->error(db_last_error());
    throw new Exception("Feature deleted has failed");
  }

  $sqlDataRs = db_fetch_all($sqlDeleteRs);
  $sqlReturn['data'] = FeatureSetup($sqlDataRs);

  return $sqlReturn;
}

/**
 *  FeatureEnable:
 *  - enable a list of user defined features, these features will become available
 *    for use by credit unions.
 *
 *  @param object $pDbh : database reference for access and manipulation of data
 *  @param string $pFeatures : comma-separated list of featureCode to be enabled
 *
 *  @return array $sqlReturn : array containing a list of only the features which have been updated
 *    along with success information
 */
function FeatureEnable($pEnv, $pDbh, $pFeatures) {

  $sqlReturn = array();

  // EXPLODE DATA
  $features = "";
  $featureList = explode(',', $pFeatures);

  foreach ($featureList as $key => $value) {
    // PREP_SAVE
    $featureList[$key] = "'" . prep_save($value, 10) . "'";
  }

  // IMPLODE FOR DELETE
  $features  = implode(",", $featureList);

  // SQL STRING FOR UPDATE
  $sqlUpdate = "UPDATE cu_feature
    SET enabled = TRUE
    WHERE feature_code IN ($features)
    RETURNING feature_code, description, limit_type, enabled";

  // QUERY & ERROR CHECK
  $sqlUpdateRs = db_query($sqlUpdate, $pDbh);
  if (!$sqlUpdateRs) {
    $pEnv['logger']->error(db_last_error());
    throw new Exception("Feature update has failed");
  }

  // GATHER DATA ROWS AND INFO
  $sqlDataRs = db_fetch_all($sqlUpdateRs);
  $sqlReturn['data'] = FeatureSetup($sqlDataRs);
  $sqlReturn['info'][] = "Feature update was successful\n";

  return $sqlReturn;
}

/**
 *  FeatureDisable:
 *  - disable a list of user defined global features, these features will no
 *    longer be available to creditunions until enabled again
 *
 *  parameters:
 *  @param object $pDbh : database reference for access and manipulation of data
 *  @param string $pFeatures : comma separated list of featureCode to be disabled
 *
 *  @return array $sqlReturn : array containing a list of only the features which have been updated
 *    along with success information
 */
function FeatureDisable($pEnv, $pDbh, $pFeatures) {

  $sqlReturn = array();

  // EXPLODE DATA
  $features = "";
  $featureList = explode(',', $pFeatures);

  // PREP_SAVE
  foreach ($featureList as $key => $value) {
    $featureList[$key] = "'" . prep_save($value, 10) . "'";
  }

  // IMPLODE FOR DELETE
  $features  = implode(",", $featureList);

  // SQL STRING FOR UPDATE
  $sqlUpdate = "UPDATE cu_feature
    SET enabled = FALSE
    WHERE feature_code IN ($features)
    RETURNING feature_code, description, limit_type, enabled";

  // QUERY & ERROR CHECK
  $sqlUpdateRs = db_query($sqlUpdate, $pDbh);
  if (!$sqlUpdateRs) {
    $pEnv['logger']->error(db_last_error());
    throw new Exception("Feature update has failed");
  }

  // GATHER DATA ROWS AND INFO
  $sqlDataRs = db_fetch_all($sqlUpdateRs);
  $sqlReturn['data'] = FeatureSetup($sqlDataRs);
  $sqlReturn['info'][] = "Feature update was successful\n";

  return $sqlReturn;
}

/**
 *  FeatureEdit:
 *  - edit a current global feature available from homecu
 *
 *  @param object $pDbh : database reference for access and manipulation of data
 *  @param string $pCode : featureCode, feature name
 *  @param string $pDescription : description, feature description
 *  @param string $pLimit : limit_type, feature limit_type
 *
 *  @return array $sqlReturn : array containing data and success/failure information
 */
function FeatureEdit($pEnv, $pDbh, $pCode, $pDescription, $pLimit) {

  // PREP_SAVE
  $code = strtoupper($pCode);
  $code = prep_save($code, 10);

  $desc = html_entity_decode($pDescription, ENT_QUOTES);
  $desc = prep_save($desc, 255);

  $limit = strtoupper($pLimit);
  $limit = prep_save($limit, 1);

  // SQL STRING FOR UPDATE
  $sqlUpdate = "UPDATE cu_feature
    SET (description, limit_type) = ('$desc', '$limit')
    WHERE feature_code = '$code'
    RETURNING feature_code, description, limit_type, enabled";

  // QUERY & ERROR CHECK
  $sqlUpdateRs = db_query($sqlUpdate, $pDbh);
  if (!$sqlUpdateRs) {
    $pEnv['logger']->error(db_last_error());
    throw new Exception("Feature update has failed");
  }

  // GATHER DATA ROWS AND INFO
  $sqlDataRs = db_fetch_all($sqlUpdateRs);
  $sqlReturn['data'] = FeatureSetup($sqlDataRs);
  $sqlReturn['info'][] = "Feature update was successful\n";

  return $sqlReturn;
}

/**
 *  FeatureCreate:
 *  - create new global feature to be available from homecu
 *
 *  @param object $pDbh : database reference for access and manipulation of data
 *  @param string $pCode : featureCode, feature name
 *  @param string $pDescription : description, feature description
 *  @param string $pLimit : limit_type, feature limit_type
 *
 *  @return array $sqlReturn : array containing data and success/failure information
 */
function FeatureCreate($pEnv, $pDbh, $pCode, $pDescription, $pLimit) {

  // PREP_SAVE
  $code = strtoupper($pCode);
  $code = prep_save($code, 10);

  $desc = html_entity_decode($pDescription, ENT_QUOTES);
  $desc = prep_save($desc, 255);

  $limit = strtoupper($pLimit);
  $limit = prep_save($limit, 1);

  // SQL STRING FOR CREATE/INSERT
  $sqlInsert = "INSERT INTO cu_feature
    (feature_code, description, limit_type, category, enabled)
    VALUES
    ('$code', '$desc', '$limit', null, FALSE)
    RETURNING feature_code, description, limit_type, enabled";

  // QUERY & ERROR CHECK
  $sqlInsertRs = db_query($sqlInsert, $pDbh);
  if (!$sqlInsertRs) {
    $pEnv['logger']->error(db_last_error());
    throw new Exception("Feature add has failed");
  }

  // GATHER DATA ROWS AND INFO
  $sqlDataRs = db_fetch_all($sqlInsertRs);
  $sqlReturn['data'] = FeatureSetup($sqlDataRs);
  $sqlReturn['info'][] = "Feature add was successful\n";

  return $sqlReturn;
}

/**
 *  FeatureReadList:
 *  - read the list of global features available from homecu
 *
 *  @param object $pDbh : database reference for access and manipulation of internal data
 *
 *  @return array $sqlReturn : array containing list of features available from homecu
 */
function FeatureReadList($pEnv, $pDbh) {

  // SQL STRING
  $sqlSelect = "SELECT feature_code, description, limit_type, enabled
    FROM cu_feature";

  // QUERY & ERROR CHECK
  $sqlSelectRs = db_query($sqlSelect, $pDbh);
  if (!$sqlSelectRs) {
    $pEnv['logger']->error(db_last_error());
    throw new Exception("Failed to read feature list");
  }

  // GATHER DATA ROWS AND INFO
  $sqlDataRs = db_fetch_all($sqlSelectRs);
  $sqlReturn['data'] = FeatureSetup($sqlDataRs);

  return $sqlReturn;
}
?>