0
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-02-06 01:20:16 +00:00
nextcloud_server/apps/dav/lib/Connector/Sabre/ExceptionLoggerPlugin.php
provokateurin 381077028a
refactor(apps): Use constructor property promotion when possible
Signed-off-by: provokateurin <kate@provokateurin.de>
2024-10-21 12:37:59 +02:00

112 lines
3.7 KiB
PHP

<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCA\DAV\Connector\Sabre;
use OCA\DAV\Connector\Sabre\Exception\FileLocked;
use OCA\DAV\Connector\Sabre\Exception\PasswordLoginForbidden;
use OCA\DAV\Exception\ServerMaintenanceMode;
use OCP\Files\StorageNotAvailableException;
use Psr\Log\LoggerInterface;
use Sabre\DAV\Exception\BadRequest;
use Sabre\DAV\Exception\Conflict;
use Sabre\DAV\Exception\Forbidden;
use Sabre\DAV\Exception\InvalidSyncToken;
use Sabre\DAV\Exception\MethodNotAllowed;
use Sabre\DAV\Exception\NotAuthenticated;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\Exception\NotImplemented;
use Sabre\DAV\Exception\PreconditionFailed;
use Sabre\DAV\Exception\RequestedRangeNotSatisfiable;
class ExceptionLoggerPlugin extends \Sabre\DAV\ServerPlugin {
protected $nonFatalExceptions = [
NotAuthenticated::class => true,
// If tokenauth can throw this exception (which is basically as
// NotAuthenticated. So not fatal.
PasswordLoginForbidden::class => true,
// basically a NotAuthenticated
InvalidSyncToken::class => true,
// the sync client uses this to find out whether files exist,
// so it is not always an error, log it as debug
NotFound::class => true,
// the sync client messed up their request
// (e.g. propfind for tags with string instead of int)
// so it is not always an error, log it as debug
BadRequest::class => true,
// this one mostly happens when the same file is uploaded at
// exactly the same time from two clients, only one client
// wins, the second one gets "Precondition failed"
PreconditionFailed::class => true,
// forbidden can be expected when trying to upload to
// read-only folders for example
Forbidden::class => true,
// our forbidden is expected when access control is blocking
// an item in a folder
\OCA\DAV\Connector\Sabre\Exception\Forbidden::class => true,
// Happens when an external storage or federated share is temporarily
// not available
StorageNotAvailableException::class => true,
// happens if some a client uses the wrong method for a given URL
// the error message itself is visible on the client side anyways
NotImplemented::class => true,
// happens when the parent directory is not present (for example when a
// move is done to a non-existent directory)
Conflict::class => true,
// happens when a certain method is not allowed to be called
// for example creating a folder that already exists
MethodNotAllowed::class => true,
// A locked file is perfectly valid and can happen in various cases
FileLocked::class => true,
// An invalid range is requested
RequestedRangeNotSatisfiable::class => true,
ServerMaintenanceMode::class => true,
];
/**
* @param string $appName app name to use when logging
*/
public function __construct(
private string $appName,
private LoggerInterface $logger,
) {
}
/**
* 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 \Sabre\DAV\Server $server
* @return void
*/
public function initialize(\Sabre\DAV\Server $server) {
$server->on('exception', [$this, 'logException'], 10);
}
/**
* Log exception
*/
public function logException(\Throwable $ex) {
$exceptionClass = get_class($ex);
if (isset($this->nonFatalExceptions[$exceptionClass])) {
$this->logger->debug($ex->getMessage(), [
'app' => $this->appName,
'exception' => $ex,
]);
return;
}
$this->logger->critical($ex->getMessage(), [
'app' => $this->appName,
'exception' => $ex,
]);
}
}