ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.20 by root, Sun Jul 16 17:29:02 2006 UTC vs.
Revision 1.231 by root, Wed Apr 4 00:02:06 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines