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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines