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