upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-03-01 13:00:44 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Merge pull request #29661 from nextcloud/enhancement/calendar-search-properties-api

Browse source 
Document and type allowed property names for calendar property searches
This commit is contained in:
Christoph Wurst 2021-11-15 10:02:47 +01:00 committed by GitHub
commit 98b963e8a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 77 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
apps/dav/lib/CalDAV/CalDavBackend.php
View file

@ -170,10 +170,25 @@ class CalDavBackend extends AbstractBackend implements SyncSupport, Subscription
'{http://calendarserver.org/ns/}subscribed-strip-attachments' => 'stripattachments',
];
/** @var array properties to index */
public static $indexProperties = ['CATEGORIES', 'COMMENT', 'DESCRIPTION',
'LOCATION', 'RESOURCES', 'STATUS', 'SUMMARY', 'ATTENDEE', 'CONTACT',
'ORGANIZER'];
/**
* properties to index
*
* This list has to be kept in sync with ICalendarQuery::SEARCH_PROPERTY_*
*
* @see \OCP\Calendar\ICalendarQuery
*/
private const INDEXED_PROPERTIES = [
'CATEGORIES',
'COMMENT',
'DESCRIPTION',
'LOCATION',
'RESOURCES',
'STATUS',
'SUMMARY',
'ATTENDEE',
'CONTACT',
'ORGANIZER'
];
/** @var array parameters to index */
public static $indexParameters = [
@ -2948,7 +2963,7 @@ class CalDavBackend extends AbstractBackend implements SyncSupport, Subscription
}
foreach ($component->children() as $property) {
if (in_array($property->name, self::$indexProperties)) {
if (in_array($property->name, self::INDEXED_PROPERTIES, true)) {
$value = $property->getValue();
// is this a shitty db?
if (!$this->db->supports4ByteText()) {

57
lib/public/Calendar/ICalendarQuery.php
View file

@ -23,6 +23,7 @@ declare(strict_types=1);
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Calendar;
use DateTimeImmutable;
@ -34,6 +35,56 @@ use DateTimeImmutable;
*/
interface ICalendarQuery {
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_CATEGORIES = 'CATEGORIES';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_COMMENT = 'COMMENT';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_DESCRIPTION = 'DESCRIPTION';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_LOCATION = 'LOCATION';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_RESOURCES = 'RESOURCES';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_STATUS = 'STATUS';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_SUMMARY = 'SUMMARY';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_ATTENDEE = 'ATTENDEE';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_CONTACT = 'CONTACT';
/**
* @since 24.0.0
*/
public const SEARCH_PROPERTY_ORGANIZER = 'ORGANIZER';
/**
* Limit the results to the calendar uri(s)
*
@ -51,6 +102,12 @@ interface ICalendarQuery {
/**
* Define the property name(s) to search for
*
* Note: Nextcloud only indexes *some* properties. You can not search for
* arbitrary properties.
*
* @param string $value any of the ICalendarQuery::SEARCH_PROPERTY_* values
* @psalm-param ICalendarQuery::SEARCH_PROPERTY_* $value
*
* @since 23.0.0
*/
public function addSearchProperty(string $value): void;