mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-12 20:02:00 +00:00
359 lines
11 KiB
Perl
Executable File
359 lines
11 KiB
Perl
Executable File
#######################################################################
|
|
# $Id$
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use POSIX;
|
|
|
|
sub holiday_refresh($$);
|
|
|
|
#####################################
|
|
sub
|
|
holiday_Initialize($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
$hash->{DefFn} = "holiday_Define";
|
|
$hash->{GetFn} = "holiday_Get";
|
|
$hash->{UndefFn} = "holiday_Undef";
|
|
}
|
|
|
|
|
|
#####################################
|
|
sub
|
|
holiday_Define($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
|
|
return holiday_refresh($hash->{NAME}, undef) if($init_done);
|
|
InternalTimer(gettimeofday()+1, "holiday_refresh", $hash->{NAME}, 0);
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
holiday_Undef($$)
|
|
{
|
|
my ($hash, $name) = @_;
|
|
RemoveInternalTimer($name);
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
holiday_refresh($$)
|
|
{
|
|
my ($name, $fordate) = (@_);
|
|
my $hash = $defs{$name};
|
|
my $internal;
|
|
|
|
return if(!$hash); # Just deleted
|
|
|
|
my $nt = gettimeofday();
|
|
my @lt = localtime($nt);
|
|
my @fd;
|
|
if(!$fordate) {
|
|
$internal = 1;
|
|
$fordate = sprintf("%02d-%02d", $lt[4]+1, $lt[3]);
|
|
@fd = @lt;
|
|
} else {
|
|
my ($m,$d) = split("-", $fordate);
|
|
@fd = localtime(mktime(1,1,1,$d,$m-1,$lt[5],0,0,-1));
|
|
}
|
|
|
|
my $fname = $attr{global}{modpath} . "/FHEM/" . $hash->{NAME} . ".holiday";
|
|
return "Can't open $fname: $!" if(!open(FH, $fname));
|
|
my @foundList;
|
|
|
|
while(my $l = <FH>) {
|
|
next if($l =~ m/^\s*#/);
|
|
next if($l =~ m/^\s*$/);
|
|
chomp($l);
|
|
my $found;
|
|
|
|
if($l =~ m/^1/) { # Exact date: 1 MM-DD Holiday
|
|
my @args = split(" +", $l, 3);
|
|
if($args[1] eq $fordate) {
|
|
$found = $args[2];
|
|
}
|
|
|
|
} elsif($l =~ m/^2/) { # Easter date: 2 +1 Ostermontag
|
|
|
|
###mh new code for easter sunday calc w.o. requirement for
|
|
# DateTime::Event::Easter
|
|
# replace $a1 with $1 !!!
|
|
# split line from file into args '2 <offset from E-sunday> <tagname>'
|
|
my @a = split(" ", $l, 3);
|
|
|
|
# get month & day for E-sunday
|
|
my ($Om,$Od) = western_easter(($lt[5]+1900));
|
|
my $timex = mktime(0,0,12,$Od,$Om-1, $lt[5],0,0,-1); # gen timevalue
|
|
$timex = $timex + $a[1]*86400; # add offset days
|
|
|
|
my ($msecond, $mminute, $mhour,
|
|
$mday, $mmonth, $myear, $mrest) = localtime($timex);
|
|
$myear = $myear+1900;
|
|
$mmonth = $mmonth+1;
|
|
#Log 4, "$name: Ostern ".($lt[5]+1900)." ist am " .sprintf("%02d-%02d",
|
|
# $Od, $Om) ." Target day: $mday-$mmonth-$myear";
|
|
|
|
next if($mday != $fd[3] || $mmonth != $fd[4]+1);
|
|
$found = $a[2];
|
|
Log 4, "$name: Match day: $a[2]\n";
|
|
|
|
} elsif($l =~ m/^3/) { # Relative date: 3 -1 Mon 03 Holiday
|
|
my @a = split(" +", $l, 5);
|
|
my %wd = ("Sun"=>0, "Mon"=>1, "Tue"=>2, "Wed"=>3,
|
|
"Thu"=>4, "Fri"=>5, "Sat"=>6);
|
|
my @md = (31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31);
|
|
$md[1]=29 if(schaltjahr($fd[5]+1900) && $fd[4] == 1);
|
|
my $wd = $wd{$a[2]};
|
|
if(!defined($wd)) {
|
|
Log 1, "Wrong timespec: $l";
|
|
next;
|
|
}
|
|
next if($wd != $fd[6]); # Weekday
|
|
next if($a[3] != ($fd[4]+1)); # Month
|
|
if($a[1] > 0) { # N'th day from the start
|
|
my $d = $fd[3] - ($a[1]-1)*7;
|
|
next if($d < 1 || $d > 7);
|
|
} elsif($a[1] < 0) { # N'th day from the end
|
|
my $d = $fd[3] - ($a[1]+1)*7;
|
|
my $md = $md[$fd[4]];
|
|
next if($d > $md || $d < $md-6);
|
|
}
|
|
|
|
$found = $a[4];
|
|
|
|
} elsif($l =~ m/^4/) { # Interval: 4 MM-DD MM-DD Holiday
|
|
my @args = split(" +", $l, 4);
|
|
if($args[1] le $fordate && $args[2] ge $fordate) {
|
|
$found = $args[3];
|
|
}
|
|
|
|
} elsif($l =~ m/^5/) { # nth weekday since MM-DD / before MM-DD
|
|
my @a = split(" +", $l, 6);
|
|
# arguments: 5 <distance> <weekday> <month> <day> <name>
|
|
my %wd = ("Sun"=>0, "Mon"=>1, "Tue"=>2, "Wed"=>3,
|
|
"Thu"=>4, "Fri"=>5, "Sat"=>6);
|
|
my $wd = $wd{$a[2]};
|
|
if(!defined($wd)) {
|
|
Log 1, "Wrong weekday spec: $l";
|
|
next;
|
|
}
|
|
next if $wd != $fd[6]; # check wether weekday matches today
|
|
my $yday=$fd[7];
|
|
# create time object of target date - mktime counts months and their
|
|
# days from 0 instead of 1, so subtract 1 from each
|
|
my $tgt=mktime(0,0,1,$a[4]-1,$a[3]-1,$fd[5],0,0,-1);
|
|
my $tgtmin=$tgt;
|
|
my $tgtmax=$tgt;
|
|
my $weeksecs=7*24*60*60; # 7 days, 24 hours, 60 minutes, 60seconds each
|
|
my $cd=mktime(0,0,1,$fd[3],$fd[4],$fd[5],0,0,-1);
|
|
if ( $a[1] =~ /^-([0-9])*$/ ) {
|
|
$tgtmin -= $1*$weeksecs; # Minimum: target date minus $1 weeks
|
|
$tgtmax = $tgtmin+$weeksecs; # Maximum: one week after minimum
|
|
# needs to be lower than max and greater than or equal to min
|
|
if( ($cd ge $tgtmin) && ( $cd lt $tgtmax) ) {
|
|
$found=$a[5];
|
|
}
|
|
} elsif ( $a[1] =~ /^\+?([0-9])*$/ ) {
|
|
$tgtmin += ($1-1)*$weeksecs; # Minimum: target date plus $1-1 weeks
|
|
$tgtmax = $tgtmin+$weeksecs; # Maximum: one week after minimum
|
|
# needs to be lower than or equal to max and greater min
|
|
if( ($cd gt $tgtmin) && ( $cd le $tgtmax) ) {
|
|
$found=$a[5];
|
|
}
|
|
} else {
|
|
Log 1, "Wrong distance spec: $l";
|
|
next;
|
|
}
|
|
}
|
|
push @foundList, $found if($found);
|
|
|
|
}
|
|
close(FH);
|
|
|
|
push @foundList, "none" if(!int(@foundList));
|
|
my $found = join(", ", @foundList);
|
|
|
|
RemoveInternalTimer($name);
|
|
$nt -= ($lt[2]*3600+$lt[1]*60+$lt[0]); # Midnight
|
|
$nt += 86400 + 2; # Tomorrow
|
|
$hash->{TRIGGERTIME} = $nt;
|
|
InternalTimer($nt, "holiday_refresh", $name, 0);
|
|
|
|
if($internal) {
|
|
$hash->{STATE} = $found;
|
|
return undef;
|
|
} else {
|
|
return $found;
|
|
}
|
|
|
|
}
|
|
|
|
sub
|
|
holiday_Get($@)
|
|
{
|
|
my ($hash, @a) = @_;
|
|
|
|
return "argument is missing" if(int(@a) != 2);
|
|
my $arg;
|
|
|
|
if($a[1] =~ m/^[01]\d-[0-3]\d/) {
|
|
$arg = $a[1];
|
|
|
|
} elsif($a[1] =~ m/^yesterday|today|tomorrow$/) {
|
|
my $t = time();
|
|
$t += 86400 if($a[1] eq "tomorrow");
|
|
$t -= 86400 if($a[1] eq "yesterday");
|
|
my @a = localtime($t);
|
|
$arg = sprintf("%02d-%02d", $a[4]+1, $a[3]);
|
|
|
|
} else {
|
|
return "wrong argument: need MM-DD/yesterday/today/tomorrow"
|
|
|
|
}
|
|
return holiday_refresh($hash->{NAME}, $arg);
|
|
}
|
|
|
|
sub
|
|
schaltjahr($)
|
|
{
|
|
my($jahr) = @_;
|
|
return 0 if $jahr % 4; # 2009
|
|
return 1 unless $jahr % 400; # 2000
|
|
return 0 unless $jahr % 100; # 2100
|
|
return 1; # 2012
|
|
}
|
|
|
|
### mh sub western_easter copied from cpan Date::Time::Easter
|
|
### mh changes marked with # mh
|
|
### mh
|
|
### mh calling parameter is 4 digit year
|
|
### mh
|
|
sub
|
|
western_easter($)
|
|
{
|
|
my $year = shift;
|
|
my $golden_number = $year % 19;
|
|
|
|
#quasicentury is so named because its a century, only its
|
|
# the number of full centuries rather than the current century
|
|
my $quasicentury = int($year / 100);
|
|
my $epact = ($quasicentury - int($quasicentury/4) -
|
|
int(($quasicentury * 8 + 13)/25) + ($golden_number*19) + 15) % 30;
|
|
|
|
my $interval = $epact - int($epact/28)*
|
|
(1 - int(29/($epact+1)) * int((21 - $golden_number)/11) );
|
|
my $weekday = ($year + int($year/4) + $interval +
|
|
2 - $quasicentury + int($quasicentury/4)) % 7;
|
|
|
|
my $offset = $interval - $weekday;
|
|
my $month = 3 + int(($offset+40)/44);
|
|
my $day = $offset + 28 - 31* int($month/4);
|
|
|
|
return $month, $day;
|
|
}
|
|
1;
|
|
|
|
=pod
|
|
=begin html
|
|
|
|
<a name="holiday"></a>
|
|
<h3>holiday</h3>
|
|
<ul>
|
|
<a name="holidaydefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> holiday</code>
|
|
<br><br>
|
|
Define a set of holidays. The module will try to open the file
|
|
<name>.holiday in the <a href="#modpath">modpath</a>/FHEM directory.
|
|
If entries in the holiday file match the current day, then the STATE of
|
|
this holiday instance displayed in the <a href="#list">list</a> command
|
|
will be set to the corresponding values, else the state is set to the text
|
|
none. Most probably you'll want to query this value in some perl script:
|
|
see Value() in the <a href="#perl">perl</a> section or the global attribute
|
|
<a href="#holiday2we"> holiday2we</a>.<br> The file will be reread once
|
|
every night, to compute the value for the current day, and by each get
|
|
command (see below).<br>
|
|
<br>
|
|
|
|
Holiday file definition:<br>
|
|
The file may contain comments (beginning with #) or empty lines.
|
|
Significant lines begin with a number (type) and contain some space
|
|
separated words, depending on the type. The different types are:<br>
|
|
<ul>
|
|
<li>1<br>
|
|
Exact date. Arguments: <MM-DD> <holiday-name><br>
|
|
Exampe: 1 12-24 Christmas
|
|
</li>
|
|
<li>2<br>
|
|
Easter-dependent date. Arguments: <day-offset>
|
|
<holiday-name>.
|
|
The offset is counted from Easter-Sunday.
|
|
<br>
|
|
Exampe: 2 1 Easter-Monday<br>
|
|
Sidenote: You can check the easter date with:
|
|
fhem> { join("-", western_easter(2011)) }
|
|
</li>
|
|
<li>3<br>
|
|
Month dependent date. Arguments: <nth> <weekday>
|
|
<month <holiday-name>.<br>
|
|
Examples:<br>
|
|
<ul>
|
|
3 1 Mon 05 First Monday In May<br>
|
|
3 2 Mon 05 Second Monday In May<br>
|
|
3 -1 Mon 05 Last Monday In May<br>
|
|
3 0 Mon 05 Each Monday In May<br>
|
|
</ul>
|
|
</li>
|
|
<li>4<br>
|
|
Interval. Arguments: <MM-DD> <MM-DD> <holiday-name>
|
|
.<br>
|
|
Example:<br>
|
|
<ul>
|
|
4 06-01 06-30 Summer holiday<br>
|
|
</ul>
|
|
</li>
|
|
<li>5<br>
|
|
Date relative, weekday fixed holiday. Arguments: <nth>
|
|
<weekday> <month> <day> < holiday-name><br>
|
|
Note that while +0 or -0 as offsets are not forbidden, their behaviour
|
|
is undefined in the sense that it might change without notice.<br>
|
|
Examples:<br>
|
|
<ul>
|
|
5 -1 Wed 11 23 Buss und Bettag (first Wednesday before Nov, 23rd)<br>
|
|
5 1 Mon 01 31 First Monday after Jan, 31st (1st Monday in February)<br>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
See also he.holiday in the contrib directory for official holidays in the
|
|
german country of Hessen, and by.holiday for the Bavarian definition.
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="holidayset"></a>
|
|
<b>Set</b> <ul>N/A</ul><br>
|
|
|
|
<a name="holidayget"></a>
|
|
<b>Get</b>
|
|
<ul>
|
|
<code>get <name> <MM-DD></code><br>
|
|
<code>get <name> yesterday</code><br>
|
|
<code>get <name> today</code><br>
|
|
<code>get <name> tomorrow</code><br>
|
|
<br><br>
|
|
Return the holiday name of the specified date or the text none.
|
|
<br><br>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="holidayattr"></a>
|
|
<b>Attributes</b><ul>N/A</ul><br>
|
|
|
|
</ul>
|
|
|
|
=end html
|
|
=cut
|