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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines