MDL-31424 compare PayPal emails case-insensitively
[moodle.git] / enrol / paypal / ipn.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Listens for Instant Payment Notification from PayPal
19  *
20  * This script waits for Payment notification from PayPal,
21  * then double checks that data by sending it back to PayPal.
22  * If PayPal verifies this then it sets up the enrolment for that
23  * user.
24  *
25  * @package    enrol
26  * @subpackage paypal
27  * @copyright 2010 Eugene Venter
28  * @author     Eugene Venter - based on code by others
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
33 require("../../config.php");
34 require_once("lib.php");
35 require_once($CFG->libdir.'/eventslib.php');
36 require_once($CFG->libdir.'/enrollib.php');
37 require_once($CFG->libdir . '/filelib.php');
40 /// Keep out casual intruders
41 if (empty($_POST) or !empty($_GET)) {
42     print_error("Sorry, you can not use the script that way.");
43 }
45 /// Read all the data from PayPal and get it ready for later;
46 /// we expect only valid UTF-8 encoding, it is the responsibility
47 /// of user to set it up properly in PayPal business account,
48 /// it is documented in docs wiki.
50 $req = 'cmd=_notify-validate';
52 $data = new stdClass();
54 foreach ($_POST as $key => $value) {
55     $req .= "&$key=".urlencode($value);
56     $data->$key = $value;
57 }
59 $custom = explode('-', $data->custom);
60 $data->userid           = (int)$custom[0];
61 $data->courseid         = (int)$custom[1];
62 $data->instanceid       = (int)$custom[2];
63 $data->payment_gross    = $data->mc_gross;
64 $data->payment_currency = $data->mc_currency;
65 $data->timeupdated      = time();
68 /// get the user and course records
70 if (! $user = $DB->get_record("user", array("id"=>$data->userid))) {
71     message_paypal_error_to_admin("Not a valid user id", $data);
72     die;
73 }
75 if (! $course = $DB->get_record("course", array("id"=>$data->courseid))) {
76     message_paypal_error_to_admin("Not a valid course id", $data);
77     die;
78 }
80 if (! $context = context_course::instance($course->id, IGNORE_MISSING)) {
81     message_paypal_error_to_admin("Not a valid context id", $data);
82     die;
83 }
85 if (! $plugin_instance = $DB->get_record("enrol", array("id"=>$data->instanceid, "status"=>0))) {
86     message_paypal_error_to_admin("Not a valid instance id", $data);
87     die;
88 }
90 $plugin = enrol_get_plugin('paypal');
92 /// Open a connection back to PayPal to validate the data
93 $paypaladdr = empty($CFG->usepaypalsandbox) ? 'www.paypal.com' : 'www.sandbox.paypal.com';
94 $c = new curl();
95 $options = array(
96     'returntransfer' => true,
97     'httpheader' => array('application/x-www-form-urlencoded', "Host: $paypaladdr"),
98     'timeout' => 30,
99     'CURLOPT_HTTP_VERSION' => CURL_HTTP_VERSION_1_1,
100 );
101 $location = "https://$paypaladdr/cgi-bin/webscr";
102 $result = $c->post($location, $req, $options);
104 if (!$result) {  /// Could not connect to PayPal - FAIL
105     echo "<p>Error: could not access paypal.com</p>";
106     message_paypal_error_to_admin("Could not access paypal.com to verify payment", $data);
107     die;
110 /// Connection is OK, so now we post the data to validate it
112 /// Now read the response and check if everything is OK.
114 if (strlen($result) > 0) {
115     if (strcmp($result, "VERIFIED") == 0) {          // VALID PAYMENT!
118         // check the payment_status and payment_reason
120         // If status is not completed or pending then unenrol the student if already enrolled
121         // and notify admin
123         if ($data->payment_status != "Completed" and $data->payment_status != "Pending") {
124             $plugin->unenrol_user($plugin_instance, $data->userid);
125             message_paypal_error_to_admin("Status not completed or pending. User unenrolled from course", $data);
126             die;
127         }
129         // If currency is incorrectly set then someone maybe trying to cheat the system
131         if ($data->mc_currency != $plugin_instance->currency) {
132             message_paypal_error_to_admin("Currency does not match course settings, received: ".$data->mc_currency, $data);
133             die;
134         }
136         // If status is pending and reason is other than echeck then we are on hold until further notice
137         // Email user to let them know. Email admin.
139         if ($data->payment_status == "Pending" and $data->pending_reason != "echeck") {
140             $eventdata = new stdClass();
141             $eventdata->modulename        = 'moodle';
142             $eventdata->component         = 'enrol_paypal';
143             $eventdata->name              = 'paypal_enrolment';
144             $eventdata->userfrom          = get_admin();
145             $eventdata->userto            = $user;
146             $eventdata->subject           = "Moodle: PayPal payment";
147             $eventdata->fullmessage       = "Your PayPal payment is pending.";
148             $eventdata->fullmessageformat = FORMAT_PLAIN;
149             $eventdata->fullmessagehtml   = '';
150             $eventdata->smallmessage      = '';
151             message_send($eventdata);
153             message_paypal_error_to_admin("Payment pending", $data);
154             die;
155         }
157         // If our status is not completed or not pending on an echeck clearance then ignore and die
158         // This check is redundant at present but may be useful if paypal extend the return codes in the future
160         if (! ( $data->payment_status == "Completed" or
161                ($data->payment_status == "Pending" and $data->pending_reason == "echeck") ) ) {
162             die;
163         }
165         // At this point we only proceed with a status of completed or pending with a reason of echeck
169         if ($existing = $DB->get_record("enrol_paypal", array("txn_id"=>$data->txn_id))) {   // Make sure this transaction doesn't exist already
170             message_paypal_error_to_admin("Transaction $data->txn_id is being repeated!", $data);
171             die;
173         }
175         if (textlib::strtolower($data->business) !== textlib::strtolower($plugin->get_config('paypalbusiness'))) {   // Check that the email is the one we want it to be
176             message_paypal_error_to_admin("Business email is {$data->business} (not ".
177                     $plugin->get_config('paypalbusiness').")", $data);
178             die;
180         }
182         if (!$user = $DB->get_record('user', array('id'=>$data->userid))) {   // Check that user exists
183             message_paypal_error_to_admin("User $data->userid doesn't exist", $data);
184             die;
185         }
187         if (!$course = $DB->get_record('course', array('id'=>$data->courseid))) { // Check that course exists
188             message_paypal_error_to_admin("Course $data->courseid doesn't exist", $data);;
189             die;
190         }
192         $coursecontext = context_course::instance($course->id, IGNORE_MISSING);
194         // Check that amount paid is the correct amount
195         if ( (float) $plugin_instance->cost <= 0 ) {
196             $cost = (float) $plugin->get_config('cost');
197         } else {
198             $cost = (float) $plugin_instance->cost;
199         }
201         if ($data->payment_gross < $cost) {
202             $cost = format_float($cost, 2);
203             message_paypal_error_to_admin("Amount paid is not enough ($data->payment_gross < $cost))", $data);
204             die;
206         }
208         // ALL CLEAR !
210         $DB->insert_record("enrol_paypal", $data);
212         if ($plugin_instance->enrolperiod) {
213             $timestart = time();
214             $timeend   = $timestart + $plugin_instance->enrolperiod;
215         } else {
216             $timestart = 0;
217             $timeend   = 0;
218         }
220         // Enrol user
221         $plugin->enrol_user($plugin_instance, $user->id, $plugin_instance->roleid, $timestart, $timeend);
223         // Pass $view=true to filter hidden caps if the user cannot see them
224         if ($users = get_users_by_capability($context, 'moodle/course:update', 'u.*', 'u.id ASC',
225                                              '', '', '', '', false, true)) {
226             $users = sort_by_roleassignment_authority($users, $context);
227             $teacher = array_shift($users);
228         } else {
229             $teacher = false;
230         }
232         $mailstudents = $plugin->get_config('mailstudents');
233         $mailteachers = $plugin->get_config('mailteachers');
234         $mailadmins   = $plugin->get_config('mailadmins');
235         $shortname = format_string($course->shortname, true, array('context' => $context));
238         if (!empty($mailstudents)) {
239             $a->coursename = format_string($course->fullname, true, array('context' => $coursecontext));
240             $a->profileurl = "$CFG->wwwroot/user/view.php?id=$user->id";
242             $eventdata = new stdClass();
243             $eventdata->modulename        = 'moodle';
244             $eventdata->component         = 'enrol_paypal';
245             $eventdata->name              = 'paypal_enrolment';
246             $eventdata->userfrom          = $teacher;
247             $eventdata->userto            = $user;
248             $eventdata->subject           = get_string("enrolmentnew", 'enrol', $shortname);
249             $eventdata->fullmessage       = get_string('welcometocoursetext', '', $a);
250             $eventdata->fullmessageformat = FORMAT_PLAIN;
251             $eventdata->fullmessagehtml   = '';
252             $eventdata->smallmessage      = '';
253             message_send($eventdata);
255         }
257         if (!empty($mailteachers)) {
258             $a->course = format_string($course->fullname, true, array('context' => $coursecontext));
259             $a->user = fullname($user);
261             $eventdata = new stdClass();
262             $eventdata->modulename        = 'moodle';
263             $eventdata->component         = 'enrol_paypal';
264             $eventdata->name              = 'paypal_enrolment';
265             $eventdata->userfrom          = $user;
266             $eventdata->userto            = $teacher;
267             $eventdata->subject           = get_string("enrolmentnew", 'enrol', $shortname);
268             $eventdata->fullmessage       = get_string('enrolmentnewuser', 'enrol', $a);
269             $eventdata->fullmessageformat = FORMAT_PLAIN;
270             $eventdata->fullmessagehtml   = '';
271             $eventdata->smallmessage      = '';
272             message_send($eventdata);
273         }
275         if (!empty($mailadmins)) {
276             $a->course = format_string($course->fullname, true, array('context' => $coursecontext));
277             $a->user = fullname($user);
278             $admins = get_admins();
279             foreach ($admins as $admin) {
280                 $eventdata = new stdClass();
281                 $eventdata->modulename        = 'moodle';
282                 $eventdata->component         = 'enrol_paypal';
283                 $eventdata->name              = 'paypal_enrolment';
284                 $eventdata->userfrom          = $user;
285                 $eventdata->userto            = $admin;
286                 $eventdata->subject           = get_string("enrolmentnew", 'enrol', $shortname);
287                 $eventdata->fullmessage       = get_string('enrolmentnewuser', 'enrol', $a);
288                 $eventdata->fullmessageformat = FORMAT_PLAIN;
289                 $eventdata->fullmessagehtml   = '';
290                 $eventdata->smallmessage      = '';
291                 message_send($eventdata);
292             }
293         }
295     } else if (strcmp ($result, "INVALID") == 0) { // ERROR
296         $DB->insert_record("enrol_paypal", $data, false);
297         message_paypal_error_to_admin("Received an invalid payment notification!! (Fake payment?)", $data);
298     }
301 exit;
304 //--- HELPER FUNCTIONS --------------------------------------------------------------------------------------
307 function message_paypal_error_to_admin($subject, $data) {
308     echo $subject;
309     $admin = get_admin();
310     $site = get_site();
312     $message = "$site->fullname:  Transaction failed.\n\n$subject\n\n";
314     foreach ($data as $key => $value) {
315         $message .= "$key => $value\n";
316     }
318     $eventdata = new stdClass();
319     $eventdata->modulename        = 'moodle';
320     $eventdata->component         = 'enrol_paypal';
321     $eventdata->name              = 'paypal_enrolment';
322     $eventdata->userfrom          = $admin;
323     $eventdata->userto            = $admin;
324     $eventdata->subject           = "PAYPAL ERROR: ".$subject;
325     $eventdata->fullmessage       = $message;
326     $eventdata->fullmessageformat = FORMAT_PLAIN;
327     $eventdata->fullmessagehtml   = '';
328     $eventdata->smallmessage      = '';
329     message_send($eventdata);