+++ /dev/null
-<?php
-/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program 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 Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
-
-namespace OCA\Files;
-
-use OCP\IDBConnection;
-use OCP\L10N\IFactory;
-use OCP\Activity\IExtension;
-use OCP\Activity\IManager;
-use OCP\IConfig;
-use OCP\IL10N;
-use OCP\IURLGenerator;
-
-class Activity implements IExtension {
- const APP_FILES = 'files';
- const FILTER_FILES = 'files';
- const FILTER_FAVORITES = 'files_favorites';
-
- const TYPE_SHARE_CREATED = 'file_created';
- const TYPE_SHARE_CHANGED = 'file_changed';
- const TYPE_SHARE_DELETED = 'file_deleted';
- const TYPE_SHARE_RESTORED = 'file_restored';
- const TYPE_FAVORITES = 'files_favorites';
-
- /** @var IL10N */
- protected $l;
-
- /** @var IFactory */
- protected $languageFactory;
-
- /** @var IURLGenerator */
- protected $URLGenerator;
-
- /** @var \OCP\Activity\IManager */
- protected $activityManager;
-
- /** @var \OCP\IDBConnection */
- protected $connection;
-
- /** @var \OCP\IConfig */
- protected $config;
-
- /**
- * @param IFactory $languageFactory
- * @param IURLGenerator $URLGenerator
- * @param IManager $activityManager
- * @param IDBConnection $connection
- * @param IConfig $config
- */
- public function __construct(IFactory $languageFactory, IURLGenerator $URLGenerator, IManager $activityManager, IDBConnection $connection, IConfig $config) {
- $this->languageFactory = $languageFactory;
- $this->URLGenerator = $URLGenerator;
- $this->l = $this->getL10N();
- $this->activityManager = $activityManager;
- $this->connection = $connection;
- $this->config = $config;
- }
-
- /**
- * @param string|null $languageCode
- * @return IL10N
- */
- protected function getL10N($languageCode = null) {
- return $this->languageFactory->get(self::APP_FILES, $languageCode);
- }
-
- /**
- * The extension can return an array of additional notification types.
- * If no additional types are to be added false is to be returned
- *
- * @param string $languageCode
- * @return array|false Array "stringID of the type" => "translated string description for the setting"
- * or Array "stringID of the type" => [
- * 'desc' => "translated string description for the setting"
- * 'methods' => [self::METHOD_*],
- * ]
- */
- public function getNotificationTypes($languageCode) {
- return false;
- }
-
- /**
- * For a given method additional types to be displayed in the settings can be returned.
- * In case no additional types are to be added false is to be returned.
- *
- * @param string $method
- * @return array|false
- */
- public function getDefaultTypes($method) {
- return false;
- }
-
- /**
- * The extension can translate a given message to the requested languages.
- * If no translation is available false is to be returned.
- *
- * @param string $app
- * @param string $text
- * @param array $params
- * @param boolean $stripPath
- * @param boolean $highlightParams
- * @param string $languageCode
- * @return string|false
- */
- public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
- if ($app !== self::APP_FILES) {
- return false;
- }
-
- $l = $this->getL10N($languageCode);
-
- if ($this->activityManager->isFormattingFilteredObject()) {
- $translation = $this->translateShort($text, $l, $params);
- if ($translation !== false) {
- return $translation;
- }
- }
-
- return $this->translateLong($text, $l, $params);
- }
-
- /**
- * @param string $text
- * @param IL10N $l
- * @param array $params
- * @return string|false
- */
- protected function translateLong($text, IL10N $l, array $params) {
- switch ($text) {
- case 'created_self':
- return (string) $l->t('You created %1$s', $params);
- case 'created_by':
- return (string) $l->t('%2$s created %1$s', $params);
- case 'created_public':
- return (string) $l->t('%1$s was created in a public folder', $params);
- case 'changed_self':
- return (string) $l->t('You changed %1$s', $params);
- case 'changed_by':
- return (string) $l->t('%2$s changed %1$s', $params);
- case 'deleted_self':
- return (string) $l->t('You deleted %1$s', $params);
- case 'deleted_by':
- return (string) $l->t('%2$s deleted %1$s', $params);
- case 'restored_self':
- return (string) $l->t('You restored %1$s', $params);
- case 'restored_by':
- return (string) $l->t('%2$s restored %1$s', $params);
- case 'renamed_self':
- return (string) $l->t('You renamed %2$s to %1$s', $params);
- case 'renamed_by':
- return (string) $l->t('%2$s renamed %3$s to %1$s', $params);
- case 'moved_self':
- return (string) $l->t('You moved %2$s to %1$s', $params);
- case 'moved_by':
- return (string) $l->t('%2$s moved %3$s to %1$s', $params);
-
- default:
- return false;
- }
- }
-
- /**
- * @param string $text
- * @param IL10N $l
- * @param array $params
- * @return string|false
- */
- protected function translateShort($text, IL10N $l, array $params) {
- switch ($text) {
- case 'changed_by':
- return (string) $l->t('Changed by %2$s', $params);
- case 'deleted_by':
- return (string) $l->t('Deleted by %2$s', $params);
- case 'restored_by':
- return (string) $l->t('Restored by %2$s', $params);
- case 'renamed_by':
- return (string) $l->t('Renamed by %2$s', $params);
- case 'moved_by':
- return (string) $l->t('Moved by %2$s', $params);
-
- default:
- return false;
- }
- }
-
- /**
- * The extension can define the type of parameters for translation
- *
- * Currently known types are:
- * * file => will strip away the path of the file and add a tooltip with it
- * * username => will add the avatar of the user
- *
- * @param string $app
- * @param string $text
- * @return array|false
- */
- function getSpecialParameterList($app, $text) {
- if ($app === self::APP_FILES) {
- switch ($text) {
- case 'created_self':
- case 'created_by':
- case 'created_public':
- case 'changed_self':
- case 'changed_by':
- case 'deleted_self':
- case 'deleted_by':
- case 'restored_self':
- case 'restored_by':
- return [
- 0 => 'file',
- 1 => 'username',
- ];
- case 'renamed_self':
- case 'moved_self':
- return [
- 0 => 'file',
- 1 => 'file',
- ];
- case 'renamed_by':
- case 'moved_by':
- return [
- 0 => 'file',
- 1 => 'username',
- 2 => 'file',
- ];
- }
- }
-
- return false;
- }
-
- /**
- * A string naming the css class for the icon to be used can be returned.
- * If no icon is known for the given type false is to be returned.
- *
- * @param string $type
- * @return string|false
- */
- public function getTypeIcon($type) {
- switch ($type) {
- case self::TYPE_SHARE_CHANGED:
- return 'icon-change';
- case self::TYPE_SHARE_CREATED:
- return 'icon-add-color';
- case self::TYPE_SHARE_DELETED:
- return 'icon-delete-color';
-
- default:
- return false;
- }
- }
-
- /**
- * The extension can define the parameter grouping by returning the index as integer.
- * In case no grouping is required false is to be returned.
- *
- * @param array $activity
- * @return integer|false
- */
- public function getGroupParameter($activity) {
- if ($activity['app'] === self::APP_FILES) {
- switch ($activity['subject']) {
- case 'created_self':
- case 'created_by':
- case 'changed_self':
- case 'changed_by':
- case 'deleted_self':
- case 'deleted_by':
- case 'restored_self':
- case 'restored_by':
- return 0;
- }
- }
-
- return false;
- }
-
- /**
- * The extension can define additional navigation entries. The array returned has to contain two keys 'top'
- * and 'apps' which hold arrays with the relevant entries.
- * If no further entries are to be added false is no be returned.
- *
- * @return array|false
- */
- public function getNavigation() {
- return false;
- }
-
- /**
- * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.
- *
- * @param string $filterValue
- * @return boolean
- */
- public function isFilterValid($filterValue) {
- return false;
- }
-
- /**
- * The extension can filter the types based on the filter if required.
- * In case no filter is to be applied false is to be returned unchanged.
- *
- * @param array $types
- * @param string $filter
- * @return array|false
- */
- public function filterNotificationTypes($types, $filter) {
- return false;
- }
-
- /**
- * For a given filter the extension can specify the sql query conditions including parameters for that query.
- * In case the extension does not know the filter false is to be returned.
- * The query condition and the parameters are to be returned as array with two elements.
- * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
- *
- * @param string $filter
- * @return array|false
- */
- public function getQueryForFilter($filter) {
- return false;
- }
-}
+++ /dev/null
-<?php
-/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program 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 Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
-
-namespace OCA\Files\Tests;
-
-use OCA\Files\Activity;
-use OCP\IL10N;
-use OCP\L10N\IFactory;
-use Test\TestCase;
-
-/**
- * Class ActivityTest
- *
- * @group DB
- * @package OCA\Files\Tests
- */
-class ActivityTest extends TestCase {
-
- /** @var \OCP\Activity\IManager */
- private $activityManager;
-
- /** @var \OCP\IRequest|\PHPUnit_Framework_MockObject_MockObject */
- protected $request;
-
- /** @var \OCP\IUserSession|\PHPUnit_Framework_MockObject_MockObject */
- protected $session;
-
- /** @var \OCP\IConfig|\PHPUnit_Framework_MockObject_MockObject */
- protected $config;
-
- /** @var \OCP\L10N\IFactory|\PHPUnit_Framework_MockObject_MockObject */
- protected $l10nFactory;
-
- /** @var \OCA\Files\Activity */
- protected $activityExtension;
-
- protected function setUp() {
- parent::setUp();
-
- $this->request = $this->getMockBuilder('OCP\IRequest')
- ->disableOriginalConstructor()
- ->getMock();
- $this->session = $this->getMockBuilder('OCP\IUserSession')
- ->disableOriginalConstructor()
- ->getMock();
- $this->config = $this->getMockBuilder('OCP\IConfig')
- ->disableOriginalConstructor()
- ->getMock();
-
- $this->activityManager = new \OC\Activity\Manager(
- $this->request,
- $this->session,
- $this->config
- );
-
- $this->l10nFactory = $this->createMock(IFactory::class);
- $deL10n = $this->createMock(IL10N::class);
- $deL10n->expects($this->any())
- ->method('t')
- ->willReturnCallback(function ($argument) {
- return 'translate(' . $argument . ')';
- });
-
- $this->l10nFactory->expects($this->any())
- ->method('get')
- ->willReturnMap([
- ['files', null, \OC::$server->getL10N('files', 'en')],
- ['files', 'en', \OC::$server->getL10N('files', 'en')],
- ['files', 'de', $deL10n],
- ]);
-
- $this->activityExtension = $activityExtension = new Activity(
- $this->l10nFactory,
- $this->getMockBuilder('OCP\IURLGenerator')->disableOriginalConstructor()->getMock(),
- $this->activityManager,
- \OC::$server->getDatabaseConnection(),
- $this->config
- );
-
- $this->activityManager->registerExtension(function() use ($activityExtension) {
- return $activityExtension;
- });
- }
-
- public function testNotificationTypes() {
- $result = $this->activityExtension->getNotificationTypes('en');
- $this->assertTrue(is_array($result), 'Asserting getNotificationTypes() returns an array');
- $this->assertCount(5, $result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_CREATED, $result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_CHANGED, $result);
- $this->assertArrayHasKey(Activity::TYPE_FAVORITES, $result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_DELETED, $result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_RESTORED, $result);
- }
-
- public function testDefaultTypes() {
- $result = $this->activityExtension->getDefaultTypes('stream');
- $this->assertTrue(is_array($result), 'Asserting getDefaultTypes(stream) returns an array');
- $this->assertCount(4, $result);
- $result = array_flip($result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_CREATED, $result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_CHANGED, $result);
- $this->assertArrayNotHasKey(Activity::TYPE_FAVORITES, $result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_DELETED, $result);
- $this->assertArrayHasKey(Activity::TYPE_SHARE_RESTORED, $result);
-
- $result = $this->activityExtension->getDefaultTypes('email');
- $this->assertFalse($result, 'Asserting getDefaultTypes(email) returns false');
- }
-
- public function testTranslate() {
- $this->assertFalse(
- $this->activityExtension->translate('files_sharing', '', [], false, false, 'en'),
- 'Asserting that no translations are set for files_sharing'
- );
-
- // Test english
- $this->assertNotFalse(
- $this->activityExtension->translate('files', 'deleted_self', ['file'], false, false, 'en'),
- 'Asserting that translations are set for files.deleted_self'
- );
- $this->assertStringStartsWith(
- 'You deleted ',
- $this->activityExtension->translate('files', 'deleted_self', ['file'], false, false, 'en')
- );
-
- // Test translation
- $this->assertNotFalse(
- $this->activityExtension->translate('files', 'deleted_self', ['file'], false, false, 'de'),
- 'Asserting that translations are set for files.deleted_self'
- );
- $this->assertStringStartsWith(
- 'translate(You deleted ',
- $this->activityExtension->translate('files', 'deleted_self', ['file'], false, false, 'de')
- );
- }
-
- public function testGetSpecialParameterList() {
- $this->assertFalse(
- $this->activityExtension->getSpecialParameterList('files_sharing', ''),
- 'Asserting that no special parameters are set for files_sharing'
- );
- }
-
- public function typeIconData() {
- return [
- [Activity::TYPE_SHARE_CHANGED, 'icon-change'],
- [Activity::TYPE_SHARE_CREATED, 'icon-add-color'],
- [Activity::TYPE_SHARE_DELETED, 'icon-delete-color'],
- [Activity::TYPE_SHARE_RESTORED, false],
- [Activity::TYPE_FAVORITES, false],
- ['unknown type', false],
- ];
- }
-
- /**
- * @dataProvider typeIconData
- *
- * @param string $type
- * @param mixed $expected
- */
- public function testTypeIcon($type, $expected) {
- $this->assertSame($expected, $this->activityExtension->getTypeIcon($type));
- }
-
- public function testGroupParameter() {
- $this->assertFalse(
- $this->activityExtension->getGroupParameter(['app' => 'files_sharing']),
- 'Asserting that no group parameters are set for files_sharing'
- );
- }
-
- public function testNavigation() {
- $result = $this->activityExtension->getNavigation();
- $this->assertCount(1, $result['top']);
- $this->assertArrayHasKey(Activity::FILTER_FAVORITES, $result['top']);
-
- $this->assertCount(1, $result['apps']);
- $this->assertArrayHasKey(Activity::FILTER_FILES, $result['apps']);
- }
-
- public function testIsFilterValid() {
- $this->assertTrue($this->activityExtension->isFilterValid(Activity::FILTER_FAVORITES));
- $this->assertTrue($this->activityExtension->isFilterValid(Activity::FILTER_FILES));
- $this->assertFalse($this->activityExtension->isFilterValid('unknown filter'));
- }
-
- public function filterNotificationTypesData() {
- return [
- [
- Activity::FILTER_FILES,
- [
- 'NT0',
- Activity::TYPE_SHARE_CREATED,
- Activity::TYPE_SHARE_CHANGED,
- Activity::TYPE_SHARE_DELETED,
- Activity::TYPE_SHARE_RESTORED,
- Activity::TYPE_FAVORITES,
- ], [
- Activity::TYPE_SHARE_CREATED,
- Activity::TYPE_SHARE_CHANGED,
- Activity::TYPE_SHARE_DELETED,
- Activity::TYPE_SHARE_RESTORED,
- ],
- ],
- [
- Activity::FILTER_FILES,
- [
- 'NT0',
- Activity::TYPE_SHARE_CREATED,
- Activity::TYPE_FAVORITES,
- ],
- [
- Activity::TYPE_SHARE_CREATED,
- ],
- ],
- [
- Activity::FILTER_FAVORITES,
- [
- 'NT0',
- Activity::TYPE_SHARE_CREATED,
- Activity::TYPE_SHARE_CHANGED,
- Activity::TYPE_SHARE_DELETED,
- Activity::TYPE_SHARE_RESTORED,
- Activity::TYPE_FAVORITES,
- ], [
- Activity::TYPE_SHARE_CREATED,
- Activity::TYPE_SHARE_CHANGED,
- Activity::TYPE_SHARE_DELETED,
- Activity::TYPE_SHARE_RESTORED,
- ],
- ],
- [
- 'unknown filter',
- [
- 'NT0',
- Activity::TYPE_SHARE_CREATED,
- Activity::TYPE_SHARE_CHANGED,
- Activity::TYPE_SHARE_DELETED,
- Activity::TYPE_SHARE_RESTORED,
- Activity::TYPE_FAVORITES,
- ],
- false,
- ],
- ];
- }
-
- /**
- * @dataProvider filterNotificationTypesData
- *
- * @param string $filter
- * @param array $types
- * @param mixed $expected
- */
- public function testFilterNotificationTypes($filter, $types, $expected) {
- $result = $this->activityExtension->filterNotificationTypes($types, $filter);
- $this->assertEquals($expected, $result);
- }
-
- public function queryForFilterData() {
- return [
- [
- new \RuntimeException(),
- '`app` = ?',
- ['files']
- ],
- [
- [
- 'items' => [],
- 'folders' => [],
- ],
- ' CASE WHEN `app` <> ? THEN 1 WHEN `app` = ? AND ((`type` <> ? AND `type` <> ?)) THEN 1 ELSE 0 END = 1 ',
- ['files', 'files', Activity::TYPE_SHARE_CREATED, Activity::TYPE_SHARE_CHANGED]
- ],
- [
- [
- 'items' => ['file.txt', 'folder'],
- 'folders' => ['folder'],
- ],
- ' CASE WHEN `app` <> ? THEN 1 WHEN `app` = ? AND ((`type` <> ? AND `type` <> ?) OR `file` = ? OR `file` = ? OR `file` LIKE ?) THEN 1 ELSE 0 END = 1 ',
- ['files', 'files', Activity::TYPE_SHARE_CREATED, Activity::TYPE_SHARE_CHANGED, 'file.txt', 'folder', 'folder/%']
- ],
- ];
- }
-
- /**
- * @dataProvider queryForFilterData
- *
- * @param mixed $will
- * @param string $query
- * @param array $parameters
- */
- public function testQueryForFilter($will, $query, $parameters) {
- $this->mockUserSession('test');
-
- $this->config->expects($this->any())
- ->method('getUserValue')
- ->willReturnMap([
- ['test', 'activity', 'notify_stream_' . Activity::TYPE_FAVORITES, false, true],
- ]);
- if (is_array($will)) {
- $this->activityHelper->expects($this->any())
- ->method('getFavoriteFilePaths')
- ->with('test')
- ->willReturn($will);
- } else {
- $this->activityHelper->expects($this->any())
- ->method('getFavoriteFilePaths')
- ->with('test')
- ->willThrowException($will);
- }
-
- $result = $this->activityExtension->getQueryForFilter('all');
- $this->assertEquals([$query, $parameters], $result);
-
- $this->executeQueryForFilter($result);
- }
-
- public function executeQueryForFilter(array $result) {
- list($resultQuery, $resultParameters) = $result;
- $resultQuery = str_replace('`file`', '`user`', $resultQuery);
- $resultQuery = str_replace('`type`', '`key`', $resultQuery);
-
- $connection = \OC::$server->getDatabaseConnection();
- // Test the query on the privatedata table, because the activity table
- // does not exist in core
- $result = $connection->executeQuery('SELECT * FROM `*PREFIX*privatedata` WHERE ' . $resultQuery, $resultParameters);
- $rows = $result->fetchAll();
- $result->closeCursor();
- }
-
- protected function mockUserSession($user) {
- $mockUser = $this->getMockBuilder('\OCP\IUser')
- ->disableOriginalConstructor()
- ->getMock();
- $mockUser->expects($this->any())
- ->method('getUID')
- ->willReturn($user);
-
- $this->session->expects($this->any())
- ->method('isLoggedIn')
- ->willReturn(true);
- $this->session->expects($this->any())
- ->method('getUser')
- ->willReturn($mockUser);
- }
-}
projects / nextcloud-server.git / commitdiff