X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_bill_pkg_detail.pm;h=7badaa3b9a33d1428646a6411df62399272fc827;hp=88694413832c77f13cd25b5bd58659e2068cb61c;hb=da86d5a8af2f915a340a74f6c97772451a1e23ef;hpb=539b6216a17a5423431d430022c4e0f9581a9d2f diff --git a/FS/FS/cust_bill_pkg_detail.pm b/FS/FS/cust_bill_pkg_detail.pm index 886944138..7badaa3b9 100644 --- a/FS/FS/cust_bill_pkg_detail.pm +++ b/FS/FS/cust_bill_pkg_detail.pm @@ -2,8 +2,10 @@ package FS::cust_bill_pkg_detail; use strict; use vars qw( @ISA $me $DEBUG %GetInfoType ); +use HTML::Entities; use FS::Record qw( qsearch qsearchs dbdef dbh ); use FS::cust_bill_pkg; +use FS::usage_class; use FS::Conf; @ISA = qw(FS::Record); @@ -41,6 +43,18 @@ inherits from FS::Record. The following fields are currently supported: =item billpkgnum - link to cust_bill_pkg +=item amount - price of this line item detail + +=item format - '' for straight text and 'C' for CSV in detail + +=item classnum - link to usage_class + +=item duration - granularized number of seconds for this call + +=item regionname - + +=item phonenum - + =item detail - detail description =back @@ -119,8 +133,10 @@ sub check { $self->ut_numbern('detailnum') || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum') #|| $self->ut_moneyn('amount') - || $self->ut_float('amount') + || $self->ut_floatn('amount') || $self->ut_enum('format', [ '', 'C' ] ) + || $self->ut_numbern('duration') + || $self->ut_textn('regionname') || $self->ut_text('detail') || $self->ut_foreign_keyn('classnum', 'usage_class', 'classnum') || $self->$phonenum_check_method('phonenum') @@ -129,18 +145,104 @@ sub check { } -# _upgrade_data -# -# Used by FS::Upgrade to migrate to a new database. +=item formatted [ OPTION => VALUE ... ] -sub _upgrade_data { # class method +Returns detail information for the invoice line item detail formatted for +display. + +Currently available options are: I I + +If I is set to html or latex then the format is improved +for tabular appearance in those environments if possible. + +If I is set then the format is processed by this +function before being returned. + +If I is set then the detail is handed to this callback +for processing. + +=cut + +sub formatted { + my ( $self, %opt ) = @_; + my $format = $opt{format} || ''; + return () unless defined dbdef->table('cust_bill_pkg_detail'); + + eval "use Text::CSV_XS;"; + die $@ if $@; + my $csv = new Text::CSV_XS; + + my $escape_function = sub { shift }; + + $escape_function = \&encode_entities + if $format eq 'html'; + + $escape_function = + sub { + my $value = shift; + $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge; + $value =~ s/([<>])/\$$1\$/g; + $value; + } + if $format eq 'latex'; + + $escape_function = $opt{escape_function} if $opt{escape_function}; + + my $format_sub = sub { my $detail = shift; + $csv->parse($detail) or return "can't parse $detail"; + join(' - ', map { &$escape_function($_) } + $csv->fields + ); + }; + + $format_sub = sub { my $detail = shift; + $csv->parse($detail) or return "can't parse $detail"; + join('', map { &$escape_function($_) } + $csv->fields + ); + } + if $format eq 'html'; + + $format_sub = sub { my $detail = shift; + $csv->parse($detail) or return "can't parse $detail"; + #join(' & ', map { '\small{'. &$escape_function($_). '}' } # $csv->fields ); + my $result = ''; + my $column = 1; + foreach ($csv->fields) { + $result .= ' & ' if $column > 1; + if ($column > 6) { # KLUDGE ALERT! + $result .= '\multicolumn{1}{l}{\scriptsize{'. + &$escape_function($_). '}}'; + }else{ + $result .= '\scriptsize{'. &$escape_function($_). '}'; + } + $column++; + } + $result; + } + if $format eq 'latex'; + + $format_sub = $opt{format_function} if $opt{format_function}; + + $self->format eq 'C' + ? &{$format_sub}( $self->detail, $self ) + : &{$escape_function}( $self->detail ) + ; +} + + +# Used by FS::Upgrade to migrate to a new database schema +sub _upgrade_schema { # class method my ($class, %opts) = @_; warn "$me upgrading $class\n" if $DEBUG; - my $columndef = dbdef->table($class->table)->column('classnum'); - unless ($columndef->type eq 'int4') { + my $classnum = dbdef->table($class->table)->column('classnum') + or return; + + my $type = $classnum->type; + unless ( $type =~ /^int/i || $type =~ /int$/i ) { my $dbh = dbh; if ( $dbh->{Driver}->{Name} eq 'Pg' ) { @@ -211,51 +313,50 @@ sub _upgrade_data { # class method } +} - if ( defined( dbdef->table($class->table)->column('billpkgnum') ) && - defined( dbdef->table($class->table)->column('invnum') ) && - defined( dbdef->table($class->table)->column('pkgnum') ) - ) { - - warn "$me Checking for unmigrated invoice line item details\n" if $DEBUG; - - my @cbpd = qsearch({ 'table' => $class->table, - 'hashref' => {}, - 'extra_sql' => 'WHERE invnum IS NOT NULL AND '. - 'pkgnum IS NOT NULL', - }); - - if (scalar(@cbpd)) { - warn "$me Found unmigrated invoice line item details\n" if $DEBUG; - - foreach my $cbpd ( @cbpd ) { - my $detailnum = $cbpd->detailnum; - warn "$me Contemplating detail $detailnum\n" if $DEBUG > 1; - my $cust_bill_pkg = - qsearchs({ 'table' => 'cust_bill_pkg', - 'hashref' => { 'invnum' => $cbpd->invnum, - 'pkgnum' => $cbpd->pkgnum, - }, - 'order_by' => 'ORDER BY billpkgnum LIMIT 1', - }); - if ($cust_bill_pkg) { - $cbpd->billpkgnum($cust_bill_pkg->billpkgnum); - $cbpd->invnum(''); - $cbpd->pkgnum(''); - my $error = $cbpd->replace; - - warn "*** WARNING: error replacing line item detail ". - "(cust_bill_pkg_detail) $detailnum: $error ***\n" - if $error; - } else { - warn "Found orphaned line item detail $detailnum during upgrade.\n"; - } +# Used by FS::Upgrade to migrate to a new database +sub _upgrade_data { # class method - } # foreach $cbpd + my ($class, %opts) = @_; + + warn "$me Checking for unmigrated invoice line item details\n" if $DEBUG; + + my @cbpd = qsearch({ 'table' => $class->table, + 'hashref' => {}, + 'extra_sql' => 'WHERE invnum IS NOT NULL AND '. + 'pkgnum IS NOT NULL', + }); + + if (scalar(@cbpd)) { + warn "$me Found unmigrated invoice line item details\n" if $DEBUG; + + foreach my $cbpd ( @cbpd ) { + my $detailnum = $cbpd->detailnum; + warn "$me Contemplating detail $detailnum\n" if $DEBUG > 1; + my $cust_bill_pkg = + qsearchs({ 'table' => 'cust_bill_pkg', + 'hashref' => { 'invnum' => $cbpd->invnum, + 'pkgnum' => $cbpd->pkgnum, + }, + 'order_by' => 'ORDER BY billpkgnum LIMIT 1', + }); + if ($cust_bill_pkg) { + $cbpd->billpkgnum($cust_bill_pkg->billpkgnum); + $cbpd->invnum(''); + $cbpd->pkgnum(''); + my $error = $cbpd->replace; + + warn "*** WARNING: error replacing line item detail ". + "(cust_bill_pkg_detail) $detailnum: $error ***\n" + if $error; + } else { + warn "Found orphaned line item detail $detailnum during upgrade.\n"; + } - } # if @cbpd + } # foreach $cbpd - } # if billpkgnum, invnum, and pkgnum columns defined + } # if @cbpd '';