1 |
package cf; |
2 |
|
3 |
use Symbol; |
4 |
use List::Util; |
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 |
13 |
|
14 |
use strict; |
15 |
|
16 |
our %COMMAND; |
17 |
our @EVENT; |
18 |
our %PROP_TYPE; |
19 |
our %PROP_IDX; |
20 |
our $LIBDIR = maps_directory "perl"; |
21 |
|
22 |
BEGIN { |
23 |
@EVENT = map lc, @EVENT; |
24 |
|
25 |
*CORE::GLOBAL::warn = sub { |
26 |
my $msg = join "", @_; |
27 |
$msg .= "\n" |
28 |
unless $msg =~ /\n$/; |
29 |
|
30 |
print STDERR "cfperl: $msg"; |
31 |
LOG llevError, "cfperl: $msg"; |
32 |
}; |
33 |
} |
34 |
|
35 |
my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! |
36 |
|
37 |
# generate property mutators |
38 |
sub prop_gen { |
39 |
my ($prefix, $class) = @_; |
40 |
|
41 |
no strict 'refs'; |
42 |
|
43 |
for my $prop (keys %PROP_TYPE) { |
44 |
$prop =~ /^\Q$prefix\E_(.*$)/ or next; |
45 |
my $sub = lc $1; |
46 |
|
47 |
my $type = $PROP_TYPE{$prop}; |
48 |
my $idx = $PROP_IDX {$prop}; |
49 |
|
50 |
*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { |
51 |
$_[0]->get_property ($type, $idx) |
52 |
}; |
53 |
|
54 |
*{"$class\::set_$sub"} = sub { |
55 |
$_[0]->set_property ($type, $idx, $_[1]); |
56 |
} unless $ignore_set{$prop}; |
57 |
} |
58 |
} |
59 |
|
60 |
# auto-generate most of the API |
61 |
|
62 |
prop_gen OBJECT_PROP => "cf::object"; |
63 |
# CFAPI_OBJECT_ANIMATION? |
64 |
prop_gen PLAYER_PROP => "cf::object::player"; |
65 |
|
66 |
prop_gen MAP_PROP => "cf::map"; |
67 |
prop_gen ARCH_PROP => "cf::arch"; |
68 |
|
69 |
# guessed hierarchies |
70 |
|
71 |
@ext::cf::object::player::ISA = @cf::object::player::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 |
}; |
84 |
|
85 |
my %ext_pkg; |
86 |
my @exts; |
87 |
my @hook; |
88 |
my %command; |
89 |
my %extcmd; |
90 |
|
91 |
sub inject_event { |
92 |
my $extension = shift; |
93 |
my $event_code = shift; |
94 |
|
95 |
my $cb = $hook[$event_code]{$extension} |
96 |
or return; |
97 |
|
98 |
&$cb |
99 |
} |
100 |
|
101 |
sub inject_global_event { |
102 |
my $event = shift; |
103 |
|
104 |
my $cb = $hook[$event] |
105 |
or return; |
106 |
|
107 |
List::Util::max map &$_, values %$cb |
108 |
} |
109 |
|
110 |
sub inject_command { |
111 |
my ($name, $obj, $params) = @_; |
112 |
|
113 |
for my $cmd (@{ $command{$name} }) { |
114 |
$cmd->[1]->($obj, $params); |
115 |
} |
116 |
|
117 |
-1 |
118 |
} |
119 |
|
120 |
sub register_command { |
121 |
my ($name, $time, $cb) = @_; |
122 |
|
123 |
my $caller = caller; |
124 |
#warn "registering command '$name/$time' to '$caller'"; |
125 |
|
126 |
push @{ $command{$name} }, [$time, $cb, $caller]; |
127 |
$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
128 |
} |
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 |
|
139 |
sub register { |
140 |
my ($base, $pkg) = @_; |
141 |
|
142 |
for my $idx (0 .. $#EVENT) { |
143 |
if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { |
144 |
#warn "registering $EVENT[$idx] hook to '$pkg'\n"; |
145 |
$hook[$idx]{$base} = $ref; |
146 |
} |
147 |
} |
148 |
} |
149 |
|
150 |
sub load_extension { |
151 |
my ($path) = @_; |
152 |
|
153 |
$path =~ /([^\/\\]+)\.ext$/ or die "$path"; |
154 |
my $base = $1; |
155 |
my $pkg = $1; |
156 |
$pkg =~ s/[^[:word:]]/_/g; |
157 |
$pkg = "cf::ext::$pkg"; |
158 |
|
159 |
warn "loading '$path' into '$pkg'\n"; |
160 |
|
161 |
open my $fh, "<:utf8", $path |
162 |
or die "$path: $!"; |
163 |
|
164 |
my $source = |
165 |
"package $pkg; use strict; use utf8;\n" |
166 |
. "#line 1 \"$path\"\n{\n" |
167 |
. (do { local $/; <$fh> }) |
168 |
. "\n};\n1"; |
169 |
|
170 |
eval $source |
171 |
or die "$path: $@"; |
172 |
|
173 |
push @exts, $pkg; |
174 |
$ext_pkg{$base} = $pkg; |
175 |
|
176 |
# no strict 'refs'; |
177 |
# @{"$pkg\::ISA"} = ext::; |
178 |
|
179 |
register $base, $pkg; |
180 |
} |
181 |
|
182 |
sub unload_extension { |
183 |
my ($pkg) = @_; |
184 |
|
185 |
warn "removing extension $pkg\n"; |
186 |
|
187 |
# remove hooks |
188 |
for my $idx (0 .. $#EVENT) { |
189 |
delete $hook[$idx]{$pkg}; |
190 |
} |
191 |
|
192 |
# remove commands |
193 |
for my $name (keys %command) { |
194 |
my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
195 |
|
196 |
if (@cb) { |
197 |
$command{$name} = \@cb; |
198 |
$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
199 |
} else { |
200 |
delete $command{$name}; |
201 |
delete $COMMAND{"$name\000"}; |
202 |
} |
203 |
} |
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 |
|
217 |
Symbol::delete_package $pkg; |
218 |
} |
219 |
|
220 |
sub load_extensions { |
221 |
my $LIBDIR = maps_directory "perl"; |
222 |
|
223 |
for my $ext (<$LIBDIR/*.ext>) { |
224 |
next unless -r $ext; |
225 |
eval { |
226 |
load_extension $ext; |
227 |
1 |
228 |
} or warn "$ext not loaded: $@"; |
229 |
} |
230 |
} |
231 |
|
232 |
register_command "perl-reload", 0, sub { |
233 |
my ($who, $arg) = @_; |
234 |
|
235 |
if ($who->flag (FLAG_WIZ)) { |
236 |
$who->message ("reloading..."); |
237 |
|
238 |
warn "reloading...\n"; |
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 <$_>"); |
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" |
274 |
delete $INC{"cf.pm"}; |
275 |
|
276 |
# don't, removes xs symbols, too |
277 |
#Symbol::delete_package __PACKAGE__; |
278 |
|
279 |
# 7. reload cf.pm |
280 |
$who->message ("reloading cf.pm"); |
281 |
require cf; |
282 |
}; |
283 |
warn $@ if $@; |
284 |
$who->message ($@) if $@; |
285 |
warn "reloaded\n"; |
286 |
|
287 |
$who->message ("reloaded"); |
288 |
} else { |
289 |
$who->message ("Intruder Alert!"); |
290 |
} |
291 |
}; |
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 |
|
342 |
*on_mapin = |
343 |
*on_mapload = sub { |
344 |
my ($map) = @_; |
345 |
|
346 |
my $path = $map->tmpname; |
347 |
$path = $map->path unless defined $path; |
348 |
|
349 |
open my $fh, "<:raw", "$path.cfperl" |
350 |
or return; # no perl data |
351 |
|
352 |
my $data = Storable::thaw do { local $/; <$fh> }; |
353 |
|
354 |
$data->{version} <= 1 |
355 |
or return; # too new |
356 |
|
357 |
$map->_set_obs ($data->{obs}); |
358 |
}; |
359 |
|
360 |
*on_mapout = sub { |
361 |
my ($map) = @_; |
362 |
|
363 |
my $path = $map->tmpname; |
364 |
$path = $map->path unless defined $path; |
365 |
|
366 |
my $obs = $map->_get_obs; |
367 |
|
368 |
if (defined $obs) { |
369 |
open my $fh, ">:raw", "$path.cfperl" |
370 |
or die "$path.cfperl: $!"; |
371 |
|
372 |
stat $path; |
373 |
|
374 |
print $fh Storable::nfreeze { |
375 |
size => (stat _)[7], |
376 |
time => (stat _)[9], |
377 |
version => 1, |
378 |
obs => $obs, |
379 |
}; |
380 |
|
381 |
chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g* |
382 |
} else { |
383 |
unlink "$path.cfperl"; |
384 |
} |
385 |
}; |
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 |
=item cf::player::exists $login |
417 |
|
418 |
Returns true when the given account exists. |
419 |
|
420 |
=cut |
421 |
|
422 |
sub cf::player::exists($) { |
423 |
cf::player::find $_[0] |
424 |
or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
425 |
} |
426 |
|
427 |
=item $player->reply ($npc, $msg[, $flags]) |
428 |
|
429 |
Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
430 |
can be C<undef>. Does the right thing when the player is currently in a |
431 |
dialogue with the given NPC character. |
432 |
|
433 |
=cut |
434 |
|
435 |
# rough implementation of a future "reply" method that works |
436 |
# with dialog boxes. |
437 |
sub cf::object::player::reply($$$;$) { |
438 |
my ($self, $npc, $msg, $flags) = @_; |
439 |
|
440 |
$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
441 |
|
442 |
if ($self->{record_replies}) { |
443 |
push @{ $self->{record_replies} }, [$npc, $msg, $flags]; |
444 |
} else { |
445 |
$msg = $npc->name . " says: $msg" if $npc; |
446 |
$self->message ($msg, $flags); |
447 |
} |
448 |
} |
449 |
|
450 |
=item $player->ext_reply ($msgid, $msgtype, %msg) |
451 |
|
452 |
Sends an ext reply to the player. |
453 |
|
454 |
=cut |
455 |
|
456 |
sub cf::player::ext_reply($$$%) { |
457 |
my ($self, $id, %msg) = @_; |
458 |
|
459 |
$msg{msgid} = $id; |
460 |
|
461 |
$self->send ("ext " . to_json \%msg); |
462 |
} |
463 |
|
464 |
############################################################################# |
465 |
# map scripting support |
466 |
|
467 |
our $safe = new Safe "ext"; |
468 |
our $safe_hole = new Safe::Hole; |
469 |
|
470 |
$SIG{FPE} = 'IGNORE'; |
471 |
|
472 |
$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
473 |
|
474 |
# here we export the classes and methods available to script code |
475 |
|
476 |
for ( |
477 |
["cf::object" => qw(contr pay_amount pay_player)], |
478 |
["cf::object::player" => qw(player)], |
479 |
["cf::player" => qw(peaceful)], |
480 |
) { |
481 |
no strict 'refs'; |
482 |
my ($pkg, @funs) = @$_; |
483 |
*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
484 |
for @funs; |
485 |
} |
486 |
|
487 |
sub safe_eval($;@) { |
488 |
my ($code, %vars) = @_; |
489 |
|
490 |
my $qcode = $code; |
491 |
$qcode =~ s/"/‟/g; # not allowed in #line filenames |
492 |
$qcode =~ s/\n/\\n/g; |
493 |
|
494 |
local $_; |
495 |
local @ext::cf::_safe_eval_args = values %vars; |
496 |
|
497 |
$code = |
498 |
"do {\n" |
499 |
. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" |
500 |
. "#line 0 \"{$qcode}\"\n" |
501 |
. $code |
502 |
. "\n}" |
503 |
; |
504 |
|
505 |
sub_generation_inc; |
506 |
my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); |
507 |
sub_generation_inc; |
508 |
|
509 |
wantarray ? @res : $res[0] |
510 |
} |
511 |
|
512 |
sub register_script_function { |
513 |
my ($fun, $cb) = @_; |
514 |
|
515 |
no strict 'refs'; |
516 |
*{"ext::$fun"} = $safe_hole->wrap ($cb); |
517 |
} |
518 |
|
519 |
############################################################################# |
520 |
# the server's main() |
521 |
|
522 |
sub run { |
523 |
my $tick = MAX_TIME * 1e-6; |
524 |
my $next = Event::time; |
525 |
my $timer = Event->timer (at => $next, cb => sub { |
526 |
cf::server_tick; # one server iteration |
527 |
|
528 |
$next += $tick; |
529 |
my $NOW = Event::time; |
530 |
|
531 |
# if we are delayd by > 0.25 second, skip ticks |
532 |
$next = $NOW if $NOW >= $next + .25; |
533 |
|
534 |
$_[0]->w->at ($next); |
535 |
$_[0]->w->start; |
536 |
}); |
537 |
|
538 |
Event::loop; |
539 |
} |
540 |
|
541 |
############################################################################# |
542 |
# initialisation |
543 |
|
544 |
register "<global>", __PACKAGE__; |
545 |
|
546 |
unshift @INC, $LIBDIR; |
547 |
|
548 |
load_extensions; |
549 |
|
550 |
1 |
551 |
|