mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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

Throw a InvalidArgumentException when a consumer/extension is invalid
This commit is contained in:
Joas Schilling 2015-08-11 10:16:20 +02:00
parent d56e03bb94 02323eca01
commit 669d705792
2 changed files with 147 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

196
lib/private/activitymanager.php
View File

@ -56,14 +56,16 @@ class ActivityManager implements IManager {
$this->config = $config; $this->config = $config;
} }
/** /** @var \Closure[] */
* @var \Closure[] private $consumersClosures = array();
*/
/** @var IConsumer[] */
private $consumers = array(); private $consumers = array();
/** /** @var \Closure[] */
* @var \Closure[] private $extensionsClosures = array();
*/
/** @var IExtension[] */
private $extensions = array(); private $extensions = array();
/** @var array list of filters "name" => "is valid" */ /** @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"]] */ /** @var array list of special parameters "app" => ["text" => ["parameter" => "type"]] */
protected $specialParameters = array(); 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 $app
* @param $subject * @param $subject
@ -93,10 +137,8 @@ class ActivityManager implements IManager {
* @return mixed * @return mixed
*/ */
function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) { function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
foreach($this->consumers as $consumer) { foreach($this->getConsumers() as $c) {
$c = $consumer(); try {
if ($c instanceof IConsumer) {
try {
$c->receive( $c->receive(
$app, $app,
$subject, $subject,
@ -108,11 +150,9 @@ class ActivityManager implements IManager {
$affectedUser, $affectedUser,
$type, $type,
$priority); $priority);
} catch (\Exception $ex) { } catch (\Exception $ex) {
// TODO: log the exception // TODO: log the exception
}
} }
} }
} }
@ -125,7 +165,8 @@ class ActivityManager implements IManager {
* @param \Closure $callable * @param \Closure $callable
*/ */
function registerConsumer(\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 * @return void
*/ */
function registerExtension(\Closure $callable) { function registerExtension(\Closure $callable) {
array_push($this->extensions, $callable); array_push($this->extensionsClosures, $callable);
$this->extensions = [];
} }
/** /**
@ -149,13 +191,10 @@ class ActivityManager implements IManager {
*/ */
function getNotificationTypes($languageCode) { function getNotificationTypes($languageCode) {
$notificationTypes = array(); $notificationTypes = array();
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $result = $c->getNotificationTypes($languageCode);
if ($c instanceof IExtension) { if (is_array($result)) {
$result = $c->getNotificationTypes($languageCode); $notificationTypes = array_merge($notificationTypes, $result);
if (is_array($result)) {
$notificationTypes = array_merge($notificationTypes, $result);
}
} }
} }
@ -168,13 +207,10 @@ class ActivityManager implements IManager {
*/ */
function getDefaultTypes($method) { function getDefaultTypes($method) {
$defaultTypes = array(); $defaultTypes = array();
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $types = $c->getDefaultTypes($method);
if ($c instanceof IExtension) { if (is_array($types)) {
$types = $c->getDefaultTypes($method); $defaultTypes = array_merge($types, $defaultTypes);
if (is_array($types)) {
$defaultTypes = array_merge($types, $defaultTypes);
}
} }
} }
return $defaultTypes; return $defaultTypes;
@ -189,14 +225,11 @@ class ActivityManager implements IManager {
return $this->typeIcons[$type]; return $this->typeIcons[$type];
} }
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $icon = $c->getTypeIcon($type);
if ($c instanceof IExtension) { if (is_string($icon)) {
$icon = $c->getTypeIcon($type); $this->typeIcons[$type] = $icon;
if (is_string($icon)) { return $icon;
$this->typeIcons[$type] = $icon;
return $icon;
}
} }
} }
@ -214,13 +247,10 @@ class ActivityManager implements IManager {
* @return string|false * @return string|false
*/ */
function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) { function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $translation = $c->translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
if ($c instanceof IExtension) { if (is_string($translation)) {
$translation = $c->translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); return $translation;
if (is_string($translation)) {
return $translation;
}
} }
} }
@ -241,14 +271,11 @@ class ActivityManager implements IManager {
$this->specialParameters[$app] = array(); $this->specialParameters[$app] = array();
} }
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $specialParameter = $c->getSpecialParameterList($app, $text);
if ($c instanceof IExtension) { if (is_array($specialParameter)) {
$specialParameter = $c->getSpecialParameterList($app, $text); $this->specialParameters[$app][$text] = $specialParameter;
if (is_array($specialParameter)) { return $specialParameter;
$this->specialParameters[$app][$text] = $specialParameter;
return $specialParameter;
}
} }
} }
@ -261,13 +288,10 @@ class ActivityManager implements IManager {
* @return integer|false * @return integer|false
*/ */
function getGroupParameter($activity) { function getGroupParameter($activity) {
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $parameter = $c->getGroupParameter($activity);
if ($c instanceof IExtension) { if ($parameter !== false) {
$parameter = $c->getGroupParameter($activity); return $parameter;
if ($parameter !== false) {
return $parameter;
}
} }
} }
@ -282,14 +306,11 @@ class ActivityManager implements IManager {
'apps' => array(), 'apps' => array(),
'top' => array(), 'top' => array(),
); );
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $additionalEntries = $c->getNavigation();
if ($c instanceof IExtension) { if (is_array($additionalEntries)) {
$additionalEntries = $c->getNavigation(); $entries['apps'] = array_merge($entries['apps'], $additionalEntries['apps']);
if (is_array($additionalEntries)) { $entries['top'] = array_merge($entries['top'], $additionalEntries['top']);
$entries['apps'] = array_merge($entries['apps'], $additionalEntries['apps']);
$entries['top'] = array_merge($entries['top'], $additionalEntries['top']);
}
} }
} }
@ -305,13 +326,10 @@ class ActivityManager implements IManager {
return $this->validFilters[$filterValue]; return $this->validFilters[$filterValue];
} }
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); if ($c->isFilterValid($filterValue) === true) {
if ($c instanceof IExtension) { $this->validFilters[$filterValue] = true;
if ($c->isFilterValid($filterValue) === true) { return true;
$this->validFilters[$filterValue] = true;
return true;
}
} }
} }
@ -329,13 +347,10 @@ class ActivityManager implements IManager {
return $types; return $types;
} }
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $result = $c->filterNotificationTypes($types, $filter);
if ($c instanceof IExtension) { if (is_array($result)) {
$result = $c->filterNotificationTypes($types, $filter); $types = $result;
if (is_array($result)) {
$types = $result;
}
} }
} }
return $types; return $types;
@ -353,16 +368,13 @@ class ActivityManager implements IManager {
$conditions = array(); $conditions = array();
$parameters = array(); $parameters = array();
foreach($this->extensions as $extension) { foreach ($this->getExtensions() as $c) {
$c = $extension(); $result = $c->getQueryForFilter($filter);
if ($c instanceof IExtension) { if (is_array($result)) {
$result = $c->getQueryForFilter($filter); list($condition, $parameter) = $result;
if (is_array($result)) { if ($condition && is_array($parameter)) {
list($condition, $parameter) = $result; $conditions[] = $condition;
if ($condition && is_array($parameter)) { $parameters = array_merge($parameters, $parameter);
$conditions[] = $condition;
$parameters = array_merge($parameters, $parameter);
}
} }
} }
} }

43
tests/lib/activitymanager.php
View File

@ -41,6 +41,9 @@ class Test_ActivityManager extends \Test\TestCase {
$this->config $this->config
); );
$this->activityManager->registerConsumer(function() {
return new NoOpConsumer();
});
$this->activityManager->registerExtension(function() { $this->activityManager->registerExtension(function() {
return new NoOpExtension(); 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() { public function testNotificationTypes() {
$result = $this->activityManager->getNotificationTypes('en'); $result = $this->activityManager->getNotificationTypes('en');
$this->assertTrue(is_array($result)); $this->assertTrue(is_array($result));
@ -328,3 +365,9 @@ class NoOpExtension implements \OCP\Activity\IExtension {
return false; return false;
} }
} }
class NoOpConsumer implements \OCP\Activity\IConsumer {
public function receive($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
}
}