ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines