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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines