Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Branch: stable
Fetching contributors…

Cannot retrieve contributors at this time

4086 lines (3238 sloc) 129.23 kB
<
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# 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., 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
# you are the copyright holder for those contributions and you grant
# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
# 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 }}}
## Portions Copyright 2000 Tobias Brox <tobix@fsck.com>
## This is a library of static subs to be used by the Mason web
## interface to RT
=head1 NAME
RT::Interface::Web
=cut
use strict;
use warnings;
package RT::Interface::Web;
use RT::SavedSearches;
use URI qw();
use RT::Interface::Web::Menu;
use RT::Interface::Web::Session;
use Digest::MD5 ();
use List::MoreUtils qw();
use JSON qw();
use Plack::Util;
=head2 SquishedCSS $style
=cut
my %SQUISHED_CSS;
sub SquishedCSS {
my $style = shift or die "need name";
return $SQUISHED_CSS{$style} if $SQUISHED_CSS{$style};
require RT::Squish::CSS;
my $css = RT::Squish::CSS->new( Style => $style );
$SQUISHED_CSS{ $css->Style } = $css;
return $css;
}
=head2 SquishedJS
=cut
my $SQUISHED_JS;
sub SquishedJS {
return $SQUISHED_JS if $SQUISHED_JS;
require RT::Squish::JS;
my $js = RT::Squish::JS->new();
$SQUISHED_JS = $js;
return $js;
}
=head2 JSFiles
=cut
sub JSFiles {
return qw{
jquery-1.9.1.min.js
jquery_noconflict.js
jquery-ui-1.10.0.custom.min.js
jquery-ui-timepicker-addon.js
jquery-ui-patch-datepicker.js
jquery.modal.min.js
jquery.modal-defaults.js
jquery.cookie.js
titlebox-state.js
i18n.js
util.js
autocomplete.js
jquery.event.hover-1.0.js
superfish.js
supersubs.js
jquery.supposition.js
history-folding.js
cascaded.js
forms.js
event-registration.js
late.js
/static/RichText/ckeditor.js
}, RT->Config->Get('JSFiles');
}
=head2 ClearSquished
Removes the cached CSS and JS entries, forcing them to be regenerated
on next use.
=cut
sub ClearSquished {
undef $SQUISHED_JS;
%SQUISHED_CSS = ();
}
=head2 EscapeHTML SCALARREF
does a css-busting but minimalist escaping of whatever html you're passing in.
=cut
sub EscapeHTML {
my $ref = shift;
return unless defined $$ref;
$$ref =~ s/&/&#38;/g;
$$ref =~ s/</&lt;/g;
$$ref =~ s/>/&gt;/g;
$$ref =~ s/\(/&#40;/g;
$$ref =~ s/\)/&#41;/g;
$$ref =~ s/"/&#34;/g;
$$ref =~ s/'/&#39;/g;
}
# Back-compat
# XXX: Remove in 4.4
sub EscapeUTF8 {
RT->Deprecated(
Instead => "EscapeHTML",
Remove => "4.4",
);
EscapeHTML(@_);
}
=head2 EscapeURI SCALARREF
Escapes URI component according to RFC2396
=cut
sub EscapeURI {
my $ref = shift;
return unless defined $$ref;
use bytes;
$$ref =~ s/([^a-zA-Z0-9_.!~*'()-])/uc sprintf("%%%02X", ord($1))/eg;
}
=head2 EncodeJSON SCALAR
Encodes the SCALAR to JSON and returns a JSON Unicode (B<not> UTF-8) string.
SCALAR may be a simple value or a reference.
=cut
sub EncodeJSON {
my $s = JSON::to_json(shift, { allow_nonref => 1 });
$s =~ s{/}{\\/}g;
return $s;
}
sub _encode_surrogates {
my $uni = $_[0] - 0x10000;
return ($uni / 0x400 + 0xD800, $uni % 0x400 + 0xDC00);
}
sub EscapeJS {
my $ref = shift;
return unless defined $$ref;
$$ref = "'" . join('',
map {
chr($_) =~ /[a-zA-Z0-9]/ ? chr($_) :
$_ <= 255 ? sprintf("\\x%02X", $_) :
$_ <= 65535 ? sprintf("\\u%04X", $_) :
sprintf("\\u%X\\u%X", _encode_surrogates($_))
} unpack('U*', $$ref))
. "'";
}
=head2 WebCanonicalizeInfo();
Different web servers set different environmental varibles. This
function must return something suitable for REMOTE_USER. By default,
just downcase $ENV{'REMOTE_USER'}
=cut
sub WebCanonicalizeInfo {
return $ENV{'REMOTE_USER'} ? lc $ENV{'REMOTE_USER'} : $ENV{'REMOTE_USER'};
}
=head2 WebRemoteUserAutocreateInfo($user);
Returns a hash of user attributes, used when WebRemoteUserAutocreate is set.
=cut
sub WebRemoteUserAutocreateInfo {
my $user = shift;
my %user_info;
# default to making Privileged users, even if they specify
# some other default Attributes
if ( !$RT::UserAutocreateDefaultsOnLogin
|| ( ref($RT::UserAutocreateDefaultsOnLogin) && not exists $RT::UserAutocreateDefaultsOnLogin->{Privileged} ) )
{
$user_info{'Privileged'} = 1;
}
# Populate fields with information from Unix /etc/passwd
my ( $comments, $realname ) = ( getpwnam($user) )[ 5, 6 ];
$user_info{'Comments'} = $comments if defined $comments;
$user_info{'RealName'} = $realname if defined $realname;
# and return the wad of stuff
return {%user_info};
}
sub HandleRequest {
my $ARGS = shift;
if (RT->Config->Get('DevelMode')) {
require Module::Refresh;
Module::Refresh->refresh;
}
$HTML::Mason::Commands::r->content_type("text/html; charset=utf-8");
$HTML::Mason::Commands::m->{'rt_base_time'} = [ Time::HiRes::gettimeofday() ];
# Roll back any dangling transactions from a previous failed connection
$RT::Handle->ForceRollback() if $RT::Handle and $RT::Handle->TransactionDepth;
MaybeEnableSQLStatementLog();
# avoid reentrancy, as suggested by masonbook
local *HTML::Mason::Commands::session unless $HTML::Mason::Commands::m->is_subrequest;
$HTML::Mason::Commands::m->autoflush( $HTML::Mason::Commands::m->request_comp->attr('AutoFlush') )
if ( $HTML::Mason::Commands::m->request_comp->attr_exists('AutoFlush') );
ValidateWebConfig();
DecodeARGS($ARGS);
local $HTML::Mason::Commands::DECODED_ARGS = $ARGS;
PreprocessTimeUpdates($ARGS);
InitializeMenu();
MaybeShowInstallModePage();
$HTML::Mason::Commands::m->comp( '/Elements/SetupSessionCookie', %$ARGS );
SendSessionCookie();
if ( _UserLoggedIn() ) {
# make user info up to date
$HTML::Mason::Commands::session{'CurrentUser'}
->Load( $HTML::Mason::Commands::session{'CurrentUser'}->id );
undef $HTML::Mason::Commands::session{'CurrentUser'}->{'LangHandle'};
}
else {
$HTML::Mason::Commands::session{'CurrentUser'} = RT::CurrentUser->new();
}
# Process session-related callbacks before any auth attempts
$HTML::Mason::Commands::m->callback( %$ARGS, CallbackName => 'Session', CallbackPage => '/autohandler' );
MaybeRejectPrivateComponentRequest();
MaybeShowNoAuthPage($ARGS);
AttemptExternalAuth($ARGS) if RT->Config->Get('WebRemoteUserContinuous') or not _UserLoggedIn();
_ForceLogout() unless _UserLoggedIn();
# Process per-page authentication callbacks
$HTML::Mason::Commands::m->callback( %$ARGS, CallbackName => 'Auth', CallbackPage => '/autohandler' );
if ( $ARGS->{'NotMobile'} ) {
$HTML::Mason::Commands::session{'NotMobile'} = 1;
}
unless ( _UserLoggedIn() ) {
_ForceLogout();
# Authenticate if the user is trying to login via user/pass query args
my ($authed, $msg) = AttemptPasswordAuthentication($ARGS);
unless ($authed) {
my $m = $HTML::Mason::Commands::m;
# REST urls get a special 401 response
if ($m->request_comp->path =~ m{^/REST/\d+\.\d+/}) {
$HTML::Mason::Commands::r->content_type("text/plain; charset=utf-8");
$m->error_format("text");
$m->out("RT/$RT::VERSION 401 Credentials required\n");
$m->out("\n$msg\n") if $msg;
$m->abort;
}
# Specially handle /index.html and /m/index.html so that we get a nicer URL
elsif ( $m->request_comp->path =~ m{^(/m)?/index\.html$} ) {
my $mobile = $1 ? 1 : 0;
my $next = SetNextPage($ARGS);
$m->comp('/NoAuth/Login.html',
next => $next,
actions => [$msg],
mobile => $mobile);
$m->abort;
}
else {
TangentForLogin($ARGS, results => ($msg ? LoginError($msg) : undef));
}
}
}
MaybeShowInterstitialCSRFPage($ARGS);
# now it applies not only to home page, but any dashboard that can be used as a workspace
$HTML::Mason::Commands::session{'home_refresh_interval'} = $ARGS->{'HomeRefreshInterval'}
if ( $ARGS->{'HomeRefreshInterval'} );
# Process per-page global callbacks
$HTML::Mason::Commands::m->callback( %$ARGS, CallbackName => 'Default', CallbackPage => '/autohandler' );
ShowRequestedPage($ARGS);
LogRecordedSQLStatements(RequestData => {
Path => $HTML::Mason::Commands::m->request_path,
});
# Process per-page final cleanup callbacks
$HTML::Mason::Commands::m->callback( %$ARGS, CallbackName => 'Final', CallbackPage => '/autohandler' );
$HTML::Mason::Commands::m->comp( '/Elements/Footer', %$ARGS );
}
sub _ForceLogout {
delete $HTML::Mason::Commands::session{'CurrentUser'};
}
sub _UserLoggedIn {
if ( $HTML::Mason::Commands::session{CurrentUser} && $HTML::Mason::Commands::session{'CurrentUser'}->id ) {
return 1;
} else {
return undef;
}
}
=head2 LoginError ERROR
Pushes a login error into the Actions session store and returns the hash key.
=cut
sub LoginError {
my $new = shift;
my $key = Digest::MD5::md5_hex( rand(1024) );
push @{ $HTML::Mason::Commands::session{"Actions"}->{$key} ||= [] }, $new;
$HTML::Mason::Commands::session{'i'}++;
return $key;
}
=head2 SetNextPage ARGSRef [PATH]
Intuits and stashes the next page in the sesssion hash. If PATH is
specified, uses that instead of the value of L<IntuitNextPage()>. Returns
the hash value.
=cut
sub SetNextPage {
my $ARGS = shift;
my $next = $_[0] ? $_[0] : IntuitNextPage();
my $hash = Digest::MD5::md5_hex($next . $$ . rand(1024));
my $page = { url => $next };
# If an explicit URL was passed and we didn't IntuitNextPage, then
# IsPossibleCSRF below is almost certainly unrelated to the actual
# destination. Currently explicit next pages aren't used in RT, but the
# API is available.
if (not $_[0] and RT->Config->Get("RestrictReferrer")) {
# This isn't really CSRF, but the CSRF heuristics are useful for catching
# requests which may have unintended side-effects.
my ($is_csrf, $msg, @loc) = IsPossibleCSRF($ARGS);
if ($is_csrf) {
RT->Logger->notice(
"Marking original destination as having side-effects before redirecting for login.\n"
."Request: $next\n"
."Reason: " . HTML::Mason::Commands::loc($msg, @loc)
);
$page->{'HasSideEffects'} = [$msg, @loc];
}
}
$HTML::Mason::Commands::session{'NextPage'}->{$hash} = $page;
$HTML::Mason::Commands::session{'i'}++;
return $hash;
}
=head2 FetchNextPage HASHKEY
Returns the stashed next page hashref for the given hash.
=cut
sub FetchNextPage {
my $hash = shift || "";
return $HTML::Mason::Commands::session{'NextPage'}->{$hash};
}
=head2 RemoveNextPage HASHKEY
Removes the stashed next page for the given hash and returns it.
=cut
sub RemoveNextPage {
my $hash = shift || "";
return delete $HTML::Mason::Commands::session{'NextPage'}->{$hash};
}
=head2 TangentForLogin ARGSRef [HASH]
Redirects to C</NoAuth/Login.html>, setting the value of L<IntuitNextPage> as
the next page. Takes a hashref of request %ARGS as the first parameter.
Optionally takes all other parameters as a hash which is dumped into query
params.
=cut
sub TangentForLogin {
my $login = TangentForLoginURL(@_);
Redirect( RT->Config->Get('WebBaseURL') . $login );
}
=head2 TangentForLoginURL [HASH]
Returns a URL suitable for tangenting for login. Optionally takes a hash which
is dumped into query params.
=cut
sub TangentForLoginURL {
my $ARGS = shift;
my $hash = SetNextPage($ARGS);
my %query = (@_, next => $hash);
$query{mobile} = 1
if $HTML::Mason::Commands::m->request_comp->path =~ m{^/m(/|$)};
my $login = RT->Config->Get('WebPath') . '/NoAuth/Login.html?';
$login .= $HTML::Mason::Commands::m->comp('/Elements/QueryString', %query);
return $login;
}
=head2 TangentForLoginWithError ERROR
Localizes the passed error message, stashes it with L<LoginError> and then
calls L<TangentForLogin> with the appropriate results key.
=cut
sub TangentForLoginWithError {
my $ARGS = shift;
my $key = LoginError(HTML::Mason::Commands::loc(@_));
TangentForLogin( $ARGS, results => $key );
}
=head2 IntuitNextPage
Attempt to figure out the path to which we should return the user after a
tangent. The current request URL is used, or failing that, the C<WebURL>
configuration variable.
=cut
sub IntuitNextPage {
my $req_uri;
# This includes any query parameters. Redirect will take care of making
# it an absolute URL.
if ($ENV{'REQUEST_URI'}) {
$req_uri = $ENV{'REQUEST_URI'};
# collapse multiple leading slashes so the first part doesn't look like
# a hostname of a schema-less URI
$req_uri =~ s{^/+}{/};
}
my $next = defined $req_uri ? $req_uri : RT->Config->Get('WebURL');
# sanitize $next
my $uri = URI->new($next);
# You get undef scheme with a relative uri like "/Search/Build.html"
unless (!defined($uri->scheme) || $uri->scheme eq 'http' || $uri->scheme eq 'https') {
$next = RT->Config->Get('WebURL');
}
# Make sure we're logging in to the same domain
# You can get an undef authority with a relative uri like "index.html"
my $uri_base_url = URI->new(RT->Config->Get('WebBaseURL'));
unless (!defined($uri->authority) || $uri->authority eq $uri_base_url->authority) {
$next = RT->Config->Get('WebURL');
}
return $next;
}
=head2 MaybeShowInstallModePage
This function, called exclusively by RT's autohandler, dispatches
a request to RT's Installation workflow, only if Install Mode is enabled in the configuration file.
If it serves a page, it stops mason processing. Otherwise, mason just keeps running through the autohandler
=cut
sub MaybeShowInstallModePage {
return unless RT->InstallMode;
my $m = $HTML::Mason::Commands::m;
if ( $m->base_comp->path =~ RT->Config->Get('WebNoAuthRegex') ) {
$m->call_next();
} elsif ( $m->request_comp->path !~ m{^(/+)Install/} ) {
RT::Interface::Web::Redirect( RT->Config->Get('WebURL') . "Install/index.html" );
} else {
$m->call_next();
}
$m->abort();
}
=head2 MaybeShowNoAuthPage \%ARGS
This function, called exclusively by RT's autohandler, dispatches
a request to the page a user requested (but only if it matches the "noauth" regex.
If it serves a page, it stops mason processing. Otherwise, mason just keeps running through the autohandler
=cut
sub MaybeShowNoAuthPage {
my $ARGS = shift;
my $m = $HTML::Mason::Commands::m;
return unless $m->base_comp->path =~ RT->Config->Get('WebNoAuthRegex');
# Don't show the login page to logged in users
Redirect(RT->Config->Get('WebURL'))
if $m->base_comp->path eq '/NoAuth/Login.html' and _UserLoggedIn();
# If it's a noauth file, don't ask for auth.
$m->comp( { base_comp => $m->request_comp }, $m->fetch_next, %$ARGS );
$m->abort;
}
=head2 MaybeRejectPrivateComponentRequest
This function will reject calls to private components, like those under
C</Elements>. If the requested path is a private component then we will
abort with a C<403> error.
=cut
sub MaybeRejectPrivateComponentRequest {
my $m = $HTML::Mason::Commands::m;
my $path = $m->request_comp->path;
# We do not check for dhandler here, because requesting our dhandlers
# directly is okay. Mason will invoke the dhandler with a dhandler_arg of
# 'dhandler'.
if ($path =~ m{
/ # leading slash
( Elements |
_elements | # mobile UI
Callbacks |
Widgets |
autohandler | # requesting this directly is suspicious
l (_unsafe)? ) # loc component
( $ | / ) # trailing slash or end of path
}xi) {
$m->abort(403);
}
return;
}
sub InitializeMenu {
$HTML::Mason::Commands::m->notes('menu', RT::Interface::Web::Menu->new());
$HTML::Mason::Commands::m->notes('page-menu', RT::Interface::Web::Menu->new());
$HTML::Mason::Commands::m->notes('page-widgets', RT::Interface::Web::Menu->new());
}
=head2 ShowRequestedPage \%ARGS
This function, called exclusively by RT's autohandler, dispatches
a request to the page a user requested (making sure that unpriviled users
can only see self-service pages.
=cut
sub ShowRequestedPage {
my $ARGS = shift;
my $m = $HTML::Mason::Commands::m;
# Ensure that the cookie that we send is up-to-date, in case the
# session-id has been modified in any way
SendSessionCookie();
# precache all system level rights for the current user
$HTML::Mason::Commands::session{CurrentUser}->PrincipalObj->HasRights( Object => RT->System );
# If the user isn't privileged, they can only see SelfService
unless ( $HTML::Mason::Commands::session{'CurrentUser'}->Privileged ) {
# if the user is trying to access a ticket, redirect them
if ( $m->request_comp->path =~ m{^(/+)Ticket/Display.html} && $ARGS->{'id'} ) {
RT::Interface::Web::Redirect( RT->Config->Get('WebURL') . "SelfService/Display.html?id=" . $ARGS->{'id'} );
}
# otherwise, drop the user at the SelfService default page
elsif ( $m->base_comp->path !~ RT->Config->Get('SelfServiceRegex') ) {
RT::Interface::Web::Redirect( RT->Config->Get('WebURL') . "SelfService/" );
}
# if user is in SelfService dir let him do anything
else {
$m->comp( { base_comp => $m->request_comp }, $m->fetch_next, %$ARGS );
}
} else {
$m->comp( { base_comp => $m->request_comp }, $m->fetch_next, %$ARGS );
}
}
sub AttemptExternalAuth {
my $ARGS = shift;
return unless ( RT->Config->Get('WebRemoteUserAuth') );
my $user = $ARGS->{user};
my $m = $HTML::Mason::Commands::m;
my $logged_in_external_user = _UserLoggedIn() && $HTML::Mason::Commands::session{'WebExternallyAuthed'};
# If RT is configured for external auth, let's go through and get REMOTE_USER
# Do we actually have a REMOTE_USER or equivalent? We only check auth if
# 1) we have no logged in user, or 2) we have a user who is externally
# authed. If we have a logged in user who is internally authed, don't
# check remote user otherwise we may log them out.
if (RT::Interface::Web::WebCanonicalizeInfo()
and (not _UserLoggedIn() or $logged_in_external_user) )
{
$user = RT::Interface::Web::WebCanonicalizeInfo();
my $load_method = RT->Config->Get('WebRemoteUserGecos') ? 'LoadByGecos' : 'Load';
my $next = RemoveNextPage($ARGS->{'next'});
$next = $next->{'url'} if ref $next;
InstantiateNewSession() unless _UserLoggedIn;
$HTML::Mason::Commands::session{'CurrentUser'} = RT::CurrentUser->new();
$HTML::Mason::Commands::session{'CurrentUser'}->$load_method($user);
if ( RT->Config->Get('WebRemoteUserAutocreate') and not _UserLoggedIn() ) {
# Create users on-the-fly
my $UserObj = RT::User->new(RT->SystemUser);
my ( $val, $msg ) = $UserObj->Create(
%{ ref RT->Config->Get('UserAutocreateDefaultsOnLogin') ? RT->Config->Get('UserAutocreateDefaultsOnLogin') : {} },
Name => $user,
Gecos => $user,
);
if ($val) {
# now get user specific information, to better create our user.
my $new_user_info = RT::Interface::Web::WebRemoteUserAutocreateInfo($user);
# set the attributes that have been defined.
foreach my $attribute ( $UserObj->WritableAttributes, qw(Privileged Disabled) ) {
$m->callback(
Attribute => $attribute,
User => $user,
UserInfo => $new_user_info,
CallbackName => 'NewUser',
CallbackPage => '/autohandler'
);
my $method = "Set$attribute";
$UserObj->$method( $new_user_info->{$attribute} ) if defined $new_user_info->{$attribute};
}
$HTML::Mason::Commands::session{'CurrentUser'}->Load($user);
} else {
RT->Logger->error("Couldn't auto-create user '$user' when attempting WebRemoteUser: $msg");
AbortExternalAuth( Error => "UserAutocreateDefaultsOnLogin" );
}
}
if ( _UserLoggedIn() ) {
$HTML::Mason::Commands::session{'WebExternallyAuthed'} = 1;
$m->callback( %$ARGS, CallbackName => 'ExternalAuthSuccessfulLogin', CallbackPage => '/autohandler' );
# It is possible that we did a redirect to the login page,
# if the external auth allows lack of auth through with no
# REMOTE_USER set, instead of forcing a "permission
# denied" message. Honor the $next.
Redirect($next) if $next;
# Unlike AttemptPasswordAuthentication below, we do not
# force a redirect to / if $next is not set -- otherwise,
# straight-up external auth would always redirect to /
# when you first hit it.
} else {
# Couldn't auth with the REMOTE_USER provided because an RT
# user doesn't exist and we're configured not to create one.
RT->Logger->error("Couldn't find internal user for '$user' when attempting WebRemoteUser and RT is not configured for auto-creation. Refer to `perldoc $RT::BasePath/docs/authentication.pod` if you want to allow auto-creation.");
AbortExternalAuth(
Error => "NoInternalUser",
User => $user,
);
}
}
elsif ($logged_in_external_user) {
# The logged in external user was deauthed by the auth system and we
# should kick them out.
AbortExternalAuth( Error => "Deauthorized" );
}
elsif (not RT->Config->Get('WebFallbackToRTLogin')) {
# Abort if we don't want to fallback internally
AbortExternalAuth( Error => "NoRemoteUser" );
}
}
sub AbortExternalAuth {
my %args = @_;
my $error = $args{Error} ? "/Errors/WebRemoteUser/$args{Error}" : undef;
my $m = $HTML::Mason::Commands::m;
my $r = $HTML::Mason::Commands::r;
_ForceLogout();
# Clear the decks, not that we should have partial content.
$m->clear_buffer;
$r->status(403);
$m->comp($error, %args)
if $error and $m->comp_exists($error);
# Return a 403 Forbidden or we may fallback to a login page with no form
$m->abort(403);
}
sub AttemptPasswordAuthentication {
my $ARGS = shift;
return unless defined $ARGS->{user} && defined $ARGS->{pass};
my $user_obj = RT::CurrentUser->new();
$user_obj->Load( $ARGS->{user} );
my $m = $HTML::Mason::Commands::m;
unless ( $user_obj->id && $user_obj->IsPassword( $ARGS->{pass} ) ) {
$RT::Logger->error("FAILED LOGIN for @{[$ARGS->{user}]} from $ENV{'REMOTE_ADDR'}");
$m->callback( %$ARGS, CallbackName => 'FailedLogin', CallbackPage => '/autohandler' );
return (0, HTML::Mason::Commands::loc('Your username or password is incorrect'));
}
else {
$RT::Logger->info("Successful login for @{[$ARGS->{user}]} from $ENV{'REMOTE_ADDR'}");
# It's important to nab the next page from the session before we blow
# the session away
my $next = RemoveNextPage($ARGS->{'next'});
$next = $next->{'url'} if ref $next;
InstantiateNewSession();
$HTML::Mason::Commands::session{'CurrentUser'} = $user_obj;
$m->callback( %$ARGS, CallbackName => 'SuccessfulLogin', CallbackPage => '/autohandler', RedirectTo => \$next );
# Really the only time we don't want to redirect here is if we were
# passed user and pass as query params in the URL.
if ($next) {
Redirect($next);
}
elsif ($ARGS->{'next'}) {
# Invalid hash, but still wants to go somewhere, take them to /
Redirect(RT->Config->Get('WebURL'));
}
return (1, HTML::Mason::Commands::loc('Logged in'));
}
}
=head2 LoadSessionFromCookie
Load or setup a session cookie for the current user.
=cut
sub _SessionCookieName {
my $cookiename = "RT_SID_" . RT->Config->Get('rtname');
$cookiename .= "." . $ENV{'SERVER_PORT'} if $ENV{'SERVER_PORT'};
return $cookiename;
}
sub LoadSessionFromCookie {
my %cookies = CGI::Cookie->fetch;
my $cookiename = _SessionCookieName();
my $SessionCookie = ( $cookies{$cookiename} ? $cookies{$cookiename}->value : undef );
tie %HTML::Mason::Commands::session, 'RT::Interface::Web::Session', $SessionCookie;
unless ( $SessionCookie && $HTML::Mason::Commands::session{'_session_id'} eq $SessionCookie ) {
InstantiateNewSession();
}
if ( int RT->Config->Get('AutoLogoff') ) {
my $now = int( time / 60 );
my $last_update = $HTML::Mason::Commands::session{'_session_last_update'} || 0;
if ( $last_update && ( $now - $last_update - RT->Config->Get('AutoLogoff') ) > 0 ) {
InstantiateNewSession();
}
# save session on each request when AutoLogoff is turned on
$HTML::Mason::Commands::session{'_session_last_update'} = $now if $now != $last_update;
}
}
sub InstantiateNewSession {
tied(%HTML::Mason::Commands::session)->delete if tied(%HTML::Mason::Commands::session);
tie %HTML::Mason::Commands::session, 'RT::Interface::Web::Session', undef;
SendSessionCookie();
}
sub SendSessionCookie {
my $cookie = CGI::Cookie->new(
-name => _SessionCookieName(),
-value => $HTML::Mason::Commands::session{_session_id},
-path => RT->Config->Get('WebPath'),
-secure => ( RT->Config->Get('WebSecureCookies') ? 1 : 0 ),
-httponly => ( RT->Config->Get('WebHttpOnlyCookies') ? 1 : 0 ),
);
$HTML::Mason::Commands::r->err_headers_out->{'Set-Cookie'} = $cookie->as_string;
}
=head2 GetWebURLFromRequest
People may use different web urls instead of C<$WebURL> in config.
Return the web url current user is using.
=cut
sub GetWebURLFromRequest {
my $uri = URI->new( RT->Config->Get('WebURL') );
if ( defined $ENV{HTTPS} and $ENV{'HTTPS'} eq 'on' ) {
$uri->scheme('https');
}
else {
$uri->scheme('http');
}
# [rt3.fsck.com #12716] Apache recommends use of $SERVER_HOST
$uri->host( $ENV{'SERVER_HOST'} || $ENV{'HTTP_HOST'} || $ENV{'SERVER_NAME'} );
$uri->port( $ENV{'SERVER_PORT'} );
return "$uri"; # stringify to be consistent with WebURL in config
}
=head2 Redirect URL
This routine ells the current user's browser to redirect to URL.
Additionally, it unties the user's currently active session, helping to avoid
A bug in Apache::Session 1.81 and earlier which clobbers sessions if we try to use
a cached DBI statement handle twice at the same time.
=cut
sub Redirect {
my $redir_to = shift;
untie $HTML::Mason::Commands::session;
my $uri = URI->new($redir_to);
my $server_uri = URI->new( RT->Config->Get('WebURL') );
# Make relative URIs absolute from the server host and scheme
$uri->scheme($server_uri->scheme) if not defined $uri->scheme;
if (not defined $uri->host) {
$uri->host($server_uri->host);
$uri->port($server_uri->port);
}
# If the user is coming in via a non-canonical
# hostname, don't redirect them to the canonical host,
# it will just upset them (and invalidate their credentials)
# don't do this if $RT::CanonicalizeRedirectURLs is true
if ( !RT->Config->Get('CanonicalizeRedirectURLs')
&& $uri->host eq $server_uri->host
&& $uri->port eq $server_uri->port )
{
my $env_uri = URI->new(GetWebURLFromRequest());
$uri->scheme($env_uri->scheme);
$uri->host($env_uri->host);
$uri->port($env_uri->port);
}
# not sure why, but on some systems without this call mason doesn't
# set status to 302, but 200 instead and people see blank pages
$HTML::Mason::Commands::r->status(302);
# Perlbal expects a status message, but Mason's default redirect status
# doesn't provide one. See also rt.cpan.org #36689.
$HTML::Mason::Commands::m->redirect( $uri->canonical, "302 Found" );
$HTML::Mason::Commands::m->abort;
}
=head2 GetStaticHeaders
return an arrayref of Headers (currently, Cache-Control and Expires).
=cut
sub GetStaticHeaders {
my %args = @_;
my $Visibility = 'private';
if ( ! defined $args{Time} ) {
$args{Time} = 0;
} elsif ( $args{Time} eq 'no-cache' ) {
$args{Time} = 0;
} elsif ( $args{Time} eq 'forever' ) {
$args{Time} = 30 * 24 * 60 * 60;
$Visibility = 'public';
}
my $CacheControl = $args{Time}
? sprintf "max-age=%d, %s", $args{Time}, $Visibility
: 'no-cache'
;
my $expires = RT::Date->new(RT->SystemUser);
$expires->SetToNow;
$expires->AddSeconds( $args{Time} ) if $args{Time};
return [
Expires => $expires->RFC2616,
'Cache-Control' => $CacheControl,
];
}
=head2 CacheControlExpiresHeaders
set both Cache-Control and Expires http headers
=cut
sub CacheControlExpiresHeaders {
Plack::Util::header_iter( GetStaticHeaders(@_), sub {
my ( $key, $val ) = @_;
$HTML::Mason::Commands::r->headers_out->{$key} = $val;
} );
}
=head2 StaticFileHeaders
Send the browser a few headers to try to get it to (somewhat agressively)
cache RT's static Javascript and CSS files.
This routine could really use _accurate_ heuristics. (XXX TODO)
=cut
sub StaticFileHeaders {
# remove any cookie headers -- if it is cached publicly, it
# shouldn't include anyone's cookie!
delete $HTML::Mason::Commands::r->err_headers_out->{'Set-Cookie'};
# Expire things in a month.
CacheControlExpiresHeaders( Time => 'forever' );
}
=head2 ComponentPathIsSafe PATH
Takes C<PATH> and returns a boolean indicating that the user-specified partial
component path is safe.
Currently "safe" means that the path does not start with a dot (C<.>), does
not contain a slash-dot C</.>, and does not contain any nulls.
=cut
sub ComponentPathIsSafe {
my $self = shift;
my $path = shift;
return($path !~ m{(?:^|/)\.} and $path !~ m{\0});
}
=head2 PathIsSafe
Takes a C<< Path => path >> and returns a boolean indicating that
the path is safely within RT's control or not. The path I<must> be
relative.
This function does not consult the filesystem at all; it is merely
a logical sanity checking of the path. This explicitly does not handle
symlinks; if you have symlinks in RT's webroot pointing outside of it,
then we assume you know what you are doing.
=cut
sub PathIsSafe {
my $self = shift;
my %args = @_;
my $path = $args{Path};
# Get File::Spec to clean up extra /s, ./, etc
my $cleaned_up = File::Spec->canonpath($path);
if (!defined($cleaned_up)) {
$RT::Logger->info("Rejecting path that canonpath doesn't understand: $path");
return 0;
}
# Forbid too many ..s. We can't just sum then check because
# "../foo/bar/baz" should be illegal even though it has more
# downdirs than updirs. So as soon as we get a negative score
# (which means "breaking out" of the top level) we reject the path.
my @components = split '/', $cleaned_up;
my $score = 0;
for my $component (@components) {
if ($component eq '..') {
$score--;
if ($score < 0) {
$RT::Logger->info("Rejecting unsafe path: $path");
return 0;
}
}
elsif ($component eq '.' || $component eq '') {
# these two have no effect on $score
}
else {
$score++;
}
}
return 1;
}
=head2 SendStaticFile
Takes a File => path and a Type => Content-type
If Type isn't provided and File is an image, it will
figure out a sane Content-type, otherwise it will
send application/octet-stream
Will set caching headers using StaticFileHeaders
=cut
sub SendStaticFile {
my $self = shift;
my %args = @_;
my $file = $args{File};
my $type = $args{Type};
my $relfile = $args{RelativeFile};
if (defined($relfile) && !$self->PathIsSafe(Path => $relfile)) {
$HTML::Mason::Commands::r->status(400);
$HTML::Mason::Commands::m->abort;
}
$self->StaticFileHeaders();
unless ($type) {
if ( $file =~ /\.(gif|png|jpe?g)$/i ) {
$type = "image/$1";
$type =~ s/jpg/jpeg/gi;
}
$type ||= "application/octet-stream";
}
$HTML::Mason::Commands::r->content_type($type);
open( my $fh, '<', $file ) or die "couldn't open file: $!";
binmode($fh);
{
local $/ = \16384;
$HTML::Mason::Commands::m->out($_) while (<$fh>);
$HTML::Mason::Commands::m->flush_buffer;
}
close $fh;
}
sub MobileClient {
my $self = shift;
if (($ENV{'HTTP_USER_AGENT'} || '') =~ /(?:hiptop|Blazer|Novarra|Vagabond|SonyEricsson|Symbian|NetFront|UP.Browser|UP.Link|Windows CE|MIDP|J2ME|DoCoMo|J-PHONE|PalmOS|PalmSource|iPhone|iPod|AvantGo|Nokia|Android|WebOS|S60|Mobile)/io && !$HTML::Mason::Commands::session{'NotMobile'}) {
return 1;
} else {
return undef;
}
}
sub StripContent {
my %args = @_;
my $content = $args{Content};
return '' unless $content;
# Make the content have no 'weird' newlines in it
$content =~ s/\r+\n/\n/g;
my $return_content = $content;
my $html = $args{ContentType} && $args{ContentType} eq "text/html";
my $sigonly = $args{StripSignature};
# massage content to easily detect if there's any real content
$content =~ s/\s+//g; # yes! remove all the spaces
if ( $html ) {
# remove html version of spaces and newlines
$content =~ s!&nbsp;!!g;
$content =~ s!<br/?>!!g;
}
# Filter empty content when type is text/html
return '' if $html && $content !~ /\S/;
# If we aren't supposed to strip the sig, just bail now.
return $return_content unless $sigonly;
# Find the signature
my $sig = $args{'CurrentUser'}->UserObj->Signature || '';
$sig =~ s/\s+//g;
# Check for plaintext sig
return '' if not $html and $content =~ /^(--)?\Q$sig\E$/;
# Check for html-formatted sig; we don't use EscapeHTML here
# because we want to precisely match the escapting that FCKEditor
# uses.
$sig =~ s/&/&amp;/g;
$sig =~ s/</&lt;/g;
$sig =~ s/>/&gt;/g;
$sig =~ s/"/&quot;/g;
$sig =~ s/'/&#39;/g;
return '' if $html and $content =~ m{^(?:<p>)?(--)?\Q$sig\E(?:</p>)?$}s;
# Pass it through
return $return_content;
}
sub DecodeARGS {
my $ARGS = shift;
# Later in the code we use
# $m->comp( { base_comp => $m->request_comp }, $m->fetch_next, %ARGS );
# instead of $m->call_next to avoid problems with UTF8 keys in
# arguments. Specifically, the call_next method pass through
# original arguments, which are still the encoded bytes, not
# characters. "{ base_comp => $m->request_comp }" is copied from
# mason's source to get the same results as we get from call_next
# method; this feature is not documented.
%{$ARGS} = map {
# if they've passed multiple values, they'll be an array. if they've
# passed just one, a scalar whatever they are, mark them as utf8
my $type = ref($_);
( !$type )
? Encode::decode( 'UTF-8', $_, Encode::FB_PERLQQ )
: ( $type eq 'ARRAY' )
? [ map { ref($_) ? $_ : Encode::decode( 'UTF-8', $_, Encode::FB_PERLQQ ) } @$_ ]
: ( $type eq 'HASH' )
? { map { ref($_) ? $_ : Encode::decode( 'UTF-8', $_, Encode::FB_PERLQQ ) } %$_ }
: $_
} %$ARGS;
}
sub PreprocessTimeUpdates {
my $ARGS = shift;
# This code canonicalizes time inputs in hours into minutes
foreach my $field ( keys %$ARGS ) {
next unless $field =~ /^(.*)-TimeUnits$/i && $ARGS->{$1};
my $local = $1;
$ARGS->{$local} =~ s{\b (?: (\d+) \s+ )? (\d+)/(\d+) \b}
{($1 || 0) + $3 ? $2 / $3 : 0}xe;
if ( $ARGS->{$field} && $ARGS->{$field} =~ /hours/i ) {
$ARGS->{$local} *= 60;
}
delete $ARGS->{$field};
}
}
sub MaybeEnableSQLStatementLog {
my $log_sql_statements = RT->Config->Get('StatementLog');
if ($log_sql_statements) {
$RT::Handle->ClearSQLStatementLog;
$RT::Handle->LogSQLStatements(1);
}
}
sub LogRecordedSQLStatements {
my %args = @_;
my $log_sql_statements = RT->Config->Get('StatementLog');
return unless ($log_sql_statements);
my @log = $RT::Handle->SQLStatementLog;
$RT::Handle->ClearSQLStatementLog;
$RT::Handle->AddRequestToHistory({
%{ $args{RequestData} },
Queries => \@log,
});
for my $stmt (@log) {
my ( $time, $sql, $bind, $duration ) = @{$stmt};
my @bind;
if ( ref $bind ) {
@bind = @{$bind};
} else {
# Older DBIx-SB
$duration = $bind;
}
$RT::Logger->log(
level => $log_sql_statements,
message => "SQL("
. sprintf( "%.6f", $duration )
. "s): $sql;"
. ( @bind ? " [ bound values: @{[map{ defined $_ ? qq|'$_'| : 'undef'} @bind]} ]" : "" )
);
}
}
my $_has_validated_web_config = 0;
sub ValidateWebConfig {
my $self = shift;
# do this once per server instance, not once per request
return if $_has_validated_web_config;
$_has_validated_web_config = 1;
my $port = $ENV{SERVER_PORT};
my $host = $ENV{HTTP_X_FORWARDED_HOST} || $ENV{HTTP_X_FORWARDED_SERVER}
|| $ENV{HTTP_HOST} || $ENV{SERVER_NAME};
($host, $port) = ($1, $2) if $host =~ /^(.*?):(\d+)$/;
if ( $port != RT->Config->Get('WebPort') and not $ENV{'rt.explicit_port'}) {
$RT::Logger->warn("The requested port ($port) does NOT match the configured WebPort ($RT::WebPort). "
."Perhaps you should Set(\$WebPort, $port); in RT_SiteConfig.pm, "
."otherwise your internal hyperlinks may be broken.");
}
if ( $host ne RT->Config->Get('WebDomain') ) {
$RT::Logger->warn("The requested host ($host) does NOT match the configured WebDomain ($RT::WebDomain). "
."Perhaps you should Set(\$WebDomain, '$host'); in RT_SiteConfig.pm, "
."otherwise your internal hyperlinks may be broken.");
}
# Unfortunately, there is no reliable way to get the _path_ that was
# requested at the proxy level; simply disable this warning if we're
# proxied and there's a mismatch.
my $proxied = $ENV{HTTP_X_FORWARDED_HOST} || $ENV{HTTP_X_FORWARDED_SERVER};
if ($ENV{SCRIPT_NAME} ne RT->Config->Get('WebPath') and not $proxied) {
$RT::Logger->warn("The requested path ($ENV{SCRIPT_NAME}) does NOT match the configured WebPath ($RT::WebPath). "
."Perhaps you should Set(\$WebPath, '$ENV{SCRIPT_NAME}'); in RT_SiteConfig.pm, "
."otherwise your internal hyperlinks may be broken.");
}
}
sub ComponentRoots {
my $self = shift;
my %args = ( Names => 0, @_ );
my @roots;
if (defined $HTML::Mason::Commands::m) {
@roots = $HTML::Mason::Commands::m->interp->comp_root_array;
} else {
@roots = (
[ local => $RT::MasonLocalComponentRoot ],
(map {[ "plugin-".$_->Name => $_->ComponentRoot ]} @{RT->Plugins}),
[ standard => $RT::MasonComponentRoot ]
);
}
@roots = map { $_->[1] } @roots unless $args{Names};
return @roots;
}
sub StaticRoots {
my $self = shift;
my @static = (
$RT::LocalStaticPath,
(map { $_->StaticDir } @{RT->Plugins}),
$RT::StaticPath,
);
return grep { $_ and -d $_ } @static;
}
our %IS_WHITELISTED_COMPONENT = (
# The RSS feed embeds an auth token in the path, but query
# information for the search. Because it's a straight-up read, in
# addition to embedding its own auth, it's fine.
'/NoAuth/rss/dhandler' => 1,
# While these can be used for denial-of-service against RT
# (construct a very inefficient query and trick lots of users into
# running them against RT) it's incredibly useful to be able to link
# to a search result (or chart) or bookmark a result page.
'/Search/Results.html' => 1,
'/Search/Simple.html' => 1,
'/m/tickets/search' => 1,
'/Search/Chart.html' => 1,
'/User/Search.html' => 1,
# This page takes Attachment and Transaction argument to figure
# out what to show, but it's read only and will deny information if you
# don't have ShowOutgoingEmail.
'/Ticket/ShowEmailRecord.html' => 1,
);
# Whitelist arguments that do not indicate an effectful request.
our @GLOBAL_WHITELISTED_ARGS = (
# For example, "id" is acceptable because that is how RT retrieves a
# record.
'id',
# If they have a results= from MaybeRedirectForResults, that's also fine.
'results',
# The homepage refresh, which uses the Refresh header, doesn't send
# a referer in most browsers; whitelist the one parameter it reloads
# with, HomeRefreshInterval, which is safe
'HomeRefreshInterval',
# The NotMobile flag is fine for any page; it's only used to toggle a flag
# in the session related to which interface you get.
'NotMobile',
);
our %WHITELISTED_COMPONENT_ARGS = (
# SavedSearchLoad - This happens when you middle-(or ⌘ )-click "Edit" for a saved search on
# the homepage. It's not going to do any damage
# NewQuery - This is simply to clear the search query
'/Search/Build.html' => ['SavedSearchLoad','NewQuery'],
# Happens if you try and reply to a message in the ticket history or click a number
# of options on a tickets Action menu
'/Ticket/Update.html' => ['QuoteTransaction', 'Action', 'DefaultStatus'],
# Action->Extract Article on a ticket's menu
'/Articles/Article/ExtractIntoClass.html' => ['Ticket'],
);
# Components which are blacklisted from automatic, argument-based whitelisting.
# These pages are not idempotent when called with just an id.
our %IS_BLACKLISTED_COMPONENT = (
# Takes only id and toggles bookmark state
'/Helpers/Toggle/TicketBookmark' => 1,
);
sub IsCompCSRFWhitelisted {
my $comp = shift;
my $ARGS = shift;
return 1 if $IS_WHITELISTED_COMPONENT{$comp};
my %args = %{ $ARGS };
# If the user specifies a *correct* user and pass then they are
# golden. This acts on the presumption that external forms may
# hardcode a username and password -- if a malicious attacker knew
# both already, CSRF is the least of your problems.
my $AllowLoginCSRF = not RT->Config->Get('RestrictReferrerLogin');
if ($AllowLoginCSRF and defined($args{user}) and defined($args{pass})) {
my $user_obj = RT::CurrentUser->new();
$user_obj->Load($args{user});
return 1 if $user_obj->id && $user_obj->IsPassword($args{pass});
delete $args{user};
delete $args{pass};
}
# Some pages aren't idempotent even with safe args like id; blacklist
# them from the automatic whitelisting below.
return 0 if $IS_BLACKLISTED_COMPONENT{$comp};
if ( my %csrf_config = RT->Config->Get('ReferrerComponents') ) {
my $value = $csrf_config{$comp};
if ( ref $value eq 'ARRAY' ) {
delete $args{$_} for @$value;
return %args ? 0 : 1;
}
else {
return $value ? 1 : 0;
}
}
return AreCompCSRFParametersWhitelisted($comp, \%args);
}
sub AreCompCSRFParametersWhitelisted {
my $sub = shift;
my $ARGS = shift;
my %leftover_args = %{ $ARGS };
# Join global whitelist and component-specific whitelist
my @whitelisted_args = (@GLOBAL_WHITELISTED_ARGS, @{ $WHITELISTED_COMPONENT_ARGS{$sub} || [] });
for my $arg (@whitelisted_args) {
delete $leftover_args{$arg};
}
# If there are no arguments, then it's likely to be an idempotent
# request, which are not susceptible to CSRF
return !%leftover_args;
}
sub IsRefererCSRFWhitelisted {
my $referer = _NormalizeHost(shift);
my $base_url = _NormalizeHost(RT->Config->Get('WebBaseURL'));
$base_url = $base_url->host_port;
my $configs;
for my $config ( $base_url, RT->Config->Get('ReferrerWhitelist') ) {
push @$configs,$config;
my $host_port = $referer->host_port;
if ($config =~ /\*/) {
# Turn a literal * into a domain component or partial component match.
# Refer to http://tools.ietf.org/html/rfc2818#page-5
my $regex = join "[a-zA-Z0-9\-]*",
map { quotemeta($_) }
split /\*/, $config;
return 1 if $host_port =~ /^$regex$/i;
} else {
return 1 if $host_port eq $config;
}
}
return (0,$referer,$configs);
}
=head3 _NormalizeHost
Takes a URI and creates a URI object that's been normalized
to handle common problems such as localhost vs 127.0.0.1
=cut
sub _NormalizeHost {
my $uri= URI->new(shift);
$uri->host('127.0.0.1') if $uri->host eq 'localhost';
return $uri;
}
sub IsPossibleCSRF {
my $ARGS = shift;
# If first request on this session is to a REST endpoint, then
# whitelist the REST endpoints -- and explicitly deny non-REST
# endpoints. We do this because using a REST cookie in a browser
# would open the user to CSRF attacks to the REST endpoints.
my $path = $HTML::Mason::Commands::r->path_info;
$HTML::Mason::Commands::session{'REST'} = $path =~ m{^/+REST/\d+\.\d+(/|$)}
unless defined $HTML::Mason::Commands::session{'REST'};
if ($HTML::Mason::Commands::session{'REST'}) {
return 0 if $path =~ m{^/+REST/\d+\.\d+(/|$)};
my $why = <<EOT;
This login session belongs to a REST client, and cannot be used to
access non-REST interfaces of RT for security reasons.
EOT
my $details = <<EOT;
Please log out and back in to obtain a session for normal browsing. If
you understand the security implications, disabling RT's CSRF protection
will remove this restriction.
EOT
chomp $details;
HTML::Mason::Commands::Abort( $why, Details => $details );
}
return 0 if IsCompCSRFWhitelisted(
$HTML::Mason::Commands::m->request_comp->path,
$ARGS
);
# if there is no Referer header then assume the worst
return (1,
"your browser did not supply a Referrer header", # loc
) if !$ENV{HTTP_REFERER};
my ($whitelisted, $browser, $configs) = IsRefererCSRFWhitelisted($ENV{HTTP_REFERER});
return 0 if $whitelisted;
if ( @$configs > 1 ) {
return (1,
"the Referrer header supplied by your browser ([_1]) is not allowed by RT's configured hostname ([_2]) or whitelisted hosts ([_3])", # loc
$browser->host_port,
shift @$configs,
join(', ', @$configs) );
}
return (1,
"the Referrer header supplied by your browser ([_1]) is not allowed by RT's configured hostname ([_2])", # loc
$browser->host_port,
$configs->[0]);
}
sub ExpandCSRFToken {
my $ARGS = shift;
my $token = delete $ARGS->{CSRF_Token};
return unless $token;
my $data = $HTML::Mason::Commands::session{'CSRF'}{$token};
return unless $data;
return unless $data->{path} eq $HTML::Mason::Commands::r->path_info;
my $user = $HTML::Mason::Commands::session{'CurrentUser'}->UserObj;
return unless $user->ValidateAuthString( $data->{auth}, $token );
%{$ARGS} = %{$data->{args}};
$HTML::Mason::Commands::DECODED_ARGS = $ARGS;
# We explicitly stored file attachments with the request, but not in
# the session yet, as that would itself be an attack. Put them into
# the session now, so they'll be visible.
if ($data->{attach}) {
my $filename = $data->{attach}{filename};
my $mime = $data->{attach}{mime};
$HTML::Mason::Commands::session{'Attachments'}{$ARGS->{'Token'}||''}{$filename}
= $mime;
}
return 1;
}
sub StoreRequestToken {
my $ARGS = shift;
my $token = Digest::MD5::md5_hex(time . {} . $$ . rand(1024));
my $user = $HTML::Mason::Commands::session{'CurrentUser'}->UserObj;
my $data = {
auth => $user->GenerateAuthString( $token ),
path => $HTML::Mason::Commands::r->path_info,
args => $ARGS,
};
if ($ARGS->{Attach}) {
my $attachment = HTML::Mason::Commands::MakeMIMEEntity( AttachmentFieldName => 'Attach' );
my $file_path = delete $ARGS->{'Attach'};
# This needs to be decoded because the value is a reference;
# hence it was not decoded along with all of the standard
# arguments in DecodeARGS
$data->{attach} = {
filename => Encode::decode("UTF-8", "$file_path"),
mime => $attachment,
};
}
$HTML::Mason::Commands::session{'CSRF'}->{$token} = $data;
$HTML::Mason::Commands::session{'i'}++;
return $token;
}
sub MaybeShowInterstitialCSRFPage {
my $ARGS = shift;
return unless RT->Config->Get('RestrictReferrer');
# Deal with the form token provided by the interstitial, which lets
# browsers which never set referer headers still use RT, if
# painfully. This blows values into ARGS
return if ExpandCSRFToken($ARGS);
my ($is_csrf, $msg, @loc) = IsPossibleCSRF($ARGS);
return if !$is_csrf;
$RT::Logger->notice("Possible CSRF: ".RT::CurrentUser->new->loc($msg, @loc));
my $token = StoreRequestToken($ARGS);
$HTML::Mason::Commands::m->comp(
'/Elements/CSRF',
OriginalURL => RT->Config->Get('WebPath') . $HTML::Mason::Commands::r->path_info,
Reason => HTML::Mason::Commands::loc( $msg, @loc ),
Token => $token,
);
# Calls abort, never gets here
}
our @POTENTIAL_PAGE_ACTIONS = (
qr'/Ticket/Create.html' => "create a ticket", # loc
qr'/Ticket/' => "update a ticket", # loc
qr'/Admin/' => "modify RT's configuration", # loc
qr'/Approval/' => "update an approval", # loc
qr'/Articles/' => "update an article", # loc
qr'/Dashboards/' => "modify a dashboard", # loc
qr'/m/ticket/' => "update a ticket", # loc
qr'Prefs' => "modify your preferences", # loc
qr'/Search/' => "modify or access a search", # loc
qr'/SelfService/Create' => "create a ticket", # loc
qr'/SelfService/' => "update a ticket", # loc
);
sub PotentialPageAction {
my $page = shift;
my @potentials = @POTENTIAL_PAGE_ACTIONS;
while (my ($pattern, $result) = splice @potentials, 0, 2) {
return HTML::Mason::Commands::loc($result)
if $page =~ $pattern;
}
return "";
}
=head2 RewriteInlineImages PARAMHASH
Turns C<< <img src="cid:..."> >> elements in HTML into working images pointing
back to RT's stored copy.
Takes the following parameters:
=over 4
=item Content
Scalar ref of the HTML content to rewrite. Modified in place to support the
most common use-case.
=item Attachment
The L<RT::Attachment> object from which the Content originates.
=item Related (optional)
Array ref of related L<RT::Attachment> objects to use for C<Content-ID> matching.
Defaults to the result of the C<Siblings> method on the passed Attachment.
=item AttachmentPath (optional)
The base path to use when rewriting C<src> attributes.
Defaults to C< $WebPath/Ticket/Attachment >
=back
In scalar context, returns the number of elements rewritten.
In list content, returns the attachments IDs referred to by the rewritten <img>
elements, in the order found. There may be duplicates.
=cut
sub RewriteInlineImages {
my %args = (
Content => undef,
Attachment => undef,
Related => undef,
AttachmentPath => RT->Config->Get('WebPath')."/Ticket/Attachment",
@_
);
return unless defined $args{Content}
and ref $args{Content} eq 'SCALAR'
and defined $args{Attachment};
my $related_part = $args{Attachment}->Closest("multipart/related")
or return;
$args{Related} ||= $related_part->Children->ItemsArrayRef;
return unless @{$args{Related}};
my $content = $args{'Content'};
my @rewritten;
require HTML::RewriteAttributes::Resources;
$$content = HTML::RewriteAttributes::Resources->rewrite($$content, sub {
my $cid = shift;
my %meta = @_;
return $cid unless lc $meta{tag} eq 'img'
and lc $meta{attr} eq 'src'
and $cid =~ s/^cid://i;
for my $attach (@{$args{Related}}) {
if (($attach->GetHeader('Content-ID') || '') =~ /^(<)?\Q$cid\E(?(1)>)$/) {
push @rewritten, $attach->Id;
return "$args{AttachmentPath}/" . $attach->TransactionId . '/' . $attach->Id;
}
}
# No attachments means this is a bogus CID. Just pass it through.
RT->Logger->debug(qq[Found bogus inline image src="cid:$cid"]);
return "cid:$cid";
});
return @rewritten;
}
=head2 GetCustomFieldInputName(CustomField => $cf_object, Object => $object, Grouping => $grouping_name)
Returns the standard custom field input name; this is complementary to
L</_ParseObjectCustomFieldArgs>. Takes the following arguments:
=over
=item CustomField => I<L<RT::CustomField> object>
Required.
=item Object => I<object>
The object that the custom field is applied to; optional. If omitted,
defaults to a new object of the appropriate class for the custom field.
=item Grouping => I<CF grouping>
The grouping that the custom field is being rendered in. Groupings
allow a custom field to appear in more than one location per form.
=back
=cut
sub GetCustomFieldInputName {
my %args = (
CustomField => undef,
Object => undef,
Grouping => undef,
@_,
);
my $name = GetCustomFieldInputNamePrefix(%args);
if ( $args{CustomField}->Type eq 'Select' ) {
if ( $args{CustomField}->RenderType eq 'List' and $args{CustomField}->SingleValue ) {
$name .= 'Value';
}
else {
$name .= 'Values';
}
}
elsif ( $args{CustomField}->Type =~ /^(?:Binary|Image)$/ ) {
$name .= 'Upload';
}
elsif ( $args{CustomField}->Type =~ /^(?:Date|DateTime|Text|Wikitext)$/ ) {
$name .= 'Values';
}
else {
if ( $args{CustomField}->SingleValue ) {
$name .= 'Value';
}
else {
$name .= 'Values';
}
}
return $name;
}
=head2 GetCustomFieldInputNamePrefix(CustomField => $cf_object, Object => $object, Grouping => $grouping_name)
Returns the standard custom field input name prefix(without "Value" or alike suffix)
=cut
sub GetCustomFieldInputNamePrefix {
my %args = (
CustomField => undef,
Object => undef,
Grouping => undef,
@_,
);
my $prefix = join '-', 'Object', ref( $args{Object} ) || $args{CustomField}->ObjectTypeFromLookupType,
( $args{Object} && $args{Object}->id ? $args{Object}->id : '' ),
'CustomField' . ( $args{Grouping} ? ":$args{Grouping}" : '' ),
$args{CustomField}->id, '';
return $prefix;
}
package HTML::Mason::Commands;
use vars qw/$r $m %session/;
use Scalar::Util qw(blessed);
sub Menu {
return $HTML::Mason::Commands::m->notes('menu');
}
sub PageMenu {
return $HTML::Mason::Commands::m->notes('page-menu');
}
sub PageWidgets {
return $HTML::Mason::Commands::m->notes('page-widgets');
}
sub RenderMenu {
my %args = (toplevel => 1, parent_id => '', depth => 0, @_);
return unless $args{'menu'};
my ($menu, $depth, $toplevel, $id, $parent_id)
= @args{qw(menu depth toplevel id parent_id)};
my $interp = $m->interp;
my $web_path = RT->Config->Get('WebPath');
my $res = '';
$res .= ' ' x $depth;
$res .= '<ul';
$res .= ' id="'. $interp->apply_escapes($id, 'h') .'"'
if $id;
$res .= ' class="toplevel"' if $toplevel;
$res .= ">\n";
for my $child ($menu->children) {
$res .= ' 'x ($depth+1);
my $item_id = lc(($parent_id? "$parent_id-" : "") .$child->key);
$item_id =~ s/\s/-/g;
my $eitem_id = $interp->apply_escapes($item_id, 'h');
$res .= qq{<li id="li-$eitem_id"};
my @classes;
push @classes, 'has-children' if $child->has_children;
push @classes, 'active' if $child->active;
$res .= ' class="'. join( ' ', @classes ) .'"'
if @classes;
$res .= '>';
if ( my $tmp = $child->raw_html ) {
$res .= $tmp;
} else {
$res .= qq{<a id="$eitem_id" class="menu-item};
if ( $tmp = $child->class ) {
$res .= ' '. $interp->apply_escapes($tmp, 'h');
}
$res .= '"';
my $path = $child->path;
my $url = (not $path or $path =~ m{^\w+:/}) ? $path : $web_path . $path;
$url ||= "#";
$res .= ' href="'. $interp->apply_escapes($url, 'h') .'"';
if ( $tmp = $child->target ) {
$res .= ' target="'. $interp->apply_escapes($tmp, 'h') .'"'
}
if ($child->attributes) {
for my $key (keys %{$child->attributes}) {
my ($name, $value) = map { $interp->apply_escapes($_, 'h') }
$key, $child->attributes->{$key};
$res .= " $name=\"$value\"";
}
}
$res .= '>';
if ( $child->escape_title ) {
$res .= $interp->apply_escapes($child->title, 'h');
} else {
$res .= $child->title;
}
$res .= '</a>';
}
if ( $child->has_children ) {
$res .= "\n";
$res .= RenderMenu(
menu => $child,
toplevel => 0,
parent_id => $item_id,
depth => $depth+1,
return => 1,
);
$res .= "\n";
$res .= ' ' x ($depth+1);
}
$res .= "</li>\n";
}
$res .= ' ' x $depth;
$res .= '</ul>';
return $res if $args{'return'};
$m->print($res);
return '';
}
=head2 loc ARRAY
loc is a nice clean global routine which calls $session{'CurrentUser'}->loc()
with whatever it's called with. If there is no $session{'CurrentUser'},
it creates a temporary user, so we have something to get a localisation handle
through
=cut
sub loc {
if ( $session{'CurrentUser'}
&& UNIVERSAL::can( $session{'CurrentUser'}, 'loc' ) )
{
return ( $session{'CurrentUser'}->loc(@_) );
} elsif (
my $u = eval {
RT::CurrentUser->new();
}
)
{
return ( $u->loc(@_) );
} else {
# pathetic case -- SystemUser is gone.
return $_[0];
}
}
=head2 loc_fuzzy STRING
loc_fuzzy is for handling localizations of messages that may already
contain interpolated variables, typically returned from libraries
outside RT's control. It takes the message string and extracts the
variable array automatically by matching against the candidate entries
inside the lexicon file.
=cut
sub loc_fuzzy {
my $msg = shift;
if ( $session{'CurrentUser'}
&& UNIVERSAL::can( $session{'CurrentUser'}, 'loc' ) )
{
return ( $session{'CurrentUser'}->loc_fuzzy($msg) );
} else {
my $u = RT::CurrentUser->new( RT->SystemUser->Id );
return ( $u->loc_fuzzy($msg) );
}
}
# Error - calls Error and aborts
sub Abort {
my $why = shift;
my %args = @_;
if ( $session{'ErrorDocument'}
&& $session{'ErrorDocumentType'} )
{
$r->content_type( $session{'ErrorDocumentType'} );
$m->comp( $session{'ErrorDocument'}, Why => $why, %args );
$m->abort;
} else {
$m->comp( "/Elements/Error", Why => $why, %args );
$m->abort;
}
}
sub MaybeRedirectForResults {
my %args = (
Path => $HTML::Mason::Commands::m->request_comp->path,
Arguments => {},
Anchor => undef,
Actions => undef,
Force => 0,
@_
);
my $has_actions = $args{'Actions'} && grep( defined, @{ $args{'Actions'} } );
return unless $has_actions || $args{'Force'};
my %arguments = %{ $args{'Arguments'} };
if ( $has_actions ) {
my $key = Digest::MD5::md5_hex( rand(1024) );
push @{ $session{"Actions"}{ $key } ||= [] }, @{ $args{'Actions'} };
$session{'i'}++;
$arguments{'results'} = $key;
}
$args{'Path'} =~ s!^/+!!;
my $url = RT->Config->Get('WebURL') . $args{Path};
if ( keys %arguments ) {
$url .= '?'. $m->comp( '/Elements/QueryString', %arguments );
}
if ( $args{'Anchor'} ) {
$url .= "#". $args{'Anchor'};
}
return RT::Interface::Web::Redirect($url);
}
=head2 MaybeRedirectToApproval Path => 'path', Whitelist => REGEX, ARGSRef => HASHREF
If the ticket specified by C<< $ARGSRef->{id} >> is an approval ticket,
redirect to the approvals display page, preserving any arguments.
C<Path>s matching C<Whitelist> are let through.
This is a no-op if the C<ForceApprovalsView> option isn't enabled.
=cut
sub MaybeRedirectToApproval {
my %args = (
Path => $HTML::Mason::Commands::m->request_comp->path,
ARGSRef => {},
Whitelist => undef,
@_
);
return unless $ENV{REQUEST_METHOD} eq 'GET';
my $id = $args{ARGSRef}->{id};
if ( $id
and RT->Config->Get('ForceApprovalsView')
and not $args{Path} =~ /$args{Whitelist}/)
{
my $ticket = RT::Ticket->new( $session{'CurrentUser'} );
$ticket->Load($id);
if ($ticket and $ticket->id and lc($ticket->Type) eq 'approval') {
MaybeRedirectForResults(
Path => "/Approvals/Display.html",
Force => 1,
Anchor => $args{ARGSRef}->{Anchor},
Arguments => $args{ARGSRef},
);
}
}
}
=head2 CreateTicket ARGS
Create a new ticket, using Mason's %ARGS. returns @results.
=cut
sub CreateTicket {
my %ARGS = (@_);
my (@Actions);
my $current_user = $session{'CurrentUser'};
my $Ticket = RT::Ticket->new( $current_user );
my $Queue = RT::Queue->new( $current_user );
unless ( $Queue->Load( $ARGS{'Queue'} ) ) {
Abort('Queue not found');
}
unless ( $Queue->CurrentUserHasRight('CreateTicket') ) {
Abort('You have no permission to create tickets in that queue.');
}
my $due;
if ( defined $ARGS{'Due'} and $ARGS{'Due'} =~ /\S/ ) {
$due = RT::Date->new( $current_user );
$due->Set( Format => 'unknown', Value => $ARGS{'Due'} );
}
my $starts;
if ( defined $ARGS{'Starts'} and $ARGS{'Starts'} =~ /\S/ ) {
$starts = RT::Date->new( $current_user );
$starts->Set( Format => 'unknown', Value => $ARGS{'Starts'} );
}
my $sigless = RT::Interface::Web::StripContent(
Content => $ARGS{Content},
ContentType => $ARGS{ContentType},
StripSignature => 1,
CurrentUser => $current_user,
);
my $date_now = RT::Date->new( $current_user );
$date_now->SetToNow;
my $MIMEObj = MakeMIMEEntity(
Subject => $ARGS{'Subject'},
From => $ARGS{'From'} || $current_user->EmailAddress,
To => $ARGS{'To'} || $Queue->CorrespondAddress
|| RT->Config->Get('CorrespondAddress'),
Cc => $ARGS{'Cc'},
Date => $date_now->RFC2822(Timezone => 'user'),
Body => $sigless,
Type => $ARGS{'ContentType'},
Interface => RT::Interface::Web::MobileClient() ? 'Mobile' : 'Web',
);
my @attachments;
if ( my $tmp = $session{'Attachments'}{ $ARGS{'Token'} || '' } ) {
push @attachments, grep $_, map $tmp->{$_}, sort keys %$tmp;
delete $session{'Attachments'}{ $ARGS{'Token'} || '' }
unless $ARGS{'KeepAttachments'};
$session{'Attachments'} = $session{'Attachments'}
if @attachments;
}
if ( $ARGS{'Attachments'} ) {
push @attachments, grep $_, map $ARGS{Attachments}->{$_}, sort keys %{ $ARGS{'Attachments'} };
}
if ( @attachments ) {
$MIMEObj->make_multipart;
$MIMEObj->add_part( $_ ) foreach @attachments;
}
for my $argument (qw(Encrypt Sign)) {
if ( defined $ARGS{ $argument } ) {
$MIMEObj->head->replace( "X-RT-$argument" => $ARGS{$argument} ? 1 : 0 );
}
}
my %create_args = (
Type => $ARGS{'Type'} || 'ticket',
Queue => $ARGS{'Queue'},
Owner => $ARGS{'Owner'},
# note: name change
Requestor => $ARGS{'Requestors'},
Cc => $ARGS{'Cc'},
AdminCc => $ARGS{'AdminCc'},
InitialPriority => $ARGS{'InitialPriority'},
FinalPriority => $ARGS{'FinalPriority'},
TimeLeft => $ARGS{'TimeLeft'},
TimeEstimated => $ARGS{'TimeEstimated'},
TimeWorked => $ARGS{'TimeWorked'},
Subject => $ARGS{'Subject'},
Status => $ARGS{'Status'},
Due => $due ? $due->ISO : undef,
Starts => $starts ? $starts->ISO : undef,
MIMEObj => $MIMEObj,
SquelchMailTo => $ARGS{'SquelchMailTo'},
TransSquelchMailTo => $ARGS{'TransSquelchMailTo'},
);
if ($ARGS{'DryRun'}) {
$create_args{DryRun} = 1;
$create_args{Owner} ||= $RT::Nobody->Id;
$create_args{Requestor} ||= $session{CurrentUser}->EmailAddress;
$create_args{Subject} ||= '';
$create_args{Status} ||= $Queue->Lifecycle->DefaultOnCreate,
} else {
my @txn_squelch;
foreach my $type (qw(Requestor Cc AdminCc)) {
push @txn_squelch, map $_->address, Email::Address->parse( $create_args{$type} )
if grep $_ eq $type || $_ eq ( $type . 's' ), @{ $ARGS{'SkipNotification'} || [] };
}
push @{$create_args{TransSquelchMailTo}}, @txn_squelch;
}
if ( $ARGS{'AttachTickets'} ) {
require RT::Action::SendEmail;
RT::Action::SendEmail->AttachTickets( RT::Action::SendEmail->AttachTickets,
ref $ARGS{'AttachTickets'}
? @{ $ARGS{'AttachTickets'} }
: ( $ARGS{'AttachTickets'} ) );
}
my %cfs = ProcessObjectCustomFieldUpdatesForCreate(
ARGSRef => \%ARGS,
ContextObject => $Queue,
);
my %links = ProcessLinksForCreate( ARGSRef => \%ARGS );
my ( $id, $Trans, $ErrMsg ) = $Ticket->Create(%create_args, %links, %cfs);
return $Trans if $ARGS{DryRun};
unless ($id) {
Abort($ErrMsg);
}
push( @Actions, split( "\n", $ErrMsg ) );
unless ( $Ticket->CurrentUserHasRight('ShowTicket') ) {
Abort( "No permission to view newly created ticket #" . $Ticket->id . "." );
}
return ( $Ticket, @Actions );
}
=head2 LoadTicket id
Takes a ticket id as its only variable. if it's handed an array, it takes
the first value.
Returns an RT::Ticket object as the current user.
=cut
sub LoadTicket {
my $id = shift;
if ( ref($id) eq "ARRAY" ) {
$id = $id->[0];
}
unless ($id) {
Abort("No ticket specified");
}
my $Ticket = RT::Ticket->new( $session{'CurrentUser'} );
$Ticket->Load($id);
unless ( $Ticket->id ) {
Abort("Could not load ticket $id");
}
return $Ticket;
}
=head2 ProcessUpdateMessage
Takes paramhash with fields ARGSRef, TicketObj and SkipSignatureOnly.
Don't write message if it only contains current user's signature and
SkipSignatureOnly argument is true. Function anyway adds attachments
and updates time worked field even if skips message. The default value
is true.
=cut
sub ProcessUpdateMessage {
my %args = (
ARGSRef => undef,
TicketObj => undef,
SkipSignatureOnly => 1,
@_
);
my @attachments;
if ( my $tmp = $session{'Attachments'}{ $args{'ARGSRef'}{'Token'} || '' } ) {
push @attachments, grep $_, map $tmp->{$_}, sort keys %$tmp;
delete $session{'Attachments'}{ $args{'ARGSRef'}{'Token'} || '' }
unless $args{'KeepAttachments'};
$session{'Attachments'} = $session{'Attachments'}
if @attachments;
}
if ( $args{ARGSRef}{'UpdateAttachments'} ) {
push @attachments, grep $_, map $args{ARGSRef}->{UpdateAttachments}{$_},
sort keys %{ $args{ARGSRef}->{'UpdateAttachments'} };
}
# Strip the signature
$args{ARGSRef}->{UpdateContent} = RT::Interface::Web::StripContent(
Content => $args{ARGSRef}->{UpdateContent},
ContentType => $args{ARGSRef}->{UpdateContentType},
StripSignature => $args{SkipSignatureOnly},
CurrentUser => $args{'TicketObj'}->CurrentUser,
);
# If, after stripping the signature, we have no message, move the
# UpdateTimeWorked into adjusted TimeWorked, so that a later
# ProcessBasics can deal -- then bail out.
if ( not @attachments
and not length $args{ARGSRef}->{'UpdateContent'} )
{
if ( $args{ARGSRef}->{'UpdateTimeWorked'} ) {
$args{ARGSRef}->{TimeWorked} = $args{TicketObj}->TimeWorked + delete $args{ARGSRef}->{'UpdateTimeWorked'};
}
return;
}
if ( ($args{ARGSRef}->{'UpdateSubject'}||'') eq ($args{'TicketObj'}->Subject || '') ) {
$args{ARGSRef}->{'UpdateSubject'} = undef;
}
my $Message = MakeMIMEEntity(
Subject => $args{ARGSRef}->{'UpdateSubject'},
Body => $args{ARGSRef}->{'UpdateContent'},
Type => $args{ARGSRef}->{'UpdateContentType'},
Interface => RT::Interface::Web::MobileClient() ? 'Mobile' : 'Web',
);
$Message->head->replace( 'Message-ID' => Encode::encode( "UTF-8",
RT::Interface::Email::GenMessageId( Ticket => $args{'TicketObj'} )
) );
my $old_txn = RT::Transaction->new( $session{'CurrentUser'} );
if ( $args{ARGSRef}->{'QuoteTransaction'} ) {
$old_txn->Load( $args{ARGSRef}->{'QuoteTransaction'} );
} else {
$old_txn = $args{TicketObj}->Transactions->First();
}
if ( my $msg = $old_txn->Message->First ) {
RT::Interface::Email::SetInReplyTo(
Message => $Message,
InReplyTo => $msg,
Ticket => $args{'TicketObj'},
);
}
if ( @attachments ) {
$Message->make_multipart;
$Message->add_part( $_ ) foreach @attachments;
}
if ( $args{ARGSRef}->{'AttachTickets'} ) {
require RT::Action::SendEmail;
RT::Action::SendEmail->AttachTickets( RT::Action::SendEmail->AttachTickets,
ref $args{ARGSRef}->{'AttachTickets'}
? @{ $args{ARGSRef}->{'AttachTickets'} }
: ( $args{ARGSRef}->{'AttachTickets'} ) );
}
my %message_args = (
Sign => $args{ARGSRef}->{'Sign'},
Encrypt => $args{ARGSRef}->{'Encrypt'},
MIMEObj => $Message,
TimeTaken => $args{ARGSRef}->{'UpdateTimeWorked'}
);
_ProcessUpdateMessageRecipients(
MessageArgs => \%message_args,
%args,
);
my @results;
if ( $args{ARGSRef}->{'UpdateType'} =~ /^(private|public)$/ ) {
my ( $Transaction, $Description, $Object ) = $args{TicketObj}->Comment(%message_args);
push( @results, $Description );
$Object->UpdateCustomFields( %{ $args{ARGSRef} } ) if $Object;
} elsif ( $args{ARGSRef}->{'UpdateType'} eq 'response' ) {
my ( $Transaction, $Description, $Object ) = $args{TicketObj}->Correspond(%message_args);
push( @results, $Description );
$Object->UpdateCustomFields( %{ $args{ARGSRef} } ) if $Object;
} else {
push( @results,
loc("Update type was neither correspondence nor comment.") . " " . loc("Update not recorded.") );
}
return @results;
}
sub _ProcessUpdateMessageRecipients {
my %args = (
ARGSRef => undef,
TicketObj => undef,
MessageArgs => undef,
@_,
);
my $bcc = $args{ARGSRef}->{'UpdateBcc'};
my $cc = $args{ARGSRef}->{'UpdateCc'};
my $message_args = $args{MessageArgs};
$message_args->{CcMessageTo} = $cc;
$message_args->{BccMessageTo} = $bcc;
my @txn_squelch;
foreach my $type (qw(Cc AdminCc)) {
if (grep $_ eq $type || $_ eq ( $type . 's' ), @{ $args{ARGSRef}->{'SkipNotification'} || [] }) {
push @txn_squelch, map $_->address, Email::Address->parse( $message_args->{$type} );
push @txn_squelch, $args{TicketObj}->$type->MemberEmailAddresses;
push @txn_squelch, $args{TicketObj}->QueueObj->$type->MemberEmailAddresses;
}
}
if (grep $_ eq 'Requestor' || $_ eq 'Requestors', @{ $args{ARGSRef}->{'SkipNotification'} || [] }) {
push @txn_squelch, map $_->address, Email::Address->parse( $message_args->{Requestor} );
push @txn_squelch, $args{TicketObj}->Requestors->MemberEmailAddresses;
}
push @txn_squelch, @{$args{ARGSRef}{SquelchMailTo}} if $args{ARGSRef}{SquelchMailTo};
$message_args->{SquelchMailTo} = \@txn_squelch
if @txn_squelch;
unless ( $args{'ARGSRef'}->{'UpdateIgnoreAddressCheckboxes'} ) {
foreach my $key ( keys %{ $args{ARGSRef} } ) {
next unless $key =~ /^Update(Cc|Bcc)-(.*)$/;
my $var = ucfirst($1) . 'MessageTo';
my $value = $2;
if ( $message_args->{$var} ) {
$message_args->{$var} .= ", $value";
} else {
$message_args->{$var} = $value;
}
}
}
}
sub ProcessAttachments {
my %args = (
ARGSRef => {},
Token => '',
@_
);
my $token = $args{'ARGSRef'}{'Token'}
||= $args{'Token'} ||= Digest::MD5::md5_hex( rand(1024) );
my $update_session = 0;
# deal with deleting uploaded attachments
if ( my $del = $args{'ARGSRef'}{'DeleteAttach'} ) {
delete $session{'Attachments'}{ $token }{ $_ }
foreach ref $del? @$del : ($del);
$update_session = 1;
}
# store the uploaded attachment in session
my $new = $args{'ARGSRef'}{'Attach'};
if ( defined $new && length $new ) {
my $attachment = MakeMIMEEntity(
AttachmentFieldName => 'Attach'
);
# This needs to be decoded because the value is a reference;
# hence it was not decoded along with all of the standard
# arguments in DecodeARGS
my $file_path = Encode::decode( "UTF-8", "$new");
$session{'Attachments'}{ $token }{ $file_path } = $attachment;
$update_session = 1;
}
$session{'Attachments'} = $session{'Attachments'} if $update_session;
}
=head2 MakeMIMEEntity PARAMHASH
Takes a paramhash Subject, Body and AttachmentFieldName.
Also takes Form, Cc and Type as optional paramhash keys.
Returns a MIME::Entity.
=cut
sub MakeMIMEEntity {
#TODO document what else this takes.
my %args = (
Subject => undef,
From => undef,
Cc => undef,
Body => undef,
AttachmentFieldName => undef,
Type => undef,
Interface => 'API',
@_,
);
my $Message = MIME::Entity->build(
Type => 'multipart/mixed',
"Message-Id" => Encode::encode( "UTF-8", RT::Interface::Email::GenMessageId ),
"X-RT-Interface" => $args{Interface},
map { $_ => Encode::encode( "UTF-8", $args{ $_} ) }
grep defined $args{$_}, qw(Subject From Cc To Date)
);
if ( defined $args{'Body'} && length $args{'Body'} ) {
# Make the update content have no 'weird' newlines in it
$args{'Body'} =~ s/\r\n/\n/gs;
$Message->attach(
Type => $args{'Type'} || 'text/plain',
Charset => 'UTF-8',
Data => Encode::encode( "UTF-8", $args{'Body'} ),
);
}
if ( $args{'AttachmentFieldName'} ) {
my $cgi_object = $m->cgi_object;
my $filehandle = $cgi_object->upload( $args{'AttachmentFieldName'} );
if ( defined $filehandle && length $filehandle ) {
my ( @content, $buffer );
while ( my $bytesread = read( $filehandle, $buffer, 4096 ) ) {
push @content, $buffer;
}
my $uploadinfo = $cgi_object->uploadInfo($filehandle);
my $filename = Encode::decode("UTF-8","$filehandle");
$filename =~ s{^.*[\\/]}{};
$Message->attach(
Type => $uploadinfo->{'Content-Type'},
Filename => Encode::encode("UTF-8",$filename),
Data => \@content, # Bytes, as read directly from the file, above
);
if ( !$args{'Subject'} && !( defined $args{'Body'} && length $args{'Body'} ) ) {
$Message->head->replace( 'Subject' => Encode::encode( "UTF-8", $filename ) );
}
# Attachment parts really shouldn't get a Message-ID or "interface"
$Message->head->delete('Message-ID');
$Message->head->delete('X-RT-Interface');
}
}
$Message->make_singlepart;
RT::I18N::SetMIMEEntityToUTF8($Message); # convert text parts into utf-8
return ($Message);
}
=head2 ParseDateToISO
Takes a date in an arbitrary format.
Returns an ISO date and time in GMT
=cut
sub ParseDateToISO {
my $date = shift;
my $date_obj = RT::Date->new( $session{'CurrentUser'} );
$date_obj->Set(
Format => 'unknown',
Value => $date
);
return ( $date_obj->ISO );
}
sub ProcessACLChanges {
my $ARGSref = shift;
#XXX: why don't we get ARGSref like in other Process* subs?
my @results;
foreach my $arg ( keys %$ARGSref ) {
next unless ( $arg =~ /^(GrantRight|RevokeRight)-(\d+)-(.+?)-(\d+)$/ );
my ( $method, $principal_id, $object_type, $object_id ) = ( $1, $2, $3, $4 );
my @rights;
if ( UNIVERSAL::isa( $ARGSref->{$arg}, 'ARRAY' ) ) {
@rights = @{ $ARGSref->{$arg} };
} else {
@rights = $ARGSref->{$arg};
}
@rights = grep $_, @rights;
next unless @rights;
my $principal = RT::Principal->new( $session{'CurrentUser'} );
$principal->Load($principal_id);
my $obj;
if ( $object_type eq 'RT::System' ) {
$obj = $RT::System;
} elsif ( $object_type->DOES('RT::Record::Role::Rights') ) {
$obj = $object_type->new( $session{'CurrentUser'} );
$obj->Load($object_id);
unless ( $obj->id ) {
$RT::Logger->error("couldn't load $object_type #$object_id");
next;
}
} else {
$RT::Logger->error("object type '$object_type' is incorrect");
push( @results, loc("System Error") . ': ' . loc( "Rights could not be granted for [_1]", $object_type ) );
next;
}
foreach my $right (@rights) {
my ( $val, $msg ) = $principal->$method( Object => $obj, Right => $right );
push( @results, $msg );
}
}
return (@results);
}
=head2 ProcessACLs
ProcessACLs expects values from a series of checkboxes that describe the full
set of rights a principal should have on an object.
It expects form inputs with names like SetRights-PrincipalId-ObjType-ObjId
instead of with the prefixes Grant/RevokeRight. Each input should be an array
listing the rights the principal should have, and ProcessACLs will modify the
current rights to match. Additionally, the previously unused CheckACL input
listing PrincipalId-ObjType-ObjId is now used to catch cases when all the
rights are removed from a principal and as such no SetRights input is
submitted.
=cut
sub ProcessACLs {
my $ARGSref = shift;
my (%state, @results);
my $CheckACL = $ARGSref->{'CheckACL'};
my @check = grep { defined } (ref $CheckACL eq 'ARRAY' ? @$CheckACL : $CheckACL);
# Check if we want to grant rights to a previously rights-less user
for my $type (qw(user group)) {
my $principal = _ParseACLNewPrincipal($ARGSref, $type)
or next;
unless ($principal->PrincipalId) {
push @results, loc("Couldn't load the specified principal");
next;
}
my $principal_id = $principal->PrincipalId;
# Turn our addprincipal rights spec into a real one
for my $arg (keys %$ARGSref) {
next unless $arg =~ /^SetRights-addprincipal-(.+?-\d+)$/;
my $tuple = "$principal_id-$1";
my $key = "SetRights-$tuple";
# If we have it already, that's odd, but merge them
if (grep { $_ eq $tuple } @check) {
$ARGSref->{$key} = [
(ref $ARGSref->{$key} eq 'ARRAY' ? @{$ARGSref->{$key}} : $ARGSref->{$key}),
(ref $ARGSref->{$arg} eq 'ARRAY' ? @{$ARGSref->{$arg}} : $ARGSref->{$arg}),
];
} else {
$ARGSref->{$key} = $ARGSref->{$arg};
push @check, $tuple;
}
}
}
# Build our rights state for each Principal-Object tuple
foreach my $arg ( keys %$ARGSref ) {
next unless $arg =~ /^SetRights-(\d+-.+?-\d+)$/;
my $tuple = $1;
my $value = $ARGSref->{$arg};
my @rights = grep { $_ } (ref $value eq 'ARRAY' ? @$value : $value);
next unless @rights;
$state{$tuple} = { map { $_ => 1 } @rights };
}
foreach my $tuple (List::MoreUtils::uniq @check) {
next unless $tuple =~ /^(\d+)-(.+?)-(\d+)$/;
my ( $principal_id, $object_type, $object_id ) = ( $1, $2, $3 );
my $principal = RT::Principal->new( $session{'CurrentUser'} );
$principal->Load($principal_id);
my $obj;
if ( $object_type eq 'RT::System' ) {
$obj = $RT::System;
} elsif ( $object_type->DOES('RT::Record::Role::Rights') ) {
$obj = $object_type->new( $session{'CurrentUser'} );
$obj->Load($object_id);
unless ( $obj->id ) {
$RT::Logger->error("couldn't load $object_type #$object_id");
next;
}
} else {
$RT::Logger->error("object type '$object_type' is incorrect");
push( @results, loc("System Error") . ': ' . loc( "Rights could not be granted for [_1]", $object_type ) );
next;
}
my $acls = RT::ACL->new($session{'CurrentUser'});
$acls->LimitToObject( $obj );
$acls->LimitToPrincipal( Id => $principal_id );
while ( my $ace = $acls->Next ) {
my $right = $ace->RightName;
# Has right and should have right
next if delete $state{$tuple}->{$right};
# Has right and shouldn't have right
my ($val, $msg) = $principal->RevokeRight( Object => $obj, Right => $right );
push @results, $msg;
}
# For everything left, they don't have the right but they should
for my $right (keys %{ $state{$tuple} || {} }) {
delete $state{$tuple}->{$right};
my ($val, $msg) = $principal->GrantRight( Object => $obj, Right => $right );
push @results, $msg;
}
# Check our state for leftovers
if ( keys %{ $state{$tuple} || {} } ) {
my $missed = join '|', %{$state{$tuple} || {}};
$RT::Logger->warn(
"Uh-oh, it looks like we somehow missed a right in "
."ProcessACLs. Here's what was leftover: $missed"
);
}
}
return (@results);
}
=head2 _ParseACLNewPrincipal
Takes a hashref of C<%ARGS> and a principal type (C<user> or C<group>). Looks
for the presence of rights being added on a principal of the specified type,
and returns undef if no new principal is being granted rights. Otherwise loads
up an L<RT::User> or L<RT::Group> object and returns it. Note that the object
may not be successfully loaded, and you should check C<->id> yourself.
=cut
sub _ParseACLNewPrincipal {
my $ARGSref = shift;
my $type = lc shift;
my $key = "AddPrincipalForRights-$type";
return unless $ARGSref->{$key};
my $principal;
if ( $type eq 'user' ) {
$principal = RT::User->new( $session{'CurrentUser'} );
$principal->LoadByCol( Name => $ARGSref->{$key} );
}
elsif ( $type eq 'group' ) {
$principal = RT::Group->new( $session{'CurrentUser'} );
$principal->LoadUserDefinedGroup( $ARGSref->{$key} );
}
return $principal;
}
=head2 UpdateRecordObj ( ARGSRef => \%ARGS, Object => RT::Record, AttributesRef => \@attribs)
@attribs is a list of ticket fields to check and update if they differ from the B<Object>'s current values. ARGSRef is a ref to HTML::Mason's %ARGS.
Returns an array of success/failure messages
=cut
sub UpdateRecordObject {
my %args = (
ARGSRef => undef,
AttributesRef => undef,
Object => undef,
AttributePrefix => undef,
@_
);
my $Object = $args{'Object'};
my @results = $Object->Update(
AttributesRef => $args{'AttributesRef'},
ARGSRef => $args{'ARGSRef'},
AttributePrefix => $args{'AttributePrefix'},
);
return (@results);
}
sub ProcessCustomFieldUpdates {
my %args = (
CustomFieldObj => undef,
ARGSRef => undef,
@_
);
my $Object = $args{'CustomFieldObj'};
my $ARGSRef = $args{'ARGSRef'};
my @attribs = qw(Name Type Description Queue SortOrder);
my @results = UpdateRecordObject(
AttributesRef => \@attribs,
Object => $Object,
ARGSRef => $ARGSRef
);
my $prefix = "CustomField-" . $Object->Id;
if ( $ARGSRef->{"$prefix-AddValue-Name"} ) {
my ( $addval, $addmsg ) = $Object->AddValue(
Name => $ARGSRef->{"$prefix-AddValue-Name"},
Description => $ARGSRef->{"$prefix-AddValue-Description"},
SortOrder => $ARGSRef->{"$prefix-AddValue-SortOrder"},
);
push( @results, $addmsg );
}
my @delete_values
= ( ref $ARGSRef->{"$prefix-DeleteValue"} eq 'ARRAY' )
? @{ $ARGSRef->{"$prefix-DeleteValue"} }
: ( $ARGSRef->{"$prefix-DeleteValue"} );
foreach my $id (@delete_values) {
next unless defined $id;
my ( $err, $msg ) = $Object->DeleteValue($id);
push( @results, $msg );
}
my $vals = $Object->Values();
while ( my $cfv = $vals->Next() ) {
if ( my $so = $ARGSRef->{ "$prefix-SortOrder" . $cfv->Id } ) {
if ( $cfv->SortOrder != $so ) {
my ( $err, $msg ) = $cfv->SetSortOrder($so);
push( @results, $msg );
}
}
}
return (@results);
}
=head2 ProcessTicketBasics ( TicketObj => $Ticket, ARGSRef => \%ARGS );
Returns an array of results messages.
=cut
sub ProcessTicketBasics {
my %args = (
TicketObj => undef,
ARGSRef => undef,
@_
);
my $TicketObj = $args{'TicketObj'};
my $ARGSRef = $args{'ARGSRef'};
my $OrigOwner = $TicketObj->Owner;
# Set basic fields
my @attribs = qw(
Subject
FinalPriority
Priority
TimeEstimated
TimeWorked
TimeLeft
Type
Status
Queue
);
# Canonicalize Queue and Owner to their IDs if they aren't numeric
for my $field (qw(Queue Owner)) {
if ( $ARGSRef->{$field} and ( $ARGSRef->{$field} !~ /^(\d+)$/ ) ) {
my $class = $field eq 'Owner' ? "RT::User" : "RT::$field";
my $temp = $class->new(RT->SystemUser);
$temp->Load( $ARGSRef->{$field} );
if ( $temp->id ) {
$ARGSRef->{$field} = $temp->id;
}
}
}
# Status isn't a field that can be set to a null value.
# RT core complains if you try
delete $ARGSRef->{'Status'} unless $ARGSRef->{'Status'};
my @results = UpdateRecordObject(
AttributesRef => \@attribs,
Object => $TicketObj,
ARGSRef => $ARGSRef,
);
# We special case owner changing, so we can use ForceOwnerChange
if ( $ARGSRef->{'Owner'}
&& $ARGSRef->{'Owner'} !~ /\D/
&& ( $OrigOwner != $ARGSRef->{'Owner'} ) ) {
my ($ChownType);
if ( $ARGSRef->{'ForceOwnerChange'} ) {
$ChownType = "Force";
}
else {
$ChownType = "Set";
}
my ( $val, $msg ) = $TicketObj->SetOwner( $ARGSRef->{'Owner'}, $ChownType );
push( @results, $msg );
}
# }}}
return (@results);
}
sub ProcessTicketReminders {
my %args = (
TicketObj => undef,
ARGSRef => undef,
@_
);
my $Ticket = $args{'TicketObj'};
my $args = $args{'ARGSRef'};
my @results;
my $reminder_collection = $Ticket->Reminders->Collection;
if ( $args->{'update-reminders'} ) {
while ( my $reminder = $reminder_collection->Next ) {
my $resolve_status = $reminder->LifecycleObj->ReminderStatusOnResolve;
my ( $status, $msg, $old_subject, @subresults );
if ( $reminder->Status ne $resolve_status
&& $args->{ 'Complete-Reminder-' . $reminder->id } )
{
( $status, $msg ) = $Ticket->Reminders->Resolve($reminder);
push @subresults, $msg;
}
elsif ( $reminder->Status eq $resolve_status
&& !$args->{ 'Complete-Reminder-' . $reminder->id } )
{
( $status, $msg ) = $Ticket->Reminders->Open($reminder);
push @subresults, $msg;
}
if (
exists( $args->{ 'Reminder-Subject-' . $reminder->id } )
&& ( $reminder->Subject ne
$args->{ 'Reminder-Subject-' . $reminder->id } )
)
{
$old_subject = $reminder->Subject;
( $status, $msg ) =
$reminder->SetSubject(
$args->{ 'Reminder-Subject-' . $reminder->id } );
push @subresults, $msg;
}
if (
exists( $args->{ 'Reminder-Owner-' . $reminder->id } )
&& ( $reminder->Owner !=
$args->{ 'Reminder-Owner-' . $reminder->id } )
)
{
( $status, $msg ) =
$reminder->SetOwner(
$args->{ 'Reminder-Owner-' . $reminder->id }, "Force" );
push @subresults, $msg;
}
if ( exists( $args->{ 'Reminder-Due-' . $reminder->id } )
&& $args->{ 'Reminder-Due-' . $reminder->id } ne '' )
{
my $DateObj = RT::Date->new( $session{'CurrentUser'} );
my $due = $args->{ 'Reminder-Due-' . $reminder->id };
$DateObj->Set(
Format => 'unknown',
Value => $due,
);
if ( $DateObj->Unix != $reminder->DueObj->Unix ) {
( $status, $msg ) = $reminder->SetDue( $DateObj->ISO );
}
else {
$msg = loc( "invalid due date: [_1]", $due );
}
push @subresults, $msg;
}
push @results, map {
loc( "Reminder '[_1]': [_2]", $old_subject || $reminder->Subject, $_ )
} @subresults;
}
}
if ( $args->{'NewReminder-Subject'} ) {
my $due_obj = RT::Date->new( $session{'CurrentUser'} );
$due_obj->Set(
Format => 'unknown',
Value => $args->{'NewReminder-Due'}
);
my ( $status, $msg ) = $Ticket->Reminders->Add(
Subject => $args->{'NewReminder-Subject'},
Owner => $args->{'NewReminder-Owner'},
Due => $due_obj->ISO
);
if ( $status ) {
push @results,
loc( "Reminder '[_1]': [_2]", $args->{'NewReminder-Subject'}, loc("Created") )
}
else {
push @results, $msg;
}
}
return @results;
}
sub ProcessObjectCustomFieldUpdates {
my %args = @_;
my $ARGSRef = $args{'ARGSRef'};
my @results;
# Build up a list of objects that we want to work with
my %custom_fields_to_mod = _ParseObjectCustomFieldArgs($ARGSRef);
# For each of those objects
foreach my $class ( keys %custom_fields_to_mod ) {
foreach my $id ( keys %{ $custom_fields_to_mod{$class} } ) {
my $Object = $args{'Object'};
$Object = $class->new( $session{'CurrentUser'} )
unless $Object && ref $Object eq $class;
$Object->Load($id) unless ( $Object->id || 0 ) == $id;
unless ( $Object->id ) {
$RT::Logger->warning("Couldn't load object $class #$id");
next;
}
foreach my $cf ( keys %{ $custom_fields_to_mod{$class}{$id} } ) {
my $CustomFieldObj = RT::CustomField->new( $session{'CurrentUser'} );
$CustomFieldObj->SetContextObject($Object);
$CustomFieldObj->LoadById($cf);
unless ( $CustomFieldObj->id ) {
$RT::Logger->warning("Couldn't load custom field #$cf");
next;
}
my @groupings = sort keys %{ $custom_fields_to_mod{$class}{$id}{$cf} };
if (@groupings > 1) {
# Check for consistency, in case of JS fail
for my $key (qw/AddValue Value Values DeleteValues DeleteValueIds/) {
my $base = $custom_fields_to_mod{$class}{$id}{$cf}{$groupings[0]}{$key};
$base = [ $base ] unless ref $base;
for my $grouping (@groupings[1..$#groupings]) {
my $other = $custom_fields_to_mod{$class}{$id}{$cf}{$grouping}{$key};
$other = [ $other ] unless ref $other;
warn "CF $cf submitted with multiple differing values"
if grep {$_} List::MoreUtils::pairwise {
no warnings qw(uninitialized);
$a ne $b
} @{$base}, @{$other};
}
}
# We'll just be picking the 1st grouping in the hash, alphabetically
}
push @results,
_ProcessObjectCustomFieldUpdates(
Prefix => GetCustomFieldInputNamePrefix(
Object => $Object,
CustomField => $CustomFieldObj,
Grouping => $groupings[0],
),
Object => $Object,
CustomField => $CustomFieldObj,
ARGS => $custom_fields_to_mod{$class}{$id}{$cf}{ $groupings[0] },
);
}
}
}
return @results;
}
sub _ParseObjectCustomFieldArgs {
my $ARGSRef = shift || {};
my %custom_fields_to_mod;
foreach my $arg ( keys %$ARGSRef ) {
# format: Object-<object class>-<object id>-CustomField[:<grouping>]-<CF id>-<commands>
# you can use GetCustomFieldInputName to generate the complement input name
next unless $arg =~ /^Object-([\w:]+)-(\d*)-CustomField(?::(\w+))?-(\d+)-(.*)$/;
# For each of those objects, find out what custom fields we want to work with.
# Class ID CF grouping command
$custom_fields_to_mod{$1}{ $2 || 0 }{$4}{$3 || ''}{$5} = $ARGSRef->{$arg};
}
return wantarray ? %custom_fields_to_mod : \%custom_fields_to_mod;
}
sub _ProcessObjectCustomFieldUpdates {
my %args = @_;
my $cf = $args{'CustomField'};
my $cf_type = $cf->Type || '';
# Remove blank Values since the magic field will take care of this. Sometimes
# the browser gives you a blank value which causes CFs to be processed twice
if ( defined $args{'ARGS'}->{'Values'}
&& !length $args{'ARGS'}->{'Values'}
&& ($args{'ARGS'}->{'Values-Magic'}) )
{
delete $args{'ARGS'}->{'Values'};
}
my @results;
foreach my $arg ( keys %{ $args{'ARGS'} } ) {
# skip category argument
next if $arg =~ /-Category$/;
# since http won't pass in a form element with a null value, we need
# to fake it
if ( $arg =~ /-Magic$/ ) {
# We don't care about the magic, if there's really a values element;
next if defined $args{'ARGS'}->{'Value'} && length $args{'ARGS'}->{'Value'};
next if defined $args{'ARGS'}->{'Values'} && length $args{'ARGS'}->{'Values'};
# "Empty" values does not mean anything for Image and Binary fields
next if $cf_type =~ /^(?:Image|Binary)$/;
$arg = 'Values';
$args{'ARGS'}->{'Values'} = undef;
}
my @values = _NormalizeObjectCustomFieldValue(
CustomField => $cf,
Param => $args{'Prefix'} . $arg,
Value => $args{'ARGS'}->{$arg}
);
# "Empty" values still don't mean anything for Image and Binary fields
next if $cf_type =~ /^(?:Image|Binary)$/ and not @values;
if ( $arg eq 'AddValue' || $arg eq 'Value' ) {
foreach my $value (@values) {
my ( $val, $msg ) = $args{'Object'}->AddCustomFieldValue(
Field => $cf->id,
Value => $value
);
push( @results, $msg );
}
} elsif ( $arg eq 'Upload' ) {
my ( $val, $msg ) = $args{'Object'}->AddCustomFieldValue( %{$values[0]}, Field => $cf, );
push( @results, $msg );
} elsif ( $arg eq 'DeleteValues' ) {
foreach my $value (@values) {
my ( $val, $msg ) = $args{'Object'}->DeleteCustomFieldValue(
Field => $cf,
Value => $value,
);
push( @results, $msg );
}
} elsif ( $arg eq 'DeleteValueIds' ) {
foreach my $value (@values) {
my ( $val, $msg ) = $args{'Object'}->DeleteCustomFieldValue(
Field => $cf,
ValueId => $value,
);
push( @results, $msg );
}
} elsif ( $arg eq 'Values' ) {
my $cf_values = $args{'Object'}->CustomFieldValues( $cf->id );
my %values_hash;
foreach my $value (@values) {
if ( my $entry = $cf_values->HasEntry($value) ) {
$values_hash{ $entry->id } = 1;
next;
}
my ( $val, $msg ) = $args{'Object'}->AddCustomFieldValue(
Field => $cf,
Value => $value
);
push( @results, $msg );
$values_hash{$val} = 1 if $val;
}
# For Date Cfs, @values is empty when there is no changes (no datas in form input)
return @results if ( $cf->Type =~ /^Date(?:Time)?$/ && ! @values );
$cf_values->RedoSearch;
while ( my $cf_value = $cf_values->Next ) {
next if $values_hash{ $cf_value->id };
my ( $val, $msg ) = $args{'Object'}->DeleteCustomFieldValue(
Field => $cf,
ValueId => $cf_value->id
);
push( @results, $msg );
}
} else {
push(
@results,
loc("User asked for an unknown update type for custom field [_1] for [_2] object #[_3]",
$cf->Name, ref $args{'Object'},
$args{'Object'}->id
)
);
}
}
return @results;