Skip to content
Snippets Groups Projects
Commit 669d7057 authored by Joas Schilling's avatar Joas Schilling
Browse files

Merge pull request #17830 from... 

Merge pull request #17830 from owncloud/issue-17825-dont-silently-ignore-invalid-consumers-extensions

Throw a InvalidArgumentException when a consumer/extension is invalid
parents d56e03bb 02323eca
Branches
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
lib/private/activitymanager.php
+ 104
− 92
View file @ 669d7057
......@@ -56,14 +56,16 @@ class ActivityManager implements IManager {
$this->config = $config;
}
/**
* @var \Closure[]
*/
/** @var \Closure[] */
private $consumersClosures = array();
/** @var IConsumer[] */
private $consumers = array();
/**
* @var \Closure[]
*/
/** @var \Closure[] */
private $extensionsClosures = array();
/** @var IExtension[] */
private $extensions = array();
/** @var array list of filters "name" => "is valid" */
......@@ -79,6 +81,48 @@ class ActivityManager implements IManager {
/** @var array list of special parameters "app" => ["text" => ["parameter" => "type"]] */
protected $specialParameters = array();
/**
* @return \OCP\Activity\IConsumer[]
*/
protected function getConsumers() {
if (!empty($this->consumers)) {
return $this->consumers;
}
$this->consumers = [];
foreach($this->consumersClosures as $consumer) {
$c = $consumer();
if ($c instanceof IConsumer) {
$this->consumers[] = $c;
} else {
throw new \InvalidArgumentException('The given consumer does not implement the \OCP\Activity\IConsumer interface');
}
}
return $this->consumers;
}
/**
* @return \OCP\Activity\IExtension[]
*/
protected function getExtensions() {
if (!empty($this->extensions)) {
return $this->extensions;
}
$this->extensions = [];
foreach($this->extensionsClosures as $extension) {
$e = $extension();
if ($e instanceof IExtension) {
$this->extensions[] = $e;
} else {
throw new \InvalidArgumentException('The given extension does not implement the \OCP\Activity\IExtension interface');
}
}
return $this->extensions;
}
/**
* @param $app
* @param $subject
......@@ -93,9 +137,7 @@ class ActivityManager implements IManager {
* @return mixed
*/
function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
foreach($this->consumers as $consumer) {
$c = $consumer();
if ($c instanceof IConsumer) {
foreach($this->getConsumers() as $c) {
try {
$c->receive(
$app,
......@@ -112,8 +154,6 @@ class ActivityManager implements IManager {
// TODO: log the exception
}
}
}
}
/**
......@@ -125,7 +165,8 @@ class ActivityManager implements IManager {
* @param \Closure $callable
*/
function registerConsumer(\Closure $callable) {
array_push($this->consumers, $callable);
array_push($this->consumersClosures, $callable);
$this->consumers = [];
}
/**
......@@ -138,7 +179,8 @@ class ActivityManager implements IManager {
* @return void
*/
function registerExtension(\Closure $callable) {
array_push($this->extensions, $callable);
array_push($this->extensionsClosures, $callable);
$this->extensions = [];
}
/**
......@@ -149,15 +191,12 @@ class ActivityManager implements IManager {
*/
function getNotificationTypes($languageCode) {
$notificationTypes = array();
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$result = $c->getNotificationTypes($languageCode);
if (is_array($result)) {
$notificationTypes = array_merge($notificationTypes, $result);
}
}
}
return $notificationTypes;
}
......@@ -168,15 +207,12 @@ class ActivityManager implements IManager {
*/
function getDefaultTypes($method) {
$defaultTypes = array();
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$types = $c->getDefaultTypes($method);
if (is_array($types)) {
$defaultTypes = array_merge($types, $defaultTypes);
}
}
}
return $defaultTypes;
}
......@@ -189,16 +225,13 @@ class ActivityManager implements IManager {
return $this->typeIcons[$type];
}
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$icon = $c->getTypeIcon($type);
if (is_string($icon)) {
$this->typeIcons[$type] = $icon;
return $icon;
}
}
}
$this->typeIcons[$type] = '';
return '';
......@@ -214,15 +247,12 @@ class ActivityManager implements IManager {
* @return string|false
*/
function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$translation = $c->translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
if (is_string($translation)) {
return $translation;
}
}
}
return false;
}
......@@ -241,16 +271,13 @@ class ActivityManager implements IManager {
$this->specialParameters[$app] = array();
}
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$specialParameter = $c->getSpecialParameterList($app, $text);
if (is_array($specialParameter)) {
$this->specialParameters[$app][$text] = $specialParameter;
return $specialParameter;
}
}
}
$this->specialParameters[$app][$text] = false;
return false;
......@@ -261,15 +288,12 @@ class ActivityManager implements IManager {
* @return integer|false
*/
function getGroupParameter($activity) {
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$parameter = $c->getGroupParameter($activity);
if ($parameter !== false) {
return $parameter;
}
}
}
return false;
}
......@@ -282,16 +306,13 @@ class ActivityManager implements IManager {
'apps' => array(),
'top' => array(),
);
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$additionalEntries = $c->getNavigation();
if (is_array($additionalEntries)) {
$entries['apps'] = array_merge($entries['apps'], $additionalEntries['apps']);
$entries['top'] = array_merge($entries['top'], $additionalEntries['top']);
}
}
}
return $entries;
}
......@@ -305,15 +326,12 @@ class ActivityManager implements IManager {
return $this->validFilters[$filterValue];
}
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
if ($c->isFilterValid($filterValue) === true) {
$this->validFilters[$filterValue] = true;
return true;
}
}
}
$this->validFilters[$filterValue] = false;
return false;
......@@ -329,15 +347,12 @@ class ActivityManager implements IManager {
return $types;
}
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$result = $c->filterNotificationTypes($types, $filter);
if (is_array($result)) {
$types = $result;
}
}
}
return $types;
}
......@@ -353,9 +368,7 @@ class ActivityManager implements IManager {
$conditions = array();
$parameters = array();
foreach($this->extensions as $extension) {
$c = $extension();
if ($c instanceof IExtension) {
foreach ($this->getExtensions() as $c) {
$result = $c->getQueryForFilter($filter);
if (is_array($result)) {
list($condition, $parameter) = $result;
......@@ -365,7 +378,6 @@ class ActivityManager implements IManager {
}
}
}
}
if (empty($conditions)) {
return array(null, null);
......
tests/lib/activitymanager.php
+ 43
− 0
View file @ 669d7057
......@@ -41,6 +41,9 @@ class Test_ActivityManager extends \Test\TestCase {
$this->config
);
$this->activityManager->registerConsumer(function() {
return new NoOpConsumer();
});
$this->activityManager->registerExtension(function() {
return new NoOpExtension();
});
......@@ -49,6 +52,40 @@ class Test_ActivityManager extends \Test\TestCase {
});
}
public function testGetConsumers() {
$consumers = $this->invokePrivate($this->activityManager, 'getConsumers');
$this->assertNotEmpty($consumers);
}
/**
* @expectedException \InvalidArgumentException
*/
public function testGetConsumersInvalidConsumer() {
$this->activityManager->registerConsumer(function() {
return new StdClass();
});
$this->invokePrivate($this->activityManager, 'getConsumers');
}
public function testGetExtensions() {
$extensions = $this->invokePrivate($this->activityManager, 'getExtensions');
$this->assertNotEmpty($extensions);
}
/**
* @expectedException \InvalidArgumentException
*/
public function testGetExtensionsInvalidExtension() {
$this->activityManager->registerExtension(function() {
return new StdClass();
});
$this->invokePrivate($this->activityManager, 'getExtensions');
}
public function testNotificationTypes() {
$result = $this->activityManager->getNotificationTypes('en');
$this->assertTrue(is_array($result));
......@@ -328,3 +365,9 @@ class NoOpExtension implements \OCP\Activity\IExtension {
return false;
}
}
class NoOpConsumer implements \OCP\Activity\IConsumer {
public function receive($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment