-
Notifications
You must be signed in to change notification settings - Fork 255
/
Web.pm
4046 lines (3205 loc) · 125 KB
/
Web.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# 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/&/&/g;
$$ref =~ s/</</g;
$$ref =~ s/>/>/g;
$$ref =~ s/\(/(/g;
$$ref =~ s/\)/)/g;
$$ref =~ s/"/"/g;
$$ref =~ s/'/'/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