. /** * This file contains the functions used by the plugin. * * @package local_webhooks * @copyright 2017 "Valentin Popov" * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined("MOODLE_INTERNAL") || die(); define("LOCAL_WEBHOOKS_TABLE_SERVICES", "local_webhooks_service"); define("LOCAL_WEBHOOKS_TABLE_EVENTS", "local_webhooks_events"); 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_TABLE_SERVICES, 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 * @param array $conditions * @param string $sort * @return array */ function local_webhooks_get_list_records($limitfrom = 0, $limitnum = 0, $conditions = array(), $sort = "id") { global $DB; $listrecords = $DB->get_records(LOCAL_WEBHOOKS_TABLE_SERVICES, $conditions, $sort, "*", $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); } /** * Get the total number of records. * * @return number */ function local_webhooks_get_total_count() { global $DB; return $DB->count_records(LOCAL_WEBHOOKS_TABLE_SERVICES, array()); } /** * Create an entry in the database. * * @param object $record * @return number */ function local_webhooks_create_record($record) { global $DB; $transaction = $DB->start_delegated_transaction(); $serviceid = $DB->insert_record(LOCAL_WEBHOOKS_TABLE_SERVICES, $record, true, false); if (!empty($record->events)) { foreach ($record->events as $eventname => $eventstatus) { $event = new stdClass(); $event->name = $eventname; $event->serviceid = $serviceid; $event->status = $record->status; $DB->insert_record(LOCAL_WEBHOOKS_TABLE_EVENTS, $event, false, false); } } $transaction->allow_commit(); /* Clear the plugin cache */ local_webhooks_cache_reset(); /* Event notification */ local_webhooks_events::service_added($result); return $serviceid; } /** * 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_TABLE_SERVICES, $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_TABLE_SERVICES, 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_TABLE_SERVICES, 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 * @param boolean $deleterecords */ 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 $record * @return array */ function local_webhooks_send_request($event, $record) { global $CFG; $event["host"] = parse_url($CFG->wwwroot)["host"]; $event["token"] = $record->token; $event["extra"] = $record->other; $curl = new curl(); $curl->setHeader(array("Content-Type: application/" . $record->type)); $curl->post($record->url, json_encode($event)); $response = $curl->getResponse(); /* Event notification */ local_webhooks_events::response_answer($record->id, $response); return $response; }