Merge branch 'master' into files_encryption
Conflicts: lib/files/cache/cache.php
This commit is contained in:
commit
28d72b822d
|
@ -280,6 +280,14 @@
|
||||||
<length>4</length>
|
<length>4</length>
|
||||||
</field>
|
</field>
|
||||||
|
|
||||||
|
<field>
|
||||||
|
<name>storage_mtime</name>
|
||||||
|
<type>integer</type>
|
||||||
|
<default></default>
|
||||||
|
<notnull>true</notnull>
|
||||||
|
<length>4</length>
|
||||||
|
</field>
|
||||||
|
|
||||||
<field>
|
<field>
|
||||||
<name>encrypted</name>
|
<name>encrypted</name>
|
||||||
<type>integer</type>
|
<type>integer</type>
|
||||||
|
|
|
@ -107,7 +107,7 @@ class Cache {
|
||||||
$params = array($file);
|
$params = array($file);
|
||||||
}
|
}
|
||||||
$query = \OC_DB::prepare(
|
$query = \OC_DB::prepare(
|
||||||
'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, `encrypted`, `unencrypted_size`, `etag`
|
'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, `storage_mtime`, `encrypted`, `unencrypted_size`, `etag`
|
||||||
FROM `*PREFIX*filecache` ' . $where);
|
FROM `*PREFIX*filecache` ' . $where);
|
||||||
$result = $query->execute($params);
|
$result = $query->execute($params);
|
||||||
$data = $result->fetchRow();
|
$data = $result->fetchRow();
|
||||||
|
@ -127,6 +127,9 @@ class Cache {
|
||||||
$data['storage'] = $this->storageId;
|
$data['storage'] = $this->storageId;
|
||||||
$data['mimetype'] = $this->getMimetype($data['mimetype']);
|
$data['mimetype'] = $this->getMimetype($data['mimetype']);
|
||||||
$data['mimepart'] = $this->getMimetype($data['mimepart']);
|
$data['mimepart'] = $this->getMimetype($data['mimepart']);
|
||||||
|
if ($data['storage_mtime'] == 0) {
|
||||||
|
$data['storage_mtime'] = $data['mtime'];
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return $data;
|
return $data;
|
||||||
|
@ -142,13 +145,16 @@ class Cache {
|
||||||
$fileId = $this->getId($folder);
|
$fileId = $this->getId($folder);
|
||||||
if ($fileId > -1) {
|
if ($fileId > -1) {
|
||||||
$query = \OC_DB::prepare(
|
$query = \OC_DB::prepare(
|
||||||
'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, `encrypted`, `unencrypted_size`, `etag`
|
'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, `storage_mtime`, `encrypted`, `unencrypted_size`, `etag`
|
||||||
FROM `*PREFIX*filecache` WHERE parent = ? ORDER BY `name` ASC');
|
FROM `*PREFIX*filecache` WHERE parent = ? ORDER BY `name` ASC');
|
||||||
$result = $query->execute(array($fileId));
|
$result = $query->execute(array($fileId));
|
||||||
$files = $result->fetchAll();
|
$files = $result->fetchAll();
|
||||||
foreach ($files as &$file) {
|
foreach ($files as &$file) {
|
||||||
$file['mimetype'] = $this->getMimetype($file['mimetype']);
|
$file['mimetype'] = $this->getMimetype($file['mimetype']);
|
||||||
$file['mimepart'] = $this->getMimetype($file['mimepart']);
|
$file['mimepart'] = $this->getMimetype($file['mimepart']);
|
||||||
|
if ($file['storage_mtime'] == 0) {
|
||||||
|
$file['storage_mtime'] = $file['mtime'];
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return $files;
|
return $files;
|
||||||
} else {
|
} else {
|
||||||
|
@ -225,7 +231,7 @@ class Cache {
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
function buildParts(array $data) {
|
function buildParts(array $data) {
|
||||||
$fields = array('path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'encrypted', 'unencrypted_size', 'etag');
|
$fields = array('path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'storage_mtime', 'encrypted', 'unencrypted_size', 'etag');
|
||||||
$params = array();
|
$params = array();
|
||||||
$queryParts = array();
|
$queryParts = array();
|
||||||
foreach ($data as $name => $value) {
|
foreach ($data as $name => $value) {
|
||||||
|
@ -237,6 +243,11 @@ class Cache {
|
||||||
$params[] = $this->getMimetypeId(substr($value, 0, strpos($value, '/')));
|
$params[] = $this->getMimetypeId(substr($value, 0, strpos($value, '/')));
|
||||||
$queryParts[] = '`mimepart`';
|
$queryParts[] = '`mimepart`';
|
||||||
$value = $this->getMimetypeId($value);
|
$value = $this->getMimetypeId($value);
|
||||||
|
} elseif ($name === 'storage_mtime') {
|
||||||
|
if (!isset($data['mtime'])) {
|
||||||
|
$params[] = $value;
|
||||||
|
$queryParts[] = '`mtime`';
|
||||||
|
}
|
||||||
}
|
}
|
||||||
$params[] = $value;
|
$params[] = $value;
|
||||||
$queryParts[] = '`' . $name . '`';
|
$queryParts[] = '`' . $name . '`';
|
||||||
|
|
|
@ -51,6 +51,7 @@ class Scanner {
|
||||||
$data['size'] = $this->storage->filesize($path);
|
$data['size'] = $this->storage->filesize($path);
|
||||||
}
|
}
|
||||||
$data['etag'] = $this->storage->getETag($path);
|
$data['etag'] = $this->storage->getETag($path);
|
||||||
|
$data['storage_mtime'] = $data['mtime'];
|
||||||
return $data;
|
return $data;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -179,9 +180,11 @@ class Scanner {
|
||||||
* walk over any folders that are not fully scanned yet and scan them
|
* walk over any folders that are not fully scanned yet and scan them
|
||||||
*/
|
*/
|
||||||
public function backgroundScan() {
|
public function backgroundScan() {
|
||||||
while (($path = $this->cache->getIncomplete()) !== false) {
|
$lastPath = null;
|
||||||
|
while (($path = $this->cache->getIncomplete()) !== false && $path !== $lastPath) {
|
||||||
$this->scan($path);
|
$this->scan($path);
|
||||||
$this->cache->correctFolderSize($path);
|
$this->cache->correctFolderSize($path);
|
||||||
|
$lastPath = $path;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -43,7 +43,7 @@ class Watcher {
|
||||||
*/
|
*/
|
||||||
public function checkUpdate($path) {
|
public function checkUpdate($path) {
|
||||||
$cachedEntry = $this->cache->get($path);
|
$cachedEntry = $this->cache->get($path);
|
||||||
if ($this->storage->hasUpdated($path, $cachedEntry['mtime'])) {
|
if ($this->storage->hasUpdated($path, $cachedEntry['storage_mtime'])) {
|
||||||
if ($this->storage->is_dir($path)) {
|
if ($this->storage->is_dir($path)) {
|
||||||
$this->scanner->scan($path, Scanner::SCAN_SHALLOW);
|
$this->scanner->scan($path, Scanner::SCAN_SHALLOW);
|
||||||
} else {
|
} else {
|
||||||
|
|
|
@ -251,8 +251,11 @@ class View {
|
||||||
if (!$this->file_exists($path)) {
|
if (!$this->file_exists($path)) {
|
||||||
$hooks[] = 'write';
|
$hooks[] = 'write';
|
||||||
}
|
}
|
||||||
|
$result = $this->basicOperation('touch', $path, $hooks, $mtime);
|
||||||
return $this->basicOperation('touch', $path, $hooks, $mtime);
|
if (!$result) { //if native touch fails, we emulate it by changing the mtime in the cache
|
||||||
|
$this->putFileInfo($path, array('mtime' => $mtime));
|
||||||
|
}
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function file_get_contents($path) {
|
public function file_get_contents($path) {
|
||||||
|
|
|
@ -0,0 +1,89 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
|
||||||
|
* This file is licensed under the Affero General Public License version 3 or
|
||||||
|
* later.
|
||||||
|
* See the COPYING-README file.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OC\Hooks;
|
||||||
|
|
||||||
|
abstract class BasicEmitter implements Emitter {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var (callable[])[] $listeners
|
||||||
|
*/
|
||||||
|
private $listeners = array();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $scope
|
||||||
|
* @param string $method
|
||||||
|
* @param callable $callback
|
||||||
|
*/
|
||||||
|
public function listen($scope, $method, $callback) {
|
||||||
|
$eventName = $scope . '::' . $method;
|
||||||
|
if (!isset($this->listeners[$eventName])) {
|
||||||
|
$this->listeners[$eventName] = array();
|
||||||
|
}
|
||||||
|
if (array_search($callback, $this->listeners[$eventName]) === false) {
|
||||||
|
$this->listeners[$eventName][] = $callback;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $scope optional
|
||||||
|
* @param string $method optional
|
||||||
|
* @param callable $callback optional
|
||||||
|
*/
|
||||||
|
public function removeListener($scope = null, $method = null, $callback = null) {
|
||||||
|
$names = array();
|
||||||
|
$allNames = array_keys($this->listeners);
|
||||||
|
if ($scope and $method) {
|
||||||
|
$name = $scope . '::' . $method;
|
||||||
|
if (isset($this->listeners[$name])) {
|
||||||
|
$names[] = $name;
|
||||||
|
}
|
||||||
|
} elseif ($scope) {
|
||||||
|
foreach ($allNames as $name) {
|
||||||
|
$parts = explode('::', $name, 2);
|
||||||
|
if ($parts[0] == $scope) {
|
||||||
|
$names[] = $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} elseif ($method) {
|
||||||
|
foreach ($allNames as $name) {
|
||||||
|
$parts = explode('::', $name, 2);
|
||||||
|
if ($parts[1] == $method) {
|
||||||
|
$names[] = $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$names = $allNames;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($names as $name) {
|
||||||
|
if ($callback) {
|
||||||
|
$index = array_search($callback, $this->listeners[$name]);
|
||||||
|
if ($index !== false) {
|
||||||
|
unset($this->listeners[$name][$index]);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$this->listeners[$name] = array();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $scope
|
||||||
|
* @param string $method
|
||||||
|
* @param array $arguments optional
|
||||||
|
*/
|
||||||
|
protected function emit($scope, $method, $arguments = array()) {
|
||||||
|
$eventName = $scope . '::' . $method;
|
||||||
|
if (isset($this->listeners[$eventName])) {
|
||||||
|
foreach ($this->listeners[$eventName] as $callback) {
|
||||||
|
call_user_func_array($callback, $arguments);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,32 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
|
||||||
|
* This file is licensed under the Affero General Public License version 3 or
|
||||||
|
* later.
|
||||||
|
* See the COPYING-README file.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OC\Hooks;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class Emitter
|
||||||
|
*
|
||||||
|
* interface for all classes that are able to emit events
|
||||||
|
*
|
||||||
|
* @package OC\Hooks
|
||||||
|
*/
|
||||||
|
interface Emitter {
|
||||||
|
/**
|
||||||
|
* @param string $scope
|
||||||
|
* @param string $method
|
||||||
|
* @param callable $callback
|
||||||
|
*/
|
||||||
|
public function listen($scope, $method, $callback);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $scope optional
|
||||||
|
* @param string $method optional
|
||||||
|
* @param callable $callback optional
|
||||||
|
*/
|
||||||
|
public function removeListener($scope = null, $method = null, $callback = null);
|
||||||
|
}
|
|
@ -0,0 +1,16 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
|
||||||
|
* This file is licensed under the Affero General Public License version 3 or
|
||||||
|
* later.
|
||||||
|
* See the COPYING-README file.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OC\Hooks;
|
||||||
|
|
||||||
|
abstract class LegacyEmitter extends BasicEmitter {
|
||||||
|
protected function emit($scope, $method, $arguments = array()) {
|
||||||
|
\OC_Hook::emit($scope, $method, $arguments);
|
||||||
|
parent::emit($scope, $method, $arguments);
|
||||||
|
}
|
||||||
|
}
|
|
@ -77,7 +77,7 @@ class OC_Util {
|
||||||
public static function getVersion() {
|
public static function getVersion() {
|
||||||
// hint: We only can count up. Reset minor/patchlevel when
|
// hint: We only can count up. Reset minor/patchlevel when
|
||||||
// updating major/minor version number.
|
// updating major/minor version number.
|
||||||
return array(5, 80, 02);
|
return array(5, 80, 03);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -211,6 +211,23 @@ class Cache extends \PHPUnit_Framework_TestCase {
|
||||||
$this->assertEquals(array($storageId, 'foo'), \OC\Files\Cache\Cache::getById($id));
|
$this->assertEquals(array($storageId, 'foo'), \OC\Files\Cache\Cache::getById($id));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function testStorageMTime() {
|
||||||
|
$data = array('size' => 1000, 'mtime' => 20, 'mimetype' => 'foo/file');
|
||||||
|
$this->cache->put('foo', $data);
|
||||||
|
$cachedData = $this->cache->get('foo');
|
||||||
|
$this->assertEquals($data['mtime'], $cachedData['storage_mtime']);//if no storage_mtime is saved, mtime should be used
|
||||||
|
|
||||||
|
$this->cache->put('foo', array('storage_mtime' => 30));//when setting storage_mtime, mtime is also set
|
||||||
|
$cachedData = $this->cache->get('foo');
|
||||||
|
$this->assertEquals(30, $cachedData['storage_mtime']);
|
||||||
|
$this->assertEquals(30, $cachedData['mtime']);
|
||||||
|
|
||||||
|
$this->cache->put('foo', array('mtime' => 25));//setting mtime does not change storage_mtime
|
||||||
|
$cachedData = $this->cache->get('foo');
|
||||||
|
$this->assertEquals(30, $cachedData['storage_mtime']);
|
||||||
|
$this->assertEquals(25, $cachedData['mtime']);
|
||||||
|
}
|
||||||
|
|
||||||
function testLongId() {
|
function testLongId() {
|
||||||
$storage = new LongId(array());
|
$storage = new LongId(array());
|
||||||
$cache = $storage->getCache();
|
$cache = $storage->getCache();
|
||||||
|
|
|
@ -35,7 +35,7 @@ class Watcher extends \PHPUnit_Framework_TestCase {
|
||||||
$updater = $storage->getWatcher();
|
$updater = $storage->getWatcher();
|
||||||
|
|
||||||
//set the mtime to the past so it can detect an mtime change
|
//set the mtime to the past so it can detect an mtime change
|
||||||
$cache->put('', array('mtime' => 10));
|
$cache->put('', array('storage_mtime' => 10));
|
||||||
|
|
||||||
$this->assertTrue($cache->inCache('folder/bar.txt'));
|
$this->assertTrue($cache->inCache('folder/bar.txt'));
|
||||||
$this->assertTrue($cache->inCache('folder/bar2.txt'));
|
$this->assertTrue($cache->inCache('folder/bar2.txt'));
|
||||||
|
@ -47,14 +47,14 @@ class Watcher extends \PHPUnit_Framework_TestCase {
|
||||||
$cachedData = $cache->get('bar.test');
|
$cachedData = $cache->get('bar.test');
|
||||||
$this->assertEquals(3, $cachedData['size']);
|
$this->assertEquals(3, $cachedData['size']);
|
||||||
|
|
||||||
$cache->put('bar.test', array('mtime' => 10));
|
$cache->put('bar.test', array('storage_mtime' => 10));
|
||||||
$storage->file_put_contents('bar.test', 'test data');
|
$storage->file_put_contents('bar.test', 'test data');
|
||||||
|
|
||||||
$updater->checkUpdate('bar.test');
|
$updater->checkUpdate('bar.test');
|
||||||
$cachedData = $cache->get('bar.test');
|
$cachedData = $cache->get('bar.test');
|
||||||
$this->assertEquals(9, $cachedData['size']);
|
$this->assertEquals(9, $cachedData['size']);
|
||||||
|
|
||||||
$cache->put('folder', array('mtime' => 10));
|
$cache->put('folder', array('storage_mtime' => 10));
|
||||||
|
|
||||||
$storage->unlink('folder/bar2.txt');
|
$storage->unlink('folder/bar2.txt');
|
||||||
$updater->checkUpdate('folder');
|
$updater->checkUpdate('folder');
|
||||||
|
@ -69,7 +69,7 @@ class Watcher extends \PHPUnit_Framework_TestCase {
|
||||||
$updater = $storage->getWatcher();
|
$updater = $storage->getWatcher();
|
||||||
|
|
||||||
//set the mtime to the past so it can detect an mtime change
|
//set the mtime to the past so it can detect an mtime change
|
||||||
$cache->put('', array('mtime' => 10));
|
$cache->put('', array('storage_mtime' => 10));
|
||||||
|
|
||||||
$storage->unlink('foo.txt');
|
$storage->unlink('foo.txt');
|
||||||
$storage->rename('folder', 'foo.txt');
|
$storage->rename('folder', 'foo.txt');
|
||||||
|
@ -85,7 +85,7 @@ class Watcher extends \PHPUnit_Framework_TestCase {
|
||||||
$updater = $storage->getWatcher();
|
$updater = $storage->getWatcher();
|
||||||
|
|
||||||
//set the mtime to the past so it can detect an mtime change
|
//set the mtime to the past so it can detect an mtime change
|
||||||
$cache->put('foo.txt', array('mtime' => 10));
|
$cache->put('foo.txt', array('storage_mtime' => 10));
|
||||||
|
|
||||||
$storage->unlink('foo.txt');
|
$storage->unlink('foo.txt');
|
||||||
$storage->rename('folder', 'foo.txt');
|
$storage->rename('folder', 'foo.txt');
|
||||||
|
|
|
@ -7,6 +7,12 @@
|
||||||
|
|
||||||
namespace Test\Files;
|
namespace Test\Files;
|
||||||
|
|
||||||
|
class TemporaryNoTouch extends \OC\Files\Storage\Temporary {
|
||||||
|
public function touch($path, $mtime = null) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
class View extends \PHPUnit_Framework_TestCase {
|
class View extends \PHPUnit_Framework_TestCase {
|
||||||
/**
|
/**
|
||||||
* @var \OC\Files\Storage\Storage[] $storages;
|
* @var \OC\Files\Storage\Storage[] $storages;
|
||||||
|
@ -220,7 +226,7 @@ class View extends \PHPUnit_Framework_TestCase {
|
||||||
$cachedData = $rootView->getFileInfo('foo.txt');
|
$cachedData = $rootView->getFileInfo('foo.txt');
|
||||||
$this->assertEquals(16, $cachedData['size']);
|
$this->assertEquals(16, $cachedData['size']);
|
||||||
|
|
||||||
$rootView->putFileInfo('foo.txt', array('mtime' => 10));
|
$rootView->putFileInfo('foo.txt', array('storage_mtime' => 10));
|
||||||
$storage1->file_put_contents('foo.txt', 'foo');
|
$storage1->file_put_contents('foo.txt', 'foo');
|
||||||
clearstatcache();
|
clearstatcache();
|
||||||
|
|
||||||
|
@ -228,12 +234,36 @@ class View extends \PHPUnit_Framework_TestCase {
|
||||||
$this->assertEquals(3, $cachedData['size']);
|
$this->assertEquals(3, $cachedData['size']);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function testTouch() {
|
||||||
|
$storage = $this->getTestStorage(true, '\Test\Files\TemporaryNoTouch');
|
||||||
|
|
||||||
|
\OC\Files\Filesystem::mount($storage, array(), '/');
|
||||||
|
|
||||||
|
$rootView = new \OC\Files\View('');
|
||||||
|
$oldCachedData = $rootView->getFileInfo('foo.txt');
|
||||||
|
|
||||||
|
$rootView->touch('foo.txt', 500);
|
||||||
|
|
||||||
|
$cachedData = $rootView->getFileInfo('foo.txt');
|
||||||
|
$this->assertEquals(500, $cachedData['mtime']);
|
||||||
|
$this->assertEquals($oldCachedData['storage_mtime'], $cachedData['storage_mtime']);
|
||||||
|
|
||||||
|
$rootView->putFileInfo('foo.txt', array('storage_mtime' => 1000)); //make sure the watcher detects the change
|
||||||
|
$rootView->file_put_contents('foo.txt', 'asd');
|
||||||
|
$cachedData = $rootView->getFileInfo('foo.txt');
|
||||||
|
$this->assertGreaterThanOrEqual($cachedData['mtime'], $oldCachedData['mtime']);
|
||||||
|
$this->assertEquals($cachedData['storage_mtime'], $cachedData['mtime']);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param bool $scan
|
* @param bool $scan
|
||||||
* @return \OC\Files\Storage\Storage
|
* @return \OC\Files\Storage\Storage
|
||||||
*/
|
*/
|
||||||
private function getTestStorage($scan = true) {
|
private function getTestStorage($scan = true, $class = '\OC\Files\Storage\Temporary') {
|
||||||
$storage = new \OC\Files\Storage\Temporary(array());
|
/**
|
||||||
|
* @var \OC\Files\Storage\Storage $storage
|
||||||
|
*/
|
||||||
|
$storage = new $class(array());
|
||||||
$textData = "dummy file data\n";
|
$textData = "dummy file data\n";
|
||||||
$imgData = file_get_contents(\OC::$SERVERROOT . '/core/img/logo.png');
|
$imgData = file_get_contents(\OC::$SERVERROOT . '/core/img/logo.png');
|
||||||
$storage->mkdir('folder');
|
$storage->mkdir('folder');
|
||||||
|
|
|
@ -0,0 +1,261 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
|
||||||
|
* This file is licensed under the Affero General Public License version 3 or
|
||||||
|
* later.
|
||||||
|
* See the COPYING-README file.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Test\Hooks;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class DummyEmitter
|
||||||
|
*
|
||||||
|
* class to make BasicEmitter::emit publicly available
|
||||||
|
*
|
||||||
|
* @package Test\Hooks
|
||||||
|
*/
|
||||||
|
class DummyEmitter extends \OC\Hooks\BasicEmitter {
|
||||||
|
public function emitEvent($scope, $method, $arguments = array()) {
|
||||||
|
$this->emit($scope, $method, $arguments);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class EmittedException
|
||||||
|
*
|
||||||
|
* a dummy exception so we can check if an event is emitted
|
||||||
|
*
|
||||||
|
* @package Test\Hooks
|
||||||
|
*/
|
||||||
|
class EmittedException extends \Exception {
|
||||||
|
}
|
||||||
|
|
||||||
|
class BasicEmitter extends \PHPUnit_Framework_TestCase {
|
||||||
|
/**
|
||||||
|
* @var \OC\Hooks\Emitter $emitter
|
||||||
|
*/
|
||||||
|
protected $emitter;
|
||||||
|
|
||||||
|
public function setUp() {
|
||||||
|
$this->emitter = new DummyEmitter();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nonStaticCallBack() {
|
||||||
|
throw new EmittedException;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function staticCallBack() {
|
||||||
|
throw new EmittedException;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testAnonymousFunction() {
|
||||||
|
$this->emitter->listen('Test', 'test', function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
});
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testStaticCallback() {
|
||||||
|
$this->emitter->listen('Test', 'test', array('\Test\Hooks\BasicEmitter', 'staticCallBack'));
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testNonStaticCallback() {
|
||||||
|
$this->emitter->listen('Test', 'test', array($this, 'nonStaticCallBack'));
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testOnlyCallOnce() {
|
||||||
|
$count = 0;
|
||||||
|
$listener = function () use (&$count) {
|
||||||
|
$count++;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->assertEquals(1, $count, 'Listener called an invalid number of times (' . $count . ') expected 1');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDifferentMethods() {
|
||||||
|
$count = 0;
|
||||||
|
$listener = function () use (&$count) {
|
||||||
|
$count++;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Test', 'foo', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->emitter->emitEvent('Test', 'foo');
|
||||||
|
$this->assertEquals(2, $count, 'Listener called an invalid number of times (' . $count . ') expected 2');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDifferentScopes() {
|
||||||
|
$count = 0;
|
||||||
|
$listener = function () use (&$count) {
|
||||||
|
$count++;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Bar', 'test', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->emitter->emitEvent('Bar', 'test');
|
||||||
|
$this->assertEquals(2, $count, 'Listener called an invalid number of times (' . $count . ') expected 2');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDifferentCallbacks() {
|
||||||
|
$count = 0;
|
||||||
|
$listener1 = function () use (&$count) {
|
||||||
|
$count++;
|
||||||
|
};
|
||||||
|
$listener2 = function () use (&$count) {
|
||||||
|
$count++;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener1);
|
||||||
|
$this->emitter->listen('Test', 'test', $listener2);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->assertEquals(2, $count, 'Listener called an invalid number of times (' . $count . ') expected 2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testArguments() {
|
||||||
|
$this->emitter->listen('Test', 'test', function ($foo, $bar) {
|
||||||
|
if ($foo == 'foo' and $bar == 'bar') {
|
||||||
|
throw new EmittedException;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
$this->emitter->emitEvent('Test', 'test', array('foo', 'bar'));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testNamedArguments() {
|
||||||
|
$this->emitter->listen('Test', 'test', function ($foo, $bar) {
|
||||||
|
if ($foo == 'foo' and $bar == 'bar') {
|
||||||
|
throw new EmittedException;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
$this->emitter->emitEvent('Test', 'test', array('foo' => 'foo', 'bar' => 'bar'));
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRemoveAllSpecified() {
|
||||||
|
$listener = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->removeListener('Test', 'test', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRemoveWildcardListener() {
|
||||||
|
$listener1 = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$listener2 = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener1);
|
||||||
|
$this->emitter->listen('Test', 'test', $listener2);
|
||||||
|
$this->emitter->removeListener('Test', 'test');
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRemoveWildcardMethod() {
|
||||||
|
$listener = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Test', 'foo', $listener);
|
||||||
|
$this->emitter->removeListener('Test', null, $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->emitter->emitEvent('Test', 'foo');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRemoveWildcardScope() {
|
||||||
|
$listener = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Bar', 'test', $listener);
|
||||||
|
$this->emitter->removeListener(null, 'test', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->emitter->emitEvent('Bar', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRemoveWildcardScopeAndMethod() {
|
||||||
|
$listener = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Test', 'foo', $listener);
|
||||||
|
$this->emitter->listen('Bar', 'foo', $listener);
|
||||||
|
$this->emitter->removeListener(null, null, $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->emitter->emitEvent('Test', 'foo');
|
||||||
|
$this->emitter->emitEvent('Bar', 'foo');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testRemoveKeepOtherCallback() {
|
||||||
|
$listener1 = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$listener2 = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener1);
|
||||||
|
$this->emitter->listen('Test', 'test', $listener2);
|
||||||
|
$this->emitter->removeListener('Test', 'test', $listener1);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testRemoveKeepOtherMethod() {
|
||||||
|
$listener = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Test', 'foo', $listener);
|
||||||
|
$this->emitter->removeListener('Test', 'foo', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testRemoveKeepOtherScope() {
|
||||||
|
$listener = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->listen('Bar', 'test', $listener);
|
||||||
|
$this->emitter->removeListener('Bar', 'test', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \Test\Hooks\EmittedException
|
||||||
|
*/
|
||||||
|
public function testRemoveNonExistingName() {
|
||||||
|
$listener = function () {
|
||||||
|
throw new EmittedException;
|
||||||
|
};
|
||||||
|
$this->emitter->listen('Test', 'test', $listener);
|
||||||
|
$this->emitter->removeListener('Bar', 'test', $listener);
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,55 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
|
||||||
|
* This file is licensed under the Affero General Public License version 3 or
|
||||||
|
* later.
|
||||||
|
* See the COPYING-README file.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Test\Hooks;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class DummyLegacyEmitter
|
||||||
|
*
|
||||||
|
* class to make LegacyEmitter::emit publicly available
|
||||||
|
*
|
||||||
|
* @package Test\Hooks
|
||||||
|
*/
|
||||||
|
class DummyLegacyEmitter extends \OC\Hooks\LegacyEmitter {
|
||||||
|
public function emitEvent($scope, $method, $arguments = array()) {
|
||||||
|
$this->emit($scope, $method, $arguments);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class LegacyEmitter extends BasicEmitter {
|
||||||
|
|
||||||
|
//we can't use exceptions here since OC_Hooks catches all exceptions
|
||||||
|
private static $emitted = false;
|
||||||
|
|
||||||
|
public function setUp() {
|
||||||
|
$this->emitter = new DummyLegacyEmitter();
|
||||||
|
self::$emitted = false;
|
||||||
|
\OC_Hook::clear('Test','test');
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function staticLegacyCallBack() {
|
||||||
|
self::$emitted = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function staticLegacyArgumentsCallBack($arguments) {
|
||||||
|
if ($arguments['foo'] == 'foo' and $arguments['bar'] == 'bar')
|
||||||
|
self::$emitted = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testLegacyHook() {
|
||||||
|
\OC_Hook::connect('Test', 'test', '\Test\Hooks\LegacyEmitter', 'staticLegacyCallBack');
|
||||||
|
$this->emitter->emitEvent('Test', 'test');
|
||||||
|
$this->assertEquals(true, self::$emitted);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testLegacyArguments() {
|
||||||
|
\OC_Hook::connect('Test', 'test', '\Test\Hooks\LegacyEmitter', 'staticLegacyArgumentsCallBack');
|
||||||
|
$this->emitter->emitEvent('Test', 'test', array('foo' => 'foo', 'bar' => 'bar'));
|
||||||
|
$this->assertEquals(true, self::$emitted);
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue