communigate (phase 2): rules. RT#7514

9 files changed, 474 insertions, 0 deletions

diff --git a/FS/FS.pm b/FS/FS.pm
index 84ec0f3..abeb140 100644
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -128,6 +128,12 @@ L<FS::domain_record> - DNS zone entries
 
 L<FS::registrar> - Domain registrar class
 
+L<FS::cgp_rule> - Communigate pro rule class
+
+L<FS::cgp_rule_condition> - Communigate pro rule condition class
+
+L<FS::cgp_rule_action> - Communigate pro rule action class
+
 L<FS::svc_forward> - Mail forwarding class
 
 L<FS::svc_mailinglist> - (Customer) Mailing list class
diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm
index 318b9e0..ca54d7b 100644
--- a/FS/FS/Schema.pm
+++ b/FS/FS/Schema.pm
@@ -1786,6 +1786,44 @@ sub tables_hashref {
       'index'       => [],
     },
 
+    'cgp_rule' => {
+      'columns' => [
+        'rulenum',  'serial', '',      '', '', '',
+        'name',    'varchar', '', $char_d, '', '',
+        'comment', 'varchar', '', $char_d, '', '',
+        'svcnum',      'int', '',      '', '', '',
+        'priority',    'int', '',      '', '', '',
+      ],
+      'primary_key' => 'rulenum',
+      'unique'      => [],
+      'index '      => [ [ 'svcnum' ] ],
+    },
+
+    'cgp_rule_condition' => {
+      'columns' => [
+        'ruleconditionnum',  'serial', '',      '', '', '',
+        'condition',        'varchar', '', $char_d, '', '',
+        'op',               'varchar', '', $char_d, '', '',
+        'params',           'varchar', '',     255, '', '',
+        'rulenum',              'int', '',      '', '', '',
+      ],
+      'primary_key' => 'ruleconditionnum',
+      'unique'      => [],
+      'index '      => [ [ 'rulenum' ] ],
+    },
+
+    'cgp_rule_action' => {
+       'columns' => [
+        'ruleactionnum',  'serial', '',      '', '', '',
+        'action',        'varchar', '', $char_d, '', '',
+        'params',        'varchar', '',     255, '', '',
+        'rulenum',           'int', '',      '', '', '',
+      ],
+      'primary_key' => 'ruleactionnum',
+      'unique'      => [],
+      'index '      => [ [ 'rulenum' ] ],
+   },
+
     'svc_forward' => {
       'columns' => [
         'svcnum',   'int',            '',   '', '', '', 
diff --git a/FS/FS/cgp_rule.pm b/FS/FS/cgp_rule.pm
new file mode 100644
index 0000000..283055f
--- /dev/null
+++ b/FS/FS/cgp_rule.pm
@@ -0,0 +1,138 @@
+package FS::cgp_rule;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::cgp_rule - Object methods for cgp_rule records
+
+=head1 SYNOPSIS
+
+  use FS::cgp_rule;
+
+  $record = new FS::cgp_rule \%hash;
+  $record = new FS::cgp_rule { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cgp_rule object represents an example.  FS::cgp_rule inherits from
+FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item rulenum
+
+primary key
+
+=item name
+
+name
+
+=item comment
+
+comment
+
+=item svcnum
+
+svcnum
+
+=item priority
+
+priority
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new example.  To add the example 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<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'cgp_rule'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid example.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('rulenum')
+    || $self->ut_text('name')
+    || $self->ut_text('comment')
+    || $self->ut_number('svcnum')
+    || $self->ut_number('priority')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+The author forgot to customize this manpage.
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/FS/cgp_rule_action.pm b/FS/FS/cgp_rule_action.pm
new file mode 100644
index 0000000..b5e4970
--- /dev/null
+++ b/FS/FS/cgp_rule_action.pm
@@ -0,0 +1,133 @@
+package FS::cgp_rule_action;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::cgp_rule_action - Object methods for cgp_rule_action records
+
+=head1 SYNOPSIS
+
+  use FS::cgp_rule_action;
+
+  $record = new FS::cgp_rule_action \%hash;
+  $record = new FS::cgp_rule_action { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cgp_rule_action object represents an example.  FS::cgp_rule_action inherits from
+FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item ruleactionnum
+
+primary key
+
+=item action
+
+action
+
+=item params
+
+params
+
+=item rulenum
+
+rulenum
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new example.  To add the example 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<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'cgp_rule_action'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid example.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('ruleactionnum')
+    || $self->ut_text('action')
+    || $self->ut_text('params')
+    || $self->ut_number('rulenum')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+The author forgot to customize this manpage.
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/FS/cgp_rule_condition.pm b/FS/FS/cgp_rule_condition.pm
new file mode 100644
index 0000000..a8b7e56
--- /dev/null
+++ b/FS/FS/cgp_rule_condition.pm
@@ -0,0 +1,138 @@
+package FS::cgp_rule_condition;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::cgp_rule_condition - Object methods for cgp_rule_condition records
+
+=head1 SYNOPSIS
+
+  use FS::cgp_rule_condition;
+
+  $record = new FS::cgp_rule_condition \%hash;
+  $record = new FS::cgp_rule_condition { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cgp_rule_condition object represents an example.  FS::cgp_rule_condition inherits from
+FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item ruleconditionnum
+
+primary key
+
+=item condition
+
+condition
+
+=item op
+
+op
+
+=item params
+
+params
+
+=item rulenum
+
+rulenum
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new example.  To add the example 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<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'cgp_rule_condition'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid example.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('ruleconditionnum')
+    || $self->ut_text('condition')
+    || $self->ut_text('op')
+    || $self->ut_text('params')
+    || $self->ut_number('rulenum')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+The author forgot to customize this manpage.
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/MANIFEST b/FS/MANIFEST
index 900d3a1..b140765 100644
--- a/FS/MANIFEST
+++ b/FS/MANIFEST
@@ -504,3 +504,9 @@ FS/part_event/Action/pkg_agent_credit_pkg.pm
 FS/part_event/Action/pkg_employee_credit.pm
 FS/part_event/Action/pkg_employee_credit_pkg.pm
 FS/Misc/DateTime.pm
+FS/cgp_rule.pm
+t/cgp_rule.t
+FS/cgp_rule_condition.pm
+t/cgp_rule_condition.t
+FS/cgp_rule_action.pm
+t/cgp_rule_action.t
diff --git a/FS/t/cgp_rule.t b/FS/t/cgp_rule.t
new file mode 100644
index 0000000..421b922
--- /dev/null
+++ b/FS/t/cgp_rule.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::cgp_rule;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/cgp_rule_action.t b/FS/t/cgp_rule_action.t
new file mode 100644
index 0000000..f0548dc
--- /dev/null
+++ b/FS/t/cgp_rule_action.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::cgp_rule_action;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/cgp_rule_condition.t b/FS/t/cgp_rule_condition.t
new file mode 100644
index 0000000..49d8c35
--- /dev/null
+++ b/FS/t/cgp_rule_condition.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::cgp_rule_condition;
+$loaded=1;
+print "ok 1\n";