Compare commits
79 Commits
Author | SHA1 | Date | |
---|---|---|---|
edb23d6aad | |||
064e2fa422 | |||
9cf4fc575c | |||
f3c2ebbe4d | |||
8f25379f32 | |||
90897b0e7d | |||
685d9ee15e | |||
db500cddce | |||
85bcb64e37 | |||
1736128dbf | |||
5cdd8de9e3 | |||
b6ddc8bd40 | |||
f10786bfb0 | |||
899b129d23 | |||
dd19065313 | |||
3a2bddeea4 | |||
a41dbbb950 | |||
a68882140b | |||
43f0bf98d2 | |||
95c4cf061a | |||
a1099245b5 | |||
66b5928e6e | |||
4f75d9c5c8 | |||
29bdbc7456 | |||
ebf76795da | |||
53c49b69de | |||
f392fd42d9 | |||
67f8d73a15 | |||
22b7569f71 | |||
fa74622268 | |||
9b7426fb20 | |||
283c64f62e | |||
17ae01ab71 | |||
28e1169be8 | |||
2126708201 | |||
0041667754 | |||
91bf79f030 | |||
7d1a0b9fec | |||
51007a0fb5 | |||
2eaa622161 | |||
3d4b78bd8b | |||
41185c6db4 | |||
7e1284bfe2 | |||
785a541d1c | |||
6e3bf072af | |||
2e57e732ba | |||
499f36d118 | |||
49516bea82 | |||
a6c6081139 | |||
9560267833 | |||
2057a1efb6 | |||
0cbf2bbb87 | |||
3e054dd94e | |||
54fb29c5ea | |||
78e9e435cc | |||
97711bb186 | |||
999ad9f472 | |||
82c7463e4a | |||
e0e9322644 | |||
7278ee951b | |||
01e2ba9f2f | |||
99868c158a | |||
bdaf1d35b2 | |||
7cfdf29600 | |||
bec8dcdc08 | |||
2ae949bbc3 | |||
de3c3a6553 | |||
05512c5440 | |||
91754489b0 | |||
f8b85a270c | |||
4bf6f61131 | |||
3da34ec7f1 | |||
4f342659d4 | |||
0bc809ba07 | |||
03d22ef096 | |||
1c87dae035 | |||
5639dc7b0f | |||
1ad4527c1d | |||
57cac60ab3 |
17
.github/workflows/main.yml
vendored
Normal file
17
.github/workflows/main.yml
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
name: Workflow
|
||||
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
mirror:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: yesolutions/mirror-action@master
|
||||
with:
|
||||
REMOTE: 'https://git.popov.link/moodle/local_webhooks.git'
|
||||
GIT_USERNAME: ${{ secrets.GIT_USERNAME }}
|
||||
GIT_PASSWORD: ${{ secrets.GIT_PASSWORD }}
|
20
.travis.yml
20
.travis.yml
@ -6,25 +6,15 @@ os: "linux"
|
||||
|
||||
php:
|
||||
- 5.6
|
||||
- 7.1
|
||||
- 7.2
|
||||
|
||||
env:
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_26_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_27_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_28_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_29_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_30_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_31_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_32_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_33_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_26_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_27_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_28_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_29_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_30_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_31_STABLE
|
||||
- DB=pgsql MOODLE_BRANCH=MOODLE_34_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_32_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_33_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_34_STABLE
|
||||
|
||||
before_install:
|
||||
- cd ../..
|
||||
@ -51,9 +41,9 @@ jobs:
|
||||
stage: deploy
|
||||
|
||||
env:
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_33_STABLE
|
||||
- DB=mysqli MOODLE_BRANCH=MOODLE_34_STABLE
|
||||
|
||||
php: 7.1
|
||||
php: 7.2
|
||||
|
||||
before_deploy:
|
||||
- cd $TRAVIS_REPO_SLUG
|
||||
|
29
README.md
29
README.md
@ -1,8 +1,5 @@
|
||||
# Moodle WebHook's
|
||||
[](https://github.com/valentineus/moodle-webhooks/releases)
|
||||
[](https://travis-ci.org/valentineus/moodle-webhooks)
|
||||
[](https://www.codacy.com/app/valentineus/moodle-webhooks)
|
||||
[](https://gitter.im/valentineus/moodle-webhooks)
|
||||
|
||||
Adding Webhooks to Moodle.
|
||||
The Webhooks feature allows applications to receive real-time notification of changes to certain data.
|
||||
@ -20,27 +17,11 @@ Features:
|
||||
* Use a secret phrase to authenticate requests;
|
||||
* [JSON](https://en.wikipedia.org/wiki/JSON) - Format of outgoing data;
|
||||
|
||||
## Installation
|
||||
## Documentation
|
||||
|
||||
Get the installation package in any of the available methods:
|
||||
|
||||
* [GitHub Releases](https://github.com/valentineus/moodle-webhooks/releases).
|
||||
* [Compilation from the source code](#build).
|
||||
|
||||
## Build
|
||||
|
||||
Self-assembly package is as follows:
|
||||
|
||||
* Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/valentineus/moodle-webhooks.git moodle-webhooks
|
||||
```
|
||||
|
||||
* Run the build script:
|
||||
```bash
|
||||
cd ./moodle-webhooks
|
||||
/bin/sh build.sh
|
||||
```
|
||||
* [Install the plugin](docs/getting-started.md#installation).
|
||||
* [User guide](docs/getting-started.md#user-guide).
|
||||
* [Request format](docs/getting-started.md#request-format).
|
||||
|
||||
## License
|
||||
|
||||
@ -48,4 +29,4 @@ cd ./moodle-webhooks
|
||||
|
||||
[GNU GPLv3](LICENSE.txt).
|
||||
Copyright (c)
|
||||
[Valentin Popov](mailto:info@valentineus.link).
|
||||
[Valentin Popov](mailto:info@valentineus.link).
|
||||
|
@ -60,6 +60,6 @@ class backup_performed extends \core\event\base {
|
||||
* Get URL related to the action.
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url("/local/webhooks/managerservice.php");
|
||||
return new \moodle_url("/local/webhooks/index.php");
|
||||
}
|
||||
}
|
@ -60,6 +60,6 @@ class backup_restored extends \core\event\base {
|
||||
* Get URL related to the action.
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url("/local/webhooks/managerservice.php");
|
||||
return new \moodle_url("/local/webhooks/index.php");
|
||||
}
|
||||
}
|
@ -60,6 +60,6 @@ class service_deleted extends \core\event\base {
|
||||
* Get URL related to the action.
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url("/local/webhooks/editservice.php", array("serviceid" => $this->objectid));
|
||||
return new \moodle_url("/local/webhooks/index.php");
|
||||
}
|
||||
}
|
65
classes/event/service_deletedall.php
Normal file
65
classes/event/service_deletedall.php
Normal file
@ -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_deletedall 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("deletecompletely", "moodle");
|
||||
}
|
||||
|
||||
/**
|
||||
* Get URL related to the action.
|
||||
*/
|
||||
public function get_url() {
|
||||
return new \moodle_url("/local/webhooks/index.php");
|
||||
}
|
||||
}
|
@ -26,10 +26,11 @@ namespace local_webhooks;
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
require_once($CFG->libdir . "/filelib.php");
|
||||
require_once(__DIR__ . "/../locallib.php");
|
||||
require_once(__DIR__ . "/../lib.php");
|
||||
|
||||
/**
|
||||
* Defines how to work with events.
|
||||
* Defines event handlers.
|
||||
*
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
@ -42,97 +43,14 @@ class handler {
|
||||
*/
|
||||
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);
|
||||
}
|
||||
if (!is_array($recordlist = local_webhooks_cache_get($data["eventname"]))) {
|
||||
$recordlist = local_webhooks_search_services_by_event($data["eventname"], true);
|
||||
local_webhooks_cache_set($data["eventname"], $recordlist);
|
||||
}
|
||||
|
||||
$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);
|
||||
}
|
||||
foreach ($recordlist as $record) {
|
||||
local_webhooks_send_request($data, $record);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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();
|
||||
}
|
||||
}
|
@ -22,15 +22,11 @@
|
||||
* @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");
|
||||
require_once(__DIR__ . "/../lib.php");
|
||||
|
||||
use lang_string;
|
||||
use moodleform;
|
||||
use report_eventlist_list_generator;
|
||||
require_once($CFG->libdir . "/formslib.php");
|
||||
|
||||
/**
|
||||
* Description editing form definition.
|
||||
@ -46,19 +42,6 @@ class service_edit_form extends moodleform {
|
||||
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.
|
||||
*/
|
||||
@ -103,7 +86,7 @@ class service_edit_form extends moodleform {
|
||||
$mform->addElement("header", "editserviceheaderevent", new lang_string("edulevel", "moodle"));
|
||||
|
||||
/* List of events */
|
||||
$eventlist = report_eventlist_list_generator::get_all_events_list(true);
|
||||
$eventlist = local_webhooks_get_list_events();
|
||||
$events = array();
|
||||
|
||||
/* Formation of the list of elements */
|
||||
@ -144,6 +127,11 @@ class service_backup_form extends moodleform {
|
||||
/* Form heading */
|
||||
$mform->addElement("header", "editserviceheader", new lang_string("restore", "moodle"));
|
||||
|
||||
/* Flag for deleting existing data */
|
||||
$mform->addElement("advcheckbox", "deleterecords", new lang_string("deleteall", "moodle"));
|
||||
$mform->setType("deleterecords", PARAM_BOOL);
|
||||
$mform->setDefault("deleterecords", 1);
|
||||
|
||||
/* Download the file */
|
||||
$mform->addElement("filepicker", "backupfile", new lang_string("file", "moodle"));
|
||||
$mform->addRule("backupfile", null, "required");
|
145
classes/webhooks_table.php
Normal file
145
classes/webhooks_table.php
Normal file
@ -0,0 +1,145 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Describes the plugin tables.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
require_once($CFG->libdir . "/tablelib.php");
|
||||
|
||||
/**
|
||||
* Describes the main table of the plugin.
|
||||
*
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class local_webhooks_table extends table_sql {
|
||||
/**
|
||||
* Manager address.
|
||||
*
|
||||
* @var string $manager
|
||||
*/
|
||||
protected static $manager = "/local/webhooks/index.php";
|
||||
|
||||
/**
|
||||
* Editor's address.
|
||||
*
|
||||
* @var string $editor
|
||||
*/
|
||||
protected static $editor = "/local/webhooks/editservice.php";
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $uniqueid The unique identifier of the table.
|
||||
*/
|
||||
public function __construct($uniqueid) {
|
||||
parent::__construct($uniqueid);
|
||||
$this->define_table_columns();
|
||||
$this->define_table_configs();
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the basic settings of the table.
|
||||
*/
|
||||
public function define_table_configs() {
|
||||
$this->set_sql("*", "{local_webhooks_service}", "1");
|
||||
$this->collapsible(false);
|
||||
$this->is_downloadable(false);
|
||||
$this->no_sorting("actions");
|
||||
$this->pageable(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the main columns and table headers.
|
||||
*/
|
||||
public function define_table_columns() {
|
||||
$columns = array(
|
||||
"title",
|
||||
"url",
|
||||
"events",
|
||||
"actions"
|
||||
);
|
||||
|
||||
$headers = array(
|
||||
new lang_string("name", "moodle"),
|
||||
new lang_string("url", "moodle"),
|
||||
new lang_string("edulevel", "moodle"),
|
||||
new lang_string("actions", "moodle")
|
||||
);
|
||||
|
||||
$this->define_columns($columns);
|
||||
$this->define_headers($headers);
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the display of a column with actions.
|
||||
*
|
||||
* @param object $row Data from the database.
|
||||
* @return string Displayed data.
|
||||
*/
|
||||
public function col_actions($row) {
|
||||
global $OUTPUT;
|
||||
|
||||
$hideshowicon = "t/show";
|
||||
$hideshowstring = new lang_string("enable", "moodle");
|
||||
if (boolval($row->enable)) {
|
||||
$hideshowicon = "t/hide";
|
||||
$hideshowstring = new lang_string("disable", "moodle");
|
||||
}
|
||||
|
||||
$hideshowlink = new moodle_url(self::$manager, array("hideshowid" => $row->id, "sesskey" => sesskey()));
|
||||
$hideshowitem = $OUTPUT->action_icon($hideshowlink, new pix_icon($hideshowicon, $hideshowstring));
|
||||
|
||||
$editlink = new moodle_url(self::$editor, array("serviceid" => $row->id, "sesskey" => sesskey()));
|
||||
$edititem = $OUTPUT->action_icon($editlink, new pix_icon("t/edit", new lang_string("edit", "moodle")));
|
||||
|
||||
$deletelink = new moodle_url(self::$manager, array("deleteid" => $row->id, "sesskey" => sesskey()));
|
||||
$deleteitem = $OUTPUT->action_icon($deletelink, new pix_icon("t/delete", new lang_string("delete", "moodle")));
|
||||
|
||||
$html = $hideshowitem . $edititem . $deleteitem;
|
||||
return $html;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the display of a column with events.
|
||||
*
|
||||
* @param object $row Data from the database.
|
||||
* @return string Displayed data.
|
||||
*/
|
||||
public function col_events($row) {
|
||||
$eventlist = local_webhooks_deserialization_data($row->events);
|
||||
return count($eventlist);
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the display of the column with the service name.
|
||||
*
|
||||
* @param object $row Data from the database.
|
||||
* @return string Displayed data.
|
||||
*/
|
||||
public function col_title($row) {
|
||||
$link = new moodle_url(self::$editor, array("serviceid" => $row->id, "sesskey" => sesskey()));
|
||||
$html = html_writer::link($link, $row->title);
|
||||
return $html;
|
||||
}
|
||||
}
|
31
db/caches.php
Normal file
31
db/caches.php
Normal file
@ -0,0 +1,31 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Definition of the plug-in cache.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
$definitions = array(
|
||||
"webhooks_services" => array(
|
||||
"mode" => cache_store::MODE_APPLICATION,
|
||||
"requiredataguarantee" => true,
|
||||
"staticacceleration" => true
|
||||
)
|
||||
);
|
115
db/services.php
Normal file
115
db/services.php
Normal file
@ -0,0 +1,115 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* This file registers the plugin's external functions.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
$functions = array(
|
||||
"local_webhooks_change_status" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "change_status",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Change the status of the service.",
|
||||
"type" => "write"
|
||||
),
|
||||
|
||||
"local_webhooks_search_services_by_event" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "search_services_by_event",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Search for services that contain the specified event.",
|
||||
"type" => "read"
|
||||
),
|
||||
|
||||
"local_webhooks_get_record" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "get_record",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Get the record from the database.",
|
||||
"type" => "read"
|
||||
),
|
||||
|
||||
"local_webhooks_get_list_records" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "get_list_records",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Get all records from the database.",
|
||||
"type" => "read"
|
||||
),
|
||||
|
||||
"local_webhooks_get_list_events" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "get_list_events",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Get a list of all system events.",
|
||||
"type" => "read"
|
||||
),
|
||||
|
||||
"local_webhooks_create_record" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "create_record",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Create an entry in the database.",
|
||||
"type" => "write"
|
||||
),
|
||||
|
||||
"local_webhooks_update_record" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "update_record",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Update the record in the database.",
|
||||
"type" => "write"
|
||||
),
|
||||
|
||||
"local_webhooks_delete_record" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "delete_record",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Delete the record from the database.",
|
||||
"type" => "write"
|
||||
),
|
||||
|
||||
"local_webhooks_delete_all_records" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "delete_all_records",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Delete all records from the database.",
|
||||
"type" => "write"
|
||||
),
|
||||
|
||||
"local_webhooks_create_backup" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "create_backup",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Create a backup.",
|
||||
"type" => "read"
|
||||
),
|
||||
|
||||
"local_webhooks_restore_backup" => array(
|
||||
"classname" => "local_webhooks_external",
|
||||
"methodname" => "restore_backup",
|
||||
"classpath" => "local/webhooks/externallib.php",
|
||||
"description" => "Restore from a backup.",
|
||||
"type" => "write"
|
||||
)
|
||||
);
|
52
db/upgrade.php
Normal file
52
db/upgrade.php
Normal file
@ -0,0 +1,52 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Keeps track of upgrades to the 'local_webhooks' plugin.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
require_once(__DIR__ . "/../lib.php");
|
||||
|
||||
/**
|
||||
* Function to upgrade 'local_webhooks'.
|
||||
*
|
||||
* @param number $oldversion
|
||||
* @return boolean
|
||||
*/
|
||||
function xmldb_local_webhooks_upgrade($oldversion) {
|
||||
global $CFG, $DB;
|
||||
|
||||
/* Update from version 3.0.0 */
|
||||
if ($oldversion < 2017112600) {
|
||||
$rs = $DB->get_recordset("local_webhooks_service", null, "id", "*", 0, 0);
|
||||
foreach ($rs as $record) {
|
||||
if (!empty($record->events)) {
|
||||
$record->events = unserialize(gzuncompress(base64_decode($record->events)));
|
||||
local_webhooks_update_record($record);
|
||||
}
|
||||
}
|
||||
$rs->close();
|
||||
upgrade_plugin_savepoint(true, 2017112600, "local", "webhooks");
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
111
docs/getting-started.md
Normal file
111
docs/getting-started.md
Normal file
@ -0,0 +1,111 @@
|
||||
# Getting Started
|
||||
|
||||
## Navigation
|
||||
|
||||
* [Installation](#installation)
|
||||
* [Build](#build)
|
||||
* [User guide](#user-guide)
|
||||
* [Guide to the manager](#guide-to-the-manager)
|
||||
* [Guide to the editor](#guide-to-the-editor)
|
||||
* [Request format](#request-format)
|
||||
|
||||
## Installation
|
||||
|
||||
Get the installation package in any of the available methods:
|
||||
|
||||
* [GitHub Releases](https://github.com/valentineus/moodle-webhooks/releases).
|
||||
* [Compilation from the source code](#build).
|
||||
|
||||
### Build
|
||||
|
||||
Self-assembly package is as follows:
|
||||
|
||||
* Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/valentineus/moodle-webhooks.git moodle-webhooks
|
||||
```
|
||||
|
||||
* Run the build script:
|
||||
```bash
|
||||
cd ./moodle-webhooks
|
||||
/bin/sh build.sh
|
||||
```
|
||||
|
||||
## User guide
|
||||
|
||||
After you install the plug-in, the Service Manager appears on the `Server` tab in the administration panel.
|
||||
|
||||
To open the page, go:
|
||||
`Site administration` ->
|
||||
`Server` ->
|
||||
`WebHooks`.
|
||||
|
||||
### Guide to the manager
|
||||
|
||||
The main window looks like this:
|
||||
|
||||

|
||||
|
||||
On the main page you can see the list of services and manage each service separately.
|
||||
|
||||
Column description
|
||||
* "**Name**" shows the name of the service.
|
||||
* "**URL**" indicates the address of the service to which notifications are received.
|
||||
* "**Actions**" allows you to enable / disable the service, edit and delete.
|
||||
|
||||
Description of control buttons:
|
||||
* "**Add service**" opens a page for creating a new service.
|
||||
* "**Backup**" loads the backup file of the service list.
|
||||
* "**Restore**" redirects the data recovery page from the backup.
|
||||
|
||||
### Guide to the editor
|
||||
|
||||
During the editing and creation of the service, this page opens:
|
||||
|
||||

|
||||
|
||||
Description of fields:
|
||||
* "**Name**" stores an arbitrary name for the service.
|
||||
* "**URL**" stores the address of the service to which notifications will be sent as a POST request.
|
||||
* "**Token**" allows you to specify an individual key that will allow an external service to identify requests.
|
||||
* "**Advanced**" stores a large string passed to the service.
|
||||
This can be useful for some services or users.
|
||||
* "**Content Type**" allows you to configure the type of outbound requests if there are compatibility issues.
|
||||
|
||||
The "**All events**" list contains a list of all events registered in the system.
|
||||
The selected events will notify the service.
|
||||
|
||||
## Request format
|
||||
|
||||
Events come in
|
||||
[JSON](https://en.wikipedia.org/wiki/JSON)
|
||||
format.
|
||||
|
||||
An example of an observed course event:
|
||||
|
||||
```JSON
|
||||
{
|
||||
"eventname": "\\core\\event\\course_viewed",
|
||||
"component": "core",
|
||||
"action": "viewed",
|
||||
"target": "course",
|
||||
"objecttable": null,
|
||||
"objectid": null,
|
||||
"crud": "r",
|
||||
"edulevel": 2,
|
||||
"contextid": 2,
|
||||
"contextlevel": 50,
|
||||
"contextinstanceid": "1",
|
||||
"userid": "2",
|
||||
"courseid": "1",
|
||||
"relateduserid": null,
|
||||
"anonymous": 0,
|
||||
"other": null,
|
||||
"timecreated": 1512961456,
|
||||
"host": "localhost",
|
||||
"token": "",
|
||||
"extra": ""
|
||||
}
|
||||
```
|
||||
|
||||
[Detailed description of the fields](https://docs.moodle.org/dev/Event_2#Properties).
|
BIN
docs/screenshots/editservice.jpg
Normal file
BIN
docs/screenshots/editservice.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 165 KiB |
BIN
docs/screenshots/managerservice.jpg
Normal file
BIN
docs/screenshots/managerservice.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 122 KiB |
@ -15,7 +15,7 @@
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* Service editor.
|
||||
* Page for editing the service.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
@ -23,30 +23,25 @@
|
||||
*/
|
||||
|
||||
require_once(__DIR__ . "/../../config.php");
|
||||
require_once(__DIR__ . "/classes/editform.php");
|
||||
require_once($CFG->libdir . "/adminlib.php");
|
||||
require_once(__DIR__ . "/classes/service_form.php");
|
||||
require_once(__DIR__ . "/lib.php");
|
||||
|
||||
admin_externalpage_setup("local_webhooks");
|
||||
require_once($CFG->libdir . "/adminlib.php");
|
||||
|
||||
/* Optional parameters */
|
||||
$serviceid = optional_param("serviceid", 0, PARAM_INT);
|
||||
|
||||
/* Link generation */
|
||||
$urlparameters = array("serviceid" => $serviceid);
|
||||
$managerservice = new moodle_url("/local/webhooks/managerservice.php", $urlparameters);
|
||||
$baseurl = new moodle_url("/local/webhooks/editservice.php", $urlparameters);
|
||||
$PAGE->set_url($baseurl, $urlparameters);
|
||||
$managerservice = new moodle_url("/local/webhooks/index.php");
|
||||
|
||||
/* Configure the context of the page */
|
||||
admin_externalpage_setup("local_webhooks", "", null, $baseurl, array());
|
||||
$context = context_system::instance();
|
||||
$PAGE->set_context($context);
|
||||
|
||||
/* Preparing a template for data */
|
||||
$titlepage = new lang_string("externalservice", "webservice");
|
||||
$servicerecord = new stdClass;
|
||||
|
||||
/* Create an editing form */
|
||||
$mform = new \local_webhooks\service_edit_form($PAGE->url);
|
||||
$mform = new service_edit_form($PAGE->url);
|
||||
|
||||
/* Cancel processing */
|
||||
if ($mform->is_cancelled()) {
|
||||
@ -54,50 +49,33 @@ if ($mform->is_cancelled()) {
|
||||
}
|
||||
|
||||
/* Getting the data */
|
||||
$servicerecord = new stdClass();
|
||||
if ($editing = boolval($serviceid)) {
|
||||
$servicerecord = $DB->get_record("local_webhooks_service", array("id" => $serviceid), "*", MUST_EXIST);
|
||||
$servicerecord = local_webhooks_get_record($serviceid);
|
||||
$mform->set_data($servicerecord);
|
||||
}
|
||||
|
||||
/* Processing of received data */
|
||||
if ($data = $mform->get_data()) {
|
||||
if (empty($data->events)) {
|
||||
$data->events = array();
|
||||
}
|
||||
|
||||
/* Pack the list of events */
|
||||
$data->events = base64_encode(gzcompress(serialize($data->events), 9));
|
||||
|
||||
if (($data = $mform->get_data()) && confirm_sesskey()) {
|
||||
if ($editing) {
|
||||
$data->id = $serviceid;
|
||||
$DB->update_record("local_webhooks_service", $data);
|
||||
|
||||
/* 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"));
|
||||
local_webhooks_update_record($data);
|
||||
} 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"));
|
||||
local_webhooks_create_record($data);
|
||||
}
|
||||
|
||||
redirect($managerservice, new lang_string("changessaved", "moodle"));
|
||||
}
|
||||
|
||||
/* Page template */
|
||||
$PAGE->set_pagelayout("admin");
|
||||
/* The page title */
|
||||
$titlepage = new lang_string("externalservice", "webservice");
|
||||
$PAGE->navbar->add($titlepage);
|
||||
$PAGE->set_heading($titlepage);
|
||||
$PAGE->set_title($titlepage);
|
||||
|
||||
/* The page title */
|
||||
$PAGE->navbar->add($titlepage);
|
||||
echo $OUTPUT->header();
|
||||
|
||||
/* Displays the form */
|
||||
$mform->display();
|
||||
|
||||
/* Footer */
|
||||
echo $OUTPUT->footer();
|
643
externallib.php
Normal file
643
externallib.php
Normal file
@ -0,0 +1,643 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* This file defines the plugin's external functions.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
require_once(__DIR__ . "/lib.php");
|
||||
|
||||
require_once($CFG->libdir . "/externallib.php");
|
||||
|
||||
/**
|
||||
* External functions.
|
||||
*
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class local_webhooks_external extends external_api {
|
||||
/**
|
||||
* Single template output parameters.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
private static function structure_record_parameters() {
|
||||
return new external_single_structure(
|
||||
array(
|
||||
"id" => new external_value(PARAM_INT, "Service ID."),
|
||||
"enable" => new external_value(PARAM_BOOL, "Enable or disable the service."),
|
||||
"title" => new external_value(PARAM_TEXT, "Name of the service."),
|
||||
"url" => new external_value(PARAM_URL, "Web address of the service."),
|
||||
"type" => new external_value(PARAM_TEXT, "Used header type."),
|
||||
"token" => new external_value(PARAM_RAW, "Authorization key.", VALUE_OPTIONAL),
|
||||
"other" => new external_value(PARAM_RAW, "Additional field.", VALUE_OPTIONAL),
|
||||
"events" => new external_multiple_structure(
|
||||
new external_single_structure(
|
||||
array(
|
||||
"name" => new external_value(PARAM_TEXT, "The name of the event."),
|
||||
"value" => new external_value(PARAM_BOOL, "Enabled or disabled handler.")
|
||||
)
|
||||
), "List of observed events.", VALUE_OPTIONAL
|
||||
)
|
||||
), "Information about the service."
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formation of the final list.
|
||||
*
|
||||
* @param array $listrecords
|
||||
* @return array
|
||||
*/
|
||||
private static function formation_list($listrecords) {
|
||||
$result = array();
|
||||
|
||||
foreach ($listrecords as $index => $record) {
|
||||
$result[$index] = (array) $record;
|
||||
$result[$index]["events"] = self::formation_events($record->events);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Formation of the final list of events.
|
||||
*
|
||||
* @param array $listevents
|
||||
* @return array
|
||||
*/
|
||||
private static function formation_events($listevents) {
|
||||
$result = array();
|
||||
|
||||
foreach ($listevents as $key => $value) {
|
||||
$result[] = array("name" => $key, "value" => $value);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function change_status_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
"serviceid" => new external_value(PARAM_INT, "Service ID.")
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Change the status of the service.
|
||||
*
|
||||
* @param number $serviceid
|
||||
* @return boolean
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function change_status($serviceid) {
|
||||
$parameters = self::validate_parameters(self::change_status_parameters(), array("serviceid" => $serviceid));
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
return local_webhooks_change_status($parameters["serviceid"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function change_status_returns() {
|
||||
return new external_value(PARAM_BOOL, "Result of execution.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function search_services_by_event_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
"eventname" => new external_value(PARAM_TEXT, "The name of the event."),
|
||||
"active" => new external_value(PARAM_BOOL, "Filter show active or all services.")
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Search for services that contain the specified event.
|
||||
*
|
||||
* @param string $eventname
|
||||
* @param boolean $active
|
||||
* @return array
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function search_services_by_event($eventname, $active) {
|
||||
$parameters = self::validate_parameters(self::search_services_by_event_parameters(), array("eventname" => $eventname, "active" => $active));
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
$result = array();
|
||||
|
||||
if ($listrecords = local_webhooks_search_services_by_event($parameters["eventname"], $parameters["active"])) {
|
||||
$result = self::formation_list($listrecords);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function search_services_by_event_returns() {
|
||||
return new external_multiple_structure(
|
||||
self::structure_record_parameters(), "List of services."
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_record_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
"serviceid" => new external_value(PARAM_INT, "Service ID.")
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the record from the database.
|
||||
*
|
||||
* @param number $serviceid
|
||||
* @return array
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_record($serviceid) {
|
||||
$parameters = self::validate_parameters(self::get_record_parameters(), array("serviceid" => $serviceid));
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
$result = array();
|
||||
|
||||
if ($record = local_webhooks_get_record($parameters["serviceid"])) {
|
||||
$result = (array) $record;
|
||||
$result["events"] = self::formation_events($record->events);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_record_returns() {
|
||||
return self::structure_record_parameters();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_list_records_parameters() {
|
||||
return new external_function_parameters(array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all records from the database.
|
||||
*
|
||||
* @return array
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_list_records() {
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
$result = array();
|
||||
|
||||
if ($listrecords = local_webhooks_get_list_records()) {
|
||||
$result = self::formation_list($listrecords);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_list_records_returns() {
|
||||
return new external_multiple_structure(
|
||||
self::structure_record_parameters(), "List of services."
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_list_events_parameters() {
|
||||
return new external_function_parameters(array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a list of all system events.
|
||||
*
|
||||
* @return array
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_list_events() {
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
$result = array();
|
||||
|
||||
if ($eventlist = local_webhooks_get_list_events()) {
|
||||
foreach ($eventlist as $item) {
|
||||
$result[] = $item["eventname"];
|
||||
}
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function get_list_events_returns() {
|
||||
return new external_multiple_structure(
|
||||
new external_value(PARAM_TEXT, "The name of the event.")
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function create_record_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
"service" => new external_single_structure(
|
||||
array(
|
||||
"enable" => new external_value(PARAM_BOOL, "Enable or disable the service.", VALUE_OPTIONAL),
|
||||
"title" => new external_value(PARAM_TEXT, "Name of the service."),
|
||||
"url" => new external_value(PARAM_URL, "Web address of the service."),
|
||||
"type" => new external_value(PARAM_TEXT, "Used header type.", VALUE_OPTIONAL),
|
||||
"token" => new external_value(PARAM_RAW, "Authorization key.", VALUE_OPTIONAL),
|
||||
"other" => new external_value(PARAM_RAW, "Additional field.", VALUE_OPTIONAL),
|
||||
"events" => new external_multiple_structure(
|
||||
new external_single_structure(
|
||||
array(
|
||||
"name" => new external_value(PARAM_TEXT, "The name of the event."),
|
||||
"value" => new external_value(PARAM_BOOL, "Enabled or disabled handler.")
|
||||
)
|
||||
), "List of observed events.", VALUE_OPTIONAL
|
||||
)
|
||||
), "Information about the service."
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an entry in the database.
|
||||
*
|
||||
* @param array $service
|
||||
* @return boolean
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function create_record($service) {
|
||||
$parameters = self::validate_parameters(self::create_record_parameters(), array("service" => $service));
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
$record = new stdClass();
|
||||
$record->other = $parameters["service"]["other"];
|
||||
$record->title = $parameters["service"]["title"];
|
||||
$record->token = $parameters["service"]["token"];
|
||||
$record->url = $parameters["service"]["url"];
|
||||
$record->events = array();
|
||||
|
||||
$record->enable = !empty($parameters["service"]["enable"]) ? $parameters["service"]["enable"] : false;
|
||||
$record->type = !empty($parameters["service"]["type"]) ? $parameters["service"]["type"] : "json";
|
||||
|
||||
foreach ($parameters["service"]["events"] as $value) {
|
||||
$record->events[$value["name"]] = $value["value"];
|
||||
}
|
||||
|
||||
return local_webhooks_create_record($record);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function create_record_returns() {
|
||||
return new external_value(PARAM_BOOL, "Result of execution.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function update_record_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
"service" => new external_single_structure(
|
||||
array(
|
||||
"id" => new external_value(PARAM_INT, "Service ID."),
|
||||
"enable" => new external_value(PARAM_BOOL, "Enable or disable the service.", VALUE_OPTIONAL),
|
||||
"title" => new external_value(PARAM_TEXT, "Name of the service.", VALUE_OPTIONAL),
|
||||
"url" => new external_value(PARAM_URL, "Web address of the service.", VALUE_OPTIONAL),
|
||||
"type" => new external_value(PARAM_TEXT, "Used header type.", VALUE_OPTIONAL),
|
||||
"token" => new external_value(PARAM_RAW, "Authorization key.", VALUE_OPTIONAL),
|
||||
"other" => new external_value(PARAM_RAW, "Additional field.", VALUE_OPTIONAL),
|
||||
"events" => new external_multiple_structure(
|
||||
new external_single_structure(
|
||||
array(
|
||||
"name" => new external_value(PARAM_TEXT, "The name of the event."),
|
||||
"value" => new external_value(PARAM_BOOL, "Enabled or disabled handler.")
|
||||
)
|
||||
), "List of observed events.", VALUE_OPTIONAL
|
||||
)
|
||||
), "Information about the service."
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the record in the database.
|
||||
*
|
||||
* @param array $service
|
||||
* @return boolean
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function update_record($service) {
|
||||
$parameters = self::validate_parameters(self::update_record_parameters(), array("service" => $service));
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
$result = false;
|
||||
|
||||
if ($record = local_webhooks_get_record($parameters["service"]["id"])) {
|
||||
$record->enable = !empty($parameters["service"]["enable"]) ? $parameters["service"]["enable"] : $record->enable;
|
||||
$record->other = !empty($parameters["service"]["other"]) ? $parameters["service"]["other"] : $record->other;
|
||||
$record->title = !empty($parameters["service"]["title"]) ? $parameters["service"]["title"] : $record->title;
|
||||
$record->token = !empty($parameters["service"]["token"]) ? $parameters["service"]["token"] : $record->token;
|
||||
$record->type = !empty($parameters["service"]["type"]) ? $parameters["service"]["type"] : $record->type;
|
||||
$record->url = !empty($parameters["service"]["url"]) ? $parameters["service"]["url"] : $record->url;
|
||||
|
||||
if (!empty($parameters["service"]["events"])) {
|
||||
$record->events = array();
|
||||
|
||||
foreach ($parameters["service"]["events"] as $value) {
|
||||
$record->events[$value["name"]] = $value["value"];
|
||||
}
|
||||
}
|
||||
|
||||
$result = local_webhooks_update_record($record);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function update_record_returns() {
|
||||
return new external_value(PARAM_BOOL, "Result of execution.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function delete_record_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
"serviceid" => new external_value(PARAM_INT, "Service ID.")
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the record from the database.
|
||||
*
|
||||
* @param number $serviceid
|
||||
* @return boolean
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function delete_record($serviceid) {
|
||||
$parameters = self::validate_parameters(self::delete_record_parameters(), array("serviceid" => $serviceid));
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
return local_webhooks_delete_record($parameters["serviceid"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function delete_record_returns() {
|
||||
return new external_value(PARAM_BOOL, "Result of execution.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function delete_all_records_parameters() {
|
||||
return new external_function_parameters(array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete all records from the database.
|
||||
*
|
||||
* @return boolean
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function delete_all_records() {
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
return local_webhooks_delete_all_records();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function delete_all_records_returns() {
|
||||
return new external_value(PARAM_BOOL, "Result of execution.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function create_backup_parameters() {
|
||||
return new external_function_parameters(array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a backup.
|
||||
*
|
||||
* @return string
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function create_backup() {
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
return local_webhooks_create_backup();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function create_backup_returns() {
|
||||
return new external_value(PARAM_RAW, "Backup copy.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function restore_backup_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
"options" => new external_single_structure(
|
||||
array(
|
||||
"backup" => new external_value(PARAM_RAW, "Backup copy."),
|
||||
"deleterecords" => new external_value(PARAM_BOOL, "Delete or leave all records.", VALUE_OPTIONAL)
|
||||
)
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Restore from a backup.
|
||||
*
|
||||
* @param array $options
|
||||
* @since Moodle 2.9 Options available
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function restore_backup($options) {
|
||||
$parameters = self::validate_parameters(self::restore_backup_parameters(), array("options" => $options));
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
|
||||
$deleterecords = !empty($parameters["options"]["deleterecords"]) ? $parameters["options"]["deleterecords"] : false;
|
||||
local_webhooks_restore_backup($parameters["options"]["backup"], $deleterecords);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method result value.
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.2
|
||||
*/
|
||||
public static function restore_backup_returns() {
|
||||
return null;
|
||||
}
|
||||
}
|
100
index.php
Normal file
100
index.php
Normal file
@ -0,0 +1,100 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Service Management Manager.
|
||||
*
|
||||
* @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/webhooks_table.php");
|
||||
require_once(__DIR__ . "/lib.php");
|
||||
|
||||
require_once($CFG->libdir . "/adminlib.php");
|
||||
|
||||
/* Optional parameters */
|
||||
$backupservices = optional_param("getbackup", 0, PARAM_BOOL);
|
||||
$deleteall = optional_param("deleteall", 0, PARAM_INT);
|
||||
$deleteid = optional_param("deleteid", 0, PARAM_INT);
|
||||
$hideshowid = optional_param("hideshowid", 0, PARAM_INT);
|
||||
|
||||
/* Link generation */
|
||||
$editservice = "/local/webhooks/editservice.php";
|
||||
$managerservice = "/local/webhooks/index.php";
|
||||
$restorebackup = "/local/webhooks/restorebackup.php";
|
||||
$baseurl = new moodle_url($managerservice);
|
||||
|
||||
/* Configure the context of the page */
|
||||
admin_externalpage_setup("local_webhooks", "", null, $baseurl, array());
|
||||
$context = context_system::instance();
|
||||
|
||||
/* Delete the service */
|
||||
if (!empty($deleteid) && confirm_sesskey()) {
|
||||
local_webhooks_delete_record($deleteid);
|
||||
redirect($PAGE->url, new lang_string("deleted", "moodle"));
|
||||
}
|
||||
|
||||
/* Switching the status of the service */
|
||||
if (!empty($hideshowid) && confirm_sesskey()) {
|
||||
local_webhooks_change_status($hideshowid);
|
||||
redirect($PAGE->url, new lang_string("changessaved", "moodle"));
|
||||
}
|
||||
|
||||
/* Deletes all data */
|
||||
if (boolval($deleteall) && confirm_sesskey()) {
|
||||
local_webhooks_delete_all_records();
|
||||
redirect($PAGE->url, new lang_string("deleted", "moodle"));
|
||||
}
|
||||
|
||||
/* Upload settings as a file */
|
||||
if (boolval($backupservices)) {
|
||||
$filecontent = local_webhooks_create_backup();
|
||||
$filename = "webhooks_" . date("U") . ".backup";
|
||||
send_file($filecontent, $filename, 0, 0, true, true);
|
||||
}
|
||||
|
||||
/* The page title */
|
||||
$titlepage = new lang_string("pluginname", "local_webhooks");
|
||||
$PAGE->set_heading($titlepage);
|
||||
$PAGE->set_title($titlepage);
|
||||
echo $OUTPUT->header();
|
||||
|
||||
/* Adds the add button */
|
||||
$addserviceurl = new moodle_url($editservice, array("sesskey" => sesskey()));
|
||||
echo $OUTPUT->single_button($addserviceurl, new lang_string("add", "moodle"));
|
||||
|
||||
/* Adds a delete button */
|
||||
$deleteallurl = new moodle_url($managerservice, array("deleteall" => true, "sesskey" => sesskey()));
|
||||
echo $OUTPUT->single_button($deleteallurl, new lang_string("deleteall", "moodle"), "get");
|
||||
|
||||
/* Adds a backup button */
|
||||
$backupurl = new moodle_url($managerservice, array("getbackup" => true));
|
||||
echo $OUTPUT->single_button($backupurl, new lang_string("backup", "moodle"), "get");
|
||||
|
||||
/* Adds a restore button */
|
||||
$restorebackupurl = new moodle_url($restorebackup);
|
||||
echo $OUTPUT->single_button($restorebackupurl, new lang_string("restore", "moodle"));
|
||||
|
||||
/* Displays the table */
|
||||
$table = new local_webhooks_table("local-webhooks-table");
|
||||
$table->define_baseurl($baseurl);
|
||||
$table->out(25, true);
|
||||
|
||||
/* Footer */
|
||||
echo $OUTPUT->footer();
|
268
lib.php
Normal file
268
lib.php
Normal file
@ -0,0 +1,268 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* This file contains the functions used by the plugin.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
require_once(__DIR__ . "/locallib.php");
|
||||
|
||||
/**
|
||||
* Change the status of the service.
|
||||
*
|
||||
* @param number $serviceid
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_change_status($serviceid) {
|
||||
global $DB;
|
||||
|
||||
$result = false;
|
||||
if ($record = local_webhooks_get_record($serviceid)) {
|
||||
$record->enable = !boolval($record->enable);
|
||||
$result = local_webhooks_update_record($record);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Search for services that contain the specified event.
|
||||
*
|
||||
* @param string $eventname
|
||||
* @param boolean $active
|
||||
* @return array
|
||||
*/
|
||||
function local_webhooks_search_services_by_event($eventname, $active = false) {
|
||||
$recordlist = local_webhooks_get_list_records();
|
||||
$active = boolval($active);
|
||||
$result = array();
|
||||
|
||||
foreach ($recordlist as $record) {
|
||||
if (!empty($record->events[$eventname])) {
|
||||
if ($active && boolval($record->enable)) {
|
||||
$result[] = $record;
|
||||
}
|
||||
|
||||
if (!$active) {
|
||||
$result[] = $record;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the record from the database.
|
||||
*
|
||||
* @param number $serviceid
|
||||
* @return object
|
||||
*/
|
||||
function local_webhooks_get_record($serviceid) {
|
||||
global $DB;
|
||||
|
||||
$servicerecord = $DB->get_record("local_webhooks_service", array("id" => $serviceid), "*", MUST_EXIST);
|
||||
|
||||
if (!empty($servicerecord->events)) {
|
||||
$servicerecord->events = local_webhooks_deserialization_data($servicerecord->events);
|
||||
}
|
||||
|
||||
return $servicerecord;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all records from the database.
|
||||
*
|
||||
* @param number $limitfrom
|
||||
* @param number $limitnum
|
||||
* @return array
|
||||
*/
|
||||
function local_webhooks_get_list_records($limitfrom = 0, $limitnum = 0) {
|
||||
global $DB;
|
||||
|
||||
$listrecords = $DB->get_records("local_webhooks_service", null, "id", "*", $limitfrom, $limitnum);
|
||||
|
||||
foreach ($listrecords as $servicerecord) {
|
||||
if (!empty($servicerecord->events)) {
|
||||
$servicerecord->events = local_webhooks_deserialization_data($servicerecord->events);
|
||||
}
|
||||
}
|
||||
|
||||
return $listrecords;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a list of all system events.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
function local_webhooks_get_list_events() {
|
||||
return report_eventlist_list_generator::get_all_events_list(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an entry in the database.
|
||||
*
|
||||
* @param object $record
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_create_record($record) {
|
||||
global $DB;
|
||||
|
||||
if (!empty($record->events)) {
|
||||
$record->events = local_webhooks_serialization_data($record->events);
|
||||
}
|
||||
|
||||
$result = $DB->insert_record("local_webhooks_service", $record, true, false);
|
||||
|
||||
/* Clear the plugin cache */
|
||||
local_webhooks_cache_reset();
|
||||
|
||||
/* Event notification */
|
||||
local_webhooks_events::service_added($result);
|
||||
|
||||
return boolval($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the record in the database.
|
||||
*
|
||||
* @param object $data
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_update_record($record) {
|
||||
global $DB;
|
||||
|
||||
if (empty($record->id)) {
|
||||
print_error("missingparam", "error", null, "id");
|
||||
}
|
||||
|
||||
$record->events = !empty($record->events) ? local_webhooks_serialization_data($record->events) : null;
|
||||
$result = $DB->update_record("local_webhooks_service", $record, false);
|
||||
|
||||
/* Clear the plugin cache */
|
||||
local_webhooks_cache_reset();
|
||||
|
||||
/* Event notification */
|
||||
local_webhooks_events::service_updated($record->id);
|
||||
|
||||
return boolval($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the record from the database.
|
||||
*
|
||||
* @param number $serviceid
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_delete_record($serviceid) {
|
||||
global $DB;
|
||||
|
||||
$result = $DB->delete_records("local_webhooks_service", array("id" => $serviceid));
|
||||
|
||||
/* Clear the plugin cache */
|
||||
local_webhooks_cache_reset();
|
||||
|
||||
/* Event notification */
|
||||
local_webhooks_events::service_deleted($serviceid);
|
||||
|
||||
return boolval($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete all records from the database.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_delete_all_records() {
|
||||
global $DB;
|
||||
|
||||
$result = $DB->delete_records("local_webhooks_service", null);
|
||||
|
||||
/* Clear the plugin cache */
|
||||
local_webhooks_cache_reset();
|
||||
|
||||
/* Event notification */
|
||||
local_webhooks_events::service_deletedall();
|
||||
|
||||
return boolval($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a backup.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
function local_webhooks_create_backup() {
|
||||
$listrecords = local_webhooks_get_list_records();
|
||||
$result = local_webhooks_serialization_data($listrecords);
|
||||
|
||||
/* Event notification */
|
||||
local_webhooks_events::backup_performed();
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Restore from a backup.
|
||||
*
|
||||
* @param string $data
|
||||
*/
|
||||
function local_webhooks_restore_backup($data, $deleterecords = false) {
|
||||
$listrecords = local_webhooks_deserialization_data($data);
|
||||
|
||||
if (boolval($deleterecords)) {
|
||||
local_webhooks_delete_all_records();
|
||||
}
|
||||
|
||||
foreach ($listrecords as $servicerecord) {
|
||||
local_webhooks_create_record($servicerecord);
|
||||
}
|
||||
|
||||
/* Event notification */
|
||||
local_webhooks_events::backup_restored();
|
||||
}
|
||||
|
||||
/**
|
||||
* Send the event remotely to the service.
|
||||
*
|
||||
* @param array $event
|
||||
* @param object $callback
|
||||
* @return array
|
||||
*/
|
||||
function local_webhooks_send_request($event, $callback) {
|
||||
global $CFG;
|
||||
|
||||
$event["host"] = parse_url($CFG->wwwroot)["host"];
|
||||
$event["token"] = $callback->token;
|
||||
$event["extra"] = $callback->other;
|
||||
|
||||
$curl = new curl();
|
||||
$curl->setHeader(array("Content-Type: application/" . $callback->type));
|
||||
$curl->post($callback->url, json_encode($event));
|
||||
$response = $curl->getResponse();
|
||||
|
||||
/* Event notification */
|
||||
local_webhooks_events::response_answer($callback->id, $response);
|
||||
|
||||
return $response;
|
||||
}
|
175
locallib.php
Normal file
175
locallib.php
Normal file
@ -0,0 +1,175 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* Classes of modules.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
/**
|
||||
* Get data from the cache by key.
|
||||
*
|
||||
* @param string $eventname
|
||||
* @return array
|
||||
*/
|
||||
function local_webhooks_cache_get($eventname) {
|
||||
$cache = cache::make("local_webhooks", "webhooks_services");
|
||||
return $cache->get($eventname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the data in the cache by key.
|
||||
*
|
||||
* @param string $eventname
|
||||
* @param array $recordlist
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_cache_set($eventname, $recordlist = array()) {
|
||||
$cache = cache::make("local_webhooks", "webhooks_services");
|
||||
return $cache->set($eventname, $recordlist);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the data in the cache by key.
|
||||
*
|
||||
* @param string $eventname
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_cache_delete($eventname) {
|
||||
$cache = cache::make("local_webhooks", "webhooks_services");
|
||||
return $cache->delete($eventname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear the cache of the plugin.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
function local_webhooks_cache_reset() {
|
||||
$cache = cache::make("local_webhooks", "webhooks_services");
|
||||
return $cache->purge();
|
||||
}
|
||||
|
||||
/**
|
||||
* Data serialization.
|
||||
*
|
||||
* @param array|object $data
|
||||
* @return string
|
||||
*/
|
||||
function local_webhooks_serialization_data($data) {
|
||||
return serialize($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Data deserialization.
|
||||
*
|
||||
* @param string $data
|
||||
* @return array|object
|
||||
*/
|
||||
function local_webhooks_deserialization_data($data) {
|
||||
return unserialize($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Description of functions of the call of events
|
||||
*
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class local_webhooks_events {
|
||||
/**
|
||||
* Call the event when creating a backup.
|
||||
*/
|
||||
public static function backup_performed() {
|
||||
$context = context_system::instance();
|
||||
$event = local_webhooks\event\backup_performed::create(array("context" => $context, "objectid" => 0));
|
||||
$event->trigger();
|
||||
}
|
||||
|
||||
/**
|
||||
* Call the event when restoring from a backup.
|
||||
*/
|
||||
public static function backup_restored() {
|
||||
$context = context_system::instance();
|
||||
$event = local_webhooks\event\backup_restored::create(array("context" => $context, "objectid" => 0));
|
||||
$event->trigger();
|
||||
}
|
||||
|
||||
/**
|
||||
* Call event when the response is received from the service
|
||||
*
|
||||
* @param number $objectid Service ID
|
||||
* @param array $response Server response
|
||||
*/
|
||||
public static function response_answer($objectid = 0, $response = array()) {
|
||||
$context = context_system::instance();
|
||||
$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, "objectid" => $objectid, "other" => array("status" => $status)));
|
||||
$event->trigger();
|
||||
}
|
||||
|
||||
/**
|
||||
* Call the event when the service is added.
|
||||
*
|
||||
* @param number $objectid Service ID
|
||||
*/
|
||||
public static function service_added($objectid = 0) {
|
||||
$context = context_system::instance();
|
||||
$event = local_webhooks\event\service_added::create(array("context" => $context, "objectid" => $objectid));
|
||||
$event->trigger();
|
||||
}
|
||||
|
||||
/**
|
||||
* Call the event when the service is deleted.
|
||||
*
|
||||
* @param number $objectid Service ID
|
||||
*/
|
||||
public static function service_deleted($objectid = 0) {
|
||||
$context = context_system::instance();
|
||||
$event = local_webhooks\event\service_deleted::create(array("context" => $context, "objectid" => $objectid));
|
||||
$event->trigger();
|
||||
}
|
||||
|
||||
/**
|
||||
* Call the event when all services are deleted.
|
||||
*/
|
||||
public static function service_deletedall() {
|
||||
$context = context_system::instance();
|
||||
$event = local_webhooks\event\service_deletedall::create(array("context" => $context, "objectid" => 0));
|
||||
$event->trigger();
|
||||
}
|
||||
|
||||
/**
|
||||
* Call event when the service is updated.
|
||||
*
|
||||
* @param number $objectid Service ID
|
||||
*/
|
||||
public static function service_updated($objectid = 0) {
|
||||
$context = context_system::instance();
|
||||
$event = local_webhooks\event\service_updated::create(array("context" => $context, "objectid" => $objectid));
|
||||
$event->trigger();
|
||||
}
|
||||
}
|
@ -1,153 +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/>.
|
||||
|
||||
/**
|
||||
* Service Management Manager.
|
||||
*
|
||||
* @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($CFG->libdir . "/tablelib.php");
|
||||
require_once($CFG->libdir . "/adminlib.php");
|
||||
|
||||
admin_externalpage_setup("local_webhooks");
|
||||
|
||||
/* 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 */
|
||||
$baseurl = new moodle_url($managerservice);
|
||||
$PAGE->set_url($baseurl);
|
||||
|
||||
/* Configure the context of the page */
|
||||
$context = context_system::instance();
|
||||
$PAGE->set_context($context);
|
||||
|
||||
/* Delete the service */
|
||||
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 */
|
||||
$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("pluginname", "local_webhooks");
|
||||
$PAGE->set_pagelayout("admin");
|
||||
$PAGE->set_title($titlepage);
|
||||
$PAGE->set_heading($titlepage);
|
||||
|
||||
/* The page title */
|
||||
echo $OUTPUT->header();
|
||||
|
||||
/* Table declaration */
|
||||
$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_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");
|
||||
|
||||
/* 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("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("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, $hideshowitem . $edititem . $deleteitem));
|
||||
}
|
||||
|
||||
/* Display the table */
|
||||
$table->print_html();
|
||||
|
||||
/* Add service button */
|
||||
$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();
|
@ -15,7 +15,7 @@
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* Restore settings page.
|
||||
* Restore the settings page.
|
||||
*
|
||||
* @package local_webhooks
|
||||
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
|
||||
@ -23,22 +23,21 @@
|
||||
*/
|
||||
|
||||
require_once(__DIR__ . "/../../config.php");
|
||||
require_once(__DIR__ . "/classes/editform.php");
|
||||
require_once(__DIR__ . "/classes/service_form.php");
|
||||
require_once(__DIR__ . "/lib.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);
|
||||
$managerservice = new moodle_url("/local/webhooks/index.php");
|
||||
|
||||
/* Configure the context of the page */
|
||||
admin_externalpage_setup("local_webhooks", "", null, $baseurl, array());
|
||||
$context = context_system::instance();
|
||||
$PAGE->set_context($context);
|
||||
|
||||
/* Create an editing form */
|
||||
$mform = new \local_webhooks\service_backup_form($PAGE->url);
|
||||
$mform = new service_backup_form($PAGE->url);
|
||||
|
||||
/* Cancel processing */
|
||||
if ($mform->is_cancelled()) {
|
||||
@ -46,34 +45,21 @@ if ($mform->is_cancelled()) {
|
||||
}
|
||||
|
||||
/* 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();
|
||||
|
||||
if (($data = $mform->get_data()) && confirm_sesskey()) {
|
||||
$content = $mform->get_file_content("backupfile");
|
||||
local_webhooks_restore_backup($content, $data->deleterecords);
|
||||
redirect($managerservice, new lang_string("restorefinished", "moodle"));
|
||||
}
|
||||
|
||||
/* Page template */
|
||||
/* The page title */
|
||||
$titlepage = new lang_string("backup", "moodle");
|
||||
$PAGE->set_pagelayout("admin");
|
||||
$PAGE->navbar->add($titlepage);
|
||||
$PAGE->set_heading($titlepage);
|
||||
$PAGE->set_title($titlepage);
|
||||
|
||||
/* The page title */
|
||||
$PAGE->navbar->add($titlepage);
|
||||
echo $OUTPUT->header();
|
||||
|
||||
/* Displays the form */
|
||||
$mform->display();
|
||||
|
||||
/* Footer */
|
||||
echo $OUTPUT->footer();
|
@ -27,6 +27,6 @@ defined("MOODLE_INTERNAL") || die();
|
||||
if ($hassiteconfig) {
|
||||
$ADMIN->add("server", new admin_externalpage("local_webhooks",
|
||||
new lang_string("pluginname", "local_webhooks"),
|
||||
new moodle_url("/local/webhooks/managerservice.php")
|
||||
new moodle_url("/local/webhooks/index.php")
|
||||
));
|
||||
}
|
11
version.php
11
version.php
@ -24,8 +24,9 @@
|
||||
|
||||
defined("MOODLE_INTERNAL") || die();
|
||||
|
||||
$plugin->release = "2.1.0 (Build: 2017111810)";
|
||||
$plugin->version = 2017111810;
|
||||
$plugin->requires = 2016112900;
|
||||
$plugin->component = "local_webhooks";
|
||||
$plugin->maturity = MATURITY_STABLE;
|
||||
$plugin->release = "4.0.0-rc.2 (Build: 2018022500)";
|
||||
$plugin->version = 2018022500;
|
||||
$plugin->requires = 2016112900;
|
||||
$plugin->component = "local_webhooks";
|
||||
$plugin->maturity = MATURITY_RC;
|
||||
$plugin->dependencies = array("report_eventlist" => 2016120500);
|
Loading…
x
Reference in New Issue
Block a user