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
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.
package Bugzilla::Extension::Push::Connector::Base;
use strict;
use warnings;
use Bugzilla;
use Bugzilla::Extension::Push::Config;
use Bugzilla::Extension::Push::BacklogMessage;
use Bugzilla::Extension::Push::BacklogQueue;
use Bugzilla::Extension::Push::Backoff;
sub new {
my ($class) = @_;
my $self = {};
bless($self, $class);
($self->{name}) = $class =~ /^.+:(.+)$/;
$self->init();
return $self;
}
sub name {
my $self = shift;
return $self->{name};
}
sub init {
my ($self) = @_;
# abstract
# perform any initialisation here
# will be run when created by the web pages or by the daemon
# and also when the configuration needs to be reloaded
}
sub stop {
my ($self) = @_;
# abstract
# run from the daemon only; disconnect from remote hosts, etc
}
sub should_send {
my ($self, $message) = @_;
# abstract
# return boolean indicating if the connector will be sending the message.
# this will be called each message, and should be a very quick simple test.
# the connector can perform a more exhaustive test in the send() method.
return 0;
}
sub send {
my ($self, $message) = @_;
# abstract
# deliver the message, daemon only
}
sub options {
my ($self) = @_;
# abstract
# return an array of configuration variables
return ();
}
sub options_validate {
my ($class, $config) = @_;
# abstract, static
# die if a combination of options in $config is invalid
}
#
#
#
sub config {
my ($self) = @_;
if (!$self->{config}) {
$self->load_config();
}
return $self->{config};
}
sub load_config {
my ($self) = @_;
my $config = Bugzilla::Extension::Push::Config->new($self->name, $self->options);
$config->load();
$self->{config} = $config;
}
sub enabled {
my ($self) = @_;
return $self->config->{enabled} eq 'Enabled';
}
sub backlog {
my ($self) = @_;
$self->{backlog} ||= Bugzilla::Extension::Push::BacklogQueue->new($self->name);
return $self->{backlog};
}
1;
|
