-
Notifications
You must be signed in to change notification settings - Fork 6
/
LedgerSMB.pm
executable file
·591 lines (474 loc) · 15.3 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
=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
=item new ()
This method creates a new base request instance.
=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 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. Currently it returns 1 when this is not found as well but when
role permissions are introduced, this will change to 0.
=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.
=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;
use Math::BigFloat lib => 'GMP';
use LedgerSMB::Sysconfig;
use Data::Dumper;
use strict;
package LedgerSMB;
sub new {
my $type = shift @_;
my $argstr = shift @_;
my $self = {};
$self->{version} = "1.3.0 Alpha 0 Pre";
$self->{dbversion} = "1.2.0";
bless $self, $type;
my $query = ($argstr) ? new CGI($argstr) : new CGI;
my $params = $query->Vars;
$self->merge($params);
$self->{action} =~ s/\W/_/g;
$self->{action} = lc $self->{action};
if ( $self->{path} eq "bin/lynx" ) {
$self->{menubar} = 1;
#menubar will be deprecated, replaced with below
$self->{lynx} = 1;
$self->{path} = "bin/lynx";
}
else {
$self->{path} = "bin/mozilla";
}
if ( ( $self->{script} =~ m#(..|\\|/)# ) ) {
$self->error("Access Denied");
}
$self;
}
sub debug {
my $self = shift @_;
my %args = @_;
my $file = $args{file};
my $d = Data::Dumper->new( [@_] );
$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) = @_;
my %args = @_;
my $str = $args{string};
my $regex = qr/([^a-zA-Z0-9_.-])/;
$str =~ s/$regex/sprintf("%%%02x", ord($1))/ge;
$str;
}
sub is_blank {
my $self = shift @_;
my %args = @_;
my $name = $args{name};
my $rc;
if ( $self->{$name} =~ /^\s*$/ ) {
$rc = 1;
}
else {
$rc = 0;
}
$rc;
}
sub is_run_mode {
my $self = shift @_;
my $mode = lc shift @_;
my $rc = 0;
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 );
my $fragment = s/^(.*)\S*$/$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();
}
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 = @_;
my $myconfig = $args{user};
my $amount = $args{amount};
my $places = $args{precision};
my $dash = $args{neg_format};
my $negative;
if ($amount) {
$amount = $self->parse_amount( $myconfig, $amount );
$negative = ( $amount < 0 );
$amount =~ s/-//;
}
if ( $places =~ /\d+/ ) {
#$places = 4 if $places == 2;
$amount = $self->round_amount( $amount, $places );
}
# is the amount negative
# Parse $myconfig->{numberformat}
my ( $ts, $ds ) = ( $1, $2 );
if ($amount) {
if ( $myconfig->{numberformat} ) {
my ( $whole, $dec ) = split /\./, "$amount";
$amount = join '', reverse split //, $whole;
if ($places) {
$dec .= "0" x $places;
$dec = substr( $dec, 0, $places );
}
if ( $myconfig->{numberformat} eq '1,000.00' ) {
$amount =~ s/\d{3,}?/$&,/g;
$amount =~ s/,$//;
$amount = join '', reverse split //, $amount;
$amount .= "\.$dec" if ( $dec ne "" );
}
if ( $myconfig->{numberformat} eq '1 000.00' ) {
$amount =~ s/\d{3,}?/$& /g;
$amount =~ s/\s$//;
$amount = join '', reverse split //, $amount;
$amount .= "\.$dec" if ( $dec ne "" );
}
if ( $myconfig->{numberformat} eq "1'000.00" ) {
$amount =~ s/\d{3,}?/$&'/g;
$amount =~ s/'$//;
$amount = join '', reverse split //, $amount;
$amount .= "\.$dec" if ( $dec ne "" );
}
if ( $myconfig->{numberformat} eq '1.000,00' ) {
$amount =~ s/\d{3,}?/$&./g;
$amount =~ s/\.$//;
$amount = join '', reverse split //, $amount;
$amount .= ",$dec" if ( $dec ne "" );
}
if ( $myconfig->{numberformat} eq '1000,00' ) {
$amount = "$whole";
$amount .= ",$dec" if ( $dec ne "" );
}
if ( $myconfig->{numberformat} eq '1000.00' ) {
$amount = "$whole";
$amount .= ".$dec" if ( $dec ne "" );
}
if ( $dash =~ /-/ ) {
$amount = ($negative) ? "($amount)" : "$amount";
}
elsif ( $dash =~ /DRCR/ ) {
$amount = ($negative) ? "$amount DR" : "$amount CR";
}
else {
$amount = ($negative) ? "-$amount" : "$amount";
}
}
}
else {
if ( $dash eq "0" && $places ) {
if ( $myconfig->{numberformat} eq '1.000,00' ) {
$amount = "0" . "," . "0" x $places;
}
else {
$amount = "0" . "." . "0" x $places;
}
}
else {
$amount = ( $dash ne "" ) ? "$dash" : "";
}
}
$amount;
}
# This should probably go to the User object too.
sub parse_amount {
my $self = shift @_;
my %args = @_;
my $myconfig = $args{user};
my $amount = $args{amount};
if ( $amount eq '' or $amount == undef ) {
return 0;
}
if ( UNIVERSAL::isa( $amount, 'Math::BigFloat' ) )
{ # Amount may not be an object
return $amount;
}
my $numberformat = $myconfig->{numberformat};
if ( ( $numberformat eq '1.000,00' )
|| ( $numberformat eq '1000,00' ) )
{
$amount =~ s/\.//g;
$amount =~ s/,/./;
}
if ( $numberformat eq '1 000.00' ) {
$amount =~ s/\s//g;
}
if ( $numberformat eq "1'000.00" ) {
$amount =~ s/'//g;
}
$amount =~ s/,//g;
if ( $amount =~ s/\((\d*\.?\d*)\)/$1/ ) {
$amount = $1 * -1;
}
if ( $amount =~ s/(\d*\.?\d*)\s?DR/$1/ ) {
$amount = $1 * -1;
}
$amount =~ s/\s?CR//;
$amount = new Math::BigFloat($amount);
return ( $amount * 1 );
}
sub round_amount {
my ( $self, $amount, $places ) = @_;
# These rounding rules follow from the previous implementation.
# They should be changed to allow different rules for different accounts.
Math::BigFloat->round_mode('+inf') if $amount >= 0;
Math::BigFloat->round_mode('-inf') if $amount < 0;
$amount = Math::BigFloat->new($amount)->ffround( -$places ) if $places >= 0;
$amount = Math::BigFloat->new($amount)->ffround( -( $places - 1 ) )
if $places < 0;
return $amount;
}
sub call_procedure {
my $self = shift @_;
my %args = @_;
my $procname = $args{procname};
my @args = @{ $args{args} };
my $order_by = $args{order_by};
my $argstr = "";
my @results;
for ( 1 .. scalar @args ) {
$argstr .= "?, ";
}
$argstr =~ s/\, $//;
my $query = "SELECT * FROM $procname()";
if ($order_by){
$query .= " ORDER BY $order_by";
}
$query =~ s/\(\)/($argstr)/;
my $sth = $self->{dbh}->prepare($query);
$sth->execute(@args);
my @types = @{$sth->{TYPE}};
my @names = @{$sth->{NAME_lc}};
while ( my $ref = $sth->fetchrow_hashref('NAME_lc') ) {
for (0 .. $#names){
if ($types[$_] == 3){
$ref->{$names[$_]} = Math::BigFloat->new($ref->{$names[$_]});
}
}
push @results, $ref;
}
@results;
}
# Keeping this here due to common requirements
sub is_allowed_role {
my $self = shift @_;
my %args = @_;
my @roles = @{$args{allowed_roles}}
for $role (@roles){
if (scalar(grep /^$role$/, $self->{_roles})){
return 1;
}
}
return 1; # TODO change to 0 when the role system is implmented
}
# 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};
my ( $yy, $mm, $dd );
if ( $date && $date =~ /\D/ ) {
if ( $myconfig->{dateformat} =~ /^yy/ ) {
( $yy, $mm, $dd ) = split /\D/, $date;
}
if ( $myconfig->{dateformat} =~ /^mm/ ) {
( $mm, $dd, $yy ) = split /\D/, $date;
}
if ( $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;
}
# Database routines used throughout
sub db_init {
my $self = shift @_;
my %args = @_;
my $myconfig = $args{user};
my $dbh = DBI->connect(
$myconfig->{dbconnect}, $myconfig->{dbuser},
$myconfig->{dbpasswd}, { AutoCommit => 0 }
) or $self->dberror;
$dbh->{pg_server_prepare} = 0;
$dbh->{pg_enable_utf8} = 1;
if ( $myconfig->{dboptions} ) {
$dbh->do( $myconfig->{dboptions} );
}
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)";
my $sth = $self->{dbh}->prepare($query);
$sth->execute;
my $ref;
while ( $ref = $sth->fetchrow_hashref('NAME_lc') ) {
push @{ $self->{custom_db_fields}{ $ref->{extends} } },
$ref->{field_def};
}
}
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; # incriment counter use only
for $i ( 1 .. $count ) {
my $temphash = { _inc => $i };
for my $fld (@flds) {
$temphash->{$fld} = $self->{ "$fld" . "_$i" };
}
push @rows, $temphash;
}
$i = 1;
for my $row ( sort { $a->{index} <=> $b->{index} } @rows ) {
for my $fld (@flds) {
$self->{ "$fld" . "_$i" } = $row->{$fld};
}
++$i;
}
}
sub merge {
my ( $self, $src ) = @_;
for my $arg ( $self, $src ) {
shift;
}
my %args = @_;
my @keys = @{ $args{keys} };
my $index = $args{index};
if ( !scalar @keys ) {
@keys = keys %{$src};
}
for my $arg ( keys %$src ) {
my $dst_arg;
if ($index) {
$dst_arg = $arg . "_$index";
}
else {
$dst_arg = $arg;
}
$self->{$dst_arg} = $src->{$arg};
}
}
1;