2012-01-30 19:19:51 +00:00
|
|
|
<?php
|
2023-05-21 21:05:40 +00:00
|
|
|
|
2024-05-16 15:33:30 +00:00
|
|
|
declare(strict_types=1);
|
2012-01-30 19:19:51 +00:00
|
|
|
/**
|
2024-05-23 07:26:56 +00:00
|
|
|
* SPDX-FileCopyrightText: 2020-2024 Nextcloud GmbH and Nextcloud contributors
|
|
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
2015-02-26 10:37:37 +00:00
|
|
|
*/
|
2024-05-16 15:25:13 +00:00
|
|
|
namespace OC;
|
|
|
|
|
|
|
|
use OCP\IEventSource;
|
|
|
|
use OCP\IRequest;
|
|
|
|
|
|
|
|
class EventSource implements IEventSource {
|
2024-05-16 15:33:30 +00:00
|
|
|
private bool $fallback = false;
|
|
|
|
private int $fallBackId = 0;
|
|
|
|
private bool $started = false;
|
2023-05-21 21:05:40 +00:00
|
|
|
|
2024-05-16 15:33:30 +00:00
|
|
|
public function __construct(
|
|
|
|
private IRequest $request,
|
|
|
|
) {
|
2023-05-21 21:05:40 +00:00
|
|
|
}
|
|
|
|
|
2024-05-16 15:33:30 +00:00
|
|
|
protected function init(): void {
|
2014-08-29 15:18:11 +00:00
|
|
|
if ($this->started) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$this->started = true;
|
|
|
|
|
|
|
|
// prevent php output buffering, caching and nginx buffering
|
2024-05-16 15:25:13 +00:00
|
|
|
\OC_Util::obEnd();
|
2012-01-30 19:19:51 +00:00
|
|
|
header('Cache-Control: no-cache');
|
2014-07-26 13:50:11 +00:00
|
|
|
header('X-Accel-Buffering: no');
|
2014-08-29 15:18:11 +00:00
|
|
|
$this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
|
|
|
|
if ($this->fallback) {
|
2014-08-29 15:33:10 +00:00
|
|
|
$this->fallBackId = (int)$_GET['fallback_id'];
|
2015-07-21 18:40:32 +00:00
|
|
|
/**
|
|
|
|
* FIXME: The default content-security-policy of ownCloud forbids inline
|
|
|
|
* JavaScript for security reasons. IE starting on Windows 10 will
|
|
|
|
* however also obey the CSP which will break the event source fallback.
|
|
|
|
*
|
|
|
|
* As a workaround thus we set a custom policy which allows the execution
|
|
|
|
* of inline JavaScript.
|
|
|
|
*
|
|
|
|
* @link https://github.com/owncloud/core/issues/14286
|
|
|
|
*/
|
|
|
|
header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
|
2012-01-30 19:19:51 +00:00
|
|
|
header("Content-Type: text/html");
|
2014-08-29 15:18:11 +00:00
|
|
|
echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
|
|
|
|
} else {
|
2012-01-30 19:19:51 +00:00
|
|
|
header("Content-Type: text/event-stream");
|
|
|
|
}
|
2023-05-21 21:05:40 +00:00
|
|
|
if (!$this->request->passesStrictCookieCheck()) {
|
2016-07-20 15:37:30 +00:00
|
|
|
header('Location: '.\OC::$WEBROOT);
|
|
|
|
exit();
|
|
|
|
}
|
2023-05-21 21:05:40 +00:00
|
|
|
if (!$this->request->passesCSRFCheck()) {
|
2013-07-10 22:00:01 +00:00
|
|
|
$this->send('error', 'Possible CSRF attack. Connection will be closed.');
|
2014-07-26 13:50:11 +00:00
|
|
|
$this->close();
|
2012-07-22 14:36:09 +00:00
|
|
|
exit();
|
|
|
|
}
|
2012-01-30 19:19:51 +00:00
|
|
|
flush();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* send a message to the client
|
2014-08-29 15:18:11 +00:00
|
|
|
*
|
2013-07-10 22:00:01 +00:00
|
|
|
* @param string $type
|
2013-07-19 14:44:47 +00:00
|
|
|
* @param mixed $data
|
2012-01-30 19:19:51 +00:00
|
|
|
*
|
2014-08-29 15:33:10 +00:00
|
|
|
* @throws \BadMethodCallException
|
2013-07-10 22:00:01 +00:00
|
|
|
* if only one parameter is given, a typeless message will be send with that parameter as data
|
2017-07-19 18:21:05 +00:00
|
|
|
* @suppress PhanDeprecatedFunction
|
2012-01-30 19:19:51 +00:00
|
|
|
*/
|
2014-08-29 15:18:11 +00:00
|
|
|
public function send($type, $data = null) {
|
2014-08-29 15:33:10 +00:00
|
|
|
if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
|
2024-05-16 15:33:30 +00:00
|
|
|
throw new \BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
|
2014-08-29 15:33:10 +00:00
|
|
|
}
|
2014-08-29 15:18:11 +00:00
|
|
|
$this->init();
|
|
|
|
if (is_null($data)) {
|
|
|
|
$data = $type;
|
|
|
|
$type = null;
|
2012-01-30 19:19:51 +00:00
|
|
|
}
|
2014-08-29 15:18:11 +00:00
|
|
|
if ($this->fallback) {
|
|
|
|
$response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
|
2024-03-05 23:26:55 +00:00
|
|
|
. $this->fallBackId . ',"' . ($type ?? '') . '",' . json_encode($data, JSON_HEX_TAG) . ')</script>' . PHP_EOL;
|
2012-01-30 19:19:51 +00:00
|
|
|
echo $response;
|
2014-08-29 15:18:11 +00:00
|
|
|
} else {
|
|
|
|
if ($type) {
|
|
|
|
echo 'event: ' . $type . PHP_EOL;
|
2012-01-30 19:19:51 +00:00
|
|
|
}
|
2024-03-05 23:26:55 +00:00
|
|
|
echo 'data: ' . json_encode($data, JSON_HEX_TAG) . PHP_EOL;
|
2012-01-30 19:19:51 +00:00
|
|
|
}
|
|
|
|
echo PHP_EOL;
|
|
|
|
flush();
|
|
|
|
}
|
2012-01-30 22:19:43 +00:00
|
|
|
|
|
|
|
/**
|
2014-08-29 15:18:11 +00:00
|
|
|
* close the connection of the event source
|
2012-01-30 22:19:43 +00:00
|
|
|
*/
|
2012-09-07 13:22:01 +00:00
|
|
|
public function close() {
|
2014-08-29 15:18:11 +00:00
|
|
|
$this->send('__internal__', 'close'); //server side closing can be an issue, let the client do it
|
2012-01-30 22:19:43 +00:00
|
|
|
}
|
2012-10-22 22:28:12 +00:00
|
|
|
}
|