Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(caldav): add missing handlers #48508

Merged
merged 1 commit into from
Oct 2, 2024
+66 −108
Merged

fix(caldav): add missing handlers #48508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 58 additions & 87 deletions apps/dav/lib/CalDAV/WebcalCaching/Connection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,11 @@
namespace OCA\DAV\CalDAV\WebcalCaching;

use Exception;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\RequestOptions;
use OCP\Http\Client\IClientService;
use OCP\Http\Client\LocalServerException;
use OCP\IAppConfig;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
use Sabre\DAV\Xml\Property\Href;
use Sabre\VObject\Reader;

class Connection {
Expand All @@ -31,107 +27,82 @@ public function __construct(
/**
* gets webcal feed from remote server
*/
public function queryWebcalFeed(array $subscription, array &$mutations): ?string {
$client = $this->clientService->newClient();

$didBreak301Chain = false;
$latestLocation = null;

$handlerStack = HandlerStack::create();
$handlerStack->push(Middleware::mapRequest(function (RequestInterface $request) {
return $request
->withHeader('Accept', 'text/calendar, application/calendar+json, application/calendar+xml')
->withHeader('User-Agent', 'Nextcloud Webcal Service');
}));
$handlerStack->push(Middleware::mapResponse(function (ResponseInterface $response) use (&$didBreak301Chain, &$latestLocation) {
if (!$didBreak301Chain) {
if ($response->getStatusCode() !== 301) {
$didBreak301Chain = true;
} else {
$latestLocation = $response->getHeader('Location');
}
}
return $response;
}));

$allowLocalAccess = $this->config->getValueString('dav', 'webcalAllowLocalAccess', 'no');
public function queryWebcalFeed(array $subscription): ?string {
$subscriptionId = $subscription['id'];
$url = $this->cleanURL($subscription['source']);
if ($url === null) {
return null;
}

try {
$params = [
'allow_redirects' => [
'redirects' => 10
Comment on lines -66 to -67
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer accepts redirects?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redirects should still work as they are enabled by default with a maximum of 5 redirects.

Resolving the final location does not work without a middleware, and therefore we are skipping it for now.

],
'handler' => $handlerStack,
'nextcloud' => [
'allow_local_address' => $allowLocalAccess === 'yes',
]
];

$user = parse_url($subscription['source'], PHP_URL_USER);
$pass = parse_url($subscription['source'], PHP_URL_PASS);
if ($user !== null && $pass !== null) {
$params['auth'] = [$user, $pass];
}
$allowLocalAccess = $this->config->getValueString('dav', 'webcalAllowLocalAccess', 'no');

$params = [
'nextcloud' => [
'allow_local_address' => $allowLocalAccess === 'yes',
],
RequestOptions::HEADERS => [
'User-Agent' => 'Nextcloud Webcal Service',
'Accept' => 'text/calendar, application/calendar+json, application/calendar+xml',
],
];

$user = parse_url($subscription['source'], PHP_URL_USER);
$pass = parse_url($subscription['source'], PHP_URL_PASS);
if ($user !== null && $pass !== null) {
$params[RequestOptions::AUTH] = [$user, $pass];
}

try {
$client = $this->clientService->newClient();
$response = $client->get($url, $params);
$body = $response->getBody();

if ($latestLocation !== null) {
$mutations['{http://calendarserver.org/ns/}source'] = new Href($latestLocation);
}

$contentType = $response->getHeader('Content-Type');
$contentType = explode(';', $contentType, 2)[0];
switch ($contentType) {
case 'application/calendar+json':
try {
$jCalendar = Reader::readJson($body, Reader::OPTION_FORGIVING);
} catch (Exception $ex) {
// In case of a parsing error return null
$this->logger->warning("Subscription $subscriptionId could not be parsed", ['exception' => $ex]);
return null;
}
return $jCalendar->serialize();

case 'application/calendar+xml':
try {
$xCalendar = Reader::readXML($body);
} catch (Exception $ex) {
// In case of a parsing error return null
$this->logger->warning("Subscription $subscriptionId could not be parsed", ['exception' => $ex]);
return null;
}
return $xCalendar->serialize();

case 'text/calendar':
default:
try {
$vCalendar = Reader::read($body);
} catch (Exception $ex) {
// In case of a parsing error return null
$this->logger->warning("Subscription $subscriptionId could not be parsed", ['exception' => $ex]);
return null;
}
return $vCalendar->serialize();
}
} catch (LocalServerException $ex) {
$this->logger->warning("Subscription $subscriptionId was not refreshed because it violates local access rules", [
'exception' => $ex,
]);

return null;
} catch (Exception $ex) {
$this->logger->warning("Subscription $subscriptionId could not be refreshed due to a network error", [
'exception' => $ex,
]);

return null;
}

$body = $response->getBody();

$contentType = $response->getHeader('Content-Type');
$contentType = explode(';', $contentType, 2)[0];
switch ($contentType) {
case 'application/calendar+json':
try {
$jCalendar = Reader::readJson($body, Reader::OPTION_FORGIVING);
} catch (Exception $ex) {
// In case of a parsing error return null
$this->logger->warning("Subscription $subscriptionId could not be parsed", ['exception' => $ex]);
return null;
}
return $jCalendar->serialize();

case 'application/calendar+xml':
try {
$xCalendar = Reader::readXML($body);
} catch (Exception $ex) {
// In case of a parsing error return null
$this->logger->warning("Subscription $subscriptionId could not be parsed", ['exception' => $ex]);
return null;
}
return $xCalendar->serialize();

case 'text/calendar':
default:
try {
$vCalendar = Reader::read($body);
} catch (Exception $ex) {
// In case of a parsing error return null
$this->logger->warning("Subscription $subscriptionId could not be parsed", ['exception' => $ex]);
return null;
}
return $vCalendar->serialize();
}
}

/**
Expand Down
2 changes: 1 addition & 1 deletion apps/dav/lib/CalDAV/WebcalCaching/RefreshWebcalService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public function refreshSubscription(string $principalUri, string $uri) {
}


$webcalData = $this->connection->queryWebcalFeed($subscription, $mutations);
$webcalData = $this->connection->queryWebcalFeed($subscription);
if (!$webcalData) {
return;
}
Expand Down
27 changes: 7 additions & 20 deletions apps/dav/tests/unit/CalDAV/WebcalCaching/ConnectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
*/
namespace OCA\DAV\Tests\unit\CalDAV\WebcalCaching;

use GuzzleHttp\HandlerStack;
use OCA\DAV\CalDAV\WebcalCaching\Connection;
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
Expand Down Expand Up @@ -48,7 +47,6 @@ public function testLocalUrl($source): void {
'source' => $source,
'lastmodified' => 0,
];
$mutation = [];

$client = $this->createMock(IClient::class);
$this->clientService->expects(self::once())
Expand All @@ -69,7 +67,7 @@ public function testLocalUrl($source): void {
->method('warning')
->with('Subscription 42 was not refreshed because it violates local access rules', ['exception' => $localServerException]);

$this->connection->queryWebcalFeed($subscription, $mutation);
$this->connection->queryWebcalFeed($subscription);
}

public function testInvalidUrl(): void {
Expand All @@ -83,22 +81,14 @@ public function testInvalidUrl(): void {
'source' => '!@#$',
'lastmodified' => 0,
];
$mutation = [];

$client = $this->createMock(IClient::class);
$this->clientService->expects(self::once())
->method('newClient')
->with()
->willReturn($client);
$this->config->expects(self::once())
->method('getValueString')
->with('dav', 'webcalAllowLocalAccess', 'no')
->willReturn('no');

$this->config->expects(self::never())
->method('getValueString');
$client->expects(self::never())
->method('get');

$this->connection->queryWebcalFeed($subscription, $mutation);
$this->connection->queryWebcalFeed($subscription);

}

Expand All @@ -120,7 +110,6 @@ public function testConnection(string $url, string $result, string $contentType)
'source' => $url,
'lastmodified' => 0,
];
$mutation = [];

$this->clientService->expects($this->once())
->method('newClient')
Expand All @@ -134,9 +123,7 @@ public function testConnection(string $url, string $result, string $contentType)

$client->expects($this->once())
->method('get')
->with('https://foo.bar/bla2', $this->callback(function ($obj) {
return $obj['allow_redirects']['redirects'] === 10 && $obj['handler'] instanceof HandlerStack;
}))
->with('https://foo.bar/bla2')
->willReturn($response);

$response->expects($this->once())
Expand All @@ -148,9 +135,9 @@ public function testConnection(string $url, string $result, string $contentType)
->with('Content-Type')
->willReturn($contentType);

$this->connection->queryWebcalFeed($subscription, $mutation);

$this->connection->queryWebcalFeed($subscription);
}

public static function runLocalURLDataProvider(): array {
return [
['localhost/foo.bar'],
Expand Down
Loading