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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines