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.248 by root, Tue Apr 17 18:40:32 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines