Added an incomplete POD, as well as some FIXME comments (which, as it
[koha.git] / C4 / Maintainance.pm
1 package C4::Maintainance; #assumes C4/Maintainance
2
3 #package to deal with marking up output
4
5
6 # Copyright 2000-2002 Katipo Communications
7 #
8 # This file is part of Koha.
9 #
10 # Koha is free software; you can redistribute it and/or modify it under the
11 # terms of the GNU General Public License as published by the Free Software
12 # Foundation; either version 2 of the License, or (at your option) any later
13 # version.
14 #
15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License along with
20 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
21 # Suite 330, Boston, MA  02111-1307 USA
22
23 use strict;
24 use C4::Database;
25
26 require Exporter;
27
28 use vars qw($VERSION @ISA @EXPORT);
29
30 # set the version for version checking
31 $VERSION = 0.01;
32
33 =head1 NAME
34
35 C4::Maintenance - Koha catalog maintenance functions
36
37 =head1 SYNOPSIS
38
39   use C4::Maintenance;
40
41 =head1 DESCRIPTION
42
43 The functions in this module perform various catalog-maintenance
44 functions, including deleting and undeleting books, fixing
45 miscategorized items, etc.
46
47 =head1 FUNCTIONS
48
49 =over 2
50
51 =cut
52
53 @ISA = qw(Exporter);
54 @EXPORT = qw(&listsubjects &updatesub &shiftgroup &deletedbib &undeletebib
55 &updatetype);
56
57 =item listsubjects
58
59   ($count, $results) = &listsubjects($subject, $n, $offset);
60
61 Finds the subjects that begin with C<$subject> in the bibliosubject
62 table of the Koha database.
63
64 C<&listsubjects> returns a two-element array. C<$results> is a
65 reference-to-array, in which each element is a reference-to-hash
66 giving information about the given subject. C<$count> is the number of
67 elements in C<@{$results}>.
68
69 Probably the only interesting field in C<$results->[$i]> is
70 C<subject>, the subject in question.
71
72 C<&listsubject> returns up to C<$n> items, starting at C<$offset>. If
73 C<$n> is 0, it will return all matching subjects.
74
75 =cut
76 #'
77 # FIXME - This API is bogus. The way it's currently used, it should
78 # just return a list of strings.
79 sub listsubjects {
80   my ($sub,$num,$offset)=@_;
81   my $dbh=C4Connect;
82   my $query="Select * from bibliosubject where subject like '$sub%' group by subject";
83   # FIXME - Make $num and $offset optional.
84   # If $num was given, make sure $offset was, too.
85   if ($num != 0){
86     $query.=" limit $offset,$num";
87   }
88   my $sth=$dbh->prepare($query);
89 #  print $query;
90   $sth->execute;
91   my @results;
92   my $i=0;
93   while (my $data=$sth->fetchrow_hashref){
94     $results[$i]=$data;
95     $i++;
96   }
97   $sth->finish;
98   $dbh->disconnect;
99   return($i,\@results);
100 }
101
102 =item updatesub
103
104   &updatesub($newsubject, $oldsubject);
105
106 Renames a subject from C<$oldsubject> to C<$newsubject> in the
107 bibliosubject table of the Koha database.
108
109 =cut
110 #'
111 sub updatesub{
112   my ($sub,$oldsub)=@_;
113   my $dbh=C4Connect;
114   $sub=$dbh->quote($sub);
115   $oldsub=$dbh->quote($oldsub);
116   my $query="update bibliosubject set subject=$sub where subject=$oldsub";
117   my $sth=$dbh->prepare($query);
118   $sth->execute;
119   $sth->finish;
120   $dbh->disconnect;
121 }
122
123 =item shiftgroup
124
125   &shiftgroup($biblionumber, $biblioitemnumber);
126
127 Changes the biblionumber associated with a given biblioitem.
128 C<$biblioitemnumber> is the number of the biblioitem to change.
129 C<$biblionumber> is the biblionumber to associate it with.
130
131 =cut
132 #'
133 sub shiftgroup{
134   my ($bib,$bi)=@_;
135   my $dbh=C4Connect;
136   my $query="update biblioitems set biblionumber=$bib where biblioitemnumber=$bi";
137   my $sth=$dbh->prepare($query);
138   $sth->execute;
139   $sth->finish;
140   $query="update items set biblionumber=$bib where biblioitemnumber=$bi";
141   $sth=$dbh->prepare($query);
142   $sth->execute;
143   $sth->finish;
144   $dbh->disconnect;
145 }
146
147 =item deletedbib
148
149   ($count, $results) = &deletedbib($title);
150
151 Looks up deleted books whose title begins with C<$title>.
152
153 C<&deletedbib> returns a two-element list. C<$results> is a
154 reference-to-array; each element is a reference-to-hash whose keys are
155 the fields of the deletedbiblio table in the Koha database. C<$count>
156 is the number of elements in C<$results>.
157
158 =cut
159 #'
160 sub deletedbib{
161   my ($title)=@_;
162   my $dbh=C4Connect;
163   my $query="Select * from deletedbiblio where title like '$title%' order by title";
164   my $sth=$dbh->prepare($query);
165   $sth->execute;
166   my @results;
167   my $i=0;
168   while (my $data=$sth->fetchrow_hashref){
169     $results[$i]=$data;
170     $i++;
171   }
172   $sth->finish;
173   $dbh->disconnect;
174   return($i,\@results);
175 }
176
177 =item undeletebib
178
179   &undeletebib($biblionumber);
180
181 Undeletes a book. C<&undeletebib> looks up the book with the given
182 biblionumber in the deletedbiblio table of the Koha database, and
183 moves its entry to the biblio table.
184
185 =cut
186 #'
187 sub undeletebib{
188   my ($bib)=@_;
189   my $dbh=C4Connect;
190   my $query="select * from deletedbiblio where biblionumber=$bib";
191   my $sth=$dbh->prepare($query);
192   $sth->execute;
193   if (my @data=$sth->fetchrow_array){
194     $sth->finish;
195     # FIXME - Doesn't this keep the same biblionumber? Isn't this
196     # forbidden by the definition of 'biblio'? Or doesn't it matter?
197     $query="Insert into biblio values (";
198     foreach my $temp (@data){
199       $temp=~ s/\'/\\\'/g;
200       $query=$query."'$temp',";
201     }
202     $query=~ s/\,$/\)/;
203     #   print $query;
204     $sth=$dbh->prepare($query);
205     $sth->execute;
206     $sth->finish;
207   }
208   $query="Delete from deletedbiblio where biblionumber=$bib";
209   $sth=$dbh->prepare($query);
210   $sth->execute;
211   $sth->finish;
212   $dbh->disconnect;
213 }
214
215 =item updatetype
216
217   &updatetype($biblioitemnumber, $itemtype);
218
219 Changes the type of the item with the given biblioitemnumber to be
220 C<$itemtype>.
221
222 =cut
223 #'
224 sub updatetype{
225   my ($bi,$type)=@_;
226   my $dbh=C4Connect;
227   # FIXME - Use $dbh->do(...);
228   my $sth=$dbh->prepare("Update biblioitems set itemtype='$type' where biblioitemnumber=$bi");
229   $sth->execute;
230   $sth->finish;
231   $dbh->disconnect;
232 }
233
234 END { }       # module clean-up code here (global destructor)
235
236 1;
237 __END__
238
239 =back
240
241 =head1 AUTHOR
242
243 Koha Developement team <info@koha.org>
244
245 =head1 SEE ALSO
246
247 L<perl>.
248
249 =cut