Payment plugin v1

Fully functional payment plugin

Author: harunaka11037

.travis.yml

@@ -0,0 +1,66 @@
+language: php
+
+addons:
+  postgresql: "9.6"
+
+services:
+  - mysql
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+    - $HOME/.npm
+
+dist: xenial
+
+matrix:
+  include:
+    - php: 7.0
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_35_STABLE
+    - php: 7.0
+      env: DB=pgsql  MOODLE_BRANCH=MOODLE_35_STABLE
+    - php: 7.1
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_35_STABLE
+    - php: 7.1
+      env: DB=pgsql  MOODLE_BRANCH=MOODLE_35_STABLE
+    - php: 7.1
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_36_STABLE
+    - php: 7.1
+      env: DB=pgsql  MOODLE_BRANCH=MOODLE_36_STABLE
+    - php: 7.2
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_37_STABLE
+    - php: 7.2
+      env: DB=pgsql  MOODLE_BRANCH=MOODLE_37_STABLE
+    - php: 7.2
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_38_STABLE
+    - php: 7.2
+      env: DB=pgsql  MOODLE_BRANCH=MOODLE_38_STABLE
+    - php: 7.2
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_39_STABLE
+    - php: 7.2
+      env: DB=pgsql  MOODLE_BRANCH=MOODLE_39_STABLE
+    - php: 7.2
+      env: DB=mysqli MOODLE_BRANCH=master
+    - php: 7.2
+      env: DB=pgsql  MOODLE_BRANCH=master
+
+before_install:
+  - phpenv config-rm xdebug.ini
+  - cd ../..
+  - composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
+  - export PATH="$(cd ci/bin; pwd):$(cd ci/vendor/bin; pwd):$PATH"
+
+install:
+  - moodle-plugin-ci add-plugin Peterburnett/QUTCapstone2020-enrol
+  - moodle-plugin-ci install -vvv
+
+script:
+  - moodle-plugin-ci phplint
+  - moodle-plugin-ci codechecker
+  - moodle-plugin-ci validate
+  - moodle-plugin-ci savepoints
+  - moodle-plugin-ci mustache
+# Grunt task disabled due to bugs
+#  - moodle-plugin-ci grunt
+  - moodle-plugin-ci phpunit -vvv
+  - moodle-plugin-ci behat

README.md

@@ -1,2 +1,87 @@
-# QUTCapstone2020
-Repository for the development of a payment gateway plugin for Moodle LMS.
+# QUTCapstone2020-Payment-Plugin
+
+* [What is this?](#what-is-this)
+* [Why design a payment plugin?](#Why-design-a-payment-plugin)
+* [Repositories](#Repositories)
+* [Version requirement](#Version-requirement)
+* [Installation](#installation)
+* [How to use these plugins?](#How-to-use-these-plugins)
+* [PayPal payment gateway subplugin](#PayPal-payment-gateway-subplugin)
+* [Support](#Support) 
+
+## What is this?
+This is a moodle plugin which adds a Paypal/credit card payment gateway to your courses.
+
+## Why design a payment plugin
+There are currently no easy to use payment plugins within the moodle plugin directory.
+Plugins that allow an admin to lock a course behind a payment already exist:
+
+(Default moodle intergrated Paypal payment gateway) https://github.com/moodle/moodle/tree/master/enrol/paypal.
+
+(Moodle payment software run through https://stripe.com) https://moodle.org/plugins/enrol_stripepayment.
+
+However, the major difference between our software and the two examples listed above is the flexibility of our plugin.
+This plugin can accomodate for multiple payment gateways through the use of subplugins.
+
+## Repositories
+There are currently two required repositories to make this plugin work.
+
+The repository that is responsible for setting up the gate ways and managing all the data:
+
+https://github.com/Peterburnett/QUTCapstone2020 
+
+The other repository responsible for displaying the website hook:
+
+https://github.com/Peterburnett/QUTCapstone2020-enrol
+
+## Version requirement
+
+To run this plugin with the enrolment plugin (https://github.com/Peterburnett/QUTCapstone2020-enrol), the enrolement plugin need to be atleast at version 2020082600.
+The enrolment plugin  requires a payment plugin version to be 2020042101+.
+
+## Installation
+
+Step 1: Installing the plugin
+-------------------------------
+Download the .zip file the from the `master` https://github.com/Peterburnett/QUTCapstone2020.
+
+Extract this into /yourmoodle/admin/tool/paymentplugin/
+
+Step 2: Installing the enrolment plugin
+-------------------------------
+Download the .zip file from the `master` https://github.com/Peterburnett/QUTCapstone2020-enrol.
+
+Extract this into /yourmoodle/admin/enrol/payment
+
+Step 3: Upgrading moodle
+-------------------------------
+Then run the moodle upgrade as normal.
+
+https://docs.moodle.org/en/Installing_plugins
+
+## How to use these plugins
+
+1. Enable the enrolment plugin.
+2. Add an instance of the enrolment plugin to a course that will require payment.
+3. Set the course price from Course Administration -> Payment Settings.
+4. In the admin tool plugin settings, enable payment gateways that the students will be able to use.
+5. Change admin tool plugin settings and payment gateway subplugin settings as necessary.
+6. The course will now display a button to unenrolled students, redirecting them to a page where the course can be purchased through the payment gateways.
+
+## PayPal payment gateway subplugin
+
+The admin tool plugin comes with a PayPal subplugin pre-installed. This subplugin requires the admin to have a PayPal business account.
+
+## Support
+
+This plugin was developed by QUT MAHQ Developers as a Capstone project.
+Haruki Nakagawa - harukinn(at)icloud(dot)com
+Quyen Nguyen - qnguy29(at)gmail(dot)com
+Aaron Dang - aarondang(at)hotmail(dot)com
+Mitchell Halpin - mhalp1406 (at) gmail (dot) com
+
+
+With the support of Catalyst IT Australia:
+https://www.catalyst-au.net/
+
+<img alt="Catalyst IT" src="https://cdn.rawgit.com/CatalystIT-AU/moodle-auth_saml2/master/pix/catalyst-logo.svg" width="400">

amd/build/purchase.min.js

@@ -0,0 +1,46 @@
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * AJAX request for the purchase.php page.
+ *
+ * @package   tool_paymentplugin
+ * @module    tool_paymentplugin/purchase
+ * @author    Haruki Nakagawa
+ * @copyright 2020 MAHQ
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+define(['core/ajax'], function(Ajax) {
+    return {
+        purchasecheck: function(courseid, userid, redirecturl) {
+            var request =  {
+                methodname: 'tool_paymentplugin_check_enrolled',
+                args: {
+                    courseid: courseid,
+                    userid: userid
+                }
+            };
+            Ajax.call([request])[0].done(
+                function(data) {
+                    if (data == true) {
+                        document.location = redirecturl;
+                    }
+                }
+            ).fail();
+            setInterval(this.purchasecheck, 10000, courseid, userid, redirecturl);
+        }
+    };
+});

amd/build/purchase.min.js.map

@@ -0,0 +1,85 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * External functions for tool_paymentplugin.
+ *
+ * @package   tool_paymentplugin
+ * @author    Haruki Nakagawa
+ * @copyright 2020 MAHQ
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace tool_paymentplugin\external;
+
+defined('MOODLE_INTERNAL') || die();
+
+use external_api;
+use external_function_parameters;
+use external_value;
+
+require_once("$CFG->libdir/externallib.php");
+
+class external extends external_api {
+
+    /**
+     * Returns description of check_enrolled() parameters.
+     * @return external_function_parameters
+     */
+    public static function check_enrolled_parameters() {
+        return new external_function_parameters(
+            array(
+                'courseid' => new external_value(PARAM_INT, 'id of course'),
+                'userid' => new external_value(PARAM_INT, 'id of user')
+            )
+        );
+    }
+
+    /**
+     * Checks database to see if a user is enrolled in a course, and redirects the user if so.
+     *
+     * @param int $courseid
+     * @param int $userid
+     * @return bool
+     */
+    public static function check_enrolled($courseid, $userid) {
+        global $DB;
+
+        $params = self::validate_parameters(self::check_enrolled_parameters(), array(
+            'courseid' => $courseid,
+            'userid' => $userid
+        ));
+
+        $courseid = $params['courseid'];
+        $userid = $params['userid'];
+
+        $query = "SELECT *
+                    FROM {user_enrolments}
+                    JOIN {enrol} ON {user_enrolments}.enrolid = {enrol}.id
+                   WHERE {enrol}.courseid = $courseid AND {user_enrolments}.userid = $userid";
+
+        $enrolled = $DB->record_exists_sql($query);
+        return $enrolled;
+    }
+
+    /**
+     * Returns description of check_enrolled() return values.
+     * @return external_value the value returned from the function.
+     */
+    public static function check_enrolled_returns() {
+        return new external_value(PARAM_BOOL, 'Whether the user is enrolled in the course.');
+    }
+}

amd/src/purchase.js

@@ -0,0 +1,71 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Form for the course settings page.
+ *
+ * @package     tool_paymentplugin
+ * @author      Mitchell Halpin
+ * @author      Haruki Nakagawa
+ *
+ * @copyright   MAHQ
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ **/
+
+namespace tool_paymentplugin\form;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir.'/formslib.php');
+
+class course_settings extends \moodleform {
+
+    /**
+     * Creates the form for course settings.
+     *
+     * @return void
+     */
+    public function definition() {
+        global $DB;
+
+        $mform = $this->_form;
+        $courseid = $this->_customdata['id'];
+        $mform->addElement('text', 'coursecost', 'Course Cost');
+        $mform->setType('coursecost', PARAM_LOCALISEDFLOAT);
+        $tablename = 'tool_paymentplugin_course';
+        $cost = 0;
+
+        if ($DB->record_exists($tablename, ['courseid' => $courseid])) {
+            $cost = $DB->get_field($tablename, 'cost', ['courseid' => $courseid]);
+        }
+
+        $mform->setDefault('coursecost', $cost);
+        $this->add_action_buttons(true);
+    }
+
+    /**
+     * Additional validation checks
+     *
+     * @return array of errors
+     */
+    public function validation($data, $files) {
+        $errors = parent::validation($data, $files);
+        if ($data['coursecost'] < 0) {
+            $errors['coursecost'] = get_string('errorcoursecost', 'tool_paymentplugin');
+        }
+        return $errors;
+    }
+}