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 with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
23 use List::MoreUtils qw(first_value any);
25 use C4::Dates qw(format_date_in_iso);
29 use vars qw($VERSION @ISA @EXPORT_OK %EXPORT_TAGS);
32 # set the version for version checking
43 %EXPORT_TAGS = ( all =>[qw( InsertInTable DeleteInTable SearchInTable UpdateInTable GetPrimaryKeys)]
52 C4::SQLHelper - Perl Module containing convenience functions for SQL Handling
60 This module contains routines for adding, modifying and Searching Data in MysqlDB
73 $hashref = &SearchInTable($tablename,$data, $orderby, $limit, $columns_out, $filtercolumns, $searchtype);
77 $tablename Name of the table (string)
80 - data_hashref : will be considered as an AND of all the data searched
81 - data_array_ref on hashrefs : Will be considered as an OR of Datahasref elements
83 $orderby is an arrayref of hashref with fieldnames as key and 0 or 1 as values (ASCENDING or DESCENDING order)
84 $limit is an array ref on 2 values
85 $columns_out is an array ref on field names is used to limit results on those fields (* by default)
86 $filtercolums is an array ref on field names : is used to limit expansion of research for strings
87 $searchtype is string Can be "wide" or "exact"
92 my ($tablename,$filters,$orderby, $limit, $columns_out, $filter_columns,$searchtype) = @_;
93 warn "searchtype : ",$searchtype;
94 # $searchtype||="start_with";
95 my $dbh = C4::Context->dbh;
97 my $sql = do { local $"=', ';
98 qq{ SELECT @$columns_out from $tablename}
102 my ($keys,$values)=_filter_fields($tablename,$filters,$searchtype,$filter_columns);
104 my @criteria=grep{defined($_) && $_ !~/^\W$/ }@$keys;
106 $sql.= do { local $"=') AND (';
107 qq{ WHERE (@criteria) }
112 #Order by desc by default
113 my @orders=map{ "$_".($$orderby{$_}? " DESC" : "") } keys %$orderby;
114 $sql.= do { local $"=', ';
115 qq{ ORDER BY @orders}
119 $sql.=qq{ LIMIT }.join(",",@$limit);
122 $debug && $values && warn $sql," ",join(",",@$values);
123 $sth = $dbh->prepare_cached($sql);
124 $sth->execute(@$values);
125 my $results = $sth->fetchall_arrayref( {} );
133 $data_id_in_table = &InsertInTable($tablename,$data_hashref);
138 and returns the id of the row inserted
142 my ($tablename,$data) = @_;
143 my $dbh = C4::Context->dbh;
144 my ($keys,$values)=_filter_hash($tablename,$data,0);
145 my $query = qq{ INSERT INTO $tablename SET }.join(", ",@$keys);
147 $debug && warn $query, join(",",@$values);
148 my $sth = $dbh->prepare_cached($query);
149 $sth->execute( @$values);
151 return $dbh->last_insert_id(undef, undef, $tablename, undef);
158 $status = &UpdateInTable($tablename,$data_hashref);
163 and returns the status of the operation
167 my ($tablename,$data) = @_;
168 my @field_ids=GetPrimaryKeys($tablename);
169 my @ids=@$data{@field_ids};
170 my $dbh = C4::Context->dbh;
171 my ($keys,$values)=_filter_hash($tablename,$data,0);
173 qq{ UPDATE $tablename
174 SET }.join(",",@$keys).qq{
175 WHERE }.join (" AND ",map{ "$_=?" }@field_ids);
176 $debug && warn $query, join(",",@$values,@ids);
178 my $sth = $dbh->prepare_cached($query);
179 return $sth->execute( @$values,@ids);
187 $status = &DeleteInTable($tablename,$data_hashref);
192 and returns the status of the operation
196 my ($tablename,$data) = @_;
197 my $dbh = C4::Context->dbh;
198 my ($keys,$values)=_filter_fields($tablename,$data,1);
200 my $query = do { local $"=') AND (';
201 qq{ DELETE FROM $tablename WHERE (@$keys)};
203 $debug && warn $query, join(",",@$values);
204 my $sth = $dbh->prepare_cached($query);
205 return $sth->execute( @$values);
209 =head2 GetPrimaryKeys
213 @primarykeys = &GetPrimaryKeys($tablename)
217 Get the Primary Key field names of the table
220 sub GetPrimaryKeys($) {
222 my $hash_columns=_get_columns($tablename);
223 return grep { $$hash_columns{$_}{'Key'} =~/PRI/i} keys %$hash_columns;
230 _get_columns($tablename)
235 Returns a hashref of all the fieldnames of the table
243 sub _get_columns($) {
245 my $dbh=C4::Context->dbh;
246 my $sth=$dbh->prepare_cached(qq{SHOW COLUMNS FROM $tablename });
248 my $columns= $sth->fetchall_hashref(qw(Field));
251 =head2 _filter_columns
255 _filter_columns($tablename,$research, $filtercolumns)
261 - indicator on purpose whether all fields should be returned or only non Primary keys
262 - array_ref to columns to limit to
264 Returns an array of all the fieldnames of the table
265 If it is not for research purpose, filter primary keys
269 sub _filter_columns ($$;$) {
270 my ($tablename,$research, $filtercolumns)=@_;
272 return (@$filtercolumns);
275 my $columns=_get_columns($tablename);
277 return keys %$columns;
280 return grep {my $column=$_; any {$_ ne $column }GetPrimaryKeys($tablename) } keys %$columns;
284 =head2 _filter_fields
294 - a string or a hashref (containing, fieldnames and datatofilter) or an arrayref to one of those elements
295 - an indicator of operation whether it is a wide research or a narrow one
296 - an array ref to columns to restrict string filter to.
298 Returns a ref of key array to use in SQL functions
299 and a ref to value array
304 my ($tablename,$filter_input,$searchtype,$filtercolumns)=@_;
307 if (ref($filter_input) eq "HASH"){
308 my ($keys, $values) = _filter_hash($tablename,$filter_input, $searchtype);
310 my $stringkey="(".join (") AND (",@$keys).")";
311 return [$stringkey],$values;
316 } elsif (ref($filter_input) eq "ARRAY"){
317 foreach my $element_data (@$filter_input){
318 my ($localkeys,$localvalues)=_filter_fields($tablename,$element_data,$searchtype,$filtercolumns);
320 @$localkeys=grep{defined($_) && $_ !~/^\W*$/}@$localkeys;
326 push @values, @$localvalues;
331 return _filter_string($tablename,$filter_input,$searchtype,$filtercolumns);
334 return (\@keys,\@values);
338 my ($tablename,$filter_input, $searchtype)=@_;
340 my $columns= _get_columns($tablename);
341 my @columns_filtered= _filter_columns($tablename,$searchtype);
343 #Filter Primary Keys of table
344 my $elements=join "|",@columns_filtered;
345 foreach my $field (grep {/\b($elements)\b/} keys %$filter_input){
346 ## supposed to be a hash of simple values, hashes of arrays could be implemented
347 $$filter_input{$field}=format_date_in_iso($$filter_input{$field}) if ($$columns{$field}{Type}=~/date/ && $$filter_input{$field} !~C4::Dates->regexp("iso"));
348 my ($tmpkeys, $localvalues)=_Process_Operands($$filter_input{$field},"$tablename.$field",$searchtype,$columns);
350 push @values, @$localvalues;
351 push @keys, @$tmpkeys;
355 return (\@keys,\@values);
363 my ($tablename,$filter_input, $searchtype,$filtercolumns)=@_;
364 return () unless($filter_input);
365 my @operands=split / /,$filter_input;
366 my @columns_filtered= _filter_columns($tablename,$searchtype,$filtercolumns);
367 my $columns= _get_columns($tablename);
370 foreach my $operand (@operands){
371 foreach my $field (@columns_filtered){
372 my ($tmpkeys, $localvalues)=_Process_Operands($operand,"$tablename.$field",$searchtype,$columns);
374 push @values,@$localvalues;
375 push @localkeys,@$tmpkeys;
379 my $sql= join (' OR ', @localkeys);
383 return (\@keys,\@values);
389 sub _Process_Operands{
390 my ($operand, $field, $searchtype,$columns)=@_;
394 push @tmpkeys, " $field = ? ";
395 push @values, $operand;
396 unless ($searchtype){
397 return \@tmpkeys,\@values;
399 if ($searchtype eq "start_with"){
400 my $col_field=(index($field,".")>0?substr($field, index($field,".")+1):$field);
401 if ($field=~/(?<!zip)code|(?<!card)number/ ){
402 push @tmpkeys,(" $field= '' ","$field IS NULL");
403 } elsif ($$columns{$col_field}{Type}=~/varchar|text/i){
405 push @tmpkeys,(" $field LIKE ? ","$field LIKE ?");
406 my @localvaluesextended=("\% $operand\%","$operand\%") ;
407 push @values,@localvaluesextended;
410 push @localkeys,qq{ (}.join(" OR ",@tmpkeys).qq{) };
411 return (\@localkeys,\@values);