1 |
package cf; |
2 |
|
3 |
use utf8; |
4 |
use strict; |
5 |
|
6 |
use Symbol; |
7 |
use List::Util; |
8 |
use Storable; |
9 |
use Opcode; |
10 |
use Safe; |
11 |
use Safe::Hole; |
12 |
|
13 |
use Coro 3.4 (); |
14 |
use Coro::Event; |
15 |
use Coro::Timer; |
16 |
use Coro::Signal; |
17 |
use Coro::Semaphore; |
18 |
use Coro::AIO; |
19 |
|
20 |
use Data::Dumper; |
21 |
use Digest::MD5; |
22 |
use Fcntl; |
23 |
use IO::AIO 2.32 (); |
24 |
use YAML::Syck (); |
25 |
use Time::HiRes; |
26 |
|
27 |
use Event; $Event::Eval = 1; # no idea why this is required, but it is |
28 |
|
29 |
sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
30 |
|
31 |
# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
32 |
$YAML::Syck::ImplicitUnicode = 1; |
33 |
|
34 |
$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority |
35 |
|
36 |
our %COMMAND = (); |
37 |
our %COMMAND_TIME = (); |
38 |
|
39 |
our @EXTS = (); # list of extension package names |
40 |
our %EXTCMD = (); |
41 |
our %EXT_CORO = (); # coroutines bound to extensions |
42 |
our %EXT_MAP = (); # pluggable maps |
43 |
|
44 |
our @EVENT; |
45 |
our $LIBDIR = datadir . "/ext"; |
46 |
|
47 |
our $TICK = MAX_TIME * 1e-6; |
48 |
our $TICK_WATCHER; |
49 |
our $AIO_POLL_WATCHER; |
50 |
our $WRITE_RUNTIME_WATCHER; |
51 |
our $NEXT_TICK; |
52 |
our $NOW; |
53 |
|
54 |
our %CFG; |
55 |
|
56 |
our $UPTIME; $UPTIME ||= time; |
57 |
our $RUNTIME; |
58 |
|
59 |
our %PLAYER; # all users |
60 |
our %MAP; # all maps |
61 |
our $LINK_MAP; # the special {link} map, which is always available |
62 |
our $RANDOM_MAPS = cf::localdir . "/random"; |
63 |
|
64 |
our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal; |
65 |
our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal; |
66 |
|
67 |
# used to convert map paths into valid unix filenames by replacing / by ∕ |
68 |
our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons |
69 |
|
70 |
binmode STDOUT; |
71 |
binmode STDERR; |
72 |
|
73 |
# read virtual server time, if available |
74 |
unless ($RUNTIME || !-e cf::localdir . "/runtime") { |
75 |
open my $fh, "<", cf::localdir . "/runtime" |
76 |
or die "unable to read runtime file: $!"; |
77 |
$RUNTIME = <$fh> + 0.; |
78 |
} |
79 |
|
80 |
mkdir cf::localdir; |
81 |
mkdir cf::localdir . "/" . cf::playerdir; |
82 |
mkdir cf::localdir . "/" . cf::tmpdir; |
83 |
mkdir cf::localdir . "/" . cf::uniquedir; |
84 |
mkdir $RANDOM_MAPS; |
85 |
|
86 |
our $EMERGENCY_POSITION; |
87 |
|
88 |
############################################################################# |
89 |
|
90 |
=head2 GLOBAL VARIABLES |
91 |
|
92 |
=over 4 |
93 |
|
94 |
=item $cf::UPTIME |
95 |
|
96 |
The timestamp of the server start (so not actually an uptime). |
97 |
|
98 |
=item $cf::RUNTIME |
99 |
|
100 |
The time this server has run, starts at 0 and is increased by $cf::TICK on |
101 |
every server tick. |
102 |
|
103 |
=item $cf::LIBDIR |
104 |
|
105 |
The perl library directory, where extensions and cf-specific modules can |
106 |
be found. It will be added to C<@INC> automatically. |
107 |
|
108 |
=item $cf::NOW |
109 |
|
110 |
The time of the last (current) server tick. |
111 |
|
112 |
=item $cf::TICK |
113 |
|
114 |
The interval between server ticks, in seconds. |
115 |
|
116 |
=item %cf::CFG |
117 |
|
118 |
Configuration for the server, loaded from C</etc/crossfire/config>, or |
119 |
from wherever your confdir points to. |
120 |
|
121 |
=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE |
122 |
|
123 |
These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) |
124 |
or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick |
125 |
processing has been done. Call C<< ->wait >> on them to maximise the |
126 |
window of cpu time available, or simply to synchronise to the server tick. |
127 |
|
128 |
=back |
129 |
|
130 |
=cut |
131 |
|
132 |
BEGIN { |
133 |
*CORE::GLOBAL::warn = sub { |
134 |
my $msg = join "", @_; |
135 |
utf8::encode $msg; |
136 |
|
137 |
$msg .= "\n" |
138 |
unless $msg =~ /\n$/; |
139 |
|
140 |
LOG llevError, $msg; |
141 |
}; |
142 |
} |
143 |
|
144 |
@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
145 |
@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
146 |
@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
147 |
@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
148 |
@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
149 |
@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
150 |
|
151 |
# we bless all objects into (empty) derived classes to force a method lookup |
152 |
# within the Safe compartment. |
153 |
for my $pkg (qw( |
154 |
cf::global cf::attachable |
155 |
cf::object cf::object::player |
156 |
cf::client cf::player |
157 |
cf::arch cf::living |
158 |
cf::map cf::party cf::region |
159 |
)) { |
160 |
no strict 'refs'; |
161 |
@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
162 |
} |
163 |
|
164 |
$Event::DIED = sub { |
165 |
warn "error in event callback: @_"; |
166 |
}; |
167 |
|
168 |
=head2 UTILITY FUNCTIONS |
169 |
|
170 |
=over 4 |
171 |
|
172 |
=item dumpval $ref |
173 |
|
174 |
=cut |
175 |
|
176 |
sub dumpval { |
177 |
eval { |
178 |
local $SIG{__DIE__}; |
179 |
my $d; |
180 |
if (1) { |
181 |
$d = new Data::Dumper([$_[0]], ["*var"]); |
182 |
$d->Terse(1); |
183 |
$d->Indent(2); |
184 |
$d->Quotekeys(0); |
185 |
$d->Useqq(1); |
186 |
#$d->Bless(...); |
187 |
$d->Seen($_[1]) if @_ > 1; |
188 |
$d = $d->Dump(); |
189 |
} |
190 |
$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; |
191 |
$d |
192 |
} || "[unable to dump $_[0]: '$@']"; |
193 |
} |
194 |
|
195 |
use JSON::Syck (); # TODO# replace by JSON::PC once working |
196 |
|
197 |
=item $ref = cf::from_json $json |
198 |
|
199 |
Converts a JSON string into the corresponding perl data structure. |
200 |
|
201 |
=cut |
202 |
|
203 |
sub from_json($) { |
204 |
$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
205 |
JSON::Syck::Load $_[0] |
206 |
} |
207 |
|
208 |
=item $json = cf::to_json $ref |
209 |
|
210 |
Converts a perl data structure into its JSON representation. |
211 |
|
212 |
=cut |
213 |
|
214 |
sub to_json($) { |
215 |
$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
216 |
JSON::Syck::Dump $_[0] |
217 |
} |
218 |
|
219 |
=item cf::lock_wait $string |
220 |
|
221 |
Wait until the given lock is available. See cf::lock_acquire. |
222 |
|
223 |
=item my $lock = cf::lock_acquire $string |
224 |
|
225 |
Wait until the given lock is available and then acquires it and returns |
226 |
a Coro::guard object. If the guard object gets destroyed (goes out of scope, |
227 |
for example when the coroutine gets canceled), the lock is automatically |
228 |
returned. |
229 |
|
230 |
Lock names should begin with a unique identifier (for example, cf::map::find |
231 |
uses map_find and cf::map::load uses map_load). |
232 |
|
233 |
=cut |
234 |
|
235 |
our %LOCK; |
236 |
|
237 |
sub lock_wait($) { |
238 |
my ($key) = @_; |
239 |
|
240 |
# wait for lock, if any |
241 |
while ($LOCK{$key}) { |
242 |
push @{ $LOCK{$key} }, $Coro::current; |
243 |
Coro::schedule; |
244 |
} |
245 |
} |
246 |
|
247 |
sub lock_acquire($) { |
248 |
my ($key) = @_; |
249 |
|
250 |
# wait, to be sure we are not locked |
251 |
lock_wait $key; |
252 |
|
253 |
$LOCK{$key} = []; |
254 |
|
255 |
Coro::guard { |
256 |
# wake up all waiters, to be on the safe side |
257 |
$_->ready for @{ delete $LOCK{$key} }; |
258 |
} |
259 |
} |
260 |
|
261 |
sub freeze_mainloop { |
262 |
return unless $TICK_WATCHER->is_active; |
263 |
|
264 |
my $guard = Coro::guard { |
265 |
$TICK_WATCHER->start; |
266 |
$WRITE_RUNTIME_WATCHER->start; |
267 |
}; |
268 |
$WRITE_RUNTIME_WATCHER->stop; |
269 |
$TICK_WATCHER->stop; |
270 |
$guard |
271 |
} |
272 |
|
273 |
=item cf::async { BLOCK } |
274 |
|
275 |
Currently the same as Coro::async_pool, meaning you cannot use |
276 |
C<on_destroy>, C<join> or other gimmicks on these coroutines. The only |
277 |
thing you are allowed to do is call C<prio> on it. |
278 |
|
279 |
=cut |
280 |
|
281 |
BEGIN { *async = \&Coro::async_pool } |
282 |
|
283 |
=item cf::sync_job { BLOCK } |
284 |
|
285 |
The design of crossfire+ requires that the main coro ($Coro::main) is |
286 |
always able to handle events or runnable, as crossfire+ is only partly |
287 |
reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. |
288 |
|
289 |
If it must be done, put the blocking parts into C<sync_job>. This will run |
290 |
the given BLOCK in another coroutine while waiting for the result. The |
291 |
server will be frozen during this time, so the block should either finish |
292 |
fast or be very important. |
293 |
|
294 |
=cut |
295 |
|
296 |
sub sync_job(&) { |
297 |
my ($job) = @_; |
298 |
|
299 |
if ($Coro::current == $Coro::main) { |
300 |
# this is the main coro, too bad, we have to block |
301 |
# till the operation succeeds, freezing the server :/ |
302 |
|
303 |
# TODO: use suspend/resume instead |
304 |
# (but this is cancel-safe) |
305 |
my $freeze_guard = freeze_mainloop; |
306 |
|
307 |
my $busy = 1; |
308 |
my @res; |
309 |
|
310 |
(async { |
311 |
@res = eval { $job->() }; |
312 |
warn $@ if $@; |
313 |
undef $busy; |
314 |
})->prio (Coro::PRIO_MAX); |
315 |
|
316 |
while ($busy) { |
317 |
Coro::cede or Event::one_event; |
318 |
} |
319 |
|
320 |
wantarray ? @res : $res[0] |
321 |
} else { |
322 |
# we are in another coroutine, how wonderful, everything just works |
323 |
|
324 |
$job->() |
325 |
} |
326 |
} |
327 |
|
328 |
=item $coro = cf::async_ext { BLOCK } |
329 |
|
330 |
Like async, but this coro is automatically being canceled when the |
331 |
extension calling this is being unloaded. |
332 |
|
333 |
=cut |
334 |
|
335 |
sub async_ext(&) { |
336 |
my $cb = shift; |
337 |
|
338 |
my $coro = &Coro::async ($cb); |
339 |
|
340 |
$coro->on_destroy (sub { |
341 |
delete $EXT_CORO{$coro+0}; |
342 |
}); |
343 |
$EXT_CORO{$coro+0} = $coro; |
344 |
|
345 |
$coro |
346 |
} |
347 |
|
348 |
sub write_runtime { |
349 |
my $runtime = cf::localdir . "/runtime"; |
350 |
|
351 |
my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 |
352 |
or return; |
353 |
|
354 |
my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock |
355 |
(aio_write $fh, 0, (length $value), $value, 0) <= 0 |
356 |
and return; |
357 |
|
358 |
aio_fsync $fh |
359 |
and return; |
360 |
|
361 |
close $fh |
362 |
or return; |
363 |
|
364 |
aio_rename "$runtime~", $runtime |
365 |
and return; |
366 |
|
367 |
1 |
368 |
} |
369 |
|
370 |
=back |
371 |
|
372 |
=cut |
373 |
|
374 |
############################################################################# |
375 |
|
376 |
=head2 ATTACHABLE OBJECTS |
377 |
|
378 |
Many objects in crossfire are so-called attachable objects. That means you can |
379 |
attach callbacks/event handlers (a collection of which is called an "attachment") |
380 |
to it. All such attachable objects support the following methods. |
381 |
|
382 |
In the following description, CLASS can be any of C<global>, C<object> |
383 |
C<player>, C<client> or C<map> (i.e. the attachable objects in |
384 |
crossfire+). |
385 |
|
386 |
=over 4 |
387 |
|
388 |
=item $attachable->attach ($attachment, key => $value...) |
389 |
|
390 |
=item $attachable->detach ($attachment) |
391 |
|
392 |
Attach/detach a pre-registered attachment to a specific object and give it |
393 |
the specified key/value pairs as arguments. |
394 |
|
395 |
Example, attach a minesweeper attachment to the given object, making it a |
396 |
10x10 minesweeper game: |
397 |
|
398 |
$obj->attach (minesweeper => width => 10, height => 10); |
399 |
|
400 |
=item $bool = $attachable->attached ($name) |
401 |
|
402 |
Checks wether the named attachment is currently attached to the object. |
403 |
|
404 |
=item cf::CLASS->attach ... |
405 |
|
406 |
=item cf::CLASS->detach ... |
407 |
|
408 |
Define an anonymous attachment and attach it to all objects of the given |
409 |
CLASS. See the next function for an explanation of its arguments. |
410 |
|
411 |
You can attach to global events by using the C<cf::global> class. |
412 |
|
413 |
Example, log all player logins: |
414 |
|
415 |
cf::player->attach ( |
416 |
on_login => sub { |
417 |
my ($pl) = @_; |
418 |
... |
419 |
}, |
420 |
); |
421 |
|
422 |
Example, attach to the jeweler skill: |
423 |
|
424 |
cf::object->attach ( |
425 |
type => cf::SKILL, |
426 |
subtype => cf::SK_JEWELER, |
427 |
on_use_skill => sub { |
428 |
my ($sk, $ob, $part, $dir, $msg) = @_; |
429 |
... |
430 |
}, |
431 |
); |
432 |
|
433 |
=item cf::CLASS::attachment $name, ... |
434 |
|
435 |
Register an attachment by C<$name> through which attachable objects of the |
436 |
given CLASS can refer to this attachment. |
437 |
|
438 |
Some classes such as crossfire maps and objects can specify attachments |
439 |
that are attached at load/instantiate time, thus the need for a name. |
440 |
|
441 |
These calls expect any number of the following handler/hook descriptions: |
442 |
|
443 |
=over 4 |
444 |
|
445 |
=item prio => $number |
446 |
|
447 |
Set the priority for all following handlers/hooks (unless overwritten |
448 |
by another C<prio> setting). Lower priority handlers get executed |
449 |
earlier. The default priority is C<0>, and many built-in handlers are |
450 |
registered at priority C<-1000>, so lower priorities should not be used |
451 |
unless you know what you are doing. |
452 |
|
453 |
=item type => $type |
454 |
|
455 |
(Only for C<< cf::object->attach >> calls), limits the attachment to the |
456 |
given type of objects only (the additional parameter C<subtype> can be |
457 |
used to further limit to the given subtype). |
458 |
|
459 |
=item on_I<event> => \&cb |
460 |
|
461 |
Call the given code reference whenever the named event happens (event is |
462 |
something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
463 |
handlers are recognised generally depends on the type of object these |
464 |
handlers attach to). |
465 |
|
466 |
See F<include/eventinc.h> for the full list of events supported, and their |
467 |
class. |
468 |
|
469 |
=item package => package:: |
470 |
|
471 |
Look for sub functions of the name C<< on_I<event> >> in the given |
472 |
package and register them. Only handlers for eevents supported by the |
473 |
object/class are recognised. |
474 |
|
475 |
=back |
476 |
|
477 |
Example, define an attachment called "sockpuppet" that calls the given |
478 |
event handler when a monster attacks: |
479 |
|
480 |
cf::object::attachment sockpuppet => |
481 |
on_skill_attack => sub { |
482 |
my ($self, $victim) = @_; |
483 |
... |
484 |
} |
485 |
} |
486 |
|
487 |
=item $attachable->valid |
488 |
|
489 |
Just because you have a perl object does not mean that the corresponding |
490 |
C-level object still exists. If you try to access an object that has no |
491 |
valid C counterpart anymore you get an exception at runtime. This method |
492 |
can be used to test for existence of the C object part without causing an |
493 |
exception. |
494 |
|
495 |
=cut |
496 |
|
497 |
# the following variables are defined in .xs and must not be re-created |
498 |
our @CB_GLOBAL = (); # registry for all global events |
499 |
our @CB_ATTACHABLE = (); # registry for all attachables |
500 |
our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
501 |
our @CB_PLAYER = (); |
502 |
our @CB_CLIENT = (); |
503 |
our @CB_TYPE = (); # registry for type (cf-object class) based events |
504 |
our @CB_MAP = (); |
505 |
|
506 |
my %attachment; |
507 |
|
508 |
sub cf::attachable::thawer_merge { |
509 |
# simply override everything except _meta |
510 |
local $_[0]{_meta}; |
511 |
%{$_[0]} = %{$_[1]}; |
512 |
} |
513 |
|
514 |
sub _attach_cb($$$$) { |
515 |
my ($registry, $event, $prio, $cb) = @_; |
516 |
|
517 |
use sort 'stable'; |
518 |
|
519 |
$cb = [$prio, $cb]; |
520 |
|
521 |
@{$registry->[$event]} = sort |
522 |
{ $a->[0] cmp $b->[0] } |
523 |
@{$registry->[$event] || []}, $cb; |
524 |
} |
525 |
|
526 |
# hack |
527 |
my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP; |
528 |
|
529 |
# attach handles attaching event callbacks |
530 |
# the only thing the caller has to do is pass the correct |
531 |
# registry (== where the callback attaches to). |
532 |
sub _attach { |
533 |
my ($registry, $klass, @arg) = @_; |
534 |
|
535 |
my $object_type; |
536 |
my $prio = 0; |
537 |
my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
538 |
|
539 |
#TODO: get rid of this hack |
540 |
if ($attachable_klass{$klass}) { |
541 |
%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT); |
542 |
} |
543 |
|
544 |
while (@arg) { |
545 |
my $type = shift @arg; |
546 |
|
547 |
if ($type eq "prio") { |
548 |
$prio = shift @arg; |
549 |
|
550 |
} elsif ($type eq "type") { |
551 |
$object_type = shift @arg; |
552 |
$registry = $CB_TYPE[$object_type] ||= []; |
553 |
|
554 |
} elsif ($type eq "subtype") { |
555 |
defined $object_type or Carp::croak "subtype specified without type"; |
556 |
my $object_subtype = shift @arg; |
557 |
$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
558 |
|
559 |
} elsif ($type eq "package") { |
560 |
my $pkg = shift @arg; |
561 |
|
562 |
while (my ($name, $id) = each %cb_id) { |
563 |
if (my $cb = $pkg->can ($name)) { |
564 |
_attach_cb $registry, $id, $prio, $cb; |
565 |
} |
566 |
} |
567 |
|
568 |
} elsif (exists $cb_id{$type}) { |
569 |
_attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
570 |
|
571 |
} elsif (ref $type) { |
572 |
warn "attaching objects not supported, ignoring.\n"; |
573 |
|
574 |
} else { |
575 |
shift @arg; |
576 |
warn "attach argument '$type' not supported, ignoring.\n"; |
577 |
} |
578 |
} |
579 |
} |
580 |
|
581 |
sub _object_attach { |
582 |
my ($obj, $name, %arg) = @_; |
583 |
|
584 |
return if exists $obj->{_attachment}{$name}; |
585 |
|
586 |
if (my $attach = $attachment{$name}) { |
587 |
my $registry = $obj->registry; |
588 |
|
589 |
for (@$attach) { |
590 |
my ($klass, @attach) = @$_; |
591 |
_attach $registry, $klass, @attach; |
592 |
} |
593 |
|
594 |
$obj->{$name} = \%arg; |
595 |
} else { |
596 |
warn "object uses attachment '$name' that is not available, postponing.\n"; |
597 |
} |
598 |
|
599 |
$obj->{_attachment}{$name} = undef; |
600 |
} |
601 |
|
602 |
sub cf::attachable::attach { |
603 |
if (ref $_[0]) { |
604 |
_object_attach @_; |
605 |
} else { |
606 |
_attach shift->_attach_registry, @_; |
607 |
} |
608 |
}; |
609 |
|
610 |
# all those should be optimised |
611 |
sub cf::attachable::detach { |
612 |
my ($obj, $name) = @_; |
613 |
|
614 |
if (ref $obj) { |
615 |
delete $obj->{_attachment}{$name}; |
616 |
reattach ($obj); |
617 |
} else { |
618 |
Carp::croak "cannot, currently, detach class attachments"; |
619 |
} |
620 |
}; |
621 |
|
622 |
sub cf::attachable::attached { |
623 |
my ($obj, $name) = @_; |
624 |
|
625 |
exists $obj->{_attachment}{$name} |
626 |
} |
627 |
|
628 |
for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) { |
629 |
eval "#line " . __LINE__ . " 'cf.pm' |
630 |
sub cf::\L$klass\E::_attach_registry { |
631 |
(\\\@CB_$klass, KLASS_$klass) |
632 |
} |
633 |
|
634 |
sub cf::\L$klass\E::attachment { |
635 |
my \$name = shift; |
636 |
|
637 |
\$attachment{\$name} = [[KLASS_$klass, \@_]]; |
638 |
} |
639 |
"; |
640 |
die if $@; |
641 |
} |
642 |
|
643 |
our $override; |
644 |
our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
645 |
|
646 |
sub override { |
647 |
$override = 1; |
648 |
@invoke_results = (); |
649 |
} |
650 |
|
651 |
sub do_invoke { |
652 |
my $event = shift; |
653 |
my $callbacks = shift; |
654 |
|
655 |
@invoke_results = (); |
656 |
|
657 |
local $override; |
658 |
|
659 |
for (@$callbacks) { |
660 |
eval { &{$_->[1]} }; |
661 |
|
662 |
if ($@) { |
663 |
warn "$@"; |
664 |
warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
665 |
override; |
666 |
} |
667 |
|
668 |
return 1 if $override; |
669 |
} |
670 |
|
671 |
0 |
672 |
} |
673 |
|
674 |
=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) |
675 |
|
676 |
=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) |
677 |
|
678 |
Generate an object-specific event with the given arguments. |
679 |
|
680 |
This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be |
681 |
removed in future versions), and there is no public API to access override |
682 |
results (if you must, access C<@cf::invoke_results> directly). |
683 |
|
684 |
=back |
685 |
|
686 |
=cut |
687 |
|
688 |
############################################################################# |
689 |
# object support |
690 |
|
691 |
sub reattach { |
692 |
# basically do the same as instantiate, without calling instantiate |
693 |
my ($obj) = @_; |
694 |
|
695 |
bless $obj, ref $obj; # re-bless in case extensions have been reloaded |
696 |
|
697 |
my $registry = $obj->registry; |
698 |
|
699 |
@$registry = (); |
700 |
|
701 |
delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
702 |
|
703 |
for my $name (keys %{ $obj->{_attachment} || {} }) { |
704 |
if (my $attach = $attachment{$name}) { |
705 |
for (@$attach) { |
706 |
my ($klass, @attach) = @$_; |
707 |
_attach $registry, $klass, @attach; |
708 |
} |
709 |
} else { |
710 |
warn "object uses attachment '$name' that is not available, postponing.\n"; |
711 |
} |
712 |
} |
713 |
} |
714 |
|
715 |
cf::attachable->attach ( |
716 |
prio => -1000000, |
717 |
on_instantiate => sub { |
718 |
my ($obj, $data) = @_; |
719 |
|
720 |
$data = from_json $data; |
721 |
|
722 |
for (@$data) { |
723 |
my ($name, $args) = @$_; |
724 |
|
725 |
$obj->attach ($name, %{$args || {} }); |
726 |
} |
727 |
}, |
728 |
on_reattach => \&reattach, |
729 |
on_clone => sub { |
730 |
my ($src, $dst) = @_; |
731 |
|
732 |
@{$dst->registry} = @{$src->registry}; |
733 |
|
734 |
%$dst = %$src; |
735 |
|
736 |
%{$dst->{_attachment}} = %{$src->{_attachment}} |
737 |
if exists $src->{_attachment}; |
738 |
}, |
739 |
); |
740 |
|
741 |
sub object_freezer_save { |
742 |
my ($filename, $rdata, $objs) = @_; |
743 |
|
744 |
sync_job { |
745 |
if (length $$rdata) { |
746 |
warn sprintf "saving %s (%d,%d)\n", |
747 |
$filename, length $$rdata, scalar @$objs; |
748 |
|
749 |
if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { |
750 |
chmod SAVE_MODE, $fh; |
751 |
aio_write $fh, 0, (length $$rdata), $$rdata, 0; |
752 |
aio_fsync $fh; |
753 |
close $fh; |
754 |
|
755 |
if (@$objs) { |
756 |
if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { |
757 |
chmod SAVE_MODE, $fh; |
758 |
my $data = Storable::nfreeze { version => 1, objs => $objs }; |
759 |
aio_write $fh, 0, (length $data), $data, 0; |
760 |
aio_fsync $fh; |
761 |
close $fh; |
762 |
aio_rename "$filename.pst~", "$filename.pst"; |
763 |
} |
764 |
} else { |
765 |
aio_unlink "$filename.pst"; |
766 |
} |
767 |
|
768 |
aio_rename "$filename~", $filename; |
769 |
} else { |
770 |
warn "FATAL: $filename~: $!\n"; |
771 |
} |
772 |
} else { |
773 |
aio_unlink $filename; |
774 |
aio_unlink "$filename.pst"; |
775 |
} |
776 |
} |
777 |
} |
778 |
|
779 |
sub object_freezer_as_string { |
780 |
my ($rdata, $objs) = @_; |
781 |
|
782 |
use Data::Dumper; |
783 |
|
784 |
$$rdata . Dumper $objs |
785 |
} |
786 |
|
787 |
sub object_thawer_load { |
788 |
my ($filename) = @_; |
789 |
|
790 |
my ($data, $av); |
791 |
|
792 |
(aio_load $filename, $data) >= 0 |
793 |
or return; |
794 |
|
795 |
unless (aio_stat "$filename.pst") { |
796 |
(aio_load "$filename.pst", $av) >= 0 |
797 |
or return; |
798 |
$av = eval { (Storable::thaw $av)->{objs} }; |
799 |
} |
800 |
|
801 |
warn sprintf "loading %s (%d)\n", |
802 |
$filename, length $data, scalar @{$av || []};#d# |
803 |
return ($data, $av); |
804 |
} |
805 |
|
806 |
############################################################################# |
807 |
# command handling &c |
808 |
|
809 |
=item cf::register_command $name => \&callback($ob,$args); |
810 |
|
811 |
Register a callback for execution when the client sends the user command |
812 |
$name. |
813 |
|
814 |
=cut |
815 |
|
816 |
sub register_command { |
817 |
my ($name, $cb) = @_; |
818 |
|
819 |
my $caller = caller; |
820 |
#warn "registering command '$name/$time' to '$caller'"; |
821 |
|
822 |
push @{ $COMMAND{$name} }, [$caller, $cb]; |
823 |
} |
824 |
|
825 |
=item cf::register_extcmd $name => \&callback($pl,$packet); |
826 |
|
827 |
Register a callbackf ro execution when the client sends an extcmd packet. |
828 |
|
829 |
If the callback returns something, it is sent back as if reply was being |
830 |
called. |
831 |
|
832 |
=cut |
833 |
|
834 |
sub register_extcmd { |
835 |
my ($name, $cb) = @_; |
836 |
|
837 |
$EXTCMD{$name} = $cb; |
838 |
} |
839 |
|
840 |
cf::player->attach ( |
841 |
on_command => sub { |
842 |
my ($pl, $name, $params) = @_; |
843 |
|
844 |
my $cb = $COMMAND{$name} |
845 |
or return; |
846 |
|
847 |
for my $cmd (@$cb) { |
848 |
$cmd->[1]->($pl->ob, $params); |
849 |
} |
850 |
|
851 |
cf::override; |
852 |
}, |
853 |
on_extcmd => sub { |
854 |
my ($pl, $buf) = @_; |
855 |
|
856 |
my $msg = eval { from_json $buf }; |
857 |
|
858 |
if (ref $msg) { |
859 |
if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
860 |
if (my %reply = $cb->($pl, $msg)) { |
861 |
$pl->ext_reply ($msg->{msgid}, %reply); |
862 |
} |
863 |
} |
864 |
} else { |
865 |
warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
866 |
} |
867 |
|
868 |
cf::override; |
869 |
}, |
870 |
); |
871 |
|
872 |
sub load_extension { |
873 |
my ($path) = @_; |
874 |
|
875 |
$path =~ /([^\/\\]+)\.ext$/ or die "$path"; |
876 |
my $base = $1; |
877 |
my $pkg = $1; |
878 |
$pkg =~ s/[^[:word:]]/_/g; |
879 |
$pkg = "ext::$pkg"; |
880 |
|
881 |
warn "... loading '$path' into '$pkg'\n"; |
882 |
|
883 |
open my $fh, "<:utf8", $path |
884 |
or die "$path: $!"; |
885 |
|
886 |
my $source = |
887 |
"package $pkg; use strict; use utf8;\n" |
888 |
. "#line 1 \"$path\"\n{\n" |
889 |
. (do { local $/; <$fh> }) |
890 |
. "\n};\n1"; |
891 |
|
892 |
unless (eval $source) { |
893 |
my $msg = $@ ? "$path: $@\n" |
894 |
: "extension disabled.\n"; |
895 |
if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match |
896 |
warn $@; |
897 |
warn "mandatory extension failed to load, exiting.\n"; |
898 |
exit 1; |
899 |
} |
900 |
die $@; |
901 |
} |
902 |
|
903 |
push @EXTS, $pkg; |
904 |
} |
905 |
|
906 |
sub load_extensions { |
907 |
for my $ext (<$LIBDIR/*.ext>) { |
908 |
next unless -r $ext; |
909 |
eval { |
910 |
load_extension $ext; |
911 |
1 |
912 |
} or warn "$ext not loaded: $@"; |
913 |
} |
914 |
} |
915 |
|
916 |
############################################################################# |
917 |
|
918 |
=head2 CORE EXTENSIONS |
919 |
|
920 |
Functions and methods that extend core crossfire objects. |
921 |
|
922 |
=cut |
923 |
|
924 |
package cf::player; |
925 |
|
926 |
use Coro::AIO; |
927 |
|
928 |
=head3 cf::player |
929 |
|
930 |
=over 4 |
931 |
|
932 |
=item cf::player::find $login |
933 |
|
934 |
Returns the given player object, loading it if necessary (might block). |
935 |
|
936 |
=cut |
937 |
|
938 |
sub playerdir($) { |
939 |
cf::localdir |
940 |
. "/" |
941 |
. cf::playerdir |
942 |
. "/" |
943 |
. (ref $_[0] ? $_[0]->ob->name : $_[0]) |
944 |
} |
945 |
|
946 |
sub path($) { |
947 |
my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; |
948 |
|
949 |
(playerdir $login) . "/$login.pl" |
950 |
} |
951 |
|
952 |
sub find_active($) { |
953 |
$cf::PLAYER{$_[0]} |
954 |
and $cf::PLAYER{$_[0]}->active |
955 |
and $cf::PLAYER{$_[0]} |
956 |
} |
957 |
|
958 |
sub exists($) { |
959 |
my ($login) = @_; |
960 |
|
961 |
$cf::PLAYER{$login} |
962 |
or cf::sync_job { !aio_stat $login } |
963 |
} |
964 |
|
965 |
sub find($) { |
966 |
return $cf::PLAYER{$_[0]} || do { |
967 |
my $login = $_[0]; |
968 |
|
969 |
my $guard = cf::lock_acquire "user_find:$login"; |
970 |
|
971 |
$cf::PLAYER{$_[0]} || do { |
972 |
my $pl = load_pl path $login |
973 |
or return; |
974 |
$cf::PLAYER{$login} = $pl |
975 |
} |
976 |
} |
977 |
} |
978 |
|
979 |
sub save($) { |
980 |
my ($pl) = @_; |
981 |
|
982 |
return if $pl->{deny_save}; |
983 |
|
984 |
my $path = path $pl; |
985 |
my $guard = cf::lock_acquire "user_save:$path"; |
986 |
|
987 |
return if $pl->{deny_save}; |
988 |
|
989 |
aio_mkdir playerdir $pl, 0770; |
990 |
$pl->{last_save} = $cf::RUNTIME; |
991 |
|
992 |
$pl->save_pl ($path); |
993 |
Coro::cede; |
994 |
} |
995 |
|
996 |
sub new($) { |
997 |
my ($login) = @_; |
998 |
|
999 |
my $self = create; |
1000 |
|
1001 |
$self->ob->name ($login); |
1002 |
$self->{deny_save} = 1; |
1003 |
|
1004 |
$cf::PLAYER{$login} = $self; |
1005 |
|
1006 |
$self |
1007 |
} |
1008 |
|
1009 |
=item $pl->quit_character |
1010 |
|
1011 |
Nukes the player without looking back. If logged in, the connection will |
1012 |
be destroyed. May block for a long time. |
1013 |
|
1014 |
=cut |
1015 |
|
1016 |
sub quit_character { |
1017 |
my ($pl) = @_; |
1018 |
|
1019 |
$pl->{deny_save} = 1; |
1020 |
$pl->password ("*"); # this should lock out the player until we nuked the dir |
1021 |
|
1022 |
$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; |
1023 |
$pl->deactivate; |
1024 |
$pl->invoke (cf::EVENT_PLAYER_QUIT); |
1025 |
$pl->ns->destroy if $pl->ns; |
1026 |
|
1027 |
my $path = playerdir $pl; |
1028 |
my $temp = "$path~$cf::RUNTIME~deleting~"; |
1029 |
aio_rename $path, $temp; |
1030 |
delete $cf::PLAYER{$pl->ob->name}; |
1031 |
$pl->destroy; |
1032 |
IO::AIO::aio_rmtree $temp; |
1033 |
} |
1034 |
|
1035 |
=item cf::player::list_logins |
1036 |
|
1037 |
Returns am arrayref of all valid playernames in the system, can take a |
1038 |
while and may block, so not sync_job-capable, ever. |
1039 |
|
1040 |
=cut |
1041 |
|
1042 |
sub list_logins { |
1043 |
my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir |
1044 |
or return []; |
1045 |
|
1046 |
my @logins; |
1047 |
|
1048 |
for my $login (@$dirs) { |
1049 |
my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; |
1050 |
aio_read $fh, 0, 512, my $buf, 0 or next; |
1051 |
$buf !~ /^password -------------$/m or next; # official not-valid tag |
1052 |
|
1053 |
utf8::decode $login; |
1054 |
push @logins, $login; |
1055 |
} |
1056 |
|
1057 |
\@logins |
1058 |
} |
1059 |
|
1060 |
=item $player->maps |
1061 |
|
1062 |
Returns an arrayref of map paths that are private for this |
1063 |
player. May block. |
1064 |
|
1065 |
=cut |
1066 |
|
1067 |
sub maps($) { |
1068 |
my ($pl) = @_; |
1069 |
|
1070 |
my $files = aio_readdir playerdir $pl |
1071 |
or return; |
1072 |
|
1073 |
my @paths; |
1074 |
|
1075 |
for (@$files) { |
1076 |
utf8::decode $_; |
1077 |
next if /\.(?:pl|pst)$/; |
1078 |
next unless /^$PATH_SEP/o; |
1079 |
|
1080 |
s/\.map$//; |
1081 |
push @paths, "~" . $pl->ob->name . "/" . $_; |
1082 |
} |
1083 |
|
1084 |
\@paths |
1085 |
} |
1086 |
|
1087 |
=item $player->ext_reply ($msgid, $msgtype, %msg) |
1088 |
|
1089 |
Sends an ext reply to the player. |
1090 |
|
1091 |
=cut |
1092 |
|
1093 |
sub ext_reply($$$%) { |
1094 |
my ($self, $id, %msg) = @_; |
1095 |
|
1096 |
$msg{msgid} = $id; |
1097 |
|
1098 |
$self->send ("ext " . cf::to_json \%msg); |
1099 |
} |
1100 |
|
1101 |
package cf; |
1102 |
|
1103 |
=back |
1104 |
|
1105 |
|
1106 |
=head3 cf::map |
1107 |
|
1108 |
=over 4 |
1109 |
|
1110 |
=cut |
1111 |
|
1112 |
package cf::map; |
1113 |
|
1114 |
use Fcntl; |
1115 |
use Coro::AIO; |
1116 |
|
1117 |
use overload |
1118 |
'""' => \&as_string, |
1119 |
fallback => 1; |
1120 |
|
1121 |
our $MAX_RESET = 3600; |
1122 |
our $DEFAULT_RESET = 3000; |
1123 |
|
1124 |
sub generate_random_map { |
1125 |
my ($self, $rmp) = @_; |
1126 |
# mit "rum" bekleckern, nicht |
1127 |
$self->_create_random_map ( |
1128 |
$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, |
1129 |
$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, |
1130 |
$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, |
1131 |
$rmp->{exit_on_final_map}, |
1132 |
$rmp->{xsize}, $rmp->{ysize}, |
1133 |
$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, |
1134 |
$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, |
1135 |
$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, |
1136 |
$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, |
1137 |
$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, |
1138 |
(cf::region::find $rmp->{region}), $rmp->{custom} |
1139 |
) |
1140 |
} |
1141 |
|
1142 |
sub register { |
1143 |
my (undef, $regex) = @_; |
1144 |
my $pkg = caller; |
1145 |
|
1146 |
no strict; |
1147 |
push @{"$pkg\::ISA"}, __PACKAGE__; |
1148 |
|
1149 |
$EXT_MAP{$pkg} = qr<$regex>; |
1150 |
} |
1151 |
|
1152 |
# also paths starting with '/' |
1153 |
$EXT_MAP{"cf::map"} = qr{^(?=/)}; |
1154 |
|
1155 |
sub thawer_merge { |
1156 |
my ($self, $merge) = @_; |
1157 |
|
1158 |
# we have to keep some variables in memory intact |
1159 |
local $self->{path}; |
1160 |
local $self->{load_path}; |
1161 |
local $self->{deny_save}; |
1162 |
local $self->{deny_reset}; |
1163 |
|
1164 |
$self->SUPER::thawer_merge ($merge); |
1165 |
} |
1166 |
|
1167 |
sub normalise { |
1168 |
my ($path, $base) = @_; |
1169 |
|
1170 |
# map plan: |
1171 |
# |
1172 |
# /! non-realised random map exit (special hack!) |
1173 |
# {... are special paths that are not being touched |
1174 |
# ?xxx/... are special absolute paths |
1175 |
# ?random/... random maps |
1176 |
# /... normal maps |
1177 |
# ~user/... per-player map of a specific user |
1178 |
|
1179 |
$path =~ s/$PATH_SEP/\//go; |
1180 |
|
1181 |
# treat it as relative path if it starts with |
1182 |
# something that looks reasonable |
1183 |
if ($path =~ m{^(?:\./|\.\./|\w)}) { |
1184 |
$base or Carp::carp "normalise called with relative path and no base: '$path'"; |
1185 |
|
1186 |
$base =~ s{[^/]+/?$}{}; |
1187 |
$path = "$base/$path"; |
1188 |
} |
1189 |
|
1190 |
for ($path) { |
1191 |
redo if s{//}{/}; |
1192 |
redo if s{/\.?/}{/}; |
1193 |
redo if s{/[^/]+/\.\./}{/}; |
1194 |
} |
1195 |
|
1196 |
$path |
1197 |
} |
1198 |
|
1199 |
sub new_from_path { |
1200 |
my (undef, $path, $base) = @_; |
1201 |
|
1202 |
return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object |
1203 |
|
1204 |
$path = normalise $path, $base; |
1205 |
|
1206 |
for my $pkg (keys %EXT_MAP) { |
1207 |
if ($path =~ $EXT_MAP{$pkg}) { |
1208 |
my $self = bless cf::map::new, $pkg; |
1209 |
$self->{path} = $path; $self->path ($path); |
1210 |
$self->init; # pass $1 etc. |
1211 |
return $self; |
1212 |
} |
1213 |
} |
1214 |
|
1215 |
Carp::carp "unable to resolve path '$path'."; |
1216 |
() |
1217 |
} |
1218 |
|
1219 |
sub init { |
1220 |
my ($self) = @_; |
1221 |
|
1222 |
$self |
1223 |
} |
1224 |
|
1225 |
sub as_string { |
1226 |
my ($self) = @_; |
1227 |
|
1228 |
"$self->{path}" |
1229 |
} |
1230 |
|
1231 |
# the displayed name, this is a one way mapping |
1232 |
sub visible_name { |
1233 |
&as_string |
1234 |
} |
1235 |
|
1236 |
# the original (read-only) location |
1237 |
sub load_path { |
1238 |
my ($self) = @_; |
1239 |
|
1240 |
sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} |
1241 |
} |
1242 |
|
1243 |
# the temporary/swap location |
1244 |
sub save_path { |
1245 |
my ($self) = @_; |
1246 |
|
1247 |
(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; |
1248 |
sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path |
1249 |
} |
1250 |
|
1251 |
# the unique path, undef == no special unique path |
1252 |
sub uniq_path { |
1253 |
my ($self) = @_; |
1254 |
|
1255 |
(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; |
1256 |
sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path |
1257 |
} |
1258 |
|
1259 |
# and all this just because we cannot iterate over |
1260 |
# all maps in C++... |
1261 |
sub change_all_map_light { |
1262 |
my ($change) = @_; |
1263 |
|
1264 |
$_->change_map_light ($change) |
1265 |
for grep $_->outdoor, values %cf::MAP; |
1266 |
} |
1267 |
|
1268 |
sub unlink_save { |
1269 |
my ($self) = @_; |
1270 |
|
1271 |
utf8::encode (my $save = $self->save_path); |
1272 |
IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; |
1273 |
IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; |
1274 |
} |
1275 |
|
1276 |
sub load_header_from($) { |
1277 |
my ($self, $path) = @_; |
1278 |
|
1279 |
utf8::encode $path; |
1280 |
aio_open $path, O_RDONLY, 0 |
1281 |
or return; |
1282 |
|
1283 |
$self->_load_header ($path) |
1284 |
or return; |
1285 |
|
1286 |
$self->{load_path} = $path; |
1287 |
|
1288 |
1 |
1289 |
} |
1290 |
|
1291 |
sub load_orig { |
1292 |
my ($self) = @_; |
1293 |
|
1294 |
$self->load_header_from ($self->load_path) |
1295 |
} |
1296 |
|
1297 |
sub load_temp { |
1298 |
my ($self) = @_; |
1299 |
|
1300 |
$self->load_header_from ($self->save_path) |
1301 |
} |
1302 |
|
1303 |
sub load_header { |
1304 |
my ($self) = @_; |
1305 |
|
1306 |
if ($self->load_temp) { |
1307 |
$self->last_access ((delete $self->{last_access}) |
1308 |
|| $cf::RUNTIME); #d# |
1309 |
# safety |
1310 |
$self->{instantiate_time} = $cf::RUNTIME |
1311 |
if $self->{instantiate_time} > $cf::RUNTIME; |
1312 |
} else { |
1313 |
$self->load_orig |
1314 |
or return; |
1315 |
|
1316 |
$self->{load_original} = 1; |
1317 |
$self->{instantiate_time} = $cf::RUNTIME; |
1318 |
$self->last_access ($cf::RUNTIME); |
1319 |
$self->instantiate; |
1320 |
} |
1321 |
|
1322 |
1 |
1323 |
} |
1324 |
|
1325 |
sub find; |
1326 |
sub find { |
1327 |
my ($path, $origin) = @_; |
1328 |
|
1329 |
$path = normalise $path, $origin && $origin->path; |
1330 |
|
1331 |
cf::lock_wait "map_find:$path"; |
1332 |
|
1333 |
$cf::MAP{$path} || do { |
1334 |
my $guard = cf::lock_acquire "map_find:$path"; |
1335 |
my $map = new_from_path cf::map $path |
1336 |
or return; |
1337 |
|
1338 |
$map->{last_save} = $cf::RUNTIME; |
1339 |
|
1340 |
$map->load_header |
1341 |
or return; |
1342 |
|
1343 |
if ($map->should_reset) { |
1344 |
$cf::WAIT_FOR_TICK->wait; |
1345 |
$map->reset; |
1346 |
undef $guard; |
1347 |
$map = find $path |
1348 |
or return; |
1349 |
} |
1350 |
|
1351 |
$cf::MAP{$path} = $map |
1352 |
} |
1353 |
} |
1354 |
|
1355 |
sub load { |
1356 |
my ($self) = @_; |
1357 |
|
1358 |
my $path = $self->{path}; |
1359 |
my $guard = cf::lock_acquire "map_load:$path"; |
1360 |
|
1361 |
return if $self->in_memory != cf::MAP_SWAPPED; |
1362 |
|
1363 |
$self->in_memory (cf::MAP_LOADING); |
1364 |
|
1365 |
$self->alloc; |
1366 |
$self->_load_objects ($self->{load_path}, 1) |
1367 |
or return; |
1368 |
|
1369 |
$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) |
1370 |
if delete $self->{load_original}; |
1371 |
|
1372 |
if (my $uniq = $self->uniq_path) { |
1373 |
utf8::encode $uniq; |
1374 |
if (aio_open $uniq, O_RDONLY, 0) { |
1375 |
$self->clear_unique_items; |
1376 |
$self->_load_objects ($uniq, 0); |
1377 |
} |
1378 |
} |
1379 |
|
1380 |
Coro::cede; |
1381 |
|
1382 |
# now do the right thing for maps |
1383 |
$self->link_multipart_objects; |
1384 |
|
1385 |
unless ($self->{deny_activate}) { |
1386 |
$self->decay_objects; |
1387 |
$self->fix_auto_apply; |
1388 |
$self->update_buttons; |
1389 |
Coro::cede; |
1390 |
$self->set_darkness_map; |
1391 |
$self->difficulty ($self->estimate_difficulty) |
1392 |
unless $self->difficulty; |
1393 |
Coro::cede; |
1394 |
$self->activate; |
1395 |
} |
1396 |
|
1397 |
$self->in_memory (cf::MAP_IN_MEMORY); |
1398 |
} |
1399 |
|
1400 |
sub customise_for { |
1401 |
my ($self, $ob) = @_; |
1402 |
|
1403 |
return find "~" . $ob->name . "/" . $self->{path} |
1404 |
if $self->per_player; |
1405 |
|
1406 |
$self |
1407 |
} |
1408 |
|
1409 |
# find and load all maps in the 3x3 area around a map |
1410 |
sub load_diag { |
1411 |
my ($map) = @_; |
1412 |
|
1413 |
my @diag; # diagonal neighbours |
1414 |
|
1415 |
for (0 .. 3) { |
1416 |
my $neigh = $map->tile_path ($_) |
1417 |
or next; |
1418 |
$neigh = find $neigh, $map |
1419 |
or next; |
1420 |
$neigh->load; |
1421 |
|
1422 |
push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], |
1423 |
[$neigh->tile_path (($_ + 1) % 4), $neigh]; |
1424 |
} |
1425 |
|
1426 |
for (@diag) { |
1427 |
my $neigh = find @$_ |
1428 |
or next; |
1429 |
$neigh->load; |
1430 |
} |
1431 |
} |
1432 |
|
1433 |
sub find_sync { |
1434 |
my ($path, $origin) = @_; |
1435 |
|
1436 |
cf::sync_job { find $path, $origin } |
1437 |
} |
1438 |
|
1439 |
sub do_load_sync { |
1440 |
my ($map) = @_; |
1441 |
|
1442 |
cf::sync_job { $map->load }; |
1443 |
} |
1444 |
|
1445 |
our %MAP_PREFETCH; |
1446 |
our $MAP_PREFETCHER = Coro::async { |
1447 |
while () { |
1448 |
for my $path (keys %MAP_PREFETCH) { |
1449 |
my $map = find $path |
1450 |
or next; |
1451 |
$map->load; |
1452 |
|
1453 |
delete $MAP_PREFETCH{$path}; |
1454 |
} |
1455 |
Coro::schedule; |
1456 |
} |
1457 |
}; |
1458 |
|
1459 |
sub find_async { |
1460 |
my ($path, $origin) = @_; |
1461 |
|
1462 |
$path = normalise $path, $origin && $origin->{path}; |
1463 |
|
1464 |
if (my $map = $cf::MAP{$path}) { |
1465 |
return $map if $map->in_memory == cf::MAP_IN_MEMORY; |
1466 |
} |
1467 |
|
1468 |
$MAP_PREFETCH{$path} = 0; |
1469 |
$MAP_PREFETCHER->ready; |
1470 |
|
1471 |
() |
1472 |
} |
1473 |
|
1474 |
sub save { |
1475 |
my ($self) = @_; |
1476 |
|
1477 |
my $lock = cf::lock_acquire "map_data:" . $self->path; |
1478 |
|
1479 |
$self->{last_save} = $cf::RUNTIME; |
1480 |
|
1481 |
return unless $self->dirty; |
1482 |
|
1483 |
my $save = $self->save_path; utf8::encode $save; |
1484 |
my $uniq = $self->uniq_path; utf8::encode $uniq; |
1485 |
|
1486 |
$self->{load_path} = $save; |
1487 |
|
1488 |
return if $self->{deny_save}; |
1489 |
|
1490 |
local $self->{last_access} = $self->last_access;#d# |
1491 |
|
1492 |
cf::async { |
1493 |
$_->contr->save for $self->players; |
1494 |
}; |
1495 |
|
1496 |
if ($uniq) { |
1497 |
$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); |
1498 |
$self->_save_objects ($uniq, cf::IO_UNIQUES); |
1499 |
} else { |
1500 |
$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); |
1501 |
} |
1502 |
} |
1503 |
|
1504 |
sub swap_out { |
1505 |
my ($self) = @_; |
1506 |
|
1507 |
# save first because save cedes |
1508 |
$self->save; |
1509 |
|
1510 |
my $lock = cf::lock_acquire "map_data:" . $self->path; |
1511 |
|
1512 |
return if $self->players; |
1513 |
return if $self->in_memory != cf::MAP_IN_MEMORY; |
1514 |
return if $self->{deny_save}; |
1515 |
|
1516 |
$self->clear; |
1517 |
$self->in_memory (cf::MAP_SWAPPED); |
1518 |
} |
1519 |
|
1520 |
sub reset_at { |
1521 |
my ($self) = @_; |
1522 |
|
1523 |
# TODO: safety, remove and allow resettable per-player maps |
1524 |
return 1e99 if $self->isa ("ext::map_per_player");#d# |
1525 |
return 1e99 if $self->{deny_reset}; |
1526 |
|
1527 |
my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; |
1528 |
my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; |
1529 |
|
1530 |
$time + $to |
1531 |
} |
1532 |
|
1533 |
sub should_reset { |
1534 |
my ($self) = @_; |
1535 |
|
1536 |
$self->reset_at <= $cf::RUNTIME |
1537 |
} |
1538 |
|
1539 |
sub reset { |
1540 |
my ($self) = @_; |
1541 |
|
1542 |
my $lock = cf::lock_acquire "map_data:$self->{path}"; |
1543 |
|
1544 |
return if $self->players; |
1545 |
return if $self->isa ("ext::map_per_player");#d# |
1546 |
|
1547 |
warn "resetting map ", $self->path;#d# |
1548 |
|
1549 |
delete $cf::MAP{$self->path}; |
1550 |
|
1551 |
$self->in_memory (cf::MAP_SWAPPED); |
1552 |
$self->clear; |
1553 |
|
1554 |
$_->clear_links_to ($self) for values %cf::MAP; |
1555 |
|
1556 |
$self->unlink_save; |
1557 |
$self->destroy; |
1558 |
} |
1559 |
|
1560 |
my $nuke_counter = "aaaa"; |
1561 |
|
1562 |
sub nuke { |
1563 |
my ($self) = @_; |
1564 |
|
1565 |
delete $cf::MAP{$self->path}; |
1566 |
|
1567 |
$self->unlink_save; |
1568 |
|
1569 |
bless $self, "cf::map"; |
1570 |
delete $self->{deny_reset}; |
1571 |
$self->{deny_save} = 1; |
1572 |
$self->reset_timeout (1); |
1573 |
$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); |
1574 |
|
1575 |
$cf::MAP{$self->path} = $self; |
1576 |
|
1577 |
$self->reset; # polite request, might not happen |
1578 |
} |
1579 |
|
1580 |
=item cf::map::unique_maps |
1581 |
|
1582 |
Returns an arrayref of paths of all shared maps that have |
1583 |
instantiated unique items. May block. |
1584 |
|
1585 |
=cut |
1586 |
|
1587 |
sub unique_maps() { |
1588 |
my $files = aio_readdir cf::localdir . "/" . cf::uniquedir |
1589 |
or return; |
1590 |
|
1591 |
my @paths; |
1592 |
|
1593 |
for (@$files) { |
1594 |
utf8::decode $_; |
1595 |
next if /\.pst$/; |
1596 |
next unless /^$PATH_SEP/o; |
1597 |
|
1598 |
s/\.map$//; |
1599 |
push @paths, $_; |
1600 |
} |
1601 |
|
1602 |
\@paths |
1603 |
} |
1604 |
|
1605 |
package cf; |
1606 |
|
1607 |
=back |
1608 |
|
1609 |
=head3 cf::object |
1610 |
|
1611 |
=cut |
1612 |
|
1613 |
package cf::object; |
1614 |
|
1615 |
=over 4 |
1616 |
|
1617 |
=item $ob->inv_recursive |
1618 |
|
1619 |
Returns the inventory of the object _and_ their inventories, recursively. |
1620 |
|
1621 |
=cut |
1622 |
|
1623 |
sub inv_recursive_; |
1624 |
sub inv_recursive_ { |
1625 |
map { $_, inv_recursive_ $_->inv } @_ |
1626 |
} |
1627 |
|
1628 |
sub inv_recursive { |
1629 |
inv_recursive_ inv $_[0] |
1630 |
} |
1631 |
|
1632 |
package cf; |
1633 |
|
1634 |
=back |
1635 |
|
1636 |
=head3 cf::object::player |
1637 |
|
1638 |
=over 4 |
1639 |
|
1640 |
=item $player_object->reply ($npc, $msg[, $flags]) |
1641 |
|
1642 |
Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
1643 |
can be C<undef>. Does the right thing when the player is currently in a |
1644 |
dialogue with the given NPC character. |
1645 |
|
1646 |
=cut |
1647 |
|
1648 |
# rough implementation of a future "reply" method that works |
1649 |
# with dialog boxes. |
1650 |
#TODO: the first argument must go, split into a $npc->reply_to ( method |
1651 |
sub cf::object::player::reply($$$;$) { |
1652 |
my ($self, $npc, $msg, $flags) = @_; |
1653 |
|
1654 |
$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
1655 |
|
1656 |
if ($self->{record_replies}) { |
1657 |
push @{ $self->{record_replies} }, [$npc, $msg, $flags]; |
1658 |
} else { |
1659 |
$msg = $npc->name . " says: $msg" if $npc; |
1660 |
$self->message ($msg, $flags); |
1661 |
} |
1662 |
} |
1663 |
|
1664 |
=item $player_object->may ("access") |
1665 |
|
1666 |
Returns wether the given player is authorized to access resource "access" |
1667 |
(e.g. "command_wizcast"). |
1668 |
|
1669 |
=cut |
1670 |
|
1671 |
sub cf::object::player::may { |
1672 |
my ($self, $access) = @_; |
1673 |
|
1674 |
$self->flag (cf::FLAG_WIZ) || |
1675 |
(ref $cf::CFG{"may_$access"} |
1676 |
? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
1677 |
: $cf::CFG{"may_$access"}) |
1678 |
} |
1679 |
|
1680 |
=item $player_object->enter_link |
1681 |
|
1682 |
Freezes the player and moves him/her to a special map (C<{link}>). |
1683 |
|
1684 |
The player should be reasonably safe there for short amounts of time. You |
1685 |
I<MUST> call C<leave_link> as soon as possible, though. |
1686 |
|
1687 |
Will never block. |
1688 |
|
1689 |
=item $player_object->leave_link ($map, $x, $y) |
1690 |
|
1691 |
Moves the player out of the special C<{link}> map onto the specified |
1692 |
map. If the map is not valid (or omitted), the player will be moved back |
1693 |
to the location he/she was before the call to C<enter_link>, or, if that |
1694 |
fails, to the emergency map position. |
1695 |
|
1696 |
Might block. |
1697 |
|
1698 |
=cut |
1699 |
|
1700 |
sub link_map { |
1701 |
unless ($LINK_MAP) { |
1702 |
$LINK_MAP = cf::map::find "{link}" |
1703 |
or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; |
1704 |
$LINK_MAP->load; |
1705 |
} |
1706 |
|
1707 |
$LINK_MAP |
1708 |
} |
1709 |
|
1710 |
sub cf::object::player::enter_link { |
1711 |
my ($self) = @_; |
1712 |
|
1713 |
$self->deactivate_recursive; |
1714 |
|
1715 |
return if UNIVERSAL::isa $self->map, "ext::map_link"; |
1716 |
|
1717 |
$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] |
1718 |
if $self->map; |
1719 |
|
1720 |
$self->enter_map ($LINK_MAP || link_map, 20, 20); |
1721 |
} |
1722 |
|
1723 |
sub cf::object::player::leave_link { |
1724 |
my ($self, $map, $x, $y) = @_; |
1725 |
|
1726 |
my $link_pos = delete $self->{_link_pos}; |
1727 |
|
1728 |
unless ($map) { |
1729 |
# restore original map position |
1730 |
($map, $x, $y) = @{ $link_pos || [] }; |
1731 |
$map = cf::map::find $map; |
1732 |
|
1733 |
unless ($map) { |
1734 |
($map, $x, $y) = @$EMERGENCY_POSITION; |
1735 |
$map = cf::map::find $map |
1736 |
or die "FATAL: cannot load emergency map\n"; |
1737 |
} |
1738 |
} |
1739 |
|
1740 |
($x, $y) = (-1, -1) |
1741 |
unless (defined $x) && (defined $y); |
1742 |
|
1743 |
# use -1 or undef as default coordinates, not 0, 0 |
1744 |
($x, $y) = ($map->enter_x, $map->enter_y) |
1745 |
if $x <=0 && $y <= 0; |
1746 |
|
1747 |
$map->load; |
1748 |
$map->load_diag; |
1749 |
|
1750 |
return unless $self->contr->active; |
1751 |
$self->activate_recursive; |
1752 |
$self->enter_map ($map, $x, $y); |
1753 |
} |
1754 |
|
1755 |
cf::player->attach ( |
1756 |
on_logout => sub { |
1757 |
my ($pl) = @_; |
1758 |
|
1759 |
# abort map switching before logout |
1760 |
if ($pl->ob->{_link_pos}) { |
1761 |
cf::sync_job { |
1762 |
$pl->ob->leave_link |
1763 |
}; |
1764 |
} |
1765 |
}, |
1766 |
on_login => sub { |
1767 |
my ($pl) = @_; |
1768 |
|
1769 |
# try to abort aborted map switching on player login :) |
1770 |
# should happen only on crashes |
1771 |
if ($pl->ob->{_link_pos}) { |
1772 |
$pl->ob->enter_link; |
1773 |
(async { |
1774 |
# we need this sleep as the login has a concurrent enter_exit running |
1775 |
# and this sleep increases chances of the player not ending up in scorn |
1776 |
$pl->ob->reply (undef, |
1777 |
"There was an internal problem at your last logout, " |
1778 |
. "the server will try to bring you to your intended destination in a second.", |
1779 |
cf::NDI_RED); |
1780 |
Coro::Timer::sleep 1; |
1781 |
$pl->ob->leave_link; |
1782 |
})->prio (2); |
1783 |
} |
1784 |
}, |
1785 |
); |
1786 |
|
1787 |
=item $player_object->goto ($path, $x, $y) |
1788 |
|
1789 |
=cut |
1790 |
|
1791 |
sub cf::object::player::goto { |
1792 |
my ($self, $path, $x, $y) = @_; |
1793 |
|
1794 |
$self->enter_link; |
1795 |
|
1796 |
(async { |
1797 |
my $map = cf::map::find $path; |
1798 |
$map = $map->customise_for ($self) if $map; |
1799 |
|
1800 |
# warn "entering ", $map->path, " at ($x, $y)\n" |
1801 |
# if $map; |
1802 |
|
1803 |
$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); |
1804 |
|
1805 |
$self->leave_link ($map, $x, $y); |
1806 |
})->prio (1); |
1807 |
} |
1808 |
|
1809 |
=item $player_object->enter_exit ($exit_object) |
1810 |
|
1811 |
=cut |
1812 |
|
1813 |
sub parse_random_map_params { |
1814 |
my ($spec) = @_; |
1815 |
|
1816 |
my $rmp = { # defaults |
1817 |
xsize => -1, |
1818 |
ysize => -1, |
1819 |
}; |
1820 |
|
1821 |
for (split /\n/, $spec) { |
1822 |
my ($k, $v) = split /\s+/, $_, 2; |
1823 |
|
1824 |
$rmp->{lc $k} = $v if (length $k) && (length $v); |
1825 |
} |
1826 |
|
1827 |
$rmp |
1828 |
} |
1829 |
|
1830 |
sub prepare_random_map { |
1831 |
my ($exit) = @_; |
1832 |
|
1833 |
my $guard = cf::lock_acquire "exit_prepare:$exit"; |
1834 |
|
1835 |
# all this does is basically replace the /! path by |
1836 |
# a new random map path (?random/...) with a seed |
1837 |
# that depends on the exit object |
1838 |
|
1839 |
my $rmp = parse_random_map_params $exit->msg; |
1840 |
|
1841 |
if ($exit->map) { |
1842 |
$rmp->{region} = $exit->map->region_name; |
1843 |
$rmp->{origin_map} = $exit->map->path; |
1844 |
$rmp->{origin_x} = $exit->x; |
1845 |
$rmp->{origin_y} = $exit->y; |
1846 |
} |
1847 |
|
1848 |
$rmp->{random_seed} ||= $exit->random_seed; |
1849 |
|
1850 |
my $data = cf::to_json $rmp; |
1851 |
my $md5 = Digest::MD5::md5_hex $data; |
1852 |
my $meta = "$cf::RANDOM_MAPS/$md5.meta"; |
1853 |
|
1854 |
if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { |
1855 |
aio_write $fh, 0, (length $data), $data, 0; |
1856 |
undef $fh; |
1857 |
aio_rename "$meta~", $meta; |
1858 |
|
1859 |
$exit->slaying ("?random/$md5"); |
1860 |
$exit->msg (undef); |
1861 |
} |
1862 |
} |
1863 |
|
1864 |
sub cf::object::player::enter_exit { |
1865 |
my ($self, $exit) = @_; |
1866 |
|
1867 |
return unless $self->type == cf::PLAYER; |
1868 |
|
1869 |
$self->enter_link; |
1870 |
|
1871 |
(async { |
1872 |
$self->deactivate_recursive; # just to be sure |
1873 |
unless (eval { |
1874 |
prepare_random_map $exit |
1875 |
if $exit->slaying eq "/!"; |
1876 |
|
1877 |
my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path; |
1878 |
$self->goto ($path, $exit->stats->hp, $exit->stats->sp); |
1879 |
|
1880 |
1; |
1881 |
}) { |
1882 |
$self->message ("Something went wrong deep within the crossfire server. " |
1883 |
. "I'll try to bring you back to the map you were before. " |
1884 |
. "Please report this to the dungeon master!", |
1885 |
cf::NDI_UNIQUE | cf::NDI_RED); |
1886 |
|
1887 |
warn "ERROR in enter_exit: $@"; |
1888 |
$self->leave_link; |
1889 |
} |
1890 |
})->prio (1); |
1891 |
} |
1892 |
|
1893 |
=head3 cf::client |
1894 |
|
1895 |
=over 4 |
1896 |
|
1897 |
=item $client->send_drawinfo ($text, $flags) |
1898 |
|
1899 |
Sends a drawinfo packet to the client. Circumvents output buffering so |
1900 |
should not be used under normal circumstances. |
1901 |
|
1902 |
=cut |
1903 |
|
1904 |
sub cf::client::send_drawinfo { |
1905 |
my ($self, $text, $flags) = @_; |
1906 |
|
1907 |
utf8::encode $text; |
1908 |
$self->send_packet (sprintf "drawinfo %d %s", $flags, $text); |
1909 |
} |
1910 |
|
1911 |
|
1912 |
=item $success = $client->query ($flags, "text", \&cb) |
1913 |
|
1914 |
Queues a query to the client, calling the given callback with |
1915 |
the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, |
1916 |
C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. |
1917 |
|
1918 |
Queries can fail, so check the return code. Or don't, as queries will become |
1919 |
reliable at some point in the future. |
1920 |
|
1921 |
=cut |
1922 |
|
1923 |
sub cf::client::query { |
1924 |
my ($self, $flags, $text, $cb) = @_; |
1925 |
|
1926 |
return unless $self->state == ST_PLAYING |
1927 |
|| $self->state == ST_SETUP |
1928 |
|| $self->state == ST_CUSTOM; |
1929 |
|
1930 |
$self->state (ST_CUSTOM); |
1931 |
|
1932 |
utf8::encode $text; |
1933 |
push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; |
1934 |
|
1935 |
$self->send_packet ($self->{query_queue}[0][0]) |
1936 |
if @{ $self->{query_queue} } == 1; |
1937 |
} |
1938 |
|
1939 |
cf::client->attach ( |
1940 |
on_reply => sub { |
1941 |
my ($ns, $msg) = @_; |
1942 |
|
1943 |
# this weird shuffling is so that direct followup queries |
1944 |
# get handled first |
1945 |
my $queue = delete $ns->{query_queue} |
1946 |
or return; # be conservative, not sure how that can happen, but we saw a crash here |
1947 |
|
1948 |
(shift @$queue)->[1]->($msg); |
1949 |
|
1950 |
push @{ $ns->{query_queue} }, @$queue; |
1951 |
|
1952 |
if (@{ $ns->{query_queue} } == @$queue) { |
1953 |
if (@$queue) { |
1954 |
$ns->send_packet ($ns->{query_queue}[0][0]); |
1955 |
} else { |
1956 |
$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; |
1957 |
} |
1958 |
} |
1959 |
}, |
1960 |
); |
1961 |
|
1962 |
=item $client->async (\&cb) |
1963 |
|
1964 |
Create a new coroutine, running the specified callback. The coroutine will |
1965 |
be automatically cancelled when the client gets destroyed (e.g. on logout, |
1966 |
or loss of connection). |
1967 |
|
1968 |
=cut |
1969 |
|
1970 |
sub cf::client::async { |
1971 |
my ($self, $cb) = @_; |
1972 |
|
1973 |
my $coro = &Coro::async ($cb); |
1974 |
|
1975 |
$coro->on_destroy (sub { |
1976 |
delete $self->{_coro}{$coro+0}; |
1977 |
}); |
1978 |
|
1979 |
$self->{_coro}{$coro+0} = $coro; |
1980 |
|
1981 |
$coro |
1982 |
} |
1983 |
|
1984 |
cf::client->attach ( |
1985 |
on_destroy => sub { |
1986 |
my ($ns) = @_; |
1987 |
|
1988 |
$_->cancel for values %{ (delete $ns->{_coro}) || {} }; |
1989 |
}, |
1990 |
); |
1991 |
|
1992 |
=back |
1993 |
|
1994 |
|
1995 |
=head2 SAFE SCRIPTING |
1996 |
|
1997 |
Functions that provide a safe environment to compile and execute |
1998 |
snippets of perl code without them endangering the safety of the server |
1999 |
itself. Looping constructs, I/O operators and other built-in functionality |
2000 |
is not available in the safe scripting environment, and the number of |
2001 |
functions and methods that can be called is greatly reduced. |
2002 |
|
2003 |
=cut |
2004 |
|
2005 |
our $safe = new Safe "safe"; |
2006 |
our $safe_hole = new Safe::Hole; |
2007 |
|
2008 |
$SIG{FPE} = 'IGNORE'; |
2009 |
|
2010 |
$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
2011 |
|
2012 |
# here we export the classes and methods available to script code |
2013 |
|
2014 |
=pod |
2015 |
|
2016 |
The following fucntions and emthods are available within a safe environment: |
2017 |
|
2018 |
cf::object contr pay_amount pay_player map |
2019 |
cf::object::player player |
2020 |
cf::player peaceful |
2021 |
cf::map trigger |
2022 |
|
2023 |
=cut |
2024 |
|
2025 |
for ( |
2026 |
["cf::object" => qw(contr pay_amount pay_player map)], |
2027 |
["cf::object::player" => qw(player)], |
2028 |
["cf::player" => qw(peaceful)], |
2029 |
["cf::map" => qw(trigger)], |
2030 |
) { |
2031 |
no strict 'refs'; |
2032 |
my ($pkg, @funs) = @$_; |
2033 |
*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
2034 |
for @funs; |
2035 |
} |
2036 |
|
2037 |
=over 4 |
2038 |
|
2039 |
=item @retval = safe_eval $code, [var => value, ...] |
2040 |
|
2041 |
Compiled and executes the given perl code snippet. additional var/value |
2042 |
pairs result in temporary local (my) scalar variables of the given name |
2043 |
that are available in the code snippet. Example: |
2044 |
|
2045 |
my $five = safe_eval '$first + $second', first => 1, second => 4; |
2046 |
|
2047 |
=cut |
2048 |
|
2049 |
sub safe_eval($;@) { |
2050 |
my ($code, %vars) = @_; |
2051 |
|
2052 |
my $qcode = $code; |
2053 |
$qcode =~ s/"/‟/g; # not allowed in #line filenames |
2054 |
$qcode =~ s/\n/\\n/g; |
2055 |
|
2056 |
local $_; |
2057 |
local @safe::cf::_safe_eval_args = values %vars; |
2058 |
|
2059 |
my $eval = |
2060 |
"do {\n" |
2061 |
. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" |
2062 |
. "#line 0 \"{$qcode}\"\n" |
2063 |
. $code |
2064 |
. "\n}" |
2065 |
; |
2066 |
|
2067 |
sub_generation_inc; |
2068 |
my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); |
2069 |
sub_generation_inc; |
2070 |
|
2071 |
if ($@) { |
2072 |
warn "$@"; |
2073 |
warn "while executing safe code '$code'\n"; |
2074 |
warn "with arguments " . (join " ", %vars) . "\n"; |
2075 |
} |
2076 |
|
2077 |
wantarray ? @res : $res[0] |
2078 |
} |
2079 |
|
2080 |
=item cf::register_script_function $function => $cb |
2081 |
|
2082 |
Register a function that can be called from within map/npc scripts. The |
2083 |
function should be reasonably secure and should be put into a package name |
2084 |
like the extension. |
2085 |
|
2086 |
Example: register a function that gets called whenever a map script calls |
2087 |
C<rent::overview>, as used by the C<rent> extension. |
2088 |
|
2089 |
cf::register_script_function "rent::overview" => sub { |
2090 |
... |
2091 |
}; |
2092 |
|
2093 |
=cut |
2094 |
|
2095 |
sub register_script_function { |
2096 |
my ($fun, $cb) = @_; |
2097 |
|
2098 |
no strict 'refs'; |
2099 |
*{"safe::$fun"} = $safe_hole->wrap ($cb); |
2100 |
} |
2101 |
|
2102 |
=back |
2103 |
|
2104 |
=cut |
2105 |
|
2106 |
############################################################################# |
2107 |
|
2108 |
=head2 EXTENSION DATABASE SUPPORT |
2109 |
|
2110 |
Crossfire maintains a very simple database for extension use. It can |
2111 |
currently store anything that can be serialised using Storable, which |
2112 |
excludes objects. |
2113 |
|
2114 |
The parameter C<$family> should best start with the name of the extension |
2115 |
using it, it should be unique. |
2116 |
|
2117 |
=over 4 |
2118 |
|
2119 |
=item $hashref = cf::db_get $family |
2120 |
|
2121 |
Return a hashref for use by the extension C<$family>, which can be |
2122 |
modified. After modifications, you have to call C<cf::db_dirty> or |
2123 |
C<cf::db_sync>. |
2124 |
|
2125 |
=item $value = cf::db_get $family => $key |
2126 |
|
2127 |
Returns a single value from the database |
2128 |
|
2129 |
=item cf::db_put $family => $hashref |
2130 |
|
2131 |
Stores the given family hashref into the database. Updates are delayed, if |
2132 |
you want the data to be synced to disk immediately, use C<cf::db_sync>. |
2133 |
|
2134 |
=item cf::db_put $family => $key => $value |
2135 |
|
2136 |
Stores the given C<$value> in the family hash. Updates are delayed, if you |
2137 |
want the data to be synced to disk immediately, use C<cf::db_sync>. |
2138 |
|
2139 |
=item cf::db_dirty |
2140 |
|
2141 |
Marks the database as dirty, to be updated at a later time. |
2142 |
|
2143 |
=item cf::db_sync |
2144 |
|
2145 |
Immediately write the database to disk I<if it is dirty>. |
2146 |
|
2147 |
=cut |
2148 |
|
2149 |
our $DB; |
2150 |
|
2151 |
{ |
2152 |
my $path = cf::localdir . "/database.pst"; |
2153 |
|
2154 |
sub db_load() { |
2155 |
$DB = stat $path ? Storable::retrieve $path : { }; |
2156 |
} |
2157 |
|
2158 |
my $pid; |
2159 |
|
2160 |
sub db_save() { |
2161 |
waitpid $pid, 0 if $pid; |
2162 |
if (0 == ($pid = fork)) { |
2163 |
$DB->{_meta}{version} = 1; |
2164 |
Storable::nstore $DB, "$path~"; |
2165 |
rename "$path~", $path; |
2166 |
cf::_exit 0 if defined $pid; |
2167 |
} |
2168 |
} |
2169 |
|
2170 |
my $dirty; |
2171 |
|
2172 |
sub db_sync() { |
2173 |
db_save if $dirty; |
2174 |
undef $dirty; |
2175 |
} |
2176 |
|
2177 |
my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { |
2178 |
db_sync; |
2179 |
}); |
2180 |
|
2181 |
sub db_dirty() { |
2182 |
$dirty = 1; |
2183 |
$idle->start; |
2184 |
} |
2185 |
|
2186 |
sub db_get($;$) { |
2187 |
@_ >= 2 |
2188 |
? $DB->{$_[0]}{$_[1]} |
2189 |
: ($DB->{$_[0]} ||= { }) |
2190 |
} |
2191 |
|
2192 |
sub db_put($$;$) { |
2193 |
if (@_ >= 3) { |
2194 |
$DB->{$_[0]}{$_[1]} = $_[2]; |
2195 |
} else { |
2196 |
$DB->{$_[0]} = $_[1]; |
2197 |
} |
2198 |
db_dirty; |
2199 |
} |
2200 |
|
2201 |
cf::global->attach ( |
2202 |
prio => 10000, |
2203 |
on_cleanup => sub { |
2204 |
db_sync; |
2205 |
}, |
2206 |
); |
2207 |
} |
2208 |
|
2209 |
############################################################################# |
2210 |
# the server's main() |
2211 |
|
2212 |
sub cfg_load { |
2213 |
open my $fh, "<:utf8", cf::confdir . "/config" |
2214 |
or return; |
2215 |
|
2216 |
local $/; |
2217 |
*CFG = YAML::Syck::Load <$fh>; |
2218 |
|
2219 |
$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; |
2220 |
|
2221 |
$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; |
2222 |
$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; |
2223 |
|
2224 |
if (exists $CFG{mlockall}) { |
2225 |
eval { |
2226 |
$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" |
2227 |
and die "WARNING: m(un)lockall failed: $!\n"; |
2228 |
}; |
2229 |
warn $@ if $@; |
2230 |
} |
2231 |
} |
2232 |
|
2233 |
sub main { |
2234 |
# we must not ever block the main coroutine |
2235 |
local $Coro::idle = sub { |
2236 |
Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# |
2237 |
(async { |
2238 |
Event::one_event; |
2239 |
})->prio (Coro::PRIO_MAX); |
2240 |
}; |
2241 |
|
2242 |
cfg_load; |
2243 |
db_load; |
2244 |
load_extensions; |
2245 |
Event::loop; |
2246 |
} |
2247 |
|
2248 |
############################################################################# |
2249 |
# initialisation and cleanup |
2250 |
|
2251 |
# install some emergency cleanup handlers |
2252 |
BEGIN { |
2253 |
for my $signal (qw(INT HUP TERM)) { |
2254 |
Event->signal ( |
2255 |
data => WF_AUTOCANCEL, |
2256 |
signal => $signal, |
2257 |
cb => sub { |
2258 |
cf::cleanup "SIG$signal"; |
2259 |
}, |
2260 |
); |
2261 |
} |
2262 |
} |
2263 |
|
2264 |
sub emergency_save() { |
2265 |
my $freeze_guard = cf::freeze_mainloop; |
2266 |
|
2267 |
warn "enter emergency perl save\n"; |
2268 |
|
2269 |
cf::sync_job { |
2270 |
# use a peculiar iteration method to avoid tripping on perl |
2271 |
# refcount bugs in for. also avoids problems with players |
2272 |
# and maps saved/destroyed asynchronously. |
2273 |
warn "begin emergency player save\n"; |
2274 |
for my $login (keys %cf::PLAYER) { |
2275 |
my $pl = $cf::PLAYER{$login} or next; |
2276 |
$pl->valid or next; |
2277 |
$pl->save; |
2278 |
} |
2279 |
warn "end emergency player save\n"; |
2280 |
|
2281 |
warn "begin emergency map save\n"; |
2282 |
for my $path (keys %cf::MAP) { |
2283 |
my $map = $cf::MAP{$path} or next; |
2284 |
$map->valid or next; |
2285 |
$map->save; |
2286 |
} |
2287 |
warn "end emergency map save\n"; |
2288 |
}; |
2289 |
|
2290 |
warn "leave emergency perl save\n"; |
2291 |
} |
2292 |
|
2293 |
sub reload() { |
2294 |
# can/must only be called in main |
2295 |
if ($Coro::current != $Coro::main) { |
2296 |
warn "can only reload from main coroutine\n"; |
2297 |
return; |
2298 |
} |
2299 |
|
2300 |
warn "reloading..."; |
2301 |
|
2302 |
warn "freezing server"; |
2303 |
my $guard = freeze_mainloop; |
2304 |
cf::emergency_save; |
2305 |
|
2306 |
warn "sync database to disk"; |
2307 |
cf::db_sync; |
2308 |
IO::AIO::flush; |
2309 |
|
2310 |
eval { |
2311 |
# if anything goes wrong in here, we should simply crash as we already saved |
2312 |
|
2313 |
warn "cancel all watchers"; |
2314 |
for (Event::all_watchers) { |
2315 |
$_->cancel if $_->data & WF_AUTOCANCEL; |
2316 |
} |
2317 |
|
2318 |
warn "cancel all extension coros"; |
2319 |
$_->cancel for values %EXT_CORO; |
2320 |
%EXT_CORO = (); |
2321 |
|
2322 |
warn "remove commands"; |
2323 |
%COMMAND = (); |
2324 |
|
2325 |
warn "remove ext commands"; |
2326 |
%EXTCMD = (); |
2327 |
|
2328 |
warn "unload/nuke all extensions"; |
2329 |
for my $pkg (@EXTS) { |
2330 |
warn "... unloading $pkg"; |
2331 |
|
2332 |
if (my $cb = $pkg->can ("unload")) { |
2333 |
eval { |
2334 |
$cb->($pkg); |
2335 |
1 |
2336 |
} or warn "$pkg unloaded, but with errors: $@"; |
2337 |
} |
2338 |
|
2339 |
warn "... nuking $pkg"; |
2340 |
Symbol::delete_package $pkg; |
2341 |
} |
2342 |
|
2343 |
warn "unload all perl modules loaded from $LIBDIR"; |
2344 |
while (my ($k, $v) = each %INC) { |
2345 |
next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
2346 |
|
2347 |
warn "removing <$k>"; |
2348 |
delete $INC{$k}; |
2349 |
|
2350 |
$k =~ s/\.pm$//; |
2351 |
$k =~ s/\//::/g; |
2352 |
|
2353 |
if (my $cb = $k->can ("unload_module")) { |
2354 |
$cb->(); |
2355 |
} |
2356 |
|
2357 |
Symbol::delete_package $k; |
2358 |
} |
2359 |
|
2360 |
warn "get rid of safe::, as good as possible"; |
2361 |
Symbol::delete_package "safe::$_" |
2362 |
for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); |
2363 |
|
2364 |
warn "unload cf.pm \"a bit\""; |
2365 |
delete $INC{"cf.pm"}; |
2366 |
|
2367 |
# don't, removes xs symbols, too, |
2368 |
# and global variables created in xs |
2369 |
#Symbol::delete_package __PACKAGE__; |
2370 |
|
2371 |
warn "reloading cf.pm"; |
2372 |
require cf; |
2373 |
cf::_connect_to_perl; # nominally unnecessary, but cannot hurt |
2374 |
|
2375 |
warn "load config and database again"; |
2376 |
cf::cfg_load; |
2377 |
cf::db_load; |
2378 |
|
2379 |
warn "load extensions"; |
2380 |
cf::load_extensions; |
2381 |
|
2382 |
warn "reattach attachments to objects/players"; |
2383 |
_global_reattach; |
2384 |
warn "reattach attachments to maps"; |
2385 |
reattach $_ for values %MAP; |
2386 |
}; |
2387 |
|
2388 |
if ($@) { |
2389 |
warn $@; |
2390 |
warn "error while reloading, exiting."; |
2391 |
exit 1; |
2392 |
} |
2393 |
|
2394 |
warn "reloaded"; |
2395 |
}; |
2396 |
|
2397 |
our $RELOAD_WATCHER; # used only during reload |
2398 |
|
2399 |
register_command "reload" => sub { |
2400 |
my ($who, $arg) = @_; |
2401 |
|
2402 |
if ($who->flag (FLAG_WIZ)) { |
2403 |
$who->message ("reloading server."); |
2404 |
|
2405 |
# doing reload synchronously and two reloads happen back-to-back, |
2406 |
# coro crashes during coro_state_free->destroy here. |
2407 |
|
2408 |
$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub { |
2409 |
reload; |
2410 |
undef $RELOAD_WATCHER; |
2411 |
}); |
2412 |
} |
2413 |
}; |
2414 |
|
2415 |
unshift @INC, $LIBDIR; |
2416 |
|
2417 |
$TICK_WATCHER = Event->timer ( |
2418 |
reentrant => 0, |
2419 |
prio => 0, |
2420 |
at => $NEXT_TICK || $TICK, |
2421 |
data => WF_AUTOCANCEL, |
2422 |
cb => sub { |
2423 |
$NOW = Event::time; |
2424 |
|
2425 |
cf::server_tick; # one server iteration |
2426 |
$RUNTIME += $TICK; |
2427 |
$NEXT_TICK += $TICK; |
2428 |
|
2429 |
$WAIT_FOR_TICK->broadcast; |
2430 |
$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; |
2431 |
|
2432 |
# if we are delayed by four ticks or more, skip them all |
2433 |
$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; |
2434 |
|
2435 |
$TICK_WATCHER->at ($NEXT_TICK); |
2436 |
$TICK_WATCHER->start; |
2437 |
}, |
2438 |
); |
2439 |
|
2440 |
IO::AIO::max_poll_time $TICK * 0.2; |
2441 |
|
2442 |
$AIO_POLL_WATCHER = Event->io ( |
2443 |
fd => IO::AIO::poll_fileno, |
2444 |
poll => 'r', |
2445 |
prio => 5, |
2446 |
data => WF_AUTOCANCEL, |
2447 |
cb => \&IO::AIO::poll_cb, |
2448 |
); |
2449 |
|
2450 |
$WRITE_RUNTIME_WATCHER = Event->timer ( |
2451 |
data => WF_AUTOCANCEL, |
2452 |
after => 0, |
2453 |
interval => 10, |
2454 |
cb => sub { |
2455 |
(Coro::unblock_sub { |
2456 |
write_runtime |
2457 |
or warn "ERROR: unable to write runtime file: $!"; |
2458 |
})->(); |
2459 |
}, |
2460 |
); |
2461 |
|
2462 |
END { cf::emergency_save } |
2463 |
|
2464 |
1 |
2465 |
|