3 # Copyright 2009 Biblibre SARL
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 use List::MoreUtils qw(first_value any);
25 use C4::Dates qw(format_date_in_iso);
28 use vars qw($VERSION @ISA @EXPORT_OK %EXPORT_TAGS);
31 # set the version for version checking
42 %EXPORT_TAGS = ( all =>[qw( InsertInTable DeleteInTable SearchInTable UpdateInTable GetPrimaryKeys)]
51 C4::SQLHelper - Perl Module containing convenience functions for SQL Handling
59 This module contains routines for adding, modifying and Searching Data in MysqlDB
65 $hashref = &SearchInTable($tablename,$data, $orderby, $limit,
66 $columns_out, $filtercolumns, $searchtype);
69 $tablename Name of the table (string)
74 - data_hashref : will be considered as an AND of all the data searched
76 - data_array_ref on hashrefs : Will be considered as an OR of Datahasref elements
78 $orderby is an arrayref of hashref with fieldnames as key and 0 or 1 as values (ASCENDING or DESCENDING order)
80 $limit is an array ref on 2 values in order to limit results to MIN..MAX
82 $columns_out is an array ref on field names is used to limit results on those fields (* by default)
84 $filtercolums is an array ref on field names : is used to limit expansion of research for strings
86 $searchtype is string Can be "start_with" or "exact"
88 This query builder is very limited, it should be replaced with DBIx::Class
90 Meanwhile adding support for special key '' in case of a data_hashref to
91 support filters of type
93 ( f1 = a OR f2 = a ) AND fx = b AND fy = c
95 Call for the query above is:
97 SearchInTable($tablename, {'' => a, fx => b, fy => c}, $orderby, $limit,
98 $columns_out, [f1, f2], 'exact');
100 NOTE: Current implementation may remove parts of the iinput hashrefs. If that is a problem
101 a copy needs to be created in _filter_fields() below
106 my ($tablename,$filters,$orderby, $limit, $columns_out, $filter_columns,$searchtype) = @_;
107 $searchtype||="exact";
108 my $dbh = C4::Context->dbh;
109 $columns_out||=["*"];
110 my $sql = do { local $"=', ';
111 qq{ SELECT @$columns_out from $tablename}
115 my ($keys,$values)=_filter_fields($tablename,$filters,$searchtype,$filter_columns);
117 my @criteria=grep{defined($_) && $_ !~/^\W$/ }@$keys;
119 $sql.= do { local $"=') OR (';
120 qq{ WHERE (@criteria) }
125 #Order by desc by default
127 foreach my $order ( ref($orderby) ? @$orderby : $orderby ){
129 push @orders,map{ "$_".($order->{$_}? " DESC " : "") } keys %$order;
134 $sql.= do { local $"=', ';
135 qq{ ORDER BY @orders}
139 $sql.=qq{ LIMIT }.join(",",@$limit);
142 $debug && $values && warn $sql," ",join(",",@$values);
143 $sth = $dbh->prepare_cached($sql);
144 eval{$sth->execute(@$values)};
145 warn $@ if ($@ && $debug);
146 my $results = $sth->fetchall_arrayref( {} );
152 $data_id_in_table = &InsertInTable($tablename,$data_hashref,$withprimarykeys);
154 Insert Data in table and returns the id of the row inserted
159 my ($tablename,$data,$withprimarykeys) = @_;
160 my $dbh = C4::Context->dbh;
161 my ($keys,$values)=_filter_hash($tablename,$data,($withprimarykeys?"exact":0));
162 my $query = qq{ INSERT INTO $tablename SET }.join(", ",@$keys);
164 $debug && warn $query, join(",",@$values);
165 my $sth = $dbh->prepare_cached($query);
166 eval{$sth->execute(@$values)};
167 warn $@ if ($@ && $debug);
169 return $dbh->last_insert_id(undef, undef, $tablename, undef);
174 $status = &UpdateInTable($tablename,$data_hashref);
176 Update Data in table and returns the status of the operation
181 my ($tablename,$data) = @_;
182 my @field_ids=GetPrimaryKeys($tablename);
183 my @ids=@$data{@field_ids};
184 my $dbh = C4::Context->dbh;
185 my ($keys,$values)=_filter_hash($tablename,$data,0);
186 return unless ($keys);
188 qq{ UPDATE $tablename
189 SET }.join(",",@$keys).qq{
190 WHERE }.join (" AND ",map{ "$_=?" }@field_ids);
191 $debug && warn $query, join(",",@$values,@ids);
193 my $sth = $dbh->prepare_cached($query);
195 eval{$result=$sth->execute(@$values,@ids)};
196 warn $@ if ($@ && $debug);
202 $status = &DeleteInTable($tablename,$data_hashref);
204 Delete Data in table and returns the status of the operation
209 my ($tablename,$data) = @_;
210 my $dbh = C4::Context->dbh;
211 my ($keys,$values)=_filter_fields($tablename,$data,1);
213 my $query = do { local $"=') AND (';
214 qq{ DELETE FROM $tablename WHERE (@$keys)};
216 $debug && warn $query, join(",",@$values);
217 my $sth = $dbh->prepare_cached($query);
219 eval{$result=$sth->execute(@$values)};
220 warn $@ if ($@ && $debug);
225 =head2 GetPrimaryKeys
227 @primarykeys = &GetPrimaryKeys($tablename)
229 Get the Primary Key field names of the table
233 sub GetPrimaryKeys($) {
235 my $hash_columns=_get_columns($tablename);
236 return grep { $hash_columns->{$_}->{'Key'} =~/PRI/i} keys %$hash_columns;
241 _get_columns($tablename)
244 Returns a hashref of all the fieldnames of the table
252 sub _get_columns($) {
254 my $dbh=C4::Context->dbh;
255 my $sth=$dbh->prepare_cached(qq{SHOW COLUMNS FROM $tablename });
257 my $columns= $sth->fetchall_hashref(qw(Field));
260 =head2 _filter_columns
262 _filter_columns($tablename,$research, $filtercolumns)
266 - indicator on purpose whether all fields should be returned or only non Primary keys
267 - array_ref to columns to limit to
269 Returns an array of all the fieldnames of the table
270 If it is not for research purpose, filter primary keys
274 sub _filter_columns ($$;$) {
275 my ($tablename,$research, $filtercolumns)=@_;
277 return (@$filtercolumns);
280 my $columns=_get_columns($tablename);
282 return keys %$columns;
285 return grep {my $column=$_; any {$_ ne $column }GetPrimaryKeys($tablename) } keys %$columns;
289 =head2 _filter_fields
295 - a string or a hashref (containing, fieldnames and datatofilter) or an arrayref to one of those elements
296 - an indicator of operation whether it is a wide research or a narrow one
297 - an array ref to columns to restrict string filter to.
299 Returns a ref of key array to use in SQL functions
300 and a ref to value array
305 my ($tablename,$filter_input,$searchtype,$filtercolumns)=@_;
308 if (ref($filter_input) eq "HASH"){
310 if (my $special = delete $filter_input->{''}) { # XXX destroyes '' key
311 ($keys, $values) = _filter_fields($tablename,$special, $searchtype,$filtercolumns);
313 my ($hkeys, $hvalues) = _filter_hash($tablename,$filter_input, $searchtype);
315 push @$keys, @$hkeys;
316 push @$values, @$hvalues;
319 my $stringkey="(".join (") AND (",@$keys).")";
320 return [$stringkey],$values;
325 } elsif (ref($filter_input) eq "ARRAY"){
326 foreach my $element_data (@$filter_input){
327 my ($localkeys,$localvalues)=_filter_fields($tablename,$element_data,$searchtype,$filtercolumns);
329 @$localkeys=grep{defined($_) && $_ !~/^\W*$/}@$localkeys;
335 push @values, @$localvalues;
340 $debug && warn "filterstring : $filter_input";
341 my ($keys, $values) = _filter_string($tablename,$filter_input, $searchtype,$filtercolumns);
343 my $stringkey="(".join (") AND (",@$keys).")";
344 return [$stringkey],$values;
351 return (\@keys,\@values);
355 my ($tablename,$filter_input, $searchtype)=@_;
357 my $columns= _get_columns($tablename);
358 my @columns_filtered= _filter_columns($tablename,$searchtype);
360 #Filter Primary Keys of table
361 my $elements=join "|",@columns_filtered;
362 foreach my $field (grep {/\b($elements)\b/} keys %$filter_input){
363 ## supposed to be a hash of simple values, hashes of arrays could be implemented
364 $filter_input->{$field}=format_date_in_iso($filter_input->{$field})
365 if $columns->{$field}{Type}=~/date/ &&
366 $filter_input->{$field} && $filter_input->{$field} !~C4::Dates->regexp("iso");
367 my ($tmpkeys, $localvalues)=_Process_Operands($filter_input->{$field},"$tablename.$field",$searchtype,$columns);
369 push @values, @$localvalues;
370 push @keys, @$tmpkeys;
374 return (\@keys,\@values);
382 my ($tablename,$filter_input, $searchtype,$filtercolumns)=@_;
383 return () unless($filter_input);
384 my @operands=split /\s+/,$filter_input;
386 # An act of desperation
387 $searchtype = 'contain' if @operands > 1 && $searchtype =~ /start_with/o;
389 my @columns_filtered= _filter_columns($tablename,$searchtype,$filtercolumns);
390 my $columns= _get_columns($tablename);
392 foreach my $operand (@operands){
394 foreach my $field (@columns_filtered){
395 my ($tmpkeys, $localvalues)=_Process_Operands($operand,"$tablename.$field",$searchtype,$columns);
397 push @values,@$localvalues;
398 push @localkeys,@$tmpkeys;
401 my $sql= join (' OR ', @localkeys);
406 return (\@keys,\@values);
412 sub _Process_Operands{
413 my ($operand, $field, $searchtype,$columns)=@_;
418 $operand = [$operand] unless ref $operand eq 'ARRAY';
419 foreach (@$operand) {
420 push @tmpkeys, " $field = ? ";
423 #By default, exact search
424 if (!$searchtype ||$searchtype eq "exact"){
425 return \@tmpkeys,\@values;
427 my $col_field=(index($field,".")>0?substr($field, index($field,".")+1):$field);
428 if ($field=~/(?<!zip)code|(?<!card)number/ && $searchtype ne "exact"){
429 push @tmpkeys,(" $field= '' ","$field IS NULL");
431 if ($columns->{$col_field}->{Type}=~/varchar|text/i){
432 my @localvaluesextended;
433 if ($searchtype eq "contain"){
434 foreach (@$operand) {
435 push @tmpkeys,(" $field LIKE ? ");
436 push @localvaluesextended,("\%$_\%") ;
439 if ($searchtype eq "field_start_with"){
440 foreach (@$operand) {
441 push @tmpkeys,("$field LIKE ?");
442 push @localvaluesextended, ("$_\%") ;
445 if ($searchtype eq "start_with"){
446 foreach (@$operand) {
447 push @tmpkeys,("$field LIKE ?","$field LIKE ?");
448 push @localvaluesextended, ("$_\%", " $_\%") ;
451 push @values,@localvaluesextended;
453 push @localkeys,qq{ (}.join(" OR ",@tmpkeys).qq{) };
454 return (\@localkeys,\@values);