2011-07-27 19:07:28 +02:00
|
|
|
<?php
|
2024-05-23 09:26:56 +02:00
|
|
|
|
2011-07-27 19:07:28 +02:00
|
|
|
/**
|
2024-05-23 09:26:56 +02:00
|
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
2011-07-27 19:07:28 +02:00
|
|
|
*/
|
2024-09-15 01:37:11 +02:00
|
|
|
|
|
|
|
use Psr\Log\LoggerInterface;
|
|
|
|
|
2019-12-11 10:04:36 +01:00
|
|
|
class OC_Hook {
|
2015-03-24 10:19:30 +01:00
|
|
|
public static $thrownExceptions = [];
|
|
|
|
|
2020-04-10 16:48:31 +02:00
|
|
|
private static $registered = [];
|
2011-07-27 19:07:28 +02:00
|
|
|
|
|
|
|
/**
|
2014-05-19 17:50:53 +02:00
|
|
|
* connects a function to a hook
|
2015-04-02 17:53:40 +02:00
|
|
|
*
|
|
|
|
* @param string $signalClass class name of emitter
|
|
|
|
* @param string $signalName name of signal
|
|
|
|
* @param string|object $slotClass class name of slot
|
|
|
|
* @param string $slotName name of slot
|
2012-09-23 02:39:11 +02:00
|
|
|
* @return bool
|
2011-07-27 19:07:28 +02:00
|
|
|
*
|
|
|
|
* This function makes it very easy to connect to use hooks.
|
|
|
|
*
|
|
|
|
* TODO: write example
|
|
|
|
*/
|
2020-04-10 16:51:06 +02:00
|
|
|
public static function connect($signalClass, $signalName, $slotClass, $slotName) {
|
2013-02-22 17:21:57 +01:00
|
|
|
// If we're trying to connect to an emitting class that isn't
|
2013-02-06 17:43:03 +00:00
|
|
|
// yet registered, register it
|
2020-04-09 16:07:47 +02:00
|
|
|
if (!array_key_exists($signalClass, self::$registered)) {
|
2020-03-26 09:30:18 +01:00
|
|
|
self::$registered[$signalClass] = [];
|
2011-07-27 19:07:28 +02:00
|
|
|
}
|
2013-02-22 17:21:57 +01:00
|
|
|
// If we're trying to connect to an emitting method that isn't
|
2013-02-06 17:43:03 +00:00
|
|
|
// yet registered, register it with the emitting class
|
2020-04-09 16:07:47 +02:00
|
|
|
if (!array_key_exists($signalName, self::$registered[$signalClass])) {
|
2020-03-26 09:30:18 +01:00
|
|
|
self::$registered[$signalClass][$signalName] = [];
|
2011-07-27 19:07:28 +02:00
|
|
|
}
|
2013-02-22 17:21:57 +01:00
|
|
|
|
2016-01-11 12:26:04 +01:00
|
|
|
// don't connect hooks twice
|
2015-04-02 17:53:40 +02:00
|
|
|
foreach (self::$registered[$signalClass][$signalName] as $hook) {
|
|
|
|
if ($hook['class'] === $slotClass and $hook['name'] === $slotName) {
|
2014-06-05 21:08:30 +02:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
2013-02-06 17:43:03 +00:00
|
|
|
// Connect the hook handler to the requested emitter
|
2020-03-26 09:30:18 +01:00
|
|
|
self::$registered[$signalClass][$signalName][] = [
|
2020-04-09 09:22:29 +02:00
|
|
|
'class' => $slotClass,
|
|
|
|
'name' => $slotName
|
2020-03-26 09:30:18 +01:00
|
|
|
];
|
2013-02-22 17:21:57 +01:00
|
|
|
|
2011-07-27 19:07:28 +02:00
|
|
|
// No chance for failure ;-)
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-19 17:50:53 +02:00
|
|
|
* emits a signal
|
2015-04-01 12:35:42 +02:00
|
|
|
*
|
|
|
|
* @param string $signalClass class name of emitter
|
|
|
|
* @param string $signalName name of signal
|
2014-05-12 23:27:36 +01:00
|
|
|
* @param mixed $params default: array() array with additional data
|
2015-01-16 18:31:15 +00:00
|
|
|
* @return bool true if slots exists or false if not
|
2021-06-29 19:20:33 -04:00
|
|
|
* @throws \OCP\HintException
|
2016-01-11 12:26:04 +01:00
|
|
|
* @throws \OC\ServerNotAvailableException Emits a signal. To get data from the slot use references!
|
2011-07-27 19:07:28 +02:00
|
|
|
*
|
|
|
|
* TODO: write example
|
|
|
|
*/
|
2020-04-10 16:51:06 +02:00
|
|
|
public static function emit($signalClass, $signalName, $params = []) {
|
2013-02-06 17:43:03 +00:00
|
|
|
// Return false if no hook handlers are listening to this
|
|
|
|
// emitting class
|
2020-04-09 16:07:47 +02:00
|
|
|
if (!array_key_exists($signalClass, self::$registered)) {
|
2011-07-27 19:07:28 +02:00
|
|
|
return false;
|
|
|
|
}
|
2013-02-22 17:21:57 +01:00
|
|
|
|
2013-02-06 17:43:03 +00:00
|
|
|
// Return false if no hook handlers are listening to this
|
|
|
|
// emitting method
|
2020-04-09 16:07:47 +02:00
|
|
|
if (!array_key_exists($signalName, self::$registered[$signalClass])) {
|
2011-07-27 19:07:28 +02:00
|
|
|
return false;
|
|
|
|
}
|
2013-02-22 17:21:57 +01:00
|
|
|
|
2011-07-27 19:07:28 +02:00
|
|
|
// Call all slots
|
2020-04-09 16:07:47 +02:00
|
|
|
foreach (self::$registered[$signalClass][$signalName] as $i) {
|
2012-12-16 20:29:36 +01:00
|
|
|
try {
|
2020-04-09 16:07:47 +02:00
|
|
|
call_user_func([ $i['class'], $i['name'] ], $params);
|
2012-12-16 20:29:36 +01:00
|
|
|
} catch (Exception $e) {
|
2015-03-24 10:19:30 +01:00
|
|
|
self::$thrownExceptions[] = $e;
|
2024-09-15 01:37:11 +02:00
|
|
|
\OCP\Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
|
2021-06-29 19:20:33 -04:00
|
|
|
if ($e instanceof \OCP\HintException) {
|
2015-11-13 17:14:08 +01:00
|
|
|
throw $e;
|
|
|
|
}
|
2015-04-10 14:51:21 +02:00
|
|
|
if ($e instanceof \OC\ServerNotAvailableException) {
|
2015-04-01 17:12:28 +02:00
|
|
|
throw $e;
|
|
|
|
}
|
2012-12-16 20:29:36 +01:00
|
|
|
}
|
2011-07-27 19:07:28 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
2012-05-11 20:33:23 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* clear hooks
|
2016-01-11 12:26:04 +01:00
|
|
|
* @param string $signalClass
|
|
|
|
* @param string $signalName
|
2012-05-11 20:33:23 +02:00
|
|
|
*/
|
2020-10-05 15:12:57 +02:00
|
|
|
public static function clear($signalClass = '', $signalName = '') {
|
2016-01-11 12:26:04 +01:00
|
|
|
if ($signalClass) {
|
|
|
|
if ($signalName) {
|
2020-10-05 15:12:57 +02:00
|
|
|
self::$registered[$signalClass][$signalName] = [];
|
2012-05-11 20:33:23 +02:00
|
|
|
} else {
|
2020-10-05 15:12:57 +02:00
|
|
|
self::$registered[$signalClass] = [];
|
2012-05-11 20:33:23 +02:00
|
|
|
}
|
|
|
|
} else {
|
2020-10-05 15:12:57 +02:00
|
|
|
self::$registered = [];
|
2012-05-11 20:33:23 +02:00
|
|
|
}
|
|
|
|
}
|
2013-12-19 20:18:09 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* DO NOT USE!
|
|
|
|
* For unit tests ONLY!
|
|
|
|
*/
|
2020-04-10 16:51:06 +02:00
|
|
|
public static function getHooks() {
|
2013-12-19 20:18:09 +01:00
|
|
|
return self::$registered;
|
|
|
|
}
|
2011-07-27 19:07:28 +02:00
|
|
|
}
|