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.59 by root, Wed Aug 30 16:30:37 2006 UTC vs.
Revision 1.88 by root, Fri Dec 15 19:29:18 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; 21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
17 22
18our %COMMAND = (); 23our %COMMAND = ();
24our %COMMAND_TIME = ();
25our %EXTCMD = ();
26
27_init_vars;
28
19our @EVENT; 29our @EVENT;
20our %PROP_TYPE; 30our $LIBDIR = datadir . "/ext";
21our %PROP_IDX;
22our $LIBDIR = maps_directory "perl";
23 31
24our $TICK = MAX_TIME * 1e-6; 32our $TICK = MAX_TIME * 1e-6;
25our $TICK_WATCHER; 33our $TICK_WATCHER;
26our $NEXT_TICK; 34our $NEXT_TICK;
35
36our %CFG;
37
38our $UPTIME; $UPTIME ||= time;
39
40#############################################################################
41
42=head2 GLOBAL VARIABLES
43
44=over 4
45
46=item $cf::UPTIME
47
48The timestamp of the server start (so not actually an uptime).
49
50=item $cf::LIBDIR
51
52The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically.
54
55=item $cf::TICK
56
57The interval between server ticks, in seconds.
58
59=item %cf::CFG
60
61Configuration for the server, loaded from C</etc/crossfire/config>, or
62from wherever your confdir points to.
63
64=back
65
66=cut
27 67
28BEGIN { 68BEGIN {
29 *CORE::GLOBAL::warn = sub { 69 *CORE::GLOBAL::warn = sub {
30 my $msg = join "", @_; 70 my $msg = join "", @_;
31 $msg .= "\n" 71 $msg .= "\n"
34 print STDERR "cfperl: $msg"; 74 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg"; 75 LOG llevError, "cfperl: $msg";
36 }; 76 };
37} 77}
38 78
39my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
40
41# generate property mutators
42sub prop_gen {
43 my ($prefix, $class) = @_;
44
45 no strict 'refs';
46
47 for my $prop (keys %PROP_TYPE) {
48 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
49 my $sub = lc $1;
50
51 my $type = $PROP_TYPE{$prop};
52 my $idx = $PROP_IDX {$prop};
53
54 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55 $_[0]->get_property ($type, $idx)
56 };
57
58 *{"$class\::set_$sub"} = sub {
59 $_[0]->set_property ($type, $idx, $_[1]);
60 } unless $ignore_set{$prop};
61 }
62}
63
64# auto-generate most of the API
65
66prop_gen OBJECT_PROP => "cf::object";
67# CFAPI_OBJECT_ANIMATION?
68prop_gen PLAYER_PROP => "cf::object::player";
69
70prop_gen MAP_PROP => "cf::map";
71prop_gen ARCH_PROP => "cf::arch";
72
73@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 79@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74 80
75# we bless all objects into (empty) derived classes to force a method lookup 81# we bless all objects into (empty) derived classes to force a method lookup
76# within the Safe compartment. 82# within the Safe compartment.
77for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 83for my $pkg (qw(
84 cf::object cf::object::player
85 cf::client_socket cf::player
86 cf::arch cf::living
87 cf::map cf::party cf::region
88)) {
78 no strict 'refs'; 89 no strict 'refs';
79 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 90 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80} 91}
81 92
82$Event::DIED = sub { 93$Event::DIED = sub {
84}; 95};
85 96
86my %ext_pkg; 97my %ext_pkg;
87my @exts; 98my @exts;
88my @hook; 99my @hook;
89my %command;
90my %extcmd;
91 100
92############################################################################# 101=head2 UTILITY FUNCTIONS
93# utility functions 102
103=over 4
104
105=cut
94 106
95use JSON::Syck (); # TODO# replace by JSON::PC once working 107use JSON::Syck (); # TODO# replace by JSON::PC once working
108
109=item $ref = cf::from_json $json
110
111Converts a JSON string into the corresponding perl data structure.
112
113=cut
96 114
97sub from_json($) { 115sub from_json($) {
98 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 116 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99 JSON::Syck::Load $_[0] 117 JSON::Syck::Load $_[0]
100} 118}
101 119
120=item $json = cf::to_json $ref
121
122Converts a perl data structure into its JSON representation.
123
124=cut
125
102sub to_json($) { 126sub to_json($) {
103 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 127 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104 JSON::Syck::Dump $_[0] 128 JSON::Syck::Dump $_[0]
105} 129}
106 130
131=back
132
133=cut
134
107############################################################################# 135#############################################################################
108# "new" plug-in system
109 136
110=head3 EVENTS AND OBJECT ATTACHMENTS 137=head2 EVENTS AND OBJECT ATTACHMENTS
111 138
112=over 4 139=over 4
113 140
114=item $object->attach ($attachment, key => $value...) 141=item $object->attach ($attachment, key => $value...)
115 142
389 for (@$callbacks) { 416 for (@$callbacks) {
390 eval { &{$_->[1]} }; 417 eval { &{$_->[1]} };
391 418
392 if ($@) { 419 if ($@) {
393 warn "$@"; 420 warn "$@";
394 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 421 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
395 override; 422 override;
396 } 423 }
397 424
398 return 1 if $override; 425 return 1 if $override;
399 } 426 }
415removed in future versions), and there is no public API to access override 442removed in future versions), and there is no public API to access override
416results (if you must, access C<@cf::invoke_results> directly). 443results (if you must, access C<@cf::invoke_results> directly).
417 444
418=back 445=back
419 446
420=head2 methods valid for all pointers 447=cut
448
449#############################################################################
450
451=head2 METHODS VALID FOR ALL CORE OBJECTS
421 452
422=over 4 453=over 4
423 454
424=item $object->valid 455=item $object->valid, $player->valid, $map->valid
425
426=item $player->valid
427
428=item $map->valid
429 456
430Just because you have a perl object does not mean that the corresponding 457Just because you have a perl object does not mean that the corresponding
431C-level object still exists. If you try to access an object that has no 458C-level object still exists. If you try to access an object that has no
432valid C counterpart anymore you get an exception at runtime. This method 459valid C counterpart anymore you get an exception at runtime. This method
433can be used to test for existence of the C object part without causing an 460can be used to test for existence of the C object part without causing an
478} 505}
479 506
480sub object_freezer_save { 507sub object_freezer_save {
481 my ($filename, $rdata, $objs) = @_; 508 my ($filename, $rdata, $objs) = @_;
482 509
510 if (length $$rdata) {
511 warn sprintf "saving %s (%d,%d)\n",
512 $filename, length $$rdata, scalar @$objs;
513
483 if (open my $fh, ">:raw", "$filename~") { 514 if (open my $fh, ">:raw", "$filename~") {
484 chmod SAVE_MODE, $fh;
485 syswrite $fh, $$rdata;
486 close $fh;
487
488 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
489 chmod SAVE_MODE, $fh; 515 chmod SAVE_MODE, $fh;
490 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 516 syswrite $fh, $$rdata;
491 close $fh; 517 close $fh;
518
519 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
520 chmod SAVE_MODE, $fh;
521 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
522 close $fh;
492 rename "$filename.pst~", "$filename.pst"; 523 rename "$filename.pst~", "$filename.pst";
524 } else {
525 unlink "$filename.pst";
526 }
527
528 rename "$filename~", $filename;
493 } else { 529 } else {
494 unlink "$filename.pst"; 530 warn "FATAL: $filename~: $!\n";
495 } 531 }
496
497 rename "$filename~", $filename;
498 } else { 532 } else {
499 warn "FATAL: $filename~: $!\n"; 533 unlink $filename;
534 unlink "$filename.pst";
500 } 535 }
536}
537
538sub object_freezer_as_string {
539 my ($rdata, $objs) = @_;
540
541 use Data::Dumper;
542
543 $$rdata . Dumper $objs
501} 544}
502 545
503sub object_thawer_load { 546sub object_thawer_load {
504 my ($filename) = @_; 547 my ($filename) = @_;
505 548
549 local $/;
550
551 my $av;
552
553 #TODO: use sysread etc.
554 if (open my $data, "<:raw:perlio", $filename) {
555 $data = <$data>;
506 open my $fh, "<:raw:perlio", "$filename.pst" 556 if (open my $pst, "<:raw:perlio", "$filename.pst") {
507 or return; 557 $av = eval { (Storable::thaw <$pst>)->{objs} };
558 }
559 return ($data, $av);
560 }
508 561
509 eval { local $/; (Storable::thaw <$fh>)->{objs} } 562 ()
510} 563}
511 564
512attach_to_objects 565attach_to_objects
513 prio => -1000000, 566 prio => -1000000,
514 on_clone => sub { 567 on_clone => sub {
522 if exists $src->{_attachment}; 575 if exists $src->{_attachment};
523 }, 576 },
524; 577;
525 578
526############################################################################# 579#############################################################################
527# old plug-in events 580# command handling &c
528 581
529sub inject_event { 582=item cf::register_command $name => \&callback($ob,$args);
530 my $extension = shift;
531 my $event_code = shift;
532 583
533 my $cb = $hook[$event_code]{$extension} 584Register a callback for execution when the client sends the user command
534 or return; 585$name.
535 586
536 &$cb 587=cut
537}
538
539sub inject_global_event {
540 my $event = shift;
541
542 my $cb = $hook[$event]
543 or return;
544
545 List::Util::max map &$_, values %$cb
546}
547
548sub inject_command {
549 my ($name, $obj, $params) = @_;
550
551 for my $cmd (@{ $command{$name} }) {
552 $cmd->[1]->($obj, $params);
553 }
554
555 -1
556}
557 588
558sub register_command { 589sub register_command {
559 my ($name, $time, $cb) = @_; 590 my ($name, $cb) = @_;
560 591
561 my $caller = caller; 592 my $caller = caller;
562 #warn "registering command '$name/$time' to '$caller'"; 593 #warn "registering command '$name/$time' to '$caller'";
563 594
564 push @{ $command{$name} }, [$time, $cb, $caller]; 595 push @{ $COMMAND{$name} }, [$caller, $cb];
565 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
566} 596}
597
598=item cf::register_extcmd $name => \&callback($pl,$packet);
599
600Register a callbackf ro execution when the client sends an extcmd packet.
601
602If the callback returns something, it is sent back as if reply was being
603called.
604
605=cut
567 606
568sub register_extcmd { 607sub register_extcmd {
569 my ($name, $cb) = @_; 608 my ($name, $cb) = @_;
570 609
571 my $caller = caller; 610 my $caller = caller;
572 #warn "registering extcmd '$name' to '$caller'"; 611 #warn "registering extcmd '$name' to '$caller'";
573 612
574 $extcmd{$name} = [$cb, $caller]; 613 $EXTCMD{$name} = [$cb, $caller];
575} 614}
615
616attach_to_players
617 on_command => sub {
618 my ($pl, $name, $params) = @_;
619
620 my $cb = $COMMAND{$name}
621 or return;
622
623 for my $cmd (@$cb) {
624 $cmd->[1]->($pl->ob, $params);
625 }
626
627 cf::override;
628 },
629 on_extcmd => sub {
630 my ($pl, $buf) = @_;
631
632 my $msg = eval { from_json $buf };
633
634 if (ref $msg) {
635 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
636 if (my %reply = $cb->[0]->($pl, $msg)) {
637 $pl->ext_reply ($msg->{msgid}, %reply);
638 }
639 }
640 } else {
641 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642 }
643
644 cf::override;
645 },
646;
576 647
577sub register { 648sub register {
578 my ($base, $pkg) = @_; 649 my ($base, $pkg) = @_;
579 650
580 #TODO 651 #TODO
599 . "#line 1 \"$path\"\n{\n" 670 . "#line 1 \"$path\"\n{\n"
600 . (do { local $/; <$fh> }) 671 . (do { local $/; <$fh> })
601 . "\n};\n1"; 672 . "\n};\n1";
602 673
603 eval $source 674 eval $source
604 or die "$path: $@"; 675 or die $@ ? "$path: $@\n"
676 : "extension disabled.\n";
605 677
606 push @exts, $pkg; 678 push @exts, $pkg;
607 $ext_pkg{$base} = $pkg; 679 $ext_pkg{$base} = $pkg;
608 680
609# no strict 'refs'; 681# no strict 'refs';
622# for my $idx (0 .. $#PLUGIN_EVENT) { 694# for my $idx (0 .. $#PLUGIN_EVENT) {
623# delete $hook[$idx]{$pkg}; 695# delete $hook[$idx]{$pkg};
624# } 696# }
625 697
626 # remove commands 698 # remove commands
627 for my $name (keys %command) { 699 for my $name (keys %COMMAND) {
628 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 700 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
629 701
630 if (@cb) { 702 if (@cb) {
631 $command{$name} = \@cb; 703 $COMMAND{$name} = \@cb;
632 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
633 } else { 704 } else {
634 delete $command{$name};
635 delete $COMMAND{"$name\000"}; 705 delete $COMMAND{$name};
636 } 706 }
637 } 707 }
638 708
639 # remove extcmds 709 # remove extcmds
640 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 710 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
641 delete $extcmd{$name}; 711 delete $EXTCMD{$name};
642 } 712 }
643 713
644 if (my $cb = $pkg->can ("unload")) { 714 if (my $cb = $pkg->can ("unload")) {
645 eval { 715 eval {
646 $cb->($pkg); 716 $cb->($pkg);
650 720
651 Symbol::delete_package $pkg; 721 Symbol::delete_package $pkg;
652} 722}
653 723
654sub load_extensions { 724sub load_extensions {
655 my $LIBDIR = maps_directory "perl";
656
657 for my $ext (<$LIBDIR/*.ext>) { 725 for my $ext (<$LIBDIR/*.ext>) {
658 next unless -r $ext; 726 next unless -r $ext;
659 eval { 727 eval {
660 load_extension $ext; 728 load_extension $ext;
661 1 729 1
662 } or warn "$ext not loaded: $@"; 730 } or warn "$ext not loaded: $@";
663 } 731 }
664} 732}
665 733
666sub _perl_reload(&) {
667 my ($msg) = @_;
668
669 $msg->("reloading...");
670
671 eval {
672 # 1. cancel all watchers
673 $_->cancel for Event::all_watchers;
674
675 # 2. unload all extensions
676 for (@exts) {
677 $msg->("unloading <$_>");
678 unload_extension $_;
679 }
680
681 # 3. unload all modules loaded from $LIBDIR
682 while (my ($k, $v) = each %INC) {
683 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
684
685 $msg->("removing <$k>");
686 delete $INC{$k};
687
688 $k =~ s/\.pm$//;
689 $k =~ s/\//::/g;
690
691 if (my $cb = $k->can ("unload_module")) {
692 $cb->();
693 }
694
695 Symbol::delete_package $k;
696 }
697
698 # 4. get rid of safe::, as good as possible
699 Symbol::delete_package "safe::$_"
700 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
701
702 # 5. remove register_script_function callbacks
703 # TODO
704
705 # 6. unload cf.pm "a bit"
706 delete $INC{"cf.pm"};
707
708 # don't, removes xs symbols, too,
709 # and global variables created in xs
710 #Symbol::delete_package __PACKAGE__;
711
712 # 7. reload cf.pm
713 $msg->("reloading cf.pm");
714 require cf;
715 };
716 $msg->($@) if $@;
717
718 $msg->("reloaded");
719};
720
721sub perl_reload() {
722 _perl_reload {
723 warn $_[0];
724 print "$_[0]\n";
725 };
726}
727
728register_command "perl-reload", 0, sub {
729 my ($who, $arg) = @_;
730
731 if ($who->flag (FLAG_WIZ)) {
732 _perl_reload {
733 warn $_[0];
734 $who->message ($_[0]);
735 };
736 }
737};
738
739#############################################################################
740# extcmd framework, basically convert ext <msg>
741# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
742
743attach_to_players
744 on_extcmd => sub {
745 my ($pl, $buf) = @_;
746
747 my $msg = eval { from_json $buf };
748
749 if (ref $msg) {
750 if (my $cb = $extcmd{$msg->{msgtype}}) {
751 if (my %reply = $cb->[0]->($pl, $msg)) {
752 $pl->ext_reply ($msg->{msgid}, %reply);
753 }
754 }
755 } else {
756 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
757 }
758
759 cf::override;
760 },
761;
762
763############################################################################# 734#############################################################################
764# load/save/clean perl data associated with a map 735# load/save/clean perl data associated with a map
765 736
766*cf::mapsupport::on_clean = sub { 737*cf::mapsupport::on_clean = sub {
767 my ($map) = @_; 738 my ($map) = @_;
779 750
780sub all_objects(@) { 751sub all_objects(@) {
781 @_, map all_objects ($_->inv), @_ 752 @_, map all_objects ($_->inv), @_
782} 753}
783 754
755# TODO: compatibility cruft, remove when no longer needed
784attach_to_players 756attach_to_players
785 on_load => sub { 757 on_load => sub {
786 my ($pl, $path) = @_; 758 my ($pl, $path) = @_;
787 759
788 for my $o (all_objects $pl->ob) { 760 for my $o (all_objects $pl->ob) {
794 } 766 }
795 }, 767 },
796; 768;
797 769
798############################################################################# 770#############################################################################
799# core extensions - in perl 771
772=head2 CORE EXTENSIONS
773
774Functions and methods that extend core crossfire objects.
775
776=over 4
800 777
801=item cf::player::exists $login 778=item cf::player::exists $login
802 779
803Returns true when the given account exists. 780Returns true when the given account exists.
804 781
807sub cf::player::exists($) { 784sub cf::player::exists($) {
808 cf::player::find $_[0] 785 cf::player::find $_[0]
809 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;
810} 787}
811 788
812=item $player->reply ($npc, $msg[, $flags]) 789=item $player_object->reply ($npc, $msg[, $flags])
813 790
814Sends 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>
815can 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
816dialogue with the given NPC character. 793dialogue with the given NPC character.
817 794
844 $msg{msgid} = $id; 821 $msg{msgid} = $id;
845 822
846 $self->send ("ext " . to_json \%msg); 823 $self->send ("ext " . to_json \%msg);
847} 824}
848 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
849############################################################################# 844#############################################################################
850# 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
851 855
852our $safe = new Safe "safe"; 856our $safe = new Safe "safe";
853our $safe_hole = new Safe::Hole; 857our $safe_hole = new Safe::Hole;
854 858
855$SIG{FPE} = 'IGNORE'; 859$SIG{FPE} = 'IGNORE';
856 860
857$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));
858 862
859# 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
860 874
861for ( 875for (
862 ["cf::object" => qw(contr pay_amount pay_player)], 876 ["cf::object" => qw(contr pay_amount pay_player)],
863 ["cf::object::player" => qw(player)], 877 ["cf::object::player" => qw(player)],
864 ["cf::player" => qw(peaceful)], 878 ["cf::player" => qw(peaceful)],
867 my ($pkg, @funs) = @$_; 881 my ($pkg, @funs) = @$_;
868 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
869 for @funs; 883 for @funs;
870} 884}
871 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
872sub safe_eval($;@) { 898sub safe_eval($;@) {
873 my ($code, %vars) = @_; 899 my ($code, %vars) = @_;
874 900
875 my $qcode = $code; 901 my $qcode = $code;
876 $qcode =~ s/"/‟/g; # not allowed in #line filenames 902 $qcode =~ s/"/‟/g; # not allowed in #line filenames
898 } 924 }
899 925
900 wantarray ? @res : $res[0] 926 wantarray ? @res : $res[0]
901} 927}
902 928
929=item cf::register_script_function $function => $cb
930
931Register a function that can be called from within map/npc scripts. The
932function should be reasonably secure and should be put into a package name
933like the extension.
934
935Example: register a function that gets called whenever a map script calls
936C<rent::overview>, as used by the C<rent> extension.
937
938 cf::register_script_function "rent::overview" => sub {
939 ...
940 };
941
942=cut
943
903sub register_script_function { 944sub register_script_function {
904 my ($fun, $cb) = @_; 945 my ($fun, $cb) = @_;
905 946
906 no strict 'refs'; 947 no strict 'refs';
907 *{"safe::$fun"} = $safe_hole->wrap ($cb); 948 *{"safe::$fun"} = $safe_hole->wrap ($cb);
908} 949}
909 950
951=back
952
953=cut
954
955#############################################################################
956
957=head2 EXTENSION DATABASE SUPPORT
958
959Crossfire maintains a very simple database for extension use. It can
960currently store anything that can be serialised using Storable, which
961excludes objects.
962
963The parameter C<$family> should best start with the name of the extension
964using it, it should be unique.
965
966=over 4
967
968=item $hashref = cf::db_get $family
969
970Return a hashref for use by the extension C<$family>, which can be
971modified. After modifications, you have to call C<cf::db_dirty> or
972C<cf::db_sync>.
973
974=item $value = cf::db_get $family => $key
975
976Returns a single value from the database
977
978=item cf::db_put $family => $hashref
979
980Stores the given family hashref into the database. Updates are delayed, if
981you want the data to be synced to disk immediately, use C<cf::db_sync>.
982
983=item cf::db_put $family => $key => $value
984
985Stores the given C<$value> in the family hash. Updates are delayed, if you
986want the data to be synced to disk immediately, use C<cf::db_sync>.
987
988=item cf::db_dirty
989
990Marks the database as dirty, to be updated at a later time.
991
992=item cf::db_sync
993
994Immediately write the database to disk I<if it is dirty>.
995
996=cut
997
998our $DB;
999
1000{
1001 my $path = cf::localdir . "/database.pst";
1002
1003 sub db_load() {
1004 warn "loading database $path\n";#d# remove later
1005 $DB = stat $path ? Storable::retrieve $path : { };
1006 }
1007
1008 my $pid;
1009
1010 sub db_save() {
1011 warn "saving database $path\n";#d# remove later
1012 waitpid $pid, 0 if $pid;
1013 if (0 == ($pid = fork)) {
1014 $DB->{_meta}{version} = 1;
1015 Storable::nstore $DB, "$path~";
1016 rename "$path~", $path;
1017 cf::_exit 0 if defined $pid;
1018 }
1019 }
1020
1021 my $dirty;
1022
1023 sub db_sync() {
1024 db_save if $dirty;
1025 undef $dirty;
1026 }
1027
1028 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1029 db_sync;
1030 });
1031
1032 sub db_dirty() {
1033 $dirty = 1;
1034 $idle->start;
1035 }
1036
1037 sub db_get($;$) {
1038 @_ >= 2
1039 ? $DB->{$_[0]}{$_[1]}
1040 : ($DB->{$_[0]} ||= { })
1041 }
1042
1043 sub db_put($$;$) {
1044 if (@_ >= 3) {
1045 $DB->{$_[0]}{$_[1]} = $_[2];
1046 } else {
1047 $DB->{$_[0]} = $_[1];
1048 }
1049 db_dirty;
1050 }
1051
1052 attach_global
1053 prio => 10000,
1054 on_cleanup => sub {
1055 db_sync;
1056 },
1057 ;
1058}
1059
910############################################################################# 1060#############################################################################
911# the server's main() 1061# the server's main()
912 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
913sub main { 1071sub main {
1072 cfg_load;
1073 db_load;
1074 load_extensions;
914 Event::loop; 1075 Event::loop;
915} 1076}
916 1077
917############################################################################# 1078#############################################################################
918# initialisation 1079# initialisation
919 1080
1081sub _perl_reload(&) {
1082 my ($msg) = @_;
1083
1084 $msg->("reloading...");
1085
1086 eval {
1087 # cancel all watchers
1088 for (Event::all_watchers) {
1089 $_->cancel if $_->data & WF_AUTOCANCEL;
1090 }
1091
1092 # unload all extensions
1093 for (@exts) {
1094 $msg->("unloading <$_>");
1095 unload_extension $_;
1096 }
1097
1098 # unload all modules loaded from $LIBDIR
1099 while (my ($k, $v) = each %INC) {
1100 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101
1102 $msg->("removing <$k>");
1103 delete $INC{$k};
1104
1105 $k =~ s/\.pm$//;
1106 $k =~ s/\//::/g;
1107
1108 if (my $cb = $k->can ("unload_module")) {
1109 $cb->();
1110 }
1111
1112 Symbol::delete_package $k;
1113 }
1114
1115 # sync database to disk
1116 cf::db_sync;
1117
1118 # get rid of safe::, as good as possible
1119 Symbol::delete_package "safe::$_"
1120 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1121
1122 # remove register_script_function callbacks
1123 # TODO
1124
1125 # unload cf.pm "a bit"
1126 delete $INC{"cf.pm"};
1127
1128 # don't, removes xs symbols, too,
1129 # and global variables created in xs
1130 #Symbol::delete_package __PACKAGE__;
1131
1132 # reload cf.pm
1133 $msg->("reloading cf.pm");
1134 require cf;
1135
1136 # load config and database again
1137 cf::cfg_load;
1138 cf::db_load;
1139
1140 # load extensions
1141 $msg->("load extensions");
1142 cf::load_extensions;
1143
1144 # reattach attachments to objects
1145 $msg->("reattach");
1146 _global_reattach;
1147 };
1148 $msg->($@) if $@;
1149
1150 $msg->("reloaded");
1151};
1152
1153sub perl_reload() {
1154 _perl_reload {
1155 warn $_[0];
1156 print "$_[0]\n";
1157 };
1158}
1159
920register "<global>", __PACKAGE__; 1160register "<global>", __PACKAGE__;
921 1161
1162register_command "perl-reload" => sub {
1163 my ($who, $arg) = @_;
1164
1165 if ($who->flag (FLAG_WIZ)) {
1166 _perl_reload {
1167 warn $_[0];
1168 $who->message ($_[0]);
1169 };
1170 }
1171};
1172
922unshift @INC, $LIBDIR; 1173unshift @INC, $LIBDIR;
923 1174
924load_extensions;
925
926$TICK_WATCHER = Event->timer ( 1175$TICK_WATCHER = Event->timer (
927 prio => 1, 1176 prio => 1,
1177 async => 1,
928 at => $NEXT_TICK || 1, 1178 at => $NEXT_TICK || 1,
1179 data => WF_AUTOCANCEL,
929 cb => sub { 1180 cb => sub {
930 cf::server_tick; # one server iteration 1181 cf::server_tick; # one server iteration
931 1182
932 my $NOW = Event::time; 1183 my $NOW = Event::time;
933 $NEXT_TICK += $TICK; 1184 $NEXT_TICK += $TICK;
934 1185
935 # if we are delayed by four ticks, skip them all 1186 # if we are delayed by four ticks or more, skip them all
936 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1187 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
937 1188
938 $TICK_WATCHER->at ($NEXT_TICK); 1189 $TICK_WATCHER->at ($NEXT_TICK);
939 $TICK_WATCHER->start; 1190 $TICK_WATCHER->start;
940 }, 1191 },
941); 1192);
942 1193
943_reload_2; 1194IO::AIO::max_poll_time $TICK * 0.2;
1195
1196Event->io (fd => IO::AIO::poll_fileno,
1197 poll => 'r',
1198 prio => 5,
1199 data => WF_AUTOCANCEL,
1200 cb => \&IO::AIO::poll_cb);
944 1201
9451 12021
946 1203

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines