mirror of
https://salsa.debian.org/dskoll/remind.git
synced 2026-04-16 06:18:47 +02:00
848 lines
32 KiB
Perl
Executable File
848 lines
32 KiB
Perl
Executable File
#!/usr/bin/perl -w
|
|
|
|
# rem2ics -- convert the output of "remind -s" into RFC2445 iCalendar format.
|
|
|
|
# Copyright 2007,2008,2009
|
|
# Mark Atwood <me@mark.atwood.name>
|
|
# Paul Hinze <paul dot t dot hinze at gmail dot com>
|
|
# Michael Schultz <mjschultz at gmail dot com>
|
|
#
|
|
# This program 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.
|
|
#
|
|
# This program 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 this program; if not, write to the
|
|
# Free Software Foundation, Inc.
|
|
# 51 Franklin Street, Fifth Floor
|
|
# Boston MA 02110-1301 USA
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
=head1 NAME
|
|
|
|
rem2ics - convert the output of "remind -s" into RFC2445 iCalendar format.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
TZ=I<timezone> B<rem2ics> [B<-man>] [B<-do>] [B<-norecur>] [B<-usetag>] E<lt>input E<gt>output
|
|
|
|
=head1 OPTIONS AND ARGUMENTS
|
|
|
|
=over 8
|
|
|
|
=item B<-man>
|
|
|
|
Print the manual page and exit.
|
|
|
|
=item B<-do>
|
|
|
|
Actually do the conversion. Otherwise just print a brief help message
|
|
and usage example, and then exit.
|
|
|
|
=item B<-norecur>
|
|
|
|
Do not attempt to detect and fold together recurring events.
|
|
|
|
=item B<-usetag>
|
|
|
|
Generate UIDs using remind TAG clauses.
|
|
|
|
=back
|
|
|
|
Input is from standard input
|
|
|
|
Output is to standard output.
|
|
|
|
=head1 USAGE
|
|
|
|
remind -s360 -irem2ics=1 ~/.reminders 1 Jan 1991 | TZ=PST8PDT rem2ics -do >reminders.ics
|
|
|
|
This tells B<remind> to use ~/.reminders, and to process the entire
|
|
range of dates it can handle (from Jan 1 1991 to Dec 31 2020), and to
|
|
define a variable named C<rem2ics>, which can be used in
|
|
C<IF !defined("rem2ics")> / C<ENDIF> pairs.
|
|
B<rem2ics> will use a timezone of PST8PDT, and will fold events that
|
|
have the same name and duration into a single iCalendar VEVENT object.
|
|
|
|
=head1 NOTES
|
|
|
|
=head2 Timezones and the TZ environment variable.
|
|
|
|
B<rem2ics> uses the TZ environment variable to determine the value of
|
|
the RFC2445 TZID property. If you are running on a Linux or other GNU
|
|
libc based system, you probably don't (and probably shouldn't)
|
|
normally have TZ set. You can confirm this by running C<printenv TZ>
|
|
at a shell prompt. If your remind data is in your "local time", and
|
|
it probably is, you should probably set TZ to a good name for your
|
|
local timezone just for the run of this script. You probably should
|
|
NOT set TZ in your login scripts.
|
|
|
|
You can use TZ like this:
|
|
|
|
remind -s ~/.reminders | TZ=PST8PDT rem2ics -do >reminders.ics
|
|
|
|
or
|
|
|
|
remind -s ~/.reminders | TZ=US/Pacific rem2ics -do >reminders.ics
|
|
|
|
|
|
If, for some reason, your remind files are all in GMT instead of
|
|
localtime (you smart person you!), you can do this:
|
|
|
|
remind -s ~/.reminders | TZ=GMT rem2ics -do >reminders.ics
|
|
|
|
or
|
|
|
|
remind -s ~/.reminders | TZ=0 rem2ics -do >reminders.ics
|
|
|
|
and B<rem2ics> will use the ISO8601 "Z" notation for GMT time in the ics
|
|
file. (Other synonyms for GMT are the empty string (not the same as
|
|
the TZ not set), "I<0>", "I<Z>", "I<Zulu>", "I<Greenwitch>", "I<GMT>",
|
|
"I<GMT+0>, and "I<GMT-0>".)
|
|
|
|
If you leave TZ undefined and unset, B<rem2ics> will use the ISO8601
|
|
"T" notation date strings with no TZID property, which RFC2445 calls a
|
|
"floating time". Who knows, it might work for you!
|
|
|
|
The TZ string value is literally incorporated into the iCalendar
|
|
stream, so whatever your iCalendar-using application needs is what you
|
|
should use. You may have to experiment a bit.
|
|
|
|
You can look around in C</usr/share/zoneinfo> to get the names of
|
|
every timezone anywhere. This is the "Olson database" that RFC2445
|
|
refers to. Read the man page for L<tzfile(5)> for more than you ever
|
|
wanted to know about the format of these files, and about GNU libc's
|
|
handling of timezones. As complex as it is, it's certainly better
|
|
than what POSIX defines or what most legacy UNIX systems do, and most
|
|
certainly better than Microsoft, who in their "cutting edge" "state of
|
|
the art" "server" OS, still hasn't figured out that daylight time
|
|
rules might be different in different years.
|
|
|
|
If you just ran B<rem2ics> without reading all this stuff, or if you
|
|
don't want to worry about it at all, and somehow your iCalendar
|
|
application manager is able to guess the proper timezone for you, just
|
|
leave TZ undefined, and B<rem2ics> will use the ISO8601 "T" notation
|
|
date strings with no TZID property, which RFC2445 calls a "floating
|
|
time". Who knows, it might work for you!
|
|
|
|
=head2 Detecting recurring events
|
|
|
|
B<rem2ics> tries to detect recurring events. If any multiple events
|
|
appear with exactly the text and exactly the same duration (including
|
|
"no duration"), instead of multiple VEVENT objects, there will be just
|
|
one VEVENT object, that will have a RFC2445 C<RDATE> property.
|
|
|
|
B<rem2ics> is not yet smart enough to derive an C<RRULE> based
|
|
recurrence. If you really want that feature, either implement it and
|
|
send in a patch, or contact the author and convince him to do it.
|
|
|
|
=head2 Other iCalendar Properties
|
|
|
|
B<rem2ics> does not generate C<DESCRIPTION> or C<LOCATION>. One
|
|
would have to heuristically parse them out of the text, and everyone
|
|
uses a idiosyncratic way of putting things in B<remind>.
|
|
|
|
If the B<-usetag> option is not used or no C<TAG> is set for a
|
|
reminder, B<rem2ics> will synthesize C<UID> properties for each
|
|
VEVENT, but the UIDs will be different (and unique) for each run of
|
|
B<rem2ics>. If you run rem2ics twice and import the two resulting ICS
|
|
streams into your new scheduling program, your appointments will
|
|
appear twice. If, however, you have set C<TAG> clauses in your
|
|
reminders and activated B<-usetag>, these will be used. The same
|
|
applies for tags synthesized by B<remind>'s B<-y> option. Hence, it
|
|
is more useful to use the B<-y> option than to let B<rem2ics>
|
|
synthesize UIDs, because the UIDs will stay the same across multiple
|
|
runs.
|
|
|
|
=head2 Other iCalendar Perl objects
|
|
|
|
Why doesn't B<rem2ics> use any of the iCalendar Perl stuff in CPAN?
|
|
Because I don't trust them, and they are too big for this app. One
|
|
links to a binary library. Another hasn't been maintained since 1991,
|
|
and is full of notes as to how buggy and incomplete it is. And so
|
|
forth. I am not at this moment interested in groveling around in
|
|
L<Net::iCal>, L<DateTime::Format::iCal>, L<Tie::iCal>,
|
|
L<iCal::Parser>, or C<libical>.
|
|
|
|
=head2 Previous implementation
|
|
|
|
There is a working quick & dirty rem2ics written in awk
|
|
by Anthony J. Chivetta E<lt>achivetta@gmail.comE<gt>.
|
|
|
|
But it has the following problems: it doesn't escape the text, it
|
|
doesn't handle events that cross over midnight, it doesn't do
|
|
timezones, it doesn't enforce the correct EOL sequence, and it doesn't
|
|
fold long lines. This is a replacement for that script.
|
|
|
|
=head1 TODO
|
|
|
|
If TZ not set, grab out of system config somewhere
|
|
Detect recurring events.
|
|
If I'm REALLY smart, derive RRULE
|
|
Handle characters not in US-ASCII. Latin1? UTF8?
|
|
|
|
=head1 VERSION HISTORY
|
|
|
|
=over 8
|
|
|
|
=item version 0.1 2007-02-08
|
|
|
|
First cut.
|
|
|
|
=item version 0.2 2007-02-09
|
|
|
|
Reorg into multipass over a data structure.
|
|
|
|
=item version 0.3 2007-02-10
|
|
|
|
Collapse repeating events. Fold output lines.
|
|
|
|
=item version 0.9 2007-02-11
|
|
|
|
POD. Command line options. First public release.
|
|
|
|
=item version 0.91 2007-02-14
|
|
|
|
Bug fix, error message for non-recurring events
|
|
|
|
=item version 0.92 2008-01-28
|
|
|
|
Bug fix,
|
|
rem2ics 0.91 chokes on timed reminders with
|
|
duration using `remind -s` as it functions in remind-03.01.03.
|
|
Remind 3.01 changed how the -s data is formatted for events that have a duration
|
|
Patch by Paul Hinze E<lt>paul dot t dot hinze at gmail dot comE<gt>
|
|
and Michael Schultz E<lt>mjschultz at gmail dot comE<gt>
|
|
|
|
=item version 0.93 2009-06-25
|
|
|
|
Add B<-usetag> option to allow for UIDs to stay the same across multiple runs
|
|
by using the remind TAG clause.
|
|
Patch by Tim Weber E<lt>scy at scytale dot nameE<gt>
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<http://mark.atwood.name/code/rem2ics>
|
|
|
|
L<http://en.wikipedia.org/wiki/ICalendar>
|
|
|
|
L<http://tools.ietf.org/html/rfc2445>
|
|
|
|
L<https://dianne.skoll.ca/projects/remind/>
|
|
|
|
L<remind(1)>
|
|
|
|
=head1 AUTHOR
|
|
|
|
Copyright 2007,2008,2009 by Mark Atwood E<lt>me+rem2ics@mark.atwood.nameE<gt>. L<http://mark.atwood.name/>.
|
|
|
|
Please report bugs (with patches, if possible).
|
|
|
|
Inspired by Anthony J. Chivetta E<lt>achivetta@gmail.comE<gt>'s
|
|
rem2ics in awk.
|
|
|
|
Thank you to Dianne Skoll E<lt>dianne@skoll.ca<gt> for Remind,
|
|
and to the IETF calsch wg for the iCalendar specification.
|
|
|
|
=cut
|
|
|
|
use Getopt::Long;
|
|
use Pod::Usage;
|
|
|
|
my $app_name = "rem2ics";
|
|
my $app_version = "0.93";
|
|
|
|
# process the command line
|
|
my %options;
|
|
GetOptions(\%options, qw(man do norecurr usetag)) || pod2usage(2);
|
|
pod2usage(-verbose => 2) if ($options{man});
|
|
|
|
unless ($options{do}) {
|
|
print STDERR "Run \"$0 -man\" for information and usage examples.\n"
|
|
. "Pay special attention to information about timezone.\n";
|
|
exit(99);
|
|
}
|
|
|
|
# grab the hostname
|
|
# this is used as part of the UID property of each VEVENT
|
|
my $ical_uid_hostname = $ENV{'HOSTNAME'};
|
|
unless ($ical_uid_hostname) {
|
|
print STDERR "Warning! "
|
|
. "The environment variable HOSTNAME was not properly set.\n"
|
|
. "Will use \"localhost\" in the RFC2445 UID property\n";
|
|
$ical_uid_hostname = "localhost";
|
|
}
|
|
|
|
# look for the TZ
|
|
my $ical_tzid = undef;
|
|
if (exists $ENV{'TZ'}) {
|
|
$ical_tzid = $ENV{'TZ'};
|
|
my %synonyms_for_gmt = (
|
|
'' => 1, '0' => 1, 'z' => 1, 'zulu' => 1, 'greenwitch' => 1,
|
|
'gmt' => 1, 'gmt+0' => 1, 'gmt-0' => 1, );
|
|
if (exists $synonyms_for_gmt{lc($ical_tzid)}) {
|
|
$ical_tzid = ''; # empty means GMT, below
|
|
}
|
|
} else {
|
|
# leave it undefined, that has a meaning below
|
|
}
|
|
|
|
# RFC2445 DTSTAMP property will be the time we started running ($^T)
|
|
my ($ical_dtstamp);
|
|
{
|
|
my @gt = gmtime($^T);
|
|
$ical_dtstamp = sprintf("%04d%02d%02dZ%02d%02d%02dZ",
|
|
1900+$gt[5], $gt[4]+1, $gt[3],
|
|
$gt[2], $gt[1], $gt[0]);
|
|
}
|
|
|
|
my ($cnt, $v, @events);
|
|
|
|
$cnt = 0;
|
|
foreach (<STDIN>) {
|
|
$cnt++;
|
|
|
|
s/#.*//; # toss comments
|
|
next if /^\s*$/; # skip blank lines
|
|
chomp;
|
|
|
|
$v = undef;
|
|
|
|
# store the raw line
|
|
$v->{src} = $_;
|
|
$v->{cnt} = $cnt;
|
|
|
|
# split and parse the line
|
|
# if we don't like it, skip it and go around again
|
|
|
|
# sf[0] = date, in yyyy/mm/dd format
|
|
# sf[1] = special, usually "*"
|
|
# sf[2] = tag, usually "*"
|
|
# sf[3] = duration, in minutes
|
|
# sf[4] = time, since midnight, in minutes
|
|
# sf[5] = text
|
|
|
|
my @sf = split(' ', $_, 6);
|
|
next unless ($sf[1] eq '*'); # ignore SPECIAL lines
|
|
next unless (($sf[3] eq '*') or ($sf[3] =~ m/\d+/));
|
|
next unless (($sf[4] eq '*') or ($sf[4] =~ m/\d+/));
|
|
next unless (length($sf[5]) > 0);
|
|
|
|
my @dt = split('/', $sf[0], 3);
|
|
next unless ($dt[0] =~ m/^\d{4}$/); # year
|
|
next unless ($dt[1] =~ m/^\d{2}$/); # month
|
|
next unless ($dt[2] =~ m/^\d{2}$/); # day
|
|
|
|
if ($sf[4] ne "*") { # a time was given
|
|
# When an event has a time, remind -s "helpfully" also
|
|
# puts it as text at the start of the text portion.
|
|
# This takes the following form:
|
|
# ##:##[a|p]m <rest of MSG>
|
|
# or, if the event has a duration:
|
|
# ##:##[a|p]m-##:##[a|p]m <rest of MSG>
|
|
# Rather than a nasty regex, just splitting at the
|
|
# first space does the trick.
|
|
my($extra_time, $textmsg) = split(' ', $sf[5], 2);
|
|
$sf[5] = $textmsg;
|
|
}
|
|
|
|
$v->{sf} = \@sf;
|
|
$v->{dt} = \@dt;
|
|
|
|
push @events, $v;
|
|
}
|
|
|
|
# generate the "date time string" for each event
|
|
foreach $v (@events) {
|
|
if (${$v->{sf}}[4] eq "*") { # no time was given
|
|
$v->{dts} = sprintf("%04d%02d%02d", @{$v->{dt}});
|
|
} else { # a time was given
|
|
my ($t_hr, $t_mn) = &idiv(${$v->{sf}}[4], 60);
|
|
$v->{dts} = sprintf("%04d%02d%02dT%02d%02d00",
|
|
@{$v->{dt}}, $t_hr, $t_mn);
|
|
|
|
}
|
|
}
|
|
|
|
my(%grovel);
|
|
|
|
# if the user doesn't want recurrence detection
|
|
unless ($options{norecurr}) {
|
|
|
|
# then dont put events in the grovel hash
|
|
|
|
foreach $v (@events) {
|
|
# key is duration followed by text
|
|
# \036 is "ASCII RS Record Separator"
|
|
my $k = ${$v->{sf}}[3] . "\036" . ${$v->{sf}}[5];
|
|
push @{$grovel{$k}}, $v;
|
|
}
|
|
|
|
foreach my $k (keys %grovel) {
|
|
if ((scalar @{$grovel{$k}}) > 1) {
|
|
$v = ${$grovel{$k}}[0];
|
|
$v->{recurlist} = \@{$grovel{$k}};
|
|
foreach my $v0 (@{$grovel{$k}}) {
|
|
$v0->{is_recurrence} = $v;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
# All of the individual events are in the @events array. All of the
|
|
# unique combinations of duration/event name are the keys in the
|
|
# %grovel hash, the elements of which are references to an arrays of
|
|
# references to the events, in the same ordering as they we read by
|
|
# us, which *ought* to be in datewise order. I don't know if "remind
|
|
# -s" actually sorts into true chronological order. If it doesn't, we
|
|
# might have a problem if a recurring event has two instances both on
|
|
# the first day.
|
|
|
|
# Every event that is recurring has a "is_recurrence" property.
|
|
# Additionally, (hopefully) the first/earliest event in a set of
|
|
# recurrences has a "recurlist" property. The "recurlist" is a
|
|
# reference to a list of references to each of the events. The first
|
|
# one on that list will be the same event that has the "recurlist"
|
|
# property. The "is_recurrence" property is a reference back to the
|
|
# event that has the "recurlist" property.
|
|
|
|
foreach my $k (keys %grovel) {
|
|
next if ((scalar @{$grovel{$k}}) <= 1);
|
|
|
|
my $recur_str = "";
|
|
foreach $v (@{$grovel{$k}}) {
|
|
if (${$v->{sf}}[4] eq "*") { # no time was given
|
|
$recur_str .= ($v->{dts} . ",");
|
|
} else {
|
|
if (defined($ical_tzid)) {
|
|
if ($ical_tzid eq '') { # tz is defined but empty, so in GMT
|
|
$recur_str .= $v->{dts} . "Z,";
|
|
} else { # tz is non-zero, so output the tz as well
|
|
$recur_str .= $v->{dts} . ",";
|
|
}
|
|
} else { # undefined tz, just floating time
|
|
$recur_str .= $v->{dts} . ",";
|
|
}
|
|
}
|
|
}
|
|
|
|
# the recur_str now has an extra comma at the end. chop it off
|
|
chop($recur_str);
|
|
${$grovel{$k}}[0]->{recur_str} = $recur_str;
|
|
}
|
|
|
|
foreach my $k (keys %grovel) {
|
|
next if ((scalar @{$grovel{$k}}) <= 1);
|
|
my $v = ${$grovel{$k}}[0]; # grab the head of each list
|
|
if (${$v->{sf}}[4] eq "*") { # no time was given
|
|
# the default value type for an RDATE is DATE-TIME,
|
|
# we much change the type to DATE
|
|
$v->{i_rdate} = sprintf("RDATE;VALUE=DATE:");
|
|
} else {
|
|
if (defined($ical_tzid)) {
|
|
if ($ical_tzid eq '') { # tz is defined but empty, so in GMT
|
|
$v->{i_rdate} = sprintf("RDATE:");
|
|
} else { # tz is non-zero, so output the tz as well
|
|
$v->{i_rdate} = sprintf("RDATE;TZID=%s:", $ical_tzid);
|
|
}
|
|
} else { # undefined tz, just floating time
|
|
$v->{i_rdate} = sprintf("RDATE:");
|
|
}
|
|
}
|
|
# now stick the recur_str onto the end
|
|
$v->{i_rdate} .= $v->{recur_str};
|
|
# if we ever get memory tight, we can probably undef($v->{recur_str})
|
|
}
|
|
|
|
foreach $v (@events) {
|
|
# for recurrent events, skip those that arnt the "head"
|
|
next if ($v->{is_recurrence} and (not $v->{recurlist}));
|
|
|
|
if (${$v->{sf}}[4] eq "*") { # no time was given
|
|
$v->{i_dtstart} = sprintf("DTSTART:%s", $v->{dts});
|
|
} else {
|
|
if (defined($ical_tzid)) {
|
|
if ($ical_tzid eq '') { # tz is defined but empty, so in GMT
|
|
$v->{i_dtstart} = sprintf("DTSTART:%sZ", $v->{dts});
|
|
} else { # tz is non-zero, so output the tz as well
|
|
$v->{i_dtstart} = sprintf("DTSTART;TZID=%s:%s",
|
|
$ical_tzid, $v->{dts});
|
|
}
|
|
} else { # undefined tz, just floating time
|
|
$v->{i_dtstart} = sprintf("DTSTART:%s", $v->{dts});
|
|
}
|
|
}
|
|
|
|
if (${$v->{sf}}[3] ne "*") { # a duration was given
|
|
# It's convenient that RFC2445 defines DURATION, thus we
|
|
# don't need to calculate DTEND, with awkward figuring out
|
|
# crossing hours, days, months, year, etc. Instead we
|
|
# will let the iCalendar consuming application worry about it.
|
|
$v->{i_duration} = sprintf("PT%dM", ${$v->{sf}}[3]);
|
|
}
|
|
}
|
|
|
|
# output header
|
|
print "BEGIN:VCALENDAR\015\012"
|
|
. "VERSION:2.0\015\012"
|
|
. "PRODID:http://mark.atwood.name/code/rem2ics"
|
|
. " $app_name $app_version\015\012";
|
|
|
|
# output each vevent
|
|
foreach $v (@events) {
|
|
# for recurrent events, only output the "head", skip the others
|
|
next if ($v->{is_recurrence} and (not $v->{recurlist}));
|
|
|
|
print "BEGIN:VEVENT\015\012";
|
|
my $tag = ${$v->{sf}}[2];
|
|
# if $tag is not set, fake up a UID from start time, process id & input line count
|
|
if ($tag eq "*" || !$options{usetag}) {
|
|
$tag = sprintf("%x.%x.%x", $^T, $$, $v->{cnt});
|
|
}
|
|
# add rem2ics and hostname to UID
|
|
print &lineify(sprintf("UID:rem2ics.%s@%s",
|
|
$tag, $ical_uid_hostname));
|
|
print &lineify("SUMMARY:" . "ify(${$v->{sf}}[5]));
|
|
print &lineify($v->{i_dtstart});
|
|
print &lineify("DURATION:" . $v->{i_duration})
|
|
if ($v->{i_duration});
|
|
print &lineify($v->{i_rdate})
|
|
if ($v->{i_rdate});
|
|
print &lineify("DTSTAMP:" . $ical_dtstamp);
|
|
print &lineify("COMMENT: generated by $app_name $app_version\\n"
|
|
. " http://mark.atwood.name/code/rem2ics\\n"
|
|
. " data[" . $v->{cnt} . "]=|" . "ify($v->{src}) . "|");
|
|
print "END:VEVENT\015\012";
|
|
}
|
|
|
|
# output trailer
|
|
print "END:VCALENDAR\015\012";
|
|
|
|
|
|
# integer division, return both quotient and remainder
|
|
sub idiv {
|
|
my $n = shift; my $d = shift;
|
|
my $r = $n; my $q = 0;
|
|
while ($r >= $d) {
|
|
$r = $r - $d;
|
|
$q = $q + 1;
|
|
}
|
|
return ($q, $r);
|
|
}
|
|
|
|
# todo, perl5 version that defines ()*, need to specify a requires up top
|
|
sub lineify {
|
|
return join("\015\012 ", unpack('(A72)*', shift)) . "\015\012";
|
|
}
|
|
|
|
sub quotify {
|
|
my $s = shift;
|
|
return $s if $s =~ m/^(\w| )*$/;
|
|
|
|
$s =~ s/\\/\\\\/gso;
|
|
$s =~ s/\n/\\n/gso;
|
|
$s =~ s/\s/ /gso;
|
|
$s =~ s/\"/\\"/gso;
|
|
$s =~ s/\,/\\,/gso;
|
|
$s =~ s/\:/\\:/gso;
|
|
$s =~ s/\;/\\;/gso;
|
|
|
|
return $s;
|
|
}
|
|
|
|
__END__
|
|
|
|
GNU GENERAL PUBLIC LICENSE
|
|
Version 2, June 1991
|
|
|
|
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
Everyone is permitted to copy and distribute verbatim copies
|
|
of this license document, but changing it is not allowed.
|
|
|
|
Preamble
|
|
|
|
The licenses for most software are designed to take away your
|
|
freedom to share and change it. By contrast, the GNU General Public
|
|
License is intended to guarantee your freedom to share and change free
|
|
software--to make sure the software is free for all its users. This
|
|
General Public License applies to most of the Free Software
|
|
Foundation's software and to any other program whose authors commit to
|
|
using it. (Some other Free Software Foundation software is covered by
|
|
the GNU Lesser General Public License instead.) You can apply it to
|
|
your programs, too.
|
|
|
|
When we speak of free software, we are referring to freedom, not
|
|
price. Our General Public Licenses are designed to make sure that you
|
|
have the freedom to distribute copies of free software (and charge for
|
|
this service if you wish), that you receive source code or can get it
|
|
if you want it, that you can change the software or use pieces of it
|
|
in new free programs; and that you know you can do these things.
|
|
|
|
To protect your rights, we need to make restrictions that forbid
|
|
anyone to deny you these rights or to ask you to surrender the rights.
|
|
These restrictions translate to certain responsibilities for you if you
|
|
distribute copies of the software, or if you modify it.
|
|
|
|
For example, if you distribute copies of such a program, whether
|
|
gratis or for a fee, you must give the recipients all the rights that
|
|
you have. You must make sure that they, too, receive or can get the
|
|
source code. And you must show them these terms so they know their
|
|
rights.
|
|
|
|
We protect your rights with two steps: (1) copyright the software, and
|
|
(2) offer you this license which gives you legal permission to copy,
|
|
distribute and/or modify the software.
|
|
|
|
Also, for each author's protection and ours, we want to make certain
|
|
that everyone understands that there is no warranty for this free
|
|
software. If the software is modified by someone else and passed on, we
|
|
want its recipients to know that what they have is not the original, so
|
|
that any problems introduced by others will not reflect on the original
|
|
authors' reputations.
|
|
|
|
Finally, any free program is threatened constantly by software
|
|
patents. We wish to avoid the danger that redistributors of a free
|
|
program will individually obtain patent licenses, in effect making the
|
|
program proprietary. To prevent this, we have made it clear that any
|
|
patent must be licensed for everyone's free use or not licensed at all.
|
|
|
|
The precise terms and conditions for copying, distribution and
|
|
modification follow.
|
|
|
|
GNU GENERAL PUBLIC LICENSE
|
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
|
|
0. This License applies to any program or other work which contains
|
|
a notice placed by the copyright holder saying it may be distributed
|
|
under the terms of this General Public License. The "Program", below,
|
|
refers to any such program or work, and a "work based on the Program"
|
|
means either the Program or any derivative work under copyright law:
|
|
that is to say, a work containing the Program or a portion of it,
|
|
either verbatim or with modifications and/or translated into another
|
|
language. (Hereinafter, translation is included without limitation in
|
|
the term "modification".) Each licensee is addressed as "you".
|
|
|
|
Activities other than copying, distribution and modification are not
|
|
covered by this License; they are outside its scope. The act of
|
|
running the Program is not restricted, and the output from the Program
|
|
is covered only if its contents constitute a work based on the
|
|
Program (independent of having been made by running the Program).
|
|
Whether that is true depends on what the Program does.
|
|
|
|
1. You may copy and distribute verbatim copies of the Program's
|
|
source code as you receive it, in any medium, provided that you
|
|
conspicuously and appropriately publish on each copy an appropriate
|
|
copyright notice and disclaimer of warranty; keep intact all the
|
|
notices that refer to this License and to the absence of any warranty;
|
|
and give any other recipients of the Program a copy of this License
|
|
along with the Program.
|
|
|
|
You may charge a fee for the physical act of transferring a copy, and
|
|
you may at your option offer warranty protection in exchange for a fee.
|
|
|
|
2. You may modify your copy or copies of the Program or any portion
|
|
of it, thus forming a work based on the Program, and copy and
|
|
distribute such modifications or work under the terms of Section 1
|
|
above, provided that you also meet all of these conditions:
|
|
|
|
a) You must cause the modified files to carry prominent notices
|
|
stating that you changed the files and the date of any change.
|
|
|
|
b) You must cause any work that you distribute or publish, that in
|
|
whole or in part contains or is derived from the Program or any
|
|
part thereof, to be licensed as a whole at no charge to all third
|
|
parties under the terms of this License.
|
|
|
|
c) If the modified program normally reads commands interactively
|
|
when run, you must cause it, when started running for such
|
|
interactive use in the most ordinary way, to print or display an
|
|
announcement including an appropriate copyright notice and a
|
|
notice that there is no warranty (or else, saying that you provide
|
|
a warranty) and that users may redistribute the program under
|
|
these conditions, and telling the user how to view a copy of this
|
|
License. (Exception: if the Program itself is interactive but
|
|
does not normally print such an announcement, your work based on
|
|
the Program is not required to print an announcement.)
|
|
|
|
These requirements apply to the modified work as a whole. If
|
|
identifiable sections of that work are not derived from the Program,
|
|
and can be reasonably considered independent and separate works in
|
|
themselves, then this License, and its terms, do not apply to those
|
|
sections when you distribute them as separate works. But when you
|
|
distribute the same sections as part of a whole which is a work based
|
|
on the Program, the distribution of the whole must be on the terms of
|
|
this License, whose permissions for other licensees extend to the
|
|
entire whole, and thus to each and every part regardless of who wrote it.
|
|
|
|
Thus, it is not the intent of this section to claim rights or contest
|
|
your rights to work written entirely by you; rather, the intent is to
|
|
exercise the right to control the distribution of derivative or
|
|
collective works based on the Program.
|
|
|
|
In addition, mere aggregation of another work not based on the Program
|
|
with the Program (or with a work based on the Program) on a volume of
|
|
a storage or distribution medium does not bring the other work under
|
|
the scope of this License.
|
|
|
|
3. You may copy and distribute the Program (or a work based on it,
|
|
under Section 2) in object code or executable form under the terms of
|
|
Sections 1 and 2 above provided that you also do one of the following:
|
|
|
|
a) Accompany it with the complete corresponding machine-readable
|
|
source code, which must be distributed under the terms of Sections
|
|
1 and 2 above on a medium customarily used for software interchange; or,
|
|
|
|
b) Accompany it with a written offer, valid for at least three
|
|
years, to give any third party, for a charge no more than your
|
|
cost of physically performing source distribution, a complete
|
|
machine-readable copy of the corresponding source code, to be
|
|
distributed under the terms of Sections 1 and 2 above on a medium
|
|
customarily used for software interchange; or,
|
|
|
|
c) Accompany it with the information you received as to the offer
|
|
to distribute corresponding source code. (This alternative is
|
|
allowed only for noncommercial distribution and only if you
|
|
received the program in object code or executable form with such
|
|
an offer, in accord with Subsection b above.)
|
|
|
|
The source code for a work means the preferred form of the work for
|
|
making modifications to it. For an executable work, complete source
|
|
code means all the source code for all modules it contains, plus any
|
|
associated interface definition files, plus the scripts used to
|
|
control compilation and installation of the executable. However, as a
|
|
special exception, the source code distributed need not include
|
|
anything that is normally distributed (in either source or binary
|
|
form) with the major components (compiler, kernel, and so on) of the
|
|
operating system on which the executable runs, unless that component
|
|
itself accompanies the executable.
|
|
|
|
If distribution of executable or object code is made by offering
|
|
access to copy from a designated place, then offering equivalent
|
|
access to copy the source code from the same place counts as
|
|
distribution of the source code, even though third parties are not
|
|
compelled to copy the source along with the object code.
|
|
|
|
4. You may not copy, modify, sublicense, or distribute the Program
|
|
except as expressly provided under this License. Any attempt
|
|
otherwise to copy, modify, sublicense or distribute the Program is
|
|
void, and will automatically terminate your rights under this License.
|
|
However, parties who have received copies, or rights, from you under
|
|
this License will not have their licenses terminated so long as such
|
|
parties remain in full compliance.
|
|
|
|
5. You are not required to accept this License, since you have not
|
|
signed it. However, nothing else grants you permission to modify or
|
|
distribute the Program or its derivative works. These actions are
|
|
prohibited by law if you do not accept this License. Therefore, by
|
|
modifying or distributing the Program (or any work based on the
|
|
Program), you indicate your acceptance of this License to do so, and
|
|
all its terms and conditions for copying, distributing or modifying
|
|
the Program or works based on it.
|
|
|
|
6. Each time you redistribute the Program (or any work based on the
|
|
Program), the recipient automatically receives a license from the
|
|
original licensor to copy, distribute or modify the Program subject to
|
|
these terms and conditions. You may not impose any further
|
|
restrictions on the recipients' exercise of the rights granted herein.
|
|
You are not responsible for enforcing compliance by third parties to
|
|
this License.
|
|
|
|
7. If, as a consequence of a court judgment or allegation of patent
|
|
infringement or for any other reason (not limited to patent issues),
|
|
conditions are imposed on you (whether by court order, agreement or
|
|
otherwise) that contradict the conditions of this License, they do not
|
|
excuse you from the conditions of this License. If you cannot
|
|
distribute so as to satisfy simultaneously your obligations under this
|
|
License and any other pertinent obligations, then as a consequence you
|
|
may not distribute the Program at all. For example, if a patent
|
|
license would not permit royalty-free redistribution of the Program by
|
|
all those who receive copies directly or indirectly through you, then
|
|
the only way you could satisfy both it and this License would be to
|
|
refrain entirely from distribution of the Program.
|
|
|
|
If any portion of this section is held invalid or unenforceable under
|
|
any particular circumstance, the balance of the section is intended to
|
|
apply and the section as a whole is intended to apply in other
|
|
circumstances.
|
|
|
|
It is not the purpose of this section to induce you to infringe any
|
|
patents or other property right claims or to contest validity of any
|
|
such claims; this section has the sole purpose of protecting the
|
|
integrity of the free software distribution system, which is
|
|
implemented by public license practices. Many people have made
|
|
generous contributions to the wide range of software distributed
|
|
through that system in reliance on consistent application of that
|
|
system; it is up to the author/donor to decide if he or she is willing
|
|
to distribute software through any other system and a licensee cannot
|
|
impose that choice.
|
|
|
|
This section is intended to make thoroughly clear what is believed to
|
|
be a consequence of the rest of this License.
|
|
|
|
8. If the distribution and/or use of the Program is restricted in
|
|
certain countries either by patents or by copyrighted interfaces, the
|
|
original copyright holder who places the Program under this License
|
|
may add an explicit geographical distribution limitation excluding
|
|
those countries, so that distribution is permitted only in or among
|
|
countries not thus excluded. In such case, this License incorporates
|
|
the limitation as if written in the body of this License.
|
|
|
|
9. The Free Software Foundation may publish revised and/or new versions
|
|
of the General Public License from time to time. Such new versions will
|
|
be similar in spirit to the present version, but may differ in detail to
|
|
address new problems or concerns.
|
|
|
|
Each version is given a distinguishing version number. If the Program
|
|
specifies a version number of this License which applies to it and "any
|
|
later version", you have the option of following the terms and conditions
|
|
either of that version or of any later version published by the Free
|
|
Software Foundation. If the Program does not specify a version number of
|
|
this License, you may choose any version ever published by the Free Software
|
|
Foundation.
|
|
|
|
10. If you wish to incorporate parts of the Program into other free
|
|
programs whose distribution conditions are different, write to the author
|
|
to ask for permission. For software which is copyrighted by the Free
|
|
Software Foundation, write to the Free Software Foundation; we sometimes
|
|
make exceptions for this. Our decision will be guided by the two goals
|
|
of preserving the free status of all derivatives of our free software and
|
|
of promoting the sharing and reuse of software generally.
|
|
|
|
NO WARRANTY
|
|
|
|
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
|
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
|
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
|
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
|
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
|
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
|
REPAIR OR CORRECTION.
|
|
|
|
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
|
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
|
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
|
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGES.
|
|
|
|
END OF TERMS AND CONDITIONS
|
|
|
|
EOF
|