Bug 15774: Add additional fields to order baskets
[koha.git] / C4 / NewsChannels.pm
index 0d9bf61..a01d279 100644 (file)
-package C4::NewsChannels;\r
-\r
-# Copyright 2000-2002 Katipo Communications\r
-#\r
-# This file is part of Koha.\r
-#\r
-# Koha is free software; you can redistribute it and/or modify it under the\r
-# terms of the GNU General Public License as published by the Free Software\r
-# Foundation; either version 2 of the License, or (at your option) any later\r
-# version.\r
-#\r
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY\r
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR\r
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.\r
-#\r
-# You should have received a copy of the GNU General Public License along with\r
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,\r
-# Suite 330, Boston, MA  02111-1307 USA\r
-\r
-use strict;\r
-\r
-use C4::Context;\r
-use C4::Date;\r
-\r
-use vars qw($VERSION @ISA @EXPORT);\r
-\r
-# set the version for version checking\r
-$VERSION = do { my @v = '$Revision$' =~ /\d+/g;\r
-    shift(@v) . "." . join( "_", map { sprintf "%03d", $_ } @v );\r
-};\r
-\r
-=head1 NAME\r
-\r
-C4::NewsChannels - Functions to manage the news channels and its categories\r
-\r
-=head1 DESCRIPTION\r
-\r
-This module provides the functions needed to admin the news channels and its categories\r
-\r
-=head1 FUNCTIONS\r
-\r
-=over 2\r
-\r
-=cut\r
-\r
-\r
-@ISA = qw(Exporter);\r
-@EXPORT = qw(\r
-  &GetNewsToDisplay\r
-  &news_channels &get_new_channel &del_channels &add_channel &update_channel\r
-  &news_channels_categories &get_new_channel_category &del_channels_categories\r
-  &add_channel_category &update_channel_category &news_channels_by_category\r
-&add_opac_new &upd_opac_new &del_opac_new &get_opac_new &get_opac_news\r
-  &add_opac_electronic &upd_opac_electronic &del_opac_electronic &get_opac_electronic &get_opac_electronics\r
-);\r
-\r
-\r
-=item news_channels\r
-\r
-  ($count, @channels) = &news_channels($channel_name, $id_category, $unclassified);\r
-\r
-Looks up news channels by name or category.\r
-\r
-C<$channel_name> is the channel name to search.\r
-\r
-C<$id_category> is the channel category code to search.\r
-\r
-C<$$unclassified> if it is set and $channel_name and $id_category search for the news channels without a category\r
-\r
-if none of the params are set C<&news_channels> returns all the news channels.\r
-\r
-C<&news_channels> returns two values: an integer giving the number of\r
-news channels found and a reference to an array\r
-of references to hash, which has the news_channels and news_channels_categories fields.\r
-\r
-=cut\r
-\r
-sub news_channels {\r
-    my ($channel_name, $id_category, $unclassified) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my @channels;\r
-    my $query = "SELECT * FROM news_channels LEFT JOIN news_channels_categories ON news_channels.id_category = news_channels_categories.id_category";\r
-    if ( ($channel_name ne '') && ($id_category ne '') ) {\r
-        $query.= " WHERE channel_name like '" . $channel_name . "%' AND news_channels.id_category = " . $id_category;\r
-    } elsif ($channel_name ne '')  {\r
-        $query.= " WHERE channel_name like '" . $channel_name . "%'";\r
-    } elsif ($id_category ne '') {\r
-        $query.= " WHERE news_channels.id_category = " . $id_category;\r
-    } elsif ($unclassified) {\r
-        $query.= " WHERE news_channels.id_category IS NULL ";\r
-    }\r
-    my $sth = $dbh->prepare($query);\r
-    $sth->execute();\r
-    while (my $row = $sth->fetchrow_hashref) {\r
-        push @channels, $row;\r
-    }\r
-    $sth->finish;\r
-    return (scalar(@channels), @channels);\r
-}\r
-\r
-=item news_channels_by_category\r
-\r
-  ($count, @results) = &news_channels_by_category();\r
-\r
-Looks up news channels grouped by category.\r
-\r
-C<&news_channels_by_category> returns two values: an integer giving the number of\r
-categories found and a reference to an array\r
-of references to hash, which the following keys: \r
-\r
-=over 4\r
-\r
-=item C<channels_count>\r
-\r
-The number of news channels in that category\r
-\r
-=item C<channels>\r
-\r
-A reference to an array of references to hash which keys are the new_channels fields. \r
-\r
-Additionally the last index of results has a reference to all the news channels which don't have a category \r
-\r
-=cut\r
-\r
-sub news_channels_by_category {\r
-    \r
-    my ($categories_count, @results) = &news_channels_categories();\r
-    foreach my $row (@results) {\r
-\r
-        my ($channels_count, @channels) = &news_channels('', $row->{'id_category'});\r
-        $row->{'channels_count'} = $channels_count;\r
-        $row->{'channels'} = \@channels;\r
-    }\r
-\r
-    my ($channels_count, @channels) = &news_channels('', '', 1);\r
-    my %row;\r
-    $row{'id_category'} = -1;\r
-    $row{'unclassified'} = 1;\r
-    $row{'channels_count'} = $channels_count;\r
-    $row{'channels'} = \@channels;\r
-    push @results, \%row;\r
-\r
-    return (scalar(@results), @results);\r
-}\r
-\r
-sub get_new_channel {\r
-    my ($id) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("SELECT * FROM news_channels WHERE id = ?");\r
-    $sth->execute($id);\r
-    my $channel = $sth->fetchrow_hashref;\r
-    $sth->finish;\r
-    return $channel;\r
-}\r
-\r
-sub del_channels {\r
-    my ($ids) = @_;\r
-    if ($ids ne '') {\r
-        my $dbh = C4::Context->dbh;\r
-        my $sth = $dbh->prepare("DELETE FROM news_channels WHERE id IN ($ids) ");\r
-        $sth->execute();\r
-        $sth->finish;\r
-        return $ids;\r
-    }\r
-    return 0;\r
-}\r
-\r
-sub add_channel {\r
-    my ($name, $url, $id_category, $notes) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("INSERT INTO news_channels (channel_name, url, id_category, notes) VALUES (?,?,?,?)");\r
-    $sth->execute($name, $url, $id_category, $notes);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub update_channel {\r
-    my ($id, $name, $url, $id_category, $notes) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("UPDATE news_channels SET channel_name = ?,  url = ?, id_category = ?, notes = ? WHERE id = ?");\r
-    $sth->execute($name, $url, $id_category, $notes, $id);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub news_channels_categories {\r
-    my $dbh = C4::Context->dbh;\r
-    my @categories;\r
-    my $query = "SELECT * FROM news_channels_categories";\r
-    my $sth = $dbh->prepare($query);\r
-    $sth->execute();\r
-    while (my $row = $sth->fetchrow_hashref) {\r
-        push @categories, $row;\r
-    }\r
-    $sth->finish;\r
-    return (scalar(@categories), @categories);\r
-\r
-}\r
-\r
-sub get_new_channel_category {\r
-    my ($id) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("SELECT * FROM news_channels_categories WHERE id_category = ?");\r
-    $sth->execute($id);\r
-    my $category = $sth->fetchrow_hashref;\r
-    $sth->finish;\r
-    return $category;\r
-}\r
-\r
-sub del_channels_categories {\r
-    my ($ids) = @_;\r
-    if ($ids ne '') {\r
-        my $dbh = C4::Context->dbh;\r
-        my $sth = $dbh->prepare("UPDATE news_channels SET id_category = NULL WHERE id_category IN ($ids) ");\r
-        $sth->execute();\r
-        $sth = $dbh->prepare("DELETE FROM news_channels_categories WHERE id_category IN ($ids) ");\r
-        $sth->execute();\r
-        $sth->finish;\r
-        return $ids;\r
-    }\r
-    return 0;\r
-}\r
-\r
-sub add_channel_category {\r
-    my ($name) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("INSERT INTO news_channels_categories (category_name) VALUES (?)");\r
-    $sth->execute($name);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub update_channel_category {\r
-    my ($id, $name) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("UPDATE news_channels_categories SET category_name = ? WHERE id_category = ?");\r
-    $sth->execute($name, $id);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub add_opac_new {\r
-    my ($title, $new, $lang, $expirationdate, $number) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("INSERT INTO opac_news (title, new, lang, expirationdate, number) VALUES (?,?,?,?,?)");\r
-    $sth->execute($title, $new, $lang, $expirationdate, $number);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub upd_opac_new {\r
-    my ($idnew, $title, $new, $lang, $expirationdate, $number) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("\r
-        UPDATE opac_news SET \r
-            title = ?,\r
-            new = ?,\r
-            lang = ?,\r
-            expirationdate = ?,\r
-            number = ?\r
-        WHERE idnew = ?\r
-    ");\r
-    $sth->execute($title, $new, $lang, $expirationdate,$number,$idnew);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub del_opac_new {\r
-    my ($ids) = @_;\r
-    if ($ids) {\r
-        my $dbh = C4::Context->dbh;\r
-        my $sth = $dbh->prepare("DELETE FROM opac_news WHERE idnew IN ($ids)");\r
-        $sth->execute();\r
-        $sth->finish;\r
-        return 1;\r
-    } else {\r
-        return 0;\r
-    }\r
-}\r
-\r
-sub get_opac_new {\r
-    my ($idnew) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("SELECT * FROM opac_news WHERE idnew = ?");\r
-    $sth->execute($idnew);\r
-    my $data = $sth->fetchrow_hashref;\r
-    $data->{$data->{'lang'}} = 1;\r
-    $data->{expirationdate} = format_date($data->{expirationdate});\r
-    $sth->finish;\r
-    return $data;\r
-}\r
-\r
-sub get_opac_news {\r
-    my ($limit, $lang) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $query = "SELECT *, timestamp AS newdate FROM opac_news";\r
-    if ($lang) {\r
-        $query.= " WHERE lang = '" .$lang ."' ";\r
-    }\r
-    $query.= " ORDER BY timestamp DESC ";\r
-    #if ($limit) {\r
-    #    $query.= "LIMIT 0, " . $limit;\r
-    #}\r
-    my $sth = $dbh->prepare($query);\r
-    $sth->execute();\r
-    my @opac_news;\r
-    my $count = 0;\r
-    while (my $row = $sth->fetchrow_hashref) {\r
-        if ((($limit) && ($count < $limit)) || (!$limit)) {\r
-            $row->{'newdate'} = format_date($row->{'newdate'});\r
-            $row->{'expirationdate'} = format_date($row->{'expirationdate'});\r
-            push @opac_news, $row;\r
-        }\r
-        $count++;\r
-    }\r
-    return ($count, \@opac_news);\r
-}\r
-\r
-=head2 GetNewsToDisplay\r
-    \r
-    $news = &GetNewsToDisplay($lang);\r
-    C<$news> is a ref to an array which containts\r
-    all news with expirationdate > today or expirationdate is null.\r
-    \r
-=cut\r
-\r
-sub GetNewsToDisplay {\r
-    my $lang = shift;\r
-    my $dbh = C4::Context->dbh;\r
-    my $query = "\r
-     SELECT *,DATE_FORMAT(timestamp, '%d/%m/%Y') AS newdate\r
-     FROM   opac_news\r
-     WHERE   (\r
-        expirationdate > CURRENT_DATE()\r
-        OR    expirationdate IS NULL\r
-        OR    expirationdate = '00-00-0000'\r
-      )\r
-      AND   lang = ?\r
-      ORDER BY number\r
-    ";\r
-    my $sth = $dbh->prepare($query);\r
-    $sth->execute($lang);\r
-    my @results;\r
-    while ( my $row = $sth->fetchrow_hashref ){\r
-        push @results, $row;\r
-    }\r
-    return \@results;\r
-}\r
-\r
-### get electronic databases\r
-\r
-sub add_opac_electronic {\r
-    my ($title, $edata, $lang,$image,$href,$section) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("INSERT INTO opac_electronic (title, edata, lang,image,href,section) VALUES (?,?,?,?,?,?)");\r
-    $sth->execute($title, $edata, $lang,$image,$href,$section);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub upd_opac_electronic {\r
-    my ($idelectronic, $title, $edata, $lang, $image, $href,$section) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("UPDATE opac_electronic SET title = ?, edata = ?, lang = ? , image=?, href=? ,section=? WHERE idelectronic = ?");\r
-    $sth->execute($title, $edata, $lang, $image,$href ,$section, $idelectronic);\r
-    $sth->finish;\r
-    return 1;\r
-}\r
-\r
-sub del_opac_electronic {\r
-    my ($ids) = @_;\r
-    if ($ids) {\r
-        my $dbh = C4::Context->dbh;\r
-        my $sth = $dbh->prepare("DELETE FROM opac_electronic WHERE idelectronic IN ($ids)");\r
-        $sth->execute();\r
-        $sth->finish;\r
-        return 1;\r
-    } else {\r
-        return 0;\r
-    }\r
-}\r
-\r
-sub get_opac_electronic {\r
-    my ($idelectronic) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $sth = $dbh->prepare("SELECT * FROM opac_electronic WHERE idelectronic = ?");\r
-    $sth->execute($idelectronic);\r
-    my $data = $sth->fetchrow_hashref;\r
-    $data->{$data->{'lang'}} = 1;\r
-    $data->{$data->{'section'}} = 1;\r
-    $sth->finish;\r
-    return $data;\r
-}\r
-\r
-sub get_opac_electronics {\r
-    my ($section, $lang) = @_;\r
-    my $dbh = C4::Context->dbh;\r
-    my $query = "SELECT *, DATE_FORMAT(timestamp, '%d/%m/%Y') AS newdate FROM opac_electronic";\r
-    if ($lang) {\r
-        $query.= " WHERE lang = '" .$lang ."' ";\r
-    }\r
-    if ($section) {\r
-        $query.= " and section= '" . $section."' ";\r
-    }\r
-    $query.= " ORDER BY title ";\r
-    \r
-    my $sth = $dbh->prepare($query);\r
-    $sth->execute();\r
-    my @opac_electronic;\r
-    my $count = 0;\r
-    while (my $row = $sth->fetchrow_hashref) {\r
-            push @opac_electronic, $row;\r
-\r
-    \r
-        $count++;\r
-    }\r
-\r
-    return ($count,\@opac_electronic);\r
-}\r
-END { }    # module clean-up code here (global destructor)\r
-\r
-=back\r
-\r
-=head1 AUTHOR\r
-\r
-TG\r
-\r
-=cut\r
+package C4::NewsChannels;
+
+# This file is part of Koha.
+#
+# Copyright (C) 2000-2002  Katipo Communications
+# Copyright (C) 2013       Mark Tompsett
+#
+# 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>.
+
+use Modern::Perl;
+use C4::Context;
+use Koha::DateUtils;
+
+use vars qw(@ISA @EXPORT);
+
+BEGIN { 
+    @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 OPAC and intranet news
+
+=head1 DESCRIPTION
+
+This module provides the functions needed to mange OPAC and intranet news.
+
+=head1 FUNCTIONS
+
+=cut
+
+=head2 add_opac_new
+
+    $retval = add_opac_new($hashref);
+
+    $hashref should contains all the fields found in opac_news,
+    except idnew. The idnew field is auto-generated.
+
+=cut
+
+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("INSERT INTO opac_news ( $field_string ) VALUES ( $values_string )");
+        $sth->execute(@values);
+        $retval = 1;
+    }
+    return $retval;
+}
+
+=head2 upd_opac_new
+
+    $retval = upd_opac_new($hashref);
+
+    $hashref should contains all the fields found in opac_news,
+    including idnew, since it is the key for the SQL UPDATE.
+
+=cut
+
+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 ,
+
+        my $dbh = C4::Context->dbh;
+        my $sth = $dbh->prepare("UPDATE opac_news SET $field_string WHERE idnew = ?;");
+        $sth->execute(@values);
+        $retval = 1;
+    }
+    return $retval;
+}
+
+sub del_opac_new {
+    my ($ids) = @_;
+    if ($ids) {
+        my $dbh = C4::Context->dbh;
+        my $sth = $dbh->prepare("DELETE FROM opac_news WHERE idnew IN ($ids)");
+        $sth->execute();
+        return 1;
+    } else {
+        return 0;
+    }
+}
+
+sub get_opac_new {
+    my ($idnew) = @_;
+    my $dbh = C4::Context->dbh;
+    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 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, $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 .= " AND (opac_news.lang='' OR opac_news.lang=?)";
+        push @values,$lang;
+    }
+    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;
+    #}
+    my $sth = $dbh->prepare($query);
+    $sth->execute(@values);
+    my @opac_news;
+    my $count = 0;
+    while (my $row = $sth->fetchrow_hashref) {
+        if ((($limit) && ($count < $limit)) || (!$limit)) {
+            push @opac_news, $row;
+        }
+        $count++;
+    }
+    return ($count, \@opac_news);
+}
+
+=head2 GetNewsToDisplay
+
+    $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,$branch) = @_;
+    my $dbh = C4::Context->dbh;
+    # SELECT *,DATE_FORMAT(timestamp, '%d/%m/%Y') 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()
+        OR    expirationdate IS NULL
+        OR    expirationdate = '00-00-0000'
+     )
+     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);
+    $lang = $lang // q{};
+    $sth->execute($lang,$branch);
+    my @results;
+    while ( my $row = $sth->fetchrow_hashref ){
+        $row->{newdate} = output_pref({ dt => dt_from_string( $row->{newdate} ), dateonly => 1 });
+        push @results, $row;
+    }
+    return \@results;
+}
+
+1;
+__END__
+
+=head1 AUTHOR
+
+TG
+
+=cut