1 files changed, 106 insertions, 0 deletions
diff --git a/extensions/Push/lib/Connector/Base.pm b/extensions/Push/lib/Connector/Base.pm
new file mode 100644
index 000000000..290ea9740
--- /dev/null
+++ b/extensions/Push/lib/Connector/Base.pm
@@ -0,0 +1,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;
+