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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines