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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines