Patch against recent OTRS to make dynamic fields writable via SOAP RPC calls

otrs-rpc-dynamgic-fields.patch

diff -ur otrs-3.1.2//bin/cgi-bin/rpc.pl otrs/bin/cgi-bin/rpc.pl
--- otrs-3.1.2//bin/cgi-bin/rpc.pl	2012-01-13 06:03:52.000000000 +0100
+++ otrs/bin/cgi-bin/rpc.pl	2012-03-21 15:42:32.000000000 +0100
@@ -44,6 +44,7 @@
 use Kernel::System::CustomerUser;
 use Kernel::System::CustomerCompany;
 use Kernel::System::Ticket;
+use Kernel::System::DynamicFieldValue;
 use Kernel::System::LinkObject;
 
 use vars qw($VERSION);
@@ -86,6 +87,7 @@
     $CommonObject{CustomerUserObject}    = Kernel::System::CustomerUser->new(%CommonObject);
     $CommonObject{CustomerCompanyObject} = Kernel::System::CustomerCompany->new(%CommonObject);
     $CommonObject{TicketObject}          = Kernel::System::Ticket->new(%CommonObject);
+    $CommonObject{TicketDynamicObject}   = Kernel::System::DynamicFieldValue->new(%CommonObject);
     $CommonObject{LinkObject}            = Kernel::System::LinkObject->new(%CommonObject);
 
     my $RequiredUser     = $CommonObject{ConfigObject}->Get('SOAP::User');

rpc.pl

#!/usr/bin/perl -w
# --
# bin/cgi-bin/rpc.pl - soap handle
# Copyright (C) 2001-2011 OTRS AG, http://otrs.org/
# --
# $Id: rpc.pl,v 1.18 2011/12/20 12:32:21 mb Exp $
# --
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU AFFERO General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# any later version.
#
# This program 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 Affero General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
# or see http://www.gnu.org/licenses/agpl.txt.
# --

use strict;
use warnings;

# use ../../ as lib location
use FindBin qw($Bin);
use lib "$Bin/../..";
use lib "$Bin/../../Kernel/cpan-lib";
use lib "$Bin/../../Custom";

use SOAP::Transport::HTTP;
use Kernel::Config;
use Kernel::System::Encode;
use Kernel::System::Log;
use Kernel::System::DB;
use Kernel::System::PID;
use Kernel::System::Main;
use Kernel::System::Time;
use Kernel::System::User;
use Kernel::System::Group;
use Kernel::System::Queue;
use Kernel::System::CustomerUser;
use Kernel::System::CustomerCompany;
use Kernel::System::Ticket;
use Kernel::System::DynamicFieldValue;
use Kernel::System::LinkObject;

use vars qw($VERSION);
$VERSION = qw($Revision: 1.18 $) [1];

SOAP::Transport::HTTP::CGI->dispatch_to('Core')->handle;

package Core;

sub new {
    my $Self = shift;

    my $Class = ref($Self) || $Self;
    bless {} => $Class;

    return $Self;
}

sub Dispatch {
    my ( $Self, $User, $Pw, $Object, $Method, %Param ) = @_;

    $User ||= '';
    $Pw   ||= '';

    # common objects
    my %CommonObject = ();
    $CommonObject{ConfigObject} = Kernel::Config->new();
    $CommonObject{EncodeObject} = Kernel::System::Encode->new(%CommonObject);
    $CommonObject{LogObject}    = Kernel::System::Log->new(
        LogPrefix => 'OTRS-RPC',
        %CommonObject,
    );
    $CommonObject{MainObject}            = Kernel::System::Main->new(%CommonObject);
    $CommonObject{DBObject}              = Kernel::System::DB->new(%CommonObject);
    $CommonObject{PIDObject}             = Kernel::System::PID->new(%CommonObject);
    $CommonObject{TimeObject}            = Kernel::System::Time->new(%CommonObject);
    $CommonObject{UserObject}            = Kernel::System::User->new(%CommonObject);
    $CommonObject{GroupObject}           = Kernel::System::Group->new(%CommonObject);
    $CommonObject{QueueObject}           = Kernel::System::Queue->new(%CommonObject);
    $CommonObject{CustomerUserObject}    = Kernel::System::CustomerUser->new(%CommonObject);
    $CommonObject{CustomerCompanyObject} = Kernel::System::CustomerCompany->new(%CommonObject);
    $CommonObject{TicketObject}          = Kernel::System::Ticket->new(%CommonObject);
    $CommonObject{TicketDynamicObject}   = Kernel::System::DynamicFieldValue->new(%CommonObject);
    $CommonObject{LinkObject}            = Kernel::System::LinkObject->new(%CommonObject);

    my $RequiredUser     = $CommonObject{ConfigObject}->Get('SOAP::User');
    my $RequiredPassword = $CommonObject{ConfigObject}->Get('SOAP::Password');

    if (
        !defined $RequiredUser
        || !length $RequiredUser
        || !defined $RequiredPassword || !length $RequiredPassword
        )
    {
        $CommonObject{LogObject}->Log(
            Priority => 'notice',
            Message  => "SOAP::User or SOAP::Password is empty, SOAP access denied!",
        );
        return;
    }

    if ( $User ne $RequiredUser || $Pw ne $RequiredPassword ) {
        $CommonObject{LogObject}->Log(
            Priority => 'notice',
            Message  => "Auth for user $User (pw $Pw) failed!",
        );
        return;
    }

    if ( !$CommonObject{$Object} ) {
        $CommonObject{LogObject}->Log(
            Priority => 'error',
            Message  => "No such Object $Object!",
        );
        return "No such Object $Object!";
    }

    return $CommonObject{$Object}->$Method(%Param);
}

=item DispatchMultipleTicketMethods()

to dispatch multiple ticket methods and get the TicketID

    my $TicketID = $RPC->DispatchMultipleTicketMethods(
        $SOAP_User,
        $SOAP_Pass,
        'TicketObject',
        [ { Method => 'TicketCreate', Parameter => \%TicketData }, { Method => 'ArticleCreate', Parameter => \%ArticleData } ],
    );

=cut

sub DispatchMultipleTicketMethods {
    my ( $Self, $User, $Pw, $Object, $MethodParamArrayRef ) = @_;

    $User ||= '';
    $Pw   ||= '';

    # common objects
    my %CommonObject = ();
    $CommonObject{ConfigObject} = Kernel::Config->new();
    $CommonObject{EncodeObject} = Kernel::System::Encode->new(%CommonObject);
    $CommonObject{LogObject}    = Kernel::System::Log->new(
        LogPrefix => 'OTRS-RPC',
        %CommonObject,
    );
    $CommonObject{MainObject}            = Kernel::System::Main->new(%CommonObject);
    $CommonObject{DBObject}              = Kernel::System::DB->new(%CommonObject);
    $CommonObject{PIDObject}             = Kernel::System::PID->new(%CommonObject);
    $CommonObject{TimeObject}            = Kernel::System::Time->new(%CommonObject);
    $CommonObject{UserObject}            = Kernel::System::User->new(%CommonObject);
    $CommonObject{GroupObject}           = Kernel::System::Group->new(%CommonObject);
    $CommonObject{QueueObject}           = Kernel::System::Queue->new(%CommonObject);
    $CommonObject{CustomerUserObject}    = Kernel::System::CustomerUser->new(%CommonObject);
    $CommonObject{CustomerCompanyObject} = Kernel::System::CustomerCompany->new(%CommonObject);
    $CommonObject{TicketObject}          = Kernel::System::Ticket->new(%CommonObject);
    $CommonObject{LinkObject}            = Kernel::System::LinkObject->new(%CommonObject);

    my $RequiredUser     = $CommonObject{ConfigObject}->Get('SOAP::User');
    my $RequiredPassword = $CommonObject{ConfigObject}->Get('SOAP::Password');

    if (
        !defined $RequiredUser
        || !length $RequiredUser
        || !defined $RequiredPassword || !length $RequiredPassword
        )
    {
        $CommonObject{LogObject}->Log(
            Priority => 'notice',
            Message  => "SOAP::User or SOAP::Password is empty, SOAP access denied!",
        );
        return;
    }

    if ( $User ne $RequiredUser || $Pw ne $RequiredPassword ) {
        $CommonObject{LogObject}->Log(
            Priority => 'notice',
            Message  => "Auth for user $User (pw $Pw) failed!",
        );
        return;
    }

    if ( !$CommonObject{$Object} ) {
        $CommonObject{LogObject}->Log(
            Priority => 'error',
            Message  => "No such Object $Object!",
        );
        return "No such Object $Object!";
    }

    my $TicketID;
    my $Counter;

    for my $MethodParamEntry ( @{$MethodParamArrayRef} ) {

        my $Method    = $MethodParamEntry->{Method};
        my %Parameter = %{ $MethodParamEntry->{Parameter} };

        # push ticket id to params if there is no ticket id
        if ( !$Parameter{TicketID} && $TicketID ) {
            $Parameter{TicketID} = $TicketID;
        }

        my $ReturnValue = $CommonObject{$Object}->$Method(%Parameter);

        # remember ticket id if method was TicketCreate
        if ( !$Counter && $Object eq 'TicketObject' && $Method eq 'TicketCreate' ) {
            $TicketID = $ReturnValue;
        }

        $Counter++;
    }

    return $TicketID;
}

1;