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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\DAV\CalDAV\WebcalCaching;
use OCA\DAV\CalDAV\CalendarRoot;
use OCP\IRequest;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\Server;
use Sabre\DAV\ServerPlugin;
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;
class Plugin extends ServerPlugin {
/**
* list of regular expressions for calendar user agents,
* that do not support subscriptions on their own
*
* /^MSFT-WIN-3/ - Windows 10 Calendar
* /Evolution/ - Gnome Calendar/Evolution
* /KIO/ - KDE PIM/Akonadi
* @var string[]
*/
public const ENABLE_FOR_CLIENTS = [
"/^MSFT-WIN-3/",
"/Evolution/",
"/KIO/"
];
/**
* @var bool
*/
private $enabled = false;
/**
* @var Server
*/
private $server;
/**
* Plugin constructor.
*
* @param IRequest $request
*/
public function __construct(IRequest $request) {
if ($request->isUserAgent(self::ENABLE_FOR_CLIENTS)) {
$this->enabled = true;
}
$magicHeader = $request->getHeader('X-NC-CalDAV-Webcal-Caching');
if ($magicHeader === 'On') {
$this->enabled = true;
}
$isExportRequest = $request->getMethod() === 'GET' && array_key_exists('export', $request->getParams());
if ($isExportRequest) {
$this->enabled = true;
}
}
/**
* This initializes the plugin.
*
* This function is called by Sabre\DAV\Server, after
* addPlugin is called.
*
* This method should set up the required event subscriptions.
*
* @param Server $server
*/
public function initialize(Server $server) {
$this->server = $server;
$server->on('beforeMethod:*', [$this, 'beforeMethod'], 15);
}
/**
* @param RequestInterface $request
* @param ResponseInterface $response
*/
public function beforeMethod(RequestInterface $request, ResponseInterface $response) {
if (!$this->enabled) {
return;
}
$path = $request->getPath();
if (!str_starts_with($path, 'calendars/')) {
return;
}
$pathParts = explode('/', ltrim($path, '/'));
if (\count($pathParts) < 2) {
return;
}
try {
$calendarRoot = $this->server->tree->getNodeForPath($pathParts[0]);
if ($calendarRoot instanceof CalendarRoot) {
$calendarRoot->enableReturnCachedSubscriptions($pathParts[1]);
}
} catch (NotFound $ex) {
return;
}
}
/**
* @return bool
*/
public function isCachingEnabledForThisRequest():bool {
return $this->enabled;
}
/**
* This method should return a list of server-features.
*
* This is for example 'versioning' and is added to the DAV: header
* in an OPTIONS response.
*
* @return string[]
*/
public function getFeatures():array {
return ['nc-calendar-webcal-cache'];
}
/**
* Returns a plugin name.
*
* Using this name other plugins will be able to access other plugins
* using Sabre\DAV\Server::getPlugin
*
* @return string
*/
public function getPluginName():string {
return 'nc-calendar-webcal-cache';
}
}
|
