aAdminSettings.i

<?php
/**
 *  Reply:
 *  @uses return data to client view print to json
 *  @param assoc $pResult: array contining results of search
 *  @param assoc $pReply: empty array to return to client
 *  @param assoc $pOperation: requested search operation
 */
function AdminSettingsReplay($pResult, $pReply, $pOperation) {
  $pReply['operation'] = $pOperation;
  isset($pResult['data']) && count($pResult['data']) ? $pReply['data'] = $pResult['data'] : null;
  isset($pResult['info']) && count($pResult['info']) ? $pReply['info'] = $pResult['info'] : null;

  print HCU_JsonEncode(array("Results" => $pReply));
}

/**
 *  AdminUpdateSettings
 *  @uses return updated banking settings
 *  @param assoc    $pEnv:      environment values
 *  @param assoc    $pDbh:      database access
 *  @param string   $pCu:       credit union code
 *  @param json     $pSettings: values for update
 *
 *  @return updated banking settings
 */
function AdminUpdateSettings($pEnv, $pDbh, $pCu, $pSettings) {
  $sqlRouting = HCU_array_key_value("routing", $pSettings);
  $sqlSettings = HCU_array_key_value("settings", $pSettings);


  $setPart = array();

  // Ensure that changing attributes in the JSON will not remove data.  (In the case of changing Auto Enroll so that it doesn't remove ACH attributes.)
  $sqlPart = "'$sqlSettings'::jsonb";
  $sqlSettings === false ? null : $setPart[] = "settings = CASE WHEN settings IS NULL or trim(settings) = '' THEN $sqlPart ELSE settings::jsonb || $sqlPart END";

  // Routing number is not updated when updating Auto Enrollment.
  $sqlRouting === false ? null : $setPart[] = "rt = $sqlRouting";

  if (count($setPart) == 0) {
    throw new Exception("Failed to update credit union settings");
  }
  $setPart = "SET " . implode(", ", $setPart);

  $sqlReturn = array();
  $sql = "
    UPDATE cuadmin
    $setPart
    WHERE cu = '{$pCu}'
    RETURNING
      TRIM(rt) AS routing,
      settings::json->>'name' AS name,
      settings::json->>'account' AS account,
      settings::json->>'sub_account_mask' AS sub_account_mask,
      settings::json->>'offsetting' AS offsetting,
      settings::json->>'cutoff' AS cutoff,
      settings::json->>'profile' AS profile,
      settings::json->>'achnotify' AS notify,
      settings::json->>'type' AS type";

  $sqlRs = db_query($sql, $pDbh);
  if (!$sqlRs) {
    throw new Exception("Failed to update credit union settings");
  }

  $sqlData = db_fetch_assoc($sqlRs);
  $sqlReturn['settings'] = array(
    "routing" => $sqlData['routing'],
    "name" => $sqlData['name'] === "null" ? null : $sqlData['name'],
    "account" => $sqlData['account'] === "null" ? null : $sqlData['account'],
    "sub_account_mask" => $sqlData['sub_account_mask'] === "null" ? null : $sqlData['sub_account_mask'],
    "offsetting" => $sqlData['offsetting'] === "null" ? 0 : $sqlData['offsetting'],
    "cutoff" => $sqlData['cutoff'] === "null" ? null : $sqlData['cutoff'],
    "profile" => $sqlData['profile'] === "null" ? null : $sqlData['profile'],
    "notify" => $sqlData['notify'] === "null" ? null : $sqlData['notify'],
    "type" => $sqlData['type'] === "null" ? null : $sqlData['type']
  );
  $sqlReturn['message'] = "Settings updated successfully";
  return $sqlReturn;
}

/**
 *  AdminReadSettings
 *  @uses return banking settings
 *  @param assoc    $pEnv:      environment values
 *  @param assoc    $pDbh:      database access
 *  @param string   $pCu:       credit union code
 *
 *  @return current banking settings for this credit union
 */
function AdminReadSettings($pEnv, $pDbh, $pCu) {
  $sqlReturn = array();
  $sql = "
    SELECT
      TRIM(a.rt) AS routing,
      a.settings::json->>'name' AS name,
      a.settings::json->>'account' AS account,
      a.settings::json->>'sub_account_mask' AS sub_account_mask,
      a.settings::json->>'offsetting' AS offsetting,
      a.settings::json->>'cutoff' AS cutoff,
      a.settings::json->>'profile' AS profile,
      a.settings::json->>'achnotify' AS notify,
      a.settings::json->>'type' AS type
    FROM cuadmin a
    WHERE cu = '{$pCu}'";
  $sqlRs = db_query($sql, $pDbh);
  if (!$sqlRs) {
    throw new Exception("Failed to read credit union settings");
  }

  $sqlData = db_fetch_assoc($sqlRs);
  $sqlReturn['settings'] = array(
    "routing" => $sqlData['routing'],
    "name" => $sqlData['name'] === "null" ? null : $sqlData['name'],
    "account" => $sqlData['account'] === "null" ? null : $sqlData['account'],
    "sub_account_mask" => $sqlData['sub_account_mask'] === "null" ? null : $sqlData['sub_account_mask'],
    "offsetting" => $sqlData['offsetting'] === "null" ? 0 : $sqlData['offsetting'],
    "cutoff" => $sqlData['cutoff'] === "null" ? null : $sqlData['cutoff'],
    "profile" => $sqlData['profile'] === "null" ? null : $sqlData['profile'],
    "notify" => $sqlData['notify'] === "null" ? null : $sqlData['notify']
  );

  // The Company ID Type should always default to 9 no matter what
  if (isset($sqlData['type']) && $sqlData['type'] == 1) {
    $sqlReturn['settings']['type'] = "1";
  } else if (isset($sqlData['type']) && $sqlData['type'] ==  " ") {
    $sqlReturn['settings']['type'] = " ";
  } else {
    $sqlReturn['settings']['type'] = "9";
  }

  return $sqlReturn;
}

/**
 *  AdminReadProfiles
 *  @uses return list of profiles configured for this cu
 *  @param assoc    $pEnv:      environment values
 *  @param assoc    $pDbh:      database access
 *  @param string   $pCu:       credit union code
 *
 *  @return list of profiles configured for this cu
 */
function AdminReadProfiles($pEnv, $pDbh, $pCu) {
  $sqlReturn = array();
  $sql = "
    SELECT
      TRIM(profile_code) AS code,
      TRIM(description) AS description
    FROM cu_profile
    WHERE cu = '{$pCu}'";
  $sqlRs = db_query($sql, $pDbh);
  if (!$sqlRs) {
    throw new Exception("Failed to read credit union profiles");
  }

  $sqlReturn['profiles'] = db_fetch_all($sqlRs);
  return $sqlReturn;
}

/**
 *  ValidateACHSettings
 *  @uses return data valid for input into the database
 *  @param assoc    $pEnv:      environment values
 *  @param json     $pSettings: values for update
 *
 *  @return validated values ready for input into database
 */
function ValidateACHSettings($pEnv, $pSettings, $pJson = false) {
  $aValidate = array();
  $aSettings = array();
  $aJsonSettings = array();

  if ($pSettings === null) {
    throw new Exception("Settings not found");
  }

  // data can come as array or json
  if ($pJson) {
    $aSettings = trim($pSettings);
    $aSettings = html_entity_decode($aSettings);
    $aSettings = HCU_JsonDecode($aSettings);
  } else {
    $aSettings = $pSettings;
  }

  // check for correct format
  if (!is_array($aSettings)) {
    throw new Exception("Settings data is invalid");
  }

  // check name field
  if (isset($aSettings['name'])) {
    $aName = trim($aSettings['name']);
    $aName = prep_save($aName, 100);

    $aJsonSettings['name'] = $aName;
  } else {
    throw new Exception("Credit union name is missing");
  }

  // check account number
  if (isset($aSettings['account'])) {
    $aAccount = trim($aSettings['account']);
    $aAccount = prep_save($aAccount, 12);

    if (strlen($aAccount) > 12) {
      throw new Exception("ACH GL Account can only contain up to 12 digits");
    }

    $aJsonSettings['account'] = $aAccount;
  } else {
    throw new Exception("ACH GL Account is missing");

  }

  // check sub-account number mask
  if (isset($aSettings['sub_account_mask'])) {
    $aSubAccountMask = trim($aSettings['sub_account_mask']);
    $aSubAccountMask = prep_save($aSubAccountMask, 16);

    if (strlen($aSubAccountMask) > 16) {
      throw new Exception("Sub-account mask can only contain up to 16 characters");
    }
    if (!preg_match('/^0*$/', $aSubAccountMask)) {
      throw new Exception("Sub-account mask can only contain '0' characters");
    }

    $aJsonSettings['sub_account_mask'] = $aSubAccountMask;
  }

  // check the "offsetting" checked status
  if (isset($aSettings['offsetting'])) {
    $aOffset = $aSettings['offsetting'] == 0 ? 0 : 1;

    $aJsonSettings['offsetting'] = $aOffset;
  } else {
    throw new Exception("Micro deposit offsetting entry choice missing");
  }

  // check routing number
  if (isset($aSettings['routing'])) {
    $aRouting = trim($aSettings['routing']);
    $aRouting = prep_save($aRouting, 9);

    if (strlen($aRouting) < 9 || strlen($aRouting) > 9) {
      throw new Exception("Routing number must be 9 digits");
    }

    $aValidate['validate']['routing'] = $aRouting;
  } else {
    throw new Exception("Routing number is missing");
  }

  // check cutoff time
  if (isset($aSettings['cutoff'])) {
    $aTime = trim($aSettings['cutoff']);
    $aTime = prep_save($aTime, 4);
    if (strlen($aTime) === 3) {
      $aTime = "0" . $aTime;
    }

    $aJsonSettings['cutoff'] = $aTime;
  } else {
    throw new Exception("Cutoff time is missing");
  }

  // check the company ID type
  if (isset($aSettings['type'])) {
    $aType = $aSettings['type'];

    if ($aType != "9" && $aType != "1" && $aType != " ") {
      throw new Exception("Company ID Type is an incorrect value.");
    }

    $aJsonSettings['type'] = $aType;
  } else {
    throw new Exception("Company ID Type is missing");
  }

  // check notification
  if (isset($aSettings['notify'])) {
    $aNotify = trim($aSettings['notify']);
    $aNotify = prep_save($aNotify);

    // Validate for correct keywords:
    // company, transactiontype, amount, date,
    // accountname, routing, accountnumber or accounttype.
    $allowedKeywords = array('company', 'transactiontype', 'amount', 'date', 'accountname', 'routing', 'accountnumber', 'accounttype');
    $notAllowed = "";

    // This will output an array with 2 arrays inside
    // 1. The list of search patterns found e.g. "{{keywords}}"
    // 2. Ths list of values from the search patterns found e.g. "keywords"
    preg_match_all("/\{{2}(.*?)\}{2}/i", $aNotify, $foundKeywords);
    $keywordPatterns = $foundKeywords[0];
    $keywordValues = $foundKeywords[1];
    foreach ($keywordValues as $key => $value) {
      if (!in_array($value, $allowedKeywords)) {
        // Append non-allowed keywords for error message
        // We will display all incorrect keywords at one time.

        // If the user for some reason doesn't add closing }} to
        // the keyword they enter, the regex above will pick up
        // the entire string until it finds closing }} if any exist
        // which could get quite large in the error popup tab on screen.

        // This code will truncate the string to only a single token.
        $tokens = explode(' ', $keywordPatterns[$key]);
        $token = $tokens[0];

        // Because the return function to the client JSON encodes
        // the return data, we cannot use new line or tab characters.

        // The error popup tab uses a list to display multiple errors
        // this will take advantage.
        $notAllowed .= "<li>$token</li>";
      }
    }

    // Any non-allowed keywords, throw error displaying
    // all that were found.
    if (strlen($notAllowed) > 0) {
      $error = "The Email Notification template contains one or more invalid keywords:";
      $error .= $notAllowed;
      throw new Exception($error);
    }

    $aJsonSettings['achnotify'] = $aNotify;
  }

  // encode setting minus routing number
  // into json string
  $aJsonSettings = HCU_JsonEncode($aJsonSettings);
  $aJsonSettings = trim($aJsonSettings);

  if ($aJsonSettings === "") {
    throw new Exception("Admin settings are missing");
  }

  $aValidate['validate']['settings'] = $aJsonSettings;
  return $aValidate;
}

/**
 *  ValidateAutoSettings
 *  @uses return data valid for input into the database
 *  @param assoc    $pEnv:      environment values
 *  @param json     $pSettings: values for update
 *
 *  @return validated values ready for input into database
 */
function ValidateAutoSettings($pEnv, $pSettings, $pJson = false) {
  $aValidate = array();
  $aSettings = array();
  $aJsonSettings = array();

  if ($pSettings === null) {
    throw new Exception("Settings not found");
  }

  // data can come as array or json
  if ($pJson) {
    $aSettings = trim($pSettings);
    $aSettings = html_entity_decode($aSettings);
    $aSettings = HCU_JsonDecode($aSettings);
  } else {
    $aSettings = $pSettings;
  }

  // check for correct format
  if (!is_array($aSettings)) {
    throw new Exception("Settings data is invalid");
  }

  // check the profile
  if (isset($aSettings['profile'])) {
    $aProfile = trim($aSettings['profile']);
    $aProfile = strtoupper($aProfile);
    $aProfile = prep_save($aProfile, 20);

    $aJsonSettings['profile'] = $aProfile;
  } else {
    throw new Exception("Default profile is missing");
  }

  // encode setting minus routing number
  // into json string
  $aJsonSettings = HCU_JsonEncode($aJsonSettings);
  $aJsonSettings = trim($aJsonSettings);

  if ($aJsonSettings === "") {
    throw new Exception("Admin settings are missing");
  }

  $aValidate['validate']['settings'] = $aJsonSettings;
  return $aValidate;
}