# $Id$ ############################################################################## # # 57_Calendar.pm # Copyright by Dr. Boris Neubert # e-mail: omega at online dot de # # This file is part of fhem. # # Fhem is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 2 of the License, or # (at your option) any later version. # # Fhem is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with fhem. If not, see . # ############################################################################## use strict; use warnings; use HttpUtils; use Storable qw(freeze thaw); use POSIX qw(strftime); ############################################## package main; no if $] >= 5.017011, warnings => 'experimental::smartmatch'; # # *** Potential isses: # # There might be issues when turning to daylight saving time and back that # need further investigation. For counterpart please see # http://forum.fhem.de/index.php?topic=18707 # http://forum.fhem.de/index.php?topic=15827 # # *** Potential future extensions: # # sequence of events fired sorted by time # http://forum.fhem.de/index.php?topic=29112 # # document ownCloud ical use # http://forum.fhem.de/index.php?topic=28667 # =for comment RFC --- https://tools.ietf.org/html/rfc5545 Data structures --------------- We call a set of calendar events (short: events) a series, even for sets consisting only of a single event. A series may consist of only one single event, a series of regularly reccuring events and reccuring events with exceptions. A series is identified by a UID. *** VEVENT record, class ICal::Entry In the iCalendar, a series is represented by one or more VEVENT records. The unique key for a VEVENT record is UID, RECURRENCE-ID (3.8.4.4, p. 112) and SEQUENCE (3.8.7.4, p. 138). The internal primary key for a VEVENT is ID. FHEM keeps a set of VEVENT records (record set). When the calendar is updated, a new record set is retrieved from the iCalendar and updates the old record set to form the resultant record set. A record in the resultant record set can be in exactly one of these states: - deleted: a record from the old record set for which no record with the same (UID, RECURRENCE-ID) was in the new record set. - new: a record from the new record set for which no record with same (UID, RECURRENCE-ID) was in the old record set. - changed-old: a record from the old record set for which a record with the same (UID, RECURRENCE-ID) but different SEQUENCE was in the new record set. - changed-new: a record from the new record set for which a record with the same (UID, RECURRENCE-ID) but different SEQUENCE was in the old record set. - known: a record with this (UID, RECURRENCE-ID, SEQUENCE) was both in the old and in the new record set and both records have the same LAST-MODIFIED. The record from the old record set was kept and the record from the new record set was discarded. - modified-new: a record with this (UID, RECURRENCE-ID, SEQUENCE) was both in the old and in the new record set and both records differ in LAST-MODIFIED. This is the record from the new record set. - modified-old: a record with this (UID, RECURRENCE-ID, SEQUENCE) was both in the old and in the new record set and both records differ in LAST-MODIFIED. This is the record from the old record set. Records in states modified-old and changed-old refer to the corresponding records in states modified-new and change-new, and vice versa. Records in state deleted, modified-old or changed-old are removed upon the next update. They are said to be "obsolete". A record is said to be "recurring" if it has a RRULE property. A record is said to be an "exception" if it has a RECURRENCE-ID property. Each records has a set of events attached. *** calendar event, class Calendar::Event Events are attached to single records (VEVENTs). The uid of the event is the UID of the record with all non-alphanumerical characters removed. At a given point in time t, an event is in exactly one of these modes: - upcoming: the start time of the event is in the future - alarm: alarm time <= t < start time for any of the alarms for the event - start: start time <= t <= end time of the event - end: end time < t An event is said to be "changed", when its mode has changed during the most recent run of calendar event processing. An event is said to be "hidden", when - it was in mode end and end time of the event < t - horizonPast, or - it was in mode upcoming and start time of the event > t + horizonFuture at the most recent run of calendar event processing. horizonPast defaults to 0, horizonFuture defaults to 366 days. Processing of iCalendar ----------------------- *** Initial situation: We have an old record set of VEVENTs. It is empty on a restart of FHEM or upon issueing the "set ... reload" command. *** Step 1: Retrieval of new record set (Calendar_GetUpdate) 1) The iCalendar is downloaded from its location into FHEM memory. 2) It is parsed into a new record set of VEVENTs. *** Step 2: Update of internal record set (Calendar_UpdateCalendar) 1) All records in the old record set that are in state deleted or obsolete are removed. 2) All states of all records in the old record set are set to blank. 3) The old and new record sets are merged to create a resultant record set according to the following procedure: If the new record set contains a record with the same (UID, RECURRENCE-ID, SEQUENCE) as a record in the old record set: - if the two records differ in LAST-MODIFIED, then both records are kept. The state of the record from the old record set is set to modified-old, the state of the record from the new record set is set to modified-new. - else the record from the old record set is kept, state set to known, and the record from the new record set is discarded. If the new record set contains a record with the same (UID, RECURRENCE-ID) but different SEQUENCE as a record in the old record set, then both records are kept. The state of the record from the new record set is set to changed-new, and the state of record from the old record set is set to changed-old. If the new record set contains a record that differs from any record in the old record set by both UID and RECURRENCE-ID, the record from the new record set id added to the resultant record set and its state is set to new. 4) The state of all records in the old record set that have not been touched in 3) are set to deleted. Notes: - This procedure favors records from the new record set over records from the old record set, even if the SEQUENCE is lower or LAST-MODIFIED is earlier. - DTSTAMP is the time stamp of the creation of the iCalendar entry. For Google Calendar it is the time stamp of the latest retrieval of the calendar. *** Step 3: Update of calendar events (Calendar_UpdateCalendar) We walk over all records and treat the corresponding events according to the state of the record: - deleted, changed-old, modified-old: all events are removed - new, changed-new, modified-new: all events are removed and events are created anew - known: all events are left alone No events older than 400 days or more than 400 days in the future will be created. Creation of events in a series works as follows: If we have several events in a series, the main series has the RRULE tag and the exceptions have RECURRENCE-IDs. The RECURRENCE-ID match the start dates in the series created from the RRULE that need to be exempted. We therefore collect all events from records with same UID and RECURRENCE-ID set as they form the list of records with the exceptions for the UID. Before the regular creation is done, events for RDATEs are added as long as an RDATE is not superseded by an EXDATE. An RDATE takes precedence over a regularly created recurring event. Starting with the start date of the series, one event is created after the other. Creation stops when the series ends or when an event more than 400 days in the future has been created. If the event is in the list of exceptions (either defined by other events with same UID and a RECURRENCE-ID or by the EXDATE property), it is not added. What attributes are recognized and which of these are honored or ignored? The following frequencies (FREQ) are recognized and honored: SECONDLY MINUTELY HOURLY DAILY WEEKLY BYDAY: recognizes and honors one or several weekdays without prefix (e.g. -1SU, 2MO) MONTHLY BYDAY: recognizes and honors one or several weekdays with and without prefix (e.g. -1SU, 2MO) BYMONTHDAY: recognized but ignored BYMONTH: recognized but ignored YEARLY For all of the above: INTERVAL: recognized and honored UNTIL: recognized and honored COUNT: recognized and honored WKST: recognized but ignored EXDATE: recognized and honored RDATE: recognized and honored *** Step 4: The device readings related to updates are set - calname - lastUpdate - nextUpdate - nextWakeup - state Note: the state... readings from the previous version of this module (2015 and earlier) are not available any more. Processing of calendar events ----------------------------- Calendar_CheckTimes In case of a series of calendar events, several calendar events may exist for the same uid which may be in different modes. Therefore only the most interesting mode is chosen over any other mode of any calendar event with the same uid. The most interesting mode is the first applicable from the following list: - start - alarm - upcoming - end Apart from these actual modes, virtual modes apply: - changed: the actual mode has changed during this call of Calendar_CheckTimes - alarmed: modes are alarm and changed - started: modes are start and changed - ended: modes are end and changed - alarm or start: mode is alarm or start If the mode has changed to , the following FHEM events are created: changed uid uid Note: there is no colon in these FHEM events. Program flow ------------ Calendar_Initialize sets the Calendar_Notify to watch for notifications. Calendar_Notify acts on the INITIALIZED and REREADCFG events by starting the timer to call Calendar_Wakeup between 10 and 29 seconds after the notification. Calendar_Wakeup starts a processing run. It sets the current time t as baseline for process. If the time for the next update has been reached, Calendar_GetUpdate is called else Calendar_CheckTimes Calendar_RearmTimer are called. Calendar_GetUpdate retrieves the iCal file. If the source is url, this is done asynchronously. Upon successfull retrieval of the iCal file, we continue with Calendar_ProcessUpdate. Calendar_ProcessUpdate calls Calendar_UpdateCalendar Calendar_CheckTimes Calendar_RearmTimer in sequence. Calendar_UpdateCalendar updates the VEVENT records in the $hash->{".fhem"}{vevents} hash and creates the associated calendar events. Calendar_CheckTimes checks for a mode change of the calendar events and creates the readings and FHEM events. Calendar_RearmTimer sets the timer to call Calendar_Wakeup to time of the next mode change or update, whatever comes earlier. What's new? ----------- This module version replaces the 2015 version that has been widely. Noteworthy changes - No more state... readings; "all" reading has been removed as well. - The mode... readings (modeAlarm, modeAlarmOrStart, etc.) are deprecated and will be removed in a future version. Use the mode= filter instead. - Handles recurring calendar events with out-of-order events and exceptions (EXDATE). - Keeps ALL calendar events within plus/minus 400 days from the date of the in FHEM: this means that you can have more than one calendar event with the same UID. - You can restrict visible calendar events with attributes hideLaterThan, hideOlderThan. - Nonblocking retrieval of calendar from URL. - New get commands: get vevents get vcalendar get get mode= get uid= - The get commands get ... may not work as before since several calendar events may exist for a single UID, particularly the get command get all show all calendar events from a series (past, current, and future); you probably want to replace "all" by "next": get next to get only the first (not past but current or future) calendar event from each series. - Migration hints: Replace get all by get next Replace get by get uid= 1 Replace get modeAlarmOrStart by get mode=alarm|start - The FHEM events created for mode changes of single calendar events have been amended: changed: UID : UID (this is new) is the current mode of the calendar event after the change. It is highly advisable to trigger actions based on these FHEM events instead of notifications for changes of the mode... readings. =cut ##################################### # # Event # ##################################### package Calendar::Event; sub new { my $class= shift; my $self= {}; # I am a hash bless $self, $class; $self->{_previousMode}= "undefined"; $self->{_mode}= "undefined"; return($self); } sub uid { my ($self)= @_; return $self->{uid}; } sub start { my ($self)= @_; return $self->{start}; } sub end { my ($self)= @_; return $self->{end}; } sub setNote($$) { my ($self,$note)= @_; $self->{_note}= $note; return $note; } sub getNote($) { my ($self)= @_; return $self->{_note}; } sub hasNote($) { my ($self)= @_; return defined($self->{_note}) ? 1 : 0; } sub setMode { my ($self,$mode)= @_; $self->{_previousMode}= $self->{_mode}; $self->{_mode}= $mode; #main::Debug "After setMode $mode: Modes(" . $self->uid() . ") " . $self->{_previousMode} . " -> " . $self->{_mode}; return $mode; } sub setModeUnchanged { my ($self)= @_; $self->{_previousMode}= $self->{_mode}; } sub getMode { my ($self)= @_; return $self->{_mode}; } sub lastModified { my ($self)= @_; return $self->{lastModified}; } sub modeChanged { my ($self)= @_; return (($self->{_mode} ne $self->{_previousMode}) and ($self->{_previousMode} ne "undefined")) ? 1 : 0; } sub summary { my ($self)= @_; return $self->{summary}; } sub location { my ($self)= @_; return $self->{location}; } sub description { my ($self)= @_; return $self->{description}; } sub categories { my ($self)= @_; return $self->{categories}; } sub classfication { my ($self)= @_; return $self->{classification}; } sub ts { my ($self,$tm,$tf)= @_; return "" unless($tm); $tf= $tf // "%d.%m.%Y %H:%M"; return POSIX::strftime($tf, localtime($tm)); } sub ts0 { my ($self,$tm)= @_; return $self->ts($tm, "%d.%m.%y %H:%M"); } # duration as friendly string sub td { # 20d # 47h # 5d 12h # 8d 4:22'04 # my ($self, $d)= @_; return "" unless defined($d); my $s= $d % 60; $d-= $s; $d/= 60; my $m= $d % 60; $d-= $m; $d/= 60; my $h= $d % 24; $d-= $h; $d/= 24; if(24*$d+$h<= 72) { $h+= 24*$d; $d= 0; } my @r= (); push @r, sprintf("%dd", $d) if $d> 0; if($m>0 || $s>0) { my $t= sprintf("%d:%02d", $h, $m); $t+= sprintf("\'%02d", $s) if $s> 0; push @r, $t; } else { push @r, sprintf("%dh", $h) if $h> 0; } return join(" ", @r); } sub asText { my ($self)= @_; return sprintf("%s %s", $self->ts0($self->{start}), $self->{summary} ); } sub asFull { my ($self)= @_; return sprintf("%s %9s %s %s-%s %s %s %s", $self->uid(), $self->getMode(), $self->{alarm} ? $self->ts($self->{alarm}) : " ", $self->ts($self->{start}), $self->ts($self->{end}), $self->{summary}, $self->{categories}, $self->{location} ); } sub asDebug { my ($self)= @_; return sprintf("%s %s %9s %s %s-%s %s %s %s %s", $self->uid(), $self->modeChanged() ? "*" : " ", $self->getMode(), $self->{alarm} ? $self->ts($self->{alarm}) : " ", $self->ts($self->{start}), $self->ts($self->{end}), $self->{summary}, $self->{categories}, $self->{location}, $self->hasNote() ? $self->getNote() : "" ); } sub formatted { my ($self, $format, $timeformat)= @_; my $t1= $self->{start}; my $T1= defined($t1) ? $self->ts($t1, $timeformat) : ""; my $t2= $self->{end}; my $T2= defined($t2) ? $self->ts($t2, $timeformat) : ""; my $a= $self->{alarm}; my $A= defined($a) ? $self->ts($a, $timeformat) : ""; my $S= $self->{summary}; $S=~s/\\,/,/g; my $L= $self->{location}; $L=~s/\\,/,/g; my $CA= $self->{categories}; my $CL= $self->{classification}; my $DS= $self->{description}; $DS=~s/\\,/,/g; my $d= defined($t1) && defined($t2) ? $t2-$t1 : undef; my $D= defined($d) ? $self->td($d) : ""; my $U= $self->uid(); my $M= sprintf("%9s", $self->getMode()); my $r= eval $format; $r= $@ if $@; return $r; } sub alarmTime { my ($self)= @_; return $self->ts($self->{alarm}); } sub startTime { my ($self)= @_; return $self->ts($self->{start}); } sub endTime { my ($self)= @_; return $self->ts($self->{end}); } # returns 1 if time is before alarm time and before start time, else 0 sub isUpcoming { my ($self,$t) = @_; return 0 unless defined($t); if($self->{alarm}) { return $t< $self->{alarm} ? 1 : 0; } else { return $t< $self->{start} ? 1 : 0; } } # returns 1 if time is between alarm time and start time, else 0 sub isAlarmed { my ($self,$t) = @_; return $self->{alarm} ? (($self->{alarm}<= $t && $t< $self->{start}) ? 1 : 0) : 0; } # return 1 if time is between start time and end time, else 0 sub isStarted { my ($self,$t) = @_; return 0 unless(defined($self->{start})); return 0 if($t < $self->{start}); if(defined($self->{end})) { return 0 if($t>= $self->{end}); } return 1; } sub isSeries { my ($self)= @_; #main::Debug " freq= " . $self->{freq}; return exists($self->{freq}) ? 1 : 0; } sub isAfterSeriesEnded { my ($self,$t) = @_; #main::Debug " isSeries? " . $self->isSeries(); return 0 unless($self->isSeries()); #main::Debug " until= " . $self->{until}; return 0 unless(exists($self->{until})); #main::Debug " has until!"; return $self->{until}< $t ? 1 : 0; } sub isEnded { my ($self,$t) = @_; #main::Debug "isEnded for " . $self->asFull(); #main::Debug " isAfterSeriesEnded? " . $self->isAfterSeriesEnded($t); #return 1 if($self->isAfterSeriesEnded($t)); #main::Debug " has end? " . (defined($self->{end}) ? 1 : 0); return 0 unless(defined($self->{end}) && defined($t)); return $self->{end}<= $t ? 1 : 0; } sub nextTime { my ($self,$t) = @_; my @times= ( ); push @times, $self->{start} if(defined($self->{start})); push @times, $self->{end} if(defined($self->{end})); unshift @times, $self->{alarm} if($self->{alarm}); if(defined($t)) { @times= sort grep { $_ > $t } @times; } else { @times= sort @times; } # main::Debug "Calendar: " . $self->asFull(); # main::Debug "Calendar: Start " . main::FmtDateTime($self->{start}); # main::Debug "Calendar: End " . main::FmtDateTime($self->{end}); # main::Debug "Calendar: Alarm " . main::FmtDateTime($self->{alarm}) if($self->{alarm}); # main::Debug "Calendar: times[0] " . main::FmtDateTime($times[0]); # main::Debug "Calendar: times[1] " . main::FmtDateTime($times[1]); # main::Debug "Calendar: times[2] " . main::FmtDateTime($times[2]); if(@times) { return $times[0]; } else { return undef; } } ##################################### # # Events # ##################################### package Calendar::Events; sub new { my $class= shift; my $self= []; # I am an array bless $self, $class; return($self); } sub addEvent($$) { my ($self,$event)= @_; return push @{$self}, $event; } sub clear($) { my ($self)= @_; return @{$self}= (); } ##################################### # # ICal # the ical format is governed by RFC2445 http://www.ietf.org/rfc/rfc2445.txt # ##################################### package ICal::Entry; sub getNextMonthlyDateByDay($$$); sub new($$) { my $class= shift; my ($type)= @_; #main::Debug "new ICal::Entry $type"; my $self= {}; bless $self, $class; $self->{type}= $type; #$self->clearState(); set here: $self->{state}= ""; #$self->clearCounterpart(); unnecessary #$self->clearReferences(); set here: $self->{references}= []; #$self->clearTags(); unnecessary $self->{entries}= []; # array of subordinated ICal::Entry $self->{events}= Calendar::Events->new(); $self->{skippedEvents}= Calendar::Events->new(); return($self); } # # keys, properties, values # # is key a repeated property? sub isMultiple($$) { my ($self,$key)= @_; return $self->{properties}{$key}{multiple}; } # has a property named key? sub hasKey($$) { my ($self,$key)= @_; return exists($self->{properties}{$key}) ? 1 : 0; } # value for single property key sub value($$) { my ($self,$key)= @_; return undef if($self->isMultiple($key)); return $self->{properties}{$key}{VALUE}; } # value for property key or default, if non-existant sub valueOrDefault($$$) { my ($self,$key,$default)= @_; return $self->hasKey($key) ? $self->value($key) : $default; } # value for multiple property key (array counterpart) sub values($$) { my ($self,$key)= @_; return undef unless($self->isMultiple($key)); return $self->{properties}{$key}{VALUES}; } # true, if the property exists at both entries and have the same value # or neither entry has this property sub sameValue($$$) { my ($self,$other,$key)= @_; my $value1= $self->hasKey($key) ? $self->value($key) : ""; my $value2= $other->hasKey($key) ? $other->value($key) : ""; return $value1 eq $value2; } sub parts($$) { my ($self,$key)= @_; return split(";", $self->{properties}{$key}{PARTS}); } # # state # sub setState { my ($self,$state)= @_; $self->{state}= $state; return $state; } sub clearState { my ($self)= @_; $self->{state}= ""; } sub state($) { my($self)= @_; return $self->{state}; } sub inState($$) { my($self, $state)= @_; return ($self->{state} eq $state ? 1 : 0); } sub isObsolete($) { my($self)= @_; # VEVENT records in these states are obsolete my @statesObsolete= qw/deleted changed-old modified-old/; return $self->state() ~~ @statesObsolete ? 1 : 0; } sub hasChanged($) { my($self)= @_; # VEVENT records in these states have changed my @statesChanged= qw/new changed-new modified-new/; return $self->state() ~~ @statesChanged ? 1 : 0; } # # type # sub type($) { my($self)= @_; return $self->{type}; } # # counterpart, for changed or modified records # sub counterpart($) { my($self)= @_; return $self->{counterpart}; } sub setCounterpart($$) { my ($self, $id)= @_; $self->{counterpart}= $id; return $id; } sub hasCounterpart($) { my($self)= @_; return (defined($self->{counterpart}) ? 1 : 0); } sub clearCounterpart($) { my($self)= @_; delete $self->{counterpart} if(defined($self->{counterpart})); } # # series # sub isRecurring($) { my($self)= @_; return $self->hasKey("RRULE"); } sub isException($) { my($self)= @_; return $self->hasKey("RECURRENCE-ID"); } sub isCancelled($) { my($self)= @_; return (($self->valueOrDefault("STATUS","CONFIRMED") eq "CANCELLED") ? 1 : 0); } sub hasReferences($) { my($self)= @_; return scalar(@{$self->references()}); } sub references($) { my($self)= @_; return $self->{references}; } sub clearReferences($) { my($self)= @_; $self->{references}= []; } # # tags # # sub tags($) { # my($self)= @_; # return $self->{tags}; # } # # sub clearTags($) { # my($self)= @_; # $self->{tags}= []; # } # # sub tagAs($$) { # my ($self, $tag)= @_; # push @{$self->{tags}}, $tag unless($self->isTaggedAs($tag)); # } # # sub isTaggedAs($$) { # my ($self, $tag)= @_; # return grep { $_ eq $tag } @{$self->{tags}} ? 1 : 0; # } # # sub numTags($) { # my ($self)= @_; # return scalar @{$self->{tags}}; # } # # parsing # sub addproperty($$) { my ($self,$line)= @_; # contentline = name *(";" param ) ":" value CRLF [Page 13] # example: # TRIGGER;VALUE=DATE-TIME:20120531T150000Z #main::Debug "line=\'$line\'"; # for DTSTART, DTEND there are several variants: # DTSTART;TZID=Europe/Berlin:20140205T183600 # * DTSTART;TZID="(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna":20140904T180000 # DTSTART:20140211T212000Z # DTSTART;VALUE=DATE:20130619 my ($key,$parts,$parameter); if($line =~ /^([\w\d\-]+)(;(.*))?:(.*)$/) { $key= $1; $parts= $3 // ""; $parameter= $4 // ""; } else { return; } return unless($key); #main::Debug "addproperty for key $key"; # ignore some properties # commented out: it is faster to add the property than to do the check # return if(($key eq "ATTENDEE") or ($key eq "TRANSP") or ($key eq "STATUS")); return if(substr($key,0,2) eq "^X-"); if(($key eq "RDATE") or ($key eq "EXDATE")) { #main::Debug "addproperty for dates"; # handle multiple properties my @values; @values= @{$self->values($key)} if($self->hasKey($key)); push @values, $parameter; #main::Debug "addproperty pushed parameter $parameter to key $key"; $self->{properties}{$key}= { multiple => 1, VALUES => \@values, } } else { # handle single properties $self->{properties}{$key}= { multiple => 0, PARTS => "$parts", VALUE => "$parameter", } }; } sub parse($$) { my ($self,$ics)= @_; # This is the proper way to do it, with \R corresponding to (?>\r\n|\n|\x0b|\f|\r|\x85|\x2028|\x2029) # my @ical= split /\R/, $ics; # Tt does not treat some unicode emojis correctly, though. # We thus go for the the DOS/Windows/Unix/Mac classic variants. # Suggested reading: # http://stackoverflow.com/questions/3219014/what-is-a-cross-platform-regex-for-removal-of-line-breaks my @ical= split /(?>\r\n|[\r\n])/, $ics; return $self->parseSub(0, \@ical); } sub parseSub($$$) { my ($self,$ln,$icalref)= @_; my $len= scalar @$icalref; #main::Debug "lines= $len"; #main::Debug "ENTER @ $ln"; while($ln< $len) { my $line= $$icalref[$ln]; $ln++; # check for and handle continuation lines (4.1 on page 12) while($ln< $len) { my $line1= $$icalref[$ln]; last if(substr($line1,0,1) ne " "); $line.= substr($line1,1); $ln++; }; #main::Debug "$ln: $line"; next if($line eq ""); # ignore empty line last if(substr($line,0,4) eq "END:"); if(substr($line,0,6) eq "BEGIN:") { my $entry= ICal::Entry->new(substr($line,6)); $entry->{ln}= $ln; push @{$self->{entries}}, $entry; $ln= $entry->parseSub($ln,$icalref); } else { $self->addproperty($line); } } #main::Debug "BACK"; return $ln; } # # events # sub events($) { my ($self)= @_; return $self->{events}; } sub clearEvents($) { my ($self)= @_; $self->{events}->clear(); } sub numEvents($) { my ($self)= @_; return scalar(@{$self->{events}}); } sub addEvent($$) { my ($self, $event)= @_; $self->{events}->addEvent($event); } sub skippedEvents($) { my ($self)= @_; return $self->{skippedEvents}; } sub clearSkippedEvents($) { my ($self)= @_; $self->{skippedEvents}->clear(); } sub numSkippedEvents($) { my ($self)= @_; return scalar(@{$self->{skippedEvents}}); } sub addSkippedEvent($$) { my ($self, $event)= @_; $self->{skippedEvents}->addEvent($event); } sub createEvent($) { my ($self)= @_; my $event= Calendar::Event->new(); $event->{uid}= $self->value("UID"); $event->{uid}=~ s/\W//g; # remove all non-alphanumeric characters, this makes life easier for perl specials return $event; } # converts a date/time string to the number of non-leap seconds since the epoch # 20120520T185202Z: date/time string in ISO8601 format, time zone GMT # 20121129T222200: date/time string in ISO8601 format, time zone local # 20120520: a date string has no time zone associated sub tm($$) { my ($self, $t)= @_; return undef if(!$t); #main::Debug "convert >$t<"; my ($year,$month,$day)= (substr($t,0,4), substr($t,4,2),substr($t,6,2)); if(length($t)>8) { my ($hour,$minute,$second)= (substr($t,9,2), substr($t,11,2),substr($t,13,2)); my $z; $z= substr($t,15,1) if(length($t) == 16); #main::Debug "$day.$month.$year $hour:$minute:$second $z"; if($z) { return main::fhemTimeGm($second,$minute,$hour,$day,$month-1,$year-1900); } else { return main::fhemTimeLocal($second,$minute,$hour,$day,$month-1,$year-1900); } } else { #main::Debug "$day.$month.$year"; return main::fhemTimeLocal(0,0,0,$day,$month-1,$year-1900); } } # DURATION RFC2445 # dur-value = (["+"] / "-") "P" (dur-date / dur-time / dur-week) # # dur-date = dur-day [dur-time] # dur-time = "T" (dur-hour / dur-minute / dur-second) # dur-week = 1*DIGIT "W" # dur-hour = 1*DIGIT "H" [dur-minute] # dur-minute = 1*DIGIT "M" [dur-second] # dur-second = 1*DIGIT "S" # dur-day = 1*DIGIT "D" # # example: -P0DT0H30M0S sub d($$) { my ($self, $d)= @_; #main::Debug "Duration $d"; my $sign= 1; my $t= 0; my @c= split("P", $d); $sign= -1 if($c[0] eq "-"); my ($dw,$dt)= split("T", $c[1]); $dt="" unless defined($dt); if($dw =~ m/(\d+)D$/) { $t+= 86400*$1; # days } elsif($dw =~ m/(\d+)W$/) { $t+= 604800*$1; # weeks } if($dt =~ m/(\d+)H/) { $t+= $1*3600; } if($dt =~ m/(\d+)M/) { $t+= $1*60; } if($dt =~ m/(\d+)S/) { $t+= $1; } $t*= $sign; #main::Debug "sign: $sign dw: $dw dt: $dt t= $t"; return $t; } sub dt($$$$) { my ($self,$t0,$value,$parts)= @_; #main::Debug "t0= $t0 parts= $parts value= $value"; if(defined($parts) && $parts =~ m/VALUE=DATE/) { return $self->tm($value); } else { return $t0+$self->d($value); } } sub makeEventDetails($$) { my ($self, $event)= @_; $event->{summary}= $self->valueOrDefault("SUMMARY", ""); $event->{location}= $self->valueOrDefault("LOCATION", ""); $event->{description}= $self->valueOrDefault("DESCRIPTION", ""); $event->{categories}= $self->valueOrDefault("CATEGORIES", ""); $event->{classification}= $self->valueOrDefault("CLASS", "PUBLIC"); return $event; } sub makeEventAlarms($$) { my ($self, $event)= @_; # alarms my @valarms= grep { $_->{type} eq "VALARM" } @{$self->{entries}}; my @alarmtimes= sort map { $self->dt($event->{start}, $_->value("TRIGGER"), $_->parts("TRIGGER")) } @valarms; if(@alarmtimes) { $event->{alarm}= $alarmtimes[0]; } else { $event->{alarm}= undef; } return $event; } sub DSTOffset($$) { my ($t1,$t2)= @_; my @lt1 = localtime($t1); my @lt2 = localtime($t2); return 3600 *($lt1[8] - $lt2[8]); } # This function adds $n times $seconds to $t1 (seconds from the epoch). # A correction of 3600 seconds (one hour) is applied if and only if # one of $t1 and $t1+$n*$seconds falls into wintertime and the other # into summertime. Thus, e.g., adding a multiple of 24*60*60 seconds # to 5 o'clock always gives 5 o'clock and not 4 o'clock or 6 o'clock # upon a change of summertime to wintertime or vice versa. sub plusNSeconds($$$) { my ($t1, $seconds, $n)= @_; $n= 1 unless defined($n); my $t2= $t1+$n*$seconds; return $t2+DSTOffset($t1,$t2); } sub plusNMonths($$) { my ($tm, $n)= @_; my ($second,$minute,$hour,$day,$month,$year,$wday,$yday,$isdst)= localtime($tm); #main::Debug "Adding $n months to $day.$month.$year $hour:$minute:$second= " . ts($tm); $month+= $n; $year+= int($month / 12); $month %= 12; #main::Debug " gives $day.$month.$year $hour:$minute:$second= " . ts(main::fhemTimeLocal($second,$minute,$hour,$day,$month,$year)); return main::fhemTimeLocal($second,$minute,$hour,$day,$month,$year); } # This function gets the next date according to interval and byDate # Alex, 2016-11-24 # 1. parameter: startTime # 2. parameter: interval (months) # 3. parameter: byDay (string with byDay-value(s), e.g. "FR" or "4SA" or "-1SU" or "4SA,4SU" (not sure if this is possible, i just take the first byDay)) sub getNextMonthlyDateByDay($$$) { my ( $ipTimeLocal, $ipByDays, $ipInterval )= @_; my ($lSecond, $lMinute, $lHour, $lDay, $lMonth, $lYear, $lWday, $lYday, $lIsdst )= localtime( $ipTimeLocal ); #main::Debug "getNextMonthlyDateByDay($ipTimeLocal, $ipByDays, $ipInterval)"; my @lByDays = split(",", $ipByDays); my $lByDay = $lByDays[0]; #only get first day element within string my $lByDayLength = length( $lByDay ); my $lDayStr; # which day to set the date my $lDayInterval; # e.g. 2 = 2nd $lDayStr of month or -1 = last $lDayStr of month if ( $lByDayLength > 2 ) { $lDayStr= substr( $lByDay, -2 ); $lDayInterval= int( substr( $lByDay, 0, $lByDayLength - 2 ) ); } else { $lDayStr= $lByDay; $lDayInterval= 1; } my @weekdays = qw(SU MO TU WE TH FR SA); my ($lDayOfWeek)= grep { $weekdays[$_] eq $lDayStr } 0..$#weekdays; # get next day from beginning of the month, e.g. "4FR" = 4th friday of the month my $lNextMonth; my $lNextYear; my $lDayOfWeekNew; my $lDaysToAddOrSub; my $lNewTime; if ( $lDayInterval > 0 ) { #get next month and year according to $ipInterval $lNextMonth= $lMonth + $ipInterval; $lNextYear= $lYear; $lNextYear += int( $lNextMonth / 12); $lNextMonth %= 12; my $lFirstOfNextMonth = main::fhemTimeLocal( $lSecond, $lMinute, $lHour, 1, $lNextMonth, $lNextYear ); ($lSecond, $lMinute, $lHour, $lDay, $lMonth, $lYear, $lDayOfWeekNew, $lYday, $lIsdst )= localtime( $lFirstOfNextMonth ); if ( $lDayOfWeekNew <= $lDayOfWeek ) { $lDaysToAddOrSub = $lDayOfWeek - $lDayOfWeekNew; } else { $lDaysToAddOrSub = 7 - $lDayOfWeekNew + $lDayOfWeek; } $lDaysToAddOrSub += ( 7 * ( $lDayInterval - 1 ) ); #add day interval, e.g. 4th friday... $lNewTime = plusNSeconds( $lFirstOfNextMonth, 24*60*60*$lDaysToAddOrSub, 1); ($lSecond, $lMinute, $lHour, $lDay, $lMonth, $lYear, $lWday, $lYday, $lIsdst )= localtime( $lNewTime ); if ( $lMonth ne $lNextMonth ) { #skip this date and move on to the next interval... $lNewTime = getNextMonthlyDateByDay( $lFirstOfNextMonth, $ipByDays, $ipInterval ); } } else { #calculate date from end of month #get next month and year according to ipInterval $lNextMonth = $lMonth + $ipInterval + 1; #first get the month after the desired month $lNextYear = $lYear; $lNextYear += int( $lNextMonth / 12); $lNextMonth %= 12; my $lLastOfNextMonth = main::fhemTimeLocal( $lSecond, $lMinute, $lHour, 1, $lNextMonth, $lNextYear ); # get time $lLastOfNextMonth = plusNSeconds( $lLastOfNextMonth, -24*60*60, 1 ); #subtract one day ($lSecond, $lMinute, $lHour, $lDay, $lMonth, $lYear, $lDayOfWeekNew, $lYday, $lIsdst )= localtime( $lLastOfNextMonth ); if ( $lDayOfWeekNew >= $lDayOfWeek ) { $lDaysToAddOrSub = $lDayOfWeekNew - $lDayOfWeek; } else { $lDaysToAddOrSub = 7 - $lDayOfWeek + $lDayOfWeekNew; } $lDaysToAddOrSub += ( 7 * ( abs( $lDayInterval ) - 1 ) ); $lNewTime = plusNSeconds( $lLastOfNextMonth, -24*60*60*$lDaysToAddOrSub, 1); } #main::Debug "lByDay = $lByDay, lByDayLength = $lByDayLength, lDay = $lDay, lDayInterval = $lDayInterval, lDayOfWeek = $lDayOfWeek, lFirstOfNextMonth = $lFirstOfNextMonth, lNextYear = $lNextYear, lNextMonth = $lNextMonth"; #main::Debug main::FmtDateTime($lNewTime); return $lNewTime; } use constant eventsLimitMinus => -34560000; # -400d use constant eventsLimitPlus => 34560000; # +400d sub addEventLimited($$$) { my ($self, $t, $event)= @_; return -1 if($event->start()< $t+eventsLimitMinus); return 1 if($event->start()> $t+eventsLimitPlus); $self->addEvent($event); #main::Debug " addEventLimited: " . $event->asDebug(); return 0; } # 0= SU ... 6= SA sub weekdayOf($$) { my ($self, $t)= @_; my (undef, undef, undef, undef, undef, undef, $weekday, undef, undef) = localtime($t); return $weekday; } sub createSingleEvent($$$$) { my ($self, $nextstart, $onCreateEvent)= @_; my $event= $self->createEvent(); my $start= $self->tm($self->value("DTSTART")); $nextstart= $start unless(defined($nextstart)); $event->{start}= $nextstart; if($self->hasKey("DTEND")) { my $end= $self->tm($self->value("DTEND")); $event->{end}= $nextstart+($end-$start); } elsif($self->hasKey("DURATION")) { my $duration= $self->d($self->value("DURATION")); $event->{end}= $nextstart + $duration; } $self->makeEventDetails($event); $self->makeEventAlarms($event); #main::Debug "createSingleEvent DTSTART=" . $self->value("DTSTART") . " DTEND=" . $self->value("DTEND"); #main::Debug "createSingleEvent Start " . main::FmtDateTime($event->{start}); #main::Debug "createSingleEvent End " . main::FmtDateTime($event->{end}); # plug-in if(defined($onCreateEvent)) { my $e= $event; #main::Debug "Executing $onCreateEvent for " . $e->asDebug(); eval $onCreateEvent; if($@) { main::Log3 undef, 2, "Erroneous onCreateEvent $onCreateEvent: $@"; } else { $event= $e; } } return $event; } sub excludeByExdate($$) { my ($self, $event)= @_; my $skip= 0; if($self->hasKey('EXDATE')) { foreach my $exdate (@{$self->values("EXDATE")}) { if($self->tm($exdate) == $event->start()) { $skip++; $event->setNote("EXDATE: $exdate"); $self->addSkippedEvent($event); last; } } # end of foreach exdate } # end of EXDATE checking return $skip; } sub excludeByReference($$$) { my ($self, $event, $veventsref)= @_; my $skip= 0; # check if superseded by out-of-series event if($self->hasReferences()) { foreach my $id (@{$self->references()}) { my $vevent= $veventsref->{$id}; my $recurrenceid= $vevent->value("RECURRENCE-ID"); my $originalstart= $vevent->tm($recurrenceid); if($originalstart == $event->start()) { $event->setNote("RECURRENCE-ID: $recurrenceid"); $self->addSkippedEvent($event); $skip++; last; } } } return $skip; } sub excludeByRdate($$) { my ($self, $event)= @_; my $skip= 0; # check if excluded by a duplicate RDATE # this is only to avoid duplicates from previously added RDATEs if($self->hasKey('RDATE')) { foreach my $rdate (@{$self->values("RDATE")}) { if($self->tm($rdate) == $event->start()) { $event->setNote("RDATE: $rdate"); $self->addSkippedEvent($event); $skip++; last; } } } return $skip; } # we return 0 if the storage limit is exceeded or the number of occurances is reached # we return 1 else no matter if this evevent was added or skipped sub addOrSkipSeriesEvent($$$$$$) { my ($self, $event, $t0, $until, $count, $veventsref)= @_; #main::Debug " addOrSkipSeriesEvent: " . $event->asDebug(); return if($event->{start} > $until); # return if we are after end of series my $skip= 0; # check if superseded by out-of-series event $skip+= $self->excludeByReference($event, $veventsref); # RFC 5545 p. 120 # The final recurrence set is generated by gathering all of the # start DATE-TIME values generated by any of the specified "RRULE" # and "RDATE" properties, and then excluding any start DATE-TIME # values specified by "EXDATE" properties. This implies that start # DATE-TIME values specified by "EXDATE" properties take precedence # over those specified by inclusion properties (i.e., "RDATE" and # "RRULE"). Where duplicate instances are generated by the "RRULE" # and "RDATE" properties, only one recurrence is considered. # Duplicate instances are ignored. # check if excluded by EXDATE $skip+= $self->excludeByExdate($event); # check if excluded by a duplicate RDATE # this is only to avoid duplicates from previously added RDATEs $skip+= $self->excludeByRdate($event); if(!$skip) { # add event # and return if we exceed storage limit my $x= $self->addEventLimited($t0, $event); #main::Debug "addEventLimited returned $x"; return 0 if($x> 0); #return 0 if($self->addEventLimited($t0, $event) > 0); } my $occurances= scalar(@{$self->{events}})+scalar(@{$self->{skippedEvents}}); #main::Debug("$occurances occurances so far"); return($occurances< $count); } sub createEvents($$$%) { my ($self, $t0, $onCreateEvent, %vevents)= @_; # t0 is today (for limits) $self->clearEvents(); $self->clearSkippedEvents(); if($self->isRecurring()) { # # recurring event creates a series # my $rrule= $self->value("RRULE"); my @rrparts= split(";", $rrule); my %r= map { split("=", $_); } @rrparts; my @keywords= qw(FREQ INTERVAL UNTIL COUNT BYMONTHDAY BYDAY BYMONTH WKST); foreach my $k (keys %r) { if(not($k ~~ @keywords)) { main::Log3 undef, 2, "Calendar: keyword $k in RRULE $rrule is not supported"; } else { #main::Debug "keyword $k in RRULE $rrule has value $r{$k}"; } } # Valid values for freq: SECONDLY, MINUTELY, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY my $freq = $r{"FREQ"}; #main::Debug "FREQ= $freq"; # According to RFC, interval defaults to 1 my $interval = exists($r{"INTERVAL"}) ? $r{"INTERVAL"} : 1; my $until = exists($r{"UNTIL"}) ? $self->tm($r{"UNTIL"}) : 99999999999999999; my $count = exists($r{"COUNT"}) ? $r{"COUNT"} : 999999; my $bymonthday = $r{"BYMONTHDAY"} if(exists($r{"BYMONTHDAY"})); # stored but ignored my $byday = exists($r{"BYDAY"}) ? $r{"BYDAY"} : ""; #main::Debug "byday is $byday"; my $bymonth = $r{"BYMONTH"} if(exists($r{"BYMONTH"})); # stored but ignored my $wkst = $r{"WKST"} if(exists($r{"WKST"})); # stored but ignored my @weekdays = qw(SU MO TU WE TH FR SA); #main::Debug "createEvents: " . $self->asString(); # # we first add all RDATEs # if($self->hasKey('RDATE')) { foreach my $rdate (@{$self->values("RDATE")}) { my $event= $self->createSingleEvent($self->tm($rdate), $onCreateEvent); my $skip= 0; if($self->hasKey('EXDATE')) { foreach my $exdate (@{$self->values("EXDATE")}) { if($self->tm($exdate) == $event->start()) { $event->setNote("EXDATE: $exdate for RDATE: $rdate"); $self->addSkippedEvent($event); $skip++; last; } } } if(!$skip) { # add event $event->setNote("RDATE: $rdate"); $self->addEventLimited($t0, $event); } } } # # now we build the series # #main::Debug "building series..."; # first event in the series my $event= $self->createSingleEvent(undef, $onCreateEvent); return if(!$self->addOrSkipSeriesEvent($event, $t0, $until, $count, \%vevents)); my $nextstart = $event->{start}; #main::Debug "start: " . $event->ts($nextstart); if(($freq eq "WEEKLY") && ($byday ne "")) { # special handling for WEEKLY and BYDAY # BYDAY with prefix (e.g. -1SU or 2MO) is not recognized #main::Debug "weekly event, BYDAY= $byday"; my @bydays= split(',', $byday); # we assume a week from MO to SU # we need to cover situations similar to: # BYDAY= TU,WE,TH and start is WE or end is WE # loop over days, skip over weeks # e.g. TH, FR, SA, SU / ... / MO, TU, WE while(1) { # next day $nextstart= plusNSeconds($nextstart, 24*60*60, 1); my $weekday= $self->weekdayOf($nextstart); # if we reach MO, then skip ($interval-1) weeks $nextstart= plusNSeconds($nextstart, 7*24*60*60, $interval-1) if($weekday==1); #main::Debug "Skip to: start " . $event->ts($nextstart) . " = " . $weekdays[$weekday]; if($weekdays[$weekday] ~~ @bydays) { my $event= $self->createSingleEvent($nextstart, $onCreateEvent); return if(!$self->addOrSkipSeriesEvent($event, $t0, $until, $count, \%vevents)); } } } else { # handling for events with equal time spacing while(1) { # advance to next occurance if($freq eq "SECONDLY") { $nextstart = plusNSeconds($nextstart, 1, $interval); } elsif($freq eq "MINUTELY") { $nextstart = plusNSeconds($nextstart, 60, $interval); } elsif($freq eq "HOURLY") { $nextstart = plusNSeconds($nextstart, 60*60, $interval); } elsif($freq eq "DAILY") { $nextstart = plusNSeconds($nextstart, 24*60*60, $interval); } elsif($freq eq "WEEKLY") { # default WEEKLY handling $nextstart = plusNSeconds($nextstart, 7*24*60*60, $interval); } elsif($freq eq "MONTHLY") { if ( $byday ne "" ) { $nextstart = getNextMonthlyDateByDay( $nextstart, $byday, $interval ); } else { # here we ignore BYMONTHDAY as we consider the day of month of $self->{start} # to be equal to BYMONTHDAY. $nextstart= plusNMonths($nextstart, $interval); } } elsif($freq eq "YEARLY") { $nextstart= plusNMonths($nextstart, 12*$interval); } else { main::Log3 undef, 2, "Calendar: event frequency '$freq' not implemented"; return; } # the next event #main::Debug "Skip to: start " . $event->ts($nextstart); $event= $self->createSingleEvent($nextstart, $onCreateEvent); return if(!$self->addOrSkipSeriesEvent($event, $t0, $until, $count, \%vevents)); } } } else { # # single event # my $event= $self->createSingleEvent(undef, $onCreateEvent); $self->addEventLimited($t0, $event); } } # # friendly string # sub asString($$) { my ($self,$level)= @_; $level= "" unless(defined($level)); my $s= $level . $self->{type}; $s.= " @" . $self->{ln} if(defined($self->{ln})); $s.= " ["; $s.= "obsolete, " if($self->isObsolete()); $s.= $self->state(); $s.= ", refers to " . $self->counterpart() if($self->hasCounterpart()); $s.= ", in a series with " . join(",", sort @{$self->references()}) if($self->hasReferences()); $s.= "]"; #$s.= " (tags: " . join(",", @{$self->tags()}) . ")" if($self->numTags()); $s.= "\n"; $level .= " "; for my $key (sort keys %{$self->{properties}}) { $s.= $level . "$key: "; if($self->{properties}{$key}{multiple}) { $s.= "(" . join(" ", @{$self->values($key)}) . ")"; } else { $s.= $self->value($key); } $s.= "\n"; } if($self->{type} eq "VEVENT") { if($self->isRecurring()) { $s.= $level . ">>> is a series\n"; } if($self->isException()) { $s.= $level . ">>> is an exception\n"; } $s.= $level . ">>> Events:\n"; foreach my $event (@{$self->{events}}) { $s.= "$level " . $event->asDebug() . "\n"; } $s.= $level . ">>> Skipped events:\n"; foreach my $event (@{$self->{skippedEvents}}) { $s.= "$level " . $event->asDebug() . "\n"; } } my @entries= @{$self->{entries}}; for(my $i= 0; $i<=$#entries; $i++) { $s.= $entries[$i]->asString($level); } return $s; } ########################################################################## # # main # ########################################################################## package main; ##################################### sub Calendar_Initialize($) { my ($hash) = @_; $hash->{DefFn} = "Calendar_Define"; $hash->{UndefFn} = "Calendar_Undef"; $hash->{GetFn} = "Calendar_Get"; $hash->{SetFn} = "Calendar_Set"; $hash->{AttrFn} = "Calendar_Attr"; $hash->{NotifyFn}= "Calendar_Notify"; $hash->{AttrList}= "update:sync,async,none removevcalendar:0,1 " . "cutoffOlderThan hideOlderThan hideLaterThan onCreateEvent " . "ignoreCancelled:0,1 " . "SSLVerify:0,1 defaultFormat defaultTimeFormat " . $readingFnAttributes; } ##################################### sub Calendar_Define($$) { my ($hash, $def) = @_; # define Calendar ical URL [interval] my @a = split("[ \t][ \t]*", $def); return "syntax: define Calendar ical url [interval]\n".\ " define Calendar ical file [interval]" if(($#a < 4 && $#a > 5) || ($a[2] ne 'ical') || (($a[3] ne 'url') && ($a[3] ne 'file'))); $hash->{NOTIFYDEV} = "global"; readingsSingleUpdate($hash, "state", "initialized", 1); my $name = $a[0]; my $type = $a[3]; my $url = $a[4]; my $interval = 3600; $interval= $a[5] if($#a==5); $hash->{".fhem"}{type}= $type; $hash->{".fhem"}{url}= $url; $hash->{".fhem"}{interval}= $interval; $hash->{".fhem"}{lastid}= 0; $hash->{".fhem"}{vevents}= {}; $hash->{".fhem"}{nxtUpdtTs}= 0; #$attr{$name}{"hideOlderThan"}= 0; #main::Debug "Interval: ${interval}s"; # if initialization is not yet done, we do not wake up at this point already to # avoid the following race condition: # events are loaded from fhem.save and data are updated asynchronousy from # non-blocking Http get Calendar_Wakeup($hash, 0) if($init_done); return undef; } ##################################### sub Calendar_Undef($$) { my ($hash, $arg) = @_; Calendar_DisarmTimer($hash); if(exists($hash->{".fhem"}{subprocess})) { my $subprocess= $hash->{".fhem"}{subprocess}; $subprocess->terminate(); $subprocess->wait(); } return undef; } ##################################### sub Calendar_Attr(@) { my ($cmd, $name, @a) = @_; return undef unless($cmd eq "set"); my $hash= $defs{$name}; return "attr $name needs at least one argument." if(!@a); my $arg= $a[1]; if($a[0] eq "onCreateEvent") { if($arg !~ m/^{.*}$/s) { return "$arg must be a perl command in curly brackets but you supplied $arg."; } } elsif($a[0] eq "update") { my @args= qw/none sync async/; return "Argument for update must be one of " . join(" ", @args) . " instead of $arg." unless($arg ~~ @args); } return undef; } ################################### sub Calendar_Notify($$) { my ($hash,$dev) = @_; my $name = $hash->{NAME}; my $type = $hash->{TYPE}; return if($dev->{NAME} ne "global"); return if(!grep(m/^INITIALIZED|REREADCFG$/, @{$dev->{CHANGED}})); return if($attr{$name} && $attr{$name}{disable}); # update calendar after initialization or change of configuration # wait 10 to 29 seconds to avoid congestion due to concurrent activities Calendar_DisarmTimer($hash); my $delay= 10+int(rand(20)); # delay removed until further notice $delay= 2; Log3 $hash, 5, "Calendar $name: FHEM initialization or rereadcfg triggered update, delay $delay seconds."; InternalTimer(time()+$delay, "Calendar_Wakeup", $hash, 0) ; return undef; } ################################### sub Calendar_Set($@) { my ($hash, @a) = @_; my $cmd= $a[1]; $cmd= "?" unless($cmd); my $t= time(); # usage check if((@a == 2) && ($a[1] eq "update")) { Calendar_DisarmTimer($hash); Calendar_GetUpdate($hash, $t, 0); return undef; } elsif((@a == 2) && ($a[1] eq "reload")) { Calendar_DisarmTimer($hash); Calendar_GetUpdate($hash, $t, 1); # remove all events before update return undef; } else { return "Unknown argument $cmd, choose one of update:noArg reload:noArg"; } } ################################### # everything within matching single or double quotes is literally copied # everything within braces is literally copied, nesting braces is allowed # use \ to mask quotes and braces # parts are separated by one or more spaces sub Calendar_simpleParseWords($;$) { my ($p,$separator)= @_; $separator= " " unless defined($separator); my $quote= undef; my $braces= 0; my @parts= (); # resultant array of space-separated parts my @chars= split(//, $p); # split into characters my $escape= 0; # escape mode off my @part= (); # the current part for my $c (@chars) { #Debug "checking $c, quote is " . (defined($quote) ? $quote : "empty") . ", braces is $braces"; push @part, $c; # append the character to the current part if($escape) { $escape= 0; next; } # continue and turn escape mode off if escape mode is on if(($c eq $separator) && !$braces && !defined($quote)) { # we have encountered a space outside quotes and braces #Debug " break"; pop @part; # remove the space push @parts, join("", @part) if(@part); # add the completed part if non-empty @part= (); next; } $escape= ($c eq "\\"); next if($escape); # escape mode on #Debug " not escaped"; if(($c eq "\"") || ($c eq "\'")) { #Debug " quote"; if(defined($quote)) { if($c eq $quote) { $quote= undef; } } else { $quote= $c; } next; } next if defined($quote); if($c eq "{") { $braces++; next; } # opening brace if($c eq "}") { # closing brace return("closing brace without matching opening brace", undef) unless($braces); $braces--; } } return("opening quote $quote without matching closing quote", undef) if(defined($quote)); return("$braces opening brace(s) without matching closing brace(s)", undef) if($braces); push @parts, join("", @part) if(@part); # add the completed part return(undef, \@parts); } sub Calendar_Get($@) { my ($hash, @a) = @_; my $name= $hash->{NAME}; my $t= time(); my $eventsObj= $hash->{".fhem"}{events}; my @events; #Debug "Command line: " . join(" ", @a); my $cmd= $a[1]; $cmd= "?" unless($cmd); # -------------------------------------------------------------------------- if($cmd eq "update") { # this is the same as set update for convenience Calendar_DisarmTimer($hash); Calendar_GetUpdate($hash, $t, 0, 1); return undef; } # -------------------------------------------------------------------------- if($cmd eq "reload") { # this is the same as set reload for convenience Calendar_DisarmTimer($hash); Calendar_GetUpdate($hash, $t, 1, 1); # remove all events before update return undef; } # -------------------------------------------------------------------------- if($cmd eq "events") { # see https://forum.fhem.de/index.php/topic,46608.msg397309.html#msg397309 for ideas # get myCalendar events # filter:mode=alarm|start|upcoming # format:custom={ sprintf("...") } # series:next=3 # attr myCalendar defaultFormat my $format= AttrVal($name, "defaultFormat", '"$T1 $D $S"'); my $timeFormat= AttrVal($name, "defaultTimeFormat",'%d.%m.%Y %H:%M'); my @filters= (); my $next= undef; my $count= undef; my ($paramerror, $arrayref)= Calendar_simpleParseWords(join(" ", @a)); return "$name: Parameter parse error: $paramerror" if(defined($paramerror)); my @a= @{$arrayref}; shift @a; shift @a; # remove name and "events" for my $p (@a) { ### format if($p =~ /^format:(.+)$/) { my $v= $1; if($v eq "default") { # as if it were not there at all } elsif($v eq "full") { $format= '"$U $M $A $T1-$T2 $S $CA $L"'; } elsif($v eq "text") { $format= '"$T1 $S"'; } elsif($v =~ /^custom=['"](.+)['"]$/) { $format= '"'.$1.'"'; } elsif($v =~ /^custom=(\{.+\})$/) { $format= $1; #Debug "Format=$format"; } else { return "$name: Illegal format specification: $v"; } ### timeFormat } elsif($p =~ /^timeFormat:['"](.+)['"]$/) { $timeFormat= $1; ### filter } elsif($p =~ /^filter:(.+)$/) { my ($filtererror, $filterarrayref)= Calendar_simpleParseWords($1, ","); return "$name: Filter parse error: $filtererror" if(defined($filtererror)); my @filterspecs= @{$filterarrayref}; for my $filterspec (@filterspecs) { #Debug "Filter specification: $filterspec"; if($filterspec =~ /^mode==['"](.+)['"]$/) { push @filters, { ref => \&filter_mode, param => $1 } } elsif($filterspec =~ /^mode=~['"](.+)['"]$/) { push @filters, { ref => \&filter_modes, param => $1 } } elsif($filterspec =~ /^uid==['"](.+)['"]$/) { push @filters, { ref => \&filter_uid, param => $1 } } elsif($filterspec =~ /^uid=~['"](.+)['"]$/) { push @filters, { ref => \&filter_uids, param => $1 } } elsif($filterspec =~ /^field\((uid|mode|summary|description|location|categories|classification)\)==['"](.+)['"]$/) { push @filters, { ref => \&filter_field, field => $1, param => $2 } } elsif($filterspec =~ /^field\((uid|mode|summary|description|location|categories|classification)\)=~['"](.+)['"]$/) { push @filters, { ref => \&filter_fields, field => $1, param => $2 } } else { return "$name: Illegal filter specification: $filterspec"; } } ### series } elsif($p =~ /^series:(.+)$/) { my ($serieserror,$seriesarrayref)= Calendar_simpleParseWords($1, ","); return "$name: Series parse error: $serieserror" if(defined($serieserror)); my @seriesspecs= @{$seriesarrayref}; for my $seriesspec (@seriesspecs) { if($seriesspec eq "next") { $next= 1; push(@filters, { ref => \&filter_notend }); } elsif($seriesspec =~ /next=([1-9]+\d*)/) { $next= $1; push(@filters, { ref => \&filter_notend }); } else { return "$name: Illegal series specification: $seriesspec"; } } ### limit } elsif($p =~ /^limit:(.+)$/) { my ($limiterror, $limitarrayref)= Calendar_simpleParseWords($1, ","); return "$name: Limit parse error: $limiterror" if(defined($limiterror)); my @limits= @{$limitarrayref}; for my $limit (@limits) { if($limit =~ /count=([1-9]+\d*)/) { $count= $1; } elsif($limit =~ /from=([+-]?)(.+)/ ) { my $sign= $1 eq "-" ? -1 : 1; my ($error, $from)= Calendar_GetSecondsFromTimeSpec($2); return "$name: $error" if($error); push @filters, { ref => \&filter_endafter, param => $t+$sign*$from }; } elsif($limit =~ /to=([+-]?)(.+)/ ) { my $sign= $1 eq "-" ? -1 : 1; my ($error, $to)= Calendar_GetSecondsFromTimeSpec($2); return "$name: $error" if($error); push @filters, { ref => \&filter_startbefore, param => $t+$sign*$to }; } else { return "$name: Illegal limit specification: $limit"; } } } else { return "$name: Illegal parameter: $p"; } } my @texts; my @events= Calendar_GetEvents($hash, $t, @filters); # special treatment for next if(defined($next)) { my %uids; # remember the UIDs # the @events are ordered by start time ascending # they do contain all events that have not ended @events = grep { my $seen= $uids{$_->uid()} // 0; $uids{$_->uid()}= ++$seen; #Debug $_->uid() . " => " . $seen . ", next= $next"; $seen <= $next; } @events; } my $n= 0; foreach my $event (@events) { push @texts, $event->formatted($format, $timeFormat); last if(defined($count) && (++$n>= $count)); } return "" if($#texts<0); return join("\n", @texts); } # -------------------------------------------------------------------------- my @cmds2= qw/text full summary location description categories alarm start end uid debug/; if($cmd ~~ @cmds2) { return "argument is missing" if($#a < 2); Log3 $hash, 2, "get $name $cmd is deprecated and will be removed soon. Use get $name events instead."; my $filter= $a[2]; # $reading is alarm, all, changed, start, end, upcoming my $filterref; my $param= undef; my $keeppos= 3; if($filter eq "changed") { $filterref= \&filter_changed; } elsif($filter eq "alarm") { $filterref= \&filter_alarm; } elsif($filter eq "start") { $filterref= \&filter_start; } elsif($filter eq "end") { $filterref= \&filter_end; } elsif($filter eq "upcoming") { $filterref= \&filter_upcoming; } elsif($filter =~ /^uid=(.+)$/) { $filterref= \&filter_uids; $param= $1; } elsif($filter =~ /^mode=(.+)$/) { $filterref= \&filter_modes; $param= $1; } elsif(($filter =~ /^mode\w+$/) and (defined($hash->{READINGS}{$filter}))) { #main::Debug "apply filter_reading"; $filterref= \&filter_reading; my @uids= split(";", $hash->{READINGS}{$filter}{VAL}); $param= \@uids; } elsif($filter eq "all") { $filterref= \&filter_true; } elsif($filter eq "next") { $filterref= \&filter_notend; $param= { }; # reference to anonymous (unnamed) empty hash, thus $ in $param } else { # everything else is interpreted as uid $filterref= \&filter_uid; $param= $a[2]; } my @filters= ( { ref => $filterref, param => $param } ); @events= Calendar_GetEvents($hash, $t, @filters); # special treatment for next if($filter eq "next") { my %uids; # remember the UIDs # the @events are ordered by start time ascending # they do contain all events that have not ended @events= grep { my $seen= defined($uids{$_->uid()}); $uids{$_->uid()}= 1; not $seen; } @events; } my @texts; if(@events) { foreach my $event (sort { $a->start() <=> $b->start() } @events) { push @texts, $event->uid() if $cmd eq "uid"; push @texts, $event->asText() if $cmd eq "text"; push @texts, $event->asFull() if $cmd eq "full"; push @texts, $event->asDebug() if $cmd eq "debug"; push @texts, $event->summary() if $cmd eq "summary"; push @texts, $event->location() if $cmd eq "location"; push @texts, $event->description() if $cmd eq "description"; push @texts, $event->categories() if $cmd eq "categories"; push @texts, $event->alarmTime() if $cmd eq "alarm"; push @texts, $event->startTime() if $cmd eq "start"; push @texts, $event->endTime() if $cmd eq "end"; } } if(defined($a[$keeppos])) { my $keep= $a[$keeppos]; return "Argument $keep is not a number." unless($keep =~ /\d+/); $keep= $#texts+1 if($keep> $#texts); splice @texts, $keep if($keep>= 0); } return "" if($#texts<0); return join("\n", @texts); } elsif($cmd eq "vevents") { my %vevents= %{$hash->{".fhem"}{vevents}}; my $s= ""; foreach my $key (sort {$a<=>$b} keys %vevents) { $s .= "$key: "; $s .= $vevents{$key}->asString(); $s .= "\n"; } return $s; } elsif($cmd eq "vcalendar") { return undef unless(defined($hash->{".fhem"}{iCalendar})); return $hash->{".fhem"}{iCalendar} } elsif($cmd eq "find") { return "argument is missing" if($#a != 2); my $regexp= $a[2]; my %vevents= %{$hash->{".fhem"}{vevents}}; my %uids; foreach my $id (keys %vevents) { my $v= $vevents{$id}; my @events= @{$v->{events}}; if(@events) { eval { if($events[0]->summary() =~ m/$regexp/) { $uids{$events[0]->uid()}= 1; # } } } Log3($hash, 2, "Calendar " . $hash->{NAME} . ": The regular expression $regexp caused a problem: $@") if($@); } return join(";", keys %uids); } else { return "Unknown argument $cmd, choose one of update:noArg reload:noArg events find text full summary location description categories alarm start end vcalendar:noArg vevents:noArg"; } } ################################### sub Calendar_Wakeup($$) { my ($hash, $removeall) = @_; Log3 $hash, 4, "Calendar " . $hash->{NAME} . ": Wakeup"; my $t= time(); # baseline # we could arrive here 1 second before nextWakeTs for unknown reasons use constant delta => 5; # avoid waking up again in a few seconds if(defined($t) && ($t>= $hash->{".fhem"}{nxtUpdtTs} - delta)) { # GetUpdate does CheckTimes and RearmTimer asynchronously Calendar_GetUpdate($hash, $t, $removeall); } else { Calendar_CheckTimes($hash, $t); Calendar_RearmTimer($hash, $t); } } ################################### sub Calendar_RearmTimer($$) { my ($hash, $t) = @_; #main::Debug "RearmTimer now " . FmtDateTime($t); my $nt= $hash->{".fhem"}{nxtUpdtTs}; #main::Debug "RearmTimer next update " . FmtDateTime($nt); # find next event my %vevents= %{$hash->{".fhem"}{vevents}}; foreach my $uid (keys %vevents) { my $v= $vevents{$uid}; foreach my $e (@{$v->{events}}) { my $et= $e->nextTime($t); # we only consider times in the future to avoid multiple # invocations for calendar events with the event time $nt= $et if(defined($et) && defined($t) && ($et< $nt) && ($et > $t)); } } $hash->{".fhem"}{nextWakeTs}= $nt; $hash->{".fhem"}{nextWake}= FmtDateTime($nt); #main::Debug "RearmTimer for " . $hash->{".fhem"}{nextWake}; readingsSingleUpdate($hash, "nextWakeup", $hash->{".fhem"}{nextWake}, 1); if($nt< $t) { $nt= $t+1 }; # sanity check / do not wake-up at or before the same second InternalTimer($nt, "Calendar_Wakeup", $hash, 0) ; } sub Calendar_DisarmTimer($) { my ($hash)= @_; RemoveInternalTimer($hash); } # ################################### sub Calendar_GetSecondsFromTimeSpec($) { my ($tspec) = @_; # days if($tspec =~ m/^([0-9]+)d$/) { return ("", $1*86400); } # seconds if($tspec =~ m/^[0-9]+s?$/) { return ("", $tspec); } # D:HH:MM:SS if($tspec =~ m/^([0-9]+):([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/) { return ("", $4+60*($3+60*($2+24*$1))); } # HH:MM:SS if($tspec =~ m/^([0-9]+):([0-5][0-9]):([0-5][0-9])$/) { # HH:MM:SS return ("", $3+60*($2+(60*$1))); } # HH:MM if($tspec =~ m/^([0-9]+):([0-5][0-9])$/) { return ("", 60*($2+60*$1)); } return ("Wrong time specification $tspec", undef); } ################################### # Filters sub filter_true($$) { return 1; } sub filter_mode($$) { my ($event,$value)= @_; my $hit; eval { $hit= ($event->getMode() eq $value); }; return 0 if($@); return $hit ? 1 : 0; } sub filter_modes($$) { my ($event,$regex)= @_; my $hit; eval { $hit= ($event->getMode() =~ $regex); }; return 0 if($@); return $hit ? 1 : 0; } sub filter_uids($$) { my ($event,$regex)= @_; my $hit; eval { $hit= ($event->uid() =~ $regex); }; return 0 if($@); #Debug "filter_uids: " . $event->uid() . " $regex: $hit"; return $hit ? 1 : 0; } sub filter_field($$$) { my ($event,$value,$field)= @_; my $hit; eval { $hit= ($event->{$field} eq $value); }; return 0 if($@); return $hit ? 1 : 0; } sub filter_fields($$$) { my ($event,$regex,$field)= @_; my $hit; eval { $hit= ($event->{$field} =~ $regex); }; return 0 if($@); return $hit ? 1 : 0; } sub filter_changed($) { my ($event)= @_; return $event->modeChanged(); } sub filter_alarm($) { my ($event)= @_; return $event->getMode() eq "alarm" ? 1 : 0; } sub filter_start($) { my ($event)= @_; return $event->getMode() eq "start" ? 1 : 0; } sub filter_startbefore($$) { my ($event, $param)= @_; return $event->start() < $param ? 1 : 0; } sub filter_end($) { my ($event)= @_; return $event->getMode() eq "end" ? 1 : 0; } sub filter_endafter($$) { my ($event, $param)= @_; return $event->end() > $param ? 1 : 0; } sub filter_notend($) { my ($event)= @_; #Debug "filter_notend: event " . $event->{summary} . ", mode= " . $event->getMode(); return $event->getMode() eq "end" ? 0 : 1; } sub filter_upcoming($) { my ($event)= @_; return $event->getMode() eq "upcoming" ? 1 : 0; } sub filter_uid($$) { my ($event, $param)= @_; return $event->uid() eq "$param" ? 1 : 0; } sub filter_reading($$) { my ($event, $param)= @_; my @uids= @{$param}; #foreach my $u (@uids) { main::Debug "UID $u"; } my $uid= $event->uid(); #main::Debug "SUCHE $uid"; #main::Debug "GREP: " . grep(/^$uid$/, @uids); return grep(/^$uid$/, @uids); } ################################### sub Calendar_GetEvents($$@) { my ($hash, $t, @filters)= @_; my $name= $hash->{NAME}; my @result= (); # time window my ($error, $t1, $t2)= (undef, undef, undef); my $hideOlderThan= AttrVal($name, "hideOlderThan", undef); my $hideLaterThan= AttrVal($name, "hideLaterThan", undef); # start of time window if(defined($hideOlderThan)) { ($error, $t1)= Calendar_GetSecondsFromTimeSpec($hideOlderThan); if($error) { Log3 $hash, 2, "$name: attribute hideOlderThan: $error"; } else { $t1= $t- $t1; } } # end of time window if(defined($hideLaterThan)) { ($error, $t2)= Calendar_GetSecondsFromTimeSpec($hideLaterThan); if($error) { Log3 $hash, 2, "$name: attribute hideLaterThan: $error"; } else { $t2= $t+ $t2; } } # get and filter events my %vevents= %{$hash->{".fhem"}{vevents}}; foreach my $id (keys %vevents) { my $v= $vevents{$id}; my @events= @{$v->{events}}; foreach my $event (@events) { if(@filters) { my $match= 0; for my $h (@filters) { my $filter= \%$h; my $filterref= $filter->{ref}; my $param = $filter->{param}; my $field = $filter->{field}; last unless(&$filterref($event, $param, $field)); $match++; } #Debug "Filter $filterref, Parameter $param, Match $match"; next unless $match==@filters; } if(defined($t1)) { next if(defined($event->end()) && $event->end() < $t1); } if(defined($t2)) { next if(defined($event->start()) && $event->start() > $t2); } push @result, $event; } } return sort { $a->start() <=> $b->start() } @result; } ################################### sub Calendar_GetUpdate($$$;$) { my ($hash, $t, $removeall, $force) = @_; my $name= $hash->{NAME}; $hash->{".fhem"}{lstUpdtTs}= $t; $hash->{".fhem"}{lastUpdate}= FmtDateTime($t); my $nut= $t+ $hash->{".fhem"}{interval}; $hash->{".fhem"}{nxtUpdtTs}= $nut; $hash->{".fhem"}{nextUpdate}= FmtDateTime($nut); #main::Debug "Getting update now: " . $hash->{".fhem"}{lastUpdate}; #main::Debug "Next Update is at : " . $hash->{".fhem"}{nextUpdate}; # If update is disable, shortcut to time checking and rearming timer. # Why is this here and not in Calendar_Wakeup? Because the next update time needs to be set if(!$force && (AttrVal($hash->{NAME},"update","") eq "none")) { Calendar_CheckTimes($hash, $t); Calendar_RearmTimer($hash, $t); return; } Log3 $hash, 4, "Calendar $name: Updating..."; my $type = $hash->{".fhem"}{type}; my $url= $hash->{".fhem"}{url}; my $errmsg= ""; my $ics; if($type eq "url") { my $SSLVerify= AttrVal($name, "SSLVerify", undef); my $SSLArgs= { }; if(defined($SSLVerify)) { eval "use IO::Socket::SSL"; if($@) { Log3 $hash, 2, $@; } else { my $SSLVerifyMode= eval("$SSLVerify ? SSL_VERIFY_PEER : SSL_VERIFY_NONE"); Log3 $hash, 5, "SSL verify mode set to $SSLVerifyMode"; $SSLArgs= { SSL_verify_mode => $SSLVerifyMode }; } } HttpUtils_NonblockingGet({ url => $url, hideurl => 1, noshutdown => 1, hash => $hash, timeout => 30, type => 'caldata', removeall => $removeall, sslargs => $SSLArgs, t => $t, callback => \&Calendar_ProcessUpdate, }); Log3 $hash, 4, "Calendar $name: Getting data from URL "; # $url } elsif($type eq "file") { Log3 $hash, 4, "Calendar $name: Getting data from file $url"; if(open(ICSFILE, $url)) { while() { $ics .= $_; } close(ICSFILE); my $paramhash; $paramhash->{hash} = $hash; $paramhash->{removeall} = $removeall; $paramhash->{t} = $t; $paramhash->{type} = 'caldata'; Calendar_ProcessUpdate($paramhash, '', $ics); return undef; } else { Log3 $hash, 1, "Calendar $name: Could not open file $url"; readingsSingleUpdate($hash, "state", "error (could not open file)", 1); return 0; } } else { # this case never happens by virtue of _Define, so just die "Software Error"; } } ################################### sub Calendar_ProcessUpdate($$$) { my ($param, $errmsg, $ics) = @_; my $hash = $param->{hash}; my $name = $hash->{NAME}; my $removeall = $param->{removeall}; my $t= $param->{t}; if(exists($hash->{".fhem"}{subprocess})) { Log3 $hash, 2, "Calendar $name: update in progress, process aborted."; return 0; } # not for the developer: # we must be sure that code that starts here ends with Calendar_CheckAndRearm() # no matter what branch is taken in the following delete($hash->{".fhem"}{iCalendar}); if($errmsg) { Log3 $name, 1, "Calendar $name: retrieval failed with error message $errmsg"; readingsSingleUpdate($hash, "state", "error ($errmsg)", 1); } else { readingsSingleUpdate($hash, "state", "retrieved", 1); } if($errmsg or !defined($ics) or ("$ics" eq "") ) { Log3 $hash, 1, "Calendar $name: retrieved no or empty data"; readingsSingleUpdate($hash, "state", "error (no or empty data)", 1); Calendar_CheckAndRearm($hash); } else { $hash->{".fhem"}{iCalendar}= $ics; # the plain text iCalendar $hash->{".fhem"}{t}= $t; $hash->{".fhem"}{removeall}= $removeall; if(AttrVal($name, "update", "sync") eq "async") { Calendar_AsynchronousUpdateCalendar($hash); } else { Calendar_SynchronousUpdateCalendar($hash); } } } sub Calendar_Cleanup($) { my ($hash)= @_; delete($hash->{".fhem"}{t}); delete($hash->{".fhem"}{removeall}); delete($hash->{".fhem"}{serialized}); delete($hash->{".fhem"}{subprocess}); my $name= $hash->{NAME}; delete($hash->{".fhem"}{iCalendar}) if(AttrVal($name,"removevcalendar",0)); Log3 $hash, 4, "Calendar $name: process ended."; } sub Calendar_CheckAndRearm($) { my ($hash)= @_; my $t= $hash->{".fhem"}{t}; Calendar_CheckTimes($hash, $t); Calendar_RearmTimer($hash, $t); } sub Calendar_SynchronousUpdateCalendar($) { my ($hash) = @_; my $name= $hash->{NAME}; Log3 $hash, 4, "Calendar $name: parsing data synchronously"; my $ical= Calendar_ParseICS($hash->{".fhem"}{iCalendar}); Calendar_UpdateCalendar($hash, $ical); Calendar_CheckAndRearm($hash); Calendar_Cleanup($hash); } use constant POLLINTERVAL => 1; sub Calendar_AsynchronousUpdateCalendar($) { require "SubProcess.pm"; my ($hash) = @_; my $name= $hash->{NAME}; my $subprocess= SubProcess->new({ onRun => \&Calendar_OnRun }); $subprocess->{ics}= $hash->{".fhem"}{iCalendar}; my $pid= $subprocess->run(); if(!defined($pid)) { Log3 $hash, 1, "Calendar $name: Cannot parse asynchronously"; Calendar_CheckAndRearm($hash); Calendar_Cleanup($hash); return undef; } Log3 $hash, 4, "Calendar $name: parsing data asynchronously (PID= $pid)"; $hash->{".fhem"}{subprocess}= $subprocess; $hash->{".fhem"}{serialized}= ""; InternalTimer(gettimeofday()+POLLINTERVAL, "Calendar_PollChild", $hash, 0); # go and do your thing while the timer polls and waits for the child to terminate Log3 $hash, 5, "Calendar $name: control passed back to main loop."; } sub Calendar_OnRun() { # This routine runs in a process separate from the main process. my $subprocess= shift; my $ical= Calendar_ParseICS($subprocess->{ics}); my $serialized= freeze $ical; $subprocess->writeToParent($serialized); } sub Calendar_PollChild($) { my ($hash)= @_; my $name= $hash->{NAME}; my $subprocess= $hash->{".fhem"}{subprocess}; my $data= $subprocess->readFromChild(); if(!defined($data)) { Log3 $name, 4, "Calendar $name: still waiting (". $subprocess->{lasterror} .")."; InternalTimer(gettimeofday()+POLLINTERVAL, "Calendar_PollChild", $hash, 0); return; } else { Log3 $name, 4, "Calendar $name: got result from asynchronous parsing."; $subprocess->wait(); Log3 $name, 4, "Calendar $name: asynchronous parsing finished."; my $ical= thaw($data); Calendar_UpdateCalendar($hash, $ical); Calendar_CheckAndRearm($hash); Calendar_Cleanup($hash); } } sub Calendar_ParseICS($) { #main::Debug "Calendar $name: parsing data"; my ($ics)= @_; my ($error, $state)= (undef, ""); # we parse the calendar into a recursive ICal::Entry structure my $ical= ICal::Entry->new("root"); $ical->parse($ics); #main::Debug "*** Result:"; #main::Debug $ical->asString(); my $numentries= scalar @{$ical->{entries}}; if($numentries<= 0) { eval { require Compress::Zlib; }; if($@) { $error= "data not in ICal format; maybe gzip data, but cannot load Compress::Zlib"; } else { $ics = Compress::Zlib::memGunzip($ics); $ical->parse($ics); $numentries= scalar @{$ical->{entries}}; if($numentries<= 0) { $error= "data not in ICal format; even not gzip data"; } else { $state= "parsed (gzip data)"; } } } else { $state= "parsed"; }; $ical->{error}= $error; $ical->{state}= $state; return $ical; } ################################### sub Calendar_UpdateCalendar($$) { my ($hash, $ical)= @_; # ******************************* # *** Step 1 Digest Parser Result # ******************************* my $name= $hash->{NAME}; my $error= $ical->{error}; my $state= $ical->{state}; if(defined($error)) { Log3 $hash, 2, "Calendar $name: error ($error)"; readingsSingleUpdate($hash, "state", "error ($error)", 1); return 0; } else { readingsSingleUpdate($hash, "state", $state, 1); } my $t= $hash->{".fhem"}{t}; my $removeall= $hash->{".fhem"}{removeall}; my @entries= @{$ical->{entries}}; my $root= @{$ical->{entries}}[0]; my $calname= "?"; if($root->{type} ne "VCALENDAR") { Log3 $hash, 1, "Calendar $name: root element is not VCALENDAR"; readingsSingleUpdate($hash, "state", "error (root element is not VCALENDAR)", 1); return 0; } else { $calname= $root->value("X-WR-CALNAME"); } # ********************* # *** Step 2 Merging # ********************* Log3 $hash, 4, "Calendar $name: merging data"; #main::Debug "Calendar $name: merging data"; # this the hash of VEVENTs that have been created on the previous update my %vevents; %vevents= %{$hash->{".fhem"}{vevents}} if(!$removeall); # the keys to the hash are numbers taken from a sequence my $lastid= $hash->{".fhem"}{lastid}; # # 1, 2, 4 # # we first discard all VEVENTs that have been tagged as deleted in the previous run # and untag the rest foreach my $key (keys %vevents) { #main::Debug "Preparing id $key..."; if($vevents{$key}->isObsolete() ) { delete($vevents{$key}); } else { $vevents{$key}->setState("deleted"); # will be changed if record is touched in the next step $vevents{$key}->clearCounterpart(); $vevents{$key}->clearReferences(); } } # # 3 # # we now run through the list of freshly retrieved VEVENTs and merge them into # the hash my ($n, $nknown, $nmodified, $nnew, $nchanged)= (0,0,0,0,0,0); # this code is O(n^2) and stalls FHEM for large numbers of VEVENTs # to speed up the code we first build a reverse hash (UID,RECURRENCE-ID) -> id sub kf($) { my ($v)= @_; return $v->value("UID").$v->valueOrDefault("RECURRENCE-ID","") } my %lookup; foreach my $id (keys %vevents) { my $k= kf($vevents{$id}); Log3 $hash, 2, "Calendar $name: Duplicate VEVENT" if(defined($lookup{$k})); $lookup{$k}= $id; #main::Debug "Adding event $id with key $k to lookup hash."; } # start of time window for cutoff my $cutoffOlderThan = AttrVal($name, "cutoffOlderThan", undef); my $cutoffT= 0; my $cutoff; if(defined($cutoffOlderThan)) { ($error, $cutoffT)= Calendar_GetSecondsFromTimeSpec($cutoffOlderThan); if($error) { Log3 $hash, 2, "$name: attribute cutoffOlderThan: $error"; }; $cutoff= $t- $cutoffT; } foreach my $v (grep { $_->{type} eq "VEVENT" } @{$root->{entries}}) { # totally skip outdated calendar entries next if( defined($cutoffOlderThan) && $v->hasKey("DTEND") && $v->tm($v->value("DTEND")) < $cutoff && !$v->hasKey("RRULE") ); #main::Debug "Merging " . $v->asString(); my $found= 0; my $added= 0; # flag to prevent multiple additions $n++; # some braindead calendars provide no UID - add one: $v->addproperty(sprintf("UID:synthetic-%06d", $v->{ln})) unless($v->hasKey("UID") or !defined($v->{ln})); # look for related records in the old record set my $k= kf($v); #main::Debug "Looking for event with key $k"; my $id= $lookup{$k}; if(defined($id)) { my $v0= $vevents{$id}; #main::Debug "Found $id"; # # same UID and RECURRENCE-ID # $found++; if($v0->sameValue($v, "SEQUENCE")) { # # and same SEQUENCE # if($v0->sameValue($v, "LAST-MODIFIED")) { # # is not modified # # we only keep the record from the old record set $v0->setState("known"); $nknown++; } else { # # is modified # # we keep both records next if($added); $added++; $vevents{++$lastid}= $v; $v->setState("modified-new"); $v->setCounterpart($id); $v0->setState("modified-old"); $v0->setCounterpart($lastid); $nmodified++; } } else { # # and different SEQUENCE # # we keep both records next if($added); $added++; $vevents{++$lastid}= $v; $v->setState("changed-new"); $v->setCounterpart($id); $v0->setState("changed-old"); $v0->setCounterpart($lastid); $nchanged++; } } if(!$found) { $v->setState("new"); $vevents{++$lastid}= $v; $added++; $nnew++; } } # # Cross-referencing series # # this code is O(n^2) and stalls FHEM for large numbers of VEVENTs # to speed up the code we build a hash of a hash UID => {id => VEVENT} %lookup= (); foreach my $id (keys %vevents) { my $v= $vevents{$id}; $lookup{$v->value("UID")}{$id}= $v unless($v->isObsolete); } for my $idref (values %lookup) { my %vs= %{$idref}; foreach my $v (values %vs) { foreach my $id (keys %vs) { push @{$v->references()}, $id unless($vs{$id} eq $v); } } } # foreach my $id (keys %vevents) { # my $v= $vevents{$id}; # next if($v->isObsolete()); # foreach my $id0 (keys %vevents) { # next if($id==$id0); # my $v0= $vevents{$id0}; # next if($v0->isObsolete()); # push @{$v0->references()}, $id if($v->sameValue($v0, "UID")); # } # } Log3 $hash, 4, "Calendar $name: $n records processed, $nnew new, ". "$nknown known, $nmodified modified, $nchanged changed."; # save the VEVENTs hash and lastid $hash->{".fhem"}{vevents}= \%vevents; $hash->{".fhem"}{lastid}= $lastid; # ********************* # *** Step 3 Events # ********************* # # Recreating the events # Log3 $hash, 4, "Calendar $name: creating calendar events"; #main::Debug "Calendar $name: creating calendar events"; my $ignoreCancelled= AttrVal($name, "ignoreCancelled", 0); foreach my $id (keys %vevents) { my $v= $vevents{$id}; if($v->isObsolete() or ($ignoreCancelled and $v->isCancelled())) { $v->clearEvents(); next; } my $onCreateEvent= AttrVal($name, "onCreateEvent", undef); if($v->hasChanged() or !$v->numEvents()) { #main::Debug "createEvents"; $v->createEvents($t, $onCreateEvent, %vevents); } } #main::Debug "*** Result:"; #main::Debug $ical->asString(); # ********************* # *** Step 4 Readings # ********************* readingsBeginUpdate($hash); readingsBulkUpdate($hash, "calname", $calname); readingsBulkUpdate($hash, "lastUpdate", $hash->{".fhem"}{lastUpdate}); readingsBulkUpdate($hash, "nextUpdate", $hash->{".fhem"}{nextUpdate}); readingsEndUpdate($hash, 1); # DoTrigger, because sub is called by a timer instead of dispatch return 1; } ################################### sub Calendar_CheckTimes($$) { my ($hash, $t) = @_; Log3 $hash, 4, "Calendar " . $hash->{NAME} . ": Checking times..."; # # determine the uids of all events and their most interesting mode # my %priority= ( "none" => 0, "end" => 1, "upcoming" => 2, "alarm" => 3, "start" => 4, ); my %mim; # most interesting mode per id my %changed; # changed per id my %vevents= %{$hash->{".fhem"}{vevents}}; foreach my $uid (keys %vevents) { my $v= $vevents{$uid}; foreach my $e (@{$v->{events}}) { my $uid= $e->uid(); my $mode= defined($mim{$uid}) ? $mim{$uid} : "none"; if($e->isEnded($t)) { $e->setMode("end"); } elsif($e->isUpcoming($t)) { $e->setMode("upcoming"); } elsif($e->isStarted($t)) { $e->setMode("start"); } elsif($e->isAlarmed($t)) { $e->setMode("alarm"); } if($priority{$e->getMode()} > $priority{$mode}) { $mim{$uid}= $e->getMode(); } $changed{$uid}= 0 unless(defined($changed{$uid})); # create the FHEM event if($e->modeChanged()) { $changed{$uid}= 1; addEvent($hash, "changed: $uid " . $e->getMode()); addEvent($hash, $e->getMode() . ": $uid "); } } } # # determine the uids of events in certain modes # my @changed; my @upcoming; my @start; my @started; my @alarm; my @alarmed; my @end; my @ended; foreach my $uid (keys %mim) { push @changed, $uid if($changed{$uid}); push @upcoming, $uid if($mim{$uid} eq "upcoming"); if($mim{$uid} eq "alarm") { push @alarm, $uid; push @alarmed, $uid if($changed{$uid}); } if($mim{$uid} eq "start") { push @start, $uid; push @started, $uid if($changed{$uid}); } if($mim{$uid} eq "end") { push @end, $uid; push @ended, $uid if($changed{$uid}); } } #sub uniq { my %uids; return grep {!$uids{$_->uid()}++} @_; } #@allevents= sort { $a->start() <=> $b->start() } uniq(@allevents); #foreach my $event (@allevents) { # main::Debug $event->asFull(); #} sub es(@) { my (@events)= @_; return join(";", @events); } sub rbu($$$) { my ($hash, $reading, $value)= @_; if(!defined($hash->{READINGS}{$reading}) or ($hash->{READINGS}{$reading}{VAL} ne $value)) { readingsBulkUpdate($hash, $reading, $value); } } # clears all events in CHANGED, thus must be called first readingsBeginUpdate($hash); # we update the readings rbu($hash, "modeUpcoming", es(@upcoming)); rbu($hash, "modeAlarm", es(@alarm)); rbu($hash, "modeAlarmed", es(@alarmed)); rbu($hash, "modeAlarmOrStart", es(@alarm,@start)); rbu($hash, "modeChanged", es(@changed)); rbu($hash, "modeStart", es(@start)); rbu($hash, "modeStarted", es(@started)); rbu($hash, "modeEnd", es(@end)); rbu($hash, "modeEnded", es(@ended)); readingsBulkUpdate($hash, "state", "triggered"); # DoTrigger, because sub is called by a timer instead of dispatch readingsEndUpdate($hash, 1); } ##################################### sub CalendarAsHtml($;$) { my ($d,$o) = @_; $d = "" if(!$d); return "$d is not a Calendar instance
" if(!$defs{$d} || $defs{$d}{TYPE} ne "Calendar"); my $l= Calendar_Get($defs{$d}, split("[ \t]+", "- text $o")); my @lines= split("\n", $l); my $ret = ''; foreach my $line (@lines) { my @fields= split(" ", $line, 3); $ret.= sprintf("", @fields); } $ret .= '
%s%s%s
'; return $ret; } sub CalendarEventsAsHtml($;$) { my ($d,$parameters) = @_; $d = "" if(!$d); return "$d is not a Calendar instance
" if(!$defs{$d} || $defs{$d}{TYPE} ne "Calendar"); my $l= Calendar_Get($defs{$d}, split("[ \t]+", "- events $parameters")); my @lines= split("\n", $l); my $ret = ''; foreach my $line (@lines) { my @fields= split(" ", $line, 3); $ret.= sprintf("", @fields); } $ret .= '
%s%s%s
'; return $ret; } ##################################### 1; =pod =item device =item summary handles calendar events from iCal file or URL =item summary_DE handhabt Kalendertermine aus iCal-Dateien und URLs =begin html

Calendar


    Define

      define <name> Calendar ical url <URL> [<interval>]
      define <name> Calendar ical file <FILENAME> [<interval>]

      Defines a calendar device.

      A calendar device periodically gathers calendar events from the source calendar at the given URL or from a file. The file must be in ICal format.

      If the URL starts with https://, the perl module IO::Socket::SSL must be installed (use cpan -i IO::Socket::SSL).

      Note for users of Google Calendar: You can literally use the private ICal URL from your Google Calendar. If your Google Calendar URL starts with https:// and the perl module IO::Socket::SSL is not installed on your system, you can replace it by http:// if and only if there is no redirection to the https:// URL. Check with your browser first if unsure.

      The optional parameter interval is the time between subsequent updates in seconds. It defaults to 3600 (1 hour).

      Examples:
            define MyCalendar Calendar ical url https://www.google.com­/calendar/ical/john.doe%40example.com­/private-foo4711/basic.ics
            define YourCalendar Calendar ical url http://www.google.com­/calendar/ical/jane.doe%40example.com­/private-bar0815/basic.ics 86400
            define SomeCalendar Calendar ical file /home/johndoe/calendar.ics
            
    Set

    • set <name> update
      Forces the retrieval of the calendar from the URL. The next automatic retrieval is scheduled to occur interval seconds later.

    • set <name> reload
      Same as update but all calendar events are removed first.


    Get

    • get <name> update
      Same as set <name> update

    • get <name> reload
      Same as set <name> update

    • get <name> events [format:<formatSpec>] [timeFormat:<timeFormatSpec>] [filter:<filterSpecs>] [series:next[=<max>]] [limit:<limitSpecs>]

      The swiss army knife for displaying calendar events. Returns, line by line, information on the calendar events in the calendar <name> according to formatting and filtering rules. You can give none, one or several of the format, timeFormat, filter, series and limit parameters and it makes even sense to give the filter parameter several times.

      The format parameter determines the overall formatting of the calendar event. The following format specifications are available:

      <formatSpec>content
      defaultthe default format (see below)
      fullsame as custom="$U $M $A $T1-$T2 $S $CA $L"
      textsame as custom="$T1 $S"
      custom="<formatString>" a custom format (see below)
      custom="{ <perl-code> }"a custom format (see below)

      Single quotes (') can be used instead of double quotes (") in the custom format.

      You can use the following variables in the <formatString> and in the <perl-code>:

      variablemeaning
      $t1the start time in seconds since the epoch
      $T1the start time according to the time format
      $t2the end time in seconds since the epoch
      $T2the end time according to the time format
      $athe alarm time in seconds since the epoch
      $Athe alarm time according to the time format
      $dthe duration in seconds
      $Dthe duration in human-readable form
      $Sthe summary
      $Lthe location
      $CAthe categories
      $CLthe classification
      $DSthe description
      $Uthe UID
      $Mthe mode

      \, (masked comma) in summary, location and description is replaced by a comma but \n (indicates newline) is untouched.

      If the format parameter is omitted, the custom format string from the defaultFormat attribute is used. If this attribute is not set, "$T1 $D $S" is used as default custom format string. The last occurance wins if the format parameter is given several times.

      Examples:
      get MyCalendar events format:full
      get MyCalendar events format:custom="$T1-$T2 $S \@ $L"
      get MyCalendar events format:custom={ sprintf("%20s %8s", $S, $D) }

      The timeFormat parameter determines the formatting of start, end and alarm times.

      You use the POSIX conversion specifications in the <timeFormatSpec>. The web page strftime.net has a nice builder for <timeFormatSpec>.

      If the timeFormat parameter is omitted, the time format specification from the defaultTimeFormat attribute is used. If this attribute is not set, "%d.%m.%Y %H:%M" is used as default time format specification. Single quotes (') or double quotes (") can be used to enclose the format specification.

      The last occurance wins if the parameter is given several times.

      Example:
      get MyCalendar events timeFormat:"%e-%b-%Y" format:full

      The filter parameter restricts the calendar events displayed to a subset. <filterSpecs> is a comma-separated list of <filterSpec> specifications. All filters must apply for a calendar event to be displayed. The parameter is cumulative: all separate occurances of the parameter add to the list of filters.

      <filterSpec>description
      uid=="<uid>"UID is <uid>
      same as field(uid)=="<uid>"
      uid=~"<regex>"UID matches regular expression <regex>
      same as field(uid)=~"<regex>"
      mode=="<mode>"mode is <mode>
      same as field(mode)=="<mode>"
      mode=~"<regex>"mode matches regular expression <regex>
      same as field(mode)=~"<regex>"
      field(<field>)=="<value>"content of the field <field> is <value>
      <field> is one of uid, mode, summary, location, description, categories, classification
      field(<field>)=~"<regex>"content of the field <field> matches <regex>
      <field> is one of uid, mode, summary, location, description, categories, classification

      The double quotes (") on the right hand side of a <filterSpec> are not part of the value or regular expression. Single quotes (') can be used instead.

      Examples:
      get MyCalendar events filter:uid=="432dsafweq64yehdbwqhkd"
      get MyCalendar events filter:uid=~"^7"
      get MyCalendar events filter:mode=="alarm"
      get MyCalendar events filter:mode=~"alarm|upcoming"
      get MyCalendar events filter:field(summary)=~"Mama"
      get MyCalendar events filter:field(classification)=="PUBLIC"
      get MyCalendar events filter:field(summary)=~"Gelber Sack",mode=~"upcoming|start"
      get MyCalendar events filter:field(summary)=~"Gelber Sack" filter:mode=~"upcoming|start"

      The series parameter determines the display of recurring events. series:next limits the display to the next calendar event out of all calendar events in the series that have not yet ended. series:next=<max> shows at most the <max> next calendar events in the series. This applies per series. To limit the total amount of events displayed see the limit parameter below.

      The limit parameter limits the number of events displayed. <limitSpecs> is a comma-separated list of <limitSpec> specifications.

      <limitSpec>description
      count=<n>shows at most <n> events, <n> is a positive integer
      from=[+|-]<timespec>shows only events that end after a timespan <timespec> from now; use a minus sign for events in the past; <timespec> is described below in the Attributes section
      to=[+|-]<timespec>shows only events that start before a timespan <timespec> from now; use a minus sign for events in the past; <timespec> is described below in the Attributes section

      Examples:
      get MyCalendar events limit:count=10
      get MyCalendar events limit:from=-2d
      get MyCalendar events limit:count=10,from=0,to=+10d


    • get <name> find <regexp>
      Returns, line by line, the UIDs of all calendar events whose summary matches the regular expression <regexp>.

    • get <name> vcalendar
      Returns the calendar in ICal format as retrieved from the source.

    • get <name> vevents
      Returns a list of all VEVENT entries in the calendar with additional information for debugging. Only properties that have been kept during processing of the source are shown. The list of calendar events created from each VEVENT entry is shown as well as the list of calendar events that have been omitted.


    Attributes

    • defaultFormat <formatSpec>
      Sets the default format for the get <name> events command. The specification is explained there. You must enclose the <formatSpec> in double quotes (") like input in attr myCalendar defaultFormat "$T1 $D $S".
    • defaultTimeFormat <timeFormatSpec>
      Sets the default time format for the get <name>events command. The specification is explained there. Do not enclose the <timeFormatSpec> in quotes.
    • update sync|async|none
      If this attribute is not set or if it is set to sync, the processing of the calendar is done in the foreground. Large calendars will block FHEM on slow systems. If this attribute is set to async, the processing is done in the background and FHEM will not block during updates. If this attribute is set to none, the calendar will not be updated at all.
    • removevcalendar 0|1
      If this attribute is set to 1, the vCalendar will be discarded after the processing to reduce the memory consumption of the module. A retrieval via get <name> vcalendar is then no longer possible.
    • hideOlderThan <timespec>
      hideLaterThan <timespec>

      These attributes limit the list of events shown by get <name> full|debug|text|summary|location|alarm|start|end ....

      The time is specified relative to the current time t. If hideOlderThan is set, calendar events that ended before t-hideOlderThan are not shown. If hideLaterThan is set, calendar events that will start after t+hideLaterThan are not shown.

      Please note that an action triggered by a change to mode "end" cannot access the calendar event if you set hideOlderThan to 0 because the calendar event will already be hidden at that time. Better set hideOlderThan to 10.

      <timespec> must have one of the following formats:
      formatdescriptionexample
      SSSseconds3600
      SSSsseconds3600s
      HH:MMhours:minutes02:30
      HH:MM:SShours:minutes:seconds00:01:30
      D:HH:MM:SSdays:hours:minutes:seconds122:10:00:00
      DDDddays100d

    • cutoffOlderThan <timespec>
      This attribute cuts off all non-recurring calendar events that ended a timespan cutoffOlderThan before the last update of the calendar. The purpose of setting this attribute is to save memory. Such calendar events cannot be accessed at all from FHEM. Calendar events are not cut off if they are recurring or if they have no end time (DTEND).
    • onCreateEvent <perl-code>
      This attribute allows to run the Perl code <perl-code> for every calendar event that is created. See section Plug-ins below.
    • SSLVerify
      This attribute sets the verification mode for the peer certificate for connections secured by SSL. Set attribute either to 0 for SSL_VERIFY_NONE (no certificate verification) or to 1 for SSL_VERIFY_PEER (certificate verification). Disabling verification is useful for local calendar installations (e.g. OwnCloud, NextCloud) without valid SSL certificate.
    • ignoreCancelled
      Set to 1 to ignore events with status "CANCELLED". Set this attribute to 1 if calanedar events of a series are returned although they are cancelled.
    • readingFnAttributes


    Description

      A calendar is a set of calendar events. The calendar events are fetched from the source calendar at the given URL on a regular basis.

      A calendar event has a summary (usually the title shown in a visual representation of the source calendar), a start time, an end time, and zero, one or more alarm times. In case of multiple alarm times for a calendar event, only the earliest alarm time is kept.

      Recurring calendar events (series) are currently supported to an extent: FREQ INTERVAL UNTIL COUNT are interpreted, BYMONTHDAY BYMONTH WKST are recognized but not interpreted. BYDAY is correctly interpreted for weekly and monthly events. The module will get it most likely wrong if you have recurring calendar events with unrecognized or uninterpreted keywords. Out-of-order events and events excluded from a series (EXDATE) are handled. Calendar events are only created within ±400 days around the time of the last update.

      Calendar events are created when FHEM is started or when the respective entry in the source calendar has changed and the calendar is updated or when the calendar is reloaded with get <name> reload. Only calendar events within ±400 days around the event creation time are created. Consider reloading the calendar from time to time to avoid running out of upcoming events. You can use something like define reloadCalendar at +*240:00:00 set MyCalendar reload for that purpose.

      Some dumb calendars do not use LAST-MODIFIED. This may result in modifications in the source calendar go unnoticed. Reload the calendar if you experience this issue.

      A calendar event is identified by its UID. The UID is taken from the source calendar. All events in a series including out-of-order events habe the same UID. All non-alphanumerical characters are stripped off the original UID to make your life easier.

      A calendar event can be in one of the following modes:
      upcomingNeither the alarm time nor the start time of the calendar event is reached.
      alarmThe alarm time has passed but the start time of the calendar event is not yet reached.
      startThe start time has passed but the end time of the calendar event is not yet reached.
      endThe end time of the calendar event has passed.

      A calendar event transitions from one mode to another immediately when the time for the change has come. This is done by waiting for the earliest future time among all alarm, start or end times of all calendar events.

      A calendar device has several readings. Except for calname, each reading is a semicolon-separated list of UIDs of calendar events that satisfy certain conditions:
      calnamename of the calendar
      modeAlarmevents in alarm mode
      modeAlarmOrStartevents in alarm or start mode
      modeAlarmedevents that have just transitioned from upcoming to alarm mode
      modeChangedevents that have just changed their mode somehow
      modeEndevents in end mode
      modeEndedevents that have just transitioned from start to end mode
      modeStartevents in start mode
      modeStartedevents that have just transitioned to start mode
      modeUpcomingevents in upcoming mode

      For recurring events, usually several calendar events exists with the same UID. In such a case, the UID is only shown in the mode reading for the most interesting mode. The most interesting mode is the first applicable of start, alarm, upcoming, end.

      In particular, you will never see the UID of a series in modeEnd or modeEnded as long as the series has not yet ended - the UID will be in one of the other mode... readings. This means that you better do not trigger FHEM events for series based on mode... readings. See below for a recommendation.


    Events

      When the calendar was reloaded or updated or when an alarm, start or end time was reached, one FHEM event is created:

      triggered

      When you receive this event, you can rely on the calendar's readings being in a consistent and most recent state.

      When a calendar event has changed, two FHEM events are created:

      changed: UID <mode>
      <mode>: UID

      <mode> is the current mode of the calendar event after the change. Note: there is a colon followed by a single space in the FHEM event specification.

      The recommended way of reacting on mode changes of calendar events is to get notified on the aforementioned FHEM events and do not check for the FHEM events triggered by a change of a mode reading.

    Plug-ins

      A plug-in is a piece of Perl code that modifies a calendar event on the fly. The Perl code operates on the hash reference $e. The most important elements are as follows:
      codedescription
      $e->{start}the start time of the calendar event, in seconds since the epoch
      $e->{end}the end time of the calendar event, in seconds since the epoch
      $e->{alarm}the alarm time of the calendar event, in seconds since the epoch
      $e->{summary}the summary (caption, title) of the calendar event
      $e->{location}the location of the calendar event

      To add or change the alarm time of a calendar event for all events with the string "Tonne" in the summary, the following plug-in can be used:

      attr MyCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 if($e->{summary} =~ /Tonne/);; }

      The double semicolon masks the semicolon. Perl specials cannot be used.

      To add a missing end time, the following plug-in can be used:

      attr MyCalendar onCreateEvent { $e->{end}= $e->{start}+86400 unless(defined($e->{summary})) }


    Usage scenarios

      Show all calendar events with details

        get MyCalendar events format:full
        2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee
        992hydf4y44awer5466lhfdsr­gl7tin6b6mckf8glmhui4­googlecom upcoming 08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation


      Show calendar events in your photo frame

        Put a line in the layout description to show calendar events in alarm or start mode:

        text 20 60 { fhem("get MyCalendar events timeFormat:'%d.%m.%Y %H:%M' format:custom='$T1 $S' filter:mode=~'alarm|start') }

        This may look like:

        07.06.12 16:30 Erna for coffee
        08.06.12 00:00 Vacation


      Switch the light on when Erna comes

        First find the UID of the calendar event:

        get MyCalendar find .*Erna.*
        2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom


        Then define a notify (the dot after the second colon matches the space):

        define ErnaComes notify MyCalendar:start:.2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom set MyLight on

        You can also do some logging:

        define LogErna notify MyCalendar:alarm:.2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom { Log3 $NAME, 1, "ALARM name=$NAME event=$EVENT part1=$EVTPART0 part2=$EVTPART1" }

      Switch actors on and off

        Think about a calendar with calendar events whose summaries (subjects, titles) are the names of devices in your fhem installation. You want the respective devices to switch on when the calendar event starts and to switch off when the calendar event ends.

        define SwitchActorOn notify MyCalendar:start:.* { \
        my $reading="$EVTPART0";; \
        my $uid= "$EVTPART1";; \
        my $actor= fhem('get MyCalendar filter:uid=="'.$uid.'" format:custom="$S"');; \
        if(defined $actor) { fhem("set $actor on") } \
        }

        define SwitchActorOff notify MyCalendar:end:.* { \
        my $reading="$EVTPART0";; \
        my $uid= "$EVTPART1";; \
        my $actor= fhem('get MyCalendar filter:uid=="'.$uid.'" format:custom="$S"');; \
        if(defined $actor) { fhem("set $actor off") } \
        }


        You can also do some logging:

        define LogActors notify MyCalendar:(start|end):.* { my $reading= "$EVTPART0";; my $uid= "$EVTPART1";; \
        my $actor= fhem('get MyCalendar filter:uid=="'.$uid.'" format:custom="$S"');; \
        Log3 $NAME, 1, "Actor: $actor, Reading $reading" }


      Inform about garbage collection

        We assume the GarbageCalendar has all the dates of the garbage collection with the type of garbage collected in the summary. The following notify can be used to inform about the garbage collection:

        define GarbageCollectionNotifier notify GarbageCalendar:alarm:.* { \
        my $uid= "$EVTPART1";; \
        my $summary= fhem('get MyCalendar events filter:uid=="'.$uid.'" format:custom="$S"');; \
        # e.g. mail $summary to someone \
        }


        If the garbage calendar has no reminders, you can set these to one day before the date of the collection:

        attr GarbageCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 }

        The following code realizes a HTML display of the upcoming collection dates (see below):

        { CalendarEventsAsHtml('GarbageCalendar','format:text filter:mode=~"alarm|start"') }

    Embedded HTML

      The module provides two functions which return HTML code.

      CalendarAsHtml(<name>,<options>) returns the HTML code for a list of calendar events. <name> is the name of the Calendar device and <options> is what you would write after get <name> text .... This function is deprecated.

      Example: define MyCalendarWeblink weblink htmlCode { CalendarAsHtml("MyCalendar","next 3") }

      CalendarEventsAsHtml(<name>,<parameters>) returns the HTML code for a list of calendar events. <name> is the name of the Calendar device and <parameters> is what you would write in get <name> events <parameters>.

      Example: define MyCalendarWeblink weblink htmlCode { CalendarEventsAsHtml('F','format:custom="$T1 $D $S" timeFormat="%d.%m" series:next=3') }

      Tip: use single quotes as outer quotes.

=end html =begin html_DE

Calendar


    Diese deutsche Übersetzung ist nicht mehr aktuell (siehe bitte Forumsbeitrag). Bitte hilf bei FHEM mit und aktualisiere diese Übersetzung. Die englischsprachige Dokumentation ist immer aktuell.

    Define

      define <name> Calendar ical url <URL> [<interval>]
      define <name> Calendar ical file <FILENAME> [<interval>]

      Definiert ein Kalender-Device.

      Ein Kalender-Device ermittelt (Serien-) Termine aus einem Quell-Kalender. Dieser kann eine URL oder eine Datei sein. Die Datei muss im iCal-Format vorliegen.

      Beginnt die URL mit https://, muss das Perl-Modul IO::Socket::SSL installiert sein (use cpan -i IO::Socket::SSL).

      Hinweis für Nutzer des Google-Kalenders: Du kann direkt die private iCal-URL des Google Kalender nutzen. Sollte Deine Google-Kalender-URL mit https:// beginnen und das Perl-Modul IO::Socket::SSL ist nicht auf Deinem Systeme installiert, kannst Du in der URL https:// durch http:// ersetzen, falls keine automatische Umleitung auf die https:// URL erfolgt. Solltest Du unsicher sein, ob dies der Fall ist, überprüfe es bitte zuerst mit Deinem Browser.

      Der optionale Parameter interval bestimmt die Zeit in Sekunden zwischen den Updates. Default-Wert ist 3600 (1 Stunde).

      Beispiele:
            define MeinKalender Calendar ical url https://www.google.com­/calendar/ical/john.doe%40example.com­/private-foo4711/basic.ics
            define DeinKalender Calendar ical url http://www.google.com­/calendar/ical/jane.doe%40example.com­/private-bar0815/basic.ics 86400
            define IrgendeinKalender Calendar ical file /home/johndoe/calendar.ics
            

    Set

      set <name> update
      Erzwingt das Einlesen des Kalenders von der definierten URL. Das nächste automatische Einlesen erfolgt in interval Sekunden später.

      set <name> reload
      Dasselbe wie update, jedoch werden zuerst alle Termine entfernt.


    Get

      get <name> update
      Entspricht set <name> update

      get <name> reload
      Entspricht set <name> reload

      get <name> <format> <filter> [<max>]
      Die Termine für den Kalender <name> werden Zeile für Zeile ausgegeben.

      Folgende Selektoren/Filter stehen zur Verfügung:

      Der Selektor <format> legt den zurückgegeben Inhalt fest:

      <format>Inhalt
      uidUID des Termins
      textBenutzer-/Monitorfreundliche Textausgabe.
      summaryÜbersicht (Betreff, Titel)
      locationOrt
      categoriesKategorien
      alarmAlarmzeit
      startStartzeit
      endEndezeit
      fullVollständiger Status
      debugwie <full> mit zusätzlichen Informationen zur Fehlersuche

      Der Filter <filter> grenzt die Termine ein:

      <filter>Inhalt
      mode=<regex>alle Termine, deren Modus durch den regulären Ausdruck <regex> beschrieben werden.
      <mode>alle Termine mit Modus <mode>.
      uid=<regex>Alle Termine, deren UIDs durch den regulären Ausdruck <regex> beschrieben werden.
      <uid>Alle Termine mit der UID <uid>
      <reading>Alle Termine die im Reading <reading> aufgelistet werden (modeAlarm, modeAlarmed, modeStart, etc.) - dieser Filter ist abgekündigt und steht in einer zukünftigen Version nicht mehr zur Verfügung, bitte mode=<regex> benutzen.
      allAlle Termine (vergangene, aktuelle und zukünftige)
      nextAlle Termine, die noch nicht beendet sind. Bei Serienterminen der erste Termin. Benutzer-/Monitorfreundliche Textausgabe

      Die Filter mode=<regex> und uid=<regex> sollten den Filtern <mode> und <uid> vorgezogen werden.

      Der optionale Parameter <max> schränkt die Anzahl der zurückgegebenen Zeilen ein.

      Bitte beachte die Attribute hideOlderThan und hideLaterThan für die Seletion von Terminen in einem bestimmten Zeitfenster. Bitte berücksichtige, dass das globale ±400 Tageslimit gilt .

      Beispiele:
      get MyCalendar text next
      get MyCalendar summary uid:435kjhk435googlecom 1
      get MyCalendar summary 435kjhk435googlecom 1
      get MyCalendar full all
      get MyCalendar text mode=alarm|start
      get MyCalendar text uid=.*6286.*

      get <name> find <regexp>
      Gibt Zeile für Zeile die UIDs aller Termine deren Zusammenfassungen durch den regulären Ausdruck <regex> beschrieben werden. <regexp>.

      get <name> vcalendar
      Gibt den Kalender ICal-Format, so wie er von der Quelle gelesen wurde, zurück.

      get <name> vevents
      Gibt eine Liste aller VEVENT-Einträge des Kalenders <name>, angereichert um Ausgaben für die Fehlersuche, zurück. Es werden nur Eigenschaften angezeigt, die während der Programmausführung beibehalten wurden. Es wird sowohl die Liste der Termine, die von jedem VEVENT-Eintrag erzeugt wurden, als auch die Liste der ausgelassenen Termine angezeigt.

    Attributes

    • update sync|async|none
      Wenn dieses Attribut nicht gesetzt ist oder wenn es auf sync gesetzt ist, findet die Verarbeitung des Kalenders im Vordergrund statt. Große Kalender werden FHEM auf langsamen Systemen blockieren. Wenn das Attribut auf async gesetzt ist, findet die Verarbeitung im Hintergrund statt, und FHEM wird während der Verarbeitung nicht blockieren. Wenn dieses Attribut auf none gesetzt ist, wird der Kalender überhaupt nicht aktualisiert.
    • removevcalendar 0|1
      Wenn dieses Attribut auf 1 gesetzt ist, wird der vCalendar nach der Verarbeitung verworfen, gleichzeitig reduziert sich der Speicherverbrauch des Moduls. Ein Abruf über get <name> vcalendar ist dann nicht mehr möglich.
    • hideOlderThan <timespec>
      hideLaterThan <timespec>

      Dieses Attribut grenzt die Liste der durch get <name> full|debug|text|summary|location|alarm|start|end ... gezeigten Termine ein. Die Zeit wird relativ zur aktuellen Zeit t angegeben.
      Wenn <hideOlderThan> gesetzt ist, werden Termine, die vor <t-hideOlderThan> enden, ingnoriert.
      Wenn <hideLaterThan> gesetzt ist, werden Termine, die nach <t+hideLaterThan> anfangen, ignoriert.

      Bitte beachten, dass eine Aktion, die durch einen Wechsel in den Modus "end" ausgelöst wird, nicht auf den Termin zugreifen kann, wenn hideOlderThan 0 ist, weil der Termin dann schon versteckt ist. Besser hideOlderThan auf 10 setzen.

      <timespec> muss einem der folgenden Formate entsprechen:
      FormatBeschreibungBeispiel
      SSSSekunden3600
      SSSsSekunden3600s
      HH:MMStunden:Minuten02:30
      HH:MM:SSStunden:Minuten:Sekunden00:01:30
      D:HH:MM:SSTage:Stunden:Minuten:Sekunden122:10:00:00
      DDDdTage100d

    • cutoffOlderThan <timespec>
      Dieses Attribut schneidet alle nicht wiederkehrenden Termine weg, die eine Zeitspanne cutoffOlderThan vor der letzten Aktualisierung des Kalenders endeten. Der Zweck dieses Attributs ist es Speicher zu sparen. Auf solche Termine kann gar nicht mehr aus FHEM heraus zugegriffen werden. Serientermine und Termine ohne Endezeitpunkt (DTEND) werden nicht weggeschnitten.
    • onCreateEvent <perl-code>
      Dieses Attribut führt ein Perlprogramm <perl-code> für jeden erzeugten Termin aus. Weitere Informationen unter Plug-ins im Text.
    • SSLVerify
      Dieses Attribut setzt die Art der Überprüfung des Zertifikats des Partners bei mit SSL gesicherten Verbindungen. Entweder auf 0 setzen für SSL_VERIFY_NONE (keine Überprüfung des Zertifikats) oder auf 1 für SSL_VERIFY_PEER (Überprüfung des Zertifikats). Die Überprüfung auszuschalten ist nützlich für lokale Kalenderinstallationen(e.g. OwnCloud, NextCloud) ohne gütiges SSL-Zertifikat.
    • ignoreCancelled
      Wenn dieses Attribut auf 1 gesetzt ist, werden Termine im Status "CANCELLED" ignoriert. Dieses Attribut auf 1 setzen, falls Termine in einer Serie zurückgegeben werden, die gelöscht sind.
    • readingFnAttributes

    Beschreibung

      Ein Kalender ist eine Menge von Terminen. Ein Termin hat eine Zusammenfassung (normalerweise der Titel, welcher im Quell-Kalender angezeigt wird), eine Startzeit, eine Endzeit und keine, eine oder mehrere Alarmzeiten. Die Termine werden aus dem Quellkalender ermittelt, welcher über die URL angegeben wird. Sollten mehrere Alarmzeiten für einen Termin existieren, wird nur der früheste Alarmzeitpunkt beibehalten. Wiederkehrende Kalendereinträge werden in einem gewissen Umfang unterstützt: FREQ INTERVAL UNTIL COUNT werden ausgewertet, BYMONTHDAY BYMONTH WKST werden erkannt aber nicht ausgewertet. BYDAY wird für wöchentliche und monatliche Termine korrekt behandelt. Das Modul wird es sehr wahrscheinlich falsch machen, wenn Du wiederkehrende Termine mit unerkannten oder nicht ausgewerteten Schlüsselwörtern hast.

      Termine werden erzeugt, wenn FHEM gestartet wird oder der betreffende Eintrag im Quell-Kalender verändert wurde oder der Kalender mit get <name> reload neu geladen wird. Es werden nur Termine innerhalb ±400 Tage um die Erzeugungs des Termins herum erzeugt. Ziehe in Betracht, den Kalender von Zeit zu Zeit neu zu laden, um zu vermeiden, dass die künftigen Termine ausgehen. Du kann so etwas wie define reloadCalendar at +*240:00:00 set MyCalendar reload dafür verwenden.

      Manche dummen Kalender benutzen LAST-MODIFIED nicht. Das kann dazu führen, dass Veränderungen im Quell-Kalender unbemerkt bleiben. Lade den Kalender neu, wenn Du dieses Problem hast.

      Ein Termin wird durch seine UID identifiziert. Die UID wird vom Quellkalender bezogen. Um das Leben leichter zu machen, werden alle nicht-alphanumerischen Zeichen automatisch aus der UID entfernt.

      Ein Termin kann sich in einem der folgenden Modi befinden:
      upcomingWeder die Alarmzeit noch die Startzeit des Kalendereintrags ist erreicht.
      alarmDie Alarmzeit ist überschritten, aber die Startzeit des Kalender-Ereignisses ist noch nicht erreicht.
      startDie Startzeit ist überschritten, aber die Ende-Zeit des Kalender-Ereignisses ist noch nicht erreicht.
      endDie Ende-Zeit des Kalender-Ereignisses wurde überschritten.

      Ein Kalender-Ereignis wechselt umgehend von einem Modus zum Anderen, wenn die Zeit für eine Änderung erreicht wurde. Dies wird dadurch erreicht, dass auf die früheste zukünftige Zeit aller Alarme, Start- oder Endezeiten aller Kalender-Ereignisse gewartet wird.

      Ein Kalender-Device hat verschiedene Readings. Mit Ausnahme von calname stellt jedes Reading eine Semikolon-getrennte Liste von UIDs von Kalender-Ereignisse dar, welche bestimmte Zustände haben:
      calnameName des Kalenders
      modeAlarmEreignisse im Alarm-Modus
      modeAlarmOrStartEreignisse im Alarm- oder Startmodus
      modeAlarmedEreignisse, welche gerade in den Alarmmodus gewechselt haben
      modeChangedEreignisse, welche gerade in irgendeiner Form ihren Modus gewechselt haben
      modeEndEreignisse im Endemodus
      modeEndedEreignisse, welche gerade vom Start- in den Endemodus gewechselt haben
      modeStartEreignisse im Startmodus
      modeStartedEreignisse, welche gerade in den Startmodus gewechselt haben
      modeUpcomingEreignisse im zukünftigen Modus

      Für Serientermine werden mehrere Termine mit der selben UID erzeugt. In diesem Fall wird die UID nur im interessantesten gelesenen Modus-Reading angezeigt. Der interessanteste Modus ist der erste zutreffende Modus aus der Liste der Modi start, alarm, upcoming, end.

      Die UID eines Serientermins wird nicht angezeigt, solange sich der Termin im Modus: modeEnd oder modeEnded befindet und die Serie nicht beendet ist. Die UID befindet sich in einem der anderen mode... Readings. Hieraus ergibts sich, das FHEM-Events nicht auf einem mode... Reading basieren sollten. Weiter unten im Text gibt es hierzu eine Empfehlung.

    Events

      Wenn der Kalendar neu geladen oder aktualisiert oder eine Alarm-, Start- oder Endezeit erreicht wurde, wird ein FHEM-Event erzeugt:

      triggered

      Man kann sich darauf verlassen, dass alle Readings des Kalenders in einem konsistenten und aktuellen Zustand befinden, wenn dieses Event empfangen wird.

      Wenn ein Termin geändert wurde, werden zwei FHEM-Events erzeugt:

      changed: UID <mode>
      <mode>: UID

      <mode> ist der aktuelle Modus des Termins nach der änderung. Bitte beachten: Im FHEM-Event befindet sich ein Doppelpunkt gefolgt von einem Leerzeichen.

      FHEM-Events sollten nur auf den vorgenannten Events basieren und nicht auf FHEM-Events, die durch ändern eines mode... Readings ausgelöst werden.

    Plug-ins

      Experimentell, bitte mit Vorsicht nutzen.

      Ein Plug-In ist ein kleines Perl-Programm, dass Termine nebenher verändern kann. Das Perl-Programm arbeitet mit der Hash-Referenz $e.
      Die wichtigsten Elemente sind:
      codedescription
      $e->{start}Startzeit des Termins, in Sekunden seit 1.1.1970
      $e->{end}Endezeit des Termins, in Sekunden seit 1.1.1970
      $e->{alarm}Alarmzeit des Termins, in Sekunden seit 1.1.1970
      $e->{summary}die Zusammenfassung (Betreff, Titel) des Termins
      $e->{location}Der Ort des Termins

      Um für alle Termine mit dem Text "Tonne" in der Zusammenfassung die Alarmzeit zu ergänzen / zu ändern, kann folgendes Plug-In benutzt werden:

      attr MyCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 if($e->{summary} =~ /Tonne/);; }

      Das doppelte Semikolon maskiert das Semikolon. Perl specials können nicht genutzt werden.



    Anwendungsbeispiele

      Alle Termine inkl. Details anzeigen

        get MyCalendar full all
        2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom known alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee
        992hydf4y44awer5466lhfdsr­gl7tin6b6mckf8glmhui4­googlecom known upcoming 08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation


      Zeige Termine in Deinem Bilderrahmen

        Füge eine Zeile in die layout description ein, um Termine im Alarm- oder Startmodus anzuzeigen:

        text 20 60 { fhem("get MyCalendar text next 2") }

        Dies kann dann z.B. so aussehen:

        07.06.12 16:30 Erna zum Kaffee
        08.06.12 00:00 Urlaub


      Schalte das Licht ein, wenn Erna kommt

        Finde zuerst die UID des Termins:

        get MyCalendar find .*Erna.*
        2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom


        Definiere dann ein notify: (Der Punkt nach dem zweiten Doppelpunkt steht für ein Leerzeichen)

        define ErnaComes notify MyCalendar:start:.2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom.* set MyLight on

        Du kannst auch ein Logging aufsetzen:

        define LogErna notify MyCalendar:alarm:.2767324dsfretfvds7dsfn3e4­dsa234r234sdfds6bh874­googlecom.* { Log3 $NAME, 1, "ALARM name=$NAME event=$EVENT part1=$EVTPART0 part2=$EVTPART1" }

      Schalte die Aktoren an und aus

        Stell Dir einen Kalender vor, dessen Zusammenfassungen (Betreff, Titel) die Namen von Devices in Deiner fhem-Installation sind. Du willst nun die entsprechenden Devices an- und ausschalten, wenn das Kalender-Ereignis beginnt bzw. endet.

        define SwitchActorOn notify MyCalendar:start:.* {}
        Dann auf DEF klicken und im DEF-Editor folgendes zwischen die beiden geschweiften Klammern {} eingeben: my $reading="$EVTPART0"; my $uid= "$EVTPART1"; my $actor= fhem("get MyCalendar summary $uid"); if(defined $actor) { fhem("set $actor on") }

        define SwitchActorOff notify MyCalendar:end:.* {}
        Dann auf DEF klicken und im DEF-Editor folgendes zwischen die beiden geschweiften Klammern {} eingeben: my $reading="$EVTPART0"; my $uid= "$EVTPART1"; my $actor= fhem("get MyCalendar summary $uid"); if(defined $actor) { fhem("set $actor off") }

        Auch hier kann ein Logging aufgesetzt werden:

        define LogActors notify MyCalendar:(start|end).* {}
        Dann auf DEF klicken und im DEF-Editor folgendes zwischen die beiden geschweiften Klammern {} eingeben: my $reading= "$EVTPART0"; my $uid= "$EVTPART1"; my $actor= fhem("get MyCalendar summary $uid"); Log 3 $NAME, 1, "Actor: $actor, Reading $reading";

    Eingebettetes HTML

      Das Modul stellt eine zusätzliche Funktion CalendarAsHtml(<name>,<options>) bereit. Diese gibt den HTML-Kode für eine Liste von Terminen zurück. <name> ist der Name des Kalendar-Device und <options> ist das, was Du hinter get <name> text ... schreiben würdest.

      Beispiel: define MyCalendarWeblink weblink htmlCode { CalendarAsHtml("MyCalendar","next 3") }

      Dies ist eine rudimentäre Funktion, die vielleicht in künftigen Versionen erweitert wird.

=end html_DE =cut