11315ef090
opac-ics.pl was added to Koha back in 2007, but there has not been a link to it from anywhere. This patch adds the link from the main view on /cgi-bin/koha/opac-user.pl, and makes some changes to opac-ics.pl itself. Changes to opac-ics.pl: - Update the code to use date and time for when a loan is due - Use dt_from_string to turn a MySQL time and date into a DateTime - Add a timestamp and a UID (these were reported as necessary by a couple of iCal validators) - Remove DTEND from events, since we now have time as well as date for when a loan is due - For loans that are overdue, set the DTSTART to now(), to avoid creating calendar events in the past - Use a template to generate text strings, to make them translatable To test: - Apply the patch - Make sure you have at least a couple of loans, including one overdue - Go to /cgi-bin/koha/opac-user.pl and click on the link labeled "Download as iCal/.ics file" - Inspect the file in a text editor and/or view the result in a calendar appplication. Make sure the data makes sense. - Sign off and go thee merrily on thine way. Update 2016-07-25 - Force date_due to UTC to avoid problematic timezone info like this: DTSTART:TZID=Europe/Zurich:20160724T235900 - Remove quotes from summary and description Followed test plan, koha.ics file successfully imported to Thunderbird calendar Signed-off-by: Marc <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
103 lines
3.1 KiB
Perl
Executable file
103 lines
3.1 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
# Copyright 2007 Liblime Ltd
|
|
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha 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 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Koha 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 Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
# This script builds an ICalendar file (rfc 2445) for use in programs such as Ical
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use CGI qw ( -utf8 );
|
|
use Data::ICal;
|
|
use Data::ICal::Entry::Event;
|
|
use DateTime;
|
|
use DateTime::Format::ICal;
|
|
use DateTime::Event::ICal;
|
|
use URI;
|
|
|
|
use C4::Auth;
|
|
use C4::Koha;
|
|
use C4::Circulation;
|
|
use C4::Members;
|
|
use Koha::DateUtils;
|
|
|
|
my $query = new CGI;
|
|
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
|
|
{
|
|
template_name => "opac-ics.tt",
|
|
query => $query,
|
|
type => "opac",
|
|
authnotrequired => 0,
|
|
debug => 1,
|
|
}
|
|
);
|
|
|
|
# Create Calendar
|
|
my $calendar = Data::ICal->new();
|
|
|
|
# get issued items ....
|
|
my $issues = GetPendingIssues($borrowernumber);
|
|
|
|
foreach my $issue ( @$issues ) {
|
|
my $vevent = Data::ICal::Entry::Event->new();
|
|
my $timestamp = DateTime->now(); # Defaults to UTC
|
|
# Send some values to the template to generate summary and description
|
|
$template->param(
|
|
overdue => $issue->{'overdue'},
|
|
title => $issue->{'title'},
|
|
barcode => $issue->{'barcode'},
|
|
);
|
|
# Catch the result of the template and split on newline
|
|
my ($summary,$description) = split /\n/, $template->output;
|
|
my $datestart;
|
|
if ($issue->{'overdue'} && $issue->{'overdue'} == 1) {
|
|
# Not much use adding an event in the past for a book that is overdue
|
|
# so we set datestart = now
|
|
$datestart = $timestamp;
|
|
} else {
|
|
$datestart = dt_from_string($issue->{'date_due'});
|
|
$datestart->set_time_zone('UTC');
|
|
}
|
|
# Create a UID that includes the issue number and the domain
|
|
my $domain = '';
|
|
my $baseurl = C4::Context->preference('OPACBaseURL');
|
|
if ( $baseurl ne '' ) {
|
|
my $url = URI->new($baseurl);
|
|
$domain = $url->host;
|
|
} else {
|
|
warn "Make sure the systempreference OPACBaseURL is set!";
|
|
}
|
|
my $uid = 'issue-' . $issue->{'issue_id'} . '@' . $domain;
|
|
# Create the event
|
|
$vevent->add_properties(
|
|
summary => $summary,
|
|
description => $description,
|
|
dtstamp => DateTime::Format::ICal->format_datetime($timestamp),
|
|
dtstart => DateTime::Format::ICal->format_datetime($datestart),
|
|
uid => $uid,
|
|
);
|
|
# Add it to the calendar
|
|
$calendar->add_entry($vevent);
|
|
}
|
|
|
|
print $query->header(
|
|
-type => 'application/octet-stream',
|
|
-attachment => 'koha.ics'
|
|
);
|
|
|
|
print $calendar->as_string;
|