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