initial releaseHEADmaster

5 files changed, 476 insertions, 0 deletions

diff --git a/html/Admin/CustomFields/Modify.html b/html/Admin/CustomFields/Modify.html
new file mode 100644
index 0000000..79c8c97
--- /dev/null
+++ b/html/Admin/CustomFields/Modify.html
@@ -0,0 +1,322 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2010 Best Practical Solutions, LLC
+%#                                          <jesse@bestpractical.com>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<& /Admin/Elements/Header, Title => $title &>
+<& /Elements/Tabs &>
+<& /Elements/ListActions, actions => \@results &>
+
+
+<form method="post" action="Modify.html" name="ModifyCustomField" id="ModifyCustomField">
+<input type="hidden" class="hidden" name="id" value="<% $id %>" />
+
+<table>
+
+<tr><td class="label"><&|/l&>Name</&></td>
+<td><input name="Name" value="<% $CustomFieldObj->Name || '' %>" size="20" /></td></tr>
+
+<tr><td class="label"><&|/l&>Description</&></td>
+<td><input name="Description" value="<% $CustomFieldObj->Description || '' %>" size="80" /></td></tr>
+
+<tr><td class="label"><&|/l&>Type</&></td>
+<td><& /Admin/Elements/SelectCustomFieldType, 
+        Name => "TypeComposite", 
+        Default => $CustomFieldObj->TypeComposite, &>
+</td></tr>
+
+% if ( $CustomFieldObj->Id and $CustomFieldObj->HasRenderTypes ) {
+<tr>
+  <td class="label"><&|/l&>Render Type</&></td>
+  <td>
+    <& /Admin/Elements/SelectCustomFieldRenderType,
+        Name            => "RenderType",
+        TypeComposite   => $CustomFieldObj->TypeComposite,
+        Default         => $CustomFieldObj->RenderType, 
+        BasedOn         => $CustomFieldObj->BasedOnObj->id, &>
+  </td>
+</tr>
+% }
+
+% if ( $CustomFieldObj->Id and $CustomFieldObj->IsSelectionType and RT->Config->Get('CustomFieldValuesSources') and ( scalar(@{RT->Config->Get('CustomFieldValuesSources')}) > 0 ) ) {
+<tr><td class="label"><&|/l&>Field values source:</&></td><td>
+<& /Admin/Elements/EditCustomFieldValuesSource, CustomField => $CustomFieldObj &>
+</td></tr>
+% }
+
+<tr><td class="label"><&|/l&>Applies to</&></td>
+<td><& /Admin/Elements/SelectCustomFieldLookupType, 
+        Name => "LookupType", 
+        Default => $CustomFieldObj->LookupType, &>
+</td></tr>
+
+<tr class="edit_validation"><td class="label"><&|/l&>Validation</&></td>
+<td><& /Widgets/ComboBox,
+    Name    => 'Pattern',
+    Default => $CustomFieldObj->Pattern,
+    Size    => 20,
+    Values  => \@CFvalidations,
+&></td></tr>
+
+<tr><td class="label"><&|/l&>Link values to</&></td><td>
+<input size="60" name="LinkValueTo"  value="<% $CustomFieldObj->LinkValueTo || '' %>" />
+<div class="hints">
+<&|/l&>RT can make this custom field's values into hyperlinks to another service.</&>
+<&|/l&>Fill in this field with a URL.</&>
+<&|/l&>RT will replace <tt>__id__</tt> and <tt>__CustomField__</tt> with the record id and custom field value, respectively</&>
+</div></td></tr>
+
+<tr><td class="label"><&|/l&>Include page</&></td><td>
+<input size="60" name="IncludeContentForValue" value="<% $CustomFieldObj->IncludeContentForValue || '' %>" />
+<div class="hints">
+<&|/l&>RT can include content from another web service when showing this custom field.</&>
+<&|/l&>Fill in this field with a URL.</&>
+<&|/l&>RT will replace <tt>__id__</tt> and <tt>__CustomField__</tt> with the record id and custom field value, respectively</&>
+<i><&|/l&>Some browsers may only load content from the same domain as your RT server.</&></i>
+</div></td></tr>
+
+% if ( $CustomFieldObj->Id && $CustomFieldObj->IsSelectionType && !$CustomFieldObj->IsExternalValues ) {
+<tr class="categoriesbasedon"><td class="label"><&|/l&>Categories are based on</&></td><td>
+<& /Admin/Elements/SelectCustomField,
+    Name => "BasedOn",
+    LookupType => $CustomFieldObj->LookupType,
+    Default => $CustomFieldObj->BasedOnObj,
+    Not => $CustomFieldObj->id,
+&>
+</td></tr>
+% }
+
+% $m->callback(CallbackName => 'BeforeEnabled', CustomField => $CustomFieldObj, CFvalidations => \@CFvalidations);
+%# MandatoryCustomFields
+<tr><td class="label">&nbsp;</td><td>
+<input type="checkbox" class="checkbox" name="Required" value="1" <% $RequiredChecked |n%>/>
+<&|/l&>Required for ticket resolution</&>
+</td></tr>
+%# MandatoryCustomFields
+<tr><td class="label">&nbsp;</td><td>
+<input type="hidden" class="hidden" name="SetEnabled" value="1" />
+<input type="checkbox" class="checkbox" name="Enabled" value="1" <% $EnabledChecked |n%> />
+<&|/l&>Enabled (Unchecking this box disables this custom field)</&>
+</td></tr>
+
+% $m->callback(CallbackName => 'EndOfTable', CustomField => $CustomFieldObj, CFvalidations => \@CFvalidations);
+
+</table>
+
+% if ( $CustomFieldObj->Id && $CustomFieldObj->IsSelectionType && !$CustomFieldObj->IsExternalValues ) {
+<h2><&|/l&>Values</&></h2>
+<div>
+<& /Admin/Elements/EditCustomFieldValues, CustomField => $CustomFieldObj &>
+<& /Admin/Elements/AddCustomFieldValue, CustomField => $CustomFieldObj &>
+</div>
+% }
+
+<& /Elements/Submit, Name => 'Update', Label => $id eq 'new'? loc('Create'): loc('Save Changes') &>
+
+</form>
+<%INIT>
+my ($title, @results, $Disabled);
+
+my $CustomFieldObj = RT::CustomField->new( $session{'CurrentUser'} );
+
+$m->callback(CallbackName => 'Initial', Pattern => \$Pattern, ARGSRef => \%ARGS);
+
+unless ( $id ) {
+    $title = loc("Create a CustomField");
+    $id    = 'new';
+}
+else {
+    if ( $id eq 'new' ) {
+        my ( $val, $msg ) = $CustomFieldObj->Create(
+            Name          => $Name,
+            TypeComposite => $TypeComposite,
+            LookupType    => $LookupType,
+            Description   => $Description,
+            Pattern       => $Pattern,
+            LinkValueTo   => $LinkValueTo,
+            IncludeContentForValue => $IncludeContentForValue,
+            BasedOn       => $BasedOn,
+        );
+        $m->comp( "/Elements/Error", Why => loc( "Could not create CustomField", $msg ) ) unless $val;
+        push @results, $msg;
+        $title = loc( 'Created CustomField [_1]', $CustomFieldObj->Name );
+    } else {
+        $CustomFieldObj->Load( $id ) || $m->comp("/Elements/Error", Why => loc('No CustomField') );
+        $title = loc( 'Editing CustomField [_1]', $CustomFieldObj->Name );
+    }
+}
+
+if ( $ARGS{'Update'} && $id ne 'new' ) {
+
+    #we're asking about enabled on the web page but really care about disabled.
+    $ARGS{'Disabled'} = $Disabled = $Enabled? 0 : 1;
+# MandatoryCustomFields
+    $ARGS{'Required'} ||= 0;
+
+    my @attribs = qw(Disabled Required Pattern Name TypeComposite LookupType Description LinkValueTo IncludeContentForValue);
+# MandatoryCustomFields
+    push @results, UpdateRecordObject(
+        AttributesRef => \@attribs,
+        Object        => $CustomFieldObj,
+        ARGSRef       => \%ARGS
+    );
+    $CustomFieldObj->SetValuesClass( $ValuesClass );
+
+    # Set the render type if we have it, but unset it if the new type doesn't
+    # support render types
+    if ( $CustomFieldObj->HasRenderTypes($TypeComposite) ) {
+        my $original = $CustomFieldObj->RenderType;
+
+        if ( defined $RenderType and $RenderType ne $original ) {
+            # It's changed!  Let's update it.
+            my ($good, $msg) = $CustomFieldObj->SetRenderType( $RenderType );
+
+            if ( $good ) {
+                $msg = loc("[_1] changed from '[_2]' to '[_3]'",
+                            loc("Render Type"), $original, $RenderType );
+            }
+
+            push @results, $msg;
+        }
+    }
+    else {
+        # Delete it if we no longer support render types
+        $CustomFieldObj->SetRenderType( undef );
+    }
+
+    my ($good, $msg) = $CustomFieldObj->SetBasedOn( $BasedOn );
+    push @results, $msg unless $good or $msg =~ /No entry found/;
+
+    my $paramtag = "CustomField-". $CustomFieldObj->Id ."-Value";
+    # Delete any fields that want to be deleted
+    foreach my $key ( keys %ARGS ) {
+        next unless $key =~ /^Delete-$paramtag-(\d+)$/o;
+        my ($val, $msg) = $CustomFieldObj->DeleteValue( $1 );
+        push (@results, $msg);
+    }
+
+    # Update any existing values
+    my $values = $CustomFieldObj->ValuesObj;
+    while ( my $value = $values->Next ) {
+        foreach my $attr (qw(Name Description SortOrder Category)) {
+            my $param = join("-", $paramtag, $value->Id, $attr);
+            next unless exists $ARGS{$param};
+            $ARGS{$param} =~ s/^\s+//;
+            $ARGS{$param} =~ s/\s+$//;
+            next if ($value->$attr()||'') eq ($ARGS{$param}||'');
+
+            my $mutator = "Set$attr";
+            my ($id, $msg) = $value->$mutator( $ARGS{$param} );
+            push (@results, $msg);
+        }
+        $m->callback(CallbackName => 'AfterUpdateCustomFieldValue', CustomFieldObj => $CustomFieldObj, CustomFieldValueObj => $value, ARGSRef => \%ARGS );
+    }
+
+    # Add any new values
+    if ( defined $ARGS{ $paramtag ."-new-Name" } && length $ARGS{ $paramtag ."-new-Name" } ) {
+        my ($id, $msg) = $CustomFieldObj->AddValue(
+            map { 
+                $ARGS{$paramtag."-new-$_"} =~ s/^\s+//;
+                $ARGS{$paramtag."-new-$_"} =~ s/\s+$//;
+                $_ => $ARGS{ $paramtag ."-new-$_" } } qw/ Name Description SortOrder Category/
+        );
+        push (@results, $msg);
+
+        my $cfv = RT::CustomFieldValue->new( $session{CurrentUser} );
+        $cfv->Load($id);
+        $m->callback(CallbackName => 'AfterCreateCustomFieldValue',
+CustomFieldObj => $CustomFieldObj, CustomFieldValueObj => $cfv, ARGSRef => \%ARGS );
+    }
+}
+
+
+
+
+$id = $CustomFieldObj->id if $CustomFieldObj->id;
+
+
+# This code does automatic redirection if any updates happen.
+$m->comp(
+    '/Elements/MaybeRedirectForResults',
+    Actions     => \@results,
+    Path        => '/Admin/CustomFields/Modify.html',
+    id              => $id,
+    ARGSRef     => \%ARGS
+);
+
+
+
+my $EnabledChecked = qq[checked="checked"];
+$EnabledChecked = '' if $CustomFieldObj->Disabled;
+
+my $RequiredChecked = '';
+$RequiredChecked = 'checked="checked"' if $CustomFieldObj->Required;
+
+my @CFvalidations = (
+    '(?#Mandatory).',
+    '(?#Digits)^[\d.]+$',
+    '(?#Year)^[12]\d{3}$',
+);
+
+$m->callback(CallbackName => 'ValidationPatterns', Values => \@CFvalidations);
+
+</%INIT>
+<%ARGS>
+$id => undef
+$TypeComposite => undef
+$LookupType => undef
+$MaxValues => undef
+$SortOrder => undef
+$Description => undef
+$Pattern => undef
+$Name => undef
+$SetEnabled => undef
+$Enabled => 0
+$ValuesClass => 'RT::CustomFieldValues'
+$RenderType => undef
+$LinkValueTo => undef
+$IncludeContentForValue => undef
+$BasedOn => undef
+</%ARGS>
diff --git a/html/Callbacks/MandatoryCustomFields/Ticket/Modify.html/Default b/html/Callbacks/MandatoryCustomFields/Ticket/Modify.html/Default
new file mode 100644
index 0000000..5fba7de
--- /dev/null
+++ b/html/Callbacks/MandatoryCustomFields/Ticket/Modify.html/Default
@@ -0,0 +1,21 @@
+<%init>
+my $ARGSRef = $ARGS{'ARGSRef'};
+my $TicketObj = $ARGS{'TicketObj'};
+my $results = $ARGS{'Results'};
+my $oldStatus = $TicketObj->Status();
+my $newStatus = ($ARGSRef->{'resolve'} && 'resolved') || 
+                $ARGSRef->{'Status'} || 
+                $ARGSRef->{'DefaultStatus'};
+if($oldStatus ne 'resolved' and
+   $newStatus eq 'resolved') {
+  my @errors =  
+    $m->comp('/Ticket/Elements/CheckMandatoryFields', Ticket => $TicketObj);
+  return if !@errors;
+  my $msg = 'Missing required field'.(@errors > 1 ? 's' : '').': ' .
+            join(', ', map { $_->Name } @errors);
+  $m->notes( ('InvalidField-' . $_->Id) => 'Required' ) foreach @errors;
+  push @$results, $msg;
+  delete $ARGSRef->{'resolve'};
+  delete $ARGSRef->{'Status'};
+}
+</%init>
diff --git a/html/Callbacks/MandatoryCustomFields/Ticket/Update.html/BeforeUpdate b/html/Callbacks/MandatoryCustomFields/Ticket/Update.html/BeforeUpdate
new file mode 100644
index 0000000..965d00b
--- /dev/null
+++ b/html/Callbacks/MandatoryCustomFields/Ticket/Update.html/BeforeUpdate
@@ -0,0 +1,28 @@
+<%doc>
+When the user tries to change a ticket's status to "resolved" through 
+the Update interface, check mandatory fields.  If they aren't all set, 
+redirect to Ticket Basics instead of updating.  Note that this will 
+lose any comments/time/other information the user has entered.
+</%doc>
+
+<%init>
+my $oldStatus = $TicketObj->Status();
+my $newStatus = $ARGSRef->{'Status'} || $ARGSRef->{'DefaultStatus'} || '';
+if( $oldStatus ne 'resolved' and 
+    $newStatus eq 'resolved' and
+    $m->comp('/Ticket/Elements/CheckMandatoryFields', 
+              Ticket => $TicketObj
+              ) ) {
+    $m->clear_buffer;
+    RT::Interface::Web::Redirect( 
+      RT->Config->Get('WebURL')."Ticket/Modify.html?id=".$TicketObj->Id."&resolve=1"
+    );
+    $m->abort;
+}
+</%init>
+<%args>
+$ARGSRef => {}
+$checks_failure => undef
+$results => []
+$TicketObj => undef
+</%args>
diff --git a/html/Ticket/Elements/CheckMandatoryFields b/html/Ticket/Elements/CheckMandatoryFields
new file mode 100644
index 0000000..3d0324f
--- /dev/null
+++ b/html/Ticket/Elements/CheckMandatoryFields
@@ -0,0 +1,9 @@
+<%init>
+
+my $TicketObj = $ARGS{'Ticket'} or return ();
+my $ARGSRef = $ARGS{'ARGSRef'};
+my @fields = grep { $_->Required } 
+             @{ $TicketObj->CustomFields->ItemsArrayRef };
+return grep { !defined($TicketObj->FirstCustomFieldValue($_->id)) } @fields;
+
+</%init>
diff --git a/html/Ticket/Modify.html b/html/Ticket/Modify.html
new file mode 100755
index 0000000..60880bc
--- /dev/null
+++ b/html/Ticket/Modify.html
@@ -0,0 +1,96 @@
+%# BEGIN BPS TAGGED BLOCK {{{
+%#
+%# COPYRIGHT:
+%#
+%# This software is Copyright (c) 1996-2010 Best Practical Solutions, LLC
+%#                                          <jesse@bestpractical.com>
+%#
+%# (Except where explicitly superseded by other copyright notices)
+%#
+%#
+%# LICENSE:
+%#
+%# This work is made available to you under the terms of Version 2 of
+%# the GNU General Public License. A copy of that license should have
+%# been provided with this software, but in any event can be snarfed
+%# from www.gnu.org.
+%#
+%# This work is distributed in the hope that it will be useful, but
+%# WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%# General Public License for more details.
+%#
+%# You should have received a copy of the GNU General Public License
+%# along with this program; if not, write to the Free Software
+%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+%# 02110-1301 or visit their web page on the internet at
+%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+%#
+%#
+%# CONTRIBUTION SUBMISSION POLICY:
+%#
+%# (The following paragraph is not intended to limit the rights granted
+%# to you to modify and distribute this software under the terms of
+%# the GNU General Public License and is only of importance to you if
+%# you choose to contribute your changes and enhancements to the
+%# community by submitting them to Best Practical Solutions, LLC.)
+%#
+%# By intentionally submitting any modifications, corrections or
+%# derivatives to this work, or any other work intended for use with
+%# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+%# you are the copyright holder for those contributions and you grant
+%# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+%# royalty-free, perpetual, license to use, copy, create derivative
+%# works based on those contributions, and sublicense and distribute
+%# those contributions and any derivatives thereof.
+%#
+%# END BPS TAGGED BLOCK }}}
+<& /Elements/Header, Title => loc('Modify ticket #[_1]', $TicketObj->Id) &>
+<& /Elements/Tabs &>
+
+% $m->callback(CallbackName => 'BeforeActionList', Actions => \@results, ARGSRef => \%ARGS, Ticket => $TicketObj);
+
+<& /Elements/ListActions, actions => \@results &>
+<form method="post" action="Modify.html" enctype="multipart/form-data" name="TicketModify" id="TicketModify">
+% $m->callback( CallbackName => 'FormStart', ARGSRef => \%ARGS );
+<input type="hidden" class="hidden" name="id" value="<% $TicketObj->Id %>" />
+
+<&| /Widgets/TitleBox, title => loc('Modify ticket #[_1]',$TicketObj->Id), class=>'ticket-info-basics' &>
+<& Elements/EditBasics, TicketObj => $TicketObj &>
+<& Elements/EditCustomFields, TicketObj => $TicketObj, DefaultsFromTopArguments => 0 &>
+</&>
+% $m->callback( CallbackName => 'AfterBasics', Ticket => $TicketObj );
+
+<& /Elements/Submit, Name => 'SubmitTicket', Label => loc('Save Changes'), Caption => loc("If you've updated anything above, be sure to"), color => "#993333" &>
+</form>
+<%INIT>
+  
+my $TicketObj = LoadTicket($id);
+my $CustomFields = $TicketObj->CustomFields;
+
+# call this to show up hints of valid cf values.
+$m->comp(
+    '/Elements/ValidateCustomFields',
+    CustomFields => $CustomFields,
+    ARGSRef => {},
+);
+
+my @results;
+
+# Now let callbacks have a chance at editing %ARGS
+$m->callback( TicketObj => $TicketObj, CustomFields => $CustomFields, ARGSRef => \%ARGS, Results => \@results );
+
+push @results, ProcessTicketBasics(TicketObj => $TicketObj, ARGSRef => \%ARGS);
+push @results, ProcessObjectCustomFieldUpdates(Object => $TicketObj, ARGSRef => \%ARGS);
+
+$TicketObj->ApplyTransactionBatch;
+
+# TODO: display the results, even if we can't display the ticket
+unless ($TicketObj->CurrentUserHasRight('ShowTicket')) {
+    Abort("No permission to view ticket");
+} 
+
+</%INIT>
+<%ARGS>
+$id => undef
+</%ARGS>