package C4::NewsChannels;
-# Copyright 2000-2002 Katipo Communications
-#
# 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 2 of the License, or (at your option) any later
-# version.
+# Copyright (C) 2000-2002 Katipo Communications
+# Copyright (C) 2013 Mark Tompsett
#
-# 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.
+# 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.
#
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
-
-use strict;
+# 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>.
+use Modern::Perl;
use C4::Context;
-use C4::Dates qw(format_date);
+use Koha::DateUtils;
-use vars qw($VERSION @ISA @EXPORT);
+use vars qw(@ISA @EXPORT);
BEGIN {
- $VERSION = 3.01; # set the version for version checking
- @ISA = qw(Exporter);
- @EXPORT = qw(
- &GetNewsToDisplay
- &news_channels &get_new_channel &del_channels &add_channel &update_channel
- &news_channels_categories &get_new_channel_category &del_channels_categories
- &add_channel_category &update_channel_category &news_channels_by_category
- &add_opac_new &upd_opac_new &del_opac_new &get_opac_new &get_opac_news
- &add_opac_electronic &upd_opac_electronic &del_opac_electronic &get_opac_electronic &get_opac_electronics
- );
+ @ISA = qw(Exporter);
+ @EXPORT = qw(
+ &GetNewsToDisplay
+ &add_opac_new &upd_opac_new &del_opac_new &get_opac_new &get_opac_news
+ );
}
=head1 NAME
-C4::NewsChannels - Functions to manage the news channels and its categories
+C4::NewsChannels - Functions to manage OPAC and intranet news
=head1 DESCRIPTION
-This module provides the functions needed to admin the news channels and its categories
+This module provides the functions needed to mange OPAC and intranet news.
=head1 FUNCTIONS
-=head2 news_channels
-
- ($count, @channels) = &news_channels($channel_name, $id_category, $unclassified);
-
-Looks up news channels by name or category.
-
-C<$channel_name> is the channel name to search.
-
-C<$id_category> is the channel category code to search.
-
-C<$$unclassified> if it is set and $channel_name and $id_category search for the news channels without a category
-
-if none of the params are set C<&news_channels> returns all the news channels.
-
-C<&news_channels> returns two values: an integer giving the number of
-news channels found and a reference to an array
-of references to hash, which has the news_channels and news_channels_categories fields.
-
=cut
-sub news_channels {
- my ($channel_name, $id_category, $unclassified) = @_;
- my $dbh = C4::Context->dbh;
- my @channels;
- my $query = "SELECT * FROM news_channels LEFT JOIN news_channels_categories ON news_channels.id_category = news_channels_categories.id_category";
- if ( ($channel_name ne '') && ($id_category ne '') ) {
- $query.= " WHERE channel_name like '" . $channel_name . "%' AND news_channels.id_category = " . $id_category;
- } elsif ($channel_name ne '') {
- $query.= " WHERE channel_name like '" . $channel_name . "%'";
- } elsif ($id_category ne '') {
- $query.= " WHERE news_channels.id_category = " . $id_category;
- } elsif ($unclassified) {
- $query.= " WHERE news_channels.id_category IS NULL ";
- }
- my $sth = $dbh->prepare($query);
- $sth->execute();
- while (my $row = $sth->fetchrow_hashref) {
- push @channels, $row;
- }
- $sth->finish;
- return (scalar(@channels), @channels);
-}
-
-=head2 news_channels_by_category
-
- ($count, @results) = &news_channels_by_category();
-
-Looks up news channels grouped by category.
-
-C<&news_channels_by_category> returns two values: an integer giving the number of
-categories found and a reference to an array
-of references to hash, which the following keys:
+=head2 add_opac_new
-=over 4
+ $retval = add_opac_new($hashref);
-=item C<channels_count>
-
-The number of news channels in that category
-
-=item C<channels>
-
-A reference to an array of references to hash which keys are the new_channels fields.
-
-Additionally the last index of results has a reference to all the news channels which don't have a category
-
-=back
+ $hashref should contains all the fields found in opac_news,
+ except idnew. The idnew field is auto-generated.
=cut
-sub news_channels_by_category {
-
- my ($categories_count, @results) = &news_channels_categories();
- foreach my $row (@results) {
-
- my ($channels_count, @channels) = &news_channels('', $row->{'id_category'});
- $row->{'channels_count'} = $channels_count;
- $row->{'channels'} = \@channels;
- }
-
- my ($channels_count, @channels) = &news_channels('', '', 1);
- my %row;
- $row{'id_category'} = -1;
- $row{'unclassified'} = 1;
- $row{'channels_count'} = $channels_count;
- $row{'channels'} = \@channels;
- push @results, \%row;
-
- return (scalar(@results), @results);
-}
-
-sub get_new_channel {
- my ($id) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("SELECT * FROM news_channels WHERE id = ?");
- $sth->execute($id);
- my $channel = $sth->fetchrow_hashref;
- $sth->finish;
- return $channel;
-}
-
-sub del_channels {
- my ($ids) = @_;
- if ($ids ne '') {
+sub add_opac_new {
+ my ($href_entry) = @_;
+ my $retval = 0;
+
+ if ($href_entry) {
+ my @fields = keys %{$href_entry};
+ my @values = values %{$href_entry};
+ my $field_string = join ',', @fields;
+ $field_string = $field_string // q{};
+ my $values_string = join(',', map { '?' } @fields);
my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("DELETE FROM news_channels WHERE id IN ($ids) ");
- $sth->execute();
- $sth->finish;
- return $ids;
+ my $sth = $dbh->prepare("INSERT INTO opac_news ( $field_string ) VALUES ( $values_string )");
+ $sth->execute(@values);
+ $retval = 1;
}
- return 0;
+ return $retval;
}
-sub add_channel {
- my ($name, $url, $id_category, $notes) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("INSERT INTO news_channels (channel_name, url, id_category, notes) VALUES (?,?,?,?)");
- $sth->execute($name, $url, $id_category, $notes);
- $sth->finish;
- return 1;
-}
+=head2 upd_opac_new
-sub update_channel {
- my ($id, $name, $url, $id_category, $notes) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("UPDATE news_channels SET channel_name = ?, url = ?, id_category = ?, notes = ? WHERE id = ?");
- $sth->execute($name, $url, $id_category, $notes, $id);
- $sth->finish;
- return 1;
-}
+ $retval = upd_opac_new($hashref);
-sub news_channels_categories {
- my $dbh = C4::Context->dbh;
- my @categories;
- my $query = "SELECT * FROM news_channels_categories";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- while (my $row = $sth->fetchrow_hashref) {
- push @categories, $row;
- }
- $sth->finish;
- return (scalar(@categories), @categories);
+ $hashref should contains all the fields found in opac_news,
+ including idnew, since it is the key for the SQL UPDATE.
-}
+=cut
-sub get_new_channel_category {
- my ($id) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("SELECT * FROM news_channels_categories WHERE id_category = ?");
- $sth->execute($id);
- my $category = $sth->fetchrow_hashref;
- $sth->finish;
- return $category;
-}
+sub upd_opac_new {
+ my ($href_entry) = @_;
+ my $retval = 0;
+
+ if ($href_entry) {
+ # take the keys of hash entry and make a list, but...
+ my @fields = keys %{$href_entry};
+ my @values;
+ $#values = -1;
+ my $field_string = q{};
+ foreach my $field_name (@fields) {
+ # exclude idnew
+ if ( $field_name ne 'idnew' ) {
+ $field_string = $field_string . "$field_name = ?,";
+ push @values,$href_entry->{$field_name};
+ }
+ }
+ # put idnew at the end, so we know which record to update
+ push @values,$href_entry->{'idnew'};
+ chop $field_string; # remove that excess ,
-sub del_channels_categories {
- my ($ids) = @_;
- if ($ids ne '') {
my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("UPDATE news_channels SET id_category = NULL WHERE id_category IN ($ids) ");
- $sth->execute();
- $sth = $dbh->prepare("DELETE FROM news_channels_categories WHERE id_category IN ($ids) ");
- $sth->execute();
- $sth->finish;
- return $ids;
+ my $sth = $dbh->prepare("UPDATE opac_news SET $field_string WHERE idnew = ?;");
+ $sth->execute(@values);
+ $retval = 1;
}
- return 0;
-}
-
-sub add_channel_category {
- my ($name) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("INSERT INTO news_channels_categories (category_name) VALUES (?)");
- $sth->execute($name);
- $sth->finish;
- return 1;
-}
-
-sub update_channel_category {
- my ($id, $name) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("UPDATE news_channels_categories SET category_name = ? WHERE id_category = ?");
- $sth->execute($name, $id);
- $sth->finish;
- return 1;
-}
-
-sub add_opac_new {
- my ($title, $new, $lang, $expirationdate, $number) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("INSERT INTO opac_news (title, new, lang, expirationdate, number) VALUES (?,?,?,?,?)");
- $sth->execute($title, $new, $lang, $expirationdate, $number);
- $sth->finish;
- return 1;
-}
-
-sub upd_opac_new {
- my ($idnew, $title, $new, $lang, $expirationdate, $number) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("
- UPDATE opac_news SET
- title = ?,
- new = ?,
- lang = ?,
- expirationdate = ?,
- number = ?
- WHERE idnew = ?
- ");
- $sth->execute($title, $new, $lang, $expirationdate,$number,$idnew);
- $sth->finish;
- return 1;
+ return $retval;
}
sub del_opac_new {
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("DELETE FROM opac_news WHERE idnew IN ($ids)");
$sth->execute();
- $sth->finish;
return 1;
} else {
return 0;
sub get_opac_new {
my ($idnew) = @_;
my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("SELECT * FROM opac_news WHERE idnew = ?");
+ my $query = q{
+ SELECT opac_news.*,branches.branchname
+ FROM opac_news LEFT JOIN branches
+ ON opac_news.branchcode=branches.branchcode
+ WHERE opac_news.idnew = ?;
+ };
+ my $sth = $dbh->prepare($query);
$sth->execute($idnew);
my $data = $sth->fetchrow_hashref;
- $data->{$data->{'lang'}} = 1;
- $data->{expirationdate} = format_date($data->{expirationdate});
- $sth->finish;
+ $data->{$data->{'lang'}} = 1 if defined $data->{lang};
+ $data->{expirationdate} = output_pref({ dt => dt_from_string( $data->{expirationdate} ), dateonly => 1 }) if ( $data->{expirationdate} );
+ $data->{timestamp} = output_pref({ dt => dt_from_string( $data->{timestamp} ), dateonly => 1 }) ;
return $data;
}
sub get_opac_news {
- my ($limit, $lang) = @_;
- my $dbh = C4::Context->dbh;
- my $query = "SELECT *, timestamp AS newdate FROM opac_news";
+ my ($limit, $lang, $branchcode) = @_;
+ my @values;
+ my $dbh = C4::Context->dbh;
+ my $query = q{
+ SELECT opac_news.*, branches.branchname,
+ timestamp AS newdate,
+ borrowers.title AS author_title,
+ borrowers.firstname AS author_firstname,
+ borrowers.surname AS author_surname
+ FROM opac_news LEFT JOIN branches
+ ON opac_news.branchcode=branches.branchcode
+ LEFT JOIN borrowers on borrowers.borrowernumber = opac_news.borrowernumber
+ };
+ $query .= ' WHERE 1';
if ($lang) {
- $query.= " WHERE lang = '" .$lang ."' ";
+ $query .= " AND (opac_news.lang='' OR opac_news.lang=?)";
+ push @values,$lang;
}
- $query.= " ORDER BY timestamp DESC ";
+ if ($branchcode) {
+ $query .= ' AND (opac_news.branchcode IS NULL OR opac_news.branchcode=?)';
+ push @values,$branchcode;
+ }
+ $query.= ' ORDER BY timestamp DESC ';
#if ($limit) {
- # $query.= "LIMIT 0, " . $limit;
+ # $query.= 'LIMIT 0, ' . $limit;
#}
my $sth = $dbh->prepare($query);
- $sth->execute();
+ $sth->execute(@values);
my @opac_news;
my $count = 0;
while (my $row = $sth->fetchrow_hashref) {
if ((($limit) && ($count < $limit)) || (!$limit)) {
- $row->{'newdate'} = format_date($row->{'newdate'});
- $row->{'expirationdate'} = format_date($row->{'expirationdate'});
push @opac_news, $row;
}
$count++;
=head2 GetNewsToDisplay
- $news = &GetNewsToDisplay($lang);
- C<$news> is a ref to an array which containts
- all news with expirationdate > today or expirationdate is null.
+ $news = &GetNewsToDisplay($lang,$branch);
+ C<$news> is a ref to an array which contains
+ all news with expirationdate > today or expirationdate is null
+ that is applicable for a given branch.
=cut
sub GetNewsToDisplay {
- my $lang = shift;
+ my ($lang,$branch) = @_;
my $dbh = C4::Context->dbh;
# SELECT *,DATE_FORMAT(timestamp, '%d/%m/%Y') AS newdate
- my $query = "
- SELECT *,timestamp AS newdate
+ my $query = q{
+ SELECT opac_news.*,timestamp AS newdate,
+ borrowers.title AS author_title,
+ borrowers.firstname AS author_firstname,
+ borrowers.surname AS author_surname
FROM opac_news
+ LEFT JOIN borrowers on borrowers.borrowernumber = opac_news.borrowernumber
WHERE (
- expirationdate > CURRENT_DATE()
+ expirationdate >= CURRENT_DATE()
OR expirationdate IS NULL
OR expirationdate = '00-00-0000'
- )
- AND lang = ?
- ORDER BY number
- "; # expirationdate field is NOT in ISO format?
+ )
+ AND DATE(timestamp) < DATE_ADD(CURDATE(), INTERVAL 1 DAY)
+ AND (opac_news.lang = '' OR opac_news.lang = ?)
+ AND (opac_news.branchcode IS NULL OR opac_news.branchcode = ?)
+ ORDER BY number
+ }; # expirationdate field is NOT in ISO format?
+ # timestamp has HH:mm:ss, CURRENT_DATE generates 00:00:00
+ # by adding 1, that captures today correctly.
my $sth = $dbh->prepare($query);
- $sth->execute($lang);
+ $lang = $lang // q{};
+ $sth->execute($lang,$branch);
my @results;
while ( my $row = $sth->fetchrow_hashref ){
- $row->{newdate} = format_date($row->{newdate});
+ $row->{newdate} = output_pref({ dt => dt_from_string( $row->{newdate} ), dateonly => 1 });
push @results, $row;
}
return \@results;
}
-### get electronic databases
-
-sub add_opac_electronic {
- my ($title, $edata, $lang,$image,$href,$section) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("INSERT INTO opac_electronic (title, edata, lang,image,href,section) VALUES (?,?,?,?,?,?)");
- $sth->execute($title, $edata, $lang,$image,$href,$section);
- $sth->finish;
- return 1;
-}
-
-sub upd_opac_electronic {
- my ($idelectronic, $title, $edata, $lang, $image, $href,$section) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("UPDATE opac_electronic SET title = ?, edata = ?, lang = ? , image=?, href=? ,section=? WHERE idelectronic = ?");
- $sth->execute($title, $edata, $lang, $image,$href ,$section, $idelectronic);
- $sth->finish;
- return 1;
-}
-
-sub del_opac_electronic {
- my ($ids) = @_;
- if ($ids) {
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("DELETE FROM opac_electronic WHERE idelectronic IN ($ids)");
- $sth->execute();
- $sth->finish;
- return 1;
- } else {
- return 0;
- }
-}
-
-sub get_opac_electronic {
- my ($idelectronic) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("SELECT * FROM opac_electronic WHERE idelectronic = ?");
- $sth->execute($idelectronic);
- my $data = $sth->fetchrow_hashref;
- $data->{$data->{'lang'}} = 1;
- $data->{$data->{'section'}} = 1;
- $sth->finish;
- return $data;
-}
-
-sub get_opac_electronics {
- my ($section, $lang) = @_;
- my $dbh = C4::Context->dbh;
- my $query = "SELECT *, DATE_FORMAT(timestamp, '%d/%m/%Y') AS newdate FROM opac_electronic";
- if ($lang) {
- $query.= " WHERE lang = '" .$lang ."' ";
- }
- if ($section) {
- $query.= " and section= '" . $section."' ";
- }
- $query.= " ORDER BY title ";
-
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my @opac_electronic;
- my $count = 0;
- while (my $row = $sth->fetchrow_hashref) {
- push @opac_electronic, $row;
- $count++;
- }
-
- return ($count,\@opac_electronic);
-}
-
1;
__END__
projects / koha.git / blobdiff