| 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; |
| 11 | our %PROP_TYPE; |
18 | our %PROP_TYPE; |
| 12 | our %PROP_IDX; |
19 | our %PROP_IDX; |
|
|
20 | our $LIBDIR = maps_directory "perl"; |
| 13 | |
21 | |
| 14 | BEGIN { |
22 | BEGIN { |
| 15 | @EVENT = map lc, @EVENT; |
23 | @EVENT = map lc, @EVENT; |
| 16 | |
24 | |
| 17 | *CORE::GLOBAL::warn = sub { |
25 | *CORE::GLOBAL::warn = sub { |
| … | |
… | |
| 22 | print STDERR "cfperl: $msg"; |
30 | print STDERR "cfperl: $msg"; |
| 23 | LOG llevError, "cfperl: $msg"; |
31 | LOG llevError, "cfperl: $msg"; |
| 24 | }; |
32 | }; |
| 25 | } |
33 | } |
| 26 | |
34 | |
|
|
35 | my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! |
|
|
36 | |
| 27 | # generate property mutators |
37 | # generate property mutators |
| 28 | sub prop_gen { |
38 | sub prop_gen { |
| 29 | my ($prefix, $class) = @_; |
39 | my ($prefix, $class) = @_; |
| 30 | |
40 | |
| 31 | no strict 'refs'; |
41 | no strict 'refs'; |
| … | |
… | |
| 41 | $_[0]->get_property ($type, $idx) |
51 | $_[0]->get_property ($type, $idx) |
| 42 | }; |
52 | }; |
| 43 | |
53 | |
| 44 | *{"$class\::set_$sub"} = sub { |
54 | *{"$class\::set_$sub"} = sub { |
| 45 | $_[0]->set_property ($type, $idx, $_[1]); |
55 | $_[0]->set_property ($type, $idx, $_[1]); |
| 46 | }; |
56 | } unless $ignore_set{$prop}; |
| 47 | } |
57 | } |
| 48 | } |
58 | } |
| 49 | |
59 | |
| 50 | # auto-generate most of the API |
60 | # auto-generate most of the API |
| 51 | |
61 | |
| … | |
… | |
| 56 | prop_gen MAP_PROP => "cf::map"; |
66 | prop_gen MAP_PROP => "cf::map"; |
| 57 | prop_gen ARCH_PROP => "cf::arch"; |
67 | prop_gen ARCH_PROP => "cf::arch"; |
| 58 | |
68 | |
| 59 | # guessed hierarchies |
69 | # guessed hierarchies |
| 60 | |
70 | |
| 61 | @cf::object::player::ISA = 'cf::object'; |
71 | @ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
| 62 | @cf::object::map::ISA = 'cf::object'; |
72 | @ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object'; |
|
|
73 | |
|
|
74 | # we bless all objects into derived classes to force a method lookup |
|
|
75 | # within the Safe compartment. |
|
|
76 | for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { |
|
|
77 | no strict 'refs'; |
|
|
78 | @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
|
|
79 | } |
|
|
80 | |
|
|
81 | $Event::DIED = sub { |
|
|
82 | warn "error in event callback: @_"; |
|
|
83 | }; |
| 63 | |
84 | |
| 64 | my %ext_pkg; |
85 | my %ext_pkg; |
| 65 | my @exts; |
86 | my @exts; |
| 66 | my @hook; |
87 | my @hook; |
| 67 | my %command; |
88 | my %command; |
|
|
89 | my %extcmd; |
| 68 | |
90 | |
| 69 | sub inject_event { |
91 | sub inject_event { |
| 70 | my ($data) = @_; |
92 | my $extension = shift; |
|
|
93 | my $event_code = shift; |
| 71 | |
94 | |
| 72 | my $cb = $hook[$data->{event_code}]{$data->{extension}} |
95 | my $cb = $hook[$event_code]{$extension} |
| 73 | or return; |
96 | or return; |
| 74 | |
97 | |
| 75 | $cb->($data) |
98 | &$cb |
| 76 | } |
99 | } |
| 77 | |
100 | |
| 78 | sub inject_global_event { |
101 | sub inject_global_event { |
| 79 | my ($data) = @_; |
102 | my $event = shift; |
| 80 | |
103 | |
| 81 | my $cb = $hook[$data->{event_code}] |
104 | my $cb = $hook[$event] |
| 82 | or return; |
105 | or return; |
| 83 | |
106 | |
| 84 | $_->($data) for values %$cb; |
107 | List::Util::max map &$_, values %$cb |
| 85 | |
|
|
| 86 | () |
|
|
| 87 | } |
108 | } |
| 88 | |
109 | |
| 89 | sub inject_command { |
110 | sub inject_command { |
| 90 | my ($name, $obj, $params) = @_; |
111 | my ($name, $obj, $params) = @_; |
| 91 | |
112 | |
| … | |
… | |
| 98 | |
119 | |
| 99 | sub register_command { |
120 | sub register_command { |
| 100 | my ($name, $time, $cb) = @_; |
121 | my ($name, $time, $cb) = @_; |
| 101 | |
122 | |
| 102 | my $caller = caller; |
123 | my $caller = caller; |
| 103 | |
|
|
| 104 | warn "registering command '$name/$time' to '$caller'"; |
124 | #warn "registering command '$name/$time' to '$caller'"; |
| 105 | |
125 | |
| 106 | push @{ $command{$name} }, [$time, $cb, $caller]; |
126 | push @{ $command{$name} }, [$time, $cb, $caller]; |
| 107 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
127 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
| 108 | } |
128 | } |
| 109 | |
129 | |
|
|
130 | sub register_extcmd { |
|
|
131 | my ($name, $cb) = @_; |
|
|
132 | |
|
|
133 | my $caller = caller; |
|
|
134 | #warn "registering extcmd '$name' to '$caller'"; |
|
|
135 | |
|
|
136 | $extcmd{$name} = [$cb, $caller]; |
|
|
137 | } |
|
|
138 | |
| 110 | sub register { |
139 | sub register { |
| 111 | my ($base, $pkg) = @_; |
140 | my ($base, $pkg) = @_; |
| 112 | |
141 | |
| 113 | for my $idx (0 .. $#EVENT) { |
142 | for my $idx (0 .. $#EVENT) { |
| 114 | if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { |
143 | if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { |
| 115 | warn "registering $EVENT[$idx] hook to '$pkg'\n"; |
144 | #warn "registering $EVENT[$idx] hook to '$pkg'\n"; |
| 116 | $hook[$idx]{$base} = $ref; |
145 | $hook[$idx]{$base} = $ref; |
| 117 | } |
146 | } |
| 118 | } |
147 | } |
| 119 | } |
148 | } |
| 120 | |
149 | |
| … | |
… | |
| 143 | |
172 | |
| 144 | push @exts, $pkg; |
173 | push @exts, $pkg; |
| 145 | $ext_pkg{$base} = $pkg; |
174 | $ext_pkg{$base} = $pkg; |
| 146 | |
175 | |
| 147 | # no strict 'refs'; |
176 | # no strict 'refs'; |
| 148 | # @{"$pkg\::ISA"} = cf::ext::; |
177 | # @{"$pkg\::ISA"} = ext::; |
| 149 | |
178 | |
| 150 | register $base, $pkg; |
179 | register $base, $pkg; |
| 151 | } |
180 | } |
| 152 | |
181 | |
| 153 | sub unload_extension { |
182 | sub unload_extension { |
| … | |
… | |
| 171 | delete $command{$name}; |
200 | delete $command{$name}; |
| 172 | delete $COMMAND{"$name\000"}; |
201 | delete $COMMAND{"$name\000"}; |
| 173 | } |
202 | } |
| 174 | } |
203 | } |
| 175 | |
204 | |
|
|
205 | # remove extcmds |
|
|
206 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
|
|
207 | delete $extcmd{$name}; |
|
|
208 | } |
|
|
209 | |
|
|
210 | if (my $cb = $pkg->can ("on_unload")) { |
|
|
211 | eval { |
|
|
212 | $cb->($pkg); |
|
|
213 | 1 |
|
|
214 | } or warn "$pkg unloaded, but with errors: $@"; |
|
|
215 | } |
|
|
216 | |
| 176 | Symbol::delete_package $pkg; |
217 | Symbol::delete_package $pkg; |
| 177 | } |
218 | } |
| 178 | |
219 | |
| 179 | sub load_extensions { |
220 | sub load_extensions { |
| 180 | my $LIBDIR = maps_directory "perl"; |
221 | my $LIBDIR = maps_directory "perl"; |
| … | |
… | |
| 194 | if ($who->flag (FLAG_WIZ)) { |
235 | if ($who->flag (FLAG_WIZ)) { |
| 195 | $who->message ("reloading..."); |
236 | $who->message ("reloading..."); |
| 196 | |
237 | |
| 197 | warn "reloading...\n"; |
238 | warn "reloading...\n"; |
| 198 | eval { |
239 | eval { |
|
|
240 | # 1. cancel all watchers |
|
|
241 | $_->cancel for Event::all_watchers; |
|
|
242 | |
|
|
243 | # 2. unload all extensions |
|
|
244 | for (@exts) { |
|
|
245 | $who->message ("unloading <$_>"); |
| 199 | unload_extension $_ for @exts; |
246 | unload_extension $_; |
|
|
247 | } |
|
|
248 | |
|
|
249 | # 3. unload all modules loaded from $LIBDIR |
|
|
250 | while (my ($k, $v) = each %INC) { |
|
|
251 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
252 | |
|
|
253 | $who->message ("removing <$k>"); |
|
|
254 | delete $INC{$k}; |
|
|
255 | |
|
|
256 | $k =~ s/\.pm$//; |
|
|
257 | $k =~ s/\//::/g; |
|
|
258 | |
|
|
259 | if (my $cb = $k->can ("unload_module")) { |
|
|
260 | $cb->(); |
|
|
261 | } |
|
|
262 | |
|
|
263 | Symbol::delete_package $k; |
|
|
264 | } |
|
|
265 | |
|
|
266 | # 4. get rid of ext::, as good as possible |
|
|
267 | Symbol::delete_package "ext::$_" |
|
|
268 | for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region); |
|
|
269 | |
|
|
270 | # 5. remove register_script_function callbacks |
|
|
271 | # TODO |
|
|
272 | |
|
|
273 | # 6. unload cf.pm "a bit" |
| 200 | delete $INC{"cf.pm"}; |
274 | delete $INC{"cf.pm"}; |
| 201 | |
275 | |
| 202 | # don't, removes xs symbols, too |
276 | # don't, removes xs symbols, too |
| 203 | #Symbol::delete_package $pkg; |
277 | #Symbol::delete_package __PACKAGE__; |
| 204 | |
278 | |
|
|
279 | # 7. reload cf.pm |
|
|
280 | $who->message ("reloading cf.pm"); |
| 205 | require cf; |
281 | require cf; |
| 206 | }; |
282 | }; |
| 207 | warn $@ if $@; |
283 | warn $@ if $@; |
| 208 | $who->message ($@) if $@; |
284 | $who->message ($@) if $@; |
| 209 | warn "reloaded\n"; |
285 | warn "reloaded\n"; |
| … | |
… | |
| 212 | } else { |
288 | } else { |
| 213 | $who->message ("Intruder Alert!"); |
289 | $who->message ("Intruder Alert!"); |
| 214 | } |
290 | } |
| 215 | }; |
291 | }; |
| 216 | |
292 | |
|
|
293 | ############################################################################# |
|
|
294 | # utility functions |
|
|
295 | |
|
|
296 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
297 | |
|
|
298 | sub from_json($) { |
|
|
299 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
|
|
300 | JSON::Syck::Load $_[0] |
|
|
301 | } |
|
|
302 | |
|
|
303 | sub to_json($) { |
|
|
304 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
|
|
305 | JSON::Syck::Dump $_[0] |
|
|
306 | } |
|
|
307 | |
|
|
308 | ############################################################################# |
|
|
309 | # extcmd framework, basically convert ext <msg> |
|
|
310 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
311 | |
|
|
312 | sub on_extcmd { |
|
|
313 | my ($pl, $buf) = @_; |
|
|
314 | |
|
|
315 | my $msg = eval { from_json $buf }; |
|
|
316 | |
|
|
317 | if (ref $msg) { |
|
|
318 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
319 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
320 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
321 | } |
|
|
322 | } |
|
|
323 | } else { |
|
|
324 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
325 | } |
|
|
326 | |
|
|
327 | 1 |
|
|
328 | } |
|
|
329 | |
|
|
330 | ############################################################################# |
|
|
331 | # load/save/clean perl data associated with a map |
|
|
332 | |
|
|
333 | *on_mapclean = sub { |
|
|
334 | my ($map) = @_; |
|
|
335 | |
|
|
336 | my $path = $map->tmpname; |
|
|
337 | defined $path or return; |
|
|
338 | |
|
|
339 | unlink "$path.cfperl"; |
|
|
340 | }; |
|
|
341 | |
| 217 | *on_mapin = |
342 | *on_mapin = |
| 218 | *on_mapload = sub { |
343 | *on_mapload = sub { |
| 219 | my $map = shift->{map}; |
344 | my ($map) = @_; |
| 220 | |
345 | |
| 221 | my $path = $map->tmpname; |
346 | my $path = $map->tmpname; |
| 222 | $path = $map->path unless defined $path; |
347 | $path = $map->path unless defined $path; |
| 223 | |
348 | |
| 224 | open my $fh, "<:raw", "$path.cfperl" |
349 | open my $fh, "<:raw", "$path.cfperl" |
| … | |
… | |
| 231 | |
356 | |
| 232 | $map->_set_obs ($data->{obs}); |
357 | $map->_set_obs ($data->{obs}); |
| 233 | }; |
358 | }; |
| 234 | |
359 | |
| 235 | *on_mapout = sub { |
360 | *on_mapout = sub { |
| 236 | my $map = shift->{map}; |
361 | my ($map) = @_; |
| 237 | |
362 | |
| 238 | my $path = $map->tmpname; |
363 | my $path = $map->tmpname; |
| 239 | $path = $map->path unless defined $path; |
364 | $path = $map->path unless defined $path; |
| 240 | |
365 | |
| 241 | my $obs = $map->_get_obs; |
366 | my $obs = $map->_get_obs; |
| 242 | |
367 | |
| 243 | if (defined $obs) { |
368 | if (defined $obs) { |
| 244 | open my $fh, ">:raw", "$path.cfperl" |
369 | open my $fh, ">:raw", "$path.cfperl" |
| 245 | or die "$path.cfperl: $!"; |
370 | or die "$path.cfperl: $!"; |
| 246 | |
371 | |
|
|
372 | stat $path; |
|
|
373 | |
| 247 | print $fh Storable::nfreeze { |
374 | print $fh Storable::nfreeze { |
|
|
375 | size => (stat _)[7], |
|
|
376 | time => (stat _)[9], |
| 248 | version => 1, |
377 | version => 1, |
| 249 | obs => $obs, |
378 | obs => $obs, |
| 250 | }; |
379 | }; |
|
|
380 | |
|
|
381 | chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g* |
| 251 | } else { |
382 | } else { |
| 252 | unlink "$path.cfperl"; |
383 | unlink "$path.cfperl"; |
| 253 | } |
384 | } |
| 254 | }; |
385 | }; |
| 255 | |
386 | |
|
|
387 | ############################################################################# |
|
|
388 | # load/save perl data associated with player->ob objects |
|
|
389 | |
|
|
390 | sub all_objects(@) { |
|
|
391 | @_, map all_objects ($_->inv), @_ |
|
|
392 | } |
|
|
393 | |
|
|
394 | *on_player_load = sub { |
|
|
395 | my ($ob, $path) = @_; |
|
|
396 | |
|
|
397 | for my $o (all_objects $ob) { |
|
|
398 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
|
|
399 | $o->set_ob_key_value ("_perl_data"); |
|
|
400 | |
|
|
401 | %$o = %{ Storable::thaw pack "H*", $value }; |
|
|
402 | } |
|
|
403 | } |
|
|
404 | }; |
|
|
405 | |
|
|
406 | *on_player_save = sub { |
|
|
407 | my ($ob, $path) = @_; |
|
|
408 | |
|
|
409 | $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) |
|
|
410 | for grep %$_, all_objects $ob; |
|
|
411 | }; |
|
|
412 | |
|
|
413 | ############################################################################# |
|
|
414 | # core extensions - in perl |
|
|
415 | |
|
|
416 | my $delta_timer = Event->timer ( |
|
|
417 | parked => 1, |
|
|
418 | prio => Event::PRIO_HIGH, |
|
|
419 | cb => sub { Event::unloop (undef) }, |
|
|
420 | ); |
|
|
421 | |
|
|
422 | sub sleep_delta($) { |
|
|
423 | $delta_timer->at (Event::time + $_[0]); |
|
|
424 | $delta_timer->start; |
|
|
425 | Event::loop; |
|
|
426 | } |
|
|
427 | |
|
|
428 | =item cf::player::exists $login |
|
|
429 | |
|
|
430 | Returns true when the given account exists. |
|
|
431 | |
|
|
432 | =cut |
|
|
433 | |
|
|
434 | sub cf::player::exists($) { |
|
|
435 | cf::player::find $_[0] |
|
|
436 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
|
|
437 | } |
|
|
438 | |
|
|
439 | =item $player->reply ($npc, $msg[, $flags]) |
|
|
440 | |
|
|
441 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
|
|
442 | can be C<undef>. Does the right thing when the player is currently in a |
|
|
443 | dialogue with the given NPC character. |
|
|
444 | |
|
|
445 | =cut |
|
|
446 | |
|
|
447 | # rough implementation of a future "reply" method that works |
|
|
448 | # with dialog boxes. |
|
|
449 | sub cf::object::player::reply($$$;$) { |
|
|
450 | my ($self, $npc, $msg, $flags) = @_; |
|
|
451 | |
|
|
452 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
|
|
453 | |
|
|
454 | if ($self->{record_replies}) { |
|
|
455 | push @{ $self->{record_replies} }, [$npc, $msg, $flags]; |
|
|
456 | } else { |
|
|
457 | $msg = $npc->name . " says: $msg" if $npc; |
|
|
458 | $self->message ($msg, $flags); |
|
|
459 | } |
|
|
460 | } |
|
|
461 | |
|
|
462 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
463 | |
|
|
464 | Sends an ext reply to the player. |
|
|
465 | |
|
|
466 | =cut |
|
|
467 | |
|
|
468 | sub cf::player::ext_reply($$$%) { |
|
|
469 | my ($self, $id, %msg) = @_; |
|
|
470 | |
|
|
471 | $msg{msgid} = $id; |
|
|
472 | |
|
|
473 | $self->send ("ext " . to_json \%msg); |
|
|
474 | } |
|
|
475 | |
|
|
476 | ############################################################################# |
|
|
477 | # map scripting support |
|
|
478 | |
|
|
479 | our $safe = new Safe "ext"; |
|
|
480 | our $safe_hole = new Safe::Hole; |
|
|
481 | |
|
|
482 | $SIG{FPE} = 'IGNORE'; |
|
|
483 | |
|
|
484 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
|
|
485 | |
|
|
486 | # here we export the classes and methods available to script code |
|
|
487 | |
|
|
488 | for ( |
|
|
489 | ["cf::object" => qw(contr pay_amount pay_player)], |
|
|
490 | ["cf::object::player" => qw(player)], |
|
|
491 | ["cf::player" => qw(peaceful)], |
|
|
492 | ) { |
|
|
493 | no strict 'refs'; |
|
|
494 | my ($pkg, @funs) = @$_; |
|
|
495 | *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
|
|
496 | for @funs; |
|
|
497 | } |
|
|
498 | |
|
|
499 | sub safe_eval($;@) { |
|
|
500 | my ($code, %vars) = @_; |
|
|
501 | |
|
|
502 | my $qcode = $code; |
|
|
503 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
|
|
504 | $qcode =~ s/\n/\\n/g; |
|
|
505 | |
|
|
506 | local $_; |
|
|
507 | local @ext::cf::_safe_eval_args = values %vars; |
|
|
508 | |
|
|
509 | $code = |
|
|
510 | "do {\n" |
|
|
511 | . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" |
|
|
512 | . "#line 0 \"{$qcode}\"\n" |
|
|
513 | . $code |
|
|
514 | . "\n}" |
|
|
515 | ; |
|
|
516 | |
|
|
517 | sub_generation_inc; |
|
|
518 | my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); |
|
|
519 | sub_generation_inc; |
|
|
520 | |
|
|
521 | wantarray ? @res : $res[0] |
|
|
522 | } |
|
|
523 | |
|
|
524 | sub register_script_function { |
|
|
525 | my ($fun, $cb) = @_; |
|
|
526 | |
|
|
527 | no strict 'refs'; |
|
|
528 | *{"ext::$fun"} = $safe_hole->wrap ($cb); |
|
|
529 | } |
|
|
530 | |
|
|
531 | ############################################################################# |
|
|
532 | # initialisation |
|
|
533 | |
| 256 | register "<global>", __PACKAGE__; |
534 | register "<global>", __PACKAGE__; |
| 257 | |
535 | |
|
|
536 | unshift @INC, $LIBDIR; |
|
|
537 | |
| 258 | load_extensions; |
538 | load_extensions; |
| 259 | |
539 | |
| 260 | 1 |
540 | 1 |
| 261 | |
541 | |
