| … | |
… | |
| 5 | use Storable; |
5 | use Storable; |
| 6 | use Opcode; |
6 | use Opcode; |
| 7 | use Safe; |
7 | use Safe; |
| 8 | use Safe::Hole; |
8 | use Safe::Hole; |
| 9 | |
9 | |
|
|
10 | use IO::AIO (); |
|
|
11 | use YAML::Syck (); |
| 10 | use Time::HiRes; |
12 | use Time::HiRes; |
| 11 | use Event; |
13 | use 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 | |
| 14 | use strict; |
19 | use strict; |
| 15 | |
20 | |
| 16 | _reload_1; |
21 | _init_vars; |
| 17 | |
22 | |
| 18 | our %COMMAND = (); |
23 | our %COMMAND = (); |
| 19 | our @EVENT; |
24 | our @EVENT; |
| 20 | our %PROP_TYPE; |
|
|
| 21 | our %PROP_IDX; |
|
|
| 22 | our $LIBDIR = maps_directory "perl"; |
25 | our $LIBDIR = maps_directory "perl"; |
| 23 | |
26 | |
| 24 | our $TICK = MAX_TIME * 1e-6; |
27 | our $TICK = MAX_TIME * 1e-6; |
| 25 | our $TICK_WATCHER; |
28 | our $TICK_WATCHER; |
| 26 | our $NEXT_TICK; |
29 | our $NEXT_TICK; |
|
|
30 | |
|
|
31 | our %CFG; |
|
|
32 | |
|
|
33 | our $uptime; |
|
|
34 | |
|
|
35 | $uptime ||= time; |
|
|
36 | |
|
|
37 | ############################################################################# |
|
|
38 | |
|
|
39 | =head2 GLOBAL VARIABLES |
|
|
40 | |
|
|
41 | =over 4 |
|
|
42 | |
|
|
43 | =item $cf::LIBDIR |
|
|
44 | |
|
|
45 | The perl library directory, where extensions and cf-specific modules can |
|
|
46 | be found. It will be added to C<@INC> automatically. |
|
|
47 | |
|
|
48 | =item $cf::TICK |
|
|
49 | |
|
|
50 | The interval between server ticks, in seconds. |
|
|
51 | |
|
|
52 | =item %cf::CFG |
|
|
53 | |
|
|
54 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
|
|
55 | from wherever your confdir points to. |
|
|
56 | |
|
|
57 | =back |
|
|
58 | |
|
|
59 | =cut |
| 27 | |
60 | |
| 28 | BEGIN { |
61 | BEGIN { |
| 29 | *CORE::GLOBAL::warn = sub { |
62 | *CORE::GLOBAL::warn = sub { |
| 30 | my $msg = join "", @_; |
63 | my $msg = join "", @_; |
| 31 | $msg .= "\n" |
64 | $msg .= "\n" |
| … | |
… | |
| 34 | print STDERR "cfperl: $msg"; |
67 | print STDERR "cfperl: $msg"; |
| 35 | LOG llevError, "cfperl: $msg"; |
68 | LOG llevError, "cfperl: $msg"; |
| 36 | }; |
69 | }; |
| 37 | } |
70 | } |
| 38 | |
71 | |
| 39 | my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! |
|
|
| 40 | |
|
|
| 41 | # generate property mutators |
|
|
| 42 | sub 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 | |
|
|
| 66 | prop_gen OBJECT_PROP => "cf::object"; |
|
|
| 67 | # CFAPI_OBJECT_ANIMATION? |
|
|
| 68 | prop_gen PLAYER_PROP => "cf::object::player"; |
|
|
| 69 | |
|
|
| 70 | prop_gen MAP_PROP => "cf::map"; |
|
|
| 71 | prop_gen ARCH_PROP => "cf::arch"; |
|
|
| 72 | |
|
|
| 73 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
72 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
| 74 | |
73 | |
| 75 | # we bless all objects into (empty) derived classes to force a method lookup |
74 | # we bless all objects into (empty) derived classes to force a method lookup |
| 76 | # within the Safe compartment. |
75 | # within the Safe compartment. |
| 77 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
76 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
| … | |
… | |
| 87 | my @exts; |
86 | my @exts; |
| 88 | my @hook; |
87 | my @hook; |
| 89 | my %command; |
88 | my %command; |
| 90 | my %extcmd; |
89 | my %extcmd; |
| 91 | |
90 | |
| 92 | ############################################################################# |
91 | =head2 UTILITY FUNCTIONS |
| 93 | # utility functions |
92 | |
|
|
93 | =over 4 |
|
|
94 | |
|
|
95 | =cut |
| 94 | |
96 | |
| 95 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
97 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
98 | |
|
|
99 | =item $ref = cf::from_json $json |
|
|
100 | |
|
|
101 | Converts a JSON string into the corresponding perl data structure. |
|
|
102 | |
|
|
103 | =cut |
| 96 | |
104 | |
| 97 | sub from_json($) { |
105 | sub from_json($) { |
| 98 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
106 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
| 99 | JSON::Syck::Load $_[0] |
107 | JSON::Syck::Load $_[0] |
| 100 | } |
108 | } |
| 101 | |
109 | |
|
|
110 | =item $json = cf::to_json $ref |
|
|
111 | |
|
|
112 | Converts a perl data structure into its JSON representation. |
|
|
113 | |
|
|
114 | =cut |
|
|
115 | |
| 102 | sub to_json($) { |
116 | sub to_json($) { |
| 103 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
117 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
| 104 | JSON::Syck::Dump $_[0] |
118 | JSON::Syck::Dump $_[0] |
| 105 | } |
119 | } |
| 106 | |
120 | |
| 107 | ############################################################################# |
121 | =back |
| 108 | # "new" plug-in system |
|
|
| 109 | |
122 | |
|
|
123 | =cut |
|
|
124 | |
|
|
125 | ############################################################################# |
|
|
126 | |
| 110 | =head3 EVENTS AND OBJECT ATTACHMENTS |
127 | =head2 EVENTS AND OBJECT ATTACHMENTS |
| 111 | |
128 | |
| 112 | =over 4 |
129 | =over 4 |
| 113 | |
130 | |
| 114 | =item $object->attach ($attachment, key => $value...) |
131 | =item $object->attach ($attachment, key => $value...) |
| 115 | |
132 | |
| … | |
… | |
| 389 | for (@$callbacks) { |
406 | for (@$callbacks) { |
| 390 | eval { &{$_->[1]} }; |
407 | eval { &{$_->[1]} }; |
| 391 | |
408 | |
| 392 | if ($@) { |
409 | if ($@) { |
| 393 | warn "$@"; |
410 | warn "$@"; |
| 394 | warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; |
411 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
| 395 | override; |
412 | override; |
| 396 | } |
413 | } |
| 397 | |
414 | |
| 398 | return 1 if $override; |
415 | return 1 if $override; |
| 399 | } |
416 | } |
| … | |
… | |
| 415 | removed in future versions), and there is no public API to access override |
432 | removed in future versions), and there is no public API to access override |
| 416 | results (if you must, access C<@cf::invoke_results> directly). |
433 | results (if you must, access C<@cf::invoke_results> directly). |
| 417 | |
434 | |
| 418 | =back |
435 | =back |
| 419 | |
436 | |
| 420 | =head2 methods valid for all pointers |
437 | =cut |
|
|
438 | |
|
|
439 | ############################################################################# |
|
|
440 | |
|
|
441 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
| 421 | |
442 | |
| 422 | =over 4 |
443 | =over 4 |
| 423 | |
444 | |
| 424 | =item $object->valid |
445 | =item $object->valid, $player->valid, $map->valid |
| 425 | |
|
|
| 426 | =item $player->valid |
|
|
| 427 | |
|
|
| 428 | =item $map->valid |
|
|
| 429 | |
446 | |
| 430 | Just because you have a perl object does not mean that the corresponding |
447 | Just because you have a perl object does not mean that the corresponding |
| 431 | C-level object still exists. If you try to access an object that has no |
448 | C-level object still exists. If you try to access an object that has no |
| 432 | valid C counterpart anymore you get an exception at runtime. This method |
449 | valid C counterpart anymore you get an exception at runtime. This method |
| 433 | can be used to test for existence of the C object part without causing an |
450 | can be used to test for existence of the C object part without causing an |
| … | |
… | |
| 476 | } |
493 | } |
| 477 | } |
494 | } |
| 478 | } |
495 | } |
| 479 | |
496 | |
| 480 | sub object_freezer_save { |
497 | sub object_freezer_save { |
| 481 | my ($filename, $objs) = @_; |
498 | my ($filename, $rdata, $objs) = @_; |
| 482 | |
499 | |
| 483 | if (@$objs) { |
500 | if (length $$rdata) { |
|
|
501 | warn sprintf "saving %s (%d,%d)\n", |
|
|
502 | $filename, length $$rdata, scalar @$objs; |
|
|
503 | |
| 484 | open my $fh, ">:raw", "$filename.pst~"; |
504 | if (open my $fh, ">:raw", "$filename~") { |
|
|
505 | chmod SAVE_MODE, $fh; |
|
|
506 | syswrite $fh, $$rdata; |
|
|
507 | close $fh; |
|
|
508 | |
|
|
509 | if (@$objs && open my $fh, ">:raw", "$filename.pst~") { |
|
|
510 | chmod SAVE_MODE, $fh; |
| 485 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
511 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
| 486 | close $fh; |
512 | close $fh; |
| 487 | chmod SAVE_MODE, "$filename.pst~"; |
|
|
| 488 | rename "$filename.pst~", "$filename.pst"; |
513 | rename "$filename.pst~", "$filename.pst"; |
|
|
514 | } else { |
|
|
515 | unlink "$filename.pst"; |
|
|
516 | } |
|
|
517 | |
|
|
518 | rename "$filename~", $filename; |
|
|
519 | } else { |
|
|
520 | warn "FATAL: $filename~: $!\n"; |
|
|
521 | } |
| 489 | } else { |
522 | } else { |
|
|
523 | unlink $filename; |
| 490 | unlink "$filename.pst"; |
524 | unlink "$filename.pst"; |
| 491 | } |
525 | } |
| 492 | |
|
|
| 493 | chmod SAVE_MODE, "$filename~"; |
|
|
| 494 | rename "$filename~", $filename; |
|
|
| 495 | } |
526 | } |
| 496 | |
527 | |
| 497 | sub object_thawer_load { |
528 | sub object_thawer_load { |
| 498 | my ($filename) = @_; |
529 | my ($filename) = @_; |
| 499 | |
530 | |
|
|
531 | local $/; |
|
|
532 | |
|
|
533 | my $av; |
|
|
534 | |
|
|
535 | #TODO: use sysread etc. |
|
|
536 | if (open my $data, "<:raw:perlio", $filename) { |
|
|
537 | $data = <$data>; |
| 500 | open my $fh, "<:raw:perlio", "$filename.pst" |
538 | if (open my $pst, "<:raw:perlio", "$filename.pst") { |
| 501 | or return; |
539 | $av = eval { (Storable::thaw <$pst>)->{objs} }; |
|
|
540 | } |
|
|
541 | return ($data, $av); |
|
|
542 | } |
| 502 | |
543 | |
| 503 | eval { local $/; (Storable::thaw <$fh>)->{objs} } |
544 | () |
| 504 | } |
545 | } |
| 505 | |
546 | |
| 506 | attach_to_objects |
547 | attach_to_objects |
| 507 | prio => -1000000, |
548 | prio => -1000000, |
| 508 | on_clone => sub { |
549 | on_clone => sub { |
| … | |
… | |
| 654 | load_extension $ext; |
695 | load_extension $ext; |
| 655 | 1 |
696 | 1 |
| 656 | } or warn "$ext not loaded: $@"; |
697 | } or warn "$ext not loaded: $@"; |
| 657 | } |
698 | } |
| 658 | } |
699 | } |
| 659 | |
|
|
| 660 | sub _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 | |
|
|
| 715 | sub perl_reload() { |
|
|
| 716 | _perl_reload { |
|
|
| 717 | warn $_[0]; |
|
|
| 718 | print "$_[0]\n"; |
|
|
| 719 | }; |
|
|
| 720 | } |
|
|
| 721 | |
|
|
| 722 | register_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 | |
700 | |
| 733 | ############################################################################# |
701 | ############################################################################# |
| 734 | # extcmd framework, basically convert ext <msg> |
702 | # extcmd framework, basically convert ext <msg> |
| 735 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
703 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
| 736 | |
704 | |
| … | |
… | |
| 764 | defined $path or return; |
732 | defined $path or return; |
| 765 | |
733 | |
| 766 | unlink "$path.pst"; |
734 | unlink "$path.pst"; |
| 767 | }; |
735 | }; |
| 768 | |
736 | |
| 769 | # old style persistent data, TODO: remove #d# |
|
|
| 770 | *cf::mapsupport::on_swapin = |
|
|
| 771 | *cf::mapsupport::on_load = sub { |
|
|
| 772 | my ($map) = @_; |
|
|
| 773 | |
|
|
| 774 | my $path = $map->tmpname; |
|
|
| 775 | $path = $map->path unless defined $path; |
|
|
| 776 | |
|
|
| 777 | open my $fh, "<:raw", "$path.cfperl" |
|
|
| 778 | or return; # no perl data |
|
|
| 779 | |
|
|
| 780 | my $data = Storable::thaw do { local $/; <$fh> }; |
|
|
| 781 | |
|
|
| 782 | $data->{version} <= 1 |
|
|
| 783 | or return; # too new |
|
|
| 784 | |
|
|
| 785 | $map->_set_obs ($data->{obs}); |
|
|
| 786 | $map->invoke (EVENT_MAP_UPGRADE); |
|
|
| 787 | }; |
|
|
| 788 | |
|
|
| 789 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
737 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
| 790 | |
738 | |
| 791 | ############################################################################# |
739 | ############################################################################# |
| 792 | # load/save perl data associated with player->ob objects |
740 | # load/save perl data associated with player->ob objects |
| 793 | |
741 | |
| 794 | sub all_objects(@) { |
742 | sub all_objects(@) { |
| 795 | @_, map all_objects ($_->inv), @_ |
743 | @_, map all_objects ($_->inv), @_ |
| 796 | } |
744 | } |
| 797 | |
745 | |
|
|
746 | # TODO: compatibility cruft, remove when no longer needed |
| 798 | attach_to_players |
747 | attach_to_players |
| 799 | on_load => sub { |
748 | on_load => sub { |
| 800 | my ($pl, $path) = @_; |
749 | my ($pl, $path) = @_; |
| 801 | |
750 | |
| 802 | for my $o (all_objects $pl->ob) { |
751 | for my $o (all_objects $pl->ob) { |
| … | |
… | |
| 808 | } |
757 | } |
| 809 | }, |
758 | }, |
| 810 | ; |
759 | ; |
| 811 | |
760 | |
| 812 | ############################################################################# |
761 | ############################################################################# |
| 813 | # core extensions - in perl |
762 | |
|
|
763 | =head2 CORE EXTENSIONS |
|
|
764 | |
|
|
765 | Functions and methods that extend core crossfire objects. |
|
|
766 | |
|
|
767 | =over 4 |
| 814 | |
768 | |
| 815 | =item cf::player::exists $login |
769 | =item cf::player::exists $login |
| 816 | |
770 | |
| 817 | Returns true when the given account exists. |
771 | Returns true when the given account exists. |
| 818 | |
772 | |
| … | |
… | |
| 821 | sub cf::player::exists($) { |
775 | sub cf::player::exists($) { |
| 822 | cf::player::find $_[0] |
776 | cf::player::find $_[0] |
| 823 | 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; |
| 824 | } |
778 | } |
| 825 | |
779 | |
| 826 | =item $player->reply ($npc, $msg[, $flags]) |
780 | =item $object->reply ($npc, $msg[, $flags]) |
| 827 | |
781 | |
| 828 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
782 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
| 829 | can be C<undef>. Does the right thing when the player is currently in a |
783 | can be C<undef>. Does the right thing when the player is currently in a |
| 830 | dialogue with the given NPC character. |
784 | dialogue with the given NPC character. |
| 831 | |
785 | |
| … | |
… | |
| 858 | $msg{msgid} = $id; |
812 | $msg{msgid} = $id; |
| 859 | |
813 | |
| 860 | $self->send ("ext " . to_json \%msg); |
814 | $self->send ("ext " . to_json \%msg); |
| 861 | } |
815 | } |
| 862 | |
816 | |
|
|
817 | =back |
|
|
818 | |
|
|
819 | =cut |
|
|
820 | |
| 863 | ############################################################################# |
821 | ############################################################################# |
| 864 | # map scripting support |
822 | |
|
|
823 | =head2 SAFE SCRIPTING |
|
|
824 | |
|
|
825 | Functions that provide a safe environment to compile and execute |
|
|
826 | snippets of perl code without them endangering the safety of the server |
|
|
827 | itself. Looping constructs, I/O operators and other built-in functionality |
|
|
828 | is not available in the safe scripting environment, and the number of |
|
|
829 | functions and methods that cna be called is greatly reduced. |
|
|
830 | |
|
|
831 | =cut |
| 865 | |
832 | |
| 866 | our $safe = new Safe "safe"; |
833 | our $safe = new Safe "safe"; |
| 867 | our $safe_hole = new Safe::Hole; |
834 | our $safe_hole = new Safe::Hole; |
| 868 | |
835 | |
| 869 | $SIG{FPE} = 'IGNORE'; |
836 | $SIG{FPE} = 'IGNORE'; |
| 870 | |
837 | |
| 871 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
838 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
| 872 | |
839 | |
| 873 | # here we export the classes and methods available to script code |
840 | # here we export the classes and methods available to script code |
|
|
841 | |
|
|
842 | =pod |
|
|
843 | |
|
|
844 | The following fucntions and emthods are available within a safe environment: |
|
|
845 | |
|
|
846 | cf::object contr pay_amount pay_player |
|
|
847 | cf::object::player player |
|
|
848 | cf::player peaceful |
|
|
849 | |
|
|
850 | =cut |
| 874 | |
851 | |
| 875 | for ( |
852 | for ( |
| 876 | ["cf::object" => qw(contr pay_amount pay_player)], |
853 | ["cf::object" => qw(contr pay_amount pay_player)], |
| 877 | ["cf::object::player" => qw(player)], |
854 | ["cf::object::player" => qw(player)], |
| 878 | ["cf::player" => qw(peaceful)], |
855 | ["cf::player" => qw(peaceful)], |
| … | |
… | |
| 881 | my ($pkg, @funs) = @$_; |
858 | my ($pkg, @funs) = @$_; |
| 882 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
859 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
| 883 | for @funs; |
860 | for @funs; |
| 884 | } |
861 | } |
| 885 | |
862 | |
|
|
863 | =over 4 |
|
|
864 | |
|
|
865 | =item @retval = safe_eval $code, [var => value, ...] |
|
|
866 | |
|
|
867 | Compiled and executes the given perl code snippet. additional var/value |
|
|
868 | pairs result in temporary local (my) scalar variables of the given name |
|
|
869 | that are available in the code snippet. Example: |
|
|
870 | |
|
|
871 | my $five = safe_eval '$first + $second', first => 1, second => 4; |
|
|
872 | |
|
|
873 | =cut |
|
|
874 | |
| 886 | sub safe_eval($;@) { |
875 | sub safe_eval($;@) { |
| 887 | my ($code, %vars) = @_; |
876 | my ($code, %vars) = @_; |
| 888 | |
877 | |
| 889 | my $qcode = $code; |
878 | my $qcode = $code; |
| 890 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
879 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
| … | |
… | |
| 912 | } |
901 | } |
| 913 | |
902 | |
| 914 | wantarray ? @res : $res[0] |
903 | wantarray ? @res : $res[0] |
| 915 | } |
904 | } |
| 916 | |
905 | |
|
|
906 | =item cf::register_script_function $function => $cb |
|
|
907 | |
|
|
908 | Register a function that can be called from within map/npc scripts. The |
|
|
909 | function should be reasonably secure and should be put into a package name |
|
|
910 | like the extension. |
|
|
911 | |
|
|
912 | Example: register a function that gets called whenever a map script calls |
|
|
913 | C<rent::overview>, as used by the C<rent> extension. |
|
|
914 | |
|
|
915 | cf::register_script_function "rent::overview" => sub { |
|
|
916 | ... |
|
|
917 | }; |
|
|
918 | |
|
|
919 | =cut |
|
|
920 | |
| 917 | sub register_script_function { |
921 | sub register_script_function { |
| 918 | my ($fun, $cb) = @_; |
922 | my ($fun, $cb) = @_; |
| 919 | |
923 | |
| 920 | no strict 'refs'; |
924 | no strict 'refs'; |
| 921 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
925 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
| 922 | } |
926 | } |
| 923 | |
927 | |
|
|
928 | =back |
|
|
929 | |
|
|
930 | =cut |
|
|
931 | |
|
|
932 | ############################################################################# |
|
|
933 | |
|
|
934 | =head2 EXTENSION DATABASE SUPPORT |
|
|
935 | |
|
|
936 | Crossfire maintains a very simple database for extension use. It can |
|
|
937 | currently store anything that can be serialised using Storable, which |
|
|
938 | excludes objects. |
|
|
939 | |
|
|
940 | The parameter C<$family> should best start with the name of the extension |
|
|
941 | using it, it should be unique. |
|
|
942 | |
|
|
943 | =over 4 |
|
|
944 | |
|
|
945 | =item $hashref = cf::db_get $family |
|
|
946 | |
|
|
947 | Return a hashref for use by the extension C<$family>, which can be |
|
|
948 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
949 | C<cf::db_sync>. |
|
|
950 | |
|
|
951 | =item $value = cf::db_get $family => $key |
|
|
952 | |
|
|
953 | Returns a single value from the database |
|
|
954 | |
|
|
955 | =item cf::db_put $family => $hashref |
|
|
956 | |
|
|
957 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
958 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
959 | |
|
|
960 | =item cf::db_put $family => $key => $value |
|
|
961 | |
|
|
962 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
|
|
963 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
964 | |
|
|
965 | =item cf::db_dirty |
|
|
966 | |
|
|
967 | Marks the database as dirty, to be updated at a later time. |
|
|
968 | |
|
|
969 | =item cf::db_sync |
|
|
970 | |
|
|
971 | Immediately write the database to disk I<if it is dirty>. |
|
|
972 | |
|
|
973 | =cut |
|
|
974 | |
|
|
975 | { |
|
|
976 | my $db; |
|
|
977 | my $path = cf::localdir . "/database.pst"; |
|
|
978 | |
|
|
979 | sub db_load() { |
|
|
980 | warn "loading database $path\n";#d# remove later |
|
|
981 | $db = stat $path ? Storable::retrieve $path : { }; |
|
|
982 | } |
|
|
983 | |
|
|
984 | my $pid; |
|
|
985 | |
|
|
986 | sub db_save() { |
|
|
987 | warn "saving database $path\n";#d# remove later |
|
|
988 | waitpid $pid, 0 if $pid; |
|
|
989 | if (0 == ($pid = fork)) { |
|
|
990 | $db->{_meta}{version} = 1; |
|
|
991 | Storable::nstore $db, "$path~"; |
|
|
992 | rename "$path~", $path; |
|
|
993 | cf::_exit 0 if defined $pid; |
|
|
994 | } |
|
|
995 | } |
|
|
996 | |
|
|
997 | my $dirty; |
|
|
998 | |
|
|
999 | sub db_sync() { |
|
|
1000 | db_save if $dirty; |
|
|
1001 | undef $dirty; |
|
|
1002 | } |
|
|
1003 | |
|
|
1004 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { |
|
|
1005 | db_sync; |
|
|
1006 | }); |
|
|
1007 | |
|
|
1008 | sub db_dirty() { |
|
|
1009 | $dirty = 1; |
|
|
1010 | $idle->start; |
|
|
1011 | } |
|
|
1012 | |
|
|
1013 | sub db_get($;$) { |
|
|
1014 | @_ >= 2 |
|
|
1015 | ? $db->{$_[0]}{$_[1]} |
|
|
1016 | : ($db->{$_[0]} ||= { }) |
|
|
1017 | } |
|
|
1018 | |
|
|
1019 | sub db_put($$;$) { |
|
|
1020 | if (@_ >= 3) { |
|
|
1021 | $db->{$_[0]}{$_[1]} = $_[2]; |
|
|
1022 | } else { |
|
|
1023 | $db->{$_[0]} = $_[1]; |
|
|
1024 | } |
|
|
1025 | db_dirty; |
|
|
1026 | } |
|
|
1027 | |
|
|
1028 | attach_global |
|
|
1029 | prio => 10000, |
|
|
1030 | on_cleanup => sub { |
|
|
1031 | db_sync; |
|
|
1032 | }, |
|
|
1033 | ; |
|
|
1034 | } |
|
|
1035 | |
| 924 | ############################################################################# |
1036 | ############################################################################# |
| 925 | # the server's main() |
1037 | # the server's main() |
| 926 | |
1038 | |
|
|
1039 | sub cfg_load { |
|
|
1040 | open my $fh, "<:utf8", cf::confdir . "/config" |
|
|
1041 | or return; |
|
|
1042 | |
|
|
1043 | local $/; |
|
|
1044 | *CFG = YAML::Syck::Load <$fh>; |
|
|
1045 | } |
|
|
1046 | |
| 927 | sub main { |
1047 | sub main { |
|
|
1048 | cfg_load; |
|
|
1049 | db_load; |
|
|
1050 | load_extensions; |
| 928 | Event::loop; |
1051 | Event::loop; |
| 929 | } |
1052 | } |
| 930 | |
1053 | |
| 931 | ############################################################################# |
1054 | ############################################################################# |
| 932 | # initialisation |
1055 | # initialisation |
| 933 | |
1056 | |
|
|
1057 | sub _perl_reload(&) { |
|
|
1058 | my ($msg) = @_; |
|
|
1059 | |
|
|
1060 | $msg->("reloading..."); |
|
|
1061 | |
|
|
1062 | eval { |
|
|
1063 | # cancel all watchers |
|
|
1064 | $_->cancel for Event::all_watchers; |
|
|
1065 | |
|
|
1066 | # unload all extensions |
|
|
1067 | for (@exts) { |
|
|
1068 | $msg->("unloading <$_>"); |
|
|
1069 | unload_extension $_; |
|
|
1070 | } |
|
|
1071 | |
|
|
1072 | # unload all modules loaded from $LIBDIR |
|
|
1073 | while (my ($k, $v) = each %INC) { |
|
|
1074 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
1075 | |
|
|
1076 | $msg->("removing <$k>"); |
|
|
1077 | delete $INC{$k}; |
|
|
1078 | |
|
|
1079 | $k =~ s/\.pm$//; |
|
|
1080 | $k =~ s/\//::/g; |
|
|
1081 | |
|
|
1082 | if (my $cb = $k->can ("unload_module")) { |
|
|
1083 | $cb->(); |
|
|
1084 | } |
|
|
1085 | |
|
|
1086 | Symbol::delete_package $k; |
|
|
1087 | } |
|
|
1088 | |
|
|
1089 | # sync database to disk |
|
|
1090 | cf::db_sync; |
|
|
1091 | |
|
|
1092 | # get rid of safe::, as good as possible |
|
|
1093 | Symbol::delete_package "safe::$_" |
|
|
1094 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
1095 | |
|
|
1096 | # remove register_script_function callbacks |
|
|
1097 | # TODO |
|
|
1098 | |
|
|
1099 | # unload cf.pm "a bit" |
|
|
1100 | delete $INC{"cf.pm"}; |
|
|
1101 | |
|
|
1102 | # don't, removes xs symbols, too, |
|
|
1103 | # and global variables created in xs |
|
|
1104 | #Symbol::delete_package __PACKAGE__; |
|
|
1105 | |
|
|
1106 | # reload cf.pm |
|
|
1107 | $msg->("reloading cf.pm"); |
|
|
1108 | require cf; |
|
|
1109 | |
|
|
1110 | # load config and database again |
|
|
1111 | cf::cfg_load; |
|
|
1112 | cf::db_load; |
|
|
1113 | |
|
|
1114 | # load extensions |
|
|
1115 | $msg->("load extensions"); |
|
|
1116 | cf::load_extensions; |
|
|
1117 | |
|
|
1118 | # reattach attachments to objects |
|
|
1119 | $msg->("reattach"); |
|
|
1120 | _global_reattach; |
|
|
1121 | }; |
|
|
1122 | $msg->($@) if $@; |
|
|
1123 | |
|
|
1124 | $msg->("reloaded"); |
|
|
1125 | }; |
|
|
1126 | |
|
|
1127 | sub perl_reload() { |
|
|
1128 | _perl_reload { |
|
|
1129 | warn $_[0]; |
|
|
1130 | print "$_[0]\n"; |
|
|
1131 | }; |
|
|
1132 | } |
|
|
1133 | |
|
|
1134 | register_command "perl-reload", 0, sub { |
|
|
1135 | my ($who, $arg) = @_; |
|
|
1136 | |
|
|
1137 | if ($who->flag (FLAG_WIZ)) { |
|
|
1138 | _perl_reload { |
|
|
1139 | warn $_[0]; |
|
|
1140 | $who->message ($_[0]); |
|
|
1141 | }; |
|
|
1142 | } |
|
|
1143 | }; |
|
|
1144 | |
| 934 | register "<global>", __PACKAGE__; |
1145 | register "<global>", __PACKAGE__; |
| 935 | |
1146 | |
| 936 | unshift @INC, $LIBDIR; |
1147 | unshift @INC, $LIBDIR; |
| 937 | |
1148 | |
| 938 | load_extensions; |
|
|
| 939 | |
|
|
| 940 | $TICK_WATCHER = Event->timer ( |
1149 | $TICK_WATCHER = Event->timer ( |
| 941 | prio => 1, |
1150 | prio => 1, |
|
|
1151 | async => 1, |
| 942 | at => $NEXT_TICK || 1, |
1152 | at => $NEXT_TICK || 1, |
| 943 | cb => sub { |
1153 | cb => sub { |
| 944 | cf::server_tick; # one server iteration |
1154 | cf::server_tick; # one server iteration |
| 945 | |
1155 | |
| 946 | my $NOW = Event::time; |
1156 | my $NOW = Event::time; |
| 947 | $NEXT_TICK += $TICK; |
1157 | $NEXT_TICK += $TICK; |
| 948 | |
1158 | |
| … | |
… | |
| 952 | $TICK_WATCHER->at ($NEXT_TICK); |
1162 | $TICK_WATCHER->at ($NEXT_TICK); |
| 953 | $TICK_WATCHER->start; |
1163 | $TICK_WATCHER->start; |
| 954 | }, |
1164 | }, |
| 955 | ); |
1165 | ); |
| 956 | |
1166 | |
| 957 | _reload_2; |
1167 | IO::AIO::max_poll_time $TICK * 0.2; |
|
|
1168 | |
|
|
1169 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1170 | poll => 'r', |
|
|
1171 | prio => 5, |
|
|
1172 | cb => \&IO::AIO::poll_cb); |
| 958 | |
1173 | |
| 959 | 1 |
1174 | 1 |
| 960 | |
1175 | |
