From 8a3d4469cc85108a194a78ac95f2a6780d2971eb Mon Sep 17 00:00:00 2001
From: "mkanat%bugzilla.org" <>
Date: Wed, 24 Dec 2008 03:43:36 +0000
Subject: Bug 284184: Allow Bugzilla to use an asynchronous job queue for
 sending mail. Patch By Max Kanat-Alexander <mkanat@bugzilla.org> and Mark
 Smith <mark@plogs.net> r=glob, a=mkanat

---
 Bugzilla/JobQueue.pm | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 Bugzilla/JobQueue.pm

(limited to 'Bugzilla/JobQueue.pm')

diff --git a/Bugzilla/JobQueue.pm b/Bugzilla/JobQueue.pm
new file mode 100644
index 000000000..102f58bc6
--- /dev/null
+++ b/Bugzilla/JobQueue.pm
@@ -0,0 +1,108 @@
+# -*- Mode: perl; indent-tabs-mode: nil -*-
+#
+# The contents of this file are subject to the Mozilla Public
+# License Version 1.1 (the "License"); you may not use this file
+# except in compliance with the License. You may obtain a copy of
+# the License at http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS
+# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# rights and limitations under the License.
+#
+# The Original Code is the Bugzilla Bug Tracking System.
+#
+# The Initial Developer of the Original Code is Mozilla Corporation.
+# Portions created by the Initial Developer are Copyright (C) 2008
+# Mozilla Corporation. All Rights Reserved.
+#
+# Contributor(s): 
+#   Mark Smith <mark@mozilla.com>
+#   Max Kanat-Alexander <mkanat@bugzilla.org>
+
+package Bugzilla::JobQueue;
+
+use strict;
+
+use Bugzilla::Constants;
+use Bugzilla::Error;
+use Bugzilla::Install::Util qw(install_string);
+BEGIN { eval "use base qw(TheSchwartz)"; }
+
+# This maps job names for Bugzilla::JobQueue to the appropriate modules.
+# If you add new types of jobs, you should add a mapping here.
+use constant JOB_MAP => {
+    send_mail => 'Bugzilla::Job::Mailer',
+};
+
+sub new {
+    my $class = shift;
+
+    if (!eval { require TheSchwartz; }) {
+        ThrowCodeError('jobqueue_not_configured');
+    }
+
+    my $lc = Bugzilla->localconfig;
+    my $self = $class->SUPER::new(
+        databases => [{
+            dsn    => Bugzilla->dbh->{private_bz_dsn},
+            user   => $lc->{db_user},
+            pass   => $lc->{db_pass},
+            prefix => 'ts_',
+        }],
+    );
+
+    return $self;
+}
+
+# A way to get access to the underlying databases directly.
+sub bz_databases {
+    my $self = shift;
+    my @hashes = keys %{ $self->{databases} };
+    return map { $self->driver_for($_) } @hashes;
+}
+
+# inserts a job into the queue to be processed and returns immediately
+sub insert {
+    my $self = shift;
+    my $job = shift;
+
+    my $mapped_job = JOB_MAP->{$job};
+    ThrowCodeError('jobqueue_no_job_mapping', { job => $job })
+        if !$mapped_job;
+    unshift(@_, $mapped_job);
+
+    my $retval = $self->SUPER::insert(@_);
+    # XXX Need to get an error message here if insert fails, but
+    # I don't see any way to do that in TheSchwartz.
+    ThrowCodeError('jobqueue_insert_failed', { job => $job, errmsg => $@ })
+        if !$retval;
+ 
+    return $retval;
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+Bugzilla::JobQueue - Interface between Bugzilla and TheSchwartz.
+
+=head1 SYNOPSIS
+
+ use Bugzilla;
+
+ my $obj = Bugzilla->job_queue();
+ $obj->insert('send_mail', { msg => $message });
+
+=head1 DESCRIPTION
+
+Certain tasks should be done asyncronously.  The job queue system allows
+Bugzilla to use some sort of service to schedule jobs to happen asyncronously.
+
+=head2 Inserting a Job
+
+See the synopsis above for an easy to follow example on how to insert a
+job into the queue.  Give it a name and some arguments and the job will
+be sent away to be done later.
-- 
cgit v1.2.3-24-g4f1b