Page MenuHomePhorge
Files F2522322

No OneTemporary
Actions

Size
12 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/lib/Kolab/DAV/Locks/Chwala.php b/lib/Kolab/DAV/Locks/Chwala.php
new file mode 100644
index 0000000..f5eb8d8
--- /dev/null
+++ b/lib/Kolab/DAV/Locks/Chwala.php
@@ -0,0 +1,196 @@
+<?php
+
+/**
+ * Chwala-based lock manager for the Kolab WebDAV service.
+ *
+ * @author Aleksander Machniak <machniak@kolabsys.com>
+ *
+ * Copyright (C) 2013, Kolab Systems AG <contact@kolabsys.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Kolab\DAV\Locks;
+
+use \file_storage;
+use \Kolab\DAV\Backend;
+use Sabre\DAV\Server;
+use Sabre\DAV\Locks\LockInfo;
+use Sabre\DAV\Locks\Backend\AbstractBackend;
+use \Exception;
+
+/**
+ * The Lock manager that maintains a lock file per user in the local file system.
+ */
+class Chwala extends AbstractBackend
+{
+ /**
+ * The base Path
+ *
+ * @var string
+ */
+ protected $basePath;
+
+ /**
+ * The file API backend class
+ *
+ * @var file_api_storage
+ */
+ protected $backend;
+
+
+ /**
+ * Constructor
+ *
+ * @param string $path Base path
+ */
+ public function __construct($path = null)
+ {
+ $this->backend = Backend::get_instance()->get_backend();
+ $this->basePath = $path;
+ }
+
+ /**
+ * Returns a list of Sabre\DAV\Locks\LockInfo objects
+ *
+ * This method should return all the locks for a particular uri, including
+ * locks that might be set on a parent uri.
+ *
+ * If returnChildLocks is set to true, this method should also look for
+ * any locks in the subtree of the uri for locks.
+ *
+ * @param string $uri
+ * @param bool $returnChildLocks
+ * @return array
+ */
+ public function getLocks($uri, $returnChildLocks)
+ {
+ console(__METHOD__, $uri, $returnChildLocks);
+
+ $path = $this->uri2path($uri);
+
+ if (!strlen($path)) {
+ return array();
+ }
+
+ // @TODO: when using Dolphin I've found that this method
+ // is called for every file in a folder, this might become
+ // a performance issue.
+
+ $list = $this->backend->lock_list($path, $returnChildLocks);
+ $list = array_map(array($this, 'to_lockinfo'), (array) $list);
+
+ return $list;
+ }
+
+ /**
+ * Locks a uri
+ *
+ * @param string $uri
+ * @param LockInfo $lockInfo
+ * @return bool
+ */
+ public function lock($uri, LockInfo $lockInfo)
+ {
+ console(__METHOD__, $uri, $lockInfo);
+
+ try {
+ $this->backend->lock($this->uri2path($uri), $this->from_lockinfo($lockInfo));
+ }
+ catch (Exception $e) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Removes a lock from a uri
+ *
+ * @param string $uri
+ * @param LockInfo $lockInfo
+ * @return bool
+ */
+ public function unlock($uri, LockInfo $lockInfo)
+ {
+ console(__METHOD__, $uri, $lockInfo);
+
+ try {
+ $this->backend->unlock($this->uri2path($uri), $this->from_lockinfo($lockInfo));
+ }
+ catch (Exception $e) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Converts URI according to root directory
+ */
+ protected function uri2path($uri)
+ {
+ if ($this->basePath) {
+ if (strpos($uri, $this->basePath . '/') === 0) {
+ $uri = substr($uri, strlen($this->basePath) + 1);
+ }
+ }
+
+ return $uri;
+ }
+
+ /**
+ * Converts URI according to root directory
+ */
+ protected function path2uri($path)
+ {
+ if ($this->basePath) {
+ $path = $this->basePath . '/' . $path;
+ }
+
+ return $path;
+ }
+
+ /**
+ * Convert LockInfo object into Chwala's lock data array
+ */
+ public function from_lockinfo(LockInfo $lockInfo)
+ {
+ $lock = (array) $lockInfo;
+
+ // map to Chwala scope/depth values
+ $lock['scope'] = $lock['scope'] == LockInfo::SHARED ? file_storage::LOCK_SHARED : file_storage::LOCK_EXCLUSIVE;
+ $lock['depth'] = $lock['depth'] == Server::DEPTH_INFINITY ? file_storage::LOCK_INFINITE : $record['depth'];
+
+ return $lock;
+ }
+
+ /**
+ * Convert Chwala's lock data array into SabreDav LockInfo object
+ */
+ public function to_lockinfo(array $lock)
+ {
+ $lockInfo = new LockInfo;
+
+ $lockInfo->uri = $this->path2uri($lock['uri']);
+ $lockInfo->owner = $lock['owner'];
+ $lockInfo->scope = $lock['scope'] == file_storage::LOCK_SHARED ? LockInfo::SHARED : LockInfo::EXCLUSIVE;
+ $lockInfo->depth = $lock['depth'] == file_storage::LOCK_INFINITE ? Server::DEPTH_INFINITY : $lock['depth'];
+ $lockInfo->token = $lock['token'];
+ $lockInfo->timeout = $lock['timeout'];
+ $lockInfo->created = $lock['created'];
+
+ return $lockInfo;
+ }
+}
diff --git a/public_html/index.php b/public_html/index.php
index 55920fe..1059462 100644
--- a/public_html/index.php
+++ b/public_html/index.php
@@ -1,184 +1,183 @@
<?php
/**
* iRony, the Kolab WebDAV/CalDAV/CardDAV Server
*
* This is the public API to provide *DAV-based access to the Kolab Groupware backend
*
* @version 0.3-dev
* @author Thomas Bruederli <bruederli@kolabsys.com>
*
* Copyright (C) 2013, Kolab Systems AG <contact@kolabsys.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// define some environment variables used throughout the app and libraries
define('KOLAB_DAV_ROOT', realpath('../'));
define('KOLAB_DAV_VERSION', '0.3-dev');
define('KOLAB_DAV_START', microtime(true));
define('RCUBE_INSTALL_PATH', KOLAB_DAV_ROOT . '/');
define('RCUBE_CONFIG_DIR', KOLAB_DAV_ROOT . '/config/');
define('RCUBE_PLUGINS_DIR', KOLAB_DAV_ROOT . '/lib/plugins/');
// suppress error notices
ini_set('error_reporting', E_ALL &~ E_NOTICE &~ E_STRICT);
/**
* Mapping PHP errors to exceptions.
*
* While this is not strictly needed, it makes a lot of sense to do so. If an
* E_NOTICE or anything appears in your code, this allows SabreDAV to intercept
* the issue and send a proper response back to the client (HTTP/1.1 500).
*/
function exception_error_handler($errno, $errstr, $errfile, $errline ) {
throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
}
//set_error_handler("exception_error_handler");
// use composer's autoloader for dependencies
$loader = require_once(KOLAB_DAV_ROOT . '/vendor/autoload.php');
$loader->setUseIncludePath(true); // enable include_path to load PEAR classes from their default location
// load the Roundcube framework with its autoloader
require_once KOLAB_DAV_ROOT . '/lib/Roundcube/bootstrap.php';
// Roundcube framework initialization
$rcube = rcube::get_instance(rcube::INIT_WITH_DB | rcube::INIT_WITH_PLUGINS);
$rcube->config->load_from_file(RCUBE_CONFIG_DIR . 'dav.inc.php');
// Load plugins
$plugins = (array)$rcube->config->get('kolabdav_plugins', array('kolab_auth'));
$required = array('libkolab', 'libcalendaring');
$rcube->plugins->init($rcube);
$rcube->plugins->load_plugins($plugins, $required);
// enable logger
if ($rcube->config->get('kolabdav_console') || $rcube->config->get('kolabdav_user_debug')) {
$logger = new \Kolab\Utils\DAVLogger((\Kolab\Utils\DAVLogger::CONSOLE | $rcube->config->get('kolabdav_http_log', 0)));
}
// convenience function, you know it well :-)
function console()
{
global $logger;
if ($logger) {
call_user_func_array(array($logger, 'console'), func_get_args());
}
}
// Make sure this setting is turned on and reflects the root url of the *DAV server.
$base_uri = $rcube->config->get('base_uri', slashify(substr(dirname($_SERVER['SCRIPT_FILENAME']), strlen($_SERVER['DOCUMENT_ROOT']))));
// add filename to base URI when called without mod_rewrite (e.g. /dav/index.php/calendar)
if (strpos($_SERVER['REQUEST_URI'], 'index.php'))
$base_uri .= 'index.php/';
// create the various backend instances
$auth_backend = new \Kolab\DAV\Auth\HTTPBasic();
$principal_backend = new \Kolab\DAVACL\PrincipalBackend();
$services = array();
foreach (array('CALDAV','CARDDAV','WEBDAV') as $skey) {
if (getenv($skey))
$services[$skey] = 1;
}
// no config means *all* services
if (empty($services))
$services = array('CALDAV' => 1, 'CARDDAV' => 1, 'WEBDAV' => 1);
// add chwala directories to include path for autoloading
if ($services['WEBDAV']) {
$include_path = ini_get('include_path') . PATH_SEPARATOR;
$include_path .= KOLAB_DAV_ROOT . '/lib/FileAPI' . PATH_SEPARATOR;
$include_path .= KOLAB_DAV_ROOT . '/lib/FileAPI/kolab' . PATH_SEPARATOR;
$include_path .= KOLAB_DAV_ROOT . '/lib/FileAPI/ext';
set_include_path($include_path);
}
// Build the directory tree
// This is an array which contains the 'top-level' directories in the WebDAV server.
if ($services['CALDAV'] || $services['CARDDAV']) {
$nodes = array(
new \Sabre\CalDAV\Principal\Collection($principal_backend),
);
if ($services['CALDAV']) {
$caldav_backend = new \Kolab\CalDAV\CalendarBackend();
$caldav_backend->setUserAgent($_SERVER['HTTP_USER_AGENT']);
$nodes[] = new \Kolab\CalDAV\CalendarRootNode($principal_backend, $caldav_backend);
}
if ($services['CARDDAV']) {
$carddav_backend = new \Kolab\CardDAV\ContactsBackend();
$carddav_backend->setUserAgent($_SERVER['HTTP_USER_AGENT']);
$nodes[] = new \Kolab\CardDAV\AddressBookRoot($principal_backend, $carddav_backend);
}
if ($services['WEBDAV']) {
$nodes[] = new \Kolab\DAV\Collection(\Kolab\DAV\Collection::ROOT_DIRECTORY);
}
}
// register WebDAV service as root
else if ($services['WEBDAV']) {
$nodes = new \Kolab\DAV\Collection('');
}
// the object tree needs in turn to be passed to the server class
$server = new \Sabre\DAV\Server($nodes);
$server->setBaseUri($base_uri);
// connect logger
if (is_object($logger)) {
$server->addPlugin($logger);
}
// register some plugins
$server->addPlugin(new \Sabre\DAV\Auth\Plugin($auth_backend, 'KolabDAV'));
$server->addPlugin(new \Sabre\DAVACL\Plugin());
if ($services['CALDAV']) {
$caldav_plugin = new \Kolab\CalDAV\Plugin();
$caldav_plugin->setIMipHandler(new \Kolab\CalDAV\IMip());
$server->addPlugin($caldav_plugin);
}
if ($services['CARDDAV']) {
$server->addPlugin(new \Kolab\CardDAV\Plugin());
}
if ($services['WEBDAV']) {
- // the lock manager is reponsible for making sure users don't overwrite each others changes.
- // TODO: replace this with a class that manages locks in the Kolab backend
- $locks_backend = new \Kolab\DAV\Locks\File(KOLAB_DAV_ROOT . '/temp');
+ // the lock manager is responsible for making sure users don't overwrite each others changes.
+ $locks_backend = new \Kolab\DAV\Locks\Chwala(\Kolab\DAV\Collection::ROOT_DIRECTORY);
$server->addPlugin(new \Sabre\DAV\Locks\Plugin($locks_backend));
// intercept some of the garbage files operation systems tend to generate when mounting a WebDAV share
$server->addPlugin(new \Kolab\DAV\TempFilesPlugin(KOLAB_DAV_ROOT . '/temp'));
}
// HTML UI for browser-based access (recommended only for development)
if (getenv('DAVBROWSER')) {
$server->addPlugin(new \Sabre\DAV\Browser\Plugin());
}
// finally, process the request
$server->exec();
// trigger log
$server->broadcastEvent('exit', array());

File Metadata

Mime Type
text/x-diff
Expires
Sat, Jan 10, 8:57 AM (14 h, 9 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
421915
Default Alt Text
(12 KB)

Event Timeline