Minor change to generalize the script
[koha.git] / misc / spellcheck_suggest / make_spellcheck_suggest.pl
1 #!/usr/bin/perl -w
2 ## This Script creates a Koha suggest and spellcheck database
3 ## for those features as visible on LibLime's opac: opac.liblime.com
4 ## It also contains the needed specs for creating a table of
5 ## queries for statistical purposes as well as a method of
6 ## returning popular searches via the suggest and spellcheck.
7 ## The code for running suggest and spellcheck can be found
8 ## either in Koha 2.4 CVS (HEAD as of this writing) or at 
9 ## LibLime's website in the downlaods
10 ## section: http://liblime.com/c/downloads.html
11 ##
12 ##Author: Joshua Ferraro jmf at liblime dot com
13 ##
14 ## TODO: add suggest features, merge the two of them?
15 ## There are a few configurable variables.  
16
17 ## CONFIGURABLE VARIABLES ####################
18 ##
19  # Change this to where your Koha modules are (C4 directory)
20 use lib '/usr/local/koha/intranet/modules/';
21  # These are the tags that have meaningful data
22  # for the databases I've worked with (MARC21 only)
23  # you may need to change them depending on your data
24 my @tags=(
25 #Tag documentation from http://lcweb.loc.gov/marc/bibliographic/ecbdhome.html
26 "020a", # INTERNATIONAL STANDARD BOOK NUMBER
27 #"022a", # INTERNATIONAL STANDARD SERIAL NUMBER
28 "100a", # MAIN ENTRY--PERSONAL NAME
29 "110a", # MAIN ENTRY--CORPORATE NAME
30 #"110b", #   Subordinate unit
31 #"110c", #   Location of meeting
32 #"111a", # MAIN ENTRY--MEETING NAME
33 #"111c", #   Location of meeting
34 "130a", # MAIN ENTRY--UNIFORM TITLE
35 "240a", # UNIFORM TITLE
36 "245a", # TITLE STATEMENT
37 "245b", #   Remainder of title
38 "245c", #   Statement of responsibility, etc.
39 "245p", #   Name of part/section of a work
40 "246a", # VARYING FORM OF TITLE
41 "246b", #   Remainder of title
42 #"260b", # PUBLICATION, DISTRIBUTION, ETC. (IMPRINT)
43 "440a", # SERIES STATEMENT/ADDED ENTRY--TITLE
44 "440p", #   Name of part/section of a work
45 #"500a", # GENERAL NOTE
46 "505t", # FORMATTED CONTENTS NOTE (t is Title)
47 "511a", # PARTICIPANT OR PERFORMER NOTE
48 #"520a", # SUMMARY, ETC.
49 "534a", # ORIGINAL VERSION NOTE
50 #"534k", #   Key title of original
51 #"534t", #   Title statement of original
52 #"586a", # AWARDS NOTE
53 "600a", # SUBJECT ADDED ENTRY--PERSONAL NAME
54 "610a", # SUBJECT ADDED ENTRY--CORPORATE NAME
55 "611a", # SUBJECT ADDED ENTRY--MEETING NAME
56 "630a", # SUBJECT ADDED ENTRY--UNIFORM TITLE
57 "650a", # SUBJECT ADDED ENTRY--TOPICAL TERM
58 "651a", # SUBJECT ADDED ENTRY--GEOGRAPHIC NAME
59 "700a", # ADDED ENTRY--PERSONAL NAME
60 "710a", # ADDED ENTRY--CORPORATE NAME
61 #"711a", # ADDED ENTRY--MEETING NAME
62 #"720a", # ADDED ENTRY--UNCONTROLLED NAME
63 "730a", # ADDED ENTRY--UNIFORM TITLE
64 "740a", # ADDED ENTRY--UNCONTROLLED RELATED/ANALYTICAL TITLE
65 #"752a", # ADDED ENTRY--HIERARCHICAL PLACE NAME
66 "800a", # SERIES ADDED ENTRY--PERSONAL NAME
67 #"810a", # SERIES ADDED ENTRY--CORPORATE NAME
68 #"811a", # SERIES ADDED ENTRY--MEETING NAME
69 "830a", # SERIES ADDED ENTRY--UNIFORM TITLE
70 #"942k"  # Holdings Branch ?? Unique to NPL??
71 );
72 ## Leave this next bit alone
73 use strict;
74 use C4::Context;
75 ##
76  # SUGGEST DATABASE INFO
77  # You'll need to change this if you want to keep your 'suggest' database
78  # separate from your Koha database -- simply comment out the next line
79  # and uncomment the one after it, adding your site info (check out GRANT
80  # syntax in the mysql manual if you're unsure how enable authentication)
81 #
82 my dbh2 = C4::Context->dbh;
83 #
84 #my $dbh2=DBI->connect("DBI:mysql:<add your database name here>:localhost","<add your mysql user here>","<add your password here>");
85 ########################################################################
86 ## End of most common configurable variables: in most cases you won't need
87 ## edit any further ... of course feel free to indulge yourself ;-)
88 ########################################################################
89 my $dbh=C4::Context->dbh;
90 my $counter = 0;
91
92 # Check for existance of suggest database and add if it doesn't.
93 print "Step 1 of 5: Checking to make sure suggest tables exist\n";
94 my $check_tables_query = "select distinct resultcount from ?";
95 my @tables = ("notdistinctspchk", "notdistinctsugg", "spellcheck", "suggestions");
96 my %tables = ( notdistinctspchk => "( display varchar(40) not null default,
97                                 suggestion varchar(40) not null default,
98 foreach my $table (@tables) {
99   my $sth_check=$dbh2->prepare($check_tables_query) || die "cant prepare query: $DBI::errstr";
100   my $rv = $sth_check->execute($table);
101   if($rv eq undef) {
102     print "$table missing ... creating it now\n";
103     my $create_this = "CREATE TABLE \'$table\' \(
104                         display varchar\(40\) NOT NULL default \'\',
105                         suggestion varchar\(40\) NOT NULL default \'\',
106                         resultcount varchar\(40\) NOT NULL default \'0\'
107                         \) TYPE=MyISAM";
108     my $sth_create = $dbh->prepare($create_this) || die "can't prepare query: $DBI::errstr";
109     $sth_create->execute() || die "can't execute: $DBI::errstr";
110     print "$table created ...\n";
111   }else {
112     print "$table exists ...  moving along\n";
113   }
114 }
115 print "All tables present ... moving along\n";
116
117 print "Step 2 of 5: Deleting old data\n";
118 my $clear_out = "DELETE FROM notdistinctspchk";
119 # Clear out old data
120 my $sth_clear_out=$dbh2->prepare($clear_out) || die "cant prepare query";
121 $sth_clear_out->execute();
122 print "Step 3 of 5: Creating non-distinct table from various Koha tables\n";
123 my $query_words = "SELECT DISTINCT word, COUNT(word) FROM marc_word";
124 my $query_marc_subfields = "SELECT DISTINCT subfieldvalue, COUNT(subfieldvalue) FROM marc_subfield_table";
125 my $query_titles = "SELECT DISTINCT title, COUNT(title) FROM biblio GROUP BY title";
126 my $query_authors = "SELECT DISTINCT author, COUNT(author) FROM biblio GROUP BY author";
127
128 my @queries = ("$query_words", "$query_marc_subfields", "$query_titles", "$query_authors");
129
130 foreach my $query (@queries) {
131         
132         #we need to do some special stuff for marc_word and marc_subfield_table queries
133         if ($query eq $queries[0]) { #marc_word
134         my $listoftagsubfields;
135           my $notfirst;
136             foreach my $tag (@tags) {   
137               $listoftagsubfields.="$tag, ";
138               if (!$notfirst) {
139                 $query.=" WHERE tagsubfield=\'$tag\'";
140                 $notfirst = 1;
141               } else {
142                 $query.=" OR tagsubfield=\'$tag\'";
143               }
144             }#foreach
145         $query.=" GROUP BY word";
146         print "Finished building marc_word list\n";
147         print "Adding marc_word entries with the following tagsubfields:"."$listoftagsubfields"."\n";
148         }
149
150         if ($query eq $queries[1]) { #marc_subfield_table
151         my $listofsubfieldstuff; #for testing
152         my $notfirst;
153           foreach my $tag (@tags) {
154             my $justtag = $tag;
155             $justtag =~ s/\D\Z//;
156             my $subfieldcode = $&;
157             $listofsubfieldstuff.="$justtag, "."$subfieldcode, ";
158             if (!$notfirst) {
159               $query.=" WHERE (tag=\'$justtag\' and subfieldcode=\'$subfieldcode\')";
160               $notfirst = 1;
161             } else {
162               $query.=" OR (tag=\'$justtag\' and subfieldcode=\'$subfieldcode\')";
163             }
164           }#foreach
165         $query.=" GROUP BY subfieldvalue";
166         print "Finished building marc_subfield_table list\n";
167         print "Adding marc_subfield_table entries with the following tags and subfields:"."$listofsubfieldstuff"."\n";
168         }
169
170         my $sth=$dbh->prepare($query) || die "cant prepare query";
171         $sth->execute();
172
173         my $insert = "INSERT INTO notdistinctspchk(suggestion,display,resultcount) VALUES(?,?,?)";
174
175         my $sth2=$dbh2->prepare($insert);
176
177         while (my ($phraseterm,$count)=$sth->fetchrow_array) {
178                 if ($phraseterm) {      
179                   #$display looks exactly like the DB
180                   my $display = $phraseterm;
181                   #except for a few things
182                   $display =~s/  / /g;
183                   $display =~ s/^\s+//; #remove leading whitespace
184                   $display  =~ s/\s+$//; #remove trailing whitespace
185                   $display =~ s/(\.|\/)/ /g;
186
187                   #suggestion is tweaked for optimal searching
188                   my $suggestion = $phraseterm;
189                   $suggestion =~ tr/A-Z/a-z/;
190                   $suggestion =~ s/(\.|\?|\:|\!|\'|,|\-|\"|\(|\)|\[|\]|\{|\})/ /g;
191                   $suggestion =~s/(\Aand-or |\Aand\/or |\Aanon |\Aan |\Aa |\Abut |\Aby |\Ade |\Ader |\Adr |\Adu|et |\Afor |\Afrom |\Ain |\Ainto |\Ait |\Amy |\Anot |\Aon |\Aor |\Aper |\Apt |\Aspp |\Ato |\Avs |\Awith |\Athe )/ /g;
192                   $suggestion =~s/( and-or | and\/or | anon | an | a | but | by | de | der | dr | du|et | for | from | in | into | it | my | not | on | or | per | pt | spp | to | vs | with | the )/ /g;
193
194                   $suggestion =~s/  / /g;
195
196                   $suggestion =~ s/^\s+//; #remove leading whitespace
197                   $suggestion =~ s/\s+$//; #remove trailing whitespace
198         
199                   if (length($suggestion)>2) {
200                         $sth2->execute($suggestion,$display,$count) || die "can't execute write";
201                         $counter++;
202                   } #if 
203                 } #if
204         }#while
205 print $counter." more records added...\n";
206 $sth2->finish;
207 $sth->finish;
208 }
209
210 # Now grab distincts from there and insert into our REAL database
211
212 print "Step 4 of 5: Deleting old distinct entries\n";
213 my $clear_distincts = "DELETE FROM spellcheck";
214
215 # Clear out old data
216 my $sth_clear_distincts=$dbh2->prepare($clear_distincts) || die "cant prepare query";
217 $sth_clear_distincts->execute();
218
219 print "Step 5 of 5: Creating distinct spellcheck table out of non-distinct table\n";
220 my $query_distincts = "SELECT DISTINCT suggestion, display, COUNT(display) FROM notdistinctspchk GROUP BY suggestion";
221 my $insert_distincts = "INSERT INTO spellcheck(suggestion,display,resultcount) VALUES(?,?,?)";
222 my $distinctcounter = 0;
223
224 my $sth=$dbh2->prepare($query_distincts) || die "cant prepare query";
225 $sth->execute();
226 my $sth2=$dbh2->prepare($insert_distincts) || die "cant prepare query";
227 while (my ($suggestion,$display,$count)=$sth->fetchrow_array) {
228         if ($count) {
229                 $sth2->execute($suggestion,$display,$count) || die "can't execute write";
230                 $distinctcounter++;
231         }
232 }
233 print "Finished: total distinct items added to spellcheck: "."$distinctcounter\n";
234
235 $dbh->disconnect();
236 $dbh2->disconnect();