Change version

List events

README.md

@@ -2,12 +2,23 @@
 [![GitHub Release](https://img.shields.io/github/release/valentineus/moodle-webhooks.svg)](https://github.com/valentineus/moodle-webhooks/releases)
 [![Build Status](https://travis-ci.org/valentineus/moodle-webhooks.svg?branch=master)](https://travis-ci.org/valentineus/moodle-webhooks)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/376ab669f2d3436884015554f686a915)](https://www.codacy.com/app/valentineus/moodle-webhooks)
-[![Gitter Badge](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/valentineus/auth-link)
+[![Gitter Badge](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/valentineus/moodle-webhooks)
 
-Webhooks allow applications to subscribe to Moodle events.
+Adding Webhooks to Moodle.
+The Webhooks feature allows applications to receive real-time notification of changes to certain data.
 
-**Attention!**:
-This plugin is in active development.
+Using Webhooks, your application will be able to receive notifications of changes to selected topics and their fields.
+Because of this, you do not have to rely on continuous or even periodic requests to check for updates.
+Notifications about Webhooks updates are sent as POST requests to the callback URL you specified.
+Notifications can indicate the very fact of a field change or include a new value.
+
+Features:
+
+* Use any number of services for notification;
+* Customizing each external service;
+* Interception of all events in the Moodle system;
+* Use a secret phrase to authenticate requests;
+* [JSON](https://en.wikipedia.org/wiki/JSON) - Format of outgoing data;
 
 ## Installation
 

classes/curl.php

@@ -1,51 +0,0 @@
-<?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/>.
-
-/**
- * Create a class for sending data.
- *
- * @package   local_webhooks
- * @copyright 2017 "Valentin Popov" <info@valentineus.link>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace local_webhooks;
-
-defined("MOODLE_INTERNAL") || die();
-
-class curl {
-    public function __construct() {
-        if (!function_exists("curl_init")) {
-            print_error("nocurl", "mnet");
-        }
-    }
-
-    public static function request($url, $data) {
-        $ch = curl_init($url);
-        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
-        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
-        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($ch, CURLOPT_HTTPHEADER,
-            array(
-                "Content-Type: application/json",
-                "Content-Length: " . strlen($data))
-            );
-
-        $result = curl_exec($ch);
-        curl_close($ch);
-        return $result;
-    }
-}

classes/editform.php

@@ -0,0 +1,154 @@
+<?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/>.
+
+/**
+ * Defines forms.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks;
+
+defined("MOODLE_INTERNAL") || die();
+
+require_once($CFG->libdir . "/formslib.php");
+
+use lang_string;
+use moodleform;
+use report_eventlist_list_generator;
+
+/**
+ * Description editing form definition.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class service_edit_form extends moodleform {
+    /**
+     * @param string $baseurl
+     */
+    public function __construct($baseurl) {
+        parent::__construct($baseurl);
+    }
+
+    /**
+     * Preparing data before displaying.
+     *
+     * @param object $record
+     */
+    public function set_data($record) {
+        if (!empty($record->events)) {
+            $record->events = unserialize(gzuncompress(base64_decode($record->events)));
+        }
+
+        return parent::set_data($record);
+    }
+
+    /**
+     * Defines the standard structure of the form.
+     */
+    protected function definition() {
+        $mform =& $this->_form;
+        $size  = array("size" => 60);
+
+        /* Form heading */
+        $mform->addElement("header", "editserviceheader", new lang_string("service", "webservice"));
+
+        /* Name of the service */
+        $mform->addElement("text", "title", new lang_string("name", "moodle"), $size);
+        $mform->addRule("title", null, "required");
+        $mform->setType("title", PARAM_NOTAGS);
+
+        /* Callback address */
+        $mform->addElement("text", "url", new lang_string("url", "moodle"), $size);
+        $mform->addRule("url", null, "required");
+        $mform->setType("url", PARAM_URL);
+
+        /* Enabling the service */
+        $mform->addElement("advcheckbox", "enable", new lang_string("enable", "moodle"));
+        $mform->setType("enable", PARAM_BOOL);
+        $mform->setDefault("enable", 1);
+        $mform->setAdvanced("enable");
+
+        /* Token */
+        $mform->addElement("text", "token", new lang_string("token", "webservice"), $size);
+        $mform->setType("token", PARAM_NOTAGS);
+
+        /* Additional information */
+        $mform->addElement("text", "other", new lang_string("sourceext", "plugin"), $size);
+        $mform->setType("other", PARAM_NOTAGS);
+        $mform->setAdvanced("other");
+
+        /* Content type */
+        $contenttype = array("json" => "application/json", "x-www-form-urlencoded" => "application/x-www-form-urlencoded");
+        $mform->addElement("select", "type", "Content type", $contenttype);
+        $mform->setAdvanced("type");
+
+        /* Form heading */
+        $mform->addElement("header", "editserviceheaderevent", new lang_string("edulevel", "moodle"));
+
+        /* List of events */
+        $eventlist = report_eventlist_list_generator::get_all_events_list(true);
+        $events    = array();
+
+        /* Formation of the list of elements */
+        foreach ($eventlist as $event) {
+            $events[$event["component"]][] =& $mform->createElement("checkbox", $event["eventname"], $event["eventname"]);
+        }
+
+        /* Displays groups of items */
+        foreach ($events as $key => $event) {
+            $mform->addGroup($event, "events", $key, "<br />", true);
+        }
+
+        /* Control Panel */
+        $this->add_action_buttons(true);
+    }
+}
+
+/**
+ * Description of the form of restoration.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class service_backup_form extends moodleform {
+    /**
+     * @param string $baseurl
+     */
+    public function __construct($baseurl) {
+        parent::__construct($baseurl);
+    }
+
+    /**
+     * Defines the standard structure of the form.
+     */
+    protected function definition() {
+        $mform =& $this->_form;
+
+        /* Form heading */
+        $mform->addElement("header", "editserviceheader", new lang_string("restore", "moodle"));
+
+        /* Download the file */
+        $mform->addElement("filepicker", "backupfile", new lang_string("file", "moodle"));
+        $mform->addRule("backupfile", null, "required");
+
+        /* Control Panel */
+        $this->add_action_buttons(true, new lang_string("restore", "moodle"));
+    }
+}

classes/event/backup_performed.php

@@ -0,0 +1,65 @@
+<?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/>.
+
+/**
+ * Registration of the system of events.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks\event;
+
+defined("MOODLE_INTERNAL") || die();
+
+/**
+ * Defines how to work with events.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class backup_performed extends \core\event\base {
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data["crud"]        = "c";
+        $this->data["edulevel"]    = self::LEVEL_OTHER;
+        $this->data["objecttable"] = "local_webhooks_service";
+    }
+
+    /**
+     * Return localised event name.
+     */
+    public static function get_name() {
+        return new \lang_string("create", "moodle");
+    }
+
+    /**
+     * Returns description of what happened.
+     */
+    public function get_description() {
+        return new \lang_string("backup", "moodle");
+    }
+
+    /**
+     * Get URL related to the action.
+     */
+    public function get_url() {
+        return new \moodle_url("/local/webhooks/managerservice.php");
+    }
+}

classes/event/backup_restored.php

@@ -0,0 +1,65 @@
+<?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/>.
+
+/**
+ * Registration of the system of events.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks\event;
+
+defined("MOODLE_INTERNAL") || die();
+
+/**
+ * Defines how to work with events.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class backup_restored extends \core\event\base {
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data["crud"]        = "u";
+        $this->data["edulevel"]    = self::LEVEL_OTHER;
+        $this->data["objecttable"] = "local_webhooks_service";
+    }
+
+    /**
+     * Return localised event name.
+     */
+    public static function get_name() {
+        return new \lang_string("update", "moodle");
+    }
+
+    /**
+     * Returns description of what happened.
+     */
+    public function get_description() {
+        return new \lang_string("backupfinished", "moodle");
+    }
+
+    /**
+     * Get URL related to the action.
+     */
+    public function get_url() {
+        return new \moodle_url("/local/webhooks/managerservice.php");
+    }
+}

classes/event/response_answer.php

@@ -0,0 +1,65 @@
+<?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/>.
+
+/**
+ * Registration of the system of events.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks\event;
+
+defined("MOODLE_INTERNAL") || die();
+
+/**
+ * Defines how to work with events.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class response_answer extends \core\event\base {
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data["crud"]        = "r";
+        $this->data["edulevel"]    = self::LEVEL_OTHER;
+        $this->data["objecttable"] = "local_webhooks_service";
+    }
+
+    /**
+     * Return localised event name.
+     */
+    public static function get_name() {
+        return new \lang_string("answer", "moodle");
+    }
+
+    /**
+     * Returns description of what happened.
+     */
+    public function get_description() {
+        return $this->other["status"];
+    }
+
+    /**
+     * Get URL related to the action.
+     */
+    public function get_url() {
+        return new \moodle_url("/local/webhooks/editservice.php", array("serviceid" => $this->objectid));
+    }
+}

classes/event/service_added.php

@@ -0,0 +1,65 @@
+<?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/>.
+
+/**
+ * Registration of the system of events.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks\event;
+
+defined("MOODLE_INTERNAL") || die();
+
+/**
+ * Defines how to work with events.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class service_added extends \core\event\base {
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data["crud"]        = "c";
+        $this->data["edulevel"]    = self::LEVEL_OTHER;
+        $this->data["objecttable"] = "local_webhooks_service";
+    }
+
+    /**
+     * Return localised event name.
+     */
+    public static function get_name() {
+        return new \lang_string("create", "moodle");
+    }
+
+    /**
+     * Returns description of what happened.
+     */
+    public function get_description() {
+        return new \lang_string("eventwebserviceservicecreated", "webservice");
+    }
+
+    /**
+     * Get URL related to the action.
+     */
+    public function get_url() {
+        return new \moodle_url("/local/webhooks/editservice.php", array("serviceid" => $this->objectid));
+    }
+}

classes/event/service_deleted.php

@@ -0,0 +1,65 @@
+<?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/>.
+
+/**
+ * Registration of the system of events.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks\event;
+
+defined("MOODLE_INTERNAL") || die();
+
+/**
+ * Defines how to work with events.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class service_deleted extends \core\event\base {
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data["crud"]        = "d";
+        $this->data["edulevel"]    = self::LEVEL_OTHER;
+        $this->data["objecttable"] = "local_webhooks_service";
+    }
+
+    /**
+     * Return localised event name.
+     */
+    public static function get_name() {
+        return new \lang_string("deleted", "moodle");
+    }
+
+    /**
+     * Returns description of what happened.
+     */
+    public function get_description() {
+        return new \lang_string("eventwebserviceservicedeleted", "webservice");
+    }
+
+    /**
+     * Get URL related to the action.
+     */
+    public function get_url() {
+        return new \moodle_url("/local/webhooks/editservice.php", array("serviceid" => $this->objectid));
+    }
+}

classes/event/service_updated.php

@@ -0,0 +1,65 @@
+<?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/>.
+
+/**
+ * Registration of the system of events.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks\event;
+
+defined("MOODLE_INTERNAL") || die();
+
+/**
+ * Defines how to work with events.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class service_updated extends \core\event\base {
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data["crud"]        = "u";
+        $this->data["edulevel"]    = self::LEVEL_OTHER;
+        $this->data["objecttable"] = "local_webhooks_service";
+    }
+
+    /**
+     * Return localised event name.
+     */
+    public static function get_name() {
+        return new \lang_string("update", "moodle");
+    }
+
+    /**
+     * Returns description of what happened.
+     */
+    public function get_description() {
+        return new \lang_string("eventwebserviceserviceupdated", "webservice");
+    }
+
+    /**
+     * Get URL related to the action.
+     */
+    public function get_url() {
+        return new \moodle_url("/local/webhooks/editservice.php", array("serviceid" => $this->objectid));
+    }
+}

classes/events.php

@@ -1,91 +0,0 @@
-<?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/>.
-
-/**
- * The event handler.
- *
- * @package   local_webhooks
- * @copyright 2017 "Valentin Popov" <info@valentineus.link>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace local_webhooks;
-
-defined("MOODLE_INTERNAL") || die();
-
-/**
- * Defines how to work with events.
- *
- * @copyright 2017 "Valentin Popov" <info@valentineus.link>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class events {
-    /**
-     * External handler.
-     *
-     * @param object $event
-     */
-    public static function handler($event) {
-        $config = get_config("local_webhooks");
-
-        if (boolval($config->enable)) {
-            $data = $event->get_data();
-            self::transmitter($data);
-        }
-    }
-
-    /**
-     * Transmitter, processing event and services.
-     *
-     * @param array $data
-     */
-    private static function transmitter($data) {
-        global $DB;
-
-        $callbacks = $DB->get_recordset("local_webhooks_service");
-
-        if ($callbacks->valid()) {
-            foreach ($callbacks as $callback) {
-                self::send($data, $callback);
-            }
-        }
-
-        $callbacks->close();
-    }
-
-    /**
-     * Sending data to the node.
-     *
-     * @param array $data
-     * @param object $callback
-     */
-    private static function send($data, $callback) {
-        if ($callback->enable) {
-            $curl = new curl();
-            $package = self::packup($data);
-            $curl::request($callback->url, $package);
-        }
-    }
-
-    /**
-     * Packs the data for transmission.
-     *
-     * @param array $data
-     */
-    private static function packup($data) {
-        return json_encode($data);
-    }
-}

classes/forms.php

@@ -1,82 +0,0 @@
-<?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/>.
-
-/**
- * Defines the form of editing the service.
- *
- * @package   local_webhooks
- * @copyright 2017 "Valentin Popov" <info@valentineus.link>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace local_webhooks;
-
-defined("MOODLE_INTERNAL") || die();
-
-require_once($CFG->libdir . "/formslib.php");
-
-use lang_string;
-use moodleform;
-
-/**
- * Description editing form definition.
- *
- * @copyright 2017 "Valentin Popov" <info@valentineus.link>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class service_edit_form extends moodleform {
-    /**
-     * @param string $baseurl
-     */
-    public function __construct($baseurl) {
-        parent::__construct($baseurl);
-    }
-
-    /**
-     * Defines the standard structure of the form.
-     */
-    protected function definition() {
-        $mform =& $this->_form;
-
-        /* Form heading */
-        $mform->addElement("header", "editserviceheader",
-            new lang_string("service", "webservice"));
-
-        /* Name of the service */
-        $mform->addElement("text", "title",
-            new lang_string("name", "moodle"),
-            array("size" => 60));
-        $mform->setType("title", PARAM_NOTAGS);
-        $mform->addRule("title", null, "required");
-
-        /* Callback address */
-        $mform->addElement("text", "url",
-            new lang_string("url", "moodle"),
-            array("size" => 60));
-        $mform->setType("url", PARAM_URL);
-        $mform->addRule("url", null, "required");
-
-        /* Enabling the service */
-        $mform->addElement("checkbox", "enable",
-            new lang_string("enable", "moodle"));
-        $mform->setType("enable", PARAM_BOOL);
-        $mform->setDefault("enable", 1);
-        $mform->setAdvanced("enable");
-
-        /* Control Panel */
-        $this->add_action_buttons(true);
-    }
-}

classes/handler.php

@@ -0,0 +1,138 @@
+<?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/>.
+
+/**
+ * The event handler.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_webhooks;
+
+defined("MOODLE_INTERNAL") || die();
+
+require_once($CFG->libdir . "/filelib.php");
+
+/**
+ * Defines how to work with events.
+ *
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class handler {
+    /**
+     * External handler.
+     *
+     * @param object $event
+     */
+    public static function events($event) {
+        $data = $event->get_data();
+        self::transmitter($data);
+    }
+
+    /**
+     * Transmitter, processing event and services.
+     *
+     * @param array $data
+     */
+    private static function transmitter($data) {
+        global $DB;
+
+        $callbacks = $DB->get_recordset("local_webhooks_service");
+
+        if ($callbacks->valid()) {
+            foreach ($callbacks as $callback) {
+                self::handler_callback($data, $callback);
+            }
+        }
+
+        $callbacks->close();
+    }
+
+    /**
+     * Processes each callback.
+     *
+     * @param array $data
+     * @param object $callback
+     */
+    private static function handler_callback($data, $callback) {
+        global $CFG;
+
+        if (boolval($callback->enable)) {
+            $events = array();
+            if (!empty($callback->events)) {
+                $events = unserialize(gzuncompress(base64_decode($callback->events)));
+            }
+
+            if (!empty($events[$data["eventname"]])) {
+                $urlparse = parse_url($CFG->wwwroot);
+                $data["host"] = $urlparse['host'];
+
+                if (!empty($callback->token)) {
+                    $data["token"] = $callback->token;
+                }
+
+                if (!empty($callback->other)) {
+                    $data["extra"] = $callback->other;
+                }
+
+                self::send($data, $callback);
+            }
+        }
+    }
+
+    /**
+     * Sending data to the node.
+     *
+     * @param array $data
+     * @param object $callback
+     */
+    private static function send($data, $callback) {
+        $curl = new \curl();
+        $curl->setHeader(array("Content-Type: application/$callback->type"));
+        $curl->post($callback->url, json_encode($data));
+        $response = $curl->getResponse();
+        self::logger($callback, $response);
+        return $response;
+    }
+
+    /**
+     * Event logging.
+     *
+     * @param array $response
+     * @param object $callback
+     */
+    private static function logger($callback, $response) {
+        $status = "Error sending request";
+        if (!empty($response["HTTP/1.1"])) {
+            $status = $response["HTTP/1.1"];
+        }
+
+        $event = \local_webhooks\event\response_answer::create(
+            array(
+                "context"  => \context_system::instance(0),
+                "objectid" => $callback->id,
+                "other"    => array(
+                    "status" => $status
+                )
+            )
+        );
+
+        $event->trigger();
+    }
+}

db/events.php

@@ -26,10 +26,10 @@ defined("MOODLE_INTERNAL") || die();
 
 $observers = array(
     array(
-        "eventname" => "*",
-        "callback" => "\local_webhooks\\events::handler",
+        "callback"    => "\local_webhooks\\handler::events",
+        "eventname"   => "*",
         "includefile" => null,
-        "priority" => 200,
-        "internal" => true
+        "internal"    => true,
+        "priority"    => 200
     )
 );

db/install.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="blocks/local_webhooks/db" VERSION="20171022" COMMENT="XMLDB file for Moodle" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd">
+<XMLDB PATH="blocks/local_webhooks/db" VERSION="20171029" COMMENT="XMLDB file for Moodle" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd">
     <TABLES>
         <TABLE NAME="local_webhooks_service" COMMENT="A table for storing callback services.">
             <FIELDS>
@@ -7,10 +7,14 @@
                 <FIELD NAME="enable" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="0" SEQUENCE="false" />
                 <FIELD NAME="title" TYPE="text" NOTNULL="true" SEQUENCE="false" />
                 <FIELD NAME="url" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false" />
+                <FIELD NAME="type" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false" />
+                <FIELD NAME="token" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false" />
+                <FIELD NAME="events" TYPE="text" NOTNULL="false" SEQUENCE="false" />
+                <FIELD NAME="other" TYPE="text" NOTNULL="false" SEQUENCE="false" />
             </FIELDS>
             <KEYS>
                 <KEY NAME="primary" TYPE="primary" FIELDS="id" />
             </KEYS>
         </TABLE>
     </TABLES>
-</XMLDB>
+</XMLDB>

editservice.php

@@ -23,16 +23,18 @@
  */
 
 require_once(__DIR__ . "/../../config.php");
-require_once(__DIR__ . "/classes/forms.php");
+require_once(__DIR__ . "/classes/editform.php");
+require_once($CFG->libdir . "/adminlib.php");
 
-$idservice = optional_param("idservice", 0, PARAM_INT);
+admin_externalpage_setup("local_webhooks");
 
-require_login();
+/* Optional parameters */
+$serviceid = optional_param("serviceid", 0, PARAM_INT);
 
 /* Link generation */
-$urlparameters = array("idservice" => $idservice);
+$urlparameters  = array("serviceid" => $serviceid);
 $managerservice = new moodle_url("/local/webhooks/managerservice.php", $urlparameters);
-$baseurl = new moodle_url("/local/webhooks/editservice.php", $urlparameters);
+$baseurl        = new moodle_url("/local/webhooks/editservice.php", $urlparameters);
 $PAGE->set_url($baseurl, $urlparameters);
 
 /* Configure the context of the page */
@@ -40,7 +42,7 @@ $context = context_system::instance();
 $PAGE->set_context($context);
 
 /* Preparing a template for data */
-$titlepage = new lang_string("externalservice", "webservice");
+$titlepage     = new lang_string("externalservice", "webservice");
 $servicerecord = new stdClass;
 
 /* Create an editing form */
@@ -52,25 +54,38 @@ if ($mform->is_cancelled()) {
 }
 
 /* Getting the data */
-if ($idediting = boolval($idservice)) {
-    $servicerecord = $DB->get_record("local_webhooks_service", array("id" => $idservice), "*", MUST_EXIST);
+if ($editing = boolval($serviceid)) {
+    $servicerecord = $DB->get_record("local_webhooks_service", array("id" => $serviceid), "*", MUST_EXIST);
     $mform->set_data($servicerecord);
 }
 
 /* Processing of received data */
 if ($data = $mform->get_data()) {
-    if (empty($data->enable)) {
-        $data->enable = 0;
+    if (empty($data->events)) {
+        $data->events = array();
     }
 
-    if ($idediting) {
-        $data->id = $idservice;
+    /* Pack the list of events */
+    $data->events = base64_encode(gzcompress(serialize($data->events), 9));
+
+    if ($editing) {
+        $data->id = $serviceid;
         $DB->update_record("local_webhooks_service", $data);
-    } else {
-        $DB->insert_record("local_webhooks_service", $data);
-    }
 
-    redirect($managerservice);
+        /* Run the event */
+        $event = \local_webhooks\event\service_updated::create(array("context" => $context, "objectid" => $data->id));
+        $event->trigger();
+
+        redirect($managerservice, new lang_string("eventwebserviceserviceupdated", "webservice"));
+    } else {
+        $servicenewid = $DB->insert_record("local_webhooks_service", $data);
+
+        /* Run the event */
+        $event = \local_webhooks\event\service_added::create(array("context" => $context, "objectid" => $servicenewid));
+        $event->trigger();
+
+        redirect($managerservice, new lang_string("eventwebserviceservicecreated", "webservice"));
+    }
 }
 
 /* Page template */
@@ -79,9 +94,6 @@ $PAGE->set_heading($titlepage);
 $PAGE->set_title($titlepage);
 
 /* The page title */
-$PAGE->navbar->add(new lang_string("local", "moodle"));
-$PAGE->navbar->add(new lang_string("pluginname", "local_webhooks"));
-$PAGE->navbar->add(new lang_string("managerservice", "local_webhooks"), $managerservice);
 $PAGE->navbar->add($titlepage);
 echo $OUTPUT->header();
 

lang/en/local_webhooks.php

@@ -22,5 +22,4 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-$string["managerservice"] = "Service management manager";
 $string["pluginname"] = "WebHooks";

lang/ru/local_webhooks.php

@@ -1,26 +0,0 @@
-<?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/>.
-
-/**
- * Strings for component "local_webhooks", language "ru".
- *
- * @package   local_webhooks
- * @copyright 2017 "Valentin Popov" <info@valentineus.link>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-$string["managerservice"] = "Менеджер управления службами";
-$string["pluginname"] = "WebHooks";

managerservice.php

@@ -24,14 +24,21 @@
 
 require_once(__DIR__ . "/../../config.php");
 require_once($CFG->libdir . "/tablelib.php");
+require_once($CFG->libdir . "/adminlib.php");
 
-$deleteservice = optional_param("deleteservice", 0, PARAM_INT);
+admin_externalpage_setup("local_webhooks");
 
-require_login();
+/* Optional parameters */
+$backupservices = optional_param("getbackup", 0, PARAM_BOOL);
+$deleteid       = optional_param("deleteid", 0, PARAM_INT);
+$hideshowid     = optional_param("hideshowid", 0, PARAM_INT);
+
+/* Used references */
+$editservice    = "/local/webhooks/editservice.php";
+$managerservice = "/local/webhooks/managerservice.php";
+$restorebackup  = "/local/webhooks/restorebackup.php";
 
 /* Link generation */
-$managerservice = "/local/webhooks/managerservice.php";
-$editservice = "/local/webhooks/editservice.php";
 $baseurl = new moodle_url($managerservice);
 $PAGE->set_url($baseurl);
 
@@ -40,66 +47,107 @@ $context = context_system::instance();
 $PAGE->set_context($context);
 
 /* Delete the service */
-if ($deleteservice && confirm_sesskey()) {
-    $DB->delete_records("local_webhooks_service", array("id" => $deleteservice));
-    redirect($PAGE->url, new lang_string("deleted", "moodle"));
+if (boolval($deleteid) && confirm_sesskey()) {
+    $DB->delete_records("local_webhooks_service", array("id" => $deleteid));
+
+    /* Run the event */
+    $event = \local_webhooks\event\service_deleted::create(array("context" => $context, "objectid" => $deleteid));
+    $event->trigger();
+
+    redirect($PAGE->url, new lang_string("eventwebserviceservicedeleted", "webservice"));
 }
 
 /* Retrieving a list of services */
-$select = null;
-$callbacks = $DB->get_records_select("local_webhooks_service", $select, null, $DB->sql_order_by_text("id"));
+$callbacks = $DB->get_records_select("local_webhooks_service", null, null, $DB->sql_order_by_text("id"));
+
+/* Upload settings as a file */
+if (boolval($backupservices)) {
+    $filecontent = base64_encode(gzcompress(serialize($callbacks), 9));
+    $filename    = "webhooks_" . date("U") . ".backup";
+
+    /* Run the event */
+    $event = \local_webhooks\event\backup_performed::create(array("context" => $context, "objectid" => 0));
+    $event->trigger();
+
+    send_file($filecontent, $filename, 0, 0, true, true);
+}
+
+/* Switching the status of the service */
+if (boolval($hideshowid) && confirm_sesskey()) {
+    $callback = $callbacks[$hideshowid];
+
+    if (!empty($callback)) {
+        $callback->enable = !boolval($callback->enable);
+        $DB->update_record("local_webhooks_service", $callback);
+
+        /* Run the event */
+        $event = \local_webhooks\event\service_updated::create(array("context" => $context, "objectid" => $hideshowid));
+        $event->trigger();
+
+        redirect($PAGE->url, new lang_string("eventwebserviceserviceupdated", "webservice"));
+    }
+}
 
 /* Page template */
-$titlepage = new lang_string("managerservice", "local_webhooks");
-$PAGE->set_pagelayout("standard");
+$titlepage = new lang_string("pluginname", "local_webhooks");
+$PAGE->set_pagelayout("admin");
 $PAGE->set_title($titlepage);
 $PAGE->set_heading($titlepage);
 
 /* The page title */
-$PAGE->navbar->add(new lang_string("local", "moodle"));
-$PAGE->navbar->add(new lang_string("pluginname", "local_webhooks"));
-$PAGE->navbar->add($titlepage, $baseurl);
 echo $OUTPUT->header();
 
 /* Table declaration */
-$table = new flexible_table("callbacks-table");
+$table = new flexible_table("webhooks-service-table");
 
 /* Customize the table */
 $table->define_columns(array("title", "url", "actions"));
-$table->define_headers(array(
-    new lang_string("name", "moodle"),
-    new lang_string("url", "moodle"),
-    new lang_string("actions", "moodle")));
+$table->define_headers(array(new lang_string("name", "moodle"), new lang_string("url", "moodle"), new lang_string("actions", "moodle")));
 $table->define_baseurl($baseurl);
 $table->setup();
 
 foreach ($callbacks as $callback) {
     /* Filling of information columns */
     $titlecallback = html_writer::div($callback->title, "title");
-    $urlcallback = html_writer::div($callback->url, "url");
+    $urlcallback   = html_writer::div($callback->url, "url");
+
+    /* Defining service status */
+    $hideshowicon   = "t/show";
+    $hideshowstring = new lang_string("enable", "moodle");
+    if (boolval($callback->enable)) {
+        $hideshowicon   = "t/hide";
+        $hideshowstring = new lang_string("disable", "moodle");
+    }
+
+    /* Link to enable / disable the service */
+    $hideshowlink = new moodle_url($managerservice, array("hideshowid" => $callback->id, "sesskey" => sesskey()));
+    $hideshowitem = $OUTPUT->action_icon($hideshowlink, new pix_icon($hideshowicon, $hideshowstring));
 
     /* Link for editing */
-    $editlink = new moodle_url($editservice,
-        array("idservice" => $callback->id));
-    $edititem = $OUTPUT->action_icon($editlink,
-        new pix_icon("t/edit", get_string("edit")));
+    $editlink = new moodle_url($editservice, array("serviceid" => $callback->id));
+    $edititem = $OUTPUT->action_icon($editlink, new pix_icon("t/edit", new lang_string("edit", "moodle")));
 
     /* Link to remove */
-    $deletelink = new moodle_url($managerservice,
-        array("deleteservice" => $callback->id, "sesskey" => sesskey()));
-    $deleteitem = $OUTPUT->action_icon($deletelink,
-        new pix_icon("t/delete", get_string("delete")));
+    $deletelink = new moodle_url($managerservice, array("deleteid" => $callback->id, "sesskey" => sesskey()));
+    $deleteitem = $OUTPUT->action_icon($deletelink, new pix_icon("t/delete", new lang_string("delete", "moodle")));
 
     /* Adding data to the table */
-    $table->add_data(array($titlecallback, $urlcallback, $edititem . $deleteitem));
+    $table->add_data(array($titlecallback, $urlcallback, $hideshowitem . $edititem . $deleteitem));
 }
 
 /* Display the table */
 $table->print_html();
 
 /* Add service button */
-$addurl = new moodle_url("/local/webhooks/editservice.php");
-echo $OUTPUT->single_button($addurl,
-    new lang_string("addaservice", "webservice"), "get");
+$addserviceurl = new moodle_url($editservice);
+echo $OUTPUT->single_button($addserviceurl, new lang_string("addaservice", "webservice"), "get");
+
+/* Button to get a backup */
+$backupurl = new moodle_url($managerservice, array("getbackup" => true));
+echo $OUTPUT->single_button($backupurl, new lang_string("backup", "moodle"), "get");
+
+/* Button for restoring settings */
+$restorebackupurl = new moodle_url($restorebackup, array("sesskey" => sesskey()));
+echo $OUTPUT->single_button($restorebackupurl, new lang_string("restore", "moodle"), "get");
 
 echo $OUTPUT->footer();

restorebackup.php

@@ -0,0 +1,79 @@
+<?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/>.
+
+/**
+ * Restore settings page.
+ *
+ * @package   local_webhooks
+ * @copyright 2017 "Valentin Popov" <info@valentineus.link>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once(__DIR__ . "/../../config.php");
+require_once(__DIR__ . "/classes/editform.php");
+require_once($CFG->libdir . "/adminlib.php");
+
+admin_externalpage_setup("local_webhooks");
+
+/* Link generation */
+$managerservice = new moodle_url("/local/webhooks/managerservice.php");
+$baseurl        = new moodle_url("/local/webhooks/restorebackup.php");
+$PAGE->set_url($baseurl);
+
+/* Configure the context of the page */
+$context = context_system::instance();
+$PAGE->set_context($context);
+
+/* Create an editing form */
+$mform = new \local_webhooks\service_backup_form($PAGE->url);
+
+/* Cancel processing */
+if ($mform->is_cancelled()) {
+    redirect($managerservice);
+}
+
+/* Processing the received file */
+$data = $mform->get_data();
+if (boolval($data) && confirm_sesskey()) {
+    $content   = $mform->get_file_content("backupfile");
+    $callbacks = unserialize(gzuncompress(base64_decode($content)));
+
+    $DB->delete_records("local_webhooks_service");
+    foreach ($callbacks as $callback) {
+        $DB->insert_record("local_webhooks_service", $callback);
+    }
+
+    /* Run the event */
+    $event = \local_webhooks\event\backup_restored::create(array("context" => $context, "objectid" => 0));
+    $event->trigger();
+
+    redirect($managerservice, new lang_string("restorefinished", "moodle"));
+}
+
+/* Page template */
+$titlepage = new lang_string("backup", "moodle");
+$PAGE->set_pagelayout("admin");
+$PAGE->set_heading($titlepage);
+$PAGE->set_title($titlepage);
+
+/* The page title */
+$PAGE->navbar->add($titlepage);
+echo $OUTPUT->header();
+
+/* Displays the form */
+$mform->display();
+
+echo $OUTPUT->footer();

settings.php

@@ -24,22 +24,9 @@
 
 defined("MOODLE_INTERNAL") || die();
 
-$settings = null;
 if ($hassiteconfig) {
-    $settings = new admin_settingpage("local_webhooks",
-        new lang_string("pluginname", "local_webhooks"));
-
-    $ADMIN->add("localplugins", $settings);
-
-    $settings->add(new admin_setting_configcheckbox(
-        "local_webhooks/enable",
-        new lang_string("enable", "moodle"),
-        new lang_string("enablews", "webservice"),
-        false));
-
-    /* Link to the service manager */
-    $linktext = new lang_string("managerservice", "local_webhooks");
-    $linkurl = new moodle_url("/local/webhooks/managerservice.php");
-    $settings->add(new admin_setting_heading("local_webhooks_managerservice", null,
-        html_writer::link($linkurl, $linktext)));
+    $ADMIN->add("server", new admin_externalpage("local_webhooks",
+        new lang_string("pluginname", "local_webhooks"),
+        new moodle_url("/local/webhooks/managerservice.php")
+    ));
 }

version.php

@@ -23,8 +23,9 @@
  */
 
 defined("MOODLE_INTERNAL") || die();
-$plugin->release   = "0.1.0 (Build: 2017102500)";
-$plugin->version   = 2017102500;
+
+$plugin->release   = "2.1.0 (Build: 2017111810)";
+$plugin->version   = 2017111810;
 $plugin->requires  = 2016112900;
 $plugin->component = "local_webhooks";
-$plugin->maturity  = MATURITY_ALPHA;
+$plugin->maturity  = MATURITY_STABLE;