-
Notifications
You must be signed in to change notification settings - Fork 8
/
Environment.pm
executable file
·3528 lines (2610 loc) · 85.5 KB
/
Environment.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
# This code is a part of Slash, and is released under the GPL.
# Copyright 1997-2005 by Open Source Technology Group. See README
# and COPYING for more information, or see http://slashcode.com/.
package Slash::Utility::Environment;
=head1 NAME
Slash::Utility::Environment - SHORT DESCRIPTION for Slash
=head1 SYNOPSIS
use Slash::Utility;
# do not use this module directly
=head1 DESCRIPTION
LONG DESCRIPTION.
=head1 EXPORTED FUNCTIONS
=cut
use strict;
use Apache::ModuleConfig;
use Digest::MD5 'md5_hex';
use Time::HiRes;
use Slash::Constants ();
use Socket qw( inet_aton inet_ntoa );
use base 'Exporter';
our $VERSION = $Slash::Constants::VERSION;
our @EXPORT = qw(
dbAvailable
createCurrentAnonymousCoward
createCurrentCookie
createCurrentDB
createCurrentForm
createCurrentHostname
createCurrentStatic
createCurrentUser
createCurrentVirtualUser
setCurrentForm
setCurrentSkin
setCurrentUser
getCurrentAnonymousCoward
getCurrentCookie
getCurrentDB
getCurrentForm
getCurrentMenu
getCurrentSkin
getCurrentStatic
getCurrentUser
getCurrentVirtualUser
getCurrentCache
setUserDBs
saveUserDBs
createEnvironment
getObject
getAnonId
isAnon
isAdmin
isSubscriber
prepareUser
filter_params
loadClass
loadCoderef
setUserDate
isDST
bakeUserCookie
eatUserCookie
setCookie
getPublicLogToken
getPollVoterHash
debugHash
slashProf
slashProfBail
slashProfInit
slashProfEnd
getOpAndDatFromStatusAndURI
createLog
errorLog
writeLog
determineCurrentSkin
get_ipids
get_srcids
convert_srcid
get_srcid_prependbyte
get_srcid_sql_in
get_srcid_sql_out
get_srcid_type
get_srcid_vis
decode_srcid_prependbyte
);
use constant DST_HR => 0;
use constant DST_NUM => 1;
use constant DST_DAY => 2;
use constant DST_MON => 3;
# These are file-scoped variables that are used when you need to use the
# set methods when not running under mod_perl
my($static_user, $static_form, $static_constants, $static_site_constants,
$static_db, $static_anonymous_coward, $static_cookie,
$static_virtual_user, $static_objects, $static_cache, $static_hostname,
$static_skin);
# FRY: I don't regret this. But I both rue and lament it.
#========================================================================
=head2 dbAvailable([TOKEN])
Returns TRUE if (as usual) the DB(s) are available for reading and
writing. Returns FALSE if the DB(s) are not available and should not
be accessed. If a TOKEN is named, return FALSE if either the DB(s)
required for that purpose are down or all DBs are down. If no TOKEN is
named, return FALSE only if all DBs are down.
Whether or not the DBs are down is determined only by whether files exist
at /usr/local/slash/dboff or /usr/local/slash/dboff_TOKEN. For best
results, admins will want to write their own db-angel scripts that detect
DBs having gone down and create one or more of those files.
=over 4
=item Parameters
=over 4
=item TOKEN
Name of the resource specifically being asked about, or the
empty string.
=back
=item Return value
0 or 1.
=back
=cut
{ # closure
my $dbAvailable_lastcheck = {};
my $dbAvailable_lastval = {};
sub dbAvailable {
# I'm not going to explain exactly how I came up with this
# logic... the if's are ordered to reduce computation as
# much as possible.
my($token) = @_;
# if we're doing a general check for dbAvailability we set
# the token to empty-string and store the lastchecked status
# and lastval check in the hashrefs with that as the key
$token ||= '';
if (defined $dbAvailable_lastcheck->{$token} && time < ($dbAvailable_lastcheck->{$token} + 5)) {
return $dbAvailable_lastval->{$token};
}
my $newval;
if (-e "/usr/local/slash/dboff") { $newval = 0 }
elsif (!$token || $token !~ /^(\w+)/) { $newval = 1 }
elsif (-e "/usr/local/slash/dboff_$token") { $newval = 0 }
else { $newval = 1 }
$dbAvailable_lastval->{$token} = $newval;
$dbAvailable_lastcheck->{$token} = time;
return $newval;
}
} # end closure
#========================================================================
=head2 getCurrentMenu([NAME])
Returns the menu for the resource requested.
=over 4
=item Parameters
=over 4
=item NAME
Name of the menu that you want to fetch. If not supplied,
menu named after active script will be used (i.e., the "users"
menu for "users.pl").
=back
=item Return value
A reference to an array with the menu in it is returned.
=back
=cut
sub getCurrentMenu {
my($menu) = @_;
my($user, @menus, $user_menu);
# do we want to bother with menus at all for static pages?
# i can see why we might ... i dunno -- pudge
#
# Well, yes. Since createMenu() may be used in a header
# and a footer, if we don't generate menus on static pages,
# the page itself will be busted. We've already run into this
# for one site, so took a stab at fixing it. -- Cliff
if ($ENV{GATEWAY_INTERFACE}) {;
$user = getCurrentUser();
unless ($menu) {
($menu = $ENV{SCRIPT_NAME}) =~ s/\.pl$//;
}
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
return unless $cfg->{menus}{$menu};
@menus = @{$cfg->{menus}{$menu}};
} else {
# Load menus direct from the database.
my $reader = getObject('Slash::DB', { db_type => 'reader' });
my $menus = $reader->getMenus();
@menus = @{$menus->{$menu}} if exists $menus->{$menu};
}
if ($user && ($user_menu = $user->{menus}{$menu})) {
push @menus, values %$user_menu;
}
return \@menus;
}
#========================================================================
=head2 getCurrentUser([MEMBER])
Returns the current authenticated user.
=over 4
=item Parameters
=over 4
=item MEMBER
A member from the users record to be returned.
=back
=item Return value
A hash reference with the user information is returned unless VALUE is passed. If
MEMBER is passed in then only its value will be returned.
=back
=cut
sub getCurrentUser {
my($value) = @_;
my $user;
if ($ENV{GATEWAY_INTERFACE} && (my $r = Apache->request)) {
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$user = $cfg->{user} ||= {};
} else {
$user = $static_user ||= {};
}
return $user->{$value} if defined $value;
return $user;
}
#========================================================================
=head2 setCurrentUser(MEMBER, VALUE)
Sets a value for the current user. It will not be permanently stored.
=over 4
=item Parameters
=over 4
=item MEMBER
The member to store VALUE in.
=item VALUE
VALUE to be stored in the current user hash.
=back
=item Return value
The passed value.
=back
=cut
sub setCurrentUser {
my($key, $value) = @_;
my $user;
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$user = $cfg->{'user'};
} else {
$user = $static_user;
}
$user->{$key} = $value;
}
#========================================================================
=head2 setCurrentForm(MEMBER, VALUE)
Sets a value for the current user. It will not be permanently stored.
=over 4
=item Parameters
=over 4
=item MEMBER
The member to store VALUE in.
=item VALUE
VALUE to be stored in the current user hash.
=back
=item Return value
The passed value.
=back
=cut
sub setCurrentForm {
my($key, $value) = @_;
my $form;
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$form = $cfg->{'form'};
} else {
$form = $static_form;
}
$form->{$key} = $value;
}
#========================================================================
=head2 createCurrentUser(USER)
Creates the current user.
=over 4
=item Parameters
=over 4
=item USER
USER to be inserted into current user.
=back
=item Return value
Returns no value.
=back
=cut
sub createCurrentUser {
my($user) = @_;
$user ||= {};
if ($ENV{GATEWAY_INTERFACE} && (my $r = Apache->request)) {
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$cfg->{'user'} = $user;
} else {
$static_user = $user;
}
}
#========================================================================
=head2 getCurrentForm([MEMBER])
Returns the current form.
=over 4
=item Parameters
=over 4
=item MEMBER
A member from the forms record to be returned.
=back
=item Return value
A hash reference with the form information is returned unless VALUE is passed. If
MEMBER is passed in then only its value will be returned.
=back
=cut
sub getCurrentForm {
my($value) = @_;
my $form;
if ($ENV{GATEWAY_INTERFACE} && (my $r = Apache->request)) {
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$form = $cfg->{'form'};
} else {
$form = $static_form;
}
return defined $value ? $form->{$value} : $form;
}
#========================================================================
=head2 createCurrentForm(FORM)
Creates the current form.
=over 4
=item Parameters
=over 4
=item FORM
FORM to be inserted into current form.
=back
=item Return value
Returns no value.
=back
=cut
sub createCurrentForm {
my($form) = @_;
$form ||= {};
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$cfg->{'form'} = $form;
} else {
$static_form = $form;
}
}
#========================================================================
=head2 getCurrentCookie([MEMBER])
Returns the current cookie.
=over 4
=item Parameters
=over 4
=item MEMBER
A member from the cookies record to be returned.
=back
=item Return value
A hash reference with the cookie incookieation is returned
unless VALUE is passed. If MEMBER is passed in then
only its value will be returned.
=back
=cut
sub getCurrentCookie {
my($value) = @_;
my $cookie;
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$cookie = $cfg->{'cookie'};
} else {
$cookie = $static_cookie;
}
return defined $value ? $cookie->{$value} : $cookie;
}
#========================================================================
=head2 createCurrentCookie(COOKIE)
Creates the current cookie.
=over 4
=item Parameters
=over 4
=item COOKIE
COOKIE to be inserted into current cookie.
=back
=item Return value
Returns no value.
=back
=cut
sub createCurrentCookie {
my($cookie) = @_;
$cookie ||= {};
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$cfg->{'cookie'} = $cookie;
} else {
$static_cookie = $cookie;
}
}
#========================================================================
=head2 getCurrentSkin([MEMBER])
Returns the current skin.
=over 4
=item Parameters
=over 4
=item MEMBER
A member (field) from the skin record.
=back
=item Return value
A hash reference with the skin information is returned unless MEMBER is
passed. If MEMBER is passed in then only its value will be returned.
=back
=cut
sub getCurrentSkin {
my($value) = @_;
my $current_skin;
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$current_skin = $cfg->{skin} ||= {};
} else {
$current_skin = $static_skin ||= {};
}
return defined $value ? $current_skin->{$value} : $current_skin;
}
#========================================================================
=head2 setCurrentSkin(HASH)
Set up the current skin global, which will be returned by
getCurrentSkin(), for both static scripts and under Apache.
=over 4
=item Parameters
=over 4
=item ID
Numeric ID (skins.skid) or name (skins.name).
=back
=item Return value
Returns no value.
=back
=cut
sub setCurrentSkin {
my($id) = @_;
my $slashdb = getCurrentDB();
my $current_skin;
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$current_skin = $cfg->{skin} ||= {};
} else {
$current_skin = $static_skin ||= {};
}
#print STDERR scalar(localtime) . " $$ setCurrentSkin id=$id c_s->{skid}=$current_skin->{skid}\n";
return 1 if $current_skin->{skid} && $current_skin->{skid} == $id;
my $gSkin = $slashdb->getSkin($id);
# we want to retain any references to $gSkin that are already
# in existence
@{$current_skin}{keys %$gSkin} = values %$gSkin;
# Now, if prepareUser() has already been called, we have to update
# the anonymous coward. Otherwise, we leave it alone and trust
# that prepareUser() will set it properly itself.
my $user = getCurrentUser();
#print STDERR scalar(localtime) . " $$ setCurrentSkin user->uid=$user->{uid} current_skin->skid=$current_skin->{skid}\n";
if ($user->{uid}) {
# prepareUser() has been called already, so it's OK to
# call it again.
my $new_ac_uid = $current_skin->{ac_uid} || getCurrentStatic('anonymous_coward_uid');
my $ac_user = getCurrentAnonymousCoward();
#print STDERR scalar(localtime) . " $$ setCurrentSkin new_ac_uid='$new_ac_uid' ac_user->uid='$ac_user->{uid}'\n";
if ($ac_user->{uid} != $new_ac_uid) {
$ENV{SLASH_USER} = $new_ac_uid;
my $form = getCurrentForm();
my $new_ac_user = prepareUser($new_ac_uid, $form, $0);
#print STDERR scalar(localtime) . " $$ new_ac_user: " . Dumper($new_ac_user);
createCurrentAnonymousCoward($new_ac_user);
# If the user is not currently logged in, switch them
# from the old AC user to the new AC user.
if ($user->{is_anon}) {
createCurrentUser($new_ac_user);
}
}
}
}
#========================================================================
=head2 getCurrentStatic([MEMBER])
Returns the current static variables (or variable).
=over 4
=item Parameters
=over 4
=item MEMBER
A member from the static record to be returned.
=back
=item Return value
A hash reference with the static information is returned unless MEMBER is passed. If
MEMBER is passed in then only its value will be returned.
=back
=cut
sub getCurrentStatic {
my($value) = @_;
my $constants;
if ($ENV{GATEWAY_INTERFACE} && (my $r = Apache->request)) {
my $const_cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
## XXXSKIN - this should probably go away, along with SlashSectionHost,
## SlashSetFormHost, and SlashSetVarHost in Slash::Apache, except ...
# my $hostname = $r->header_in('host');
# $hostname =~ s/:\d+$//;
# if ($const_cfg->{'site_constants'}{$hostname}) {
# $constants = $const_cfg->{site_constants}{$hostname};
# } else {
## XXXSKIN - ... this would be the one line to keep
$constants = $const_cfg->{'constants'};
# }
} else {
$constants = $static_constants;
}
return defined $value ? $constants->{$value} : $constants;
}
#========================================================================
=head2 createCurrentStatic(HASH)
Creates the current static information for non Apache scripts.
=over 4
=item Parameters
=over 4
=item HASH
A hash that is to be used in scripts not running in Apache to simulate a
script running under Apache.
=back
=item Return value
Returns no value.
=back
=cut
sub createCurrentStatic {
($static_constants) = @_;
$static_site_constants = $_[1] if defined $_[1];
}
#========================================================================
=head2 createCurrentHostname(HOSTNAME)
Allows you to set a host so that constants will behave properly.
This is used as a key into %$static_site_constants so that a single
Apache process can serve multiple Slash sites.
=over 4
=item Parameters
=over 4
=item HOSTNAME
A name of a host to use to force constants to think it is being used by a host.
=back
=item Return value
Returns no value.
=back
=cut
sub createCurrentHostname {
($static_hostname) = @_;
}
#========================================================================
=head2 getCurrentAnonymousCoward([MEMBER])
Returns the current anonymous corward (or value from that object).
=over 4
=item Parameters
=over 4
=item MEMBER
A member from the AC record to be returned.
=back
=item Return value
If MEMBER, then that value is returned; else, the hash containing all
the AC info will be returned.
=back
=cut
sub getCurrentAnonymousCoward {
my($value) = @_;
my $ref;
if ($ENV{GATEWAY_INTERFACE}) {
my $r = Apache->request;
my $const_cfg = Apache::ModuleConfig->get($r, 'Slash::Apache') or return;
$ref = $const_cfg->{anonymous_coward};
} else {
$ref = $static_anonymous_coward;
}
return undef unless $ref && ref $ref;
return $ref->{$value} if defined $value;
my %coward = %$ref;
return \%coward;
}
#========================================================================
=head2 createCurrentAnonymousCoward(HASH)
Creates the current anonymous coward for non Apache scripts.
=over 4
=item Parameters
=over 4
=item HASH
A hash that is to be used in scripts not running in Apache to simulate a
script running under Apache.
=back
=item Return value
Returns no value.
=back
=cut
sub createCurrentAnonymousCoward {
($static_anonymous_coward) = @_;
}
#========================================================================
=head2 getCurrentVirtualUser()
Returns the current virtual user that the site is running under.
=over 4
=item Return value
The current virtual user that the site is running under.
=back
=cut
sub getCurrentVirtualUser {
if ($ENV{GATEWAY_INTERFACE} && (my $r = Apache->request)) {
my $cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
return $cfg->{'VirtualUser'};
} else {
return $static_virtual_user;
}
}
#========================================================================
=head2 createCurrentVirtualUser(VIRTUAL_USER)
Creates the current virtual user for non Apache scripts.
=over 4
=item Parameters
=over 4
=item VIRTUAL_USER
The current virtual user that is to be used in scripts not running in Apache
to simulate a script running under Apache.
=back
=item Return value
Returns no value.
=back
=cut
sub createCurrentVirtualUser {
($static_virtual_user) = @_;
}
#========================================================================
=head2 getCurrentDB()
Returns the current Slash::DB object.
=over 4
=item Return value
Returns the current Slash::DB object.
=back
=cut
sub getCurrentDB {
my $slashdb;
if ($ENV{GATEWAY_INTERFACE} && (my $r = Apache->request)) {
my $const_cfg = Apache::ModuleConfig->get($r, 'Slash::Apache');
$slashdb = $const_cfg->{slashdb};
} else {
$slashdb = $static_db;
}
return $slashdb;
}
#========================================================================
=head2 createCurrentDB(SLASHDB)
Creates the current DB object for scripts not running under Apache.
=over 4
=item Parameters
=over 4
=item SLASHDB