From 36d69066d3e7d72620dc94279841aba945da6ce7 Mon Sep 17 00:00:00 2001 From: "mkanat%bugzilla.org" <> Date: Mon, 9 Nov 2009 18:35:39 +0000 Subject: Bug 511028: Create a read-only Bugzilla::Whine::Schedule object using Bugzilla::Object, for whine schedules Patch by Eric Black r=mkanat, a=mkanat --- Bugzilla/Whine/Schedule.pm | 172 +++++++++++++++++++++++++++++++++++++++++++++ editwhines.cgi | 53 +++++--------- 2 files changed, 190 insertions(+), 35 deletions(-) create mode 100644 Bugzilla/Whine/Schedule.pm diff --git a/Bugzilla/Whine/Schedule.pm b/Bugzilla/Whine/Schedule.pm new file mode 100644 index 000000000..be0f2fae8 --- /dev/null +++ b/Bugzilla/Whine/Schedule.pm @@ -0,0 +1,172 @@ +# -*- 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 Eric Black. +# Portions created by the Initial Developer are Copyright (C) 2009 +# Eric Black. All Rights Reserved. +# +# Contributor(s): Eric Black + +use strict; + +package Bugzilla::Whine::Schedule; + +use base qw(Bugzilla::Object); + +use Bugzilla::Constants; + +############# +# Constants # +############# + +use constant DB_TABLE => 'whine_schedules'; + +use constant DB_COLUMNS => qw( + id + eventid + run_day + run_time + run_next + mailto + mailto_type +); + +use constant REQUIRED_CREATE_FIELDS => qw(eventid mailto mailto_type); + +use constant UPDATE_COLUMNS => qw( + eventid + run_day + run_time + run_next + mailto + mailto_type +); +use constant NAME_FIELD => 'id'; +use constant LIST_ORDER => 'id'; + +#################### +# Simple Accessors # +#################### +sub eventid { return $_[0]->{'eventid'}; } +sub run_day { return $_[0]->{'run_day'}; } +sub run_time { return $_[0]->{'run_time'}; } +sub mailto_is_group { return $_[0]->{'mailto_type'}; } + +sub mailto { + my $self = shift; + + return $self->{mailto_object} if exists $self->{mailto_object}; + my $id = $self->{'mailto'}; + + if ($self->mailto_is_group) { + $self->{mailto_object} = Bugzilla::Group->new($id); + } else { + $self->{mailto_object} = Bugzilla::User->new($id); + } + return $self->{mailto_object}; +} + +sub mailto_users { + my $self = shift; + return $self->{mailto_users} if exists $self->{mailto_users}; + my $object = $self->mailto; + + if ($self->mailto_is_group) { + $self->{mailto_users} = $object->members_non_inherited if $object->is_active; + } else { + $self->{mailto_users} = $object; + } + return $self->{mailto_users}; +} + +1; + +__END__ + +=head1 NAME + +Bugzilla::Whine::Schedule - A schedule object used by L. + +=head1 SYNOPSIS + + use Bugzilla::Whine::Schedule; + + my $schedule = new Bugzilla::Whine::Schedule($schedule_id); + + my $event_id = $schedule->eventid; + my $run_day = $schedule->run_day; + my $run_time = $schedule->run_time; + my $is_group = $schedule->mailto_is_group; + my $object = $schedule->mailto; + my $array_ref = $schedule->mailto_users; + +=head1 DESCRIPTION + +This module exists to represent a L event schedule. + +This is an implementation of L, and so has all the +same methods available as L, in addition to what is +documented below. + +=head1 METHODS + +=head2 Constructors + +=over + +=item C + +Does not accept a bare C argument. Instead, accepts only an id. + +See also: L. + +=back + + +=head2 Accessors + +These return data about the object, without modifying the object. + +=over + +=item C + +The L event object id for this object. + +=item C + +The day or day pattern that a L event is scheduled to run. + +=item C + +The time or time pattern that a L event is scheduled to run. + +=item C + +Returns a numeric 1 (C) or 0 (C) to represent whether +L is a group or user. + +=item C + +This is either a L or L object to represent +the user or group this scheduled event is set to be mailed to. + +=item C + +Returns an array reference of Ls. This is derived from the +L stored in L if L is true and +the group is still active, otherwise it will contain a single array element +for the L in L. + +=back diff --git a/editwhines.cgi b/editwhines.cgi index 37f52349e..e93437647 100755 --- a/editwhines.cgi +++ b/editwhines.cgi @@ -36,6 +36,7 @@ use Bugzilla::Error; use Bugzilla::User; use Bugzilla::Group; use Bugzilla::Token; +use Bugzilla::Whine::Schedule; # require the user to have logged in my $user = Bugzilla->login(LOGIN_REQUIRED); @@ -104,20 +105,11 @@ if ($cgi->param('update')) { # otherwise we could simply delete whatever matched that ID. # # schedules - $sth = $dbh->prepare("SELECT whine_schedules.id " . - "FROM whine_schedules " . - "LEFT JOIN whine_events " . - "ON whine_events.id = " . - "whine_schedules.eventid " . - "WHERE whine_events.id = ? " . - "AND whine_events.owner_userid = ?"); - $sth->execute($eventid, $userid); - my @ids = @{$sth->fetchall_arrayref}; + my $schedules = Bugzilla::Whine::Schedule->match({ eventid => $eventid }); $sth = $dbh->prepare("DELETE FROM whine_schedules " . "WHERE id=?"); - for (@ids) { - my $delete_id = $_->[0]; - $sth->execute($delete_id); + foreach my $schedule (@$schedules) { + $sth->execute($schedule->id); } # queries @@ -129,7 +121,7 @@ if ($cgi->param('update')) { "WHERE whine_events.id = ? " . "AND whine_events.owner_userid = ?"); $sth->execute($eventid, $userid); - @ids = @{$sth->fetchall_arrayref}; + my @ids = @{$sth->fetchall_arrayref}; $sth = $dbh->prepare("DELETE FROM whine_queries " . "WHERE id=?"); for (@ids) { @@ -183,13 +175,10 @@ if ($cgi->param('update')) { # to be altered or deleted # Check schedules for changes - $sth = $dbh->prepare("SELECT id " . - "FROM whine_schedules " . - "WHERE eventid=?"); - $sth->execute($eventid); + my $schedules = Bugzilla::Whine::Schedule->match({ eventid => $eventid }); my @scheduleids = (); - while (my ($sid) = $sth->fetchrow_array) { - push @scheduleids, $sid; + foreach my $schedule (@$schedules) { + push @scheduleids, $schedule->id; } # we need to double-check all of the user IDs in mailto to make @@ -370,30 +359,24 @@ for my $event_id (keys %{$events}) { $events->{$event_id}->{'queries'} = []; # schedules - $sth = $dbh->prepare("SELECT run_day, run_time, mailto_type, mailto, id " . - "FROM whine_schedules " . - "WHERE eventid=?"); - $sth->execute($event_id); - for my $row (@{$sth->fetchall_arrayref}) { - my $mailto_type = $row->[2]; + my $schedules = Bugzilla::Whine::Schedule->match({ eventid => $event_id }); + foreach my $schedule (@$schedules) { + my $mailto_type = $schedule->mailto_is_group ? MAILTO_GROUP + : MAILTO_USER; my $mailto = ''; if ($mailto_type == MAILTO_USER) { - my $mailto_user = new Bugzilla::User($row->[3]); - $mailto = $mailto_user->login; + $mailto = $schedule->mailto->login; } elsif ($mailto_type == MAILTO_GROUP) { - $sth = $dbh->prepare("SELECT name FROM groups WHERE id=?"); - $sth->execute($row->[3]); - $mailto = $sth->fetch->[0]; - $mailto = "" unless Bugzilla::Group::ValidateGroupName( - $mailto, ($user)); + $mailto = $schedule->mailto->name; } + my $this_schedule = { - 'day' => $row->[0], - 'time' => $row->[1], + 'day' => $schedule->run_day, + 'time' => $schedule->run_time, 'mailto_type' => $mailto_type, 'mailto' => $mailto, - 'id' => $row->[4], + 'id' => $schedule->id, }; push @{$events->{$event_id}->{'schedule'}}, $this_schedule; } -- cgit v1.2.3-24-g4f1b