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.101 by root, Mon Dec 25 14:43:23 2006 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines