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.11 by root, Sun Mar 26 15:52:03 2006 UTC vs.
Revision 1.257 by root, Sat Apr 21 17:34:24 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines