├── README.md
├── payment_form.php
└── PaymentPaypal.module


/README.md:
--------------------------------------------------------------------------------
 1 | # PaymentPaypal
 2 | PayPal payment method for ProcessWire
 3 | 
 4 | ## Requirements
 5 | Requires PaymentModule -module
 6 | 
 7 | ## Example
 8 | 
 9 | ```PHP
10 | 
11 | // Load the module and setup payment
12 | $payment = $modules->get("PaymentPaypal");
13 | $payment->setCurrency("EUR");
14 | $payment->setId(123456789);
15 | 
16 | $customer = Array();
17 | $customer['givenName'] = "Antti";
18 | $customer['familyName'] = "Peisa";
19 | $customer['streetAddress'] = "Some Street";
20 | $customer['locality'] = "Some City";
21 | $customer['postalCode'] = "12345";
22 | $customer['email'] = "antti.peisa@gmail.com";
23 | $payment->setCustomerData($customer);
24 | 
25 | $title = "Cool product";
26 | $quantity = 2;
27 | $amount = 1000; // Amount in payment modules always in cents
28 | $payment->addProduct($title, $amount, $quantity);
29 | 
30 | // In this example we are going to do all in same page
31 | $url = $page->httpUrl;
32 | $payment->setProcessUrl($url . "?step=process");
33 | $payment->setFailureUrl($url . "?step=fail");
34 | $payment->setCancelUrl($url . "?step=cancel");
35 | 
36 | switch ($input->get->step) {
37 | 	case 'process':
38 | 		if ($payment->processPayment()) {
39 | 			echo "Thanks, payment successful!";
40 | 		} else {
41 | 			echo "Are you kidding me?";
42 | 		}
43 | 		break;
44 | 
45 | 	case 'fail':
46 | 		echo "Something went wrong";
47 | 		break;
48 | 
49 | 	case 'cancel':
50 | 		echo "I think you cancelled?";
51 | 		break;
52 | 	
53 | 	default:
54 | 		echo $payment->render();
55 | 		break;
56 | }
57 | ```
58 | 
59 | ## License
60 | GPL 2.0
61 | 


--------------------------------------------------------------------------------
/payment_form.php:
--------------------------------------------------------------------------------
 1 | <form id = "paypal_checkout" action = "<?= $endpoint ?>cgi-bin/webscr" method = "post">
 2 | 
 3 |   <input name = "cmd" value = "_cart" type = "hidden">
 4 |   <input name = "upload" value = "1" type = "hidden">
 5 |   <input name = "no_note" value = "0" type = "hidden">
 6 |   <input name = "bn" value = "PP-BuyNowBF" type = "hidden">
 7 |   <input name = "tax" value = "0" type = "hidden">
 8 |   <input name = "rm" value = "2" type = "hidden">
 9 |   <input name = "charset" value = "utf-8" type = "hidden">
10 | 
11 |   <input type="hidden" name="first_name" value="<?= $customer->givenName ?>">
12 |   <input type="hidden" name="last_name" value="<?= $customer->familyName ?>">
13 |   <input type="hidden" name="address1" value="<?=  $customer->streetAddress ?>">
14 |   <input type="hidden" name="address2" value="<?=  $customer->streetAddress2 ?>">
15 |   <input type="hidden" name="city" value="<?= $customer->locality ?>">
16 |   <input type="hidden" name="zip" value="<?= $customer->postalCode ?>">
17 |   <input type="hidden" name="email" value="<?= $customer->email ?>">
18 | 
19 |   <input name = "business" value = "<?= $business ?>" type = "hidden">
20 |   <input name = "handling_cart" value = "0" type = "hidden">
21 |   <input name = "currency_code" value = "<?= $currency ?>" type = "hidden">
22 |   <input name = "lc" value = "<?= $location ?>" type = "hidden">
23 |   <input name = "return" value = "<?= $returnUrl ?>" type = "hidden">
24 |   <input name = "cbt" value = "<?= $returntxt ?>" type = "hidden">
25 |   <input name = "cancel_return" value = "<?= $cancelUrl ?>" type = "hidden">
26 |   <input name = "invoice" value = "<?= $invoice ?>" type = "hidden">
27 |   <input name="landing_page" value="Billing" type="hidden">
28 | 
29 |   <?php
30 |   $i = 0;
31 |   foreach($products as $p) {
32 |     $i = $i + 1;
33 |     $amount = $p->amount / 100;
34 |     $amount = str_replace(",", ".", $amount);
35 |     echo '<input name = "item_name_'. $i .'" value = "'. $p->title .'" type = "hidden">';
36 |     echo '<input name = "quantity_'. $i .'" value = "'. $p->quantity .'" type = "hidden">';
37 |     echo '<input name = "amount_'. $i .'" value = "'. $amount .'" type = "hidden">';
38 |     echo '<input name = "shipping_'. $i .'" value = "0" type = "hidden">';
39 |   }
40 |   ?>
41 |   
42 |   <input id="ppcheckoutbtn" value="<?= __("Click here to proceed to Paypal.com") ?>" class="button" type="submit">
43 | 
44 | </form>
45 | <!--<script>document.forms['paypal_checkout'].submit();</script>-->
46 | 


--------------------------------------------------------------------------------
/PaymentPaypal.module:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * 
  5 |  * PayPal payment method for ProcessWire
  6 |  * 2015-2016 - Antti Peisa
  7 |  * 
  8 |  * Uses PayPal standard payment API and PDT for payment verification. 
  9 |  * 
 10 |  * Big thanks to Torleif Berger for this article:
 11 |  * http://www.geekality.net/2010/10/19/php-tutorial-paypal-payment-data-transfers-pdt/
 12 |  * 
 13 |  */
 14 | 
 15 | 
 16 | 
 17 | class PaymentPaypal extends PaymentModule {
 18 | 
 19 |   public static function getModuleInfo() {
 20 |     return array(
 21 |       'title' => 'PaymentPaypal', 
 22 |       'version' => 001, 
 23 |       'summary' => 'PaymentPaypal - using standard payment API and PDT for verification',
 24 |       'singular' => false,
 25 |       'autoload' => false, 
 26 |       'requires' => 'PaymentModule'
 27 |     );
 28 |   }
 29 | 
 30 |   public function init() {
 31 |     $this->currency = $this->defaultCurrency;
 32 |   }
 33 | 
 34 |   public function getTitle() {
 35 |     return $this->_("PayPal");
 36 |   }
 37 | 
 38 |   public function getFailureReason() {
 39 |     return $this->session->paypalError;
 40 |   }
 41 | 
 42 |   public function processPayment() {
 43 | 
 44 |     $tx = $this->input->get->tx;
 45 |     $postParams = array(
 46 |       'cmd' => '_notify-synch',
 47 |       'tx' => $tx, 
 48 |       'at' => $this->identityToken 
 49 |     ); 
 50 | 
 51 |     $endpoint = $this->endpoint . 'cgi-bin/webscr';
 52 | 
 53 |     if ($this->curl) {
 54 |       $ch = curl_init();
 55 |       curl_setopt($ch,CURLOPT_URL, $endpoint);
 56 |       curl_setopt($ch,CURLOPT_POST, count($postParams));
 57 |       curl_setopt($ch,CURLOPT_POSTFIELDS, http_build_query($postParams));
 58 |       curl_setopt($ch,CURLOPT_RETURNTRANSFER, TRUE);
 59 |       curl_setopt($ch,CURLOPT_HEADER, FALSE);
 60 |       curl_setopt($ch,CURLOPT_SSLVERSION, 6);
 61 |       $response = curl_exec($ch); 
 62 |     } else {
 63 |       $http = new WireHttp();
 64 |       $response = $http->post($endpoint, $postParams); 
 65 |     }
 66 | 
 67 |     if (! $response) {
 68 |       throw new WireException("Couldn't get access into ");
 69 |       
 70 |     }
 71 | 
 72 |     // Response should start with SUCCESS, otherwise something fishy going on (or more likely PayPal changing something...)
 73 |     if( ! strpos($response, 'SUCCESS') === 0) {
 74 |       // TODO: We could do much better error handling here
 75 |       if (strpos($response, "4020")) $this->session->paypalError = "PayPal error 4020. Most probably wrong or missing Identity Token";
 76 |       else $this->session->paypalError = $response;
 77 |       return false;
 78 |     }
 79 |     
 80 |     // Clean the messy response into an array
 81 |     $data = substr($response, 7);
 82 |     $data = urldecode($data);
 83 |     preg_match_all('/^([^=\s]++)=(.*+)/m', $data, $m, PREG_PATTERN_ORDER);
 84 |     $data = array_combine($m[1], $m[2]);
 85 | 
 86 |     // Verify payment to have same id and amount that we except
 87 |     $amount = $data['mc_gross'] * 100;
 88 |     if ($this->getTotalAmount()  ==  $amount && $this->id == $data['invoice']) {
 89 |       return true;
 90 |     } 
 91 |     
 92 |     return false;
 93 |   }
 94 | 
 95 |   public function render() {
 96 | 
 97 |     if ($this->getTotalAmount() <= 0) throw new WireException("Products are not set");
 98 |     if ($this->processUrl == '') throw new WireException("processUrl is not set");
 99 | 
100 |     $formTemplate = new TemplateFile(__DIR__ . DIRECTORY_SEPARATOR . "payment_form.php");
101 |     $formTemplate->set("invoice", $this->id);
102 |     $formTemplate->set("endpoint", $this->endpoint);
103 |     $formTemplate->set("customer", $this->customer);
104 |     $formTemplate->set("products", $this->products);
105 |     $formTemplate->set("business", $this->business);
106 |     $formTemplate->set("currency", $this->currency);
107 |     $formTemplate->set("location", $this->location);
108 |     $formTemplate->set("returnUrl", $this->processUrl);
109 |     $formTemplate->set("returntxt", $this->returntxt);
110 |     $formTemplate->set("cancelUrl", $this->cancelUrl);
111 | 
112 |     return $formTemplate->render();
113 |   }
114 | 
115 |   public static function getModuleConfigInputfields(array $data) {
116 |     $inputfields = new InputfieldWrapper();
117 | 
118 |     $field = wire('modules')->get('InputfieldText');
119 |     $field->name = 'currency';
120 |     $field->label = __("Default currency");
121 |     $field->notes = __("Use this currency by default (always possible to overwrite when using this module from API)");
122 |     if(isset($data['currency'])) $field->value = $data['currency'];
123 |     $inputfields->add($field);
124 | 
125 |     $field = wire('modules')->get('InputfieldText');
126 |     $field->name = 'returntxt';
127 |     $field->label = __("Return to store text at PayPal");
128 |     $field->notes = __("Text that is shown on back to store buttons at PayPal.");
129 |     if(isset($data['returntxt'])) $field->value = $data['returntxt'];
130 |     $inputfields->add($field);
131 | 
132 |     $field = wire('modules')->get('InputfieldText');
133 |     $field->name = 'location';
134 |     $field->label = __("Location");
135 |     $field->notes = __("Location code, ie. GB");
136 |     if(isset($data['location'])) $field->value = $data['location'];
137 |     $inputfields->add($field);
138 | 
139 |     $field = wire('modules')->get('InputfieldText');
140 |     $field->name = 'endpoint';
141 |     $field->label = __("API Endpoint");
142 |     $field->notes = __("Either https://www.paypal.com/ or https://www.sandbox.paypal.com/ depending if testing or not");
143 |     if(isset($data['endpoint'])) $field->value = $data['endpoint'];
144 |     $inputfields->add($field);
145 | 
146 |     
147 |     $field = wire('modules')->get('InputfieldText');
148 |     $field->name = 'identityToken';
149 |     $field->label = __("Identity Token");
150 |     $field->notes = __("Payment Data Transfer Identity Token (can be found from paypal.com => LOGIN => Profile => My selling preferences => Website preferences");
151 |     if(isset($data['identityToken'])) $field->value = $data['identityToken'];
152 |     $inputfields->add($field);
153 | 
154 |     $field = wire('modules')->get('InputfieldEmail');
155 |     $field->name = 'business';
156 |     $field->label = __("PayPal email");
157 |     if(isset($data['business'])) $field->value = $data['business'];
158 |     $inputfields->add($field);
159 | 
160 |     $field = wire('modules')->get("InputfieldMarkup");
161 |     $field->label = __("Additional information");
162 |     $field->value = "Make sure you have Auto Return and Payment Data Transfer set to ON from <a href='https://www.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-website-payments'>PayPal website preferences</a>";
163 |     $inputfields->add($field);
164 | 
165 |     $field = wire('modules')->get("InputfieldCheckbox");
166 |     $field->name = 'curl';
167 |     $field->label = __("Use cURL for payment validation");
168 |     $field->description = __("If your successfull payment's doesn't validate, you might want to try this cURL based verification instead of the standard (WireHttp)");
169 |     $field->value = 1;
170 |     $field->attr('checked', empty($data['curl']) ? '' : 'checked');
171 |     $inputfields->add($field);
172 | 
173 |     return $inputfields;
174 |   }
175 | }
176 | 


--------------------------------------------------------------------------------