/**
* @param array $params (reference ) an assoc array of name/value pairs
*
* @return object CRM_Core_BAO_SEPAMandate object on success, null otherwise
* @access public
* @static (I do apologize, I don't want to)
*/
static function add(&$params)
{
// handle 'normal' creation process inlcuding hooks
$hook = empty($params['id']) ? 'create' : 'edit';
CRM_Utils_Hook::pre($hook, 'SepaMandate', CRM_Utils_Array::value('id', $params), $params);
// set default date to today
if (!array_key_exists("date", $params)) {
$params["date"] = date("YmdHis");
}
if (empty($params['id'])) {
CRM_Utils_SepaCustomisationHooks::create_mandate($params);
if (empty($params['reference'])) {
// If no mandate reference was supplied by the caller nor the customisation hook, create a nice default one.
$creditor = civicrm_api3('SepaCreditor', 'getsingle', array('id' => $params['creditor_id'], 'return' => 'mandate_prefix'));
$dao = new CRM_Core_DAO();
$database = $dao->database();
$next_id = CRM_Core_DAO::singleValueQuery("SELECT auto_increment FROM information_schema.tables WHERE table_schema='{$database}' and table_name='civicrm_sdd_mandate';");
$params['reference'] = $creditor['mandate_prefix'] . '-' . $params['creditor_id'] . '-' . $params['type'] . '-' . date("Y") . '-' . $next_id;
}
}
// validate IBAN / BIC
if (!empty($params['iban'])) {
$params['iban'] = strtoupper($params['iban']);
// create uppercase string
$params['iban'] = str_replace(' ', '', $params['iban']);
// strip spaces
$iban_error = CRM_Sepa_Logic_Verification::verifyIBAN($params['iban']);
if ($iban_error) {
throw new CRM_Exception($iban_error . ':' . $params['iban']);
}
}
if (!empty($params['bic'])) {
$bic_error = CRM_Sepa_Logic_Verification::verifyBIC($params['bic']);
if ($bic_error) {
throw new CRM_Exception($bic_error . ':' . $params['bic']);
}
}
// create the DAO object
$dao = new CRM_Sepa_DAO_SEPAMandate();
$dao->copyValues($params);
if (self::is_active(CRM_Utils_Array::value('status', $params))) {
if ($dao->validation_date == NULL) {
$dao->validation_date = date("YmdHis");
}
}
$dao->save();
CRM_Utils_Hook::post($hook, 'SepaMandate', $dao->id, $dao);
return $dao;
}
/**
* Will checks all the POSTed data with respect to creating a mandate
*
* @return array('<field_id>' => '<error message>') with the fields that have not passed
*/
function validateParameters()
{
$errors = array();
// check amount
if (!isset($_REQUEST['total_amount'])) {
$errors['total_amount'] = sprintf(ts("'%s' is a required field."), ts("Amount"));
} else {
$_REQUEST['total_amount'] = str_replace(',', '.', $_REQUEST['total_amount']);
if (strlen($_REQUEST['total_amount']) == 0) {
$errors['total_amount'] = sprintf(ts("'%s' is a required field."), ts("Amount"));
} elseif (!is_numeric($_REQUEST['total_amount'])) {
$errors['total_amount'] = ts("Cannot parse amount");
} elseif ($_REQUEST['total_amount'] <= 0) {
$errors['total_amount'] = ts("Amount has to be positive");
}
}
// check BIC
if (!isset($_REQUEST['bic'])) {
$errors['bic'] = sprintf(ts("'%s' is a required field."), "BIC");
} else {
$_REQUEST['bic'] = strtoupper($_REQUEST['bic']);
if (strlen($_REQUEST['bic']) == 0) {
$errors['bic'] = sprintf(ts("'%s' is a required field."), "BIC");
} else {
$bic_error = CRM_Sepa_Logic_Verification::verifyBIC($_REQUEST['bic']);
if (!empty($bic_error)) {
$errors['bic'] = $bic_error;
}
}
}
// check IBAN
if (!isset($_REQUEST['iban'])) {
$errors['iban'] = sprintf(ts("'%s' is a required field."), "IBAN");
} else {
if (strlen($_REQUEST['iban']) == 0) {
$errors['iban'] = sprintf(ts("'%s' is a required field."), "IBAN");
} else {
$iban_error = CRM_Sepa_Logic_Verification::verifyIBAN($_REQUEST['iban']);
if (!empty($iban_error)) {
$errors['iban'] = $iban_error;
}
}
}
// check reference
if (!empty($_REQUEST['reference'])) {
// check if it is formally correct
if (!preg_match("/^[A-Z0-9\\-]{4,35}\$/", $_REQUEST['reference'])) {
$errors['reference'] = ts("Reference has to be an upper case alphanumeric string between 4 and 35 characters long.");
} else {
// check if the reference is taken
$count = civicrm_api3('SepaMandate', 'getcount', array("reference" => $_REQUEST['reference']));
if ($count > 0) {
$errors['reference'] = ts("This reference is already in use.");
}
}
}
// check date fields
if ($_REQUEST['mandate_type'] == 'OOFF') {
if (!$this->_check_date('date')) {
$errors['date'] = ts("Incorrect date format");
}
} elseif ($_REQUEST['mandate_type'] == 'RCUR') {
if (!$this->_check_date('start_date')) {
$errors['start_date'] = ts("Incorrect date format");
}
if (isset($_REQUEST['end_date']) && strlen($_REQUEST['end_date'])) {
if (!$this->_check_date('end_date')) {
$errors['end_date'] = ts("Incorrect date format");
} else {
// check if end_date AFTER start_date (#341)
if (!isset($errors['start_date']) && $_REQUEST['end_date'] < $_REQUEST['start_date']) {
$errors['end_date'] = ts("End date cannot be earlier than start date.");
}
}
}
}
// check replace fields
if (isset($_REQUEST['replace'])) {
if (!$this->_check_date('replace_date')) {
$errors['replace_date'] = ts("Incorrect date format");
}
if (!isset($_REQUEST['replace_reason']) || strlen($_REQUEST['replace_reason']) == 0) {
$errors['replace_reason'] = sprintf(ts("'%s' is a required field."), ts("replace reason"));
}
}
return $errors;
}
/**
* Function to validate IBAN and log error if invalid
*
* @param $daoEspadon
* @param $logger
* @param $errors
* @return bool
*/
function _validateIban($daoEspadon, $logger, &$errors)
{
$validateIban = CRM_Sepa_Logic_Verification::verifyIBAN($daoEspadon->Iban);
if ($validateIban == "IBAN is not correct") {
$logger->logError("Iban afgekeurd", $daoEspadon->contactId, 0, 0, 0, "Iban is :" . $daoEspadon->Iban . " bij mandaat " . $daoEspadon->Mandate);
$errors++;
return FALSE;
} else {
return TRUE;
}
}
function civicrm_api3_contribution_migrate($params)
{
$logger = new CRM_MigrateLogger();
$migrated = array();
if (!array_key_exists('option.limit', $params)) {
$logger->logMessage('Warning', 'option.limit defaults to 1');
$params["option.limit"] = 1;
} else {
$logger->logMessage('Warning', 'option.limit set to ' . $params['option.limit']);
}
$contributionQuery = "SELECT c.contact_id, c.id, c.total_amount AS amount, c.campaign_id, p.id AS pledge_id,\n p.status_id,p.frequency_unit, p.frequency_interval, p.frequency_day,p.start_date, p.create_date,\n p.acknowledge_date,p.end_date,p.cancel_date, m.bankname_pledge_7 AS bank, m.mandate_3 AS mandate,\n iban_pledge_5 AS iban,bic_pledge_6 AS bic\n FROM civicrm_contribution AS c\n LEFT JOIN civicrm_pledge AS p ON p.campaign_id=c.campaign_id AND p.contact_id = c.contact_id\n LEFT JOIN civicrm_campaign ON civicrm_campaign.id=c.campaign_id\n LEFT JOIN civicrm_value_sepa_direct_debit_2 AS m ON m.entity_id=p.id\n WHERE c.financial_type_id=4 AND p.original_installment_amount = c.total_amount AND c.total_amount > 0\n AND contribution_recur_id IS NULL AND c.campaign_id IS NOT NULL ORDER BY receive_date DESC\n LIMIT %1";
$contributionParams = array(1 => array($params['option.limit'], 'Integer'));
$c = CRM_Core_DAO::executeQuery($contributionQuery, $contributionParams);
while ($c->fetch()) {
if ($c->frequency_unit == "quarter") {
$logger->logMessage("Warning", "Skipping quarterly pledge " . $c->pledge_id . " for contact " . $c->contact_id . " with mandate " . $c->mandate);
continue;
}
if (in_array($c->pledge_id, $migrated)) {
continue;
//this contribution is part of a pledge that has already been migrated in this batch
}
$logger->logMessage("Info", "Processing pledge " . $c->pledge_id . " for contact " . $c->contact_id . " with mandate " . $c->mandate);
$migrated[] = $c->pledge_id;
$recurParams = array("contact_id" => $c->contact_id, "amount" => $c->amount, "currency" => "EUR", "contribution_status_id" => $c->status_id, "frequency_interval" => $c->frequency_interval, "frequency_unit" => $c->frequency_unit, "cycle_day" => $c->frequency_day, "start_date" => $c->start_date, "create_date" => $c->create_date, "end_date" => $c->end_date, "cancel_date" => $c->cancel_date, "financial_type_id" => 4, "payment_instrument_id" => (int) CRM_Core_OptionGroup::getValue('payment_instrument', 'RCUR', 'name'), "status" => 'RCUR', "campaign_id" => $c->campaign_id, "sequential" => 0);
$cr = civicrm_api3("ContributionRecur", "create", $recurParams);
$logger->logMessage("Info", "Created recurring contribution " . $cr['id'] . " for pledge " . $c->pledge_id . " and contact_id " . $c->contact_id);
/*
* validate IBAN and BIC
*/
$verifyIBAN = CRM_Sepa_Logic_Verification::verifyIBAN($c->iban);
if ($verifyIBAN) {
$logger->logError("IBAN is invalid, emptied mandate IBAN and BIC", $c->contact_id, $c->pledge_id, $cr['id'], $c->campaign_id, "IBAN: " . $c->iban);
$c->iban = "";
$c->bic = "";
$reference = "INVIBAN" . $c->mandate . ": " . $cr["id"];
} else {
$verifyBIC = CRM_Sepa_Logic_Verification::verifyBIC($c->bic);
if ($verifyBIC == "BIC is not correct") {
// try lookup with Iban
try {
$result = civicrm_api3('Bic', 'getfromiban', array('iban' => $c->iban));
$logger->logError("BIC was invalid, replaced with look up of BIC", $c->contact_id, $c->pledge_id, $cr['id'], $c->campaign_id, "BIC: " . $c->bic . " with IBAN: " . $c->iban);
$c->bic = $result['bic'];
$reference = $c->mandate;
} catch (CiviCRM_API3_Exception $ex) {
$logger->logError("BIC is invalid and lookup failed, emptied BIC", $c->contact_id, $c->pledge_id, $cr['id'], $c->campaign_id, "BIC: " . $c->bic . " with IBAN: " . $c->iban);
$c->bic = "";
$reference = "INVBIC" . $c->mandate . ": " . $cr["id"];
}
}
}
/*
* add check on length of reference
*/
if (strlen($reference) > 35) {
$logger->logError("Mandate was more than 35 characters, will be truncated to 35", $c->contact_id, $c->pledge_id, $cr['id'], $c->campaign_id, "Mandate was " . $reference . " and will be " . substr($reference, 0, 35));
$reference = substr($reference, 0, 35);
}
$mandate = array("contact_id" => $c->contact_id, "entity_table" => "civicrm_contribution_recur", "entity_id" => $cr["id"], "source" => "pledge:" . $c->pledge_id, "creditor_id" => 2, "type" => "RCUR", "status" => "RCUR", "creation_date" => $c->create_date, "validation_date" => $c->start_date, "iban" => $c->iban, "bic" => $c->bic, "reference" => $reference, "bank" => $c->bank, "sequential" => 0);
try {
$r = civicrm_api3("SepaMandate", "create", $mandate);
$logger->logMessage("Info", "Added mandate " . $reference . " for contact " . $c->contact_id . " recurring contribution " . $cr['id'] . " and pledge " . $c->pledge_id);
} catch (Exception $e) {
$mandate = array("contact_id" => $c->contact_id, "entity_table" => "civicrm_contribution_recur", "entity_id" => $cr["id"], "source" => "pledge:" . $c->pledge_id, "creditor_id" => 2, "type" => "RCUR", "status" => "RCUR", "creation_date" => $c->create_date, "validation_date" => $c->start_date, "iban" => $c->iban, "bic" => $c->bic, "bank" => $c->bank, "sequential" => 0);
if (empty($c->iban)) {
$mandate['reference'] = "DUP " . $reference;
} else {
$mandate['reference'] = "DUP" . $reference . ": " . $cr["id"];
}
$logger->logError("Creating duplicate mandate", $c->contact_id, $c->pledge_id, $cr['id'], $c->campaign_id, "Original mandate is " . $c->mandate . ", duplicate mandate is " . $mandate['reference']);
$r = civicrm_api3("SepaMandate", "create", $mandate);
}
$updateQuery = "UPDATE civicrm_contribution SET contribution_recur_id = %1\n WHERE contact_id = %2 AND financial_type_id = %3 AND total_amount = %4";
$updateParams = array(1 => array($cr['id'], 'Integer'), 2 => array($c->contact_id, 'Integer'), 3 => array(4, 'Integer'), 4 => array($c->amount, 'Money'));
$t = CRM_Core_DAO::executeQuery($updateQuery, $updateParams);
$logger->logMessage("Info", "migrated contributions/pledge for " . $c->contact_id);
}
}
