+++ /dev/null
-package PMG::RuleDB::Object;
-
-use strict;
-use warnings;
-use DBI;
-
-use PMG::Utils;
-use PMG::RuleDB;
-
-sub new {
- my ($type, $otype, $ogroup) = @_;
-
- $otype //= 0;
-
- my $self = {
- otype => $otype,
- ogroup => $ogroup,
- };
-
- bless $self, $type;
-
- return $self;
-}
-
-sub save {
- die "never call this method: ERROR";
-}
-
-sub update {
- my ($self, $param) = @_;
-
- die "never call this method: ERROR";
-}
-
-sub load_attr {
- die "never call this method: ERROR";
-}
-
-sub who_match {
- die "never call this method: ERROR";
-}
-
-sub when_match {
- die "never call this method: ERROR";
-}
-
-sub what_match {
- die "never call this method: ERROR";
-}
-
-sub execute {
- die "never call this method: ERROR";
-}
-
-sub final {
- return undef;
-}
-
-sub priority {
- return 0;
-}
-
-sub oisedit {
- return 1;
-}
-
-sub ogroup {
- my ($self, $v) = @_;
-
- if (defined ($v)) {
- $self->{ogroup} = $v;
- }
-
- $self->{ogroup};
-}
-
-sub otype {
- my $self = shift;
-
- $self->{otype};
-}
-
-sub otype_text {
- my $self = shift;
-
- return "object";
-}
-
-# some who object only matches 'receivers'
-sub receivertest {
- return 0;
-}
-
-sub oclass {
- die "never call this method: ERROR";
-}
-
-sub id {
- my $self = shift;
-
- $self->{id};
-}
-
-sub short_desc {
- return "basic object";
-}
-
-sub properties {
- die "never call this method: ERROR";
-}
-
-sub get {
- my ($self) = @_;
-
- return undef;
-}
-
-sub get_data {
- my ($self) = @_;
-
- my $data = $self->get() // {};
-
- $data->{id} = $self->{id};
- $data->{ogroup} = $self->{ogroup};
- $data->{otype} = $self->otype();
- $data->{otype_text} = $self->otype_text();
- $data->{receivertest} = $self->receivertest();
- $data->{descr} = $self->short_desc();
-
- return $data;
-}
-
-sub register_api {
- my ($class, $apiclass, $name, $path, $use_greylist_gid) = @_;
-
- $path //= $name;
-
- my $otype = $class->otype();
-
- my $otype_text = $class->otype_text();
-
- my $properties = $class->properties();
-
- my $create_properties = {};
- my $update_properties = {
- id => {
- description => "Object ID.",
- type => 'integer',
- },
- };
- my $read_properties = {
- id => {
- description => "Object ID.",
- type => 'integer',
- },
- };
-
- if (!$use_greylist_gid) {
- $read_properties->{ogroup} = $create_properties->{ogroup} = $update_properties->{ogroup} = {
- description => "Object Groups ID.",
- type => 'integer',
- };
- };
-
- foreach my $key (keys %$properties) {
- $create_properties->{$key} = $properties->{$key};
- $update_properties->{$key} = $properties->{$key};
- }
-
- $apiclass->register_method ({
- name => $name,
- path => $path,
- method => 'POST',
- description => "Add '$otype_text' object.",
- proxyto => 'master',
- protected => 1,
- permissions => { check => [ 'admin' ] },
- parameters => {
- additionalProperties => 0,
- properties => $create_properties,
- },
- returns => {
- description => "The object ID.",
- type => 'integer',
- },
- code => sub {
- my ($param) = @_;
-
- my $rdb = PMG::RuleDB->new();
-
- my $gid = $use_greylist_gid ?
- $rdb->greylistexclusion_groupid() : $param->{ogroup};
-
- my $obj = $rdb->get_object($otype);
- $obj->{ogroup} = $gid;
-
- $obj->update($param);
-
- my $id = $obj->save($rdb);
-
- if ($use_greylist_gid) {
- PMG::DBTools::reload_ruledb($rdb);
- } else {
- PMG::DBTools::reload_ruledb();
- }
-
- return $id;
- }});
-
- $apiclass->register_method ({
- name => "read_$name",
- path => "$path/{id}",
- method => 'GET',
- description => "Read '$otype_text' object settings.",
- proxyto => 'master',
- permissions => { check => [ 'admin', 'audit' ] },
- parameters => {
- additionalProperties => 0,
- properties => $read_properties,
- },
- returns => {
- type => "object",
- properties => {
- id => { type => 'integer'},
- },
- },
- code => sub {
- my ($param) = @_;
-
- my $rdb = PMG::RuleDB->new();
-
- my $gid = $use_greylist_gid ?
- $rdb->greylistexclusion_groupid() : $param->{ogroup};
-
- my $obj = $rdb->load_object_full($param->{id}, $gid, $otype);
-
- return $obj->get_data();
- }});
-
- $apiclass->register_method ({
- name => "update_$name",
- path => "$path/{id}",
- method => 'PUT',
- description => "Update '$otype_text' object.",
- proxyto => 'master',
- permissions => { check => [ 'admin' ] },
- protected => 1,
- parameters => {
- additionalProperties => 0,
- properties => $update_properties,
- },
- returns => { type => 'null' },
- code => sub {
- my ($param) = @_;
-
- my $rdb = PMG::RuleDB->new();
-
- my $gid = $use_greylist_gid ?
- $rdb->greylistexclusion_groupid() : $param->{ogroup};
-
- my $obj = $rdb->load_object_full($param->{id}, $gid, $otype);
-
- $obj->update($param);
-
- $obj->save($rdb);
-
- if ($use_greylist_gid) {
- PMG::DBTools::reload_ruledb($rdb);
- } else {
- PMG::DBTools::reload_ruledb();
- }
-
- return undef;
- }});
-
-}
-
-1;
-
-__END__
-
-=head1 PMG::RuleDB::Object
-
-The Proxmox Rules consists of Objects. There are several classes of Objects. Ech such class has a method to check if the object 'matches'.
-
-=head2 WHO Objects ($obj->oclass() eq 'who')
-
-Who sent the mail, who is the receiver?
-
-=head3 $obj->who_match ($addr)
-
-Returns true if $addr belongs to this objects. $addr is a text string representing the email address you want to check.
-
-=over
-
-=item *
-
-EMail: the only attribute is a regex to test email addresses
-
-=back
-
-=head2 WHEN Objects ($obj->oclass() eq 'when')
-
-Used to test for a certain daytime
-
-=head3 $obj->when_match ($time)
-
-Return true if $time matches the when object constraints. $time is an integer like returned by the time() system call (or generated with POSIX::mktime()).
-
-=over
-
-=item *
-
-TimeFrame: specifies a start and a end time
-
-=back
-
-=head2 WHAT Objects ($obj->oclass() eq 'what')
-
-mail content tests
-
-=head2 ACTION Objects ($obj->oclass() eq 'action')
-
-actions which can be executed
-
-=head3 $obj->execute ($mod_group, $queue, $ruledb, $mod_group, $targets, $msginfo, $vars, $marks)
-
-Execute the action code. $target is a array reference containing all
-matching targets.
-
-=head2 Common Methods
-
-=head3 $obj->oclass()
-
-Returns 'who', 'when' 'what' or 'action';
-
-=head3 $obj->short_desc()
-
-Returns a short text describing the contents of the object. This is used
-for debugging purposes.
-
-=head3 $obj->otype
-
-Returns an integer representing the Type of the objects. This integer
-is used in the database to uniquely identify object types.
-
-=head3 $obj->id
-
-Returns the unique database ID of the object. undef means the object is not jet stored in the databse.
-
-=head3 $obj->final()
-
-Return true if the object is an action and the action is final, i.e. the action stops further rule processing for all matching targets.
-
-=head3 $obj->priority()
-
-Return a priority between 0 and 100. This is currently used to sort action objects by priority.
-
projects / pmg-api.git / blobdiff