Skip to content
Snippets Groups Projects
Commit c5c564df authored by Joshua Walker's avatar Joshua Walker
Browse files

Fix for Webhook issue in Civi 4.3 and code cleanup.

parent b6d45c38
Branches
Tags
No related merge requests found
Hide whitespace changes
Inline Side-by-side
com.drastikbydesign.stripe/CRM/Stripe/Page/Webhook.php
+ 198
− 90
View file @ c5c564df
<?php
/*
* Handle Stripe Webhooks for recurring payments
* @file
* Handle Stripe Webhooks for recurring payments.
*/
require_once 'CRM/Core/Page.php';
class CRM_Stripe_Page_Webhook extends CRM_Core_Page {
function run() {
//Get the data from stripe
// Get the data from Stripe.
$data_raw = file_get_contents("php://input");
$data = json_decode($data_raw);
if(!$data) {
if (!$data) {
CRM_Core_Error::Fatal("Stripe Callback: cannot json_decode data, exiting. <br /> $data");
}
$test_mode = ! $data->livemode;
$stripe_key = CRM_Core_DAO::singleValueQuery("SELECT user_name FROM civicrm_payment_processor WHERE payment_processor_type = 'Stripe' AND is_test = '$test_mode'");
require_once ("packages/stripe-php/lib/Stripe.php");
Stripe::setApiKey($stripe_key);
//Retrieve Event from Stripe using ID even though we already have the values now.
//This is for extra security precautions mentioned here: https://stripe.com/docs/webhooks
// Retrieve Event from Stripe using ID even though we already have the values now.
// This is for extra security precautions mentioned here: https://stripe.com/docs/webhooks
$stripe_event_data = Stripe_Event::retrieve($data->id);
$customer_id = $stripe_event_data->data->object->customer;
switch($stripe_event_data->type) {
//Successful recurring payment
// Successful recurring payment.
case 'invoice.payment_succeeded':
//Get the Stripe charge object
// Get the Stripe charge object.
try {
$charge = Stripe_Charge::retrieve($stripe_event_data->data->object->charge);
} catch(Exception $e) {
}
catch(Exception $e) {
CRM_Core_Error::Fatal("Failed to retrieve Stripe charge. Message: " . $e->getMessage());
break;
exit();
}
//Find the recurring contribution in CiviCRM by mapping it from Stripe
$rel_info_query = CRM_Core_DAO::executeQuery("SELECT invoice_id, end_time FROM civicrm_stripe_subscriptions WHERE customer_id = '$customer_id'");
if(!empty($rel_info_query)) {
// Find the recurring contribution in CiviCRM by mapping it from Stripe.
$query_params = array(
1 => array($customer_id, 'String'),
);
$rel_info_query = CRM_Core_DAO::executeQuery("SELECT invoice_id, end_time
FROM civicrm_stripe_subscriptions
WHERE customer_id = %1",
$query_params);
if (!empty($rel_info_query)) {
$rel_info_query->fetch();
$invoice_id = $rel_info_query->invoice_id;
$end_time = $rel_info_query->end_time;
} else {
}
else {
CRM_Core_Error::Fatal("Error relating this customer ($customer_id) to the one in civicrm_stripe_subscriptions");
exit();
}
//Compare against now + 24hrs to prevent charging 1 extra day.
// Compare against now + 24hrs to prevent charging 1 extra day.
$time_compare = time() + 86400;
//Fetch Civi's info about this recurring object
$recur_contrib_query = CRM_Core_DAO::executeQuery("SELECT id, contact_id, currency, contribution_status_id, is_test, contribution_type_id, payment_instrument_id, campaign_id FROM civicrm_contribution_recur WHERE invoice_id = '$invoice_id'");
if(!empty($recur_contrib_query)) {
// As of 4.3, contribution_type_id column renamed to financial_type_id.
$financial_field = 'contribution_type_id';
$civi_version = CRM_Utils_System::version();
if ($civi_version >= 4.3) {
$financial_field = 'financial_type_id';
}
// Fetch Civi's info about this recurring object.
$query_params = array(
1 => array($invoice_id, 'String'),
);
$recur_contrib_query = CRM_Core_DAO::executeQuery("SELECT id, contact_id, currency, contribution_status_id, is_test, {$financial_field}, payment_instrument_id, campaign_id
FROM civicrm_contribution_recur
WHERE invoice_id = %1",
$query_params);
if (!empty($recur_contrib_query)) {
$recur_contrib_query->fetch();
} else {
}
else {
CRM_Core_Error::Fatal("ERROR: Stripe triggered a Webhook on an invoice not found in civicrm_contribution_recur: " . $stripe_event_data);
exit();
}
//Build some params
// Build some params.
$stripe_customer = Stripe_Customer::retrieve($customer_id);
$recieve_date = date("Y-m-d H:i:s", $charge->created);
$total_amount = $charge->amount / 100;
......@@ -63,108 +89,190 @@ class CRM_Stripe_Page_Webhook extends CRM_Core_Page {
$net_amount = $total_amount - $fee_amount;
$transaction_id = $charge->id;
$new_invoice_id = $stripe_event_data->data->object->id;
if(empty($recur_contrib_query->campaign_id)) {
if (empty($recur_contrib_query->campaign_id)) {
$recur_contrib_query->campaign_id = 'NULL';
}
$first_contrib_check = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_contribution WHERE invoice_id = '$invoice_id' AND contribution_status_id = '2'");
if(!empty($first_contrib_check)) {
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution SET contribution_status_id = '1' WHERE id = '$first_contrib_check'");
$query_params = array(
1 => array($invoice_id, 'String'),
);
$first_contrib_check = CRM_Core_DAO::singleValueQuery("SELECT id
FROM civicrm_contribution
WHERE invoice_id = %1
AND contribution_status_id = '2'", $query_params);
if (!empty($first_contrib_check)) {
$query_params = array(
1 => array($first_contrib_check, 'Integer'),
);
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution
SET contribution_status_id = '1'
WHERE id = %1",
$query_params);
return;
}
//Create this instance of the contribution for accounting in CiviCRM
CRM_Core_DAO::executeQuery("
INSERT INTO civicrm_contribution (
contact_id, contribution_type_id, payment_instrument_id, receive_date,
total_amount, fee_amount, net_amount, trxn_id, invoice_id, currency,
contribution_recur_id, is_test, contribution_status_id, campaign_id
) VALUES (
'$recur_contrib_query->contact_id', '$recur_contrib_query->contribution_type_id', '$recur_contrib_query->payment_instrument_id', '$recieve_date',
'$total_amount', '$fee_amount', '$net_amount', '$transaction_id', '$new_invoice_id', '$recur_contrib_query->currency',
'$recur_contrib_query->id', '$recur_contrib_query->is_test', '1', $recur_contrib_query->campaign_id
)");
if($time_compare > $end_time) {
// Create this instance of the contribution for accounting in CiviCRM.
$query_params = array(
1 => array($recur_contrib_query->contact_id, 'Integer'),
2 => array($recur_contrib_query->{$financial_field}, 'Integer'),
3 => array($recur_contrib_query->payment_instrument_id, 'Integer'),
4 => array($recieve_date, 'String'),
5 => array($total_amount, 'String'),
6 => array($fee_amount, 'String'),
7 => array($net_amount, 'String'),
8 => array($transaction_id, 'String'),
9 => array($new_invoice_id, 'String'),
10 => array($recur_contrib_query->currency, 'String'),
11 => array($recur_contrib_query->id, 'Integer'),
12 => array($recur_contrib_query->is_test, 'Integer'),
13 => array($recur_contrib_query->campaign_id, 'Integer'),
);
CRM_Core_DAO::executeQuery("INSERT INTO civicrm_contribution (
contact_id, {$financial_field}, payment_instrument_id, receive_date,
total_amount, fee_amount, net_amount, trxn_id, invoice_id, currency,
contribution_recur_id, is_test, contribution_status_id, campaign_id
) VALUES (
%1, %2, %3, %4,
%5, %6, %7, %8, %9, %10,
%11, %12, '1', %13)",
$query_params);
if ($time_compare > $end_time) {
$end_date = date("Y-m-d H:i:s", $end_time);
//Final payment. Recurring contribution complete
// Final payment. Recurring contribution complete.
$stripe_customer->cancelSubscription();
CRM_Core_DAO::executeQuery("DELETE FROM civicrm_stripe_subscriptions WHERE invoice_id = '$invoice_id'");
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution_recur SET end_date = '$end_date', contribution_status_id = '1' WHERE invoice_id = '$invoice_id'");
$query_params = array(
1 => array($invoice_id, 'String'),
);
CRM_Core_DAO::executeQuery("DELETE FROM civicrm_stripe_subscriptions
WHERE invoice_id = %1", $query_params);
$query_params = array(
1 => array($end_date, 'String'),
2 => array($invoice_id, 'String'),
);
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution_recur
SET end_date = %1, contribution_status_id = '1'
WHERE invoice_id = %2", $query_params);
return;
}
//Successful charge & more to come so set recurring contribution status to In Progress
if($recur_contrib_query->contribution_status_id != 5) {
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution_recur SET contribution_status_id = 5 WHERE invoice_id = '$invoice_id'");
// Successful charge & more to come so set recurring contribution status to In Progress.
$query_params = array(
1 => array($invoice_id, 'String'),
);
if ($recur_contrib_query->contribution_status_id != 5) {
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution_recur
SET contribution_status_id = 5
WHERE invoice_id = %1", $query_params);
return;
}
break;
//Failed recurring payment
// Failed recurring payment.
case 'invoice.payment_failed':
//Get the Stripe charge object
// Get the Stripe charge object.
try {
$charge = Stripe_Charge::retrieve($stripe_event_data->data->object->charge);
} catch(Exception $e) {
}
catch(Exception $e) {
CRM_Core_Error::Fatal("Failed to retrieve Stripe charge. Message: " . $e->getMessage());
break;
exit();
}
//Find the recurring contribution in CiviCRM by mapping it from Stripe
$invoice_id = CRM_Core_DAO::singleValueQuery("SELECT invoice_id FROM civicrm_stripe_subscriptions WHERE customer_id = '$customer_id'");
if(empty($invoice_id)) {
CRM_Core_Error::Fatal("Error relating this customer ($customer_id) to the one in civicrm_stripe_subscriptions");
// Find the recurring contribution in CiviCRM by mapping it from Stripe.
$query_params = array(
1 => array($customer_id, 'String'),
);
$invoice_id = CRM_Core_DAO::singleValueQuery("SELECT invoice_id
FROM civicrm_stripe_subscriptions
WHERE customer_id = %1", $query_params);
if (empty($invoice_id)) {
CRM_Core_Error::Fatal("Error relating this customer ({$customer_id}) to the one in civicrm_stripe_subscriptions");
exit();
}
//Fetch Civi's info about this recurring object
$recur_contrib_query = CRM_Core_DAO::executeQuery("SELECT id, contact_id, currency, contribution_status_id, is_test, contribution_type_id, payment_instrument_id, campaign_id FROM civicrm_contribution_recur WHERE invoice_id = '$invoice_id'");
if(!empty($recur_contrib_query)) {
// Fetch Civi's info about this recurring object.
$query_params = array(
1 => array($invoice_id, 'String'),
);
$recur_contrib_query = CRM_Core_DAO::executeQuery("SELECT id, contact_id, currency, contribution_status_id, is_test, {$financial_field}, payment_instrument_id, campaign_id
FROM civicrm_contribution_recur
WHERE invoice_id = %1", $query_params);
if (!empty($recur_contrib_query)) {
$recur_contrib_query->fetch();
} else {
}
else {
CRM_Core_Error::Fatal("ERROR: Stripe triggered a Webhook on an invoice not found in civicrm_contribution_recur: " . $stripe_event_data);
exit();
}
//Build some params
// Build some params.
$recieve_date = date("Y-m-d H:i:s", $charge->created);
$total_amount = $charge->amount / 100;
$fee_amount = $charge->fee / 100;
$net_amount = $total_amount - $fee_amount;
$transaction_id = $charge->id;
if(empty($recur_contrib_query->campaign_id)) {
if (empty($recur_contrib_query->campaign_id)) {
$recur_contrib_query->campaign_id = 'NULL';
}
//Create this instance of the contribution for accounting in CiviCRM
CRM_Core_DAO::executeQuery("
INSERT INTO civicrm_contribution (
contact_id, contribution_type_id, payment_instrument_id, receive_date,
total_amount, fee_amount, net_amount, trxn_id, invoice_id, currency,
contribution_recur_id, is_test, contribution_status_id, campaign_id
) VALUES (
'$recur_contrib_query->contact_id', '$recur_contrib_query->contribution_type_id', '$recur_contrib_query->payment_instrument_id', '$recieve_date',
'$total_amount', '$fee_amount', '$net_amount', '$transaction_id', '$invoice_id', '$recur_contrib_query->currency',
'$recur_contrib_query->id', '$recur_contrib_query->is_test', '4', $recur_contrib_query->campaign_id
)");
//Failed charge. Set to status to: Failed
if($recur_contrib_query->contribution_status_id != 4) {
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution_recur SET contribution_status_id = 4 WHERE invoice_id = '$invoice_id'");
// Create this instance of the contribution for accounting in CiviCRM.
$query_params = array(
1 => array($recur_contrib_query->contact_id, 'Integer'),
2 => array($recur_contrib_query->{$financial_field}, 'Integer'),
3 => array($recur_contrib_query->payment_instrument_id, 'Integer'),
4 => array($recieve_date, 'String'),
5 => array($total_amount, 'String'),
6 => array($fee_amount, 'String'),
7 => array($net_amount, 'String'),
8 => array($transaction_id, 'String'),
9 => array($invoice_id, 'String'),
10 => array($recur_contrib_query->currency, 'String'),
11 => array($recur_contrib_query->id, 'Integer'),
12 => array($recur_contrib_query->is_test, 'Integer'),
13 => array($recur_contrib_query->campaign_id, 'Integer'),
);
CRM_Core_DAO::executeQuery("INSERT INTO civicrm_contribution (
contact_id, {$financial_field}, payment_instrument_id, receive_date,
total_amount, fee_amount, net_amount, trxn_id, invoice_id, currency,
contribution_recur_id, is_test, contribution_status_id, campaign_id
) VALUES (
%1, %2, %3, %4,
%5, %6, %7, %8, %9, %10,
%11, %12, '4', %13)",
$query_params);
// Failed charge. Set to status to: Failed.
if ($recur_contrib_query->contribution_status_id != 4) {
$query_params = array(
1 => array($invoice_id, 'String'),
);
CRM_Core_DAO::executeQuery("UPDATE civicrm_contribution_recur
SET contribution_status_id = 4
WHERE invoice_id = %1", $query_params);
return;
} else {
//This has failed more than once. Now what?
}
else {
// This has failed more than once. Now what?
}
break;
//One-time donation and per invoice payment
// One-time donation and per invoice payment.
case 'charge.succeeded':
//Not implemented
// Not implemented.
return;
break;
}
parent::run();
}
......
com.drastikbydesign.stripe/info.xml
+ 4
− 3
View file @ c5c564df
<?xml version="1.0"?>
<extension key="com.drastikbydesign.stripe" type="module">
<downloadUrl>http://drastikbydesign.com/files/downloads/com.drastikbydesign.stripe-4.2-1.5.zip</downloadUrl>
<downloadUrl>http://drastikbydesign.com/files/downloads/com.drastikbydesign.stripe-4.2-1.6.zip</downloadUrl>
<file>stripe</file>
<name>Stripe</name>
<description>Stripe Payment Processor</description>
......@@ -12,11 +12,12 @@
<author>Joshua Walker (drastik) - Drastik by Design</author>
<email>admin@drastikbydesign.com</email>
</maintainer>
<releaseDate>2013-03-19</releaseDate>
<version>1.5</version>
<releaseDate>2013-05-07</releaseDate>
<version>1.6</version>
<develStage>stable</develStage>
<compatibility>
<ver>4.2</ver>
<ver>4.3</ver>
</compatibility>
<comments>http://drastikbydesign.com/blog-entry/civicrm-stripe-payment-processor</comments>
<civix>
......
com.drastikbydesign.stripe/stripe.php
+ 36
− 35
View file @ c5c564df
......@@ -3,14 +3,14 @@
require_once 'stripe.civix.php';
/**
* Implementation of hook_civicrm_config
* Implementation of hook_civicrm_config().
*/
function stripe_civicrm_config(&$config) {
_stripe_civix_civicrm_config($config);
}
/**
* Implementation of hook_civicrm_xmlMenu
* Implementation of hook_civicrm_xmlMenu().
*
* @param $files array(string)
*/
......@@ -19,44 +19,44 @@ function stripe_civicrm_xmlMenu(&$files) {
}
/**
* Implementation of hook_civicrm_install
* Implementation of hook_civicrm_install().
*/
function stripe_civicrm_install() {
//Create required tables for Stripe
// Create required tables for Stripe.
require_once "CRM/Core/DAO.php";
CRM_Core_DAO::executeQuery("
CREATE TABLE IF NOT EXISTS `civicrm_stripe_customers` (
`email` varchar(64) COLLATE utf8_unicode_ci DEFAULT NULL,
`id` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
UNIQUE KEY `email` (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
");
CREATE TABLE IF NOT EXISTS `civicrm_stripe_customers` (
`email` varchar(64) COLLATE utf8_unicode_ci DEFAULT NULL,
`id` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
UNIQUE KEY `email` (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
");
CRM_Core_DAO::executeQuery("
CREATE TABLE IF NOT EXISTS `civicrm_stripe_plans` (
`plan_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
UNIQUE KEY `plan_id` (`plan_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
");
CREATE TABLE IF NOT EXISTS `civicrm_stripe_plans` (
`plan_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
UNIQUE KEY `plan_id` (`plan_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
");
CRM_Core_DAO::executeQuery("
CREATE TABLE IF NOT EXISTS `civicrm_stripe_subscriptions` (
`customer_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
`invoice_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
`end_time` int(11) NOT NULL DEFAULT '0',
`is_live` tinyint(4) NOT NULL COMMENT 'Whether this is a live or test transaction',
KEY `end_time` (`end_time`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
");
CREATE TABLE IF NOT EXISTS `civicrm_stripe_subscriptions` (
`customer_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
`invoice_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
`end_time` int(11) NOT NULL DEFAULT '0',
`is_live` tinyint(4) NOT NULL COMMENT 'Whether this is a live or test transaction',
KEY `end_time` (`end_time`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
");
return _stripe_civix_civicrm_install();
}
/**
* Implementation of hook_civicrm_uninstall
* Implementation of hook_civicrm_uninstall().
*/
function stripe_civicrm_uninstall() {
//Remove Stripe tables on uninstall
// Remove Stripe tables on uninstall.
require_once "CRM/Core/DAO.php";
CRM_Core_DAO::executeQuery("DROP TABLE civicrm_stripe_customers");
CRM_Core_DAO::executeQuery("DROP TABLE civicrm_stripe_plans");
......@@ -66,7 +66,7 @@ function stripe_civicrm_uninstall() {
}
/**
* Implementation of hook_civicrm_enable
* Implementation of hook_civicrm_enable().
*/
function stripe_civicrm_enable() {
CRM_Core_Session::setStatus("Stripe Payment Processor Message:
......@@ -78,7 +78,7 @@ function stripe_civicrm_enable() {
}
/**
* Implementation of hook_civicrm_disable
* Implementation of hook_civicrm_disable().
*/
function stripe_civicrm_disable() {
return _stripe_civix_civicrm_disable();
......@@ -97,9 +97,9 @@ function stripe_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _stripe_civix_civicrm_upgrade($op, $queue);
}
/**
* Implementation of hook_civicrm_buildForm().
*
* @param $formName - the name of the form
* @param $form - reference to the form object
*/
......@@ -117,18 +117,18 @@ function stripe_civicrm_buildForm($formName, &$form) {
}
/**
* Implementation of hook_civicrm_managed
* Implementation of hook_civicrm_managed().
*
* Generate a list of entities to create/deactivate/delete when this module
* is installed, disabled, uninstalled.
*/
function stripe_civicrm_managed(&$entities) {
$entities[] = array(
'module' => 'com.drastikbydesign.stripe',
'name' => 'Stripe',
'entity' => 'PaymentProcessorType',
'params' => array(
'version' => 3,
'module' => 'com.drastikbydesign.stripe',
'name' => 'Stripe',
'entity' => 'PaymentProcessorType',
'params' => array(
'version' => 3,
'name' => 'Stripe',
'title' => 'Stripe',
'description' => 'Stripe Payment Processor',
......@@ -136,7 +136,7 @@ function stripe_civicrm_managed(&$entities) {
'billing_mode' => 'form',
'user_name_label' => 'Secret Key',
'password_label' => 'Publishable Key',
'url_site_default'=> 'https://api.stripe.com/v1',
'url_site_default'=> 'https://api.stripe.com/v1',
'url_recur_default' => 'https://api.stripe.com/v1',
'url_site_test_default' => 'https://api.stripe.com/v1',
'url_recur_test_default' => 'https://api.stripe.com/v1',
......@@ -144,5 +144,6 @@ function stripe_civicrm_managed(&$entities) {
'payment_type' => 1
),
);
return _stripe_civix_civicrm_managed($entities);
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment