/
LedgerSMB.pm
executable file
·1120 lines (908 loc) · 32.5 KB
/
LedgerSMB.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
=head1 NAME
LedgerSMB - The Base class for many LedgerSMB objects, including DBObject.
=head1 SYNOPSIS
This module creates a basic request handler with utility functions available
in database objects (LedgerSMB::DBObject)
=head1 METHODS
=over
=item new ()
This method creates a new base request instance. It also validates the
session/user credentials, as appropriate for the run mode. Finally, it sets up
the database connections for the user.
=item date_to_number (user => $LedgerSMB::User, date => $string);
This function takes the date in the format provided and returns a numeric
string in YYMMDD format. This may be moved to User in the future.
=item open_form()
This sets a $self->{form_id} to be used in later form validation (anti-XSRF
measure).
=item check_form()
This returns true if the form_id was associated with the session, and false if
not. Use this if the form may be re-used (back-button actions are valid).
=item close_form()
Identical with check_form() above, but also removes the form_id from the
session. This should be used when back-button actions are not valid.
=item debug (file => $path);
This dumps the current object to the file if that is defined and otherwise to
standard output.
=item escape (string => $string);
This function returns the current string escaped using %hexhex notation.
=item unescape (string => $string);
This function returns the $string encoded using %hexhex using ordinary notation.
=item format_amount (user => $LedgerSMB::User::hash, amount => $string, precision => $integer, neg_format => (-|DRCR));
The function takes a monetary amount and formats it according to the user
preferences, the negative format (- or DR/CR). Note that it may move to
LedgerSMB::User at some point in the future.
=item parse_amount (user => $LedgerSMB::User::hash, amount => $variable);
If $amount is a Bigfloat, it is returned as is. If it is a string, it is
parsed according to the user preferences stored in the LedgerSMB::User object.
=item is_blank (name => $string)
This function returns true if $self->{$string} only consists of whitespace
characters or is an empty string.
=item is_run_mode ('(cli|cgi|mod_perl)')
This function returns 1 if the run mode is what is specified. Otherwise
returns 0.
=item is_allowed_role({allowed_roles => @role_names})
This function returns 1 if the user's roles include any of the roles in
@role_names.
=item num_text_rows (string => $string, cols => $number, max => $number);
This function determines the likely number of rows needed to hold text in a
textbox. It returns either that number or max, which ever is lower.
=item merge ($hashref, keys => @list, index => $number);
This command merges the $hashref into the current object. If keys are
specified, only those keys are used. Otherwise all keys are merged.
If an index is specified, the merged keys are given a form of
"$key" . "_$index", otherwise the key is used on both sides.
=item redirect (msg => $string)
This function redirects to the script and argument set determined by
$self->{callback}, and if this is not set, goes to an info screen and prints
$msg.
=item redo_rows (fields => \@list, count => $integer, [index => $string);
This function is undergoing serious redesign at the moment. If index is
defined, that field is used for ordering the rows. If not, runningnumber is
used. Behavior is not defined when index points to a field containing
non-numbers.
=item set (@attrs)
Copies the given key=>vars to $self. Allows for finer control of
merging hashes into self.
=item remove_cgi_globals()
Removes all elements starting with a . because these elements conflict with the
ability to hide the entire structure for things like CSV lookups.
=item get_default_value_by_key($key)
Retrieves a default value for the given key, it is just a wrapper on LedgerSMB::Setting;
=item call_procedure( procname => $procname, args => $args )
Function that allows you to call a stored procedure by name and map the appropriate argument to the function values.
Args is an arrayref. The members of args can be scalars or arrayrefs in which
case they are just bound to the placeholders (arrayref to Pg array conversion
occurs automatically in DBD::Pg 2.x), or they can be hashrefs of the following
syntax: {value => $data, type=> $db_type}. The type field is any SQL type
DBD::Pg supports (such as 'PG_BYTEA').
=item dberror()
Localizes and returns database errors and error codes within LedgerSMB
=item error()
Returns HTML errors in LedgerSMB. Needs refactored into a general Error class.
=item get_user_info()
Loads user configuration info from LedgerSMB::User
=item round_amount()
Uses Math::Float with an amount and a set number of decimal places to round the amount and return it.
Defaults to the default decimal places setting in the LedgerSMB configuration if there is no places argument passed in.
They should be changed to allow different rules for different accounts.
=item sanitize_for_display()
Expands a hash into human-readable key => value pairs, and formats and rounds amounts, recursively expanding hashes until there are no hash members present.
=item take_top_level()
Removes blank keys and non-reference keys from a hash and returns a hash with only non-blank and referenced keys.
=item type()
Ensures that the $ENV{REQUEST_METHOD} is defined and either "HEAD", "GET", "POST".
=item finalize_request()
This function throws a CancelFurtherProcessing exception to be caught
by the outermost processing script. This construct allows the outer
script and intermediate levels to clean up, if required.
This construct replaces 'exit;' calls randomly scattered
around the code everywhere.
=cut
=back
=head1 Copyright (C) 2006, The LedgerSMB core team.
# This work contains copyrighted information from a number of sources
# all used with permission.
#
# This file contains source code included with or based on SQL-Ledger
# which is Copyright Dieter Simader and DWS Systems Inc. 2000-2005
# and licensed under the GNU General Public License version 2 or, at
# your option, any later version. For a full list including contact
# information of contributors, maintainers, and copyright holders,
# see the CONTRIBUTORS file.
#
# Original Copyright Notice from SQL-Ledger 2.6.17 (before the fork):
# Copyright (C) 2000
#
# Author: DWS Systems Inc.
# Web: http://www.sql-ledger.org
#
# Contributors: Thomas Bayen <bayen@gmx.de>
# Antti Kaihola <akaihola@siba.fi>
# Moritz Bunkus (tex)
# Jim Rawlings <jim@your-dba.com> (DB2)
#====================================================================
=cut
use CGI::Simple;
$CGI::Simple::DISABLE_UPLOADS = 0;
use LedgerSMB::PGNumber;
use LedgerSMB::PGDate;
use LedgerSMB::Sysconfig;
use Data::Dumper;
use Error;
use LedgerSMB::App_State;
use LedgerSMB::Auth;
use LedgerSMB::Session;
use LedgerSMB::CancelFurtherProcessing;
use LedgerSMB::Template;
use LedgerSMB::Locale;
use LedgerSMB::User;
use LedgerSMB::Setting;
use LedgerSMB::Company_Config;
use strict;
use utf8;
$CGI::Simple::POST_MAX = -1;
package LedgerSMB;
our $VERSION = '1.3.999';
my $logger = Log::Log4perl->get_logger('LedgerSMB');
sub new {
#my $type = "" unless defined shift @_;
#my $argstr = "" unless defined shift @_;
(my $package,my $filename,my $line)=caller;
my $type = shift @_;
my $argstr = shift @_;
my %cookie;
my $self = {};
$type = "" unless defined $type;
$argstr = "" unless defined $argstr;
$logger->debug("Begin called from \$filename=$filename \$line=$line \$type=$type \$argstr=$argstr ref argstr=".ref $argstr);
$self->{version} = $VERSION;
$self->{dbversion} = "1.3.999";
bless $self, $type;
my $query;
my %params=();
if(ref($argstr) eq 'DBI::db')
{
$self->{dbh}=$argstr;
$logger->info("setting dbh from argstr \$self->{dbh}=$self->{dbh}");
}
else
{
$query = ($argstr) ? new CGI::Simple($argstr) : new CGI::Simple;
# my $params = $query->Vars; returns a tied hash with keys that
# are not parameters of the CGI query.
%params = $query->Vars;
for my $p(keys %params){
utf8::decode($params{$p});
utf8::upgrade($params{$p});
}
$logger->debug("params=", Data::Dumper::Dumper(\%params));
}
$self->{VERSION} = $VERSION;
$self->{_request} = $query;
$self->merge(\%params);
$self->{have_latex} = $LedgerSMB::Sysconfig::latex;
# Adding this so that empty values are stored in the db as NULL's. If
# stored procedures want to handle them differently, they must opt to do so.
# -- CT
for (keys %$self){
if ($self->{$_} eq ''){
$self->{$_} = undef;
}
}
if ($self->is_run_mode('cgi', 'mod_perl')) {
$ENV{HTTP_COOKIE} =~ s/;\s*/;/g;
my @cookies = split /;/, $ENV{HTTP_COOKIE};
foreach (@cookies) {
my ( $name, $value ) = split /=/, $_, 2;
$cookie{$name} = $value;
}
}
#HV set _locale already to default here,so routines lower in stack can use it;e.g. login.pl
$self->{_locale}=LedgerSMB::Locale->get_handle(${LedgerSMB::Sysconfig::language})
or $self->error( __FILE__ . ':' . __LINE__ .": Locale not loaded: $!\n" );
$self->{action} = "" unless defined $self->{action};
$self->{action} =~ s/\W/_/g;
$self->{action} = lc $self->{action};
$self->{path} = "" unless defined $self->{path};
if ( $self->{path} eq "bin/lynx" ) {
$self->{menubar} = 1;
# Applying the path is deprecated. Use menubar instead. CT.
$self->{lynx} = 1;
$self->{path} = "bin/lynx";
}
else {
$self->{path} = "bin/mozilla";
}
$ENV{SCRIPT_NAME} = "" unless defined $ENV{SCRIPT_NAME};
$ENV{SCRIPT_NAME} =~ m/([^\/\\]*.pl)\?*.*$/;
$self->{script} = $1 unless !defined $1;
$self->{script} = "" unless defined $self->{script};
if ( ( $self->{script} =~ m#(\.\.|\\|/)# ) ) {
$self->error("Access Denied");
}
if (!$self->{script}) {
$self->{script} = 'login.pl';
}
$logger->debug("\$self->{script} = $self->{script} \$self->{action} = $self->{action}");
# if ($self->{action} eq 'migrate_user'){
# return $self;
# }
# This is suboptimal. We need to have a better way for 1.4
#HV we should try to have DBI->connect in one place?
#HV why not trying _db_init also in case of login authenticate? quid logout-function?
if ($self->{script} eq 'login.pl' &&
($self->{action} eq 'authenticate' || $self->{action} eq '__default'
|| !$self->{action})){
return $self;
}
if ($self->{script} eq 'setup.pl'){
return $self;
}
my $ccookie;
if (!$self->{company} && $self->is_run_mode('cgi', 'mod_perl')){
$ccookie = $cookie{${LedgerSMB::Sysconfig::cookie_name}};
$ccookie =~ s/.*:([^:]*)$/$1/;
if($ccookie ne 'Login') { $self->{company} = $ccookie; }
}
$logger->debug("\$ccookie=$ccookie cookie.LedgerSMB::Sysconfig::cookie_name=".$cookie{${LedgerSMB::Sysconfig::cookie_name}}." \$self->{company}=$self->{company}");
if(! $cookie{${LedgerSMB::Sysconfig::cookie_name}} && $self->{action} eq 'logout')
{
$logger->debug("quitting because of logout and no cookie,avoid _db_init");
return $self;
}
#dbh may have been set elsewhere,by DBObject.pm?
if(!$self->{dbh})
{
$self->_db_init;
}
LedgerSMB::Company_Config::initialize($self);
#TODO move before _db_init to avoid _db_init with invalid session?
# Can't do that: Company_Config has to pull company data from the db --CT
if ($self->is_run_mode('cgi', 'mod_perl') and !$ENV{LSMB_NOHEAD}) {
#check for valid session unless this is an inital authentication
#request -- CT
if (!LedgerSMB::Session::check( $cookie{${LedgerSMB::Sysconfig::cookie_name}}, $self) ) {
$logger->error("Session did not check");
$self->_get_password("Session Expired");
exit;
}
$logger->debug("session_check completed OK \$self->{session_id}=$self->{session_id} caller=\$filename=$filename \$line=$line");
}
$self->get_user_info;
my %date_setting = (
'mm/dd/yy' => "SQL, US",
'mm-dd-yy' => "POSTGRES, US",
'dd/mm/yy' => "SQL, EUROPEAN",
'dd-mm-yy' => "POSTGRES, EUROPEAN",
'dd.mm.yy' => "GERMAN",
);
$self->{dbh}->do("set DateStyle to '".$date_setting{$self->{_user}->{dateformat}}."'");
#my $locale = LedgerSMB::Locale->get_handle($self->{_user}->{language})
# or $self->error(__FILE__.':'.__LINE__.": Locale not loaded: $!\n");
#$self->{_locale} = $locale;
$self->{_locale}=LedgerSMB::Locale->get_handle($self->{_user}->{language})
or $self->error(__FILE__.':'.__LINE__.": Locale not loaded: $!\n");
$self->{stylesheet} = $self->{_user}->{stylesheet};
$logger->debug("End");
return $self;
}
sub open_form {
my ($self, $args) = @_;
if (!$ENV{GATEWAY_INTERFACE}){
return 1;
}
my @vars = $self->call_procedure(procname => 'form_open',
args => [$self->{session_id}],
continue_on_error => 1
);
if ($args->{commit}){
$self->{dbh}->commit;
}
$self->{form_id} = $vars[0]->{form_open};
}
sub check_form {
my ($self) = @_;
if (!$ENV{GATEWAY_INTERFACE}){
return 1;
}
my @vars = $self->call_procedure(procname => 'form_check',
args => [$self->{session_id}, $self->{form_id}]
);
return $vars[0]->{form_check};
}
sub close_form {
my ($self) = @_;
if (!$ENV{GATEWAY_INTERFACE}){
return 1;
}
my @vars = $self->call_procedure(procname => 'form_close',
args => [$self->{session_id}, $self->{form_id}]
);
delete $self->{form_id};
return $vars[0]->{form_close};
}
sub get_user_info {
my ($self) = @_;
$self->{_user} = LedgerSMB::User->fetch_config($self);
}
#This function needs to be moved into the session handler.
sub _get_password {
my ($self) = shift @_;
$self->{sessionexpired} = shift @_;
LedgerSMB::Auth::credential_prompt();
exit;
}
sub debug {
my $self = shift @_;
my $args = shift @_;
my $file;
if (scalar keys %$args){
$file = $args->{'file'};
}
my $d = Data::Dumper->new( [$self] );
$d->Sortkeys(1);
if ($file) {
open( FH, '>', "$file" ) or die $!;
print FH $d->Dump();
close(FH);
}
else {
print "\n";
print $d->Dump();
}
}
sub escape {
my $self = shift;
my %args = @_;
my $str = $args{string};
$str = "" unless defined $str;
my $regex = qr/([^a-zA-Z0-9_.-])/;
$str =~ s/$regex/sprintf("%%%02x", ord($1))/ge;
return $str;
}
sub is_blank {
my $self = shift @_;
my %args = @_;
my $name = $args{name};
my $rc;
if (not defined $name){
$self->{_locale} = LedgerSMB::Locale->get_handle('en') unless defined $self->{_locale};
$self->error($self->{_locale}->text('Field \"Name\" Not Defined'));
}
if ( $self->{$name} =~ /^\s*$/ ) {
$rc = 1;
}
else {
$rc = 0;
}
$rc;
}
sub is_run_mode {
my $self = shift @_;
#avoid 'uninitialized' warnings in tests
my $mode = shift @_;
my $rc = 0;
if(! $mode){return $rc;}
$mode=lc $mode;
if ( $mode eq 'cgi' && $ENV{GATEWAY_INTERFACE} ) {
$rc = 1;
}
elsif ( $mode eq 'cli' && !( $ENV{GATEWAY_INTERFACE} || $ENV{MOD_PERL} ) ) {
$rc = 1;
}
elsif ( $mode eq 'mod_perl' && $ENV{MOD_PERL} ) {
$rc = 1;
}
$rc;
}
sub num_text_rows {
my $self = shift @_;
my %args = @_;
my $string = $args{string};
my $cols = $args{cols};
my $maxrows = $args{max};
my $rows = 0;
for ( split /\n/, $string ) {
my $line = $_;
while ( length($line) > $cols ) {
my $fragment = substr( $line, 0, $cols + 1 );
$fragment =~ s/^(.*)\W.*$/$1/;
$line =~ s/$fragment//;
if ( $line eq $fragment ) { # No word breaks!
$line = "";
}
++$rows;
}
++$rows;
}
if ( !defined $maxrows ) {
$maxrows = $rows;
}
return ( $rows > $maxrows ) ? $maxrows : $rows;
}
sub redirect {
my $self = shift @_;
my %args = @_;
my $msg = $args{msg};
if ( $self->{callback} || !$msg ) {
main::redirect();
exit;
}
else {
$self->info($msg);
}
}
# TODO: Either we should have an amount class with formats and such attached
# Or maybe we should move this into the user class...
sub format_amount {
# Based on SQL-Ledger's Form::format_amount
my $self = shift @_;
my %args = (ref($_[0]) eq 'HASH')? %{$_[0]}: @_;
my $myconfig = $args{user} || $self->{_user};
my $amount = $args{amount};
my $places = $args{precision};
my $dash = $args{neg_format};
my $format = $args{format};
if (defined $amount and ! UNIVERSAL::isa($amount, 'LedgerSMB::PGNumber' )) {
$amount = $self->parse_amount('user' => $myconfig, 'amount' => $amount);
}
$dash = undef unless defined $dash;
if (!defined $format){
$format = $myconfig->{numberformat}
}
if (!defined $amount){
return undef;
}
if (!defined $args{precision} and defined $args{money}){
$places = $LedgerSMB::Sysconfig::decimal_places;
}
return $amount->to_output({format => $format,
neg_format => $args{neg_format},
places => $places,
money => $args{money},
});
}
# For backwards compatibility only
sub parse_amount {
my $self = shift @_;
my %args = @_;
my $amount = $args{amount};
my $user = ($args{user})? ($args{user}) : $self->{_user};
if (UNIVERSAL::isa($amount, 'LedgerSMB::PGNumber')){
return $amount;
}
return LedgerSMB::PGNumber->from_input($amount,
{format => $user->{numberformat}}
);
}
sub round_amount {
my ( $self, $amount, $places ) = @_;
#
# We will grab the default value, if it isnt defined
#
if (!defined $places){
$places = ${LedgerSMB::Sysconfig::decimal_places};
}
# These rounding rules follow from the previous implementation.
# They should be changed to allow different rules for different accounts.
if ($amount >= 0) {
Math::BigFloat->round_mode('+inf');
}
else {
Math::BigFloat->round_mode('-inf');
}
if ($places >= 0) {
$amount = Math::BigFloat->new($amount)->ffround( -$places );
}
else {
$amount = Math::BigFloat->new($amount)->ffround( -( $places - 1 ) );
}
$amount->precision(undef);
return $amount;
}
sub call_procedure {
my $self = shift @_;
my %args = @_;
my $procname = $args{procname};
my $schema = $args{schema};
my @call_args;
@call_args = @{ $args{args} } if defined $args{args};
my $order_by = $args{order_by};
my $query_rc;
my $argstr = "";
my @results;
my $dbh = $LedgerSMB::App_State::DBH;
die 'Database handle not found!' if !$dbh;
if (!defined $procname){
$self->error('Undefined function in call_procedure.');
}
$procname = $dbh->quote_identifier($procname);
# Add the test for whether the schema is something useful.
$logger->trace("\$procname=$procname");
$schema = $schema || $LedgerSMB::Sysconfig::db_namespace;
$schema = $dbh->quote_identifier($schema);
for my $arg ( @call_args ) {
if (eval { $arg->can('to_db') }){
$arg = $arg->to_db;
}
$argstr .= "?, ";
}
$argstr =~ s/\, $//;
my $query = "SELECT * FROM $schema.$procname()";
if ($order_by){
$query .= " ORDER BY $order_by";
}
$query =~ s/\(\)/($argstr)/;
my $sth = $dbh->prepare($query);
my $place = 1;
# API Change here to support byteas:
# If the argument is a hashref, allow it to define it's SQL type
# for example PG_BYTEA, and use that to bind. The API supports the old
# syntax (array of scalars and arrayrefs) but extends this so that hashrefs
# now have special meaning. I expect this to be somewhat recursive in the
# future if hashrefs to complex types are added, but we will have to put
# that off for another day. --CT
foreach my $carg (@call_args){
if (ref($carg) eq 'HASH'){
$sth->bind_param($place, $carg->{value},
{ pg_type => $carg->{type} });
} else {
$sth->bind_param($place, $carg);
}
++$place;
}
$query_rc = $sth->execute();
if (!$query_rc){
if ($args{continue_on_error} and # only for plpgsql exceptions
($dbh->state =~ /^P/)){
$@ = $dbh->errstr;
} else {
$self->dberror($dbh->errstr . ": " . $query);
}
}
my @types = @{$sth->{TYPE}};
my @names = @{$sth->{NAME_lc}};
while ( my $ref = $sth->fetchrow_hashref('NAME_lc') ) {
for (0 .. $#names){
# numeric float4/real
if ($types[$_] == 3 or $types[$_] == 2) {
$ref->{$names[$_]} = LedgerSMB::PGNumber->from_db($ref->{$names[$_]}, 'datetime') if defined $ref->{$names[$_]};
}
# DATE TIMESTAMP
if ($types[$_] == 91 or $types[$_] == 11){
$ref->{$names[$_]} = LedgerSMB::PGDate->from_db($ref->{$names[$_]}, 'date') if defined $ref->{$names[$_]};
}
}
push @results, $ref;
}
return @results;
}
# Keeping this here due to common requirements
sub is_allowed_role {
my ($self, $args) = @_;
my @roles = @{$args->{allowed_roles}};
for my $role (@roles){
$self->{_role_prefix} = "lsmb_$self->{company}__" unless defined $self->{_role_prefix};
my @roleset = grep m/^$self->{_role_prefix}$role$/, @{$self->{_roles}};
if (scalar @roleset){
return 1;
}
}
return 0;
}
# This should probably be moved to User too...
sub date_to_number {
#based on SQL-Ledger's Form::datetonum
my $self = shift @_;
my %args = @_;
my $myconfig = $args{user};
my $date = $args{date};
$date = "" unless defined $date;
my ( $yy, $mm, $dd );
if ( $date ne "" && $date && $date =~ /\D/ ) {
if ( $date =~ /^\d{4}-\d\d-\d\d$/ ) {
( $yy, $mm, $dd ) = split /\D/, $date;
} elsif ( $myconfig->{dateformat} =~ /^yy/ ) {
( $yy, $mm, $dd ) = split /\D/, $date;
} elsif ( $myconfig->{dateformat} =~ /^mm/ ) {
( $mm, $dd, $yy ) = split /\D/, $date;
} elsif ( $myconfig->{dateformat} =~ /^dd/ ) {
( $dd, $mm, $yy ) = split /\D/, $date;
}
$dd *= 1;
$mm *= 1;
$yy += 2000 if length $yy == 2;
$dd = substr( "0$dd", -2 );
$mm = substr( "0$mm", -2 );
$date = "$yy$mm$dd";
}
$date;
}
sub sanitize_for_display {
my $self = shift;
my $var = shift;
$self->error('Untested API');
if (!$var){
$var = $self;
}
for my $k (keys %$var){
my $type = ref($var);
if (UNIVERSAL::isa($var->{$k}, 'Math::BigFloat')){
$var->{$k} =
$self->format_amount({amount => $var->{$k}});
}
elsif ($type == 'HASH'){
$self->sanitize_for_display($var->{$k});
}
}
}
sub finalize_request {
$logger->debug("throwing CancelFurtherProcessing()");#if trying to follow flow of request
throw CancelFurtherProcessing();
}
# To be replaced with a generic interface to an Error class
sub error {
my ( $self, $msg ) = @_;
if ( $ENV{GATEWAY_INTERFACE} ) {
$self->{msg} = $msg;
$self->{format} = "html";
$logger->error($msg);
$logger->error("dbversion: $self->{dbversion}, company: $self->{company}");
delete $self->{pre};
print qq|Content-Type: text/html; charset=utf-8\n\n|;
print "<head><link rel='stylesheet' href='css/$self->{_user}->{stylesheet}' type='text/css'></head>";
$self->{msg} =~ s/\n/<br \/>\n/;
print
qq|<body><h2 class="error">Error!</h2> <p><b>$self->{msg}</b></p>
<p>dbversion: $self->{dbversion}, company: $self->{company}</p>
</body>|;
exit;
}
else {
if ( $ENV{error_function} ) {
&{ $ENV{error_function} }($msg);
}
die "Error: $msg\n";
}
}
# Database routines used throughout
sub _db_init {
my $self = shift @_;
my %args = @_;
(my $package,my $filename,my $line)=caller;
if($self->{dbh})
{
$logger->error("dbh already set \$self->{dbh}=$self->{dbh},called from $filename");
}
my $creds = LedgerSMB::Auth::get_credentials();
$self->{login} = $creds->{login};
if (!$self->{company}){
$self->{company} = $LedgerSMB::Sysconfig::default_db;
}
my $dbname = $self->{company};
# Note that we have to request the login/password again if the db
# connection fails since this probably means bad credentials are entered.
# Just in case, however, I think it is a good idea to include the DBI
# error string. CT
$self->{dbh} = DBI->connect(
"dbi:Pg:dbname=$dbname", "$creds->{login}", "$creds->{password}", { AutoCommit => 0 }
);
$logger->debug("DBI->connect dbh=$self->{dbh}");
my $dbi_trace=$LedgerSMB::Sysconfig::DBI_TRACE;
if($dbi_trace)
{
$logger->debug("\$dbi_trace=$dbi_trace");
$self->{dbh}->trace(split /=/,$dbi_trace,2);#http://search.cpan.org/~timb/DBI-1.616/DBI.pm#TRACING
}
if (($self->{script} eq 'login.pl') && ($self->{action} eq
'authenticate')){
if (!$self->{dbh}){
$self->{_auth_error} = $DBI::errstr;
}
return;
}
elsif (!$self->{dbh}){
$self->_get_password;
}
$self->{dbh}->{pg_server_prepare} = 0;
$self->{dbh}->{pg_enable_utf8} = 1;
$LedgerSMB::App_State::DBH = $self->{dbh};
$LedgerSMB::App_State::DBName = $dbname;
# This is the general version check
my $sth = $self->{dbh}->prepare("
SELECT value FROM defaults
WHERE setting_key = 'version'");
$sth->execute;
my ($dbversion) = $sth->fetchrow_array;
$sth = $self->{dbh}->prepare("
SELECT value FROM defaults
WHERE setting_key = 'role_prefix'");
$sth->execute;
($self->{_role_prefix}) = $sth->fetchrow_array;
if ($dbversion ne $self->{dbversion}){
$self->error("Database is not the expected version. Was $dbversion, expected $self->{dbversion}. Please re-run setup.pl against this database to correct.<a href='setup.pl'>setup.pl</a>");
}
$sth = $self->{dbh}->prepare('SELECT check_expiration()');
$sth->execute;
($self->{warn_expire}) = $sth->fetchrow_array;
if ($self->{warn_expire}){
$sth = $self->{dbh}->prepare('SELECT user__check_my_expiration()');
$sth->execute;
($self->{pw_expires}) = $sth->fetchrow_array;
}
my $query = "SELECT t.extends,
coalesce (t.table_name, 'custom_' || extends)
|| ':' || f.field_name as field_def
FROM custom_table_catalog t
JOIN custom_field_catalog f USING (table_id)";
$sth = $self->{dbh}->prepare($query);
$sth->execute;
my $ref;
$self->{custom_db_fields} = {};
while ( $ref = $sth->fetchrow_hashref('NAME_lc') ) {
push @{ $self->{custom_db_fields}->{ $ref->{extends} } },
$ref->{field_def};
}
# Adding role list to self
$self->{_roles} = [];
$query = "select rolname from pg_roles
where pg_has_role(SESSION_USER, 'USAGE')";
$sth = $self->{dbh}->prepare($query);
$sth->execute();
while (my @roles = $sth->fetchrow_array){
push @{$self->{_roles}}, $roles[0];
}
$LedgerSMB::App_State::Roles = @{$self->{_roles}};
$LedgerSMB::App_State::Role_Prefix = $self->{_role_prefix};
# @{$self->{_roles}} will eventually go away. --CT
$sth->finish();
$logger->debug("end");
}
#private, for db connection errors
sub _on_connection_error {
for (@_){
$logger->error("$_");
}
}
sub dberror{
my $self = shift @_;
my $state_error = {};
my $locale = $LedgerSMB::App_State::Locale;
my $dbh = $LedgerSMB::App_State::DBH;
$state_error = {
'42883' => $locale->text('Internal Database Error'),
'42501' => $locale->text('Access Denied'),
'42401' => $locale->text('Access Denied'),
'22008' => $locale->text('Invalid date/time entered'),
'22012' => $locale->text('Division by 0 error'),
'22004' => $locale->text('Required input not provided'),
'23502' => $locale->text('Required input not provided'),
'23505' => $locale->text('Conflict with Existing Data. Perhaps you already entered this?'),
'P0001' => $locale->text('Error from Function:') . "\n" .
$dbh->errstr,
};
$logger->error("Logging SQL State ".$dbh->state.", error ".
$dbh->err . ", string " .$dbh->errstr);
if (defined $state_error->{$dbh->state}){
die $state_error->{$dbh->state}
. "\n" .
$locale->text('More information has been reported in the error logs');
$dbh->rollback;
exit;
}
die $dbh->state . ":" . $dbh->errstr;
}
sub redo_rows {
my $self = shift @_;
my %args = @_;
my @flds = @{ $args{fields} };
my $count = $args{count};
my $index = ( $args{index} ) ? $args{index} : 'runningnumber';
my @rows;
my $i; # increment counter use only
for $i ( 1 .. $count ) {
my $temphash = { _inc => $i };
for my $fld (@flds) {