ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.63 by root, Fri Sep 8 17:41:41 2006 UTC vs.
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC

5use Storable; 5use Storable;
6use Opcode; 6use Opcode;
7use Safe; 7use Safe;
8use Safe::Hole; 8use Safe::Hole;
9 9
10use IO::AIO ();
11use YAML::Syck ();
10use Time::HiRes; 12use Time::HiRes;
11use Event; 13use Event;
12$Event::Eval = 1; # no idea why this is required, but it is 14$Event::Eval = 1; # no idea why this is required, but it is
13 15
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1;
18
14use strict; 19use strict;
15 20
16_init_vars; 21_init_vars;
17 22
18our %COMMAND = (); 23our %COMMAND = ();
20our $LIBDIR = maps_directory "perl"; 25our $LIBDIR = maps_directory "perl";
21 26
22our $TICK = MAX_TIME * 1e-6; 27our $TICK = MAX_TIME * 1e-6;
23our $TICK_WATCHER; 28our $TICK_WATCHER;
24our $NEXT_TICK; 29our $NEXT_TICK;
30
31our %CFG;
32
33our $UPTIME; $UPTIME ||= time;
34
35#############################################################################
36
37=head2 GLOBAL VARIABLES
38
39=over 4
40
41=item $cf::UPTIME
42
43The timestamp of the server start (so not actually an uptime).
44
45=item $cf::LIBDIR
46
47The perl library directory, where extensions and cf-specific modules can
48be found. It will be added to C<@INC> automatically.
49
50=item $cf::TICK
51
52The interval between server ticks, in seconds.
53
54=item %cf::CFG
55
56Configuration for the server, loaded from C</etc/crossfire/config>, or
57from wherever your confdir points to.
58
59=back
60
61=cut
25 62
26BEGIN { 63BEGIN {
27 *CORE::GLOBAL::warn = sub { 64 *CORE::GLOBAL::warn = sub {
28 my $msg = join "", @_; 65 my $msg = join "", @_;
29 $msg .= "\n" 66 $msg .= "\n"
51my @exts; 88my @exts;
52my @hook; 89my @hook;
53my %command; 90my %command;
54my %extcmd; 91my %extcmd;
55 92
56############################################################################# 93=head2 UTILITY FUNCTIONS
57# utility functions 94
95=over 4
96
97=cut
58 98
59use JSON::Syck (); # TODO# replace by JSON::PC once working 99use JSON::Syck (); # TODO# replace by JSON::PC once working
100
101=item $ref = cf::from_json $json
102
103Converts a JSON string into the corresponding perl data structure.
104
105=cut
60 106
61sub from_json($) { 107sub from_json($) {
62 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 108 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
63 JSON::Syck::Load $_[0] 109 JSON::Syck::Load $_[0]
64} 110}
65 111
112=item $json = cf::to_json $ref
113
114Converts a perl data structure into its JSON representation.
115
116=cut
117
66sub to_json($) { 118sub to_json($) {
67 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 119 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
68 JSON::Syck::Dump $_[0] 120 JSON::Syck::Dump $_[0]
69} 121}
70 122
123=back
124
125=cut
126
71############################################################################# 127#############################################################################
72# "new" plug-in system
73 128
74=head3 EVENTS AND OBJECT ATTACHMENTS 129=head2 EVENTS AND OBJECT ATTACHMENTS
75 130
76=over 4 131=over 4
77 132
78=item $object->attach ($attachment, key => $value...) 133=item $object->attach ($attachment, key => $value...)
79 134
353 for (@$callbacks) { 408 for (@$callbacks) {
354 eval { &{$_->[1]} }; 409 eval { &{$_->[1]} };
355 410
356 if ($@) { 411 if ($@) {
357 warn "$@"; 412 warn "$@";
358 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 413 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
359 override; 414 override;
360 } 415 }
361 416
362 return 1 if $override; 417 return 1 if $override;
363 } 418 }
379removed in future versions), and there is no public API to access override 434removed in future versions), and there is no public API to access override
380results (if you must, access C<@cf::invoke_results> directly). 435results (if you must, access C<@cf::invoke_results> directly).
381 436
382=back 437=back
383 438
384=head2 methods valid for all pointers 439=cut
440
441#############################################################################
442
443=head2 METHODS VALID FOR ALL CORE OBJECTS
385 444
386=over 4 445=over 4
387 446
388=item $object->valid 447=item $object->valid, $player->valid, $map->valid
389
390=item $player->valid
391
392=item $map->valid
393 448
394Just because you have a perl object does not mean that the corresponding 449Just because you have a perl object does not mean that the corresponding
395C-level object still exists. If you try to access an object that has no 450C-level object still exists. If you try to access an object that has no
396valid C counterpart anymore you get an exception at runtime. This method 451valid C counterpart anymore you get an exception at runtime. This method
397can be used to test for existence of the C object part without causing an 452can be used to test for existence of the C object part without causing an
470 unlink $filename; 525 unlink $filename;
471 unlink "$filename.pst"; 526 unlink "$filename.pst";
472 } 527 }
473} 528}
474 529
530sub object_freezer_as_string {
531 my ($rdata, $objs) = @_;
532
533 use Data::Dumper;
534
535 $$rdata . Dumper $objs
536}
537
475sub object_thawer_load { 538sub object_thawer_load {
476 my ($filename) = @_; 539 my ($filename) = @_;
477 540
478 local $/; 541 local $/;
479 542
581 . "#line 1 \"$path\"\n{\n" 644 . "#line 1 \"$path\"\n{\n"
582 . (do { local $/; <$fh> }) 645 . (do { local $/; <$fh> })
583 . "\n};\n1"; 646 . "\n};\n1";
584 647
585 eval $source 648 eval $source
586 or die "$path: $@"; 649 or die $@ ? "$path: $@\n"
650 : "extension disabled.\n";
587 651
588 push @exts, $pkg; 652 push @exts, $pkg;
589 $ext_pkg{$base} = $pkg; 653 $ext_pkg{$base} = $pkg;
590 654
591# no strict 'refs'; 655# no strict 'refs';
642 load_extension $ext; 706 load_extension $ext;
643 1 707 1
644 } or warn "$ext not loaded: $@"; 708 } or warn "$ext not loaded: $@";
645 } 709 }
646} 710}
647
648sub _perl_reload(&) {
649 my ($msg) = @_;
650
651 $msg->("reloading...");
652
653 eval {
654 # 1. cancel all watchers
655 $_->cancel for Event::all_watchers;
656
657 # 2. unload all extensions
658 for (@exts) {
659 $msg->("unloading <$_>");
660 unload_extension $_;
661 }
662
663 # 3. unload all modules loaded from $LIBDIR
664 while (my ($k, $v) = each %INC) {
665 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
666
667 $msg->("removing <$k>");
668 delete $INC{$k};
669
670 $k =~ s/\.pm$//;
671 $k =~ s/\//::/g;
672
673 if (my $cb = $k->can ("unload_module")) {
674 $cb->();
675 }
676
677 Symbol::delete_package $k;
678 }
679
680 # 4. get rid of safe::, as good as possible
681 Symbol::delete_package "safe::$_"
682 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
683
684 # 5. remove register_script_function callbacks
685 # TODO
686
687 # 6. unload cf.pm "a bit"
688 delete $INC{"cf.pm"};
689
690 # don't, removes xs symbols, too,
691 # and global variables created in xs
692 #Symbol::delete_package __PACKAGE__;
693
694 # 7. reload cf.pm
695 $msg->("reloading cf.pm");
696 require cf;
697
698 $msg->("load extensions");
699 cf::load_extensions;
700
701 $msg->("reattach");
702 _global_reattach;
703 };
704 $msg->($@) if $@;
705
706 $msg->("reloaded");
707};
708
709sub perl_reload() {
710 _perl_reload {
711 warn $_[0];
712 print "$_[0]\n";
713 };
714}
715
716register_command "perl-reload", 0, sub {
717 my ($who, $arg) = @_;
718
719 if ($who->flag (FLAG_WIZ)) {
720 _perl_reload {
721 warn $_[0];
722 $who->message ($_[0]);
723 };
724 }
725};
726 711
727############################################################################# 712#############################################################################
728# extcmd framework, basically convert ext <msg> 713# extcmd framework, basically convert ext <msg>
729# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 714# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
730 715
783 } 768 }
784 }, 769 },
785; 770;
786 771
787############################################################################# 772#############################################################################
788# core extensions - in perl 773
774=head2 CORE EXTENSIONS
775
776Functions and methods that extend core crossfire objects.
777
778=over 4
789 779
790=item cf::player::exists $login 780=item cf::player::exists $login
791 781
792Returns true when the given account exists. 782Returns true when the given account exists.
793 783
796sub cf::player::exists($) { 786sub cf::player::exists($) {
797 cf::player::find $_[0] 787 cf::player::find $_[0]
798 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 788 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
799} 789}
800 790
801=item $player->reply ($npc, $msg[, $flags]) 791=item $player_object->reply ($npc, $msg[, $flags])
802 792
803Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 793Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
804can be C<undef>. Does the right thing when the player is currently in a 794can be C<undef>. Does the right thing when the player is currently in a
805dialogue with the given NPC character. 795dialogue with the given NPC character.
806 796
833 $msg{msgid} = $id; 823 $msg{msgid} = $id;
834 824
835 $self->send ("ext " . to_json \%msg); 825 $self->send ("ext " . to_json \%msg);
836} 826}
837 827
828=item $player_object->may ("access")
829
830Returns wether the given player is authorized to access resource "access"
831(e.g. "command_wizcast").
832
833=cut
834
835sub cf::object::player::may {
836 my ($self, $access) = @_;
837
838 $self->flag (cf::FLAG_WIZ) ||
839 (ref $cf::CFG{"may_$access"}
840 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
841 : $cf::CFG{"may_$access"})
842}
843
844=cut
845
838############################################################################# 846#############################################################################
839# map scripting support 847
848=head2 SAFE SCRIPTING
849
850Functions that provide a safe environment to compile and execute
851snippets of perl code without them endangering the safety of the server
852itself. Looping constructs, I/O operators and other built-in functionality
853is not available in the safe scripting environment, and the number of
854functions and methods that can be called is greatly reduced.
855
856=cut
840 857
841our $safe = new Safe "safe"; 858our $safe = new Safe "safe";
842our $safe_hole = new Safe::Hole; 859our $safe_hole = new Safe::Hole;
843 860
844$SIG{FPE} = 'IGNORE'; 861$SIG{FPE} = 'IGNORE';
845 862
846$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 863$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
847 864
848# here we export the classes and methods available to script code 865# here we export the classes and methods available to script code
866
867=pod
868
869The following fucntions and emthods are available within a safe environment:
870
871 cf::object contr pay_amount pay_player
872 cf::object::player player
873 cf::player peaceful
874
875=cut
849 876
850for ( 877for (
851 ["cf::object" => qw(contr pay_amount pay_player)], 878 ["cf::object" => qw(contr pay_amount pay_player)],
852 ["cf::object::player" => qw(player)], 879 ["cf::object::player" => qw(player)],
853 ["cf::player" => qw(peaceful)], 880 ["cf::player" => qw(peaceful)],
856 my ($pkg, @funs) = @$_; 883 my ($pkg, @funs) = @$_;
857 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 884 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
858 for @funs; 885 for @funs;
859} 886}
860 887
888=over 4
889
890=item @retval = safe_eval $code, [var => value, ...]
891
892Compiled and executes the given perl code snippet. additional var/value
893pairs result in temporary local (my) scalar variables of the given name
894that are available in the code snippet. Example:
895
896 my $five = safe_eval '$first + $second', first => 1, second => 4;
897
898=cut
899
861sub safe_eval($;@) { 900sub safe_eval($;@) {
862 my ($code, %vars) = @_; 901 my ($code, %vars) = @_;
863 902
864 my $qcode = $code; 903 my $qcode = $code;
865 $qcode =~ s/"/‟/g; # not allowed in #line filenames 904 $qcode =~ s/"/‟/g; # not allowed in #line filenames
887 } 926 }
888 927
889 wantarray ? @res : $res[0] 928 wantarray ? @res : $res[0]
890} 929}
891 930
931=item cf::register_script_function $function => $cb
932
933Register a function that can be called from within map/npc scripts. The
934function should be reasonably secure and should be put into a package name
935like the extension.
936
937Example: register a function that gets called whenever a map script calls
938C<rent::overview>, as used by the C<rent> extension.
939
940 cf::register_script_function "rent::overview" => sub {
941 ...
942 };
943
944=cut
945
892sub register_script_function { 946sub register_script_function {
893 my ($fun, $cb) = @_; 947 my ($fun, $cb) = @_;
894 948
895 no strict 'refs'; 949 no strict 'refs';
896 *{"safe::$fun"} = $safe_hole->wrap ($cb); 950 *{"safe::$fun"} = $safe_hole->wrap ($cb);
897} 951}
898 952
953=back
954
955=cut
956
957#############################################################################
958
959=head2 EXTENSION DATABASE SUPPORT
960
961Crossfire maintains a very simple database for extension use. It can
962currently store anything that can be serialised using Storable, which
963excludes objects.
964
965The parameter C<$family> should best start with the name of the extension
966using it, it should be unique.
967
968=over 4
969
970=item $hashref = cf::db_get $family
971
972Return a hashref for use by the extension C<$family>, which can be
973modified. After modifications, you have to call C<cf::db_dirty> or
974C<cf::db_sync>.
975
976=item $value = cf::db_get $family => $key
977
978Returns a single value from the database
979
980=item cf::db_put $family => $hashref
981
982Stores the given family hashref into the database. Updates are delayed, if
983you want the data to be synced to disk immediately, use C<cf::db_sync>.
984
985=item cf::db_put $family => $key => $value
986
987Stores the given C<$value> in the family hash. Updates are delayed, if you
988want the data to be synced to disk immediately, use C<cf::db_sync>.
989
990=item cf::db_dirty
991
992Marks the database as dirty, to be updated at a later time.
993
994=item cf::db_sync
995
996Immediately write the database to disk I<if it is dirty>.
997
998=cut
999
1000our $DB;
1001
1002{
1003 my $path = cf::localdir . "/database.pst";
1004
1005 sub db_load() {
1006 warn "loading database $path\n";#d# remove later
1007 $DB = stat $path ? Storable::retrieve $path : { };
1008 }
1009
1010 my $pid;
1011
1012 sub db_save() {
1013 warn "saving database $path\n";#d# remove later
1014 waitpid $pid, 0 if $pid;
1015 if (0 == ($pid = fork)) {
1016 $DB->{_meta}{version} = 1;
1017 Storable::nstore $DB, "$path~";
1018 rename "$path~", $path;
1019 cf::_exit 0 if defined $pid;
1020 }
1021 }
1022
1023 my $dirty;
1024
1025 sub db_sync() {
1026 db_save if $dirty;
1027 undef $dirty;
1028 }
1029
1030 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1031 db_sync;
1032 });
1033
1034 sub db_dirty() {
1035 $dirty = 1;
1036 $idle->start;
1037 }
1038
1039 sub db_get($;$) {
1040 @_ >= 2
1041 ? $DB->{$_[0]}{$_[1]}
1042 : ($DB->{$_[0]} ||= { })
1043 }
1044
1045 sub db_put($$;$) {
1046 if (@_ >= 3) {
1047 $DB->{$_[0]}{$_[1]} = $_[2];
1048 } else {
1049 $DB->{$_[0]} = $_[1];
1050 }
1051 db_dirty;
1052 }
1053
1054 attach_global
1055 prio => 10000,
1056 on_cleanup => sub {
1057 db_sync;
1058 },
1059 ;
1060}
1061
899############################################################################# 1062#############################################################################
900# the server's main() 1063# the server's main()
901 1064
1065sub cfg_load {
1066 open my $fh, "<:utf8", cf::confdir . "/config"
1067 or return;
1068
1069 local $/;
1070 *CFG = YAML::Syck::Load <$fh>;
1071}
1072
902sub main { 1073sub main {
1074 cfg_load;
1075 db_load;
903 load_extensions; 1076 load_extensions;
904 Event::loop; 1077 Event::loop;
905} 1078}
906 1079
907############################################################################# 1080#############################################################################
908# initialisation 1081# initialisation
909 1082
1083sub _perl_reload(&) {
1084 my ($msg) = @_;
1085
1086 $msg->("reloading...");
1087
1088 eval {
1089 # cancel all watchers
1090 $_->cancel for Event::all_watchers;
1091
1092 # unload all extensions
1093 for (@exts) {
1094 $msg->("unloading <$_>");
1095 unload_extension $_;
1096 }
1097
1098 # unload all modules loaded from $LIBDIR
1099 while (my ($k, $v) = each %INC) {
1100 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101
1102 $msg->("removing <$k>");
1103 delete $INC{$k};
1104
1105 $k =~ s/\.pm$//;
1106 $k =~ s/\//::/g;
1107
1108 if (my $cb = $k->can ("unload_module")) {
1109 $cb->();
1110 }
1111
1112 Symbol::delete_package $k;
1113 }
1114
1115 # sync database to disk
1116 cf::db_sync;
1117
1118 # get rid of safe::, as good as possible
1119 Symbol::delete_package "safe::$_"
1120 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1121
1122 # remove register_script_function callbacks
1123 # TODO
1124
1125 # unload cf.pm "a bit"
1126 delete $INC{"cf.pm"};
1127
1128 # don't, removes xs symbols, too,
1129 # and global variables created in xs
1130 #Symbol::delete_package __PACKAGE__;
1131
1132 # reload cf.pm
1133 $msg->("reloading cf.pm");
1134 require cf;
1135
1136 # load config and database again
1137 cf::cfg_load;
1138 cf::db_load;
1139
1140 # load extensions
1141 $msg->("load extensions");
1142 cf::load_extensions;
1143
1144 # reattach attachments to objects
1145 $msg->("reattach");
1146 _global_reattach;
1147 };
1148 $msg->($@) if $@;
1149
1150 $msg->("reloaded");
1151};
1152
1153sub perl_reload() {
1154 _perl_reload {
1155 warn $_[0];
1156 print "$_[0]\n";
1157 };
1158}
1159
1160register_command "perl-reload", 0, sub {
1161 my ($who, $arg) = @_;
1162
1163 if ($who->flag (FLAG_WIZ)) {
1164 _perl_reload {
1165 warn $_[0];
1166 $who->message ($_[0]);
1167 };
1168 }
1169};
1170
910register "<global>", __PACKAGE__; 1171register "<global>", __PACKAGE__;
911 1172
912unshift @INC, $LIBDIR; 1173unshift @INC, $LIBDIR;
913 1174
914$TICK_WATCHER = Event->timer ( 1175$TICK_WATCHER = Event->timer (
915 prio => 1, 1176 prio => 1,
1177 async => 1,
916 at => $NEXT_TICK || 1, 1178 at => $NEXT_TICK || 1,
917 cb => sub { 1179 cb => sub {
918 cf::server_tick; # one server iteration 1180 cf::server_tick; # one server iteration
919 1181
920 my $NOW = Event::time; 1182 my $NOW = Event::time;
921 $NEXT_TICK += $TICK; 1183 $NEXT_TICK += $TICK;
922 1184
923 # if we are delayed by four ticks, skip them all 1185 # if we are delayed by four ticks or more, skip them all
924 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1186 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
925 1187
926 $TICK_WATCHER->at ($NEXT_TICK); 1188 $TICK_WATCHER->at ($NEXT_TICK);
927 $TICK_WATCHER->start; 1189 $TICK_WATCHER->start;
928 }, 1190 },
929); 1191);
930 1192
1193IO::AIO::max_poll_time $TICK * 0.2;
1194
1195Event->io (fd => IO::AIO::poll_fileno,
1196 poll => 'r',
1197 prio => 5,
1198 cb => \&IO::AIO::poll_cb);
1199
9311 12001
932 1201

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines