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.69 by root, Mon Sep 18 01:10:35 2006 UTC vs.
Revision 1.86 by root, Thu Dec 14 05:09:32 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
21our %COMMAND = ();
22our %COMMAND_TIME = ();
23our %EXTCMD = ();
24
16_init_vars; 25_init_vars;
17 26
18our %COMMAND = ();
19our @EVENT; 27our @EVENT;
20our $LIBDIR = maps_directory "perl"; 28our $LIBDIR = maps_directory "perl";
21 29
22our $TICK = MAX_TIME * 1e-6; 30our $TICK = MAX_TIME * 1e-6;
23our $TICK_WATCHER; 31our $TICK_WATCHER;
24our $NEXT_TICK; 32our $NEXT_TICK;
33
34our %CFG;
35
36our $UPTIME; $UPTIME ||= time;
37
38#############################################################################
39
40=head2 GLOBAL VARIABLES
41
42=over 4
43
44=item $cf::UPTIME
45
46The timestamp of the server start (so not actually an uptime).
47
48=item $cf::LIBDIR
49
50The perl library directory, where extensions and cf-specific modules can
51be found. It will be added to C<@INC> automatically.
52
53=item $cf::TICK
54
55The interval between server ticks, in seconds.
56
57=item %cf::CFG
58
59Configuration for the server, loaded from C</etc/crossfire/config>, or
60from wherever your confdir points to.
61
62=back
63
64=cut
25 65
26BEGIN { 66BEGIN {
27 *CORE::GLOBAL::warn = sub { 67 *CORE::GLOBAL::warn = sub {
28 my $msg = join "", @_; 68 my $msg = join "", @_;
29 $msg .= "\n" 69 $msg .= "\n"
36 76
37@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 77@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
38 78
39# we bless all objects into (empty) derived classes to force a method lookup 79# we bless all objects into (empty) derived classes to force a method lookup
40# within the Safe compartment. 80# within the Safe compartment.
41for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 81for my $pkg (qw(
82 cf::object cf::object::player
83 cf::client_socket cf::player
84 cf::arch cf::living
85 cf::map cf::party cf::region
86)) {
42 no strict 'refs'; 87 no strict 'refs';
43 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 88 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
44} 89}
45 90
46$Event::DIED = sub { 91$Event::DIED = sub {
48}; 93};
49 94
50my %ext_pkg; 95my %ext_pkg;
51my @exts; 96my @exts;
52my @hook; 97my @hook;
53my %command;
54my %extcmd;
55 98
56############################################################################# 99=head2 UTILITY FUNCTIONS
57# utility functions 100
101=over 4
102
103=cut
58 104
59use JSON::Syck (); # TODO# replace by JSON::PC once working 105use JSON::Syck (); # TODO# replace by JSON::PC once working
106
107=item $ref = cf::from_json $json
108
109Converts a JSON string into the corresponding perl data structure.
110
111=cut
60 112
61sub from_json($) { 113sub from_json($) {
62 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 114 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
63 JSON::Syck::Load $_[0] 115 JSON::Syck::Load $_[0]
64} 116}
65 117
118=item $json = cf::to_json $ref
119
120Converts a perl data structure into its JSON representation.
121
122=cut
123
66sub to_json($) { 124sub to_json($) {
67 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 125 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
68 JSON::Syck::Dump $_[0] 126 JSON::Syck::Dump $_[0]
69} 127}
70 128
129=back
130
131=cut
132
71############################################################################# 133#############################################################################
72# "new" plug-in system
73 134
74=head3 EVENTS AND OBJECT ATTACHMENTS 135=head2 EVENTS AND OBJECT ATTACHMENTS
75 136
76=over 4 137=over 4
77 138
78=item $object->attach ($attachment, key => $value...) 139=item $object->attach ($attachment, key => $value...)
79 140
379removed in future versions), and there is no public API to access override 440removed in future versions), and there is no public API to access override
380results (if you must, access C<@cf::invoke_results> directly). 441results (if you must, access C<@cf::invoke_results> directly).
381 442
382=back 443=back
383 444
384=head2 methods valid for all pointers 445=cut
446
447#############################################################################
448
449=head2 METHODS VALID FOR ALL CORE OBJECTS
385 450
386=over 4 451=over 4
387 452
388=item $object->valid 453=item $object->valid, $player->valid, $map->valid
389
390=item $player->valid
391
392=item $map->valid
393 454
394Just because you have a perl object does not mean that the corresponding 455Just 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 456C-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 457valid 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 458can be used to test for existence of the C object part without causing an
470 unlink $filename; 531 unlink $filename;
471 unlink "$filename.pst"; 532 unlink "$filename.pst";
472 } 533 }
473} 534}
474 535
536sub object_freezer_as_string {
537 my ($rdata, $objs) = @_;
538
539 use Data::Dumper;
540
541 $$rdata . Dumper $objs
542}
543
475sub object_thawer_load { 544sub object_thawer_load {
476 my ($filename) = @_; 545 my ($filename) = @_;
477 546
478 local $/; 547 local $/;
479 548
504 if exists $src->{_attachment}; 573 if exists $src->{_attachment};
505 }, 574 },
506; 575;
507 576
508############################################################################# 577#############################################################################
509# old plug-in events 578# command handling &c
510 579
511sub inject_event { 580=item cf::register_command $name => \&callback($ob,$args);
512 my $extension = shift;
513 my $event_code = shift;
514 581
515 my $cb = $hook[$event_code]{$extension} 582Register a callback for execution when the client sends the user command
516 or return; 583$name.
517 584
518 &$cb 585=cut
519}
520
521sub inject_global_event {
522 my $event = shift;
523
524 my $cb = $hook[$event]
525 or return;
526
527 List::Util::max map &$_, values %$cb
528}
529
530sub inject_command {
531 my ($name, $obj, $params) = @_;
532
533 for my $cmd (@{ $command{$name} }) {
534 $cmd->[1]->($obj, $params);
535 }
536
537 -1
538}
539 586
540sub register_command { 587sub register_command {
541 my ($name, $time, $cb) = @_; 588 my ($name, $cb) = @_;
542 589
543 my $caller = caller; 590 my $caller = caller;
544 #warn "registering command '$name/$time' to '$caller'"; 591 #warn "registering command '$name/$time' to '$caller'";
545 592
546 push @{ $command{$name} }, [$time, $cb, $caller]; 593 push @{ $COMMAND{$name} }, [$caller, $cb];
547 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
548} 594}
595
596=item cf::register_extcmd $name => \&callback($pl,$packet);
597
598Register a callbackf ro execution when the client sends an extcmd packet.
599
600If the callback returns something, it is sent back as if reply was being
601called.
602
603=cut
549 604
550sub register_extcmd { 605sub register_extcmd {
551 my ($name, $cb) = @_; 606 my ($name, $cb) = @_;
552 607
553 my $caller = caller; 608 my $caller = caller;
554 #warn "registering extcmd '$name' to '$caller'"; 609 #warn "registering extcmd '$name' to '$caller'";
555 610
556 $extcmd{$name} = [$cb, $caller]; 611 $EXTCMD{$name} = [$cb, $caller];
557} 612}
613
614attach_to_players
615 on_command => sub {
616 my ($pl, $name, $params) = @_;
617
618 my $cb = $COMMAND{$name}
619 or return;
620
621 for my $cmd (@$cb) {
622 $cmd->[1]->($pl->ob, $params);
623 }
624
625 cf::override;
626 },
627 on_extcmd => sub {
628 my ($pl, $buf) = @_;
629
630 my $msg = eval { from_json $buf };
631
632 if (ref $msg) {
633 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
634 if (my %reply = $cb->[0]->($pl, $msg)) {
635 $pl->ext_reply ($msg->{msgid}, %reply);
636 }
637 }
638 } else {
639 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
640 }
641
642 cf::override;
643 },
644;
558 645
559sub register { 646sub register {
560 my ($base, $pkg) = @_; 647 my ($base, $pkg) = @_;
561 648
562 #TODO 649 #TODO
581 . "#line 1 \"$path\"\n{\n" 668 . "#line 1 \"$path\"\n{\n"
582 . (do { local $/; <$fh> }) 669 . (do { local $/; <$fh> })
583 . "\n};\n1"; 670 . "\n};\n1";
584 671
585 eval $source 672 eval $source
586 or die "$path: $@"; 673 or die $@ ? "$path: $@\n"
674 : "extension disabled.\n";
587 675
588 push @exts, $pkg; 676 push @exts, $pkg;
589 $ext_pkg{$base} = $pkg; 677 $ext_pkg{$base} = $pkg;
590 678
591# no strict 'refs'; 679# no strict 'refs';
604# for my $idx (0 .. $#PLUGIN_EVENT) { 692# for my $idx (0 .. $#PLUGIN_EVENT) {
605# delete $hook[$idx]{$pkg}; 693# delete $hook[$idx]{$pkg};
606# } 694# }
607 695
608 # remove commands 696 # remove commands
609 for my $name (keys %command) { 697 for my $name (keys %COMMAND) {
610 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 698 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
611 699
612 if (@cb) { 700 if (@cb) {
613 $command{$name} = \@cb; 701 $COMMAND{$name} = \@cb;
614 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
615 } else { 702 } else {
616 delete $command{$name};
617 delete $COMMAND{"$name\000"}; 703 delete $COMMAND{$name};
618 } 704 }
619 } 705 }
620 706
621 # remove extcmds 707 # remove extcmds
622 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 708 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
623 delete $extcmd{$name}; 709 delete $EXTCMD{$name};
624 } 710 }
625 711
626 if (my $cb = $pkg->can ("unload")) { 712 if (my $cb = $pkg->can ("unload")) {
627 eval { 713 eval {
628 $cb->($pkg); 714 $cb->($pkg);
644 } or warn "$ext not loaded: $@"; 730 } or warn "$ext not loaded: $@";
645 } 731 }
646} 732}
647 733
648############################################################################# 734#############################################################################
649# extcmd framework, basically convert ext <msg>
650# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
651
652attach_to_players
653 on_extcmd => sub {
654 my ($pl, $buf) = @_;
655
656 my $msg = eval { from_json $buf };
657
658 if (ref $msg) {
659 if (my $cb = $extcmd{$msg->{msgtype}}) {
660 if (my %reply = $cb->[0]->($pl, $msg)) {
661 $pl->ext_reply ($msg->{msgid}, %reply);
662 }
663 }
664 } else {
665 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
666 }
667
668 cf::override;
669 },
670;
671
672#############################################################################
673# load/save/clean perl data associated with a map 735# load/save/clean perl data associated with a map
674 736
675*cf::mapsupport::on_clean = sub { 737*cf::mapsupport::on_clean = sub {
676 my ($map) = @_; 738 my ($map) = @_;
677 739
704 } 766 }
705 }, 767 },
706; 768;
707 769
708############################################################################# 770#############################################################################
709# core extensions - in perl 771
772=head2 CORE EXTENSIONS
773
774Functions and methods that extend core crossfire objects.
775
776=over 4
710 777
711=item cf::player::exists $login 778=item cf::player::exists $login
712 779
713Returns true when the given account exists. 780Returns true when the given account exists.
714 781
717sub cf::player::exists($) { 784sub cf::player::exists($) {
718 cf::player::find $_[0] 785 cf::player::find $_[0]
719 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 786 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
720} 787}
721 788
722=item $player->reply ($npc, $msg[, $flags]) 789=item $player_object->reply ($npc, $msg[, $flags])
723 790
724Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 791Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
725can be C<undef>. Does the right thing when the player is currently in a 792can be C<undef>. Does the right thing when the player is currently in a
726dialogue with the given NPC character. 793dialogue with the given NPC character.
727 794
754 $msg{msgid} = $id; 821 $msg{msgid} = $id;
755 822
756 $self->send ("ext " . to_json \%msg); 823 $self->send ("ext " . to_json \%msg);
757} 824}
758 825
826=item $player_object->may ("access")
827
828Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast").
830
831=cut
832
833sub cf::object::player::may {
834 my ($self, $access) = @_;
835
836 $self->flag (cf::FLAG_WIZ) ||
837 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"})
840}
841
842=cut
843
759############################################################################# 844#############################################################################
760# map scripting support 845
846=head2 SAFE SCRIPTING
847
848Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server
850itself. Looping constructs, I/O operators and other built-in functionality
851is not available in the safe scripting environment, and the number of
852functions and methods that can be called is greatly reduced.
853
854=cut
761 855
762our $safe = new Safe "safe"; 856our $safe = new Safe "safe";
763our $safe_hole = new Safe::Hole; 857our $safe_hole = new Safe::Hole;
764 858
765$SIG{FPE} = 'IGNORE'; 859$SIG{FPE} = 'IGNORE';
766 860
767$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 861$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
768 862
769# here we export the classes and methods available to script code 863# here we export the classes and methods available to script code
864
865=pod
866
867The following fucntions and emthods are available within a safe environment:
868
869 cf::object contr pay_amount pay_player
870 cf::object::player player
871 cf::player peaceful
872
873=cut
770 874
771for ( 875for (
772 ["cf::object" => qw(contr pay_amount pay_player)], 876 ["cf::object" => qw(contr pay_amount pay_player)],
773 ["cf::object::player" => qw(player)], 877 ["cf::object::player" => qw(player)],
774 ["cf::player" => qw(peaceful)], 878 ["cf::player" => qw(peaceful)],
777 my ($pkg, @funs) = @$_; 881 my ($pkg, @funs) = @$_;
778 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
779 for @funs; 883 for @funs;
780} 884}
781 885
886=over 4
887
888=item @retval = safe_eval $code, [var => value, ...]
889
890Compiled and executes the given perl code snippet. additional var/value
891pairs result in temporary local (my) scalar variables of the given name
892that are available in the code snippet. Example:
893
894 my $five = safe_eval '$first + $second', first => 1, second => 4;
895
896=cut
897
782sub safe_eval($;@) { 898sub safe_eval($;@) {
783 my ($code, %vars) = @_; 899 my ($code, %vars) = @_;
784 900
785 my $qcode = $code; 901 my $qcode = $code;
786 $qcode =~ s/"/‟/g; # not allowed in #line filenames 902 $qcode =~ s/"/‟/g; # not allowed in #line filenames
830 946
831 no strict 'refs'; 947 no strict 'refs';
832 *{"safe::$fun"} = $safe_hole->wrap ($cb); 948 *{"safe::$fun"} = $safe_hole->wrap ($cb);
833} 949}
834 950
951=back
952
953=cut
954
835############################################################################# 955#############################################################################
836 956
837=head2 EXTENSION DATABASE SUPPORT 957=head2 EXTENSION DATABASE SUPPORT
838 958
839Crossfire maintains a very simple database for extension use. It can 959Crossfire maintains a very simple database for extension use. It can
873 993
874Immediately write the database to disk I<if it is dirty>. 994Immediately write the database to disk I<if it is dirty>.
875 995
876=cut 996=cut
877 997
998our $DB;
999
878{ 1000{
879 my $db;
880 my $path = cf::localdir . "/database.pst"; 1001 my $path = cf::localdir . "/database.pst";
881 1002
882 sub db_load() { 1003 sub db_load() {
883 warn "loading database $path\n";#d# remove later 1004 warn "loading database $path\n";#d# remove later
884 $db = stat $path ? Storable::retrieve $path : { }; 1005 $DB = stat $path ? Storable::retrieve $path : { };
885 } 1006 }
886 1007
887 my $pid; 1008 my $pid;
888 1009
889 sub db_save() { 1010 sub db_save() {
890 warn "saving database $path\n";#d# remove later 1011 warn "saving database $path\n";#d# remove later
891 waitpid $pid, 0 if $pid; 1012 waitpid $pid, 0 if $pid;
892 if (0 == ($pid = fork)) { 1013 if (0 == ($pid = fork)) {
893 $db->{_meta}{version} = 1; 1014 $DB->{_meta}{version} = 1;
894 Storable::nstore $db, "$path~"; 1015 Storable::nstore $DB, "$path~";
895 rename "$path~", $path; 1016 rename "$path~", $path;
896 cf::_exit 0 if defined $pid; 1017 cf::_exit 0 if defined $pid;
897 } 1018 }
898 } 1019 }
899 1020
913 $idle->start; 1034 $idle->start;
914 } 1035 }
915 1036
916 sub db_get($;$) { 1037 sub db_get($;$) {
917 @_ >= 2 1038 @_ >= 2
918 ? $db->{$_[0]}{$_[1]} 1039 ? $DB->{$_[0]}{$_[1]}
919 : ($db->{$_[0]} ||= { }) 1040 : ($DB->{$_[0]} ||= { })
920 } 1041 }
921 1042
922 sub db_put($$;$) { 1043 sub db_put($$;$) {
923 if (@_ >= 3) { 1044 if (@_ >= 3) {
924 $db->{$_[0]}{$_[1]} = $_[2]; 1045 $DB->{$_[0]}{$_[1]} = $_[2];
925 } else { 1046 } else {
926 $db->{$_[0]} = $_[1]; 1047 $DB->{$_[0]} = $_[1];
927 } 1048 }
928 db_dirty; 1049 db_dirty;
929 } 1050 }
930 1051
931 attach_global 1052 attach_global
937} 1058}
938 1059
939############################################################################# 1060#############################################################################
940# the server's main() 1061# the server's main()
941 1062
1063sub cfg_load {
1064 open my $fh, "<:utf8", cf::confdir . "/config"
1065 or return;
1066
1067 local $/;
1068 *CFG = YAML::Syck::Load <$fh>;
1069}
1070
942sub main { 1071sub main {
1072 cfg_load;
943 db_load; 1073 db_load;
944 load_extensions; 1074 load_extensions;
945 Event::loop; 1075 Event::loop;
946} 1076}
947 1077
999 1129
1000 # reload cf.pm 1130 # reload cf.pm
1001 $msg->("reloading cf.pm"); 1131 $msg->("reloading cf.pm");
1002 require cf; 1132 require cf;
1003 1133
1004 # load database again 1134 # load config and database again
1135 cf::cfg_load;
1005 cf::db_load; 1136 cf::db_load;
1006 1137
1007 # load extensions 1138 # load extensions
1008 $msg->("load extensions"); 1139 $msg->("load extensions");
1009 cf::load_extensions; 1140 cf::load_extensions;
1022 warn $_[0]; 1153 warn $_[0];
1023 print "$_[0]\n"; 1154 print "$_[0]\n";
1024 }; 1155 };
1025} 1156}
1026 1157
1158register "<global>", __PACKAGE__;
1159
1027register_command "perl-reload", 0, sub { 1160register_command "perl-reload" => sub {
1028 my ($who, $arg) = @_; 1161 my ($who, $arg) = @_;
1029 1162
1030 if ($who->flag (FLAG_WIZ)) { 1163 if ($who->flag (FLAG_WIZ)) {
1031 _perl_reload { 1164 _perl_reload {
1032 warn $_[0]; 1165 warn $_[0];
1033 $who->message ($_[0]); 1166 $who->message ($_[0]);
1034 }; 1167 };
1035 } 1168 }
1036}; 1169};
1037 1170
1038register "<global>", __PACKAGE__;
1039
1040unshift @INC, $LIBDIR; 1171unshift @INC, $LIBDIR;
1041 1172
1042$TICK_WATCHER = Event->timer ( 1173$TICK_WATCHER = Event->timer (
1043 prio => 1, 1174 prio => 1,
1175 async => 1,
1044 at => $NEXT_TICK || 1, 1176 at => $NEXT_TICK || 1,
1045 cb => sub { 1177 cb => sub {
1046 cf::server_tick; # one server iteration 1178 cf::server_tick; # one server iteration
1047 1179
1048 my $NOW = Event::time; 1180 my $NOW = Event::time;
1049 $NEXT_TICK += $TICK; 1181 $NEXT_TICK += $TICK;
1050 1182
1051 # if we are delayed by four ticks, skip them all 1183 # if we are delayed by four ticks or more, skip them all
1052 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1184 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1053 1185
1054 $TICK_WATCHER->at ($NEXT_TICK); 1186 $TICK_WATCHER->at ($NEXT_TICK);
1055 $TICK_WATCHER->start; 1187 $TICK_WATCHER->start;
1056 }, 1188 },
1057); 1189);
1058 1190
1191IO::AIO::max_poll_time $TICK * 0.2;
1192
1193Event->io (fd => IO::AIO::poll_fileno,
1194 poll => 'r',
1195 prio => 5,
1196 cb => \&IO::AIO::poll_cb);
1197
10591 11981
1060 1199

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines