| … | |
… | |
| 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 | _init_vars; |
21 | _init_vars; |
| 17 | |
22 | |
| 18 | our %COMMAND = (); |
23 | our %COMMAND = (); |
| … | |
… | |
| 20 | our $LIBDIR = maps_directory "perl"; |
25 | our $LIBDIR = maps_directory "perl"; |
| 21 | |
26 | |
| 22 | our $TICK = MAX_TIME * 1e-6; |
27 | our $TICK = MAX_TIME * 1e-6; |
| 23 | our $TICK_WATCHER; |
28 | our $TICK_WATCHER; |
| 24 | 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 |
| 25 | |
60 | |
| 26 | BEGIN { |
61 | BEGIN { |
| 27 | *CORE::GLOBAL::warn = sub { |
62 | *CORE::GLOBAL::warn = sub { |
| 28 | my $msg = join "", @_; |
63 | my $msg = join "", @_; |
| 29 | $msg .= "\n" |
64 | $msg .= "\n" |
| … | |
… | |
| 51 | my @exts; |
86 | my @exts; |
| 52 | my @hook; |
87 | my @hook; |
| 53 | my %command; |
88 | my %command; |
| 54 | my %extcmd; |
89 | my %extcmd; |
| 55 | |
90 | |
| 56 | ############################################################################# |
91 | =head2 UTILITY FUNCTIONS |
| 57 | # utility functions |
92 | |
|
|
93 | =over 4 |
|
|
94 | |
|
|
95 | =cut |
| 58 | |
96 | |
| 59 | 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 |
| 60 | |
104 | |
| 61 | sub from_json($) { |
105 | sub from_json($) { |
| 62 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
106 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
| 63 | JSON::Syck::Load $_[0] |
107 | JSON::Syck::Load $_[0] |
| 64 | } |
108 | } |
| 65 | |
109 | |
|
|
110 | =item $json = cf::to_json $ref |
|
|
111 | |
|
|
112 | Converts a perl data structure into its JSON representation. |
|
|
113 | |
|
|
114 | =cut |
|
|
115 | |
| 66 | sub to_json($) { |
116 | sub to_json($) { |
| 67 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
117 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
| 68 | JSON::Syck::Dump $_[0] |
118 | JSON::Syck::Dump $_[0] |
| 69 | } |
119 | } |
| 70 | |
120 | |
| 71 | ############################################################################# |
121 | =back |
| 72 | # "new" plug-in system |
|
|
| 73 | |
122 | |
|
|
123 | =cut |
|
|
124 | |
|
|
125 | ############################################################################# |
|
|
126 | |
| 74 | =head3 EVENTS AND OBJECT ATTACHMENTS |
127 | =head2 EVENTS AND OBJECT ATTACHMENTS |
| 75 | |
128 | |
| 76 | =over 4 |
129 | =over 4 |
| 77 | |
130 | |
| 78 | =item $object->attach ($attachment, key => $value...) |
131 | =item $object->attach ($attachment, key => $value...) |
| 79 | |
132 | |
| … | |
… | |
| 379 | 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 |
| 380 | results (if you must, access C<@cf::invoke_results> directly). |
433 | results (if you must, access C<@cf::invoke_results> directly). |
| 381 | |
434 | |
| 382 | =back |
435 | =back |
| 383 | |
436 | |
| 384 | =head2 methods valid for all pointers |
437 | =cut |
|
|
438 | |
|
|
439 | ############################################################################# |
|
|
440 | |
|
|
441 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
| 385 | |
442 | |
| 386 | =over 4 |
443 | =over 4 |
| 387 | |
444 | |
| 388 | =item $object->valid |
445 | =item $object->valid, $player->valid, $map->valid |
| 389 | |
|
|
| 390 | =item $player->valid |
|
|
| 391 | |
|
|
| 392 | =item $map->valid |
|
|
| 393 | |
446 | |
| 394 | 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 |
| 395 | 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 |
| 396 | 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 |
| 397 | 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 |
| … | |
… | |
| 704 | } |
757 | } |
| 705 | }, |
758 | }, |
| 706 | ; |
759 | ; |
| 707 | |
760 | |
| 708 | ############################################################################# |
761 | ############################################################################# |
| 709 | # core extensions - in perl |
762 | |
|
|
763 | =head2 CORE EXTENSIONS |
|
|
764 | |
|
|
765 | Functions and methods that extend core crossfire objects. |
|
|
766 | |
|
|
767 | =over 4 |
| 710 | |
768 | |
| 711 | =item cf::player::exists $login |
769 | =item cf::player::exists $login |
| 712 | |
770 | |
| 713 | Returns true when the given account exists. |
771 | Returns true when the given account exists. |
| 714 | |
772 | |
| … | |
… | |
| 717 | sub cf::player::exists($) { |
775 | sub cf::player::exists($) { |
| 718 | cf::player::find $_[0] |
776 | cf::player::find $_[0] |
| 719 | 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; |
| 720 | } |
778 | } |
| 721 | |
779 | |
| 722 | =item $player->reply ($npc, $msg[, $flags]) |
780 | =item $object->reply ($npc, $msg[, $flags]) |
| 723 | |
781 | |
| 724 | 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> |
| 725 | 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 |
| 726 | dialogue with the given NPC character. |
784 | dialogue with the given NPC character. |
| 727 | |
785 | |
| … | |
… | |
| 754 | $msg{msgid} = $id; |
812 | $msg{msgid} = $id; |
| 755 | |
813 | |
| 756 | $self->send ("ext " . to_json \%msg); |
814 | $self->send ("ext " . to_json \%msg); |
| 757 | } |
815 | } |
| 758 | |
816 | |
|
|
817 | =back |
|
|
818 | |
|
|
819 | =cut |
|
|
820 | |
| 759 | ############################################################################# |
821 | ############################################################################# |
| 760 | # 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 |
| 761 | |
832 | |
| 762 | our $safe = new Safe "safe"; |
833 | our $safe = new Safe "safe"; |
| 763 | our $safe_hole = new Safe::Hole; |
834 | our $safe_hole = new Safe::Hole; |
| 764 | |
835 | |
| 765 | $SIG{FPE} = 'IGNORE'; |
836 | $SIG{FPE} = 'IGNORE'; |
| 766 | |
837 | |
| 767 | $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)); |
| 768 | |
839 | |
| 769 | # 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 |
| 770 | |
851 | |
| 771 | for ( |
852 | for ( |
| 772 | ["cf::object" => qw(contr pay_amount pay_player)], |
853 | ["cf::object" => qw(contr pay_amount pay_player)], |
| 773 | ["cf::object::player" => qw(player)], |
854 | ["cf::object::player" => qw(player)], |
| 774 | ["cf::player" => qw(peaceful)], |
855 | ["cf::player" => qw(peaceful)], |
| … | |
… | |
| 777 | my ($pkg, @funs) = @$_; |
858 | my ($pkg, @funs) = @$_; |
| 778 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
859 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
| 779 | for @funs; |
860 | for @funs; |
| 780 | } |
861 | } |
| 781 | |
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 | |
| 782 | sub safe_eval($;@) { |
875 | sub safe_eval($;@) { |
| 783 | my ($code, %vars) = @_; |
876 | my ($code, %vars) = @_; |
| 784 | |
877 | |
| 785 | my $qcode = $code; |
878 | my $qcode = $code; |
| 786 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
879 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
| … | |
… | |
| 808 | } |
901 | } |
| 809 | |
902 | |
| 810 | wantarray ? @res : $res[0] |
903 | wantarray ? @res : $res[0] |
| 811 | } |
904 | } |
| 812 | |
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 | |
| 813 | sub register_script_function { |
921 | sub register_script_function { |
| 814 | my ($fun, $cb) = @_; |
922 | my ($fun, $cb) = @_; |
| 815 | |
923 | |
| 816 | no strict 'refs'; |
924 | no strict 'refs'; |
| 817 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
925 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
| 818 | } |
926 | } |
|
|
927 | |
|
|
928 | =back |
|
|
929 | |
|
|
930 | =cut |
| 819 | |
931 | |
| 820 | ############################################################################# |
932 | ############################################################################# |
| 821 | |
933 | |
| 822 | =head2 EXTENSION DATABASE SUPPORT |
934 | =head2 EXTENSION DATABASE SUPPORT |
| 823 | |
935 | |
| … | |
… | |
| 922 | } |
1034 | } |
| 923 | |
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; |
| 928 | db_load; |
1049 | db_load; |
| 929 | load_extensions; |
1050 | load_extensions; |
| 930 | Event::loop; |
1051 | Event::loop; |
| 931 | } |
1052 | } |
| 932 | |
1053 | |
| … | |
… | |
| 984 | |
1105 | |
| 985 | # reload cf.pm |
1106 | # reload cf.pm |
| 986 | $msg->("reloading cf.pm"); |
1107 | $msg->("reloading cf.pm"); |
| 987 | require cf; |
1108 | require cf; |
| 988 | |
1109 | |
| 989 | # load database again |
1110 | # load config and database again |
|
|
1111 | cf::cfg_load; |
| 990 | cf::db_load; |
1112 | cf::db_load; |
| 991 | |
1113 | |
| 992 | # load extensions |
1114 | # load extensions |
| 993 | $msg->("load extensions"); |
1115 | $msg->("load extensions"); |
| 994 | cf::load_extensions; |
1116 | cf::load_extensions; |
| … | |
… | |
| 1023 | register "<global>", __PACKAGE__; |
1145 | register "<global>", __PACKAGE__; |
| 1024 | |
1146 | |
| 1025 | unshift @INC, $LIBDIR; |
1147 | unshift @INC, $LIBDIR; |
| 1026 | |
1148 | |
| 1027 | $TICK_WATCHER = Event->timer ( |
1149 | $TICK_WATCHER = Event->timer ( |
| 1028 | prio => 1, |
1150 | prio => 1, |
|
|
1151 | async => 1, |
| 1029 | at => $NEXT_TICK || 1, |
1152 | at => $NEXT_TICK || 1, |
| 1030 | cb => sub { |
1153 | cb => sub { |
| 1031 | cf::server_tick; # one server iteration |
1154 | cf::server_tick; # one server iteration |
| 1032 | |
1155 | |
| 1033 | my $NOW = Event::time; |
1156 | my $NOW = Event::time; |
| 1034 | $NEXT_TICK += $TICK; |
1157 | $NEXT_TICK += $TICK; |
| 1035 | |
1158 | |
| … | |
… | |
| 1039 | $TICK_WATCHER->at ($NEXT_TICK); |
1162 | $TICK_WATCHER->at ($NEXT_TICK); |
| 1040 | $TICK_WATCHER->start; |
1163 | $TICK_WATCHER->start; |
| 1041 | }, |
1164 | }, |
| 1042 | ); |
1165 | ); |
| 1043 | |
1166 | |
|
|
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); |
|
|
1173 | |
| 1044 | 1 |
1174 | 1 |
| 1045 | |
1175 | |
