#
# Copyright 2008 Tamil s.a.r.l.
#
-# This software is placed under the gnu General Public License, v2
-# (http://www.gnu.org/licenses/gpl.html)
+# 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.
+#
+# 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;
use warnings;
for my $cloud ( @clouds ) {
print "Create a cloud\n",
- " Koha conf file: ", $cloud->{KohaConf}, "\n",
+ " Koha conf file: ", $cloud->{KohaConf} ? $cloud->{KohaConf} : "default", "\n",
" Zebra Index: ", $cloud->{ZebraIndex}, "\n",
" Koha Keyword: ", $cloud->{KohaIndex}, "\n",
" Count: ", $cloud->{Count}, "\n",
" Output: ", $cloud->{Output}, "\n",
if $verbose;
- # Set Koha context
- my $context = new C4::Context( $cloud->{KohaConf} );
- $context->set_context();
+ # Set Koha context if KohaConf is present
+ my $set_new_context = 0;
+ if ( $cloud->{KohaConf} ) {
+ if ( -e $cloud->{KohaConf} ) {
+ my $context = C4::Context->new( $cloud->{KohaConf} );
+ $context->set_context();
+ $set_new_context = 1;
+ }
+ else {
+ carp "Koha conf file doesn't exist: ", $cloud->{KohaConf}, " ; use KOHA_CONF\n";
+ }
+ }
my $index = new ZebraIndex( $cloud->{ZebraIndex} );
$index->scan( $cloud->{Count} );
open my $fh, ">", $cloud->{Output}
or croak "Unable to create file ", $cloud->{Output};
- my $withcss = $cloud->{Withcss};
- $withcss =~ /^y/i;
+ my $withcss = $cloud->{Withcss} =~ /^yes/i;
print $fh $index->html_cloud( $cloud->{KohaIndex}, $withcss );
close $fh;
+ $set_new_context && restore_context C4::Context;
}
package ZebraIndex;
+use strict;
+use warnings;
+use diagnostics;
+use Carp;
sub new {
my $self = {};
$self->{ top_terms } = undef;
$self->{ levels_cloud } = 24;
bless $self, $class;
+
+ # Test Zebra index
+ my $zbiblio = C4::Context->Zconn( "biblioserver" );
+ eval {
+ my $ss = $zbiblio->scan_pqf(
+ '@attr 1=' . $self->{ zebra_index } . ' @attr 4=1 @attr 6=3 "a"'
+ );
+ };
+ croak "Invalid Zebra index: ", $self->{ zebra_index } if $@;
+
return $self;
}
my $min_occurence_index = -1;
my $min_occurence;
my $from = '0';
+
while (1) {
my $ss;
eval {
# Sort array of array by terms weight
@terms = sort { @{$a}[1] <=> @{$b}[1] } @terms;
-
+
# A relatif weight to other set terms is added to each term
my $min = $terms[0][1];
my $log_min = log( $min );
- my $max = $terms[$#terms-1][1];
+ my $max = $terms[$#terms][1];
my $log_max = log( $max );
my $delta = $max - $min;
+ $delta = 1 if $delta == 0; # Very unlikely
my $factor;
if ($log_max - $log_min == 0) {
$log_min = $log_min - $self->{levels_cloud};
$factor = $self->{levels_cloud} / ($log_max - $log_min);
}
- foreach (0..$#terms-1) {
+ foreach (0..$#terms) {
my $count = @{ $terms[$_] }[1];
my $weight = ( $count - $min ) / $delta;
my $log_weight = int( (log($count) - $log_min) * $factor);
my $koha_index = shift;
my $withcss = shift;
my @terms = @{ $self->{top_terms} };
- my $html = <<EOS;
+ my $html = '';
+ if ( $withcss ) {
+ $html = <<EOS;
<style>
.subjectcloud {
text-align: center;
</style>
<div class="subjectcloud">
EOS
- for (0..$#terms-1) {
+ }
+ for (0..$#terms) {
my @term = @{ $terms[$_] };
my $uri = $term[0];
$uri =~ s/\(//g;
+ #print " 0=", $term[0]," - 1=", $term[1], " - 2=", $term[2], " - 3=", $term[3],"\n";
$html = $html
. '<span class="tagcloud'
. $term[3]
=item cloud-kw.pl [--verbose|--help] --conf=F<cloud.conf>
-Creates multiple HTML files containing kewords cloud.
+Creates multiple HTML files containing kewords cloud with top terms sorted
+by their logarithmic weight.
F<cloud.conf> is a YAML configuration file driving cloud generation
process.
=back
=head1 CONFIGURATION
-
+
Configuration file looks like that:
---
# Koha configuration file for a specific installation
+ # If not present, defaults to KOHA_CONF
KohaConf: /home/koha/mylibray/etc/koha-conf.xml
# Zebra index to scan
ZebraIndex: Author
# Koha index used to link found kewords with an opac search URL
KohaIndex: au
- # Number of top keyword to used for the cloud
+ # Number of top keyword to use for the cloud
Count: 50
# Include CSS style directives with the cloud
+ # This could be used as a model and then CSS directives are
+ # put in the appropriate CSS file directly.
Withcss: Yes
# HTML file where to output the cloud
Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
Withcss: no
Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html
+=head1 IMPROVEMENTS
+
+Generated top terms have more informations than those outputted from
+the time beeing. Some parameters could be easily added to improve
+this script:
+
+=over
+
+=item B<WithCount>
+
+In order to output terms with the number of occurences they
+have been found in Koha Catalogue by Zebra.
+
+=item B<CloudLevels>
+
+Number of levels in the cloud. Now 24 levels are hardcoded.
+
+=item B<Weithing>
+
+Weighting method used to distribute terms in the cloud. We could have two
+values: Logarithmic and Linear. Now it's Logarithmic by default.
+
+=item B<Order>
+
+Now terms are outputted in the lexical order. They could be sorted
+by their weight.
+
+=back
+
=cut
projects / koha_fer / blobdiff