blob: 05f8121a5f871c556906591de9be6d3be08e1798 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
/**
* ownCloud - gallery
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Bart Visscher <bartv@thisnet.nl>
* @author Felix Moeller <mail@felixmoeller.de>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
* @author Olivier Paroz <owncloud@interfasys.ch>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @copyright Olivier Paroz 2015
*/
namespace OCA\Gallery\Utility;
/**
* Class EventSource
*
* Wrapper for server side events (http://en.wikipedia.org/wiki/Server-sent_events)
*
* This version is tailored for the Gallery app, do not use elsewhere!
* @link https://github.com/owncloud/core/blob/master/lib/private/eventsource.php
*
* @todo Replace with a library
*
* @package OCA\Gallery\Controller
*/
class EventSource implements \OCP\IEventSource {
/**
* @var bool
*/
private $started = false;
protected function init() {
if ($this->started) {
return;
}
$this->started = true;
// prevent php output buffering, caching and nginx buffering
while (ob_get_level()) {
ob_end_clean();
}
header('Cache-Control: no-cache');
header('X-Accel-Buffering: no');
header("Content-Type: text/event-stream");
flush();
}
/**
* Sends a message to the client
*
* If only one parameter is given, a typeless message will be sent with that parameter as data
*
* @param string $type
* @param mixed $data
*
* @throws \BadMethodCallException
*/
public function send($type, $data = null) {
$this->validateMessage($type, $data);
$this->init();
if (is_null($data)) {
$data = $type;
$type = null;
}
if (!empty($type)) {
echo 'event: ' . $type . PHP_EOL;
}
echo 'data: ' . json_encode($data) . PHP_EOL;
echo PHP_EOL;
flush();
}
/**
* Closes the connection of the event source
*
* It's best to let the client close the stream
*/
public function close() {
$this->send(
'__internal__', 'close'
);
}
/**
* Makes sure we have a message we can use
*
* @param string $type
* @param mixed $data
*/
private function validateMessage($type, $data) {
if ($data && !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
throw new \BadMethodCallException('Type needs to be alphanumeric (' . $type . ')');
}
}
}
|
