-# {{{ BEGIN BPS TAGGED BLOCK
-#
+# BEGIN BPS TAGGED BLOCK {{{
+#
# COPYRIGHT:
-#
-# This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC
-# <jesse@bestpractical.com>
-#
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+# <sales@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., 675 Mass Ave, Cambridge, MA 02139, USA.
-#
-#
+# 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
# 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
-# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
-# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
-#
-# !! DO NOT EDIT THIS FILE !!
#
-
-use strict;
-
+# END BPS TAGGED BLOCK }}}
=head1 NAME
- RT::CustomFields -- Class Description
-
+ RT::CustomFields - a collection of RT CustomField objects
+
=head1 SYNOPSIS
- use RT::CustomFields
+ use RT::CustomFields;
=head1 DESCRIPTION
-
=head1 METHODS
+
+
=cut
+
package RT::CustomFields;
-use RT::SearchBuilder;
+use strict;
+use warnings;
+
use RT::CustomField;
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
+use base 'RT::SearchBuilder';
+sub Table { 'CustomFields'}
sub _Init {
my $self = shift;
- $self->{'table'} = 'CustomFields';
- $self->{'primary_key'} = 'id';
+ # By default, order by SortOrder
+ $self->OrderByCols(
+ { ALIAS => 'main',
+ FIELD => 'SortOrder',
+ ORDER => 'ASC' },
+ { ALIAS => 'main',
+ FIELD => 'Name',
+ ORDER => 'ASC' },
+ { ALIAS => 'main',
+ FIELD => 'id',
+ ORDER => 'ASC' },
+ );
+ $self->{'with_disabled_column'} = 1;
+ return ( $self->SUPER::_Init(@_) );
+}
- # By default, order by name
- $self->OrderBy( ALIAS => 'main',
- FIELD => 'SortOrder',
- ORDER => 'ASC');
- return ( $self->SUPER::_Init(@_) );
+=head2 LimitToLookupType
+
+Takes LookupType and limits collection.
+
+=cut
+
+sub LimitToLookupType {
+ my $self = shift;
+ my $lookup = shift;
+
+ $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
}
+=head2 LimitToChildType
-=head2 NewItem
+Takes partial LookupType and limits collection to records
+where LookupType is equal or ends with the value.
-Returns an empty new RT::CustomField item
+=cut
+
+sub LimitToChildType {
+ my $self = shift;
+ my $lookup = shift;
+
+ $self->Limit( FIELD => 'LookupType', VALUE => "$lookup", OPERATOR => "ENDSWITH" );
+}
+
+
+=head2 LimitToParentType
+
+Takes partial LookupType and limits collection to records
+where LookupType is equal or starts with the value.
=cut
-sub NewItem {
+sub LimitToParentType {
+ my $self = shift;
+ my $lookup = shift;
+
+ $self->Limit( FIELD => 'LookupType', VALUE => "$lookup", OPERATOR => "STARTSWITH" );
+}
+
+=head2 LimitToObjectId
+
+Takes an ObjectId and limits the collection to CFs applied to said object.
+
+When called multiple times the ObjectId limits are joined with OR.
+
+=cut
+
+sub LimitToObjectId {
+ my $self = shift;
+ my $id = shift;
+ $self->Limit(
+ ALIAS => $self->_OCFAlias,
+ FIELD => 'ObjectId',
+ OPERATOR => '=',
+ VALUE => $id || 0,
+ ENTRYAGGREGATOR => 'OR'
+ );
+}
+
+=head2 LimitToGlobalOrObjectId
+
+Takes list of object IDs and limits collection to custom
+fields that are applied to these objects or globally.
+
+=cut
+
+sub LimitToGlobalOrObjectId {
+ my $self = shift;
+ my $global_only = 1;
+
+
+ foreach my $id (@_) {
+ $self->LimitToObjectId($id);
+ $global_only = 0 if $id;
+ }
+
+ $self->LimitToObjectId(0) unless $global_only;
+}
+
+sub _LimitToOCFs {
+ my $self = shift;
+ my @ids = @_;
+
+ my $ocfs_alias = $self->_OCFAlias( New => 1, Left => 1 );
+ if ( @ids ) {
+ # XXX: we need different EA in join clause, but DBIx::SB
+ # doesn't support them, use IN (X) instead
+ my $dbh = $self->_Handle->dbh;
+ $self->Limit(
+ LEFTJOIN => $ocfs_alias,
+ ALIAS => $ocfs_alias,
+ FIELD => 'ObjectId',
+ OPERATOR => 'IN',
+ QUOTEVALUE => 0,
+ VALUE => "(". join( ',', map $dbh->quote($_), @ids ) .")",
+ );
+ }
+
+ return $ocfs_alias;
+}
+
+=head2 LimitToNotApplied
+
+Takes either list of object ids or nothing. Limits collection
+to custom fields to listed objects or any corespondingly. Use
+zero to mean global.
+
+=cut
+
+sub LimitToNotApplied {
+ my $self = shift;
+ my @ids = @_;
+
+ my $ocfs_alias = $self->_LimitToOCFs(@ids);
+
+ $self->Limit(
+ ENTRYAGGREGATOR => 'AND',
+ ALIAS => $ocfs_alias,
+ FIELD => 'id',
+ OPERATOR => 'IS',
+ VALUE => 'NULL',
+ );
+}
+
+=head2 LimitToApplied
+
+Limits collection to custom fields to listed objects or any corespondingly. Use
+zero to mean global.
+
+=cut
+
+sub LimitToApplied {
+ my $self = shift;
+ my @ids = @_;
+
+ my $ocfs_alias = $self->_LimitToOCFs(@ids);
+
+ $self->Limit(
+ ENTRYAGGREGATOR => 'AND',
+ ALIAS => $ocfs_alias,
+ FIELD => 'id',
+ OPERATOR => 'IS NOT',
+ VALUE => 'NULL',
+ );
+}
+
+=head2 LimitToGlobalOrQueue QUEUEID
+
+DEPRECATED since CFs are applicable not only to tickets these days.
+
+Limits the set of custom fields found to global custom fields or those tied to the queue with ID QUEUEID
+
+=cut
+
+sub LimitToGlobalOrQueue {
+ my $self = shift;
+ my $queue = shift;
+ $self->LimitToGlobalOrObjectId( $queue );
+ $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
+}
+
+
+=head2 LimitToQueue QUEUEID
+
+DEPRECATED since CFs are applicable not only to tickets these days.
+
+Takes a queue id (numerical) as its only argument. Makes sure that
+Scopes it pulls out apply to this queue (or another that you've selected with
+another call to this method
+
+=cut
+
+sub LimitToQueue {
+ my $self = shift;
+ my $queue = shift;
+
+ $self->Limit (ALIAS => $self->_OCFAlias,
+ ENTRYAGGREGATOR => 'OR',
+ FIELD => 'ObjectId',
+ VALUE => "$queue")
+ if defined $queue;
+ $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
+}
+
+
+=head2 LimitToGlobal
+
+DEPRECATED since CFs are applicable not only to tickets these days.
+
+Makes sure that Scopes it pulls out apply to all queues
+(or another that you've selected with
+another call to this method or LimitToQueue)
+
+=cut
+
+sub LimitToGlobal {
+ my $self = shift;
+
+ $self->Limit (ALIAS => $self->_OCFAlias,
+ ENTRYAGGREGATOR => 'OR',
+ FIELD => 'ObjectId',
+ VALUE => 0);
+ $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
+}
+
+
+=head2 ApplySortOrder
+
+Sort custom fields according to thier order application to objects. It's
+expected that collection contains only records of one
+L<RT::CustomField/LookupType> and applied to one object or globally
+(L</LimitToGlobalOrObjectId>), otherwise sorting makes no sense.
+
+=cut
+
+sub ApplySortOrder {
my $self = shift;
- return(RT::CustomField->new($self->CurrentUser));
+ my $order = shift || 'ASC';
+ $self->OrderByCols( {
+ ALIAS => $self->_OCFAlias,
+ FIELD => 'SortOrder',
+ ORDER => $order,
+ } );
}
- eval "require RT::CustomFields_Overlay";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFields_Overlay.pm}) {
- die $@;
- };
- eval "require RT::CustomFields_Vendor";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFields_Vendor.pm}) {
- die $@;
- };
+=head2 ContextObject
- eval "require RT::CustomFields_Local";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFields_Local.pm}) {
- die $@;
- };
+Returns context object for this collection of custom fields,
+but only if it's defined.
+=cut
+sub ContextObject {
+ my $self = shift;
+ return $self->{'context_object'};
+}
-=head1 SEE ALSO
+=head2 SetContextObject
-This class allows "overlay" methods to be placed
-into the following files _Overlay is for a System overlay by the original author,
-_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
+Sets context object for this collection of custom fields.
-These overlay files can contain new subs or subs to replace existing subs in this module.
+=cut
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line
+sub SetContextObject {
+ my $self = shift;
+ return $self->{'context_object'} = shift;
+}
- no warnings qw(redefine);
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+sub _OCFAlias {
+ my $self = shift;
+ my %args = ( New => 0, Left => 0, @_ );
+
+ return $self->{'_sql_ocfalias'} if $self->{'_sql_ocfalias'} && !$args{'New'};
+
+ my $alias = $self->Join(
+ $args{'Left'} ? (TYPE => 'LEFT') : (),
+ ALIAS1 => 'main',
+ FIELD1 => 'id',
+ TABLE2 => 'ObjectCustomFields',
+ FIELD2 => 'CustomField'
+ );
+ return $alias if $args{'New'};
+ return $self->{'_sql_ocfalias'} = $alias;
+}
+
+
+=head2 AddRecord
-RT::CustomFields_Overlay, RT::CustomFields_Vendor, RT::CustomFields_Local
+Overrides the collection to ensure that only custom fields the user can
+see are returned; also propagates down the L</ContextObject>.
=cut
+sub AddRecord {
+ my $self = shift;
+ my ($record) = @_;
+
+ $record->SetContextObject( $self->ContextObject );
+ return unless $record->CurrentUserHasRight('SeeCustomField');
+ return $self->SUPER::AddRecord( $record );
+}
+
+=head2 NewItem
+
+Returns an empty new RT::CustomField item
+Overrides <RT::SearchBuilder/NewItem> to make sure </ContextObject>
+is inherited.
+
+=cut
+
+sub NewItem {
+ my $self = shift;
+ my $res = RT::CustomField->new($self->CurrentUser);
+ $res->SetContextObject($self->ContextObject);
+ return $res;
+}
+
+RT::Base->_ImportOverlays();
1;
projects / freeside.git / blobdiff