Server.php 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. * @copyright Copyright (c) 2022 Informatyka Boguslawski sp. z o.o. sp.k., http://www.ib.pl/
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  7. * @author Bjoern Schiessle <bjoern@schiessle.org>
  8. * @author Brandon Kirsch <brandonkirsch@github.com>
  9. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  10. * @author Georg Ehrke <oc.list@georgehrke.com>
  11. * @author Joas Schilling <coding@schilljs.com>
  12. * @author John Molakvoæ <skjnldsv@protonmail.com>
  13. * @author Lukas Reschke <lukas@statuscode.ch>
  14. * @author Morris Jobke <hey@morrisjobke.de>
  15. * @author Robin Appelman <robin@icewind.nl>
  16. * @author Roeland Jago Douma <roeland@famdouma.nl>
  17. * @author Thomas Citharel <nextcloud@tcit.fr>
  18. * @author Thomas Müller <thomas.mueller@tmit.eu>
  19. * @author Vincent Petry <vincent@nextcloud.com>
  20. *
  21. * @license AGPL-3.0
  22. *
  23. * This code is free software: you can redistribute it and/or modify
  24. * it under the terms of the GNU Affero General Public License, version 3,
  25. * as published by the Free Software Foundation.
  26. *
  27. * This program is distributed in the hope that it will be useful,
  28. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  29. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  30. * GNU Affero General Public License for more details.
  31. *
  32. * You should have received a copy of the GNU Affero General Public License, version 3,
  33. * along with this program. If not, see <http://www.gnu.org/licenses/>
  34. *
  35. */
  36. namespace OCA\DAV;
  37. use OCA\DAV\AppInfo\PluginManager;
  38. use OCA\DAV\BulkUpload\BulkUploadPlugin;
  39. use OCA\DAV\CalDAV\BirthdayService;
  40. use OCA\DAV\CardDAV\HasPhotoPlugin;
  41. use OCA\DAV\CardDAV\ImageExportPlugin;
  42. use OCA\DAV\CardDAV\MultiGetExportPlugin;
  43. use OCA\DAV\CardDAV\PhotoCache;
  44. use OCA\DAV\Comments\CommentsPlugin;
  45. use OCA\DAV\Connector\Sabre\AnonymousOptionsPlugin;
  46. use OCA\DAV\Connector\Sabre\Auth;
  47. use OCA\DAV\Connector\Sabre\BearerAuth;
  48. use OCA\DAV\Connector\Sabre\BlockLegacyClientPlugin;
  49. use OCA\DAV\Connector\Sabre\CachingTree;
  50. use OCA\DAV\Connector\Sabre\ChecksumUpdatePlugin;
  51. use OCA\DAV\Connector\Sabre\CommentPropertiesPlugin;
  52. use OCA\DAV\Connector\Sabre\CopyEtagHeaderPlugin;
  53. use OCA\DAV\Connector\Sabre\DavAclPlugin;
  54. use OCA\DAV\Connector\Sabre\DummyGetResponsePlugin;
  55. use OCA\DAV\Connector\Sabre\FakeLockerPlugin;
  56. use OCA\DAV\Connector\Sabre\FilesPlugin;
  57. use OCA\DAV\Connector\Sabre\FilesReportPlugin;
  58. use OCA\DAV\Connector\Sabre\PropfindCompressionPlugin;
  59. use OCA\DAV\Connector\Sabre\QuotaPlugin;
  60. use OCA\DAV\Connector\Sabre\RequestIdHeaderPlugin;
  61. use OCA\DAV\Connector\Sabre\SharesPlugin;
  62. use OCA\DAV\Connector\Sabre\TagsPlugin;
  63. use OCA\DAV\DAV\CustomPropertiesBackend;
  64. use OCA\DAV\DAV\PublicAuth;
  65. use OCA\DAV\DAV\ViewOnlyPlugin;
  66. use OCA\DAV\Events\SabrePluginAuthInitEvent;
  67. use OCA\DAV\Files\BrowserErrorPagePlugin;
  68. use OCA\DAV\Files\LazySearchBackend;
  69. use OCA\DAV\Profiler\ProfilerPlugin;
  70. use OCA\DAV\Provisioning\Apple\AppleProvisioningPlugin;
  71. use OCA\DAV\SystemTag\SystemTagPlugin;
  72. use OCA\DAV\Upload\ChunkingPlugin;
  73. use OCA\DAV\Upload\ChunkingV2Plugin;
  74. use OCP\AppFramework\Http\Response;
  75. use OCP\Diagnostics\IEventLogger;
  76. use OCP\EventDispatcher\IEventDispatcher;
  77. use OCP\ICacheFactory;
  78. use OCP\IRequest;
  79. use OCP\Profiler\IProfiler;
  80. use OCP\SabrePluginEvent;
  81. use Psr\Log\LoggerInterface;
  82. use Sabre\CardDAV\VCFExportPlugin;
  83. use Sabre\DAV\Auth\Plugin;
  84. use Sabre\DAV\UUIDUtil;
  85. use SearchDAV\DAV\SearchPlugin;
  86. class Server {
  87. private IRequest $request;
  88. private string $baseUri;
  89. public Connector\Sabre\Server $server;
  90. private IProfiler $profiler;
  91. public function __construct(IRequest $request, string $baseUri) {
  92. $this->profiler = \OC::$server->get(IProfiler::class);
  93. if ($this->profiler->isEnabled()) {
  94. /** @var IEventLogger $eventLogger */
  95. $eventLogger = \OC::$server->get(IEventLogger::class);
  96. $eventLogger->start('runtime', 'DAV Runtime');
  97. }
  98. $this->request = $request;
  99. $this->baseUri = $baseUri;
  100. $logger = \OC::$server->get(LoggerInterface::class);
  101. $dispatcher = \OC::$server->getEventDispatcher();
  102. /** @var IEventDispatcher $newDispatcher */
  103. $newDispatcher = \OC::$server->query(IEventDispatcher::class);
  104. $root = new RootCollection();
  105. $this->server = new \OCA\DAV\Connector\Sabre\Server(new CachingTree($root));
  106. // Add maintenance plugin
  107. $this->server->addPlugin(new \OCA\DAV\Connector\Sabre\MaintenancePlugin(\OC::$server->getConfig(), \OC::$server->getL10N('dav')));
  108. $this->server->addPlugin(new \OCA\DAV\Connector\Sabre\AppleQuirksPlugin());
  109. // Backends
  110. $authBackend = new Auth(
  111. \OC::$server->getSession(),
  112. \OC::$server->getUserSession(),
  113. \OC::$server->getRequest(),
  114. \OC::$server->getTwoFactorAuthManager(),
  115. \OC::$server->getBruteForceThrottler()
  116. );
  117. // Set URL explicitly due to reverse-proxy situations
  118. $this->server->httpRequest->setUrl($this->request->getRequestUri());
  119. $this->server->setBaseUri($this->baseUri);
  120. $this->server->addPlugin(new ProfilerPlugin($this->request));
  121. $this->server->addPlugin(new BlockLegacyClientPlugin(\OC::$server->getConfig()));
  122. $this->server->addPlugin(new AnonymousOptionsPlugin());
  123. $authPlugin = new Plugin();
  124. $authPlugin->addBackend(new PublicAuth());
  125. $this->server->addPlugin($authPlugin);
  126. // allow setup of additional auth backends
  127. $event = new SabrePluginEvent($this->server);
  128. $dispatcher->dispatch('OCA\DAV\Connector\Sabre::authInit', $event);
  129. $newAuthEvent = new SabrePluginAuthInitEvent($this->server);
  130. $newDispatcher->dispatchTyped($newAuthEvent);
  131. $bearerAuthBackend = new BearerAuth(
  132. \OC::$server->getUserSession(),
  133. \OC::$server->getSession(),
  134. \OC::$server->getRequest()
  135. );
  136. $authPlugin->addBackend($bearerAuthBackend);
  137. // because we are throwing exceptions this plugin has to be the last one
  138. $authPlugin->addBackend($authBackend);
  139. // debugging
  140. if (\OC::$server->getConfig()->getSystemValue('debug', false)) {
  141. $this->server->addPlugin(new \Sabre\DAV\Browser\Plugin());
  142. } else {
  143. $this->server->addPlugin(new DummyGetResponsePlugin());
  144. }
  145. $this->server->addPlugin(new \OCA\DAV\Connector\Sabre\ExceptionLoggerPlugin('webdav', $logger));
  146. $this->server->addPlugin(new \OCA\DAV\Connector\Sabre\LockPlugin());
  147. $this->server->addPlugin(new \Sabre\DAV\Sync\Plugin());
  148. // acl
  149. $acl = new DavAclPlugin();
  150. $acl->principalCollectionSet = [
  151. 'principals/users',
  152. 'principals/groups',
  153. 'principals/calendar-resources',
  154. 'principals/calendar-rooms',
  155. ];
  156. $this->server->addPlugin($acl);
  157. // calendar plugins
  158. if ($this->requestIsForSubtree(['calendars', 'public-calendars', 'system-calendars', 'principals'])) {
  159. $this->server->addPlugin(new \OCA\DAV\CalDAV\Plugin());
  160. $this->server->addPlugin(new \OCA\DAV\CalDAV\ICSExportPlugin\ICSExportPlugin(\OC::$server->getConfig(), $logger));
  161. $this->server->addPlugin(new \OCA\DAV\CalDAV\Schedule\Plugin(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class)));
  162. if (\OC::$server->getConfig()->getAppValue('dav', 'sendInvitations', 'yes') === 'yes') {
  163. $this->server->addPlugin(\OC::$server->query(\OCA\DAV\CalDAV\Schedule\IMipPlugin::class));
  164. }
  165. $this->server->addPlugin(\OC::$server->get(\OCA\DAV\CalDAV\Trashbin\Plugin::class));
  166. $this->server->addPlugin(new \OCA\DAV\CalDAV\WebcalCaching\Plugin($request));
  167. if (\OC::$server->getConfig()->getAppValue('dav', 'allow_calendar_link_subscriptions', 'yes') === 'yes') {
  168. $this->server->addPlugin(new \Sabre\CalDAV\Subscriptions\Plugin());
  169. }
  170. $this->server->addPlugin(new \Sabre\CalDAV\Notifications\Plugin());
  171. $this->server->addPlugin(new DAV\Sharing\Plugin($authBackend, \OC::$server->getRequest(), \OC::$server->getConfig()));
  172. $this->server->addPlugin(new \OCA\DAV\CalDAV\Publishing\PublishPlugin(
  173. \OC::$server->getConfig(),
  174. \OC::$server->getURLGenerator()
  175. ));
  176. }
  177. // addressbook plugins
  178. if ($this->requestIsForSubtree(['addressbooks', 'principals'])) {
  179. $this->server->addPlugin(new DAV\Sharing\Plugin($authBackend, \OC::$server->getRequest(), \OC::$server->getConfig()));
  180. $this->server->addPlugin(new \OCA\DAV\CardDAV\Plugin());
  181. $this->server->addPlugin(new VCFExportPlugin());
  182. $this->server->addPlugin(new MultiGetExportPlugin());
  183. $this->server->addPlugin(new HasPhotoPlugin());
  184. $this->server->addPlugin(new ImageExportPlugin(new PhotoCache(
  185. \OC::$server->getAppDataDir('dav-photocache'),
  186. $logger)
  187. ));
  188. }
  189. // system tags plugins
  190. $this->server->addPlugin(\OC::$server->get(SystemTagPlugin::class));
  191. // comments plugin
  192. $this->server->addPlugin(new CommentsPlugin(
  193. \OC::$server->getCommentsManager(),
  194. \OC::$server->getUserSession()
  195. ));
  196. $this->server->addPlugin(new CopyEtagHeaderPlugin());
  197. $this->server->addPlugin(new RequestIdHeaderPlugin(\OC::$server->get(IRequest::class)));
  198. $this->server->addPlugin(new ChunkingV2Plugin(\OCP\Server::get(ICacheFactory::class)));
  199. $this->server->addPlugin(new ChunkingPlugin());
  200. // allow setup of additional plugins
  201. $dispatcher->dispatch('OCA\DAV\Connector\Sabre::addPlugin', $event);
  202. // Some WebDAV clients do require Class 2 WebDAV support (locking), since
  203. // we do not provide locking we emulate it using a fake locking plugin.
  204. if ($request->isUserAgent([
  205. '/WebDAVFS/',
  206. '/OneNote/',
  207. '/^Microsoft-WebDAV/',// Microsoft-WebDAV-MiniRedir/6.1.7601
  208. ])) {
  209. $this->server->addPlugin(new FakeLockerPlugin());
  210. }
  211. // Allow view-only plugin for webdav requests
  212. $this->server->addPlugin(new ViewOnlyPlugin(
  213. $logger
  214. ));
  215. if (BrowserErrorPagePlugin::isBrowserRequest($request)) {
  216. $this->server->addPlugin(new BrowserErrorPagePlugin());
  217. }
  218. $lazySearchBackend = new LazySearchBackend();
  219. $this->server->addPlugin(new SearchPlugin($lazySearchBackend));
  220. // wait with registering these until auth is handled and the filesystem is setup
  221. $this->server->on('beforeMethod:*', function () use ($root, $lazySearchBackend, $logger) {
  222. // custom properties plugin must be the last one
  223. $userSession = \OC::$server->getUserSession();
  224. $user = $userSession->getUser();
  225. if ($user !== null) {
  226. $view = \OC\Files\Filesystem::getView();
  227. $this->server->addPlugin(
  228. new FilesPlugin(
  229. $this->server->tree,
  230. \OC::$server->getConfig(),
  231. $this->request,
  232. \OC::$server->getPreviewManager(),
  233. \OC::$server->getUserSession(),
  234. false,
  235. !\OC::$server->getConfig()->getSystemValue('debug', false)
  236. )
  237. );
  238. $this->server->addPlugin(new ChecksumUpdatePlugin());
  239. $this->server->addPlugin(
  240. new \Sabre\DAV\PropertyStorage\Plugin(
  241. new CustomPropertiesBackend(
  242. $this->server->tree,
  243. \OC::$server->getDatabaseConnection(),
  244. \OC::$server->getUserSession()->getUser()
  245. )
  246. )
  247. );
  248. if ($view !== null) {
  249. $this->server->addPlugin(
  250. new QuotaPlugin($view));
  251. }
  252. $this->server->addPlugin(
  253. new TagsPlugin(
  254. $this->server->tree, \OC::$server->getTagManager()
  255. )
  256. );
  257. // TODO: switch to LazyUserFolder
  258. $userFolder = \OC::$server->getUserFolder();
  259. $this->server->addPlugin(new SharesPlugin(
  260. $this->server->tree,
  261. $userSession,
  262. $userFolder,
  263. \OC::$server->getShareManager()
  264. ));
  265. $this->server->addPlugin(new CommentPropertiesPlugin(
  266. \OC::$server->getCommentsManager(),
  267. $userSession
  268. ));
  269. $this->server->addPlugin(new \OCA\DAV\CalDAV\Search\SearchPlugin());
  270. if ($view !== null) {
  271. $this->server->addPlugin(new FilesReportPlugin(
  272. $this->server->tree,
  273. $view,
  274. \OC::$server->getSystemTagManager(),
  275. \OC::$server->getSystemTagObjectMapper(),
  276. \OC::$server->getTagManager(),
  277. $userSession,
  278. \OC::$server->getGroupManager(),
  279. $userFolder,
  280. \OC::$server->getAppManager()
  281. ));
  282. $lazySearchBackend->setBackend(new \OCA\DAV\Files\FileSearchBackend(
  283. $this->server->tree,
  284. $user,
  285. \OC::$server->getRootFolder(),
  286. \OC::$server->getShareManager(),
  287. $view
  288. ));
  289. $this->server->addPlugin(
  290. new BulkUploadPlugin(
  291. $userFolder,
  292. $logger
  293. )
  294. );
  295. }
  296. $this->server->addPlugin(new \OCA\DAV\CalDAV\BirthdayCalendar\EnablePlugin(
  297. \OC::$server->getConfig(),
  298. \OC::$server->query(BirthdayService::class)
  299. ));
  300. $this->server->addPlugin(new AppleProvisioningPlugin(
  301. \OC::$server->getUserSession(),
  302. \OC::$server->getURLGenerator(),
  303. \OC::$server->getThemingDefaults(),
  304. \OC::$server->getRequest(),
  305. \OC::$server->getL10N('dav'),
  306. function () {
  307. return UUIDUtil::getUUID();
  308. }
  309. ));
  310. }
  311. // register plugins from apps
  312. $pluginManager = new PluginManager(
  313. \OC::$server,
  314. \OC::$server->getAppManager()
  315. );
  316. foreach ($pluginManager->getAppPlugins() as $appPlugin) {
  317. $this->server->addPlugin($appPlugin);
  318. }
  319. foreach ($pluginManager->getAppCollections() as $appCollection) {
  320. $root->addChild($appCollection);
  321. }
  322. });
  323. $this->server->addPlugin(
  324. new PropfindCompressionPlugin()
  325. );
  326. }
  327. public function exec() {
  328. /** @var IEventLogger $eventLogger */
  329. $eventLogger = \OC::$server->get(IEventLogger::class);
  330. $eventLogger->start('dav_server_exec', '');
  331. $this->server->exec();
  332. $eventLogger->end('dav_server_exec');
  333. if ($this->profiler->isEnabled()) {
  334. $eventLogger->end('runtime');
  335. $profile = $this->profiler->collect(\OC::$server->get(IRequest::class), new Response());
  336. $this->profiler->saveProfile($profile);
  337. }
  338. }
  339. private function requestIsForSubtree(array $subTrees): bool {
  340. foreach ($subTrees as $subTree) {
  341. $subTree = trim($subTree, ' /');
  342. if (strpos($this->server->getRequestUri(), $subTree.'/') === 0) {
  343. return true;
  344. }
  345. }
  346. return false;
  347. }
  348. }