import torrus 1.0.9
[freeside.git] / rt / lib / RT / ObjectCustomField_Overlay.pm
index c4eb437..719fad0 100644 (file)
@@ -1,8 +1,8 @@
 # BEGIN BPS TAGGED BLOCK {{{
 # 
 # COPYRIGHT:
-#  
-# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC 
+# 
+# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
 #                                          <jesse@bestpractical.com>
 # 
 # (Except where explicitly superseded by other copyright notices)
 # those contributions and any derivatives thereof.
 # 
 # END BPS TAGGED BLOCK }}}
+
 package RT::ObjectCustomField;
 
 use strict;
+use warnings;
 no warnings qw(redefine);
 
 sub Create {
     my $self = shift;
-    my %args = ( 
-                CustomField => '0',
-                ObjectId => '0',
-               SortOrder => undef,
-                 @_);
-
-    if (!defined $args{SortOrder}) {
-       my $CF = $self->CustomFieldObj($args{'CustomField'});
-       my $ObjectCFs = RT::ObjectCustomFields->new($self->CurrentUser);
-       $ObjectCFs->LimitToObjectId($args{'ObjectId'});
-       $ObjectCFs->LimitToLookupType($CF->LookupType);
-
-       $args{SortOrder} = $ObjectCFs->Count + 1;
+    my %args = (
+        CustomField => 0,
+        ObjectId    => 0,
+        SortOrder   => undef,
+        @_
+    );
+
+    my $cf = $self->CustomFieldObj( $args{'CustomField'} );
+    unless ( $cf->id ) {
+        $RT::Logger->error("Couldn't load '$args{'CustomField'}' custom field");
+        return 0;
+    }
+
+    #XXX: Where is ACL check for 'AssignCustomFields'?
+
+    my $ObjectCFs = RT::ObjectCustomFields->new($self->CurrentUser);
+    $ObjectCFs->LimitToObjectId( $args{'ObjectId'} );
+    $ObjectCFs->LimitToCustomField( $cf->id );
+    $ObjectCFs->LimitToLookupType( $cf->LookupType );
+    if ( my $first = $ObjectCFs->First ) {
+        $self->Load( $first->id );
+        return $first->id;
     }
 
-    $self->SUPER::Create(
-                         CustomField => $args{'CustomField'},
-                         ObjectId => $args{'ObjectId'},
-                         SortOrder => $args{'SortOrder'},
-                    );
+    unless ( defined $args{'SortOrder'} ) {
+        my $ObjectCFs = RT::ObjectCustomFields->new( $RT::SystemUser );
+        $ObjectCFs->LimitToObjectId( $args{'ObjectId'} );
+        $ObjectCFs->LimitToObjectId( 0 ) if $args{'ObjectId'};
+        $ObjectCFs->LimitToLookupType( $cf->LookupType );
+        $ObjectCFs->OrderBy( FIELD => 'SortOrder', ORDER => 'DESC' );
+        if ( my $first = $ObjectCFs->First ) {
+            $args{'SortOrder'} = $first->SortOrder + 1;
+        } else {
+            $args{'SortOrder'} = 0;
+        }
+    }
+
+    return $self->SUPER::Create(
+        CustomField => $args{'CustomField'},
+        ObjectId    => $args{'ObjectId'},
+        SortOrder   => $args{'SortOrder'},
+    );
 }
 
 sub Delete {
@@ -84,9 +108,9 @@ sub Delete {
     # Move everything below us up
     my $sort_order = $self->SortOrder;
     while (my $OCF = $ObjectCFs->Next) {
-       my $this_order = $OCF->SortOrder;
-       next if $this_order <= $sort_order; 
-       $OCF->SetSortOrder($this_order - 1);
+        my $this_order = $OCF->SortOrder;
+        next if $this_order <= $sort_order; 
+        $OCF->SetSortOrder($this_order - 1);
     }
 
     $self->SUPER::Delete;
@@ -95,9 +119,150 @@ sub Delete {
 sub CustomFieldObj {
     my $self = shift;
     my $id = shift || $self->CustomField;
-    my $CF = RT::CustomField->new($self->CurrentUser);
-    $CF->Load($id) or die "Cannot load CustomField $id";
+    my $CF = RT::CustomField->new( $self->CurrentUser );
+    $CF->Load( $id );
     return $CF;
 }
 
+=head2 Sorting custom fields applications
+
+Custom fields sorted on multiple layers. First of all custom
+fields with different lookup type are sorted indepedantly. All
+global custom fields have fixed order for all objects, but you
+can insert object specific custom fields between them. Object
+specific custom fields can be applied to several objects and
+be on different place. For example you have GCF1, GCF2, LCF1,
+LCF2 and LCF3 that applies to tickets. You can place GCF2
+above GCF1, but they will be in the same order in all queues.
+However, LCF1 and other local can be placed at any place
+for particular queue: above global, between them or below.
+
+=head3 MoveDown
+
+Moves custom field up. See </Sorting custom fields applications>.
+
+=cut
+
+sub MoveUp {
+    my $self = shift;
+
+    my $ocfs = RT::ObjectCustomFields->new( $self->CurrentUser );
+
+    my $oid = $self->ObjectId;
+    $ocfs->LimitToObjectId( $oid );
+    if ( $oid ) {
+        $ocfs->LimitToObjectId( 0 );
+    }
+
+    my $cf = $self->CustomFieldObj;
+    $ocfs->LimitToLookupType( $cf->LookupType );
+
+    $ocfs->Limit( FIELD => 'SortOrder', OPERATOR => '<', VALUE => $self->SortOrder );
+    $ocfs->OrderByCols( { FIELD => 'SortOrder', ORDER => 'DESC' } );
+
+    my @above = ($ocfs->Next, $ocfs->Next);
+    unless ($above[0]) {
+        return (0, "Can not move up. It's already at the top");
+    }
+
+    my $new_sort_order;
+    if ( $above[0]->ObjectId == $self->ObjectId ) {
+        $new_sort_order = $above[0]->SortOrder;
+        my ($status, $msg) = $above[0]->SetSortOrder( $self->SortOrder );
+        unless ( $status ) {
+            return (0, "Couldn't move custom field");
+        }
+    }
+    elsif ( $above[1] && $above[0]->SortOrder == $above[1]->SortOrder + 1 ) {
+        my $move_ocfs = RT::ObjectCustomFields->new( $RT::SystemUser );
+        $move_ocfs->LimitToLookupType( $cf->LookupType );
+        $move_ocfs->Limit(
+            FIELD => 'SortOrder',
+            OPERATOR => '>=',
+            VALUE => $above[0]->SortOrder,
+        );
+        $move_ocfs->OrderByCols( { FIELD => 'SortOrder', ORDER => 'DESC' } );
+        while ( my $record = $move_ocfs->Next ) {
+            my ($status, $msg) = $record->SetSortOrder( $record->SortOrder + 1 );
+            unless ( $status ) {
+                return (0, "Couldn't move custom field");
+            }
+        }
+        $new_sort_order = $above[0]->SortOrder;
+    } else {
+        $new_sort_order = $above[0]->SortOrder - 1;
+    }
+
+    my ($status, $msg) = $self->SetSortOrder( $new_sort_order );
+    unless ( $status ) {
+        return (0, "Couldn't move custom field");
+    }
+
+    return (1,"Moved custom field up");
+}
+
+=head3 MoveDown
+
+Moves custom field down. See </Sorting custom fields applications>.
+
+=cut
+
+sub MoveDown {
+    my $self = shift;
+
+    my $ocfs = RT::ObjectCustomFields->new( $self->CurrentUser );
+
+    my $oid = $self->ObjectId;
+    $ocfs->LimitToObjectId( $oid );
+    if ( $oid ) {
+        $ocfs->LimitToObjectId( 0 );
+    }
+
+    my $cf = $self->CustomFieldObj;
+    $ocfs->LimitToLookupType( $cf->LookupType );
+
+    $ocfs->Limit( FIELD => 'SortOrder', OPERATOR => '>', VALUE => $self->SortOrder );
+    $ocfs->OrderByCols( { FIELD => 'SortOrder', ORDER => 'ASC' } );
+
+    my @below = ($ocfs->Next, $ocfs->Next);
+    unless ($below[0]) {
+        return (0, "Can not move down. It's already at the bottom");
+    }
+
+    my $new_sort_order;
+    if ( $below[0]->ObjectId == $self->ObjectId ) {
+        $new_sort_order = $below[0]->SortOrder;
+        my ($status, $msg) = $below[0]->SetSortOrder( $self->SortOrder );
+        unless ( $status ) {
+            return (0, "Couldn't move custom field");
+        }
+    }
+    elsif ( $below[1] && $below[0]->SortOrder + 1 == $below[1]->SortOrder ) {
+        my $move_ocfs = RT::ObjectCustomFields->new( $RT::SystemUser );
+        $move_ocfs->LimitToLookupType( $cf->LookupType );
+        $move_ocfs->Limit(
+            FIELD => 'SortOrder',
+            OPERATOR => '<=',
+            VALUE => $below[0]->SortOrder,
+        );
+        $move_ocfs->OrderByCols( { FIELD => 'SortOrder', ORDER => 'ASC' } );
+        while ( my $record = $move_ocfs->Next ) {
+            my ($status, $msg) = $record->SetSortOrder( $record->SortOrder - 1 );
+            unless ( $status ) {
+                return (0, "Couldn't move custom field");
+            }
+        }
+        $new_sort_order = $below[0]->SortOrder;
+    } else {
+        $new_sort_order = $below[0]->SortOrder + 1;
+    }
+
+    my ($status, $msg) = $self->SetSortOrder( $new_sort_order );
+    unless ( $status ) {
+        return (0, "Couldn't move custom field");
+    }
+
+    return (1,"Moved custom field down");
+}
+
 1;