package C4::Tags;
+
+# Copyright Liblime 2008
+# Parts Copyright ACPL 2011
+#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it under the
# 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, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;
use warnings;
use C4::Context;
use C4::Debug;
+#use Data::Dumper;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
use vars qw($ext_dict $select_all @fields);
BEGIN {
- $VERSION = 0.03;
+ $VERSION = 3.07.00.049;
@ISA = qw(Exporter);
@EXPORT_OK = qw(
&get_tag &get_tags &get_tag_rows
&whitelist
&is_approved
&approval_counts
+ &get_count_by_tag_status
&get_filters
);
# %EXPORT_TAGS = ();
$select_all = "SELECT " . join(',',@fields) . "\n FROM tags_all\n";
}
-sub get_filters (;$) {
+sub get_filters {
my $query = "SELECT * FROM tags_filters ";
my ($sth);
if (@_) {
# (SELECT count(*) FROM tags_all ) as tags_all,
# (SELECT count(*) FROM tags_index ) as tags_index,
-sub approval_counts () {
+sub approval_counts {
my $query = "SELECT
(SELECT count(*) FROM tags_approval WHERE approved= 1) as approved_count,
(SELECT count(*) FROM tags_approval WHERE approved=-1) as rejected_count,
return $result;
}
-sub remove_tag ($;$) {
+=head2 get_count_by_tag_status
+
+ get_count_by_tag_status($status);
+
+Takes a status and gets a count of tags with that status
+
+=cut
+
+sub get_count_by_tag_status {
+ my ($status) = @_;
+ my $dbh = C4::Context->dbh;
+ my $query =
+ "SELECT count(*) FROM tags_approval WHERE approved=?";
+ my $sth = $dbh->prepare($query);
+ $sth->execute( $status );
+ return $sth->fetchrow;
+}
+
+sub remove_tag {
my $tag_id = shift or return undef;
my $user_id = (@_) ? shift : undef;
my $rows = (defined $user_id) ?
delete_tag_row_by_id($tag_id);
}
-sub delete_tag_index ($$) {
+sub delete_tag_index {
(@_) or return undef;
my $sth = C4::Context->dbh->prepare("DELETE FROM tags_index WHERE term = ? AND biblionumber = ? LIMIT 1");
$sth->execute(@_);
return $sth->rows || 0;
}
-sub delete_tag_approval ($) {
+sub delete_tag_approval {
(@_) or return undef;
my $sth = C4::Context->dbh->prepare("DELETE FROM tags_approval WHERE term = ? LIMIT 1");
$sth->execute(shift);
return $sth->rows || 0;
}
-sub delete_tag_row_by_id ($) {
+sub delete_tag_row_by_id {
(@_) or return undef;
my $sth = C4::Context->dbh->prepare("DELETE FROM tags_all WHERE tag_id = ? LIMIT 1");
$sth->execute(shift);
return $sth->rows || 0;
}
-sub delete_tag_rows_by_ids (@) {
+sub delete_tag_rows_by_ids {
(@_) or return undef;
my $i=0;
foreach(@_) {
return $i;
}
-sub get_tag_rows ($) {
+sub get_tag_rows {
my $hash = shift || {};
my @ok_fields = @fields;
push @ok_fields, 'limit'; # push the limit! :)
return $sth->fetchall_arrayref({});
}
-sub get_tags (;$) { # i.e., from tags_index
+sub get_tags { # i.e., from tags_index
my $hash = shift || {};
- my @ok_fields = qw(term biblionumber weight limit sort);
+ my @ok_fields = qw(term biblionumber weight limit sort approved);
my $wheres;
my $limit = "";
my $order = "";
} else {
my $whereval = $hash->{$key};
- my $longkey = ($key eq 'term') ? 'tags_index.term' : $key;
+ my $longkey = ($key eq 'term' ) ? 'tags_index.term' :
+ ($key eq 'approved') ? 'tags_approval.approved' : $key;
my $op = ($whereval =~ s/^(>=|<=)// or
$whereval =~ s/^(>|=|<)// ) ? $1 : '=';
$wheres .= ($wheres) ? " AND $longkey $op ?\n" : " WHERE $longkey $op ?\n";
return $sth->fetchall_arrayref({});
}
-sub get_approval_rows (;$) { # i.e., from tags_approval
+sub get_approval_rows { # i.e., from tags_approval
my $hash = shift || {};
- my @ok_fields = qw(term approved date_approved approved_by weight_total limit sort);
+ my @ok_fields = qw(term approved date_approved approved_by weight_total limit sort borrowernumber);
my $wheres;
my $limit = "";
my $order = "";
if ($key eq 'limit') {
my $val = $hash->{$key};
unless ($val =~ /^(\d+,)?\d+$/) {
- carp "Non-nuerical limit value '$val' ignored!";
+ carp "Non-numerical limit value '$val' ignored!";
next;
}
$limit = " LIMIT $val\n";
unless (
$by =~ /^([-+])?(term)/ or
$by =~ /^([-+])?(biblionumber)/ or
+ $by =~ /^([-+])?(borrowernumber)/ or
$by =~ /^([-+])?(weight_total)/ or
$by =~ /^([-+])?(approved(_by)?)/ or
$by =~ /^([-+])?(date_approved)/
return $sth->fetchall_arrayref({});
}
-sub is_approved ($) {
+sub is_approved {
my $term = shift or return undef;
my $sth = C4::Context->dbh->prepare("SELECT approved FROM tags_approval WHERE term = ?");
$sth->execute($term);
unless ($sth->rows) {
$ext_dict and return (spellcheck($term) ? 0 : 1); # spellcheck returns empty on OK word
- return undef;
+ return 0;
}
- return $sth->fetch;
+ return $sth->fetchrow;
}
-sub get_tag_index ($;$) {
+sub get_tag_index {
my $term = shift or return undef;
my $sth;
if (@_) {
return scalar @_;
}
-sub add_tag_approval ($;$$) { # or disapproval
+sub add_tag_approval { # or disapproval
+ $debug and warn "add_tag_approval(" . join(", ",map {defined($_) ? $_ : 'UNDEF'} @_) . ")";
my $term = shift or return undef;
my $query = "SELECT * FROM tags_approval WHERE term = ?";
my $sth = C4::Context->dbh->prepare($query);
$sth->execute($term);
($sth->rows) and return increment_weight_total($term);
- my $operator = (@_ ? shift : 0);
+ my $operator = shift || 0;
+ my $approval = (@_ ? shift : 0); # default is unapproved
+ my @exe_args = ($term); # all 3 queries will use this argument
if ($operator) {
- my $approval = (@_ ? shift : 1); # default is to approve
$query = "INSERT INTO tags_approval (term,approved_by,approved,date_approved) VALUES (?,?,?,NOW())";
- $debug and print STDERR "add_tag_approval query:\n$query\nadd_tag_approval args: ($term,$operator,$approval)\n";
- $sth = C4::Context->dbh->prepare($query);
- $sth->execute($term,$operator,$approval);
+ push @exe_args, $operator, $approval;
+ } elsif ($approval) {
+ $query = "INSERT INTO tags_approval (term,approved,date_approved) VALUES (?,?,NOW())";
+ push @exe_args, $approval;
} else {
$query = "INSERT INTO tags_approval (term,date_approved) VALUES (?,NOW())";
- $debug and print STDERR "add_tag_approval query:\n$query\nadd_tag_approval args: ($term)\n";
- $sth = C4::Context->dbh->prepare($query);
- $sth->execute($term);
}
+ $debug and print STDERR "add_tag_approval query: $query\nadd_tag_approval args: (" . join(", ", @exe_args) . ")\n";
+ $sth = C4::Context->dbh->prepare($query);
+ $sth->execute(@exe_args);
return $sth->rows;
}
-sub mod_tag_approval ($$$) {
+sub mod_tag_approval {
my $operator = shift;
defined $operator or return undef; # have to test defined to allow =0 (kohaadmin)
my $term = shift or return undef;
- my $approval = (@_ ? shift : 1); # default is to approve
+ my $approval = (scalar @_ ? shift : 1); # default is to approve
my $query = "UPDATE tags_approval SET approved_by=?, approved=?, date_approved=NOW() WHERE term = ?";
- $debug and print STDERR "mod_tag_approval query:\n$query\nmod_tag_approval args: ($operator,$approval,$term)\n";
+ $debug and print STDERR "mod_tag_approval query: $query\nmod_tag_approval args: ($operator,$approval,$term)\n";
my $sth = C4::Context->dbh->prepare($query);
$sth->execute($operator,$approval,$term);
}
-sub add_tag_index ($$;$) {
+sub add_tag_index {
my $term = shift or return undef;
my $biblionumber = shift or return undef;
my $query = "SELECT * FROM tags_index WHERE term = ? AND biblionumber = ?";
$sth->execute($term,$biblionumber);
($sth->rows) and return increment_weight($term,$biblionumber);
$query = "INSERT INTO tags_index (term,biblionumber) VALUES (?,?)";
- $debug and print "add_tag_index query:\n$query\nadd_tag_index args: ($term,$biblionumber)\n";
+ $debug and print STDERR "add_tag_index query: $query\nadd_tag_index args: ($term,$biblionumber)\n";
$sth = C4::Context->dbh->prepare($query);
$sth->execute($term,$biblionumber);
return $sth->rows;
}
-sub get_tag ($) { # by tag_id
+sub get_tag { # by tag_id
(@_) or return undef;
my $sth = C4::Context->dbh->prepare("$select_all WHERE tag_id = ?");
$sth->execute(shift);
return $sth->fetchrow_hashref;
}
-sub rectify_weights (;$) {
+sub rectify_weights {
my $dbh = C4::Context->dbh;
my $sth;
my $query = "
return ($results,\%tally);
}
-sub increment_weights ($$) {
+sub increment_weights {
increment_weight(@_);
increment_weight_total(shift);
}
-sub decrement_weights ($$) {
+sub decrement_weights {
decrement_weight(@_);
decrement_weight_total(shift);
}
-sub increment_weight_total ($) {
+sub increment_weight_total {
_set_weight_total('weight_total+1',shift);
}
-sub increment_weight ($$) {
+sub increment_weight {
_set_weight('weight+1',shift,shift);
}
-sub decrement_weight_total ($) {
+sub decrement_weight_total {
_set_weight_total('weight_total-1',shift);
}
-sub decrement_weight ($$) {
+sub decrement_weight {
_set_weight('weight-1',shift,shift);
}
-sub _set_weight_total ($$) {
+sub _set_weight_total {
my $sth = C4::Context->dbh->prepare("
UPDATE tags_approval
SET weight_total=" . (shift) . "
"); # note: CANNOT use "?" for weight_total (see the args above).
$sth->execute(shift); # just the term
}
-sub _set_weight ($$$) {
+sub _set_weight {
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("
UPDATE tags_index
$sth->execute(@_);
}
-sub add_tag ($$;$$) { # biblionumber,term,[borrowernumber,approvernumber]
+sub add_tag { # biblionumber,term,[borrowernumber,approvernumber]
my $biblionumber = shift or return undef;
my $term = shift or return undef;
my $borrowernumber = (@_) ? shift : 0; # the user, default to kohaadmin
my $query = "INSERT INTO tags_all
(borrowernumber,biblionumber,term,date_created)
VALUES (?,?,?,NOW())";
- $debug and print STDERR "add_tag query:\n $query\n",
+ $debug and print STDERR "add_tag query: $query\n",
"add_tag query args: ($borrowernumber,$biblionumber,$term)\n";
if (scalar @$rows) {
$debug and carp "Duplicate tag detected. Tag not added.";
$sth->execute($borrowernumber,$biblionumber,$term);
# then
- if (@_) { # if an arg remains, it is the borrowernumber of the approver: tag is pre-approved. Note, whitelist unaffected.
+ if (scalar @_) { # if arg remains, it is the borrowernumber of the approver: tag is pre-approved.
my $approver = shift;
- add_tag_approval($term,$approver);
+ $debug and print STDERR "term '$term' pre-approved by borrower #$approver\n";
+ add_tag_approval($term,$approver,1);
add_tag_index($term,$biblionumber,$approver);
- } elsif (is_approved($term)) {
- add_tag_approval($term,1);
+ } elsif (is_approved($term) >= 1) {
+ $debug and print STDERR "term '$term' approved by whitelist\n";
+ add_tag_approval($term,0,1);
add_tag_index($term,$biblionumber,1);
} else {
+ $debug and print STDERR "term '$term' NOT approved (yet)\n";
add_tag_approval($term);
add_tag_index($term,$biblionumber);
}
=head3 TO DO: Add real perldoc
+=cut
+
=head2 External Dictionary (Ispell) [Recommended]
An external dictionary can be used as a means of "pre-populating" and tracking
language version of Ispell can be installed. It is also possible to modify the dictionary
at the command line to affect the desired content.
+WARNING: The default Ispell dictionary includes (properly spelled) obscenities! Users
+should build their own wordlist and recompile Ispell based on it. See man ispell for
+instructions.
+
=head2 Table Structure
The tables used by tags are:
projects / koha-ffzg.git / blobdiff