#!/usr/bin/php
<?php
/***********************************************
* File : z-push-admin.php
* Project : Z-Push
* Descr : This is a small command line
* client to see and modify the
* wipe status of Zarafa users.
*
* Created : 14.05.2010
*
* Copyright 2007 - 2013 Zarafa Deutschland GmbH
*
* This program 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 with the following additional
* term according to sec. 7:
*
* According to sec. 7 of the GNU Affero General Public License, version 3,
* the terms of the AGPL are supplemented with the following terms:
*
* "Zarafa" is a registered trademark of Zarafa B.V.
* "Z-Push" is a registered trademark of Zarafa Deutschland GmbH
* The licensing of the Program under the AGPL does not imply a trademark license.
* Therefore any rights, title and interest in our trademarks remain entirely with us.
*
* However, if you propagate an unmodified version of the Program you are
* allowed to use the term "Z-Push" to indicate that you distribute the Program.
* Furthermore you may use our trademarks where it is necessary to indicate
* the intended purpose of a product or service provided you use it in accordance
* with honest practices in industrial or commercial matters.
* If you want to propagate modified versions of the Program under the name "Z-Push",
* you may only do so if you have a written permission by Zarafa Deutschland GmbH
* (to acquire a permission please contact Zarafa at trademark@zarafa.com).
*
* 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/>.
*
* Consult LICENSE file for details
************************************************/
require_once 'vendor/autoload.php';
require_once 'config.php';
/**
* //TODO resync of single folders of a users device
*/
/************************************************
* MAIN
*/
define('BASE_PATH_CLI', dirname(__FILE__) ."/");
set_include_path(get_include_path() . PATH_SEPARATOR . BASE_PATH_CLI);
try {
ZPush::CheckConfig();
ZLog::Initialize();
ZPushAdminCLI::CheckEnv();
ZPushAdminCLI::CheckOptions();
if (! ZPushAdminCLI::SureWhatToDo()) {
// show error message if available
if (ZPushAdminCLI::GetErrorMessage())
echo "ERROR: ". ZPushAdminCLI::GetErrorMessage() . "\n";
echo ZPushAdminCLI::UsageInstructions();
exit(1);
}
ZPushAdminCLI::RunCommand();
}
catch (ZPushException $zpe) {
die(get_class($zpe) . ": ". $zpe->getMessage() . "\n");
}
/************************************************
* Z-Push-Admin CLI
*/
class ZPushAdminCLI {
const COMMAND_SHOWALLDEVICES = 1;
const COMMAND_SHOWDEVICESOFUSER = 2;
const COMMAND_SHOWUSERSOFDEVICE = 3;
const COMMAND_WIPEDEVICE = 4;
const COMMAND_REMOVEDEVICE = 5;
const COMMAND_RESYNCDEVICE = 6;
const COMMAND_CLEARLOOP = 7;
const COMMAND_SHOWLASTSYNC = 8;
const COMMAND_RESYNCFOLDER = 9;
const COMMAND_FIXSTATES = 10;
const COMMAND_MAP = 11;
const COMMAND_UNMAP = 12;
const TYPE_OPTION_EMAIL = "email";
const TYPE_OPTION_CALENDAR = "calendar";
const TYPE_OPTION_CONTACT = "contact";
const TYPE_OPTION_TASK = "task";
const TYPE_OPTION_NOTE = "note";
static private $command;
static private $user = false;
static private $device = false;
static private $type = false;
static private $backend = false;
static private $errormessage;
/**
* Returns usage instructions
*
* @return string
* @access public
*/
static public function UsageInstructions() {
$types = "'".self::TYPE_OPTION_EMAIL."', '".self::TYPE_OPTION_CALENDAR."', '".self::TYPE_OPTION_CONTACT."', '".self::TYPE_OPTION_TASK."' or '".self::TYPE_OPTION_NOTE."'";
return "Usage:\n\tz-push-admin.php -a ACTION [options]\n\n" .
"Parameters:\n\t-a list/wipe/remove/resync/clearloop/fixstates/map/unmap\n" .
"\t[-u] username\n" .
"\t[-d] deviceid\n" .
"\t[-b] backend\n\n" .
"Actions:\n" .
"\tlist\t\t\t\t Lists all devices and synchronized users\n" .
"\tlist -u USER\t\t\t Lists all devices of user USER\n" .
"\tlist -d DEVICE\t\t\t Lists all users of device DEVICE\n" .
"\tlastsync\t\t\t Lists all devices and synchronized users and the last synchronization time\n" .
"\twipe -u USER\t\t\t Remote wipes all devices of user USER\n" .
"\twipe -d DEVICE\t\t\t Remote wipes device DEVICE\n" .
"\twipe -u USER -d DEVICE\t\t Remote wipes device DEVICE of user USER\n" .
"\tremove -u USER\t\t\t Removes all state data of all devices of user USER\n" .
"\tremove -d DEVICE\t\t Removes all state data of all users synchronized on device DEVICE\n" .
"\tremove -u USER -d DEVICE\t Removes all related state data of device DEVICE of user USER\n" .
"\tresync -u USER -d DEVICE\t Resynchronizes all data of device DEVICE of user USER\n" .
"\tresync -t TYPE \t\t\t Resynchronizes all folders of type $types for all devices and users.\n" .
"\tresync -t TYPE -u USER \t\t Resynchronizes all folders of type $types for the user USER.\n" .
"\tresync -t TYPE -u USER -d DEVICE Resynchronizes all folders of type $types for a specified device and user.\n" .
"\tresync -t FOLDERID -u USER\t Resynchronize the specified folder id only. The USER should be specified for better performance.\n" .
"\tclearloop\t\t\t Clears system wide loop detection data\n" .
"\tclearloop -d DEVICE -u USER\t Clears all loop detection data of a device DEVICE and an optional user USER\n" .
"\tfixstates\t\t\t Checks the states for integrity and fixes potential issues\n" .
"\tmap -u USER -b BACKEND -t USER2\t Maps USER for BACKEND to username USER2 (when using 'combined' backend)\n" .
"\tunmap -u USER -b BACKEND\t Removes the mapping for USER and BACKEND (when using 'combined' backend)\n" .
"\n";
}
/**
* Checks the environment
*
* @return
* @access public
*/
static public function CheckEnv() {
if (php_sapi_name() != "cli")
self::$errormessage = sprintf("This script should not be called in a browser. Called from: %s", php_sapi_name());
if (!function_exists("getopt"))
self::$errormessage = "PHP Function getopt not found. Please check your PHP version and settings.";
}
/**
* Checks the options from the command line
*
* @return
* @access public
*/
static public function CheckOptions() {
if (self::$errormessage)
return;
$options = getopt("u:d:a:t:b:");
// get 'user'
if (isset($options['u']) && !empty($options['u']))
self::$user = strtolower(trim($options['u']));
else if (isset($options['user']) && !empty($options['user']))
self::$user = strtolower(trim($options['user']));
// get 'device'
if (isset($options['d']) && !empty($options['d']))
self::$device = strtolower(trim($options['d']));
else if (isset($options['device']) && !empty($options['device']))
self::$device = strtolower(trim($options['device']));
// get 'action'
$action = false;
if (isset($options['a']) && !empty($options['a']))
$action = strtolower(trim($options['a']));
elseif (isset($options['action']) && !empty($options['action']))
$action = strtolower(trim($options['action']));
// get 'type'
if (isset($options['t']) && !empty($options['t']))
self::$type = strtolower(trim($options['t']));
elseif (isset($options['type']) && !empty($options['type']))
self::$type = strtolower(trim($options['type']));
// if type is set, it must be one of known types or a 44 byte long folder id
if (self::$type !== false) {
if (self::$type !== self::TYPE_OPTION_EMAIL &&
self::$type !== self::TYPE_OPTION_CALENDAR &&
self::$type !== self::TYPE_OPTION_CONTACT &&
self::$type !== self::TYPE_OPTION_TASK &&
self::$type !== self::TYPE_OPTION_NOTE &&
strlen(self::$type) !== 44) {
self::$errormessage = "Wrong 'type'. Possible values are: ".
"'".self::TYPE_OPTION_EMAIL."', '".self::TYPE_OPTION_CALENDAR."', '".self::TYPE_OPTION_CONTACT."', '".self::TYPE_OPTION_TASK."', '".self::TYPE_OPTION_NOTE."' ".
"or a 44 byte long folder id (as hex).";
return;
}
}
// get 'backend'
if (isset($options['b']) && !empty($options['b']))
self::$backend = strtolower(trim($options['b']));
elseif (isset($options['backend']) && !empty($options['backend']))
self::$backend = strtolower(trim($options['backend']));
// get a command for the requested action
switch ($action) {
// list data
case "list":
if (self::$user === false && self::$device === false)
self::$command = self::COMMAND_SHOWALLDEVICES;
if (self::$user !== false)
self::$command = self::COMMAND_SHOWDEVICESOFUSER;
if (self::$device !== false)
self::$command = self::COMMAND_SHOWUSERSOFDEVICE;
break;
// list data
case "lastsync":
self::$command = self::COMMAND_SHOWLASTSYNC;
break;
// remove wipe device
case "wipe":
if (self::$user === false && self::$device === false)
self::$errormessage = "Not possible to execute remote wipe. Device, user or both must be specified.";
else
self::$command = self::COMMAND_WIPEDEVICE;
break;
// remove device data of user
case "remove":
if (self::$user === false && self::$device === false)
self::$errormessage = "Not possible to remove data. Device, user or both must be specified.";
else
self::$command = self::COMMAND_REMOVEDEVICE;
break;
// resync a device
case "resync":
case "re-sync":
case "sync":
case "resynchronize":
case "re-synchronize":
case "synchronize":
// full resync
if (self::$type === false) {
if (self::$user === false || self::$device === false)
self::$errormessage = "Not possible to resynchronize device. Device and user must be specified.";
else
self::$command = self::COMMAND_RESYNCDEVICE;
}
else {
self::$command = self::COMMAND_RESYNCFOLDER;
}
break;
// clear loop detection data
case "clearloop":
case "clearloopdetection":
self::$command = self::COMMAND_CLEARLOOP;
break;
// clear loop detection data
case "fixstates":
case "fix":
self::$command = self::COMMAND_FIXSTATES;
break;
// map users for 'combined' backend
case "map":
if (self::$user === false || self::$backend === false || self::$type === false)
self::$errormessage = "Not possible to map. User, backend and target user must be specified.";
else
self::$command = self::COMMAND_MAP;
break;
// unmap users for 'combined' backend
case "unmap":
if (self::$user === false || self::$backend === false)
self::$errormessage = "Not possible to unmap. User and backend must be specified.";
else
self::$command = self::COMMAND_UNMAP;
break;
default:
self::UsageInstructions();
}
}
/**
* Indicates if the options from the command line
* could be processed correctly
*
* @return boolean
* @access public
*/
static public function SureWhatToDo() {
return isset(self::$command);
}
/**
* Returns a errormessage of things which could have gone wrong
*
* @return string
* @access public
*/
static public function GetErrorMessage() {
return (isset(self::$errormessage))?self::$errormessage:"";
}
/**
* Runs a command requested from an action of the command line
*
* @return
* @access public
*/
static public function RunCommand() {
echo "\n";
switch(self::$command) {
case self::COMMAND_SHOWALLDEVICES:
self::CommandShowDevices();
break;
case self::COMMAND_SHOWDEVICESOFUSER:
self::CommandShowDevices();
break;
case self::COMMAND_SHOWUSERSOFDEVICE:
self::CommandDeviceUsers();
break;
case self::COMMAND_SHOWLASTSYNC:
self::CommandShowLastSync();
break;
case self::COMMAND_WIPEDEVICE:
if (self::$device)
echo sprintf("Are you sure you want to REMOTE WIPE device '%s' [y/N]: ", self::$device);
else
echo sprintf("Are you sure you want to REMOTE WIPE all devices of user '%s' [y/N]: ", self::$user);
$confirm = strtolower(trim(fgets(STDIN)));
if ( $confirm === 'y' || $confirm === 'yes')
self::CommandWipeDevice();
else
echo "Aborted!\n";
break;
case self::COMMAND_REMOVEDEVICE:
self::CommandRemoveDevice();
break;
case self::COMMAND_RESYNCDEVICE:
if (self::$device == false) {
echo sprintf("Are you sure you want to re-synchronize all devices of user '%s' [y/N]: ", self::$user);
$confirm = strtolower(trim(fgets(STDIN)));
if ( !($confirm === 'y' || $confirm === 'yes')) {
echo "Aborted!\n";
exit(1);
}
}
self::CommandResyncDevices();
break;
case self::COMMAND_RESYNCFOLDER:
if (self::$device == false && self::$user == false) {
echo "Are you sure you want to re-synchronize this folder type of all devices and users [y/N]: ";
$confirm = strtolower(trim(fgets(STDIN)));
if ( !($confirm === 'y' || $confirm === 'yes')) {
echo "Aborted!\n";
exit(1);
}
}
self::CommandResyncFolder();
break;
case self::COMMAND_CLEARLOOP:
self::CommandClearLoopDetectionData();
break;
case self::COMMAND_FIXSTATES:
self::CommandFixStates();
break;
case self::COMMAND_MAP:
self::CommandMap();
break;
case self::COMMAND_UNMAP:
self::CommandUnmap();
break;
}
echo "\n";
}
/**
* Command "Show all devices" and "Show devices of user"
* Prints the device id of/and connected users
*
* @return
* @access public
*/
static public function CommandShowDevices() {
$devicelist = ZPushAdmin::ListDevices(self::$user);
if (empty($devicelist))
echo "\tno devices found\n";
else {
if (self::$user === false) {
echo "All synchronized devices\n\n";
echo str_pad("Device id", 36). "Synchronized users\n";
echo "-----------------------------------------------------\n";
}
else
echo "Synchronized devices of user: ". self::$user. "\n";
}
foreach ($devicelist as $deviceId) {
if (self::$user === false) {
echo str_pad($deviceId, 36) . implode (",", ZPushAdmin::ListUsers($deviceId)) ."\n";
}
else
self::printDeviceData($deviceId, self::$user);
}
}
/**
* Command "Show all devices and users with last sync time"
* Prints the device id of/and connected users
*
* @return
* @access public
*/
static public function CommandShowLastSync() {
$devicelist = ZPushAdmin::ListDevices(false);
if (empty($devicelist))
echo "\tno devices found\n";
else {
echo "All known devices and users and their last synchronization time\n\n";
echo str_pad("Device id", 36). str_pad("Synchronized user", 31)."Last sync time\n";
echo "-----------------------------------------------------------------------------------------------------\n";
}
foreach ($devicelist as $deviceId) {
$users = ZPushAdmin::ListUsers($deviceId);
foreach ($users as $user) {
$device = ZPushAdmin::GetDeviceDetails($deviceId, $user);
echo str_pad($deviceId, 36) . str_pad($user, 30) . " " . ($device->GetLastSyncTime() ? strftime("%Y-%m-%d %H:%M", $device->GetLastSyncTime()) : "never") . "\n";
}
}
}
/**
* Command "Show users of device"
* Prints informations about all users which use a device
*
* @return
* @access public
*/
static public function CommandDeviceUsers() {
$users = ZPushAdmin::ListUsers(self::$device);
if (empty($users)) {
echo "\tno user data synchronized to device\n";
}
// if a user is specified, we only want to see the devices of this one
else if (self::$user !== false && !in_array(self::$user, $users)) {
printf("\tuser '%s' not known in device data '%s'\n", self::$user, self::$device);
}
foreach ($users as $user) {
if (self::$user !== false && strtolower($user) !== self::$user) {
continue;
}
echo "Synchronized by user: ". $user. "\n";
self::printDeviceData(self::$device, $user);
}
}
/**
* Command "Wipe device"
* Marks a device of that user to be remotely wiped
*
* @return
* @access public
*/
static public function CommandWipeDevice() {
$stat = ZPushAdmin::WipeDevice($_SERVER["LOGNAME"], self::$user, self::$device);
if (self::$user !== false && self::$device !== false) {
echo sprintf("Mark device '%s' of user '%s' to be wiped: %s", self::$device, self::$user, ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
if ($stat) {
echo "Updated information about this device:\n";
self::printDeviceData(self::$device, self::$user);
}
}
elseif (self::$user !== false) {
echo sprintf("Mark devices of user '%s' to be wiped: %s", self::$user, ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
self::CommandShowDevices();
}
}
/**
* Command "Remove device"
* Remove a device of that user from the device list
*
* @return
* @access public
*/
static public function CommandRemoveDevice() {
$stat = ZPushAdmin::RemoveDevice(self::$user, self::$device);
if (self::$user === false)
echo sprintf("State data of device '%s' removed: %s", self::$device, ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
elseif (self::$device === false)
echo sprintf("State data of all devices of user '%s' removed: %s", self::$user, ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
else
echo sprintf("State data of device '%s' of user '%s' removed: %s", self::$device, self::$user, ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
}
/**
* Command "Resync device(s)"
* Resyncs one or all devices of that user
*
* @return
* @access public
*/
static public function CommandResyncDevices() {
$stat = ZPushAdmin::ResyncDevice(self::$user, self::$device);
echo sprintf("Resync of device '%s' of user '%s': %s", self::$device, self::$user, ($stat)?'Requested':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
}
/**
* Command "Resync folder(s)"
* Resyncs a folder type of a specific device/user or of all users
*
* @return
* @access public
*/
static public function CommandResyncFolder() {
// if no device is specified, search for all devices of a user. If user is not set, all devices are returned.
if (self::$device === false) {
$devicelist = ZPushAdmin::ListDevices(self::$user);
if (empty($devicelist)) {
echo "\tno devices/users found\n";
return true;
}
}
else
$devicelist = array(self::$device);
foreach ($devicelist as $deviceId) {
$users = ZPushAdmin::ListUsers($deviceId);
foreach ($users as $user) {
if (self::$user && self::$user != $user)
continue;
self::resyncFolder($deviceId, $user, self::$type);
}
}
}
/**
* Command to clear the loop detection data
* Mobiles may enter loop detection (one-by-one synchring due to timeouts / erros).
*
* @return
* @access public
*/
static public function CommandClearLoopDetectionData() {
$stat = false;
$stat = ZPushAdmin::ClearLoopDetectionData(self::$user, self::$device);
if (self::$user === false && self::$device === false)
echo sprintf("System wide loop detection data removed: %s", ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
elseif (self::$user === false)
echo sprintf("Loop detection data of device '%s' removed: %s", self::$device, ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
elseif (self::$device === false && self::$user !== false)
echo sprintf("Error: %s", ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_WARN)). "\n";
else
echo sprintf("Loop detection data of device '%s' of user '%s' removed: %s", self::$device, self::$user, ($stat)?'OK':ZLog::GetLastMessage(LOGLEVEL_ERROR)). "\n";
}
/**
* Resynchronizes a folder type of a device & user
*
* @param string $deviceId the id of the device
* @param string $user the user
* @param string $type the folder type
*
* @return
* @access private
*/
static private function resyncFolder($deviceId, $user, $type) {
$device = ZPushAdmin::GetDeviceDetails($deviceId, $user);
if (! $device instanceof ASDevice) {
echo sprintf("Folder resync failed: %s\n", ZLog::GetLastMessage(LOGLEVEL_ERROR));
return false;
}
$folders = array();
foreach ($device->GetAllFolderIds() as $folderid) {
// if submitting a folderid as type to resync a specific folder.
if ($folderid == $type) {
printf("Found and resynching requested folderid '%s' on device '%s' of user '%s'\n", $folderid, $deviceId, $user);
$folders[] = $folderid;
break;
}
if ($device->GetFolderUUID($folderid)) {
$foldertype = $device->GetFolderType($folderid);
switch($foldertype) {
case SYNC_FOLDER_TYPE_APPOINTMENT:
case SYNC_FOLDER_TYPE_USER_APPOINTMENT:
if ($type == "calendar")
$folders[] = $folderid;
break;
case SYNC_FOLDER_TYPE_CONTACT:
case SYNC_FOLDER_TYPE_USER_CONTACT:
if ($type == "contact")
$folders[] = $folderid;
break;
case SYNC_FOLDER_TYPE_TASK:
case SYNC_FOLDER_TYPE_USER_TASK:
if ($type == "task")
$folders[] = $folderid;
break;
case SYNC_FOLDER_TYPE_NOTE:
case SYNC_FOLDER_TYPE_USER_NOTE:
if ($type == "note")
$folders[] = $folderid;
break;
default:
if ($type == "email")
$folders[] = $folderid;
break;
}
}
}
$stat = ZPushAdmin::ResyncFolder($user, $deviceId, $folders);
echo sprintf("Resync of %d folders of type %s on device '%s' of user '%s': %s\n", count($folders), $type, $deviceId, $user, ($stat)?'Requested':ZLog::GetLastMessage(LOGLEVEL_ERROR));
}
/**
* Fixes the states for potential issues
*
* @return
* @access private
*/
static private function CommandFixStates() {
echo "Validating and fixing states (this can take some time):\n";
echo "\tChecking devicedata states: ";
if ($stat = ZPushAdmin::FixStatesWrongDevicedata())
printf("Devices: fixed %d - ok %d Users: removed %d - ok %d\n",$stat[0], $stat[1], $stat[2], $stat[3]);
else
echo ZLog::GetLastMessage(LOGLEVEL_ERROR) . "\n";
echo "\tChecking username casings: ";
if ($stat = ZPushAdmin::FixStatesDifferentUsernameCases())
printf("Processed: %d - Converted: %d - Removed: %d\n", $stat[0], $stat[1], $stat[2]);
else
echo ZLog::GetLastMessage(LOGLEVEL_ERROR) . "\n";
// fixes ZP-339
echo "\tChecking available devicedata & user linking: ";
if ($stat = ZPushAdmin::FixStatesDeviceToUserLinking())
printf("Unlinked: %d - Linked: %d\n", $stat[0], $stat[1]);
else
echo ZLog::GetLastMessage(LOGLEVEL_ERROR) . "\n";
echo "\tChecking for unreferenced (obsolete) state files: ";
if (($stat = ZPushAdmin::FixStatesUserToStatesLinking()) !== false)
printf("Processed: %d - Deleted: %d\n", $stat[0], $stat[1]);
else
echo ZLog::GetLastMessage(LOGLEVEL_ERROR) . "\n";
}
/**
* Maps a username for a specific backend to another username
*
* @return
* @access private
*/
static private function CommandMap() {
if (ZPushAdmin::AddUsernameMapping(self::$user, self::$backend, self::$type))
printf("Successfully mapped username.\n");
else
echo ZLog::GetLastMessage(LOGLEVEL_ERROR) . "\n";
}
/**
* Deletes the mapping for a username and a specific bakkend
*
* @return
* @access private
*/
static private function CommandUnmap() {
if (ZPushAdmin::RemoveUsernameMapping(self::$user, self::$backend))
printf("Successfully unmapped username.\n");
else
echo ZLog::GetLastMessage(LOGLEVEL_ERROR) . "\n";
}
/**
* Prints detailed informations about a device
*
* @param string $deviceId the id of the device
* @param string $user the user
*
* @return
* @access private
*/
static private function printDeviceData($deviceId, $user) {
$device = ZPushAdmin::GetDeviceDetails($deviceId, $user);
if (! $device instanceof ASDevice) {
echo sprintf("Folder resync failed: %s\n", ZLog::GetLastMessage(LOGLEVEL_ERROR));
return false;
}
// Gather some statistics about synchronized folders
$folders = $device->GetAllFolderIds();
$synchedFolders = 0;
$synchedFolderTypes = array();
$syncedFoldersInProgress = 0;
foreach ($folders as $folderid) {
if ($device->GetFolderUUID($folderid)) {
$synchedFolders++;
$type = $device->GetFolderType($folderid);
switch($type) {
case SYNC_FOLDER_TYPE_APPOINTMENT:
case SYNC_FOLDER_TYPE_USER_APPOINTMENT:
$gentype = "Calendars";
break;
case SYNC_FOLDER_TYPE_CONTACT:
case SYNC_FOLDER_TYPE_USER_CONTACT:
$gentype = "Contacts";
break;
case SYNC_FOLDER_TYPE_TASK:
case SYNC_FOLDER_TYPE_USER_TASK:
$gentype = "Tasks";
break;
case SYNC_FOLDER_TYPE_NOTE:
case SYNC_FOLDER_TYPE_USER_NOTE:
$gentype = "Notes";
break;
default:
$gentype = "Emails";
break;
}
if (!isset($synchedFolderTypes[$gentype]))
$synchedFolderTypes[$gentype] = 0;
$synchedFolderTypes[$gentype]++;
// set the folder name for all folders which are not fully synchronized yet
$fstatus = $device->GetFolderSyncStatus($folderid);
if ($fstatus !== false && is_array($fstatus)) {
// TODO would be nice if we could see the real name of the folder, right now we use the folder type as name
$fstatus['name'] = $gentype;
$device->SetFolderSyncStatus($folderid, $fstatus);
$syncedFoldersInProgress++;
}
}
}
$folderinfo = "";
foreach ($synchedFolderTypes as $gentype=>$count) {
$folderinfo .= $gentype;
if ($count>1) $folderinfo .= "($count)";
$folderinfo .= " ";
}
if (!$folderinfo) $folderinfo = "None available";
echo "-----------------------------------------------------\n";
echo "DeviceId:\t\t$deviceId\n";
echo "Device type:\t\t". ($device->GetDeviceType() !== ASDevice::UNDEFINED ? $device->GetDeviceType() : "unknown") ."\n";
echo "UserAgent:\t\t".($device->GetDeviceUserAgent()!== ASDevice::UNDEFINED ? $device->GetDeviceUserAgent() : "unknown") ."\n";
// TODO implement $device->GetDeviceUserAgentHistory()
// device information transmitted during Settings command
if ($device->GetDeviceModel())
echo "Device Model:\t\t". $device->GetDeviceModel(). "\n";
if ($device->GetDeviceIMEI())
echo "Device IMEI:\t\t". $device->GetDeviceIMEI(). "\n";
if ($device->GetDeviceFriendlyName())
echo "Device friendly name:\t". $device->GetDeviceFriendlyName(). "\n";
if ($device->GetDeviceOS())
echo "Device OS:\t\t". $device->GetDeviceOS(). "\n";
if ($device->GetDeviceOSLanguage())
echo "Device OS Language:\t". $device->GetDeviceOSLanguage(). "\n";
if ($device->GetDevicePhoneNumber())
echo "Device Phone nr:\t". $device->GetDevicePhoneNumber(). "\n";
if ($device->GetDeviceMobileOperator())
echo "Device Operator:\t". $device->GetDeviceMobileOperator(). "\n";
if ($device->GetDeviceEnableOutboundSMS())
echo "Device Outbound SMS:\t". $device->GetDeviceEnableOutboundSMS(). "\n";
echo "ActiveSync version:\t".($device->GetASVersion() ? $device->GetASVersion() : "unknown") ."\n";
echo "First sync:\t\t". strftime("%Y-%m-%d %H:%M", $device->GetFirstSyncTime()) ."\n";
echo "Last sync:\t\t". ($device->GetLastSyncTime() ? strftime("%Y-%m-%d %H:%M", $device->GetLastSyncTime()) : "never")."\n";
echo "Total folders:\t\t". count($folders). "\n";
echo "Synchronized folders:\t". $synchedFolders;
if ($syncedFoldersInProgress > 0)
echo " (". $syncedFoldersInProgress. " in progress)";
echo "\n";
echo "Synchronized data:\t$folderinfo\n";
if ($syncedFoldersInProgress > 0) {
echo "Synchronization progress:\n";
foreach ($folders as $folderid) {
$d = $device->GetFolderSyncStatus($folderid);
if ($d) {
$status = "";
if ($d['total'] > 0) {
$percent = round($d['done']*100/$d['total']);
$status = sprintf("Status: %s%d%% (%d/%d)", ($percent < 10)?" ":"", $percent, $d['done'], $d['total']);
}
printf("\tFolder: %s%s Sync: %s %s\n", $d['name'], str_repeat(" ", 12-strlen($d['name'])), $d['status'], $status);
}
}
}
echo "Status:\t\t\t";
switch ($device->GetWipeStatus()) {
case SYNC_PROVISION_RWSTATUS_OK:
echo "OK\n";
break;
case SYNC_PROVISION_RWSTATUS_PENDING:
echo "Pending wipe\n";
break;
case SYNC_PROVISION_RWSTATUS_REQUESTED:
echo "Wipe requested on device\n";
break;
case SYNC_PROVISION_RWSTATUS_WIPED:
echo "Wiped\n";
break;
default:
echo "Not available\n";
break;
}
echo "WipeRequest on:\t\t". ($device->GetWipeRequestedOn() ? strftime("%Y-%m-%d %H:%M", $device->GetWipeRequestedOn()) : "not set")."\n";
echo "WipeRequest by:\t\t". ($device->GetWipeRequestedBy() ? $device->GetWipeRequestedBy() : "not set")."\n";
echo "Wiped on:\t\t". ($device->GetWipeActionOn() ? strftime("%Y-%m-%d %H:%M", $device->GetWipeActionOn()) : "not set")."\n";
echo "Attention needed:\t";
if ($device->GetDeviceError())
echo $device->GetDeviceError() ."\n";
else if (!isset($device->ignoredmessages) || empty($device->ignoredmessages)) {
echo "No errors known\n";
}
else {
printf("%d messages need attention because they could not be synchronized\n", count($device->ignoredmessages));
foreach ($device->ignoredmessages as $im) {
$info = "";
if (isset($im->asobject->subject))
$info .= sprintf("Subject: '%s'", $im->asobject->subject);
if (isset($im->asobject->fileas))
$info .= sprintf("FileAs: '%s'", $im->asobject->fileas);
if (isset($im->asobject->from))
$info .= sprintf(" - From: '%s'", $im->asobject->from);
if (isset($im->asobject->starttime))
$info .= sprintf(" - On: '%s'", strftime("%Y-%m-%d %H:%M", $im->asobject->starttime));
$reason = $im->reasonstring;
if ($im->reasoncode == 2)
$reason = "Message was causing loop";
printf("\tBroken object:\t'%s' ignored on '%s'\n", $im->asclass, strftime("%Y-%m-%d %H:%M", $im->timestamp));
printf("\tInformation:\t%s\n", $info);
printf("\tReason: \t%s (%s)\n", $reason, $im->reasoncode);
printf("\tItem/Parent id: %s/%s\n", $im->id, $im->folderid);
echo "\n";
}
}
}
}