<?php

/**
 * DAV client bound to a fixed collection (used for the
 * 'calendar_caldav_preinstalled_sources' option of the CalDAV driver).
 *
 * Unlike kolab_dav_client, which discovers the calendar home of the current
 * user, this client lists calendars from a given location of the server. The
 * location can be a calendar home (a collection of calendars, e.g. the home of
 * another principal) or a single calendar collection.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 */

class caldav_source_client extends kolab_dav_client
{
    /** @var string Absolute path of the source on the server */
    protected $source_path;

    /** @var ?bool Default value of the "alarms" folder property */
    protected $default_alarms;

    /**
     * @param string $server         DAV server URL (calendar_caldav_server), may contain credentials
     * @param string $source_path    Absolute path of the collection on the server
     * @param ?bool  $default_alarms Alarms flag used when the server does not provide one
     */
    public function __construct($server, $source_path, $default_alarms = null)
    {
        parent::__construct($server);

        $this->source_path    = $source_path;
        $this->default_alarms = $default_alarms;
    }

    /**
     * Calendars are not discovered, they live at the configured location.
     */
    public function getHome($type)
    {
        if ($type == 'VEVENT' || $type == 'VTODO') {
            return $this->normalize_location($this->source_path);
        }

        return parent::getHome($type);
    }

    /**
     * List calendars at the configured location.
     */
    public function listFolders($component = 'VEVENT')
    {
        $location = $this->getHome($component);

        // The location may be a calendar collection itself
        $info = $this->folderInfo($location);

        if (is_array($info)
            && in_array('calendar', (array) $info['resource_type'])
            && in_array($component, (array) $info['types'])
        ) {
            $folders = [$info];
        } else {
            // ...or a collection of calendars
            $folders = parent::listFolders($component);
        }

        if (is_array($folders) && $this->default_alarms !== null) {
            foreach ($folders as $idx => $folder) {
                if (!isset($folder['alarms'])) {
                    $folders[$idx]['alarms'] = $this->default_alarms;
                }
            }
        }

        return $folders;
    }
}