Enhance getEvents with logging and error handling by hismayilov · Pull Request #81 · LJPc-solutions/freescout-calendar-module

hismayilov · 2026-03-07T15:01:37Z

The issue was that the getEvents method was using propFind, which doesn't retrieve calendar event data correctly in CalDAV. I've updated it to use the proper REPORT method with a calendar-query to fetch all events from the calendar.

This should now work with Zoho Calendar (and other CalDAV servers). The method sends a REPORT request to query for VEVENT components and extracts the calendar data from the XML response.

Added logging for CalDAV events retrieval process and improved error handling for the REPORT request.

Previous issue. #77

The issue was that the getEvents method was using propFind, which doesn't retrieve calendar event data correctly in CalDAV. I've updated it to use the proper REPORT method with a calendar-query to fetch all events from the calendar. This should now work with Zoho Calendar (and other CalDAV servers). The method sends a REPORT request to query for VEVENT components and extracts the calendar data from the XML response. Added logging for CalDAV events retrieval process and improved error handling for the REPORT request.

Lars-

First of all, thank you for the pull request! There are a couple of small things that could be improved. Can you change those?

Lars- · 2026-03-09T09:34:59Z

Http/Helpers/CalDAV.php

+						'Depth' => '1',
+				] );
+
+				\Log::info('CalDAV REPORT response', ['status' => $response['statusCode'] ?? 'no status', 'body_length' => strlen($response['body'] ?? '')]);


This and the other \Log::info() calls will fire on every scheduled sync (potentially every minute). Please downgrade to \Log::debug() or remove them. The URL could also contain credentials in some CalDAV setups.

Lars- · 2026-03-09T09:35:51Z

Http/Helpers/CalDAV.php

+								\Log::info('CalDAV response body preview', ['body' => substr($response['body'], 0, 500)]);
+								// Parse the XML response to extract calendar-data
+								$matches = [];
+								preg_match_all( '/<(?:C:)?calendar-data[^>]*>(.*?)<\/(?:C:)?calendar-data>/s', $response['body'], $matches );


This regex misses the cal: namespace prefix, which many CalDAV servers use. Your existing getEventByUid method handles cal:, C:, and unqualifie, this should match. Suggested fix: preg_match_all( '/<(?:cal:|C:)?calendar-data[^>]*>(.*?)<\/(?:cal:|C:)?calendar-data>/s', $response['body'], $matches );

Lars- · 2026-03-09T09:36:25Z

Http/Helpers/CalDAV.php

+				           '  </C:filter>' . "\n" .
+				           '</C:calendar-query>';
+
+				$response = $this->client->request( 'REPORT', $calendarUrl, $xmlBody, [


Client::request() can throw ClientException on network/HTTP errors. Wrap this in a try-catch like getEventByUid does, otherwise a transient failure will crash the cron job instead of returning an empty array.

Handle REPORT responses without calendar-data by fetching each event .ics via href, reduce noisy/sensitive logging, and preserve ICS separators so imported events parse correctly.

hismayilov · 2026-03-11T23:08:22Z

Summary

This PR fixes CalDAV event retrieval for providers (notably Zoho) that return 207 Multi-Status responses without embedded calendar-data nodes.

Fixes CalDAV event sync for Zoho-like servers that return REPORT results without inline calendar-data.
Adds a fallback to parse event hrefs and fetch .ics payloads via GET when needed.
Also preserves valid ICS boundaries by joining event payloads with \r\n in external content assembly.
Logging was reduced to safer debug output (no large/sensitive response previews).
Low-risk change: existing behavior remains the same when calendar-data is already present.

What changed

Added a fallback flow in CalDAV::getEvents():
- First, try extracting calendar-data from the REPORT XML response.
- If none is present, extract event href entries and fetch each event via GET (.ics payloads).
Improved XML parsing robustness:
- Parse calendar-data and href with namespace-agnostic DOM/XPath.
- Keep regex parsing as a fallback when XML parsing cannot extract data.
Reduced noisy/sensitive logs:
- Changed several info/error logs to safer debug logs and removed large body dumps.
Fixed ICS concatenation in Calendar::getExternalContent():
- Join event payloads with "\r\n" separators instead of an empty string to preserve valid ICS boundaries.

Why this is needed

Some CalDAV servers return valid event references (href) but omit inline calendar-data in REPORT results.
Before this change, those calendars could appear empty or partially imported.
With this fallback, events are retrieved reliably across more CalDAV providers (including Zoho) while preserving correct ICS formatting.

Scope

Http/Helpers/CalDAV.php
Entities/Calendar.php

Testing performed

Verified normal REPORT parsing still returns events when calendar-data is present.
Verified fallback path retrieves events by href when calendar-data is absent.
Confirmed resulting ICS payload remains parseable after concatenation with CRLF separators.
Confirmed no sensitive response body preview is logged at info/error level.

Risk / impact

Low to medium: retrieval logic expanded with a defensive fallback path.
Behavior is unchanged for providers already returning calendar-data.
Additional GET requests only occur when REPORT does not include event payloads.

db961ee

Lars-

2 small changes, then it's good!

Lars- · 2026-03-23T13:13:24Z

Http/Helpers/CalDAV.php

+
+				libxml_use_internal_errors( true );
+				$document = new \DOMDocument();
+				if ( $document->loadXML( $responseBody ) ) {


DOMDocument::loadXML() without LIBXML_NONET allows external entity loading on PHP < 8.0 (XXE risk). FreeScout supports PHP 7.x. Use:

$document->loadXML( $responseBody, LIBXML_NONET );

Same applies to extractEventHrefsFromMultistatus below.

Lars- · 2026-03-23T13:13:50Z

Http/Helpers/CalDAV.php

+								foreach ( $nodes as $node ) {
+										$data = trim( $node->nodeValue );
+										if ( $data !== '' ) {
+												$events[] = html_entity_decode( $data, ENT_XML1, 'UTF-8' );


Doesn't $node->nodeValue already returns decoded text?

Lars- requested changes Mar 9, 2026

View reviewed changes

Fix CalDAV Zoho event retrieval fallback.

db961ee

Handle REPORT responses without calendar-data by fetching each event .ics via href, reduce noisy/sensitive logging, and preserve ICS separators so imported events parse correctly.

Lars- requested changes Mar 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance getEvents with logging and error handling#81

Enhance getEvents with logging and error handling#81
hismayilov wants to merge 2 commits intoLJPc-solutions:mainfrom
hismayilov:patch-1

hismayilov commented Mar 7, 2026 •

edited

Loading

Uh oh!

Lars- left a comment

Uh oh!

Lars- Mar 9, 2026

Uh oh!

Lars- Mar 9, 2026

Uh oh!

Lars- Mar 9, 2026

Uh oh!

hismayilov commented Mar 11, 2026

Uh oh!

Lars- left a comment

Uh oh!

Lars- Mar 23, 2026

Uh oh!

Lars- Mar 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

hismayilov commented Mar 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Lars- left a comment

Choose a reason for hiding this comment

Uh oh!

Lars- Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Lars- Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Lars- Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

hismayilov commented Mar 11, 2026

Summary

What changed

Why this is needed

Scope

Testing performed

Risk / impact

Uh oh!

Lars- left a comment

Choose a reason for hiding this comment

Uh oh!

Lars- Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Lars- Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hismayilov commented Mar 7, 2026 •

edited

Loading