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.78 by root, Tue Nov 7 00:15:27 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;
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
643 1 696 1
644 } or warn "$ext not loaded: $@"; 697 } or warn "$ext not loaded: $@";
645 } 698 }
646} 699}
647 700
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
727############################################################################# 701#############################################################################
728# extcmd framework, basically convert ext <msg> 702# extcmd framework, basically convert ext <msg>
729# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 703# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
730 704
731attach_to_players 705attach_to_players
783 } 757 }
784 }, 758 },
785; 759;
786 760
787############################################################################# 761#############################################################################
788# core extensions - in perl 762
763=head2 CORE EXTENSIONS
764
765Functions and methods that extend core crossfire objects.
766
767=over 4
789 768
790=item cf::player::exists $login 769=item cf::player::exists $login
791 770
792Returns true when the given account exists. 771Returns true when the given account exists.
793 772
796sub cf::player::exists($) { 775sub cf::player::exists($) {
797 cf::player::find $_[0] 776 cf::player::find $_[0]
798 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 777 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
799} 778}
800 779
801=item $player->reply ($npc, $msg[, $flags]) 780=item $object->reply ($npc, $msg[, $flags])
802 781
803Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 782Sends 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 783can be C<undef>. Does the right thing when the player is currently in a
805dialogue with the given NPC character. 784dialogue with the given NPC character.
806 785
833 $msg{msgid} = $id; 812 $msg{msgid} = $id;
834 813
835 $self->send ("ext " . to_json \%msg); 814 $self->send ("ext " . to_json \%msg);
836} 815}
837 816
817=back
818
819=cut
820
838############################################################################# 821#############################################################################
839# map scripting support 822
823=head2 SAFE SCRIPTING
824
825Functions that provide a safe environment to compile and execute
826snippets of perl code without them endangering the safety of the server
827itself. Looping constructs, I/O operators and other built-in functionality
828is not available in the safe scripting environment, and the number of
829functions and methods that cna be called is greatly reduced.
830
831=cut
840 832
841our $safe = new Safe "safe"; 833our $safe = new Safe "safe";
842our $safe_hole = new Safe::Hole; 834our $safe_hole = new Safe::Hole;
843 835
844$SIG{FPE} = 'IGNORE'; 836$SIG{FPE} = 'IGNORE';
845 837
846$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 838$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
847 839
848# here we export the classes and methods available to script code 840# here we export the classes and methods available to script code
841
842=pod
843
844The following fucntions and emthods are available within a safe environment:
845
846 cf::object contr pay_amount pay_player
847 cf::object::player player
848 cf::player peaceful
849
850=cut
849 851
850for ( 852for (
851 ["cf::object" => qw(contr pay_amount pay_player)], 853 ["cf::object" => qw(contr pay_amount pay_player)],
852 ["cf::object::player" => qw(player)], 854 ["cf::object::player" => qw(player)],
853 ["cf::player" => qw(peaceful)], 855 ["cf::player" => qw(peaceful)],
856 my ($pkg, @funs) = @$_; 858 my ($pkg, @funs) = @$_;
857 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 859 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
858 for @funs; 860 for @funs;
859} 861}
860 862
863=over 4
864
865=item @retval = safe_eval $code, [var => value, ...]
866
867Compiled and executes the given perl code snippet. additional var/value
868pairs result in temporary local (my) scalar variables of the given name
869that are available in the code snippet. Example:
870
871 my $five = safe_eval '$first + $second', first => 1, second => 4;
872
873=cut
874
861sub safe_eval($;@) { 875sub safe_eval($;@) {
862 my ($code, %vars) = @_; 876 my ($code, %vars) = @_;
863 877
864 my $qcode = $code; 878 my $qcode = $code;
865 $qcode =~ s/"/‟/g; # not allowed in #line filenames 879 $qcode =~ s/"/‟/g; # not allowed in #line filenames
887 } 901 }
888 902
889 wantarray ? @res : $res[0] 903 wantarray ? @res : $res[0]
890} 904}
891 905
906=item cf::register_script_function $function => $cb
907
908Register a function that can be called from within map/npc scripts. The
909function should be reasonably secure and should be put into a package name
910like the extension.
911
912Example: register a function that gets called whenever a map script calls
913C<rent::overview>, as used by the C<rent> extension.
914
915 cf::register_script_function "rent::overview" => sub {
916 ...
917 };
918
919=cut
920
892sub register_script_function { 921sub register_script_function {
893 my ($fun, $cb) = @_; 922 my ($fun, $cb) = @_;
894 923
895 no strict 'refs'; 924 no strict 'refs';
896 *{"safe::$fun"} = $safe_hole->wrap ($cb); 925 *{"safe::$fun"} = $safe_hole->wrap ($cb);
897} 926}
898 927
928=back
929
930=cut
931
932#############################################################################
933
934=head2 EXTENSION DATABASE SUPPORT
935
936Crossfire maintains a very simple database for extension use. It can
937currently store anything that can be serialised using Storable, which
938excludes objects.
939
940The parameter C<$family> should best start with the name of the extension
941using it, it should be unique.
942
943=over 4
944
945=item $hashref = cf::db_get $family
946
947Return a hashref for use by the extension C<$family>, which can be
948modified. After modifications, you have to call C<cf::db_dirty> or
949C<cf::db_sync>.
950
951=item $value = cf::db_get $family => $key
952
953Returns a single value from the database
954
955=item cf::db_put $family => $hashref
956
957Stores the given family hashref into the database. Updates are delayed, if
958you want the data to be synced to disk immediately, use C<cf::db_sync>.
959
960=item cf::db_put $family => $key => $value
961
962Stores the given C<$value> in the family hash. Updates are delayed, if you
963want the data to be synced to disk immediately, use C<cf::db_sync>.
964
965=item cf::db_dirty
966
967Marks the database as dirty, to be updated at a later time.
968
969=item cf::db_sync
970
971Immediately write the database to disk I<if it is dirty>.
972
973=cut
974
975our $DB;
976
977{
978 my $path = cf::localdir . "/database.pst";
979
980 sub db_load() {
981 warn "loading database $path\n";#d# remove later
982 $DB = stat $path ? Storable::retrieve $path : { };
983 }
984
985 my $pid;
986
987 sub db_save() {
988 warn "saving database $path\n";#d# remove later
989 waitpid $pid, 0 if $pid;
990 if (0 == ($pid = fork)) {
991 $DB->{_meta}{version} = 1;
992 Storable::nstore $DB, "$path~";
993 rename "$path~", $path;
994 cf::_exit 0 if defined $pid;
995 }
996 }
997
998 my $dirty;
999
1000 sub db_sync() {
1001 db_save if $dirty;
1002 undef $dirty;
1003 }
1004
1005 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1006 db_sync;
1007 });
1008
1009 sub db_dirty() {
1010 $dirty = 1;
1011 $idle->start;
1012 }
1013
1014 sub db_get($;$) {
1015 @_ >= 2
1016 ? $DB->{$_[0]}{$_[1]}
1017 : ($DB->{$_[0]} ||= { })
1018 }
1019
1020 sub db_put($$;$) {
1021 if (@_ >= 3) {
1022 $DB->{$_[0]}{$_[1]} = $_[2];
1023 } else {
1024 $DB->{$_[0]} = $_[1];
1025 }
1026 db_dirty;
1027 }
1028
1029 attach_global
1030 prio => 10000,
1031 on_cleanup => sub {
1032 db_sync;
1033 },
1034 ;
1035}
1036
899############################################################################# 1037#############################################################################
900# the server's main() 1038# the server's main()
901 1039
1040sub cfg_load {
1041 open my $fh, "<:utf8", cf::confdir . "/config"
1042 or return;
1043
1044 local $/;
1045 *CFG = YAML::Syck::Load <$fh>;
1046}
1047
902sub main { 1048sub main {
1049 cfg_load;
1050 db_load;
903 load_extensions; 1051 load_extensions;
904 Event::loop; 1052 Event::loop;
905} 1053}
906 1054
907############################################################################# 1055#############################################################################
908# initialisation 1056# initialisation
909 1057
1058sub _perl_reload(&) {
1059 my ($msg) = @_;
1060
1061 $msg->("reloading...");
1062
1063 eval {
1064 # cancel all watchers
1065 $_->cancel for Event::all_watchers;
1066
1067 # unload all extensions
1068 for (@exts) {
1069 $msg->("unloading <$_>");
1070 unload_extension $_;
1071 }
1072
1073 # unload all modules loaded from $LIBDIR
1074 while (my ($k, $v) = each %INC) {
1075 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1076
1077 $msg->("removing <$k>");
1078 delete $INC{$k};
1079
1080 $k =~ s/\.pm$//;
1081 $k =~ s/\//::/g;
1082
1083 if (my $cb = $k->can ("unload_module")) {
1084 $cb->();
1085 }
1086
1087 Symbol::delete_package $k;
1088 }
1089
1090 # sync database to disk
1091 cf::db_sync;
1092
1093 # get rid of safe::, as good as possible
1094 Symbol::delete_package "safe::$_"
1095 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1096
1097 # remove register_script_function callbacks
1098 # TODO
1099
1100 # unload cf.pm "a bit"
1101 delete $INC{"cf.pm"};
1102
1103 # don't, removes xs symbols, too,
1104 # and global variables created in xs
1105 #Symbol::delete_package __PACKAGE__;
1106
1107 # reload cf.pm
1108 $msg->("reloading cf.pm");
1109 require cf;
1110
1111 # load config and database again
1112 cf::cfg_load;
1113 cf::db_load;
1114
1115 # load extensions
1116 $msg->("load extensions");
1117 cf::load_extensions;
1118
1119 # reattach attachments to objects
1120 $msg->("reattach");
1121 _global_reattach;
1122 };
1123 $msg->($@) if $@;
1124
1125 $msg->("reloaded");
1126};
1127
1128sub perl_reload() {
1129 _perl_reload {
1130 warn $_[0];
1131 print "$_[0]\n";
1132 };
1133}
1134
1135register_command "perl-reload", 0, sub {
1136 my ($who, $arg) = @_;
1137
1138 if ($who->flag (FLAG_WIZ)) {
1139 _perl_reload {
1140 warn $_[0];
1141 $who->message ($_[0]);
1142 };
1143 }
1144};
1145
910register "<global>", __PACKAGE__; 1146register "<global>", __PACKAGE__;
911 1147
912unshift @INC, $LIBDIR; 1148unshift @INC, $LIBDIR;
913 1149
914$TICK_WATCHER = Event->timer ( 1150$TICK_WATCHER = Event->timer (
915 prio => 1, 1151 prio => 1,
1152 async => 1,
916 at => $NEXT_TICK || 1, 1153 at => $NEXT_TICK || 1,
917 cb => sub { 1154 cb => sub {
918 cf::server_tick; # one server iteration 1155 cf::server_tick; # one server iteration
919 1156
920 my $NOW = Event::time; 1157 my $NOW = Event::time;
921 $NEXT_TICK += $TICK; 1158 $NEXT_TICK += $TICK;
922 1159
923 # if we are delayed by four ticks, skip them all 1160 # if we are delayed by four ticks or more, skip them all
924 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1161 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
925 1162
926 $TICK_WATCHER->at ($NEXT_TICK); 1163 $TICK_WATCHER->at ($NEXT_TICK);
927 $TICK_WATCHER->start; 1164 $TICK_WATCHER->start;
928 }, 1165 },
929); 1166);
930 1167
1168eval { IO::AIO::max_poll_time $TICK * 0.2 }; #d# remove eval after restart
1169
1170Event->io (fd => IO::AIO::poll_fileno,
1171 poll => 'r',
1172 prio => 5,
1173 cb => \&IO::AIO::poll_cb);
1174
9311 11751
932 1176

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines