import rt 3.8.7
[freeside.git] / rt / lib / RT / ObjectCustomField_Overlay.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2
3 # COPYRIGHT:
4
5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
6 #                                          <jesse@bestpractical.com>
7
8 # (Except where explicitly superseded by other copyright notices)
9
10
11 # LICENSE:
12
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
16 # from www.gnu.org.
17
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21 # General Public License for more details.
22
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28
29
30 # CONTRIBUTION SUBMISSION POLICY:
31
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
37
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
46
47 # END BPS TAGGED BLOCK }}}
48
49 package RT::ObjectCustomField;
50
51 use strict;
52 use warnings;
53 no warnings qw(redefine);
54
55 sub Create {
56     my $self = shift;
57     my %args = (
58         CustomField => 0,
59         ObjectId    => 0,
60         SortOrder   => undef,
61         @_
62     );
63
64     my $cf = $self->CustomFieldObj( $args{'CustomField'} );
65     unless ( $cf->id ) {
66         $RT::Logger->error("Couldn't load '$args{'CustomField'}' custom field");
67         return 0;
68     }
69
70     #XXX: Where is ACL check for 'AssignCustomFields'?
71
72     my $ObjectCFs = RT::ObjectCustomFields->new($self->CurrentUser);
73     $ObjectCFs->LimitToObjectId( $args{'ObjectId'} );
74     $ObjectCFs->LimitToCustomField( $cf->id );
75     $ObjectCFs->LimitToLookupType( $cf->LookupType );
76     if ( my $first = $ObjectCFs->First ) {
77         $self->Load( $first->id );
78         return $first->id;
79     }
80
81     unless ( defined $args{'SortOrder'} ) {
82         my $ObjectCFs = RT::ObjectCustomFields->new( $RT::SystemUser );
83         $ObjectCFs->LimitToObjectId( $args{'ObjectId'} );
84         $ObjectCFs->LimitToLookupType( $cf->LookupType );
85         $ObjectCFs->OrderBy( FIELD => 'SortOrder', ORDER => 'DESC' );
86         if ( my $first = $ObjectCFs->First ) {
87             $args{'SortOrder'} = $first->SortOrder + 1;
88         } else {
89             $args{'SortOrder'} = 0;
90         }
91     }
92
93     return $self->SUPER::Create(
94         CustomField => $args{'CustomField'},
95         ObjectId    => $args{'ObjectId'},
96         SortOrder   => $args{'SortOrder'},
97     );
98 }
99
100 sub Delete {
101     my $self = shift;
102
103     my $ObjectCFs = RT::ObjectCustomFields->new($self->CurrentUser);
104     $ObjectCFs->LimitToObjectId($self->ObjectId);
105     $ObjectCFs->LimitToLookupType($self->CustomFieldObj->LookupType);
106
107     # Move everything below us up
108     my $sort_order = $self->SortOrder;
109     while (my $OCF = $ObjectCFs->Next) {
110         my $this_order = $OCF->SortOrder;
111         next if $this_order <= $sort_order; 
112         $OCF->SetSortOrder($this_order - 1);
113     }
114
115     $self->SUPER::Delete;
116 }
117
118 sub CustomFieldObj {
119     my $self = shift;
120     my $id = shift || $self->CustomField;
121     my $CF = RT::CustomField->new( $self->CurrentUser );
122     $CF->Load( $id );
123     return $CF;
124 }
125
126 1;