X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcgp_rule.pm;h=1029f5a1759e136c5b523604d8253b8dd74a42a9;hp=283055fefec53a992ec97b4ce75e624b26f0cac9;hb=ff27c3f36240aee48ed50153dd5d8fe3ac3f2443;hpb=3a201934245c2e72b167804a6d512e0e6d435f65 diff --git a/FS/FS/cgp_rule.pm b/FS/FS/cgp_rule.pm index 283055fef..1029f5a17 100644 --- a/FS/FS/cgp_rule.pm +++ b/FS/FS/cgp_rule.pm @@ -1,8 +1,8 @@ package FS::cgp_rule; +use base qw( FS::o2m_Common FS::Record ); use strict; -use base qw( FS::Record ); -use FS::Record qw( qsearch qsearchs ); +use FS::Record qw( dbh ); =head1 NAME @@ -25,8 +25,8 @@ FS::cgp_rule - Object methods for cgp_rule records =head1 DESCRIPTION -An FS::cgp_rule object represents an example. FS::cgp_rule inherits from -FS::Record. The following fields are currently supported: +An FS::cgp_rule object represents a mail filtering rule. FS::cgp_rule +inherits from FS::Record. The following fields are currently supported: =over 4 @@ -59,7 +59,7 @@ priority =item new HASHREF -Creates a new example. To add the example to the database, see L<"insert">. +Creates a new rule. To add the rule to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. @@ -77,7 +77,36 @@ otherwise returns false. =cut -# the insert method can be inherited from FS::Record +# sub insert { +# my $self = shift; +# +# local $SIG{HUP} = 'IGNORE'; +# local $SIG{INT} = 'IGNORE'; +# local $SIG{QUIT} = 'IGNORE'; +# local $SIG{TERM} = 'IGNORE'; +# local $SIG{TSTP} = 'IGNORE'; +# local $SIG{PIPE} = 'IGNORE'; +# +# my $oldAutoCommit = $FS::UID::AutoCommit; +# local $FS::UID::AutoCommit = 0; +# my $dbh = dbh; +# +# my $error = $self->SUPER::insert(@_); +# if ( $error ) { +# $dbh->rollback if $oldAutoCommit; +# return $error; +# } +# +# #conditions and actions not in yet +# #$error = $self->svc_export; +# #if ( $error ) { +# # $dbh->rollback if $oldAutoCommit; +# # return $error; +# #} +# +# $dbh->commit or die $dbh->errstr if $oldAutoCommit; +# ''; +# } =item delete @@ -85,7 +114,46 @@ Delete this record from the database. =cut -# the delete method can be inherited from FS::Record +sub delete { + my $self = shift; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my @del = $self->cgp_rule_condition; + push @del, $self->cgp_rule_action; + + foreach my $del (@del) { + my $error = $del->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + my $error = $self->SUPER::delete(@_); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + $error = $self->svc_export; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; +} =item replace OLD_RECORD @@ -94,11 +162,66 @@ returns the error, otherwise returns false. =cut -# the replace method can be inherited from FS::Record +sub replace { + my $new = shift; + + my $old = ( ref($_[0]) eq ref($new) ) + ? shift + : $new->replace_old; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my $error = $new->SUPER::replace($old, @_); + if ( $error ) { + $dbh->rollback or die $dbh->errstr if $oldAutoCommit; + return $error; + } + + #conditions and actions not in yet + #$error = $new->svc_export; + #if ( $error ) { + # $dbh->rollback if $oldAutoCommit; + # return $error; + #} + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; + +} + +=item svc_export + +Calls the replace export for any communigate exports attached to this rule's +service. + +=cut + +sub svc_export { + my $self = shift; + + my $cust_svc = $self->cust_svc; + my $svc_x = $cust_svc->svc_x; + + #_singledomain too + my @exports = $cust_svc->part_svc->part_export('communigate_pro'); + my @errors = map $_->export_replace($svc_x, $svc_x), @exports; + + @errors ? join(' / ', @errors) : ''; + +} =item check -Checks all fields to make sure this is a valid example. If there is +Checks all fields to make sure this is a valid rule. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. @@ -113,8 +236,8 @@ sub check { my $error = $self->ut_numbern('rulenum') || $self->ut_text('name') - || $self->ut_text('comment') - || $self->ut_number('svcnum') + || $self->ut_textn('comment') + || $self->ut_foreign_key('svcnum', 'cust_svc', 'svcnum') || $self->ut_number('priority') ; return $error if $error; @@ -122,12 +245,85 @@ sub check { $self->SUPER::check; } +=item clone NEW_SVCNUM + +Clones this rule into an identical rule for the specified new service. + +If there is an error, returns the error, otherwise returns false. + +=cut + +#should return the newly inserted rule instead? used in misc/clone-cgp_rule.html + +#i should probably be transactionalized so i'm all-or-nothing +sub clone { + my( $self, $svcnum ) = @_; + + my $new = $self->new( { $self->hash } ); + $new->rulenum(''); + $new->svcnum( $svcnum ); + my $error = $new->insert; + return $error if $error; + + my @dup = $self->cgp_rule_condition; + push @dup, $self->cgp_rule_action; + + foreach my $dup (@dup) { + my $new_dup = $dup->new( { $dup->hash } ); + my $pk = $new_dup->primary_key; + $new_dup->$pk(''); + $new_dup->rulenum( $new->rulenum ); + + $error = $new_dup->insert; + return $error if $error; + + } + + $error = $new->svc_export; + return $error if $error; + + ''; + +} + +=item cust_svc + +=item cgp_rule_condition + +Returns the conditions associated with this rule, as FS::cgp_rule_condition +objects. + +=item arrayref + +Returns an arraref representing this rule, suitable for Communigate Pro API +commands: + +The first element specifies the rule priority. + +The second element specifies the rule name. + +The third element specifies the rule conditions. + +The fourth element specifies the rule actions. + +The fifth element specifies the rule comment. + +=cut + +sub arrayref { + my $self = shift; + [ $self->priority, + $self->name, + [ map $_->arrayref, $self->cgp_rule_condition ], + [ map $_->arrayref, $self->cgp_rule_action ], + $self->comment, + ], +} + =back =head1 BUGS -The author forgot to customize this manpage. - =head1 SEE ALSO L, schema.html from the base documentation.