Spatie\CalendarLinks\Generators\Ics

Complexity

Total Complexity

24

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	generate()	0	41	4
A	escapeString()	0	4	1
A	generateEventUid()	0	4	1
A	addVTimezoneComponents()	0	16	3
C	generateVTimeZoneComponent()	0	71	15

<?php

namespace Spatie\CalendarLinks\Generators;

use Sabre\VObject\Component;
use Spatie\CalendarLinks\Link;
use Sabre\VObject\TimeZoneUtil;
use Spatie\CalendarLinks\Generator;
use Sabre\VObject\Component\VCalendar;

/**
 * @see https://icalendar.org/RFC-Specifications/iCalendar-RFC-5545/
 */
class Ics implements Generator
{
    public function generate(Link $link): string
    {
        $timeZones = [];

        $vcalendar = new VCalendar();
        $vevent = $vcalendar->createComponent('VEVENT', [
            'UID' => $this->generateEventUid($link),
            'SUMMARY' => $link->title,
        ]);
        $vcalendar->add($vevent);

        if ($link->allDay) {
            $vevent->add('DTSTART', $link->from);
            $vevent->add('DURATION:P1D');
            $timeZones[$link->from->getTimezone()->getName()] = $link->from->getTimezone();
        } else {
            $vevent->add('DTSTART', $link->from);
            $timeZones[$link->from->getTimezone()->getName()] = $link->from->getTimezone();

            $vevent->add('DTEND', $link->to);
            $timeZones[$link->to->getTimezone()->getName()] = $link->to->getTimezone();
        }

        if ($link->description) {
            $vevent->add('DESCRIPTION', $link->description);
        }

        if ($link->address) {
            $vevent->add('LOCATION', $link->address);
        }

        $this->addVTimezoneComponents($vcalendar, $timeZones, $link->from, $link->to);

        // Remove non-wanted component
        $vcalendar->remove('PRODID');
        $vevent->remove('DTSTAMP');

        $redirectLink = str_replace("\r\n", '%0d%0a', $vcalendar->serialize());

        return 'data:text/calendar;charset=utf8,'.$redirectLink;
    }

    /** @see https://tools.ietf.org/html/rfc5545.html#section-3.3.11 */
    protected function escapeString(string $field): string
    {
        return addcslashes($field, "\r\n,;");
    }

    /** @see https://tools.ietf.org/html/rfc5545#section-3.8.4.7 */
    protected function generateEventUid(Link $link): string
    {
        return md5($link->from->format(\DateTime::ATOM).$link->to->format(\DateTime::ATOM).$link->title.$link->address);
    }

    protected function addVTimezoneComponents(VCalendar $vcalendar, array $timeZones, \DateTime $from, \DateTime $to)
    {
        foreach ($timeZones as $timeZone) {
            /* @var \DateTimeZone $timeZone */
            if ($timeZone->getName() !== 'UTC') {
                $vcalendar->add(
                    $this->generateVTimeZoneComponent(
                        $vcalendar,
                        $timeZone,
                        $from->getTimestamp(),
                        $to->getTimestamp()
                    )
                );
            }
        }
    }

    /**
     * Returns a VTIMEZONE component for a Olson timezone identifier
     * with daylight transitions covering the given date range.
     *
     * Kinldy inspired from https://gist.github.com/thomascube/47ff7d530244c669825736b10877a200
     * and https://stackoverflow.com/a/25971680
     *
     * @param VCalendar $vcalendar
     * @param \DateTimeZone $timeZone Timezone
     * @param int $from Unix timestamp with first date/time in this timezone
     * @param int $to Unix timestap with last date/time in this timezone
     *
     * @return Component A Sabre\VObject\Component object representing a VTIMEZONE definition
     */
    protected function generateVTimeZoneComponent(VCalendar $vcalendar, \DateTimeZone $timeZone, int $from = 0, int $to = 0)
    {
        if (! $from) {
            $from = time();
        }
        if (! $to) {
            $to = $from;
        }

        // get all transitions for one year back/ahead
        $year = 86400 * 360;
        $transitions = $timeZone->getTransitions($from - $year, $to + $year);

        $vTimeZone = $vcalendar->createComponent('VTIMEZONE');
        $vTimeZone->TZID = $timeZone->getName();

        $std = null;
        $dst = null;
        foreach ($transitions as $i => $trans) {
            $component = null;

$component is not used, you could remove the assignment.

            if ($i === 0) {
                // remember the offset for the next TZOFFSETFROM value
                $tzfrom = $trans['offset'] / 3600;
            }

            // daylight saving time definition
            if ($trans['isdst']) {
                $t_dst = $trans['ts'];
                $dst = $vcalendar->createComponent('DAYLIGHT');
                $component = $dst;
            } // standard time definition
            else {
                $t_std = $trans['ts'];
                $std = $vcalendar->createComponent('STANDARD');
                $component = $std;
            }

            if ($component) {
                $dt = new \DateTime($trans['time']);
                $offset = $trans['offset'] / 3600;

                $component->DTSTART = $dt->format('Ymd\THis');
                $component->TZOFFSETFROM = sprintf('%s%02d%02d', $tzfrom >= 0 ? '+' : '', floor($tzfrom),

The variable $tzfrom does not seem to be defined for all execution paths leading up to this point.

                    ($tzfrom - floor($tzfrom)) * 60);
                $component->TZOFFSETTO = sprintf('%s%02d%02d', $offset >= 0 ? '+' : '', floor($offset),
                    ($offset - floor($offset)) * 60);

                // add abbreviated timezone name if available
                if (! empty($trans['abbr'])) {
                    $component->TZNAME = $trans['abbr'];
                }

                $tzfrom = $offset;
                $vTimeZone->add($component);
            }

            // we covered the entire date range
            if ($std && $dst && min($t_std, $t_dst) < $from && max($t_std, $t_dst) > $to) {

The variable $t_std does not seem to be defined for all execution paths leading up to this point.

The variable $t_dst does not seem to be defined for all execution paths leading up to this point.

                break;
            }
        }

        // add X-MICROSOFT-CDO-TZID if available
        $microsoftExchangeMap = array_flip(TimeZoneUtil::$microsoftExchangeMap);
        if (array_key_exists($timeZone->getName(), $microsoftExchangeMap)) {
            $vTimeZone->add('X-MICROSOFT-CDO-TZID', $microsoftExchangeMap[$timeZone->getName()]);
        }

        return $vTimeZone;
    }
}