| … | |
… | |
| 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; |
|
|
| 17 | |
|
|
| 18 | our %COMMAND = (); |
21 | our %COMMAND = (); |
|
|
22 | our %COMMAND_TIME = (); |
|
|
23 | our %EXTCMD = (); |
|
|
24 | |
|
|
25 | _init_vars; |
|
|
26 | |
| 19 | our @EVENT; |
27 | our @EVENT; |
| 20 | our $LIBDIR = maps_directory "perl"; |
28 | our $LIBDIR = maps_directory "perl"; |
| 21 | |
29 | |
| 22 | our $TICK = MAX_TIME * 1e-6; |
30 | our $TICK = MAX_TIME * 1e-6; |
| 23 | our $TICK_WATCHER; |
31 | our $TICK_WATCHER; |
| 24 | our $NEXT_TICK; |
32 | our $NEXT_TICK; |
|
|
33 | |
|
|
34 | our %CFG; |
|
|
35 | |
|
|
36 | our $UPTIME; $UPTIME ||= time; |
|
|
37 | |
|
|
38 | ############################################################################# |
|
|
39 | |
|
|
40 | =head2 GLOBAL VARIABLES |
|
|
41 | |
|
|
42 | =over 4 |
|
|
43 | |
|
|
44 | =item $cf::UPTIME |
|
|
45 | |
|
|
46 | The timestamp of the server start (so not actually an uptime). |
|
|
47 | |
|
|
48 | =item $cf::LIBDIR |
|
|
49 | |
|
|
50 | The perl library directory, where extensions and cf-specific modules can |
|
|
51 | be found. It will be added to C<@INC> automatically. |
|
|
52 | |
|
|
53 | =item $cf::TICK |
|
|
54 | |
|
|
55 | The interval between server ticks, in seconds. |
|
|
56 | |
|
|
57 | =item %cf::CFG |
|
|
58 | |
|
|
59 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
|
|
60 | from wherever your confdir points to. |
|
|
61 | |
|
|
62 | =back |
|
|
63 | |
|
|
64 | =cut |
| 25 | |
65 | |
| 26 | BEGIN { |
66 | BEGIN { |
| 27 | *CORE::GLOBAL::warn = sub { |
67 | *CORE::GLOBAL::warn = sub { |
| 28 | my $msg = join "", @_; |
68 | my $msg = join "", @_; |
| 29 | $msg .= "\n" |
69 | $msg .= "\n" |
| … | |
… | |
| 48 | }; |
88 | }; |
| 49 | |
89 | |
| 50 | my %ext_pkg; |
90 | my %ext_pkg; |
| 51 | my @exts; |
91 | my @exts; |
| 52 | my @hook; |
92 | my @hook; |
| 53 | my %command; |
|
|
| 54 | my %extcmd; |
|
|
| 55 | |
93 | |
| 56 | ############################################################################# |
94 | =head2 UTILITY FUNCTIONS |
| 57 | # utility functions |
95 | |
|
|
96 | =over 4 |
|
|
97 | |
|
|
98 | =cut |
| 58 | |
99 | |
| 59 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
100 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
101 | |
|
|
102 | =item $ref = cf::from_json $json |
|
|
103 | |
|
|
104 | Converts a JSON string into the corresponding perl data structure. |
|
|
105 | |
|
|
106 | =cut |
| 60 | |
107 | |
| 61 | sub from_json($) { |
108 | sub from_json($) { |
| 62 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
109 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
| 63 | JSON::Syck::Load $_[0] |
110 | JSON::Syck::Load $_[0] |
| 64 | } |
111 | } |
| 65 | |
112 | |
|
|
113 | =item $json = cf::to_json $ref |
|
|
114 | |
|
|
115 | Converts a perl data structure into its JSON representation. |
|
|
116 | |
|
|
117 | =cut |
|
|
118 | |
| 66 | sub to_json($) { |
119 | sub to_json($) { |
| 67 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
120 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
| 68 | JSON::Syck::Dump $_[0] |
121 | JSON::Syck::Dump $_[0] |
| 69 | } |
122 | } |
| 70 | |
123 | |
|
|
124 | =back |
|
|
125 | |
|
|
126 | =cut |
|
|
127 | |
| 71 | ############################################################################# |
128 | ############################################################################# |
| 72 | # "new" plug-in system |
|
|
| 73 | |
129 | |
| 74 | =head3 EVENTS AND OBJECT ATTACHMENTS |
130 | =head2 EVENTS AND OBJECT ATTACHMENTS |
| 75 | |
131 | |
| 76 | =over 4 |
132 | =over 4 |
| 77 | |
133 | |
| 78 | =item $object->attach ($attachment, key => $value...) |
134 | =item $object->attach ($attachment, key => $value...) |
| 79 | |
135 | |
| … | |
… | |
| 353 | for (@$callbacks) { |
409 | for (@$callbacks) { |
| 354 | eval { &{$_->[1]} }; |
410 | eval { &{$_->[1]} }; |
| 355 | |
411 | |
| 356 | if ($@) { |
412 | if ($@) { |
| 357 | warn "$@"; |
413 | warn "$@"; |
| 358 | warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; |
414 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
| 359 | override; |
415 | override; |
| 360 | } |
416 | } |
| 361 | |
417 | |
| 362 | return 1 if $override; |
418 | return 1 if $override; |
| 363 | } |
419 | } |
| … | |
… | |
| 379 | removed in future versions), and there is no public API to access override |
435 | removed in future versions), and there is no public API to access override |
| 380 | results (if you must, access C<@cf::invoke_results> directly). |
436 | results (if you must, access C<@cf::invoke_results> directly). |
| 381 | |
437 | |
| 382 | =back |
438 | =back |
| 383 | |
439 | |
| 384 | =head2 methods valid for all pointers |
440 | =cut |
|
|
441 | |
|
|
442 | ############################################################################# |
|
|
443 | |
|
|
444 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
| 385 | |
445 | |
| 386 | =over 4 |
446 | =over 4 |
| 387 | |
447 | |
| 388 | =item $object->valid |
448 | =item $object->valid, $player->valid, $map->valid |
| 389 | |
|
|
| 390 | =item $player->valid |
|
|
| 391 | |
|
|
| 392 | =item $map->valid |
|
|
| 393 | |
449 | |
| 394 | Just because you have a perl object does not mean that the corresponding |
450 | Just because you have a perl object does not mean that the corresponding |
| 395 | C-level object still exists. If you try to access an object that has no |
451 | C-level object still exists. If you try to access an object that has no |
| 396 | valid C counterpart anymore you get an exception at runtime. This method |
452 | valid C counterpart anymore you get an exception at runtime. This method |
| 397 | can be used to test for existence of the C object part without causing an |
453 | can be used to test for existence of the C object part without causing an |
| … | |
… | |
| 470 | unlink $filename; |
526 | unlink $filename; |
| 471 | unlink "$filename.pst"; |
527 | unlink "$filename.pst"; |
| 472 | } |
528 | } |
| 473 | } |
529 | } |
| 474 | |
530 | |
|
|
531 | sub object_freezer_as_string { |
|
|
532 | my ($rdata, $objs) = @_; |
|
|
533 | |
|
|
534 | use Data::Dumper; |
|
|
535 | |
|
|
536 | $$rdata . Dumper $objs |
|
|
537 | } |
|
|
538 | |
| 475 | sub object_thawer_load { |
539 | sub object_thawer_load { |
| 476 | my ($filename) = @_; |
540 | my ($filename) = @_; |
| 477 | |
541 | |
| 478 | local $/; |
542 | local $/; |
| 479 | |
543 | |
| … | |
… | |
| 504 | if exists $src->{_attachment}; |
568 | if exists $src->{_attachment}; |
| 505 | }, |
569 | }, |
| 506 | ; |
570 | ; |
| 507 | |
571 | |
| 508 | ############################################################################# |
572 | ############################################################################# |
| 509 | # old plug-in events |
573 | # command handling &c |
| 510 | |
574 | |
| 511 | sub inject_event { |
575 | =item cf::register_command $name => \&callback($ob,$args); |
| 512 | my $extension = shift; |
|
|
| 513 | my $event_code = shift; |
|
|
| 514 | |
576 | |
| 515 | my $cb = $hook[$event_code]{$extension} |
577 | Register a callback for execution when the client sends the user command |
| 516 | or return; |
578 | $name. |
| 517 | |
579 | |
| 518 | &$cb |
580 | =cut |
| 519 | } |
|
|
| 520 | |
|
|
| 521 | sub 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 | |
|
|
| 530 | sub 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 | |
581 | |
| 540 | sub register_command { |
582 | sub register_command { |
| 541 | my ($name, $time, $cb) = @_; |
583 | my ($name, $cb) = @_; |
| 542 | |
584 | |
| 543 | my $caller = caller; |
585 | my $caller = caller; |
| 544 | #warn "registering command '$name/$time' to '$caller'"; |
586 | #warn "registering command '$name/$time' to '$caller'"; |
| 545 | |
587 | |
| 546 | push @{ $command{$name} }, [$time, $cb, $caller]; |
588 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
| 547 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
| 548 | } |
589 | } |
|
|
590 | |
|
|
591 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
592 | |
|
|
593 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
594 | |
|
|
595 | If the callback returns something, it is sent back as if reply was being |
|
|
596 | called. |
|
|
597 | |
|
|
598 | =cut |
| 549 | |
599 | |
| 550 | sub register_extcmd { |
600 | sub register_extcmd { |
| 551 | my ($name, $cb) = @_; |
601 | my ($name, $cb) = @_; |
| 552 | |
602 | |
| 553 | my $caller = caller; |
603 | my $caller = caller; |
| 554 | #warn "registering extcmd '$name' to '$caller'"; |
604 | #warn "registering extcmd '$name' to '$caller'"; |
| 555 | |
605 | |
| 556 | $extcmd{$name} = [$cb, $caller]; |
606 | $EXTCMD{$name} = [$cb, $caller]; |
| 557 | } |
607 | } |
|
|
608 | |
|
|
609 | attach_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 | ; |
| 558 | |
640 | |
| 559 | sub register { |
641 | sub register { |
| 560 | my ($base, $pkg) = @_; |
642 | my ($base, $pkg) = @_; |
| 561 | |
643 | |
| 562 | #TODO |
644 | #TODO |
| … | |
… | |
| 581 | . "#line 1 \"$path\"\n{\n" |
663 | . "#line 1 \"$path\"\n{\n" |
| 582 | . (do { local $/; <$fh> }) |
664 | . (do { local $/; <$fh> }) |
| 583 | . "\n};\n1"; |
665 | . "\n};\n1"; |
| 584 | |
666 | |
| 585 | eval $source |
667 | eval $source |
| 586 | or die "$path: $@"; |
668 | or die $@ ? "$path: $@\n" |
|
|
669 | : "extension disabled.\n"; |
| 587 | |
670 | |
| 588 | push @exts, $pkg; |
671 | push @exts, $pkg; |
| 589 | $ext_pkg{$base} = $pkg; |
672 | $ext_pkg{$base} = $pkg; |
| 590 | |
673 | |
| 591 | # no strict 'refs'; |
674 | # no strict 'refs'; |
| … | |
… | |
| 604 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
687 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
| 605 | # delete $hook[$idx]{$pkg}; |
688 | # delete $hook[$idx]{$pkg}; |
| 606 | # } |
689 | # } |
| 607 | |
690 | |
| 608 | # remove commands |
691 | # remove commands |
| 609 | for my $name (keys %command) { |
692 | for my $name (keys %COMMAND) { |
| 610 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
693 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
| 611 | |
694 | |
| 612 | if (@cb) { |
695 | if (@cb) { |
| 613 | $command{$name} = \@cb; |
696 | $COMMAND{$name} = \@cb; |
| 614 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
| 615 | } else { |
697 | } else { |
| 616 | delete $command{$name}; |
|
|
| 617 | delete $COMMAND{"$name\000"}; |
698 | delete $COMMAND{$name}; |
| 618 | } |
699 | } |
| 619 | } |
700 | } |
| 620 | |
701 | |
| 621 | # remove extcmds |
702 | # remove extcmds |
| 622 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
703 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
| 623 | delete $extcmd{$name}; |
704 | delete $EXTCMD{$name}; |
| 624 | } |
705 | } |
| 625 | |
706 | |
| 626 | if (my $cb = $pkg->can ("unload")) { |
707 | if (my $cb = $pkg->can ("unload")) { |
| 627 | eval { |
708 | eval { |
| 628 | $cb->($pkg); |
709 | $cb->($pkg); |
| … | |
… | |
| 643 | 1 |
724 | 1 |
| 644 | } or warn "$ext not loaded: $@"; |
725 | } or warn "$ext not loaded: $@"; |
| 645 | } |
726 | } |
| 646 | } |
727 | } |
| 647 | |
728 | |
| 648 | sub _perl_reload(&) { |
|
|
| 649 | my ($msg) = @_; |
|
|
| 650 | |
|
|
| 651 | $msg->("reloading..."); |
|
|
| 652 | |
|
|
| 653 | eval { |
|
|
| 654 | # 1. cancel all watchers |
|
|
| 655 | $_->cancel for Event::all_watchers; |
|
|
| 656 | |
|
|
| 657 | # 2. unload all extensions |
|
|
| 658 | for (@exts) { |
|
|
| 659 | $msg->("unloading <$_>"); |
|
|
| 660 | unload_extension $_; |
|
|
| 661 | } |
|
|
| 662 | |
|
|
| 663 | # 3. unload all modules loaded from $LIBDIR |
|
|
| 664 | while (my ($k, $v) = each %INC) { |
|
|
| 665 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
| 666 | |
|
|
| 667 | $msg->("removing <$k>"); |
|
|
| 668 | delete $INC{$k}; |
|
|
| 669 | |
|
|
| 670 | $k =~ s/\.pm$//; |
|
|
| 671 | $k =~ s/\//::/g; |
|
|
| 672 | |
|
|
| 673 | if (my $cb = $k->can ("unload_module")) { |
|
|
| 674 | $cb->(); |
|
|
| 675 | } |
|
|
| 676 | |
|
|
| 677 | Symbol::delete_package $k; |
|
|
| 678 | } |
|
|
| 679 | |
|
|
| 680 | # 4. get rid of safe::, as good as possible |
|
|
| 681 | Symbol::delete_package "safe::$_" |
|
|
| 682 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
| 683 | |
|
|
| 684 | # 5. remove register_script_function callbacks |
|
|
| 685 | # TODO |
|
|
| 686 | |
|
|
| 687 | # 6. unload cf.pm "a bit" |
|
|
| 688 | delete $INC{"cf.pm"}; |
|
|
| 689 | |
|
|
| 690 | # don't, removes xs symbols, too, |
|
|
| 691 | # and global variables created in xs |
|
|
| 692 | #Symbol::delete_package __PACKAGE__; |
|
|
| 693 | |
|
|
| 694 | # 7. reload cf.pm |
|
|
| 695 | $msg->("reloading cf.pm"); |
|
|
| 696 | require cf; |
|
|
| 697 | |
|
|
| 698 | $msg->("load extensions"); |
|
|
| 699 | cf::load_extensions; |
|
|
| 700 | }; |
|
|
| 701 | $msg->($@) if $@; |
|
|
| 702 | |
|
|
| 703 | $msg->("reloaded"); |
|
|
| 704 | }; |
|
|
| 705 | |
|
|
| 706 | sub perl_reload() { |
|
|
| 707 | _perl_reload { |
|
|
| 708 | warn $_[0]; |
|
|
| 709 | print "$_[0]\n"; |
|
|
| 710 | }; |
|
|
| 711 | } |
|
|
| 712 | |
|
|
| 713 | register_command "perl-reload", 0, sub { |
|
|
| 714 | my ($who, $arg) = @_; |
|
|
| 715 | |
|
|
| 716 | if ($who->flag (FLAG_WIZ)) { |
|
|
| 717 | _perl_reload { |
|
|
| 718 | warn $_[0]; |
|
|
| 719 | $who->message ($_[0]); |
|
|
| 720 | }; |
|
|
| 721 | } |
|
|
| 722 | }; |
|
|
| 723 | |
|
|
| 724 | ############################################################################# |
|
|
| 725 | # extcmd framework, basically convert ext <msg> |
|
|
| 726 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
| 727 | |
|
|
| 728 | attach_to_players |
|
|
| 729 | on_extcmd => sub { |
|
|
| 730 | my ($pl, $buf) = @_; |
|
|
| 731 | |
|
|
| 732 | my $msg = eval { from_json $buf }; |
|
|
| 733 | |
|
|
| 734 | if (ref $msg) { |
|
|
| 735 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
| 736 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
| 737 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
| 738 | } |
|
|
| 739 | } |
|
|
| 740 | } else { |
|
|
| 741 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
| 742 | } |
|
|
| 743 | |
|
|
| 744 | cf::override; |
|
|
| 745 | }, |
|
|
| 746 | ; |
|
|
| 747 | |
|
|
| 748 | ############################################################################# |
729 | ############################################################################# |
| 749 | # load/save/clean perl data associated with a map |
730 | # load/save/clean perl data associated with a map |
| 750 | |
731 | |
| 751 | *cf::mapsupport::on_clean = sub { |
732 | *cf::mapsupport::on_clean = sub { |
| 752 | my ($map) = @_; |
733 | my ($map) = @_; |
| … | |
… | |
| 780 | } |
761 | } |
| 781 | }, |
762 | }, |
| 782 | ; |
763 | ; |
| 783 | |
764 | |
| 784 | ############################################################################# |
765 | ############################################################################# |
| 785 | # core extensions - in perl |
766 | |
|
|
767 | =head2 CORE EXTENSIONS |
|
|
768 | |
|
|
769 | Functions and methods that extend core crossfire objects. |
|
|
770 | |
|
|
771 | =over 4 |
| 786 | |
772 | |
| 787 | =item cf::player::exists $login |
773 | =item cf::player::exists $login |
| 788 | |
774 | |
| 789 | Returns true when the given account exists. |
775 | Returns true when the given account exists. |
| 790 | |
776 | |
| … | |
… | |
| 793 | sub cf::player::exists($) { |
779 | sub cf::player::exists($) { |
| 794 | cf::player::find $_[0] |
780 | cf::player::find $_[0] |
| 795 | 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; |
| 796 | } |
782 | } |
| 797 | |
783 | |
| 798 | =item $player->reply ($npc, $msg[, $flags]) |
784 | =item $player_object->reply ($npc, $msg[, $flags]) |
| 799 | |
785 | |
| 800 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
786 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
| 801 | can be C<undef>. Does the right thing when the player is currently in a |
787 | can be C<undef>. Does the right thing when the player is currently in a |
| 802 | dialogue with the given NPC character. |
788 | dialogue with the given NPC character. |
| 803 | |
789 | |
| … | |
… | |
| 830 | $msg{msgid} = $id; |
816 | $msg{msgid} = $id; |
| 831 | |
817 | |
| 832 | $self->send ("ext " . to_json \%msg); |
818 | $self->send ("ext " . to_json \%msg); |
| 833 | } |
819 | } |
| 834 | |
820 | |
|
|
821 | =item $player_object->may ("access") |
|
|
822 | |
|
|
823 | Returns wether the given player is authorized to access resource "access" |
|
|
824 | (e.g. "command_wizcast"). |
|
|
825 | |
|
|
826 | =cut |
|
|
827 | |
|
|
828 | sub 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 | |
| 835 | ############################################################################# |
839 | ############################################################################# |
| 836 | # map scripting support |
840 | |
|
|
841 | =head2 SAFE SCRIPTING |
|
|
842 | |
|
|
843 | Functions that provide a safe environment to compile and execute |
|
|
844 | snippets of perl code without them endangering the safety of the server |
|
|
845 | itself. Looping constructs, I/O operators and other built-in functionality |
|
|
846 | is not available in the safe scripting environment, and the number of |
|
|
847 | functions and methods that can be called is greatly reduced. |
|
|
848 | |
|
|
849 | =cut |
| 837 | |
850 | |
| 838 | our $safe = new Safe "safe"; |
851 | our $safe = new Safe "safe"; |
| 839 | our $safe_hole = new Safe::Hole; |
852 | our $safe_hole = new Safe::Hole; |
| 840 | |
853 | |
| 841 | $SIG{FPE} = 'IGNORE'; |
854 | $SIG{FPE} = 'IGNORE'; |
| 842 | |
855 | |
| 843 | $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)); |
| 844 | |
857 | |
| 845 | # 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 | |
|
|
862 | The 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 |
| 846 | |
869 | |
| 847 | for ( |
870 | for ( |
| 848 | ["cf::object" => qw(contr pay_amount pay_player)], |
871 | ["cf::object" => qw(contr pay_amount pay_player)], |
| 849 | ["cf::object::player" => qw(player)], |
872 | ["cf::object::player" => qw(player)], |
| 850 | ["cf::player" => qw(peaceful)], |
873 | ["cf::player" => qw(peaceful)], |
| … | |
… | |
| 853 | my ($pkg, @funs) = @$_; |
876 | my ($pkg, @funs) = @$_; |
| 854 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
877 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
| 855 | for @funs; |
878 | for @funs; |
| 856 | } |
879 | } |
| 857 | |
880 | |
|
|
881 | =over 4 |
|
|
882 | |
|
|
883 | =item @retval = safe_eval $code, [var => value, ...] |
|
|
884 | |
|
|
885 | Compiled and executes the given perl code snippet. additional var/value |
|
|
886 | pairs result in temporary local (my) scalar variables of the given name |
|
|
887 | that are available in the code snippet. Example: |
|
|
888 | |
|
|
889 | my $five = safe_eval '$first + $second', first => 1, second => 4; |
|
|
890 | |
|
|
891 | =cut |
|
|
892 | |
| 858 | sub safe_eval($;@) { |
893 | sub safe_eval($;@) { |
| 859 | my ($code, %vars) = @_; |
894 | my ($code, %vars) = @_; |
| 860 | |
895 | |
| 861 | my $qcode = $code; |
896 | my $qcode = $code; |
| 862 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
897 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
| … | |
… | |
| 884 | } |
919 | } |
| 885 | |
920 | |
| 886 | wantarray ? @res : $res[0] |
921 | wantarray ? @res : $res[0] |
| 887 | } |
922 | } |
| 888 | |
923 | |
|
|
924 | =item cf::register_script_function $function => $cb |
|
|
925 | |
|
|
926 | Register a function that can be called from within map/npc scripts. The |
|
|
927 | function should be reasonably secure and should be put into a package name |
|
|
928 | like the extension. |
|
|
929 | |
|
|
930 | Example: register a function that gets called whenever a map script calls |
|
|
931 | C<rent::overview>, as used by the C<rent> extension. |
|
|
932 | |
|
|
933 | cf::register_script_function "rent::overview" => sub { |
|
|
934 | ... |
|
|
935 | }; |
|
|
936 | |
|
|
937 | =cut |
|
|
938 | |
| 889 | sub register_script_function { |
939 | sub register_script_function { |
| 890 | my ($fun, $cb) = @_; |
940 | my ($fun, $cb) = @_; |
| 891 | |
941 | |
| 892 | no strict 'refs'; |
942 | no strict 'refs'; |
| 893 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
943 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
| 894 | } |
944 | } |
| 895 | |
945 | |
|
|
946 | =back |
|
|
947 | |
|
|
948 | =cut |
|
|
949 | |
|
|
950 | ############################################################################# |
|
|
951 | |
|
|
952 | =head2 EXTENSION DATABASE SUPPORT |
|
|
953 | |
|
|
954 | Crossfire maintains a very simple database for extension use. It can |
|
|
955 | currently store anything that can be serialised using Storable, which |
|
|
956 | excludes objects. |
|
|
957 | |
|
|
958 | The parameter C<$family> should best start with the name of the extension |
|
|
959 | using it, it should be unique. |
|
|
960 | |
|
|
961 | =over 4 |
|
|
962 | |
|
|
963 | =item $hashref = cf::db_get $family |
|
|
964 | |
|
|
965 | Return a hashref for use by the extension C<$family>, which can be |
|
|
966 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
967 | C<cf::db_sync>. |
|
|
968 | |
|
|
969 | =item $value = cf::db_get $family => $key |
|
|
970 | |
|
|
971 | Returns a single value from the database |
|
|
972 | |
|
|
973 | =item cf::db_put $family => $hashref |
|
|
974 | |
|
|
975 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
976 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
977 | |
|
|
978 | =item cf::db_put $family => $key => $value |
|
|
979 | |
|
|
980 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
|
|
981 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
982 | |
|
|
983 | =item cf::db_dirty |
|
|
984 | |
|
|
985 | Marks the database as dirty, to be updated at a later time. |
|
|
986 | |
|
|
987 | =item cf::db_sync |
|
|
988 | |
|
|
989 | Immediately write the database to disk I<if it is dirty>. |
|
|
990 | |
|
|
991 | =cut |
|
|
992 | |
|
|
993 | our $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 | |
| 896 | ############################################################################# |
1055 | ############################################################################# |
| 897 | # the server's main() |
1056 | # the server's main() |
| 898 | |
1057 | |
|
|
1058 | sub cfg_load { |
|
|
1059 | open my $fh, "<:utf8", cf::confdir . "/config" |
|
|
1060 | or return; |
|
|
1061 | |
|
|
1062 | local $/; |
|
|
1063 | *CFG = YAML::Syck::Load <$fh>; |
|
|
1064 | } |
|
|
1065 | |
| 899 | sub main { |
1066 | sub main { |
|
|
1067 | cfg_load; |
|
|
1068 | db_load; |
| 900 | load_extensions; |
1069 | load_extensions; |
| 901 | Event::loop; |
1070 | Event::loop; |
| 902 | } |
1071 | } |
| 903 | |
1072 | |
| 904 | ############################################################################# |
1073 | ############################################################################# |
| 905 | # initialisation |
1074 | # initialisation |
| 906 | |
1075 | |
|
|
1076 | sub _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 | |
|
|
1146 | sub perl_reload() { |
|
|
1147 | _perl_reload { |
|
|
1148 | warn $_[0]; |
|
|
1149 | print "$_[0]\n"; |
|
|
1150 | }; |
|
|
1151 | } |
|
|
1152 | |
| 907 | register "<global>", __PACKAGE__; |
1153 | register "<global>", __PACKAGE__; |
| 908 | |
1154 | |
|
|
1155 | register_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 | |
| 909 | unshift @INC, $LIBDIR; |
1166 | unshift @INC, $LIBDIR; |
| 910 | |
1167 | |
| 911 | $TICK_WATCHER = Event->timer ( |
1168 | $TICK_WATCHER = Event->timer ( |
| 912 | prio => 1, |
1169 | prio => 1, |
|
|
1170 | async => 1, |
| 913 | at => $NEXT_TICK || 1, |
1171 | at => $NEXT_TICK || 1, |
| 914 | cb => sub { |
1172 | cb => sub { |
| 915 | cf::server_tick; # one server iteration |
1173 | cf::server_tick; # one server iteration |
| 916 | |
1174 | |
| 917 | my $NOW = Event::time; |
1175 | my $NOW = Event::time; |
| 918 | $NEXT_TICK += $TICK; |
1176 | $NEXT_TICK += $TICK; |
| 919 | |
1177 | |
| 920 | # if we are delayed by four ticks, skip them all |
1178 | # if we are delayed by four ticks or more, skip them all |
| 921 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
1179 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
| 922 | |
1180 | |
| 923 | $TICK_WATCHER->at ($NEXT_TICK); |
1181 | $TICK_WATCHER->at ($NEXT_TICK); |
| 924 | $TICK_WATCHER->start; |
1182 | $TICK_WATCHER->start; |
| 925 | }, |
1183 | }, |
| 926 | ); |
1184 | ); |
| 927 | |
1185 | |
| 928 | _reload_2; |
1186 | IO::AIO::max_poll_time $TICK * 0.2; |
|
|
1187 | |
|
|
1188 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1189 | poll => 'r', |
|
|
1190 | prio => 5, |
|
|
1191 | cb => \&IO::AIO::poll_cb); |
| 929 | |
1192 | |
| 930 | 1 |
1193 | 1 |
| 931 | |
1194 | |
