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.77 by root, Sun Nov 5 11:13:01 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
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->($@) 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
724############################################################################# 701#############################################################################
725# extcmd framework, basically convert ext <msg> 702# extcmd framework, basically convert ext <msg>
726# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 703# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
727 704
728attach_to_players 705attach_to_players
780 } 757 }
781 }, 758 },
782; 759;
783 760
784############################################################################# 761#############################################################################
785# core extensions - in perl 762
763=head2 CORE EXTENSIONS
764
765Functions and methods that extend core crossfire objects.
766
767=over 4
786 768
787=item cf::player::exists $login 769=item cf::player::exists $login
788 770
789Returns true when the given account exists. 771Returns true when the given account exists.
790 772
793sub cf::player::exists($) { 775sub cf::player::exists($) {
794 cf::player::find $_[0] 776 cf::player::find $_[0]
795 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;
796} 778}
797 779
798=item $player->reply ($npc, $msg[, $flags]) 780=item $object->reply ($npc, $msg[, $flags])
799 781
800Sends 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>
801can 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
802dialogue with the given NPC character. 784dialogue with the given NPC character.
803 785
830 $msg{msgid} = $id; 812 $msg{msgid} = $id;
831 813
832 $self->send ("ext " . to_json \%msg); 814 $self->send ("ext " . to_json \%msg);
833} 815}
834 816
817=back
818
819=cut
820
835############################################################################# 821#############################################################################
836# 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
837 832
838our $safe = new Safe "safe"; 833our $safe = new Safe "safe";
839our $safe_hole = new Safe::Hole; 834our $safe_hole = new Safe::Hole;
840 835
841$SIG{FPE} = 'IGNORE'; 836$SIG{FPE} = 'IGNORE';
842 837
843$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));
844 839
845# 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
846 851
847for ( 852for (
848 ["cf::object" => qw(contr pay_amount pay_player)], 853 ["cf::object" => qw(contr pay_amount pay_player)],
849 ["cf::object::player" => qw(player)], 854 ["cf::object::player" => qw(player)],
850 ["cf::player" => qw(peaceful)], 855 ["cf::player" => qw(peaceful)],
853 my ($pkg, @funs) = @$_; 858 my ($pkg, @funs) = @$_;
854 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 859 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
855 for @funs; 860 for @funs;
856} 861}
857 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
858sub safe_eval($;@) { 875sub safe_eval($;@) {
859 my ($code, %vars) = @_; 876 my ($code, %vars) = @_;
860 877
861 my $qcode = $code; 878 my $qcode = $code;
862 $qcode =~ s/"/‟/g; # not allowed in #line filenames 879 $qcode =~ s/"/‟/g; # not allowed in #line filenames
884 } 901 }
885 902
886 wantarray ? @res : $res[0] 903 wantarray ? @res : $res[0]
887} 904}
888 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
889sub register_script_function { 921sub register_script_function {
890 my ($fun, $cb) = @_; 922 my ($fun, $cb) = @_;
891 923
892 no strict 'refs'; 924 no strict 'refs';
893 *{"safe::$fun"} = $safe_hole->wrap ($cb); 925 *{"safe::$fun"} = $safe_hole->wrap ($cb);
894} 926}
895 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
975{
976 my $db;
977 my $path = cf::localdir . "/database.pst";
978
979 sub db_load() {
980 warn "loading database $path\n";#d# remove later
981 $db = stat $path ? Storable::retrieve $path : { };
982 }
983
984 my $pid;
985
986 sub db_save() {
987 warn "saving database $path\n";#d# remove later
988 waitpid $pid, 0 if $pid;
989 if (0 == ($pid = fork)) {
990 $db->{_meta}{version} = 1;
991 Storable::nstore $db, "$path~";
992 rename "$path~", $path;
993 cf::_exit 0 if defined $pid;
994 }
995 }
996
997 my $dirty;
998
999 sub db_sync() {
1000 db_save if $dirty;
1001 undef $dirty;
1002 }
1003
1004 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1005 db_sync;
1006 });
1007
1008 sub db_dirty() {
1009 $dirty = 1;
1010 $idle->start;
1011 }
1012
1013 sub db_get($;$) {
1014 @_ >= 2
1015 ? $db->{$_[0]}{$_[1]}
1016 : ($db->{$_[0]} ||= { })
1017 }
1018
1019 sub db_put($$;$) {
1020 if (@_ >= 3) {
1021 $db->{$_[0]}{$_[1]} = $_[2];
1022 } else {
1023 $db->{$_[0]} = $_[1];
1024 }
1025 db_dirty;
1026 }
1027
1028 attach_global
1029 prio => 10000,
1030 on_cleanup => sub {
1031 db_sync;
1032 },
1033 ;
1034}
1035
896############################################################################# 1036#############################################################################
897# the server's main() 1037# the server's main()
898 1038
1039sub cfg_load {
1040 open my $fh, "<:utf8", cf::confdir . "/config"
1041 or return;
1042
1043 local $/;
1044 *CFG = YAML::Syck::Load <$fh>;
1045}
1046
899sub main { 1047sub main {
1048 cfg_load;
1049 db_load;
900 load_extensions; 1050 load_extensions;
901 Event::loop; 1051 Event::loop;
902} 1052}
903 1053
904############################################################################# 1054#############################################################################
905# initialisation 1055# initialisation
906 1056
1057sub _perl_reload(&) {
1058 my ($msg) = @_;
1059
1060 $msg->("reloading...");
1061
1062 eval {
1063 # cancel all watchers
1064 $_->cancel for Event::all_watchers;
1065
1066 # unload all extensions
1067 for (@exts) {
1068 $msg->("unloading <$_>");
1069 unload_extension $_;
1070 }
1071
1072 # unload all modules loaded from $LIBDIR
1073 while (my ($k, $v) = each %INC) {
1074 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1075
1076 $msg->("removing <$k>");
1077 delete $INC{$k};
1078
1079 $k =~ s/\.pm$//;
1080 $k =~ s/\//::/g;
1081
1082 if (my $cb = $k->can ("unload_module")) {
1083 $cb->();
1084 }
1085
1086 Symbol::delete_package $k;
1087 }
1088
1089 # sync database to disk
1090 cf::db_sync;
1091
1092 # get rid of safe::, as good as possible
1093 Symbol::delete_package "safe::$_"
1094 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1095
1096 # remove register_script_function callbacks
1097 # TODO
1098
1099 # unload cf.pm "a bit"
1100 delete $INC{"cf.pm"};
1101
1102 # don't, removes xs symbols, too,
1103 # and global variables created in xs
1104 #Symbol::delete_package __PACKAGE__;
1105
1106 # reload cf.pm
1107 $msg->("reloading cf.pm");
1108 require cf;
1109
1110 # load config and database again
1111 cf::cfg_load;
1112 cf::db_load;
1113
1114 # load extensions
1115 $msg->("load extensions");
1116 cf::load_extensions;
1117
1118 # reattach attachments to objects
1119 $msg->("reattach");
1120 _global_reattach;
1121 };
1122 $msg->($@) if $@;
1123
1124 $msg->("reloaded");
1125};
1126
1127sub perl_reload() {
1128 _perl_reload {
1129 warn $_[0];
1130 print "$_[0]\n";
1131 };
1132}
1133
1134register_command "perl-reload", 0, sub {
1135 my ($who, $arg) = @_;
1136
1137 if ($who->flag (FLAG_WIZ)) {
1138 _perl_reload {
1139 warn $_[0];
1140 $who->message ($_[0]);
1141 };
1142 }
1143};
1144
907register "<global>", __PACKAGE__; 1145register "<global>", __PACKAGE__;
908 1146
909unshift @INC, $LIBDIR; 1147unshift @INC, $LIBDIR;
910 1148
911$TICK_WATCHER = Event->timer ( 1149$TICK_WATCHER = Event->timer (
912 prio => 1, 1150 prio => 1,
1151 async => 1,
913 at => $NEXT_TICK || 1, 1152 at => $NEXT_TICK || 1,
914 cb => sub { 1153 cb => sub {
915 cf::server_tick; # one server iteration 1154 cf::server_tick; # one server iteration
916 1155
917 my $NOW = Event::time; 1156 my $NOW = Event::time;
918 $NEXT_TICK += $TICK; 1157 $NEXT_TICK += $TICK;
919 1158
923 $TICK_WATCHER->at ($NEXT_TICK); 1162 $TICK_WATCHER->at ($NEXT_TICK);
924 $TICK_WATCHER->start; 1163 $TICK_WATCHER->start;
925 }, 1164 },
926); 1165);
927 1166
928_reload_2; 1167IO::AIO::max_poll_time $TICK * 0.2;
1168
1169Event->io (fd => IO::AIO::poll_fileno,
1170 poll => 'r',
1171 prio => 5,
1172 cb => \&IO::AIO::poll_cb);
929 1173
9301 11741
931 1175

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines