| Path : /opt/z-push/lib/core/ |
|
B-Con CMD Config cPanel C-Rdp D-Log Info Jump Mass Ransom Symlink vHost Zone-H |
| Current File : //opt/z-push/lib/core/zpush.php |
<?php
/***********************************************
* File : zpush.php
* Project : Z-Push
* Descr : Core functionalities
*
* Created : 12.04.2011
*
* Copyright 2007 - 2016 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.
*
* 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
************************************************/
class ZPush {
const UNAUTHENTICATED = 1;
const UNPROVISIONED = 2;
const NOACTIVESYNCCOMMAND = 3;
const WEBSERVICECOMMAND = 4;
const HIERARCHYCOMMAND = 5;
const PLAININPUT = 6;
const REQUESTHANDLER = 7;
const CLASS_NAME = 1;
const CLASS_REQUIRESPROTOCOLVERSION = 2;
const CLASS_DEFAULTTYPE = 3;
const CLASS_OTHERTYPES = 4;
// AS versions
const ASV_1 = "1.0";
const ASV_2 = "2.0";
const ASV_21 = "2.1";
const ASV_25 = "2.5";
const ASV_12 = "12.0";
const ASV_121 = "12.1";
const ASV_14 = "14.0";
const ASV_141 = "14.1";
/**
* Command codes for base64 encoded requests (AS >= 12.1)
*/
const COMMAND_SYNC = 0;
const COMMAND_SENDMAIL = 1;
const COMMAND_SMARTFORWARD = 2;
const COMMAND_SMARTREPLY = 3;
const COMMAND_GETATTACHMENT = 4;
const COMMAND_FOLDERSYNC = 9;
const COMMAND_FOLDERCREATE = 10;
const COMMAND_FOLDERDELETE = 11;
const COMMAND_FOLDERUPDATE = 12;
const COMMAND_MOVEITEMS = 13;
const COMMAND_GETITEMESTIMATE = 14;
const COMMAND_MEETINGRESPONSE = 15;
const COMMAND_SEARCH = 16;
const COMMAND_SETTINGS = 17;
const COMMAND_PING = 18;
const COMMAND_ITEMOPERATIONS = 19;
const COMMAND_PROVISION = 20;
const COMMAND_RESOLVERECIPIENTS = 21;
const COMMAND_VALIDATECERT = 22;
// Deprecated commands
const COMMAND_GETHIERARCHY = -1;
const COMMAND_CREATECOLLECTION = -2;
const COMMAND_DELETECOLLECTION = -3;
const COMMAND_MOVECOLLECTION = -4;
const COMMAND_NOTIFY = -5;
// Webservice commands
const COMMAND_WEBSERVICE_DEVICE = -100;
const COMMAND_WEBSERVICE_USERS = -101;
const COMMAND_WEBSERVICE_INFO = -102;
// Latest supported State version
const STATE_VERSION = IStateMachine::STATEVERSION_02;
static private $autoloadBackendPreference = array(
"BackendKopano",
"BackendCombined",
"BackendIMAP",
"BackendVCardDir",
"BackendMaildir"
);
// Versions 1.0, 2.0, 2.1 and 2.5 are deprecated (ZP-604)
static private $supportedASVersions = array(
self::ASV_12,
self::ASV_121,
self::ASV_14,
self::ASV_141
);
static private $supportedCommands = array(
// COMMAND // AS VERSION // REQUESTHANDLER // OTHER SETTINGS
self::COMMAND_SYNC => array(self::ASV_1, self::REQUESTHANDLER => "Sync"),
self::COMMAND_SENDMAIL => array(self::ASV_1, self::REQUESTHANDLER => "SendMail"),
self::COMMAND_SMARTFORWARD => array(self::ASV_1, self::REQUESTHANDLER => "SendMail"),
self::COMMAND_SMARTREPLY => array(self::ASV_1, self::REQUESTHANDLER => "SendMail"),
self::COMMAND_GETATTACHMENT => array(self::ASV_1, self::REQUESTHANDLER => "GetAttachment"),
self::COMMAND_GETHIERARCHY => array(self::ASV_1, self::REQUESTHANDLER => "GetHierarchy", self::HIERARCHYCOMMAND), // deprecated but implemented
self::COMMAND_CREATECOLLECTION => array(self::ASV_1), // deprecated & not implemented
self::COMMAND_DELETECOLLECTION => array(self::ASV_1), // deprecated & not implemented
self::COMMAND_MOVECOLLECTION => array(self::ASV_1), // deprecated & not implemented
self::COMMAND_FOLDERSYNC => array(self::ASV_2, self::REQUESTHANDLER => "FolderSync", self::HIERARCHYCOMMAND),
self::COMMAND_FOLDERCREATE => array(self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND),
self::COMMAND_FOLDERDELETE => array(self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND),
self::COMMAND_FOLDERUPDATE => array(self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND),
self::COMMAND_MOVEITEMS => array(self::ASV_1, self::REQUESTHANDLER => "MoveItems"),
self::COMMAND_GETITEMESTIMATE => array(self::ASV_1, self::REQUESTHANDLER => "GetItemEstimate"),
self::COMMAND_MEETINGRESPONSE => array(self::ASV_1, self::REQUESTHANDLER => "MeetingResponse"),
self::COMMAND_RESOLVERECIPIENTS => array(self::ASV_1, self::REQUESTHANDLER => "ResolveRecipients"),
self::COMMAND_VALIDATECERT => array(self::ASV_1, self::REQUESTHANDLER => "ValidateCert"),
self::COMMAND_PROVISION => array(self::ASV_25, self::REQUESTHANDLER => "Provisioning", self::UNAUTHENTICATED, self::UNPROVISIONED),
self::COMMAND_SEARCH => array(self::ASV_1, self::REQUESTHANDLER => "Search"),
self::COMMAND_PING => array(self::ASV_2, self::REQUESTHANDLER => "Ping", self::UNPROVISIONED),
self::COMMAND_NOTIFY => array(self::ASV_1, self::REQUESTHANDLER => "Notify"), // deprecated & not implemented
self::COMMAND_ITEMOPERATIONS => array(self::ASV_12, self::REQUESTHANDLER => "ItemOperations"),
self::COMMAND_SETTINGS => array(self::ASV_12, self::REQUESTHANDLER => "Settings"),
self::COMMAND_WEBSERVICE_DEVICE => array(self::REQUESTHANDLER => "Webservice", self::PLAININPUT, self::NOACTIVESYNCCOMMAND, self::WEBSERVICECOMMAND),
self::COMMAND_WEBSERVICE_USERS => array(self::REQUESTHANDLER => "Webservice", self::PLAININPUT, self::NOACTIVESYNCCOMMAND, self::WEBSERVICECOMMAND),
self::COMMAND_WEBSERVICE_INFO => array(self::REQUESTHANDLER => "Webservice", self::PLAININPUT, self::NOACTIVESYNCCOMMAND, self::WEBSERVICECOMMAND),
);
static private $classes = array(
"Email" => array(
self::CLASS_NAME => "SyncMail",
self::CLASS_REQUIRESPROTOCOLVERSION => false,
self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_INBOX,
self::CLASS_OTHERTYPES => array(SYNC_FOLDER_TYPE_OTHER, SYNC_FOLDER_TYPE_DRAFTS, SYNC_FOLDER_TYPE_WASTEBASKET,
SYNC_FOLDER_TYPE_SENTMAIL, SYNC_FOLDER_TYPE_OUTBOX, SYNC_FOLDER_TYPE_USER_MAIL,
SYNC_FOLDER_TYPE_JOURNAL, SYNC_FOLDER_TYPE_USER_JOURNAL),
),
"Contacts" => array(
self::CLASS_NAME => "SyncContact",
self::CLASS_REQUIRESPROTOCOLVERSION => true,
self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_CONTACT,
self::CLASS_OTHERTYPES => array(SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_UNKNOWN),
),
"Calendar" => array(
self::CLASS_NAME => "SyncAppointment",
self::CLASS_REQUIRESPROTOCOLVERSION => false,
self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_APPOINTMENT,
self::CLASS_OTHERTYPES => array(SYNC_FOLDER_TYPE_USER_APPOINTMENT),
),
"Tasks" => array(
self::CLASS_NAME => "SyncTask",
self::CLASS_REQUIRESPROTOCOLVERSION => false,
self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_TASK,
self::CLASS_OTHERTYPES => array(SYNC_FOLDER_TYPE_USER_TASK),
),
"Notes" => array(
self::CLASS_NAME => "SyncNote",
self::CLASS_REQUIRESPROTOCOLVERSION => false,
self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_NOTE,
self::CLASS_OTHERTYPES => array(SYNC_FOLDER_TYPE_USER_NOTE),
),
);
static private $stateMachine;
static private $searchProvider;
static private $deviceManager;
static private $topCollector;
static private $backend;
static private $addSyncFolders;
static private $policies;
/**
* Verifies configuration
*
* @access public
* @return boolean
* @throws FatalMisconfigurationException
*/
static public function CheckConfig() {
// check the php version
if (version_compare(phpversion(),'5.4.0') < 0) {
throw new FatalException("The configured PHP version is too old. Please make sure at least PHP 5.4 is used.");
}
// some basic checks
if (!defined('BASE_PATH'))
throw new FatalMisconfigurationException("The BASE_PATH is not configured. Check if the config.php file is in place.");
if (substr(BASE_PATH, -1,1) != "/")
throw new FatalMisconfigurationException("The BASE_PATH should terminate with a '/'");
if (!file_exists(BASE_PATH))
throw new FatalMisconfigurationException("The configured BASE_PATH does not exist or can not be accessed.");
if (defined('BASE_PATH_CLI') && file_exists(BASE_PATH_CLI))
define('REAL_BASE_PATH', BASE_PATH_CLI);
else
define('REAL_BASE_PATH', BASE_PATH);
if (!defined('LOGBACKEND')) {
define('LOGBACKEND', 'filelog');
}
if (strtolower(LOGBACKEND) == 'syslog') {
define('LOGBACKEND_CLASS', 'Syslog');
if (!defined('LOG_SYSLOG_FACILITY')) {
define('LOG_SYSLOG_FACILITY', LOG_LOCAL0);
}
if (!defined('LOG_SYSLOG_HOST')) {
define('LOG_SYSLOG_HOST', false);
}
if (!defined('LOG_SYSLOG_PORT')) {
define('LOG_SYSLOG_PORT', 514);
}
if (!defined('LOG_SYSLOG_PROGRAM')) {
define('LOG_SYSLOG_PROGRAM', 'z-push');
}
if (!is_numeric(LOG_SYSLOG_PORT)) {
throw new FatalMisconfigurationException("The LOG_SYSLOG_PORT must a be a number.");
}
if (LOG_SYSLOG_HOST && LOG_SYSLOG_PORT <= 0) {
throw new FatalMisconfigurationException("LOG_SYSLOG_HOST is defined but the LOG_SYSLOG_PORT does not seem to be valid.");
}
}
elseif (strtolower(LOGBACKEND) == 'filelog') {
define('LOGBACKEND_CLASS', 'FileLog');
if (!defined('LOGFILEDIR'))
throw new FatalMisconfigurationException("The LOGFILEDIR is not configured. Check if the config.php file is in place.");
if (substr(LOGFILEDIR, -1,1) != "/")
throw new FatalMisconfigurationException("The LOGFILEDIR should terminate with a '/'");
if (!file_exists(LOGFILEDIR))
throw new FatalMisconfigurationException("The configured LOGFILEDIR does not exist or can not be accessed.");
if ((!file_exists(LOGFILE) && !touch(LOGFILE)) || !is_writable(LOGFILE))
throw new FatalMisconfigurationException("The configured LOGFILE can not be modified.");
if ((!file_exists(LOGERRORFILE) && !touch(LOGERRORFILE)) || !is_writable(LOGERRORFILE))
throw new FatalMisconfigurationException("The configured LOGERRORFILE can not be modified.");
// check ownership on the (eventually) just created files
Utils::FixFileOwner(LOGFILE);
Utils::FixFileOwner(LOGERRORFILE);
}
else {
define('LOGBACKEND_CLASS', LOGBACKEND);
}
// set time zone
// code contributed by Robert Scheck (rsc)
if(defined('TIMEZONE') ? constant('TIMEZONE') : false) {
if (! @date_default_timezone_set(TIMEZONE))
throw new FatalMisconfigurationException(sprintf("The configured TIMEZONE '%s' is not valid. Please check supported timezones at http://www.php.net/manual/en/timezones.php", constant('TIMEZONE')));
}
else if(!ini_get('date.timezone')) {
date_default_timezone_set('Europe/Amsterdam');
}
// check if Provisioning is enabled and the default policies are available
if (PROVISIONING) {
if (file_exists(REAL_BASE_PATH . PROVISIONING_POLICYFILE)) {
$policyfile = REAL_BASE_PATH . PROVISIONING_POLICYFILE;
}
else {
$policyfile = PROVISIONING_POLICYFILE;
}
ZPush::$policies = parse_ini_file($policyfile, true);
if (!isset(ZPush::$policies['default'])) {
throw new FatalMisconfigurationException(sprintf("Your policies' configuration file doesn't contain the required [default] section. Please check the '%s' file.", $policyfile));
}
}
if (defined('USE_X_FORWARDED_FOR_HEADER')) {
ZLog::Write(LOGLEVEL_INFO, "The configuration parameter 'USE_X_FORWARDED_FOR_HEADER' was deprecated in favor of 'USE_CUSTOM_REMOTE_IP_HEADER'. Please update your configuration.");
}
//check folder re-sync triggering settings
if(defined('DELETION_RATIO_THR') || defined('DELETION_COUNT_THR') || defined('DELETION_COUNT_LIMIT')){
if (!defined('DELETION_RATIO_THR')) {
throw new FatalMisconfigurationException("Please define DELETION_RATIO_THR.");
}
elseif (!defined('DELETION_COUNT_THR')) {
throw new FatalMisconfigurationException("Please define DELETION_COUNT_THR.");
}
elseif (!defined('DELETION_COUNT_LIMIT')) {
throw new FatalMisconfigurationException("Please define DELETION_COUNT_LIMIT.");
}
elseif (!is_numeric(DELETION_RATIO_THR) || DELETION_RATIO_THR <= 0) {
throw new FatalMisconfigurationException("The DELETION_RATIO_THR value must be a number higher than 0.");
}
elseif (!is_int(DELETION_COUNT_THR) || DELETION_COUNT_THR < 1) {
throw new FatalMisconfigurationException("The DELETION_COUNT_THR value must be a number higher than 0.");
}
elseif (!is_int(DELETION_COUNT_LIMIT) || DELETION_COUNT_LIMIT <= DELETION_COUNT_THR) {
throw new FatalMisconfigurationException("The DELETION_COUNT_LIMIT value must be a positive number higher than DELETION_COUNT_THR.");
}
}
//check retry loop settings when writing/reading file state machine data to disk
if ((defined('FILE_STATE_ATTEMPTS')) && (!is_int(FILE_STATE_ATTEMPTS) || FILE_STATE_ATTEMPTS < 1)) {
throw new FatalMisconfigurationException("The FILE_STATE_ATTEMPTS value must be a number higher than 0.");
}
if ((defined('FILE_STATE_SLEEP')) && (!is_int(FILE_STATE_SLEEP) || FILE_STATE_SLEEP < 1)) {
throw new FatalMisconfigurationException("The FILE_STATE_SLEEP value must be a number higher than 0.");
}
if (defined('FILE_STATE_WRITE_ATTEMPTS') || defined('FILE_STATE_WRITE_SLEEP')){
throw new FatalMisconfigurationException("The configuration parameter 'FILE_STATE_WRITE_ATTEMPTS' and 'FILE_STATE_WRITE_SLEEP' were deprecated in favor of 'FILE_STATE_ATTEMPTS' and 'FILE_STATE_SLEEP'. Please update your configuration.");
}
//check retry loop settings when writing file state machine data to disk
if ((defined('FILE_STATE_WRITE_ATTEMPTS')) && (!is_int(FILE_STATE_WRITE_ATTEMPTS) || FILE_STATE_WRITE_ATTEMPTS < 1)) {
throw new FatalMisconfigurationException("The FILE_STATE_WRITE_ATTEMPTS value must be a number higher than 0.");
}
if ((defined('FILE_STATE_WRITE_SLEEP')) && (!is_int(FILE_STATE_WRITE_SLEEP) || FILE_STATE_WRITE_SLEEP < 1)) {
throw new FatalMisconfigurationException("The FILE_STATE_WRITE_SLEEP value must be a number higher than 0.");
}
return true;
}
/**
* Verifies Timezone, StateMachine and Backend configuration
*
* @access public
* @return boolean
* @trows FatalMisconfigurationException
*/
static public function CheckAdvancedConfig() {
global $specialLogUsers, $additionalFolders;
if (!is_array($specialLogUsers))
throw new FatalMisconfigurationException("The WBXML log users is not an array.");
if (!defined('SYNC_CONTACTS_MAXPICTURESIZE')) {
define('SYNC_CONTACTS_MAXPICTURESIZE', 49152);
}
else if ((!is_int(SYNC_CONTACTS_MAXPICTURESIZE) || SYNC_CONTACTS_MAXPICTURESIZE < 1))
throw new FatalMisconfigurationException("The SYNC_CONTACTS_MAXPICTURESIZE value must be a number higher than 0.");
if (!defined('USE_PARTIAL_FOLDERSYNC')) {
define('USE_PARTIAL_FOLDERSYNC', false);
}
if (!defined('PING_LOWER_BOUND_LIFETIME')) {
define('PING_LOWER_BOUND_LIFETIME', false);
}
elseif(PING_LOWER_BOUND_LIFETIME !== false && (!is_int(PING_LOWER_BOUND_LIFETIME) || PING_LOWER_BOUND_LIFETIME < 1 || PING_LOWER_BOUND_LIFETIME > 3540)){
throw new FatalMisconfigurationException("The PING_LOWER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
}
if (!defined('PING_HIGHER_BOUND_LIFETIME')) {
define('PING_HIGHER_BOUND_LIFETIME', false);
}
elseif(PING_HIGHER_BOUND_LIFETIME !== false && (!is_int(PING_HIGHER_BOUND_LIFETIME) || PING_HIGHER_BOUND_LIFETIME < 1 || PING_HIGHER_BOUND_LIFETIME > 3540)){
throw new FatalMisconfigurationException("The PING_HIGHER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
}
if(PING_HIGHER_BOUND_LIFETIME !== false && PING_LOWER_BOUND_LIFETIME !== false && PING_HIGHER_BOUND_LIFETIME < PING_LOWER_BOUND_LIFETIME){
throw new FatalMisconfigurationException("The PING_HIGHER_BOUND_LIFETIME value must be greater or equal to PING_LOWER_BOUND_LIFETIME.");
}
if (!defined('RETRY_AFTER_DELAY')) {
define('RETRY_AFTER_DELAY', 300);
}
elseif (RETRY_AFTER_DELAY !== false && (!is_int(RETRY_AFTER_DELAY) || RETRY_AFTER_DELAY < 1)) {
throw new FatalMisconfigurationException("The RETRY_AFTER_DELAY value must be 'false' or a number greater than 0.");
}
// Check KOE flags
if (!defined('KOE_CAPABILITY_GAB')) {
define('KOE_CAPABILITY_GAB', false);
}
if (!defined('KOE_CAPABILITY_RECEIVEFLAGS')) {
define('KOE_CAPABILITY_RECEIVEFLAGS', false);
}
if (!defined('KOE_CAPABILITY_SENDFLAGS')) {
define('KOE_CAPABILITY_SENDFLAGS', false);
}
if (!defined('KOE_CAPABILITY_OOF')) {
define('KOE_CAPABILITY_OOF', false);
}
if (!defined('KOE_CAPABILITY_OOFTIMES')) {
define('KOE_CAPABILITY_OOFTIMES', false);
}
if (!defined('KOE_CAPABILITY_NOTES')) {
define('KOE_CAPABILITY_NOTES', false);
}
if (!defined('KOE_CAPABILITY_SHAREDFOLDER')) {
define('KOE_CAPABILITY_SHAREDFOLDER', false);
}
if (!defined('KOE_GAB_FOLDERID')) {
define('KOE_GAB_FOLDERID', '');
}
if (!defined('KOE_GAB_STORE')) {
define('KOE_GAB_STORE', '');
}
if (!defined('KOE_GAB_NAME')) {
define('KOE_GAB_NAME', false);
}
// the check on additional folders will not throw hard errors, as this is probably changed on live systems
if (isset($additionalFolders) && !is_array($additionalFolders))
ZLog::Write(LOGLEVEL_ERROR, "ZPush::CheckConfig() : The additional folders synchronization not available as array.");
else {
// check configured data
foreach ($additionalFolders as $af) {
if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
ZLog::Write(LOGLEVEL_ERROR, "ZPush::CheckConfig() : the additional folder synchronization is not configured correctly. Missing parameters. Entry will be ignored.");
continue;
}
if ($af['store'] == "" || $af['folderid'] == "" || $af['name'] == "" || $af['type'] == "") {
ZLog::Write(LOGLEVEL_WARN, "ZPush::CheckConfig() : the additional folder synchronization is not configured correctly. Empty parameters. Entry will be ignored.");
continue;
}
if (!in_array($af['type'], array(SYNC_FOLDER_TYPE_USER_NOTE, SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_USER_APPOINTMENT, SYNC_FOLDER_TYPE_USER_TASK, SYNC_FOLDER_TYPE_USER_MAIL))) {
ZLog::Write(LOGLEVEL_ERROR, sprintf("ZPush::CheckConfig() : the type of the additional synchronization folder '%s is not permitted.", $af['name']));
continue;
}
// the data will be inizialized when used via self::getAddFolders()
}
}
ZLog::Write(LOGLEVEL_DEBUG, sprintf("Used timezone '%s'", date_default_timezone_get()));
// get the statemachine, which will also try to load the backend.. This could throw errors
self::GetStateMachine();
}
/**
* Returns the StateMachine object
* which has to be an IStateMachine implementation
*
* @access public
* @throws FatalNotImplementedException
* @throws HTTPReturnCodeException
* @return object implementation of IStateMachine
*/
static public function GetStateMachine() {
if (!isset(ZPush::$stateMachine)) {
// the backend could also return an own IStateMachine implementation
$backendStateMachine = self::GetBackend()->GetStateMachine();
// if false is returned, use the default StateMachine
if ($backendStateMachine !== false) {
ZLog::Write(LOGLEVEL_DEBUG, "Backend implementation of IStateMachine: ".get_class($backendStateMachine));
if (in_array('IStateMachine', class_implements($backendStateMachine)))
ZPush::$stateMachine = $backendStateMachine;
else
throw new FatalNotImplementedException("State machine returned by the backend does not implement the IStateMachine interface!");
}
else {
// Initialize the default StateMachine
if (defined('STATE_MACHINE') && STATE_MACHINE == 'SQL') {
ZPush::$stateMachine = new SqlStateMachine();
}
else {
ZPush::$stateMachine = new FileStateMachine();
}
}
if (ZPush::$stateMachine->GetStateVersion() !== ZPush::GetLatestStateVersion()) {
if (class_exists("TopCollector")) self::GetTopCollector()->AnnounceInformation("Run migration script!", true);
throw new ServiceUnavailableException(sprintf("The state version available to the %s is not the latest version - please run the state upgrade script. See release notes for more information.", get_class(ZPush::$stateMachine)));
}
}
return ZPush::$stateMachine;
}
/**
* Returns the latest version of supported states
*
* @access public
* @return int
*/
static public function GetLatestStateVersion() {
return self::STATE_VERSION;
}
/**
* Returns the DeviceManager object
*
* @param boolean $initialize (opt) default true: initializes the DeviceManager if not already done
*
* @access public
* @return object DeviceManager
*/
static public function GetDeviceManager($initialize = true) {
if (!isset(ZPush::$deviceManager) && $initialize)
ZPush::$deviceManager = new DeviceManager();
return ZPush::$deviceManager;
}
/**
* Load another device in the DeviceManager and return it.
*
* @param ASDevice $asDevice
* @param boolean $initialize - default: true
* @return DeviceManager
*/
static public function GetDeviceManagerWithDevice($asDevice, $initialize = true) {
$dm = ZPush::GetDeviceManager($initialize);
if ($dm) {
$dm->SetDevice($asDevice);
}
return $dm;
}
/**
* Returns the Top data collector object
*
* @access public
* @return object TopCollector
*/
static public function GetTopCollector() {
if (!isset(ZPush::$topCollector))
ZPush::$topCollector = new TopCollector();
return ZPush::$topCollector;
}
/**
* Loads a backend file
*
* @param string $backendname
* @access public
* @throws FatalNotImplementedException
* @return boolean
*/
static public function IncludeBackend($backendname) {
if ($backendname == false) return false;
$backendname = strtolower($backendname);
if (substr($backendname, 0, 7) !== 'backend')
throw new FatalNotImplementedException(sprintf("Backend '%s' is not allowed",$backendname));
$rbn = substr($backendname, 7);
$subdirbackend = REAL_BASE_PATH . "backend/" . $rbn . "/" . $rbn . ".php";
$stdbackend = REAL_BASE_PATH . "backend/" . $rbn . ".php";
if (is_file($subdirbackend))
$toLoad = $subdirbackend;
else if (is_file($stdbackend))
$toLoad = $stdbackend;
else
return false;
ZLog::Write(LOGLEVEL_DEBUG, sprintf("Including backend file: '%s'", $toLoad));
return include_once($toLoad);
}
/**
* Returns the SearchProvider object
* which has to be an ISearchProvider implementation
*
* @access public
* @return object implementation of ISearchProvider
* @throws FatalMisconfigurationException, FatalNotImplementedException
*/
static public function GetSearchProvider() {
if (!isset(ZPush::$searchProvider)) {
// is a global searchprovider configured ? It will outrank the backend
if (defined('SEARCH_PROVIDER') && @constant('SEARCH_PROVIDER') != "") {
$searchClass = @constant('SEARCH_PROVIDER');
if (! class_exists($searchClass))
self::IncludeBackend($searchClass);
if (class_exists($searchClass))
$aSearchProvider = new $searchClass();
else
throw new FatalMisconfigurationException(sprintf("Search provider '%s' can not be loaded. Check configuration!", $searchClass));
}
// get the searchprovider from the backend
else
$aSearchProvider = self::GetBackend()->GetSearchProvider();
if (in_array('ISearchProvider', class_implements($aSearchProvider)))
ZPush::$searchProvider = $aSearchProvider;
else
throw new FatalNotImplementedException("Instantiated SearchProvider does not implement the ISearchProvider interface!");
}
return ZPush::$searchProvider;
}
/**
* Returns the Backend for this request
* the backend has to be an IBackend implementation
*
* @access public
* @return object IBackend implementation
*/
static public function GetBackend() {
// if the backend is not yet loaded, load backend drivers and instantiate it
if (!isset(ZPush::$backend)) {
// Initialize our backend
$ourBackend = @constant('BACKEND_PROVIDER');
// if no backend provider is defined, try to include automatically
if ($ourBackend == false || $ourBackend == "") {
foreach (self::$autoloadBackendPreference as $autoloadBackend) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::GetBackend(): trying autoload backend '%s'", $autoloadBackend));
if (class_exists($autoloadBackend)) {
$ourBackend = $autoloadBackend;
break;
}
}
if (!$ourBackend)
throw new FatalMisconfigurationException("No Backend provider can be found. Check your installation and/or configuration!");
}
elseif (!class_exists($ourBackend)) {
\ZPush::IncludeBackend($ourBackend);
}
if (class_exists($ourBackend))
ZPush::$backend = new $ourBackend();
else
throw new FatalMisconfigurationException(sprintf("Backend provider '%s' can not be loaded. Check configuration!", $ourBackend));
}
return ZPush::$backend;
}
/**
* Returns additional folder objects which should be synchronized to the device
*
* @param boolean $backendIdsAsKeys if true the keys are backendids else folderids, default: true
*
* @access public
* @return array
*/
static public function GetAdditionalSyncFolders($backendIdsAsKeys = true) {
// get user based folders which should be synchronized
$userFolder = self::GetDeviceManager()->GetAdditionalUserSyncFolders();
$addfolders = self::getAddSyncFolders() + $userFolder;
// if requested, we rewrite the backendids to folderids here
if ($backendIdsAsKeys === false && !empty($addfolders)) {
ZLog::Write(LOGLEVEL_DEBUG, "ZPush::GetAdditionalSyncFolders(): Requested AS folderids as keys for additional folders array, converting");
$faddfolders = array();
foreach ($addfolders as $backendId => $addFolder) {
$fid = self::GetDeviceManager()->GetFolderIdForBackendId($backendId);
$faddfolders[$fid] = $addFolder;
}
$addfolders = $faddfolders;
}
return $addfolders;
}
/**
* Returns additional folder objects which should be synchronized to the device
*
* @param string $backendid
* @param boolean $noDebug (opt) by default, debug message is shown
*
* @access public
* @return string
*/
static public function GetAdditionalSyncFolderStore($backendid, $noDebug = false) {
if(isset(self::getAddSyncFolders()[$backendid]->Store)) {
$val = self::getAddSyncFolders()[$backendid]->Store;
}
else {
$val = self::GetDeviceManager()->GetAdditionalUserSyncFolder($backendid);
if (isset($val['store'])) {
$val = $val['store'];
}
}
if (!$noDebug)
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::GetAdditionalSyncFolderStore('%s'): '%s'", $backendid, Utils::PrintAsString($val)));
return $val;
}
/**
* Returns a SyncObject class name for a folder class
*
* @param string $folderclass
*
* @access public
* @return string
* @throws FatalNotImplementedException
*/
static public function getSyncObjectFromFolderClass($folderclass) {
if (!isset(self::$classes[$folderclass]))
throw new FatalNotImplementedException("Class '$folderclass' is not supported");
$class = self::$classes[$folderclass][self::CLASS_NAME];
if (self::$classes[$folderclass][self::CLASS_REQUIRESPROTOCOLVERSION])
return new $class(Request::GetProtocolVersion());
else
return new $class();
}
/**
* Initializes the SyncObjects for additional folders on demand.
* Uses DeviceManager->BuildSyncFolderObject() to do patching required for ZP-907.
*
* @access private
* @return array
*/
static private function getAddSyncFolders() {
global $additionalFolders;
if (!isset(self::$addSyncFolders)) {
self::$addSyncFolders = array();
if (isset($additionalFolders) && !is_array($additionalFolders)) {
ZLog::Write(LOGLEVEL_ERROR, "ZPush::getAddSyncFolders() : The additional folders synchronization not available as array.");
}
else {
foreach ($additionalFolders as $af) {
if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
ZLog::Write(LOGLEVEL_ERROR, "ZPush::getAddSyncFolders() : the additional folder synchronization is not configured correctly. Missing parameters. Entry will be ignored.");
continue;
}
if ($af['store'] == "" || $af['folderid'] == "" || $af['name'] == "" || $af['type'] == "") {
ZLog::Write(LOGLEVEL_WARN, "ZPush::getAddSyncFolders() : the additional folder synchronization is not configured correctly. Empty parameters. Entry will be ignored.");
continue;
}
if (!in_array($af['type'], array(SYNC_FOLDER_TYPE_USER_NOTE, SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_USER_APPOINTMENT, SYNC_FOLDER_TYPE_USER_TASK, SYNC_FOLDER_TYPE_USER_MAIL))) {
ZLog::Write(LOGLEVEL_ERROR, sprintf("ZPush::getAddSyncFolders() : the type of the additional synchronization folder '%s is not permitted.", $af['name']));
continue;
}
// don't fail hard if no flags are set, but we at least warn about it
if (!isset($af['flags'])) {
ZLog::Write(LOGLEVEL_WARN, sprintf("ZPush::getAddSyncFolders() : the additional folder '%s' is not configured completely. Missing 'flags' parameter, defaulting to DeviceManager::FLD_FLAGS_NONE.", $af['name']));
$af['flags'] = DeviceManager::FLD_FLAGS_NONE;
}
$folder = self::GetDeviceManager()->BuildSyncFolderObject($af['store'], $af['folderid'], '0', $af['name'], $af['type'], $af['flags'], DeviceManager::FLD_ORIGIN_CONFIG);
self::$addSyncFolders[$folder->BackendId] = $folder;
}
}
}
return self::$addSyncFolders;
}
/**
* Returns the default foldertype for a folder class
*
* @param string $folderclass folderclass sent by the mobile
*
* @access public
* @return string
*/
static public function getDefaultFolderTypeFromFolderClass($folderclass) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::getDefaultFolderTypeFromFolderClass('%s'): '%d'", $folderclass, self::$classes[$folderclass][self::CLASS_DEFAULTTYPE]));
return self::$classes[$folderclass][self::CLASS_DEFAULTTYPE];
}
/**
* Returns the folder class for a foldertype
*
* @param string $foldertype
*
* @access public
* @return string/false false if no class for this type is available
*/
static public function GetFolderClassFromFolderType($foldertype) {
$class = false;
foreach (self::$classes as $aClass => $cprops) {
if ($cprops[self::CLASS_DEFAULTTYPE] == $foldertype || in_array($foldertype, $cprops[self::CLASS_OTHERTYPES])) {
$class = $aClass;
break;
}
}
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::GetFolderClassFromFolderType('%s'): %s", $foldertype, Utils::PrintAsString($class)));
return $class;
}
/**
* Prints the Z-Push legal header to STDOUT
* Using this breaks ActiveSync synchronization if wbxml is expected
*
* @param string $message (opt) message to be displayed
* @param string $additionalMessage (opt) additional message to be displayed
* @access public
* @return
*
*/
static public function PrintZPushLegal($message = "", $additionalMessage = "") {
ZLog::Write(LOGLEVEL_DEBUG,"ZPush::PrintZPushLegal()");
$zpush_version = @constant('ZPUSH_VERSION');
if ($message)
$message = "<h3>". $message . "</h3>";
if ($additionalMessage)
$additionalMessage .= "<br>";
header("Content-type: text/html");
print <<<END
<html>
<header>
<title>Z-Push ActiveSync</title>
</header>
<body>
<font face="verdana">
<h2>Z-Push - Open Source ActiveSync</h2>
<b>Version $zpush_version</b><br>
$message $additionalMessage
<br><br>
More information about Z-Push can be found at:<br>
<a href="http://z-push.org/">Z-Push homepage</a><br>
<a href="http://z-push.org/download">Z-Push download page</a><br>
<a href="https://jira.z-hub.io/browse/ZP">Z-Push Bugtracker</a><br>
<a href="https://wiki.z-hub.io/display/ZP">Z-Push Wiki</a> and <a href="https://wiki.z-hub.io/display/ZP/Roadmap">Roadmap</a><br>
<br>
All modifications to this sourcecode must be published and returned to the community.<br>
Please see <a href="http://www.gnu.org/licenses/agpl-3.0.html">AGPLv3 License</a> for details.<br>
</font face="verdana">
</body>
</html>
END;
}
/**
* Indicates the latest AS version supported by Z-Push
*
* @access public
* @return string
*/
static public function GetLatestSupportedASVersion() {
return end(self::$supportedASVersions);
}
/**
* Indicates which is the highest AS version supported by the backend
*
* @access public
* @return string
* @throws FatalNotImplementedException if the backend returns an invalid version
*/
static public function GetSupportedASVersion() {
$version = self::GetBackend()->GetSupportedASVersion();
if (!in_array($version, self::$supportedASVersions))
throw new FatalNotImplementedException(sprintf("AS version '%s' reported by the backend is not supported", $version));
return $version;
}
/**
* Returns AS server header
*
* @access public
* @return string
*/
static public function GetServerHeader() {
if (self::GetSupportedASVersion() == self::ASV_25)
return "MS-Server-ActiveSync: 6.5.7638.1";
else
return "MS-Server-ActiveSync: ". self::GetSupportedASVersion();
}
/**
* Returns AS protocol versions which are supported
*
* @param boolean $valueOnly (opt) default: false (also returns the header name)
*
* @access public
* @return string
*/
static public function GetSupportedProtocolVersions($valueOnly = false) {
$versions = implode(',', array_slice(self::$supportedASVersions, 0, (array_search(self::GetSupportedASVersion(), self::$supportedASVersions)+1)));
ZLog::Write(LOGLEVEL_DEBUG, "ZPush::GetSupportedProtocolVersions(): " . $versions);
if ($valueOnly === true)
return $versions;
return "MS-ASProtocolVersions: " . $versions;
}
/**
* Returns AS commands which are supported
*
* @access public
* @return string
*/
static public function GetSupportedCommands() {
$asCommands = array();
// filter all non-activesync commands
foreach (self::$supportedCommands as $c=>$v)
if (!self::checkCommandOptions($c, self::NOACTIVESYNCCOMMAND) &&
self::checkCommandOptions($c, self::GetSupportedASVersion()))
$asCommands[] = Utils::GetCommandFromCode($c);
$commands = implode(',', $asCommands);
ZLog::Write(LOGLEVEL_DEBUG, "ZPush::GetSupportedCommands(): " . $commands);
return "MS-ASProtocolCommands: " . $commands;
}
/**
* Loads and instantiates a request processor for a command
*
* @param int $commandCode
*
* @access public
* @return RequestProcessor sub-class
*/
static public function GetRequestHandlerForCommand($commandCode) {
if (!array_key_exists($commandCode, self::$supportedCommands) ||
!array_key_exists(self::REQUESTHANDLER, self::$supportedCommands[$commandCode]) )
throw new FatalNotImplementedException(sprintf("Command '%s' has no request handler or class", Utils::GetCommandFromCode($commandCode)));
$class = self::$supportedCommands[$commandCode][self::REQUESTHANDLER];
if ($class == "Webservice")
$handlerclass = REAL_BASE_PATH . "lib/webservice/webservice.php";
else
$handlerclass = REAL_BASE_PATH . "lib/request/" . strtolower($class) . ".php";
if (is_file($handlerclass))
include($handlerclass);
if (class_exists($class))
return new $class();
else
throw new FatalNotImplementedException(sprintf("Request handler '%s' can not be loaded", $class));
}
/**
* Indicates if a commands requires authentication or not
*
* @param int $commandCode
*
* @access public
* @return boolean
*/
static public function CommandNeedsAuthentication($commandCode) {
$stat = ! self::checkCommandOptions($commandCode, self::UNAUTHENTICATED);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::CommandNeedsAuthentication(%d): %s", $commandCode, Utils::PrintAsString($stat)));
return $stat;
}
/**
* Indicates if the Provisioning check has to be forced on these commands
*
* @param string $commandCode
* @access public
* @return boolean
*/
static public function CommandNeedsProvisioning($commandCode) {
$stat = ! self::checkCommandOptions($commandCode, self::UNPROVISIONED);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::CommandNeedsProvisioning(%s): %s", $commandCode, Utils::PrintAsString($stat)));
return $stat;
}
/**
* Indicates if these commands expect plain text input instead of wbxml
*
* @param string $commandCode
*
* @access public
* @return boolean
*/
static public function CommandNeedsPlainInput($commandCode) {
$stat = self::checkCommandOptions($commandCode, self::PLAININPUT);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::CommandNeedsPlainInput(%d): %s", $commandCode, Utils::PrintAsString($stat)));
return $stat;
}
/**
* Indicates if the comand to be executed operates on the hierarchy
*
* @param int $commandCode
* @access public
* @return boolean
*/
static public function HierarchyCommand($commandCode) {
$stat = self::checkCommandOptions($commandCode, self::HIERARCHYCOMMAND);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPush::HierarchyCommand(%d): %s", $commandCode, Utils::PrintAsString($stat)));
return $stat;
}
/**
* Checks access types of a command
*
* @param string $commandCode a commandCode
* @param string $option e.g. self::UNAUTHENTICATED
* @access private
* @throws FatalNotImplementedException
* @return object StateMachine
*/
static private function checkCommandOptions($commandCode, $option) {
if ($commandCode === false) return false;
if (!array_key_exists($commandCode, self::$supportedCommands))
throw new FatalNotImplementedException(sprintf("Command '%s' is not supported", Utils::GetCommandFromCode($commandCode)));
$capa = self::$supportedCommands[$commandCode];
$defcapa = in_array($option, $capa, true);
// if not looking for a default capability, check if the command is supported since a previous AS version
if (!$defcapa) {
$verkey = array_search($option, self::$supportedASVersions, true);
if ($verkey !== false && ($verkey >= array_search($capa[0], self::$supportedASVersions))) {
$defcapa = true;
}
}
return $defcapa;
}
/**
* Returns the available provisioning policies.
*
* @return array
*/
static public function GetPolicies() {
// TODO another policy providers might be available, e.g. for sqlstatemachine
return ZPush::$policies;
}
}