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.100 by root, Mon Dec 25 11:25:49 2006 UTC vs.
Revision 1.272 by root, Sun Jun 3 15:32:50 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines