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.83 by root, Mon Dec 11 01:30:41 2006 UTC vs.
Revision 1.381 by root, Mon Oct 8 18:19:39 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines