| 1 | package cf; |
1 | package cf; |
| 2 | |
2 | |
| 3 | use Symbol; |
3 | use Symbol; |
| 4 | use List::Util; |
4 | use List::Util; |
| 5 | use Storable; |
5 | use Storable; |
|
|
6 | use Opcode; |
|
|
7 | use Safe; |
|
|
8 | use Safe::Hole; |
|
|
9 | |
|
|
10 | use Time::HiRes; |
|
|
11 | use Event; |
|
|
12 | $Event::Eval = 1; # no idea why this is required, but it is |
| 6 | |
13 | |
| 7 | use strict; |
14 | use strict; |
| 8 | |
15 | |
| 9 | our %COMMAND; |
16 | our %COMMAND; |
| 10 | our @EVENT; |
17 | our @EVENT; |
|
|
18 | our @PLUGIN_EVENT; |
| 11 | our %PROP_TYPE; |
19 | our %PROP_TYPE; |
| 12 | our %PROP_IDX; |
20 | our %PROP_IDX; |
|
|
21 | our $LIBDIR = maps_directory "perl"; |
|
|
22 | |
|
|
23 | our $TICK = MAX_TIME * 1e-6; |
|
|
24 | our $TICK_WATCHER; |
|
|
25 | our $NEXT_TICK; |
| 13 | |
26 | |
| 14 | BEGIN { |
27 | BEGIN { |
| 15 | @EVENT = map lc, @EVENT; |
28 | @PLUGIN_EVENT = map lc, @PLUGIN_EVENT; |
| 16 | |
29 | |
| 17 | *CORE::GLOBAL::warn = sub { |
30 | *CORE::GLOBAL::warn = sub { |
| 18 | my $msg = join "", @_; |
31 | my $msg = join "", @_; |
| 19 | $msg .= "\n" |
32 | $msg .= "\n" |
| 20 | unless $msg =~ /\n$/; |
33 | unless $msg =~ /\n$/; |
| … | |
… | |
| 58 | prop_gen MAP_PROP => "cf::map"; |
71 | prop_gen MAP_PROP => "cf::map"; |
| 59 | prop_gen ARCH_PROP => "cf::arch"; |
72 | prop_gen ARCH_PROP => "cf::arch"; |
| 60 | |
73 | |
| 61 | # guessed hierarchies |
74 | # guessed hierarchies |
| 62 | |
75 | |
| 63 | @cf::object::player::ISA = 'cf::object'; |
76 | @ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
| 64 | @cf::object::map::ISA = 'cf::object'; |
77 | @ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object'; |
|
|
78 | |
|
|
79 | # we bless all objects into derived classes to force a method lookup |
|
|
80 | # within the Safe compartment. |
|
|
81 | for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { |
|
|
82 | no strict 'refs'; |
|
|
83 | @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
|
|
84 | } |
|
|
85 | |
|
|
86 | $Event::DIED = sub { |
|
|
87 | warn "error in event callback: @_"; |
|
|
88 | }; |
| 65 | |
89 | |
| 66 | my %ext_pkg; |
90 | my %ext_pkg; |
| 67 | my @exts; |
91 | my @exts; |
| 68 | my @hook; |
92 | my @hook; |
| 69 | my %command; |
93 | my %command; |
|
|
94 | my %extcmd; |
| 70 | |
95 | |
| 71 | sub inject_event { |
96 | sub inject_event { |
| 72 | my $extension = shift; |
97 | my $extension = shift; |
| 73 | my $event_code = shift; |
98 | my $event_code = shift; |
| 74 | |
99 | |
| … | |
… | |
| 99 | |
124 | |
| 100 | sub register_command { |
125 | sub register_command { |
| 101 | my ($name, $time, $cb) = @_; |
126 | my ($name, $time, $cb) = @_; |
| 102 | |
127 | |
| 103 | my $caller = caller; |
128 | my $caller = caller; |
| 104 | |
|
|
| 105 | warn "registering command '$name/$time' to '$caller'"; |
129 | #warn "registering command '$name/$time' to '$caller'"; |
| 106 | |
130 | |
| 107 | push @{ $command{$name} }, [$time, $cb, $caller]; |
131 | push @{ $command{$name} }, [$time, $cb, $caller]; |
| 108 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
132 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
| 109 | } |
133 | } |
| 110 | |
134 | |
|
|
135 | sub register_extcmd { |
|
|
136 | my ($name, $cb) = @_; |
|
|
137 | |
|
|
138 | my $caller = caller; |
|
|
139 | #warn "registering extcmd '$name' to '$caller'"; |
|
|
140 | |
|
|
141 | $extcmd{$name} = [$cb, $caller]; |
|
|
142 | } |
|
|
143 | |
| 111 | sub register { |
144 | sub register { |
| 112 | my ($base, $pkg) = @_; |
145 | my ($base, $pkg) = @_; |
| 113 | |
146 | |
| 114 | for my $idx (0 .. $#EVENT) { |
147 | for my $idx (0 .. $#PLUGIN_EVENT) { |
| 115 | if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { |
148 | if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) { |
| 116 | warn "registering $EVENT[$idx] hook to '$pkg'\n"; |
149 | #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n"; |
| 117 | $hook[$idx]{$base} = $ref; |
150 | $hook[$idx]{$base} = $ref; |
| 118 | } |
151 | } |
| 119 | } |
152 | } |
| 120 | } |
153 | } |
| 121 | |
154 | |
| … | |
… | |
| 144 | |
177 | |
| 145 | push @exts, $pkg; |
178 | push @exts, $pkg; |
| 146 | $ext_pkg{$base} = $pkg; |
179 | $ext_pkg{$base} = $pkg; |
| 147 | |
180 | |
| 148 | # no strict 'refs'; |
181 | # no strict 'refs'; |
| 149 | # @{"$pkg\::ISA"} = cf::ext::; |
182 | # @{"$pkg\::ISA"} = ext::; |
| 150 | |
183 | |
| 151 | register $base, $pkg; |
184 | register $base, $pkg; |
| 152 | } |
185 | } |
| 153 | |
186 | |
| 154 | sub unload_extension { |
187 | sub unload_extension { |
| 155 | my ($pkg) = @_; |
188 | my ($pkg) = @_; |
| 156 | |
189 | |
| 157 | warn "removing extension $pkg\n"; |
190 | warn "removing extension $pkg\n"; |
| 158 | |
191 | |
| 159 | # remove hooks |
192 | # remove hooks |
| 160 | for my $idx (0 .. $#EVENT) { |
193 | for my $idx (0 .. $#PLUGIN_EVENT) { |
| 161 | delete $hook[$idx]{$pkg}; |
194 | delete $hook[$idx]{$pkg}; |
| 162 | } |
195 | } |
| 163 | |
196 | |
| 164 | # remove commands |
197 | # remove commands |
| 165 | for my $name (keys %command) { |
198 | for my $name (keys %command) { |
| … | |
… | |
| 172 | delete $command{$name}; |
205 | delete $command{$name}; |
| 173 | delete $COMMAND{"$name\000"}; |
206 | delete $COMMAND{"$name\000"}; |
| 174 | } |
207 | } |
| 175 | } |
208 | } |
| 176 | |
209 | |
|
|
210 | # remove extcmds |
|
|
211 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
|
|
212 | delete $extcmd{$name}; |
|
|
213 | } |
|
|
214 | |
|
|
215 | if (my $cb = $pkg->can ("on_unload")) { |
|
|
216 | eval { |
|
|
217 | $cb->($pkg); |
|
|
218 | 1 |
|
|
219 | } or warn "$pkg unloaded, but with errors: $@"; |
|
|
220 | } |
|
|
221 | |
| 177 | Symbol::delete_package $pkg; |
222 | Symbol::delete_package $pkg; |
| 178 | } |
223 | } |
| 179 | |
224 | |
| 180 | sub load_extensions { |
225 | sub load_extensions { |
| 181 | my $LIBDIR = maps_directory "perl"; |
226 | my $LIBDIR = maps_directory "perl"; |
| … | |
… | |
| 187 | 1 |
232 | 1 |
| 188 | } or warn "$ext not loaded: $@"; |
233 | } or warn "$ext not loaded: $@"; |
| 189 | } |
234 | } |
| 190 | } |
235 | } |
| 191 | |
236 | |
|
|
237 | sub _perl_reload(&) { |
|
|
238 | my ($msg) = @_; |
|
|
239 | |
|
|
240 | $msg->("reloading..."); |
|
|
241 | |
|
|
242 | eval { |
|
|
243 | # 1. cancel all watchers |
|
|
244 | $_->cancel for Event::all_watchers; |
|
|
245 | |
|
|
246 | # 2. unload all extensions |
|
|
247 | for (@exts) { |
|
|
248 | $msg->("unloading <$_>"); |
|
|
249 | unload_extension $_; |
|
|
250 | } |
|
|
251 | |
|
|
252 | # 3. unload all modules loaded from $LIBDIR |
|
|
253 | while (my ($k, $v) = each %INC) { |
|
|
254 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
255 | |
|
|
256 | $msg->("removing <$k>"); |
|
|
257 | delete $INC{$k}; |
|
|
258 | |
|
|
259 | $k =~ s/\.pm$//; |
|
|
260 | $k =~ s/\//::/g; |
|
|
261 | |
|
|
262 | if (my $cb = $k->can ("unload_module")) { |
|
|
263 | $cb->(); |
|
|
264 | } |
|
|
265 | |
|
|
266 | Symbol::delete_package $k; |
|
|
267 | } |
|
|
268 | |
|
|
269 | # 4. get rid of ext::, as good as possible |
|
|
270 | Symbol::delete_package "ext::$_" |
|
|
271 | for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region); |
|
|
272 | |
|
|
273 | # 5. remove register_script_function callbacks |
|
|
274 | # TODO |
|
|
275 | |
|
|
276 | # 6. unload cf.pm "a bit" |
|
|
277 | delete $INC{"cf.pm"}; |
|
|
278 | |
|
|
279 | # don't, removes xs symbols, too |
|
|
280 | #Symbol::delete_package __PACKAGE__; |
|
|
281 | |
|
|
282 | # 7. reload cf.pm |
|
|
283 | $msg->("reloading cf.pm"); |
|
|
284 | require cf; |
|
|
285 | }; |
|
|
286 | $msg->($@) if $@; |
|
|
287 | |
|
|
288 | $msg->("reloaded"); |
|
|
289 | }; |
|
|
290 | |
|
|
291 | sub perl_reload() { |
|
|
292 | _perl_reload { |
|
|
293 | warn $_[0]; |
|
|
294 | print "$_[0]\n"; |
|
|
295 | }; |
|
|
296 | } |
|
|
297 | |
| 192 | register_command "perl-reload", 0, sub { |
298 | register_command "perl-reload", 0, sub { |
| 193 | my ($who, $arg) = @_; |
299 | my ($who, $arg) = @_; |
| 194 | |
300 | |
| 195 | if ($who->flag (FLAG_WIZ)) { |
301 | if ($who->flag (FLAG_WIZ)) { |
| 196 | $who->message ("reloading..."); |
302 | _perl_reload { |
| 197 | |
303 | warn $_[0]; |
| 198 | warn "reloading...\n"; |
304 | $who->message ($_[0]); |
| 199 | eval { |
|
|
| 200 | unload_extension $_ for @exts; |
|
|
| 201 | delete $INC{"cf.pm"}; |
|
|
| 202 | |
|
|
| 203 | # don't, removes xs symbols, too |
|
|
| 204 | #Symbol::delete_package $pkg; |
|
|
| 205 | |
|
|
| 206 | require cf; |
|
|
| 207 | }; |
305 | }; |
| 208 | warn $@ if $@; |
306 | } |
| 209 | $who->message ($@) if $@; |
307 | }; |
| 210 | warn "reloaded\n"; |
|
|
| 211 | |
308 | |
| 212 | $who->message ("reloaded"); |
309 | ############################################################################# |
|
|
310 | # utility functions |
|
|
311 | |
|
|
312 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
313 | |
|
|
314 | sub from_json($) { |
|
|
315 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
|
|
316 | JSON::Syck::Load $_[0] |
|
|
317 | } |
|
|
318 | |
|
|
319 | sub to_json($) { |
|
|
320 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
|
|
321 | JSON::Syck::Dump $_[0] |
|
|
322 | } |
|
|
323 | |
|
|
324 | ############################################################################# |
|
|
325 | # extcmd framework, basically convert ext <msg> |
|
|
326 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
327 | |
|
|
328 | sub on_extcmd { |
|
|
329 | my ($pl, $buf) = @_; |
|
|
330 | |
|
|
331 | my $msg = eval { from_json $buf }; |
|
|
332 | |
|
|
333 | if (ref $msg) { |
|
|
334 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
335 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
336 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
337 | } |
|
|
338 | } |
| 213 | } else { |
339 | } else { |
| 214 | $who->message ("Intruder Alert!"); |
340 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
341 | } |
|
|
342 | |
| 215 | } |
343 | 1 |
| 216 | }; |
344 | } |
| 217 | |
345 | |
| 218 | ############################################################################# |
346 | ############################################################################# |
| 219 | # load/save/clean perl data associated with a map |
347 | # load/save/clean perl data associated with a map |
| 220 | |
348 | |
| 221 | *on_mapclean = sub { |
349 | *on_mapclean = sub { |
| … | |
… | |
| 273 | }; |
401 | }; |
| 274 | |
402 | |
| 275 | ############################################################################# |
403 | ############################################################################# |
| 276 | # load/save perl data associated with player->ob objects |
404 | # load/save perl data associated with player->ob objects |
| 277 | |
405 | |
|
|
406 | sub all_objects(@) { |
|
|
407 | @_, map all_objects ($_->inv), @_ |
|
|
408 | } |
|
|
409 | |
| 278 | *on_player_load = sub { |
410 | *on_player_load = sub { |
| 279 | my ($ob, $path) = @_; |
411 | my ($ob, $path) = @_; |
| 280 | |
412 | |
| 281 | if (open my $fh, "<:raw", "$path.cfperl") { |
413 | for my $o (all_objects $ob) { |
| 282 | |
|
|
| 283 | #d##TODO#remove |
|
|
| 284 | |
|
|
| 285 | my $data = Storable::thaw do { local $/; <$fh> }; |
|
|
| 286 | |
|
|
| 287 | $data->{version} <= 1 |
|
|
| 288 | or return; # too new |
|
|
| 289 | |
|
|
| 290 | %$ob = %{$data->{ob}}; |
|
|
| 291 | return; |
|
|
| 292 | } |
|
|
| 293 | |
|
|
| 294 | for my $o ($ob, $ob->inv) { |
|
|
| 295 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
414 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
| 296 | $o->set_ob_key_value ("_perl_data"); |
415 | $o->set_ob_key_value ("_perl_data"); |
| 297 | |
416 | |
| 298 | %$o = %{ Storable::thaw pack "H*", $value }; |
417 | %$o = %{ Storable::thaw pack "H*", $value }; |
| 299 | } |
418 | } |
| … | |
… | |
| 302 | |
421 | |
| 303 | *on_player_save = sub { |
422 | *on_player_save = sub { |
| 304 | my ($ob, $path) = @_; |
423 | my ($ob, $path) = @_; |
| 305 | |
424 | |
| 306 | $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) |
425 | $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) |
| 307 | for grep %$_, $ob, $ob->inv; |
426 | for grep %$_, all_objects $ob; |
| 308 | |
|
|
| 309 | unlink "$path.cfperl";#d##TODO#remove |
|
|
| 310 | }; |
427 | }; |
|
|
428 | |
|
|
429 | ############################################################################# |
|
|
430 | # core extensions - in perl |
|
|
431 | |
|
|
432 | =item cf::player::exists $login |
|
|
433 | |
|
|
434 | Returns true when the given account exists. |
|
|
435 | |
|
|
436 | =cut |
|
|
437 | |
|
|
438 | sub cf::player::exists($) { |
|
|
439 | cf::player::find $_[0] |
|
|
440 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
|
|
441 | } |
|
|
442 | |
|
|
443 | =item $player->reply ($npc, $msg[, $flags]) |
|
|
444 | |
|
|
445 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
|
|
446 | can be C<undef>. Does the right thing when the player is currently in a |
|
|
447 | dialogue with the given NPC character. |
|
|
448 | |
|
|
449 | =cut |
|
|
450 | |
|
|
451 | # rough implementation of a future "reply" method that works |
|
|
452 | # with dialog boxes. |
|
|
453 | sub cf::object::player::reply($$$;$) { |
|
|
454 | my ($self, $npc, $msg, $flags) = @_; |
|
|
455 | |
|
|
456 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
|
|
457 | |
|
|
458 | if ($self->{record_replies}) { |
|
|
459 | push @{ $self->{record_replies} }, [$npc, $msg, $flags]; |
|
|
460 | } else { |
|
|
461 | $msg = $npc->name . " says: $msg" if $npc; |
|
|
462 | $self->message ($msg, $flags); |
|
|
463 | } |
|
|
464 | } |
|
|
465 | |
|
|
466 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
467 | |
|
|
468 | Sends an ext reply to the player. |
|
|
469 | |
|
|
470 | =cut |
|
|
471 | |
|
|
472 | sub cf::player::ext_reply($$$%) { |
|
|
473 | my ($self, $id, %msg) = @_; |
|
|
474 | |
|
|
475 | $msg{msgid} = $id; |
|
|
476 | |
|
|
477 | $self->send ("ext " . to_json \%msg); |
|
|
478 | } |
|
|
479 | |
|
|
480 | ############################################################################# |
|
|
481 | # map scripting support |
|
|
482 | |
|
|
483 | our $safe = new Safe "ext"; |
|
|
484 | our $safe_hole = new Safe::Hole; |
|
|
485 | |
|
|
486 | $SIG{FPE} = 'IGNORE'; |
|
|
487 | |
|
|
488 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
|
|
489 | |
|
|
490 | # here we export the classes and methods available to script code |
|
|
491 | |
|
|
492 | for ( |
|
|
493 | ["cf::object" => qw(contr pay_amount pay_player)], |
|
|
494 | ["cf::object::player" => qw(player)], |
|
|
495 | ["cf::player" => qw(peaceful)], |
|
|
496 | ) { |
|
|
497 | no strict 'refs'; |
|
|
498 | my ($pkg, @funs) = @$_; |
|
|
499 | *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
|
|
500 | for @funs; |
|
|
501 | } |
|
|
502 | |
|
|
503 | sub safe_eval($;@) { |
|
|
504 | my ($code, %vars) = @_; |
|
|
505 | |
|
|
506 | my $qcode = $code; |
|
|
507 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
|
|
508 | $qcode =~ s/\n/\\n/g; |
|
|
509 | |
|
|
510 | local $_; |
|
|
511 | local @ext::cf::_safe_eval_args = values %vars; |
|
|
512 | |
|
|
513 | $code = |
|
|
514 | "do {\n" |
|
|
515 | . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" |
|
|
516 | . "#line 0 \"{$qcode}\"\n" |
|
|
517 | . $code |
|
|
518 | . "\n}" |
|
|
519 | ; |
|
|
520 | |
|
|
521 | sub_generation_inc; |
|
|
522 | my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); |
|
|
523 | sub_generation_inc; |
|
|
524 | |
|
|
525 | wantarray ? @res : $res[0] |
|
|
526 | } |
|
|
527 | |
|
|
528 | sub register_script_function { |
|
|
529 | my ($fun, $cb) = @_; |
|
|
530 | |
|
|
531 | no strict 'refs'; |
|
|
532 | *{"ext::$fun"} = $safe_hole->wrap ($cb); |
|
|
533 | } |
|
|
534 | |
|
|
535 | ############################################################################# |
|
|
536 | # the server's main() |
|
|
537 | |
|
|
538 | sub run { |
|
|
539 | Event::loop; |
|
|
540 | } |
|
|
541 | |
|
|
542 | ############################################################################# |
|
|
543 | # initialisation |
| 311 | |
544 | |
| 312 | register "<global>", __PACKAGE__; |
545 | register "<global>", __PACKAGE__; |
| 313 | |
546 | |
|
|
547 | unshift @INC, $LIBDIR; |
|
|
548 | |
| 314 | load_extensions; |
549 | load_extensions; |
| 315 | |
550 | |
|
|
551 | $TICK_WATCHER = Event->timer ( |
|
|
552 | prio => 1, |
|
|
553 | at => $NEXT_TICK || 1, |
|
|
554 | cb => sub { |
|
|
555 | cf::server_tick; # one server iteration |
|
|
556 | |
|
|
557 | my $NOW = Event::time; |
|
|
558 | $NEXT_TICK += $TICK; |
|
|
559 | |
|
|
560 | # if we are delayed by four ticks, skip them all |
|
|
561 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
|
|
562 | |
|
|
563 | $TICK_WATCHER->at ($NEXT_TICK); |
|
|
564 | $TICK_WATCHER->start; |
|
|
565 | }, |
|
|
566 | ); |
|
|
567 | |
| 316 | 1 |
568 | 1 |
| 317 | |
569 | |
