mirror of
https://github.com/YunoHost-Apps/z-push_ynh.git
synced 2024-09-03 18:05:58 +02:00
295 lines
No EOL
14 KiB
PHP
295 lines
No EOL
14 KiB
PHP
<?php
|
|
/***********************************************
|
|
* File : index.php
|
|
* Project : Z-Push
|
|
* Descr : This is the entry point
|
|
* through which all requests
|
|
* are processed.
|
|
*
|
|
* Created : 01.10.2007
|
|
*
|
|
* 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
|
|
************************************************/
|
|
|
|
ob_start(null, 1048576);
|
|
|
|
// ignore user abortions because this can lead to weird errors - see ZP-239
|
|
ignore_user_abort(true);
|
|
|
|
include_once('lib/exceptions/exceptions.php');
|
|
include_once('lib/utils/utils.php');
|
|
include_once('lib/utils/compat.php');
|
|
include_once('lib/utils/timezoneutil.php');
|
|
include_once('lib/core/zpushdefs.php');
|
|
include_once('lib/core/stateobject.php');
|
|
include_once('lib/core/interprocessdata.php');
|
|
include_once('lib/core/pingtracking.php');
|
|
include_once('lib/core/topcollector.php');
|
|
include_once('lib/core/loopdetection.php');
|
|
include_once('lib/core/asdevice.php');
|
|
include_once('lib/core/statemanager.php');
|
|
include_once('lib/core/devicemanager.php');
|
|
include_once('lib/core/zpush.php');
|
|
include_once('lib/core/zlog.php');
|
|
include_once('lib/core/paddingfilter.php');
|
|
include_once('lib/interface/ibackend.php');
|
|
include_once('lib/interface/ichanges.php');
|
|
include_once('lib/interface/iexportchanges.php');
|
|
include_once('lib/interface/iimportchanges.php');
|
|
include_once('lib/interface/isearchprovider.php');
|
|
include_once('lib/interface/istatemachine.php');
|
|
include_once('lib/core/streamer.php');
|
|
include_once('lib/core/streamimporter.php');
|
|
include_once('lib/core/synccollections.php');
|
|
include_once('lib/core/hierarchycache.php');
|
|
include_once('lib/core/changesmemorywrapper.php');
|
|
include_once('lib/core/syncparameters.php');
|
|
include_once('lib/core/bodypreference.php');
|
|
include_once('lib/core/contentparameters.php');
|
|
include_once('lib/wbxml/wbxmldefs.php');
|
|
include_once('lib/wbxml/wbxmldecoder.php');
|
|
include_once('lib/wbxml/wbxmlencoder.php');
|
|
include_once('lib/syncobjects/syncobject.php');
|
|
include_once('lib/syncobjects/syncbasebody.php');
|
|
include_once('lib/syncobjects/syncbaseattachment.php');
|
|
include_once('lib/syncobjects/syncmailflags.php');
|
|
include_once('lib/syncobjects/syncrecurrence.php');
|
|
include_once('lib/syncobjects/syncappointment.php');
|
|
include_once('lib/syncobjects/syncappointmentexception.php');
|
|
include_once('lib/syncobjects/syncattachment.php');
|
|
include_once('lib/syncobjects/syncattendee.php');
|
|
include_once('lib/syncobjects/syncmeetingrequestrecurrence.php');
|
|
include_once('lib/syncobjects/syncmeetingrequest.php');
|
|
include_once('lib/syncobjects/syncmail.php');
|
|
include_once('lib/syncobjects/syncnote.php');
|
|
include_once('lib/syncobjects/synccontact.php');
|
|
include_once('lib/syncobjects/syncfolder.php');
|
|
include_once('lib/syncobjects/syncprovisioning.php');
|
|
include_once('lib/syncobjects/synctaskrecurrence.php');
|
|
include_once('lib/syncobjects/synctask.php');
|
|
include_once('lib/syncobjects/syncoofmessage.php');
|
|
include_once('lib/syncobjects/syncoof.php');
|
|
include_once('lib/syncobjects/syncuserinformation.php');
|
|
include_once('lib/syncobjects/syncdeviceinformation.php');
|
|
include_once('lib/syncobjects/syncdevicepassword.php');
|
|
include_once('lib/syncobjects/syncitemoperationsattachment.php');
|
|
include_once('lib/syncobjects/syncsendmail.php');
|
|
include_once('lib/syncobjects/syncsendmailsource.php');
|
|
include_once('lib/syncobjects/syncvalidatecert.php');
|
|
include_once('lib/syncobjects/syncresolverecipients.php');
|
|
include_once('lib/syncobjects/syncresolverecipient.php');
|
|
include_once('lib/syncobjects/syncresolverecipientsoptions.php');
|
|
include_once('lib/syncobjects/syncresolverecipientsavailability.php');
|
|
include_once('lib/syncobjects/syncresolverecipientscertificates.php');
|
|
include_once('lib/syncobjects/syncresolverecipientspicture.php');
|
|
include_once('lib/default/backend.php');
|
|
include_once('lib/default/searchprovider.php');
|
|
include_once('lib/request/request.php');
|
|
include_once('lib/request/requestprocessor.php');
|
|
|
|
include_once('config.php');
|
|
include_once('version.php');
|
|
|
|
|
|
// Attempt to set maximum execution time
|
|
ini_set('max_execution_time', SCRIPT_TIMEOUT);
|
|
set_time_limit(SCRIPT_TIMEOUT);
|
|
|
|
try {
|
|
// check config & initialize the basics
|
|
ZPush::CheckConfig();
|
|
Request::Initialize();
|
|
ZLog::Initialize();
|
|
|
|
ZLog::Write(LOGLEVEL_DEBUG,"-------- Start");
|
|
ZLog::Write(LOGLEVEL_INFO,
|
|
sprintf("Version='%s' method='%s' from='%s' cmd='%s' getUser='%s' devId='%s' devType='%s'",
|
|
@constant('ZPUSH_VERSION'), Request::GetMethod(), Request::GetRemoteAddr(),
|
|
Request::GetCommand(), Request::GetGETUser(), Request::GetDeviceID(), Request::GetDeviceType()));
|
|
|
|
// Stop here if this is an OPTIONS request
|
|
if (Request::IsMethodOPTIONS())
|
|
throw new NoPostRequestException("Options request", NoPostRequestException::OPTIONS_REQUEST);
|
|
|
|
ZPush::CheckAdvancedConfig();
|
|
|
|
// Process request headers and look for AS headers
|
|
Request::ProcessHeaders();
|
|
|
|
// Check required GET parameters
|
|
if(Request::IsMethodPOST() && (Request::GetCommandCode() === false || !Request::GetDeviceID() || !Request::GetDeviceType()))
|
|
throw new FatalException("Requested the Z-Push URL without the required GET parameters");
|
|
|
|
// Load the backend
|
|
$backend = ZPush::GetBackend();
|
|
|
|
// always request the authorization header
|
|
if (! Request::AuthenticationInfo() || !Request::GetGETUser())
|
|
throw new AuthenticationRequiredException("Access denied. Please send authorisation information");
|
|
|
|
// check the provisioning information
|
|
if (PROVISIONING === true && Request::IsMethodPOST() && ZPush::CommandNeedsProvisioning(Request::GetCommandCode()) &&
|
|
((Request::WasPolicyKeySent() && Request::GetPolicyKey() == 0) || ZPush::GetDeviceManager()->ProvisioningRequired(Request::GetPolicyKey())) &&
|
|
(LOOSE_PROVISIONING === false ||
|
|
(LOOSE_PROVISIONING === true && Request::WasPolicyKeySent())))
|
|
//TODO for AS 14 send a wbxml response
|
|
throw new ProvisioningRequiredException();
|
|
|
|
// most commands require an authenticated user
|
|
if (ZPush::CommandNeedsAuthentication(Request::GetCommandCode()))
|
|
RequestProcessor::Authenticate();
|
|
|
|
// Do the actual processing of the request
|
|
if (Request::IsMethodGET())
|
|
throw new NoPostRequestException("This is the Z-Push location and can only be accessed by Microsoft ActiveSync-capable devices", NoPostRequestException::GET_REQUEST);
|
|
|
|
// Do the actual request
|
|
header(ZPush::GetServerHeader());
|
|
|
|
// announce the supported AS versions (if not already sent to device)
|
|
if (ZPush::GetDeviceManager()->AnnounceASVersion()) {
|
|
$versions = ZPush::GetSupportedProtocolVersions(true);
|
|
ZLog::Write(LOGLEVEL_INFO, sprintf("Announcing latest AS version to device: %s", $versions));
|
|
header("X-MS-RP: ". $versions);
|
|
}
|
|
|
|
RequestProcessor::Initialize();
|
|
if(!RequestProcessor::HandleRequest())
|
|
throw new WBXMLException(ZLog::GetWBXMLDebugInfo());
|
|
|
|
// eventually the RequestProcessor wants to send other headers to the mobile
|
|
foreach (RequestProcessor::GetSpecialHeaders() as $header)
|
|
header($header);
|
|
|
|
// stream the data
|
|
$len = ob_get_length();
|
|
$data = ob_get_contents();
|
|
ob_end_clean();
|
|
|
|
// log amount of data transferred
|
|
// TODO check $len when streaming more data (e.g. Attachments), as the data will be send chunked
|
|
ZPush::GetDeviceManager()->SentData($len);
|
|
|
|
// Unfortunately, even though Z-Push can stream the data to the client
|
|
// with a chunked encoding, using chunked encoding breaks the progress bar
|
|
// on the PDA. So the data is de-chunk here, written a content-length header and
|
|
// data send as a 'normal' packet. If the output packet exceeds 1MB (see ob_start)
|
|
// then it will be sent as a chunked packet anyway because PHP will have to flush
|
|
// the buffer.
|
|
if(!headers_sent())
|
|
header("Content-Length: $len");
|
|
|
|
// send vnd.ms-sync.wbxml content type header if there is no content
|
|
// otherwise text/html content type is added which might break some devices
|
|
if ($len == 0)
|
|
header("Content-Type: application/vnd.ms-sync.wbxml");
|
|
|
|
print $data;
|
|
|
|
// destruct backend after all data is on the stream
|
|
$backend->Logoff();
|
|
}
|
|
|
|
catch (NoPostRequestException $nopostex) {
|
|
if ($nopostex->getCode() == NoPostRequestException::OPTIONS_REQUEST) {
|
|
header(ZPush::GetServerHeader());
|
|
header(ZPush::GetSupportedProtocolVersions());
|
|
header(ZPush::GetSupportedCommands());
|
|
ZLog::Write(LOGLEVEL_INFO, $nopostex->getMessage());
|
|
}
|
|
else if ($nopostex->getCode() == NoPostRequestException::GET_REQUEST) {
|
|
if (Request::GetUserAgent())
|
|
ZLog::Write(LOGLEVEL_INFO, sprintf("User-agent: '%s'", Request::GetUserAgent()));
|
|
if (!headers_sent() && $nopostex->showLegalNotice())
|
|
ZPush::PrintZPushLegal('GET not supported', $nopostex->getMessage());
|
|
}
|
|
}
|
|
|
|
catch (Exception $ex) {
|
|
if (Request::GetUserAgent())
|
|
ZLog::Write(LOGLEVEL_INFO, sprintf("User-agent: '%s'", Request::GetUserAgent()));
|
|
$exclass = get_class($ex);
|
|
|
|
if(!headers_sent()) {
|
|
if ($ex instanceof ZPushException) {
|
|
header('HTTP/1.1 '. $ex->getHTTPCodeString());
|
|
foreach ($ex->getHTTPHeaders() as $h)
|
|
header($h);
|
|
}
|
|
// something really unexpected happened!
|
|
else
|
|
header('HTTP/1.1 500 Internal Server Error');
|
|
}
|
|
else
|
|
ZLog::Write(LOGLEVEL_FATAL, "Exception: ($exclass) - headers were already sent. Message: ". $ex->getMessage());
|
|
|
|
if ($ex instanceof AuthenticationRequiredException) {
|
|
ZPush::PrintZPushLegal($exclass, sprintf('<pre>%s</pre>',$ex->getMessage()));
|
|
|
|
// log the failed login attemt e.g. for fail2ban
|
|
if (defined('LOGAUTHFAIL') && LOGAUTHFAIL != false)
|
|
ZLog::Write(LOGLEVEL_WARN, sprintf("IP: %s failed to authenticate user '%s'", Request::GetRemoteAddr(), Request::GetAuthUser()? Request::GetAuthUser(): Request::GetGETUser() ));
|
|
}
|
|
|
|
// This could be a WBXML problem.. try to get the complete request
|
|
else if ($ex instanceof WBXMLException) {
|
|
ZLog::Write(LOGLEVEL_FATAL, "Request could not be processed correctly due to a WBXMLException. Please report this.");
|
|
}
|
|
|
|
// Try to output some kind of error information. This is only possible if
|
|
// the output had not started yet. If it has started already, we can't show the user the error, and
|
|
// the device will give its own (useless) error message.
|
|
else if (!($ex instanceof ZPushException) || $ex->showLegalNotice()) {
|
|
$cmdinfo = (Request::GetCommand())? sprintf(" processing command <i>%s</i>", Request::GetCommand()): "";
|
|
$extrace = $ex->getTrace();
|
|
$trace = (!empty($extrace))? "\n\nTrace:\n". print_r($extrace,1):"";
|
|
ZPush::PrintZPushLegal($exclass . $cmdinfo, sprintf('<pre>%s</pre>',$ex->getMessage() . $trace));
|
|
}
|
|
|
|
// Announce exception to process loop detection
|
|
if (ZPush::GetDeviceManager(false))
|
|
ZPush::GetDeviceManager()->AnnounceProcessException($ex);
|
|
|
|
// Announce exception if the TopCollector if available
|
|
ZPush::GetTopCollector()->AnnounceInformation(get_class($ex), true);
|
|
}
|
|
|
|
// save device data if the DeviceManager is available
|
|
if (ZPush::GetDeviceManager(false))
|
|
ZPush::GetDeviceManager()->Save();
|
|
|
|
// end gracefully
|
|
ZLog::Write(LOGLEVEL_DEBUG, '-------- End');
|
|
?>
|