No OneTemporary
Actions

Size

24 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/plugins/kolab_zpush/kolab_zpush.php b/plugins/kolab_zpush/kolab_zpush.php
	index 4ef242cf..b65f39ca 100644
	--- a/plugins/kolab_zpush/kolab_zpush.php
	+++ b/plugins/kolab_zpush/kolab_zpush.php
	@@ -1,346 +1,349 @@
	<?php

	/**
	* Z-Push configuration utility for Kolab accounts
	*
	* @version 0.2
	* @author Thomas Bruederli <bruederli@kolabsys.com>
	*
	* Copyright (C) 2012, 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/>.
	*/

	class kolab_zpush extends rcube_plugin
	{
	public $task = 'settings';
	public $urlbase;
	-
	+
	private $rc;
	private $ui;
	private $cache;
	private $devices;
	private $folders;
	private $folders_meta;
	private $root_meta;
	-
	+
	const ROOT_MAILBOX = 'INBOX';
	const CTYPE_KEY = '/shared/vendor/kolab/folder-type';
	const ACTIVESYNC_KEY = '/private/vendor/kolab/activesync';

	/**
	* Plugin initialization.
	*/
	public function init()
	{
	$this->rc = rcmail::get_instance();
	-
	+
	$this->require_plugin('jqueryui');
	$this->add_texts('localization/', true);
	-
	+
	$this->include_script('kolab_zpush.js');
	-
	+
	$this->register_action('plugin.zpushconfig', array($this, 'config_view'));
	$this->register_action('plugin.zpushjson', array($this, 'json_command'));
	-
	- if ($this->rc->action == 'plugin.zpushconfig')
	- $this->require_plugin('kolab_core');
	+
	+ if ($this->rc->action == 'plugin.zpushconfig') {
	+ $this->require_plugin('libkolab');
	+ }
	}


	/**
	* Establish IMAP connection
	*/
	public function init_imap()
	{
	$storage = $this->rc->get_storage();

	+ // @TODO: Metadata is already cached by rcube storage, get rid of cache here
	+
	$this->cache = $this->rc->get_cache('zpush', 'db', 900);
	$this->cache->expunge();

	if ($meta = $storage->get_metadata(self::ROOT_MAILBOX, self::ACTIVESYNC_KEY)) {
	// clear cache if device config changed
	if (($oldmeta = $this->cache->read('devicemeta')) && $oldmeta != $meta)
	$this->cache->remove();

	$this->root_meta = $this->unserialize_metadata($meta[self::ROOT_MAILBOX][self::ACTIVESYNC_KEY]);
	$this->cache->remove('devicemeta');
	$this->cache->write('devicemeta', $meta);
	}
	}


	/**
	* Handle JSON requests
	*/
	public function json_command()
	{
	$storage = $this->rc->get_storage();
	$cmd = get_input_value('cmd', RCUBE_INPUT_GPC);
	$imei = get_input_value('id', RCUBE_INPUT_GPC);

	switch ($cmd) {
	case 'load':
	$result = array();
	$devices = $this->list_devices();
	if ($device = $devices[$imei]) {
	$result['id'] = $imei;
	$result['devicealias'] = $device['ALIAS'];
	$result['syncmode'] = intval($device['MODE']);
	$result['laxpic'] = intval($device['LAXPIC']);
	$result['subscribed'] = array();

	foreach ($this->folders_meta() as $folder => $meta) {
	if ($meta[$imei]['S'])
	$result['subscribed'][$folder] = intval($meta[$imei]['S']);
	}

	$this->rc->output->command('plugin.zpush_data_ready', $result);
	}
	else {
	$this->rc->output->show_message($this->gettext('devicenotfound'), 'error');
	}
	break;

	case 'save':
	$devices = $this->list_devices();
	$syncmode = intval(get_input_value('syncmode', RCUBE_INPUT_POST));
	$devicealias = get_input_value('devicealias', RCUBE_INPUT_POST, true);
	$laxpic = intval(get_input_value('laxpic', RCUBE_INPUT_POST));
	$subsciptions = get_input_value('subscribed', RCUBE_INPUT_POST);
	$err = false;
	-
	+
	if ($device = $devices[$imei]) {
	// update device config if changed
	if ($devicealias != $this->root_meta['DEVICE'][$imei]['ALIAS'] \|\|
	$syncmode != $this->root_meta['DEVICE'][$imei]['MODE'] \|\|
	$laxpic != $this->root_meta['DEVICE'][$imei]['LAXPIC'] \|\|
	$subsciptions[self::ROOT_MAILBOX] != $this->root_meta['FOLDER'][$imei]['S']) {
	$this->root_meta['DEVICE'][$imei]['MODE'] = $syncmode;
	$this->root_meta['DEVICE'][$imei]['ALIAS'] = $devicealias;
	$this->root_meta['DEVICE'][$imei]['LAXPIC'] = $laxpic;
	$this->root_meta['FOLDER'][$imei]['S'] = intval($subsciptions[self::ROOT_MAILBOX]);

	$err = !$storage->set_metadata(self::ROOT_MAILBOX,
	array(self::ACTIVESYNC_KEY => $this->serialize_metadata($this->root_meta)));

	// update cached meta data
	if (!$err) {
	$this->cache->remove('devicemeta');
	$this->cache->write('devicemeta', $storage->get_metadata(self::ROOT_MAILBOX, self::ACTIVESYNC_KEY));
	}
	}
	// iterate over folders list and update metadata if necessary
	foreach ($this->folders_meta() as $folder => $meta) {
	// skip root folder (already handled above)
	if ($folder == self::ROOT_MAILBOX)
	continue;
	-
	+
	if ($subsciptions[$folder] != $meta[$imei]['S']) {
	$meta[$imei]['S'] = intval($subsciptions[$folder]);
	$this->folders_meta[$folder] = $meta;
	unset($meta['TYPE']);
	-
	+
	// read metadata first
	$folderdata = $storage->get_metadata($folder, array(self::ACTIVESYNC_KEY));
	if ($asyncdata = $folderdata[$folder][self::ACTIVESYNC_KEY])
	$metadata = $this->unserialize_metadata($asyncdata);
	$metadata['FOLDER'] = $meta;

	$err \|= !$storage->set_metadata($folder, array(self::ACTIVESYNC_KEY => $this->serialize_metadata($metadata)));
	}
	}
	-
	+
	// update cache
	$this->cache->remove('folders');
	$this->cache->write('folders', $this->folders_meta);
	-
	+
	$this->rc->output->command('plugin.zpush_save_complete', array('success' => !$err, 'id' => $imei, 'devicealias' => Q($devicealias)));
	}
	-
	+
	if ($err)
	$this->rc->output->show_message($this->gettext('savingerror'), 'error');
	else
	$this->rc->output->show_message($this->gettext('successfullysaved'), 'confirmation');
	-
	+
	break;

	case 'delete':
	$devices = $this->list_devices();
	-
	+
	if ($device = $devices[$imei]) {
	unset($this->root_meta['DEVICE'][$imei], $this->root_meta['FOLDER'][$imei]);

	// update annotation and cached meta data
	if ($success = $storage->set_metadata(self::ROOT_MAILBOX, array(self::ACTIVESYNC_KEY => $this->serialize_metadata($this->root_meta)))) {
	$this->cache->remove('devicemeta');
	$this->cache->write('devicemeta', $storage->get_metadata(self::ROOT_MAILBOX, self::ACTIVESYNC_KEY));

	// remove device annotation in every folder
	foreach ($this->folders_meta() as $folder => $meta) {
	// skip root folder (already handled above)
	if ($folder == self::ROOT_MAILBOX)
	continue;

	if (isset($meta[$imei])) {
	$type = $meta['TYPE']; // remember folder type
	unset($meta[$imei], $meta['TYPE']);

	// read metadata first and update FOLDER property
	$folderdata = $storage->get_metadata($folder, array(self::ACTIVESYNC_KEY));
	if ($asyncdata = $folderdata[$folder][self::ACTIVESYNC_KEY])
	$metadata = $this->unserialize_metadata($asyncdata);
	$metadata['FOLDER'] = $meta;

	if ($storage->set_metadata($folder, array(self::ACTIVESYNC_KEY => $this->serialize_metadata($metadata)))) {
	$this->folders_meta[$folder] = $metadata;
	$this->folders_meta[$folder]['TYPE'] = $type;
	}
	}
	}

	// update cache
	$this->cache->remove('folders');
	$this->cache->write('folders', $this->folders_meta);
	}
	}

	if ($success) {
	$this->rc->output->show_message($this->gettext('successfullydeleted'), 'confirmation');
	$this->rc->output->redirect(array('action' => 'plugin.zpushconfig')); // reload UI
	}
	else
	$this->rc->output->show_message($this->gettext('savingerror'), 'error');

	break;
	}

	$this->rc->output->send();
	}


	/**
	* Render main UI for device configuration
	*/
	public function config_view()
	{
	require_once $this->home . '/kolab_zpush_ui.php';
	-
	+
	$storage = $this->rc->get_storage();
	-
	+
	// checks if IMAP server supports any of METADATA, ANNOTATEMORE, ANNOTATEMORE2
	if (!($storage->get_capability('METADATA') \|\| $storage->get_capability('ANNOTATEMORE') \|\| $storage->get_capability('ANNOTATEMORE2'))) {
	$this->rc->output->show_message($this->gettext('notsupported'), 'error');
	}
	-
	+
	$this->ui = new kolab_zpush_ui($this);
	-
	+
	$this->register_handler('plugin.devicelist', array($this->ui, 'device_list'));
	$this->register_handler('plugin.deviceconfigform', array($this->ui, 'device_config_form'));
	$this->register_handler('plugin.foldersubscriptions', array($this->ui, 'folder_subscriptions'));
	-
	+
	$this->rc->output->set_env('devicecount', count($this->list_devices()));
	$this->rc->output->send('kolab_zpush.config');
	}


	/**
	* List known devices
	*
	* @return array Device list as hash array
	*/
	public function list_devices()
	{
	if (!isset($this->devices)) {
	$this->init_imap();
	$this->devices = (array)$this->root_meta['DEVICE'];
	}
	-
	+
	return $this->devices;
	}


	/**
	* Get list of all folders available for sync
	*
	* @return array List of mailbox folders
	*/
	public function list_folders()
	{
	if (!isset($this->folders)) {
	// read cached folder meta data
	if ($cached_folders = $this->cache->read('folders')) {
	$this->folders_meta = $cached_folders;
	$this->folders = array_keys($this->folders_meta);
	}
	// fetch folder data from server
	else {
	$storage = $this->rc->get_storage();
	$this->folders = $storage->list_folders();

	foreach ($this->folders as $folder) {
	$folderdata = $storage->get_metadata($folder, array(self::ACTIVESYNC_KEY, self::CTYPE_KEY));
	$foldertype = explode('.', $folderdata[$folder][self::CTYPE_KEY]);

	if ($asyncdata = $folderdata[$folder][self::ACTIVESYNC_KEY]) {
	$metadata = $this->unserialize_metadata($asyncdata);
	$this->folders_meta[$folder] = $metadata['FOLDER'];
	}
	$this->folders_meta[$folder]['TYPE'] = !empty($foldertype[0]) ? $foldertype[0] : 'mail';
	}
	-
	+
	// cache it!
	$this->cache->write('folders', $this->folders_meta);
	}
	}

	return $this->folders;
	}

	/**
	* Getter for folder metadata
	*
	* @return array Hash array with meta data for each folder
	*/
	public function folders_meta()
	{
	if (!isset($this->folders_meta))
	$this->list_folders();
	-
	+
	return $this->folders_meta;
	}

	/**
	* Helper method to decode saved IMAP metadata
	*/
	private function unserialize_metadata($str)
	{
	if (!empty($str))
	return @json_decode(base64_decode($str), true);

	return null;
	}

	/**
	* Helper method to encode IMAP metadata for saving
	*/
	private function serialize_metadata($data)
	{
	if (is_array($data))
	return base64_encode(json_encode($data));

	return '';
	}

	}
	diff --git a/plugins/kolab_zpush/kolab_zpush_ui.php b/plugins/kolab_zpush/kolab_zpush_ui.php
	index e651e982..4c99cf78 100644
	--- a/plugins/kolab_zpush/kolab_zpush_ui.php
	+++ b/plugins/kolab_zpush/kolab_zpush_ui.php
	@@ -1,171 +1,171 @@
	<?php

	/**
	* Z-Push configuration user interface builder
	*
	* @version 0.2
	* @author Thomas Bruederli <bruederli@kolabsys.com>
	*
	* Copyright (C) 2011, 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/>.
	*/

	class kolab_zpush_ui
	{
	private $rc;
	private $config;

	public function __construct($config)
	{
	$this->config = $config;
	$this->rc = rcmail::get_instance();

	$skin = $this->rc->config->get('skin');
	$this->config->include_stylesheet('skins/' . $skin . '/config.css');
	$this->rc->output->include_script('list.js');
	$this->skin_path = $this->config->urlbase . 'skins/' . $skin . '/';
	}


	public function device_list($attrib = array())
	{
	$attrib += array('id' => 'devices-list');

	$devices = $this->config->list_devices();
	$table = new html_table();

	foreach ($devices as $id => $device) {
	$name = $device['ALIAS'] ? $device['ALIAS'] : $id;
	$table->add_row(array('id' => 'rcmrow' . $id));
	$table->add(null, html::span('devicealias', Q($name)) . html::span('devicetype', Q($device['TYPE'])));
	}

	$this->rc->output->add_gui_object('devicelist', $attrib['id']);
	$this->rc->output->set_env('devices', $devices);

	return $table->show($attrib);
	}


	public function device_config_form($attrib = array())
	{
	$table = new html_table(array('cols' => 2));

	$field_id = 'config-device-alias';
	$input = new html_inputfield(array('name' => 'devicealias', 'id' => $field_id, 'size' => 40));
	$table->add('title', html::label($field_id, $this->config->gettext('devicealias')));
	$table->add(null, $input->show());
	-
	+
	$field_id = 'config-device-mode';
	$select = new html_select(array('name' => 'syncmode', 'id' => $field_id));
	$select->add(array($this->config->gettext('modeauto'), $this->config->gettext('modeflat'), $this->config->gettext('modefolder')), array('-1', '0', '1'));
	$table->add('title', html::label($field_id, $this->config->gettext('syncmode')));
	$table->add(null, $select->show('-1'));
	-
	+
	$field_id = 'config-device-laxpic';
	$checkbox = new html_checkbox(array('name' => 'laxpic', 'value' => '1', 'id' => $field_id));
	$table->add('title', $this->config->gettext('imageformat'));
	$table->add(null, html::label($field_id, $checkbox->show() . ' ' . $this->config->gettext('laxpiclabel')));
	-
	+
	if ($attrib['form'])
	$this->rc->output->add_gui_object('editform', $attrib['form']);

	return $table->show($attrib);
	}


	public function folder_subscriptions($attrib = array())
	{
	if (!$attrib['id'])
	$attrib['id'] = 'foldersubscriptions';
	-
	+
	// group folders by type (show only known types)
	$folder_groups = array('mail' => array(), 'contact' => array(), 'event' => array(), 'task' => array());
	$folder_meta = $this->config->folders_meta();
	foreach ($this->config->list_folders() as $folder) {
	$type = $folder_meta[$folder]['TYPE'] ? $folder_meta[$folder]['TYPE'] : 'mail';
	if (is_array($folder_groups[$type]))
	$folder_groups[$type][] = $folder;
	}
	-
	+
	// build block for every folder type
	foreach ($folder_groups as $type => $group) {
	if (empty($group))
	continue;
	$attrib['type'] = $type;
	$html .= html::div('subscriptionblock',
	html::tag('h3', $type, $this->config->gettext($type)) .
	$this->folder_subscriptions_block($group, $attrib));
	}

	$this->rc->output->add_gui_object('subscriptionslist', $attrib['id']);
	-
	+
	return html::div($attrib, $html);
	}

	public function folder_subscriptions_block($a_folders, $attrib)
	{
	$alarms = ($attrib['type'] == 'event' \|\| $attrib['type'] == 'task');
	-
	+
	$table = new html_table(array('cellspacing' => 0));
	$table->add_header('subscription', $attrib['syncicon'] ? html::img(array('src' => $this->skin_path . $attrib['syncicon'], 'title' => $this->config->gettext('synchronize'))) : '');
	$table->add_header('alarm', $alarms && $attrib['alarmicon'] ? html::img(array('src' => $this->skin_path . $attrib['alarmicon'], 'title' => $this->config->gettext('withalarms'))) : '');
	$table->add_header('foldername', $this->config->gettext('folder'));

	$checkbox_sync = new html_checkbox(array('name' => 'subscribed[]', 'class' => 'subscription'));
	$checkbox_alarm = new html_checkbox(array('name' => 'alarm[]', 'class' => 'alarm'));

	$names = array();
	foreach ($a_folders as $folder) {
	- $foldername = $origname = preg_replace('/^INBOX »\s+/', '', rcube_kolab::object_name($folder));
	+ $foldername = $origname = preg_replace('/^INBOX »\s+/', '', kolab_storage::object_name($folder));

	// find folder prefix to truncate (the same code as in kolab_addressbook plugin)
	for ($i = count($names)-1; $i >= 0; $i--) {
	if (strpos($foldername, $names[$i].' » ') === 0) {
	$length = strlen($names[$i].' » ');
	$prefix = substr($foldername, 0, $length);
	$count = count(explode(' » ', $prefix));
	$foldername = str_repeat('  ', $count-1) . '» ' . substr($foldername, $length);
	break;
	}
	}

	$names[] = $origname;

	$classes = array('mailbox');

	if ($folder_class = rcmail_folder_classname($folder)) {
	$foldername = rcube_label($folder_class);
	$classes[] = $folder_class;
	}

	$folder_id = 'rcmf' . html_identifier($folder);
	$padding = str_repeat('    ', $level);

	$table->add_row(array('class' => (($level+1) * $idx++) % 2 == 0 ? 'even' : 'odd'));
	$table->add('subscription', $checkbox_sync->show('', array('value' => $folder, 'id' => $folder_id)));

	if ($alarms)
	$table->add('alarm', $checkbox_alarm->show('', array('value' => $folder, 'id' => $folder_id.'_alarm')));
	else
	$table->add('alarm', '');
	-
	+
	$table->add(join(' ', $classes), html::label($folder_id, $padding . Q($foldername)));
	}

	return $table->show();
	}

	}
	diff --git a/plugins/kolab_zpush/package.xml b/plugins/kolab_zpush/package.xml
	index 61478795..ef6dfd72 100644
	--- a/plugins/kolab_zpush/package.xml
	+++ b/plugins/kolab_zpush/package.xml
	@@ -1,71 +1,72 @@
	<?xml version="1.0" encoding="UTF-8"?>
	<package xmlns="http://pear.php.net/dtd/package-2.0" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" packagerversion="1.9.0" version="2.0" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0
	http://pear.php.net/dtd/tasks-1.0.xsd
	http://pear.php.net/dtd/package-2.0
	http://pear.php.net/dtd/package-2.0.xsd">
	<name>kolab_zpush</name>
	<uri>http://git.kolab.org/roundcubemail-plugins-kolab/</uri>
	<summary>Z-Push configuration utility for Kolab accounts</summary>
	<description></description>
	<lead>
	<name>Thomas Bruederli</name>
	<user>thomasb</user>
	<email>bruederli@kolabsys.com</email>
	<active>yes</active>
	</lead>
	- <date>2011-11-14</date>
	- <time>12:12:00</time>
	+ <date>2012-05-14</date>
	<version>
	- <release>0.3</release>
	+ <release>1.0</release>
	+ <api>1.0</api>
	</version>
	<stability>
	<release>stable</release>
	</stability>
	<license uri="http://www.gnu.org/licenses/agpl.html">GNU AGPL</license>
	<notes>-</notes>
	<contents>
	<dir baseinstalldir="/" name="/">
	<file name="kolab_zpush.php" role="php"></file>
	<file name="kolab_zpush_ui.php" role="php"></file>
	<file name="kolab_zpush.js" role="data"></file>
	<file name="localization/de_CH.inc" role="data"></file>
	+ <file name="localization/de_DE.inc" role="data"></file>
	<file name="localization/en_US.inc" role="data"></file>
	<file name="localization/pl_PL.inc" role="data"></file>
	<file name="skins/default/templates/config.html" role="data"></file>
	<file name="skins/default/config.css" role="data"></file>
	<file name="skins/default/alarm-clock.png" role="data"></file>
	<file name="skins/default/deviceactions.png" role="data"></file>
	<file name="skins/default/foldertypes.png" role="data"></file>
	<file name="skins/default/pointer-left.gif" role="data"></file>
	<file name="skins/default/synchronize.png" role="data"></file>
	<file name="skins/larry/templates/config.html" role="data"></file>
	<file name="skins/larry/config.css" role="data"></file>
	<file name="skins/larry/alarm-clock.png" role="data"></file>
	<file name="skins/larry/deviceactions.png" role="data"></file>
	<file name="skins/larry/foldertypes.png" role="data"></file>
	<file name="skins/larry/pointer-left.png" role="data"></file>
	<file name="skins/larry/synchronize.png" role="data"></file>
	<file name="README" role="data"></file>
	<file name="LICENSE" role="data"></file>
	</dir>
	</contents>
	<dependencies>
	<required>
	<php>
	<min>5.2.1</min>
	</php>
	<pearinstaller>
	<min>1.7.0</min>
	</pearinstaller>
	<package>
	<name>kolab_core</name>
	<uri>http://kolabsys.com</uri>
	</package>
	<package>
	<name>jqueryui</name>
	<channel>pear.roundcube.net</uri>
	</package>
	</required>
	</dependencies>
	<phprelease/>
	</package>

File Metadata

Mime Type: text/x-diff
Expires: Mon, Aug 17, 6:14 PM (1 d, 9 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1257470
Default Alt Text: (24 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions