rt 4.2.15

[freeside.git] / rt / lib / RT / ObjectCustomFieldValues.pm

diff --git a/rt/lib/RT/ObjectCustomFieldValues.pm b/rt/lib/RT/ObjectCustomFieldValues.pm
index dad4a69..e9466d5 100644 (file)
--- a/rt/lib/RT/ObjectCustomFieldValues.pm
+++ b/rt/lib/RT/ObjectCustomFieldValues.pm
@@ -2,7 +2,7 @@
 #
 # COPYRIGHT:
 #
-# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2018 Best Practical Solutions, LLC
 #                                          <sales@bestpractical.com>
 #
 # (Except where explicitly superseded by other copyright notices)
@@ -50,11 +50,15 @@ package RT::ObjectCustomFieldValues;
 
 use strict;
 use warnings;
+use 5.010;
 
+use base 'RT::SearchBuilder';
 
 use RT::ObjectCustomFieldValue;
 
-use base 'RT::SearchBuilder';
+# Set up the OCFV cache for faster comparison on add/update
+our $_OCFV_CACHE;
+ClearOCFVCache();
 
 sub Table { 'ObjectCustomFieldValues'}
 
@@ -63,17 +67,26 @@ sub _Init {
 
   # By default, order by SortOrder
   $self->OrderByCols(
-        { ALIAS => 'main',
-          FIELD => 'SortOrder',
-          ORDER => 'ASC' },
-        { ALIAS => 'main',
-          FIELD => 'id',
-          ORDER => 'ASC' },
+         { ALIAS => 'main',
+           FIELD => 'SortOrder',
+           ORDER => 'ASC' },
+         { ALIAS => 'main',
+           FIELD => 'id',
+           ORDER => 'ASC' },
      );
 
     return ( $self->SUPER::_Init(@_) );
 }
 
+=head2 ClearOCFVCache
+
+Cleans out and reinitializes the OCFV cache
+
+=cut
+
+sub ClearOCFVCache {
+    $_OCFV_CACHE = {}
+}
 
 # {{{ sub LimitToCustomField
 
@@ -115,10 +128,10 @@ sub LimitToObject {
 }
 
 
-=head2 HasEntry VALUE
+=head2 HasEntry CONTENT LARGE_CONTENT
 
-If this collection has an entry with content that eq VALUE then
-returns the entry, otherwise returns undef.
+If this collection has an entry with content that eq CONTENT and large content
+that eq LARGE_CONTENT then returns the entry, otherwise returns undef.
 
 =cut
 
@@ -126,20 +139,79 @@ returns the entry, otherwise returns undef.
 sub HasEntry {
     my $self = shift;
     my $value = shift;
+    my $large_content = shift;
     return undef unless defined $value && length $value;
 
-    #TODO: this could cache and optimize a fair bit.
-    foreach my $item ( @{$self->ItemsArrayRef} ) {
-        return $item if lc $item->Content eq lc $value;
+    my $first = $self->First;
+    return undef unless $first;  # No entries to check
+
+    # Key should be the same for all values of the same ocfv
+    my $ocfv_key = $first->GetOCFVCacheKey;
+
+    # This cache relieves performance issues when adding large numbers of values
+    # to a CF since each add compares against the full list each time.
+
+    unless ( $_OCFV_CACHE->{$ocfv_key} ) {
+        # Load the cache with existing values
+        foreach my $item ( @{$self->ItemsArrayRef} ) {
+            push @{$_OCFV_CACHE->{$ocfv_key}}, {
+                'ObjectId'       => $item->Id,
+                'CustomFieldObj' => $item->CustomFieldObj,
+                'Content'        => $item->_Value('Content'),
+                'LargeContent'   => $item->LargeContent };
+        }
+    }
+
+    my %canon_value;
+    my $item_id;
+    foreach my $item ( @{$_OCFV_CACHE->{$ocfv_key}} ) {
+        my $cf = $item->{'CustomFieldObj'};
+        my $args = $canon_value{ $cf->Type };
+        if ( !$args ) {
+            $args = { Content => $value, LargeContent => $large_content };
+            my ($ok, $msg) = $cf->_CanonicalizeValue( $args );
+            next unless $ok;
+            $canon_value{ $cf->Type } = $args;
+        }
+
+        if ( $cf->Type eq 'Select' ) {
+            # select is case insensitive
+            $item_id = $item->{'ObjectId'} if lc $item->{'Content'} eq lc $args->{Content};
+        }
+        else {
+            if ( ($item->{'Content'} // '') eq $args->{Content} ) {
+                if ( defined $item->{'LargeContent'} ) {
+                    $item_id = $item->{'ObjectId'}
+                      if defined $args->{LargeContent}
+                      && $item->{'LargeContent'} eq $args->{LargeContent};
+                }
+                else {
+                    $item_id = $item->{'ObjectId'} unless defined $args->{LargeContent};
+                }
+            } elsif ( $item->{'LargeContent'} && $args->{Content} ) {
+                $item_id = $item->{'ObjectId'} if ($item->{'LargeContent'} eq $args->{Content});
+            }
+        }
+        last if $item_id;
+    }
+
+    if ( $item_id ) {
+        my $ocfv = RT::ObjectCustomFieldValue->new( $self->CurrentUser );
+        my ($ret, $msg) = $ocfv->Load($item_id);
+        RT::Logger->error("Unable to load object custom field value from id: $item_id $msg")
+            unless $ret;
+        return $ocfv;
+    }
+    else {
+        return undef;
     }
-    return undef;
 }
 
 sub _DoSearch {
     my $self = shift;
     
     # unless we really want to find disabled rows,
-    # make sure we\'re only finding enabled ones.
+    # make sure we're only finding enabled ones.
     unless ( $self->{'find_expired_rows'} ) {
         $self->LimitToEnabled();
     }
@@ -151,7 +223,7 @@ sub _DoCount {
     my $self = shift;
     
     # unless we really want to find disabled rows,
-    # make sure we\'re only finding enabled ones.
+    # make sure we're only finding enabled ones.
     unless ( $self->{'find_expired_rows'} ) {
         $self->LimitToEnabled();
     }
@@ -159,17 +231,14 @@ sub _DoCount {
     return $self->SUPER::_DoCount(@_);
 }
 
+RT::Base->_ImportOverlays();
 
-=head2 NewItem
-
-Returns an empty new RT::ObjectCustomFieldValue item
-
-=cut
+# Clear the OCVF cache on exit to release connected RT::Ticket objects.
+#
+# Without this, there could be warnings generated like "Too late to safely run
+# transaction-batch scrips...". You can test this by commenting it out and running
+# some cf tests, e.g. perl -Ilib t/customfields/enter_one.t
+END { ClearOCFVCache(); }
 
-sub NewItem {
-    my $self = shift;
-    return(RT::ObjectCustomFieldValue->new($self->CurrentUser));
-}
-RT::Base->_ImportOverlays();
 
 1;