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.385 by root, Fri Oct 12 19:13:26 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Socket;
9use Event;
6use Opcode; 10use Opcode;
7use Safe; 11use Safe;
8use Safe::Hole; 12use Safe::Hole;
13use Storable ();
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, 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 return 1;#d#
473 977
474 for (@$data) { 978 #todo#d# kill yourself and do some recursive checking manually without storable
475 my ($name, $args) = @$_; 979 sync_job {
476 980 my $guard = Coro::Storable::guard;
477 $obj->attach ($name, %{$args || {} }); 981 local $Storable::canonical = 1;
982 my $fob1 = Storable::freeze $ob1;
983 my $fob2 = Storable::freeze $ob2;
984 $fob1 eq $fob2
478 } 985 }
479} 986}
480 987
481# basically do the same as instantiate, without calling instantiate
482sub reattach { 988sub reattach {
989 # basically do the same as instantiate, without calling instantiate
483 my ($obj) = @_; 990 my ($obj) = @_;
991
992 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
993
484 my $registry = $obj->registry; 994 my $registry = $obj->registry;
485 995
486 @$registry = (); 996 @$registry = ();
487 997
488 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 998 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
489 999
490 for my $name (keys %{ $obj->{_attachment} || {} }) { 1000 for my $name (keys %{ $obj->{_attachment} || {} }) {
491 if (my $attach = $attachment{$name}) { 1001 if (my $attach = $attachment{$name}) {
492 for (@$attach) { 1002 for (@$attach) {
493 my ($klass, @attach) = @$_; 1003 my ($klass, @attach) = @$_;
494 _attach @$registry, $klass, @attach; 1004 _attach $registry, $klass, @attach;
495 } 1005 }
496 } else { 1006 } else {
497 warn "object uses attachment '$name' that is not available, postponing.\n"; 1007 warn "object uses attachment '$name' that is not available, postponing.\n";
498 } 1008 }
499 } 1009 }
500} 1010}
501 1011
502sub object_freezer_save { 1012cf::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, 1013 prio => -1000000,
1014 on_instantiate => sub {
1015 my ($obj, $data) = @_;
1016
1017 $data = from_json $data;
1018
1019 for (@$data) {
1020 my ($name, $args) = @$_;
1021
1022 $obj->attach ($name, %{$args || {} });
1023 }
1024 },
1025 on_reattach => \&reattach,
562 on_clone => sub { 1026 on_clone => sub {
563 my ($src, $dst) = @_; 1027 my ($src, $dst) = @_;
564 1028
565 @{$dst->registry} = @{$src->registry}; 1029 @{$dst->registry} = @{$src->registry};
566 1030
567 %$dst = %$src; 1031 %$dst = %$src;
568 1032
569 %{$dst->{_attachment}} = %{$src->{_attachment}} 1033 %{$dst->{_attachment}} = %{$src->{_attachment}}
570 if exists $src->{_attachment}; 1034 if exists $src->{_attachment};
571 }, 1035 },
572; 1036);
1037
1038sub object_freezer_save {
1039 my ($filename, $rdata, $objs) = @_;
1040
1041 sync_job {
1042 if (length $$rdata) {
1043 utf8::decode (my $decname = $filename);
1044 warn sprintf "saving %s (%d,%d)\n",
1045 $decname, length $$rdata, scalar @$objs;
1046
1047 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
1048 chmod SAVE_MODE, $fh;
1049 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1050 aio_fsync $fh if $cf::USE_FSYNC;
1051 close $fh;
1052
1053 if (@$objs) {
1054 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
1055 chmod SAVE_MODE, $fh;
1056 my $data = Coro::Storable::blocking_nfreeze { version => 1, objs => $objs };
1057 aio_write $fh, 0, (length $data), $data, 0;
1058 aio_fsync $fh if $cf::USE_FSYNC;
1059 close $fh;
1060 aio_rename "$filename.pst~", "$filename.pst";
1061 }
1062 } else {
1063 aio_unlink "$filename.pst";
1064 }
1065
1066 aio_rename "$filename~", $filename;
1067 } else {
1068 warn "FATAL: $filename~: $!\n";
1069 }
1070 } else {
1071 aio_unlink $filename;
1072 aio_unlink "$filename.pst";
1073 }
1074 };
1075}
1076
1077sub object_freezer_as_string {
1078 my ($rdata, $objs) = @_;
1079
1080 use Data::Dumper;
1081
1082 $$rdata . Dumper $objs
1083}
1084
1085sub object_thawer_load {
1086 my ($filename) = @_;
1087
1088 my ($data, $av);
1089
1090 (aio_load $filename, $data) >= 0
1091 or return;
1092
1093 unless (aio_stat "$filename.pst") {
1094 (aio_load "$filename.pst", $av) >= 0
1095 or return;
1096
1097 my $st = eval { Coro::Storable::thaw $av }
1098 || eval { my $guard = Coro::Storable::guard; Storable::thaw $av }; #d# compatibility, remove
1099 $av = $st->{objs};
1100 }
1101
1102 utf8::decode (my $decname = $filename);
1103 warn sprintf "loading %s (%d,%d)\n",
1104 $decname, length $data, scalar @{$av || []};
1105
1106 ($data, $av)
1107}
1108
1109=head2 COMMAND CALLBACKS
1110
1111=over 4
1112
1113=cut
573 1114
574############################################################################# 1115#############################################################################
575# old plug-in events 1116# command handling &c
576 1117
577sub inject_event { 1118=item cf::register_command $name => \&callback($ob,$args);
578 my $extension = shift;
579 my $event_code = shift;
580 1119
581 my $cb = $hook[$event_code]{$extension} 1120Register a callback for execution when the client sends the user command
582 or return; 1121$name.
583 1122
584 &$cb 1123=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 1124
606sub register_command { 1125sub register_command {
607 my ($name, $time, $cb) = @_; 1126 my ($name, $cb) = @_;
608 1127
609 my $caller = caller; 1128 my $caller = caller;
610 #warn "registering command '$name/$time' to '$caller'"; 1129 #warn "registering command '$name/$time' to '$caller'";
611 1130
612 push @{ $command{$name} }, [$time, $cb, $caller]; 1131 push @{ $COMMAND{$name} }, [$caller, $cb];
613 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
614} 1132}
1133
1134=item cf::register_extcmd $name => \&callback($pl,$packet);
1135
1136Register a callback for execution when the client sends an (synchronous)
1137extcmd packet. Ext commands will be processed in the order they are
1138received by the server, like other user commands. The first argument is
1139the logged-in player. Ext commands can only be processed after a player
1140has logged in successfully.
1141
1142If the callback returns something, it is sent back as if reply was being
1143called.
1144
1145=item cf::register_exticmd $name => \&callback($ns,$packet);
1146
1147Register a callback for execution when the client sends an (asynchronous)
1148exticmd packet. Exti commands are processed by the server as soon as they
1149are received, i.e. out of order w.r.t. other commands. The first argument
1150is a client socket. Exti commands can be received anytime, even before
1151log-in.
1152
1153If the callback returns something, it is sent back as if reply was being
1154called.
1155
1156=cut
615 1157
616sub register_extcmd { 1158sub register_extcmd {
617 my ($name, $cb) = @_; 1159 my ($name, $cb) = @_;
618 1160
619 my $caller = caller; 1161 $EXTCMD{$name} = $cb;
620 #warn "registering extcmd '$name' to '$caller'";
621
622 $extcmd{$name} = [$cb, $caller];
623} 1162}
624 1163
625sub register { 1164sub register_exticmd {
626 my ($base, $pkg) = @_; 1165 my ($name, $cb) = @_;
627 1166
628 #TODO 1167 $EXTICMD{$name} = $cb;
629} 1168}
630 1169
631sub load_extension { 1170cf::player->attach (
632 my ($path) = @_; 1171 on_command => sub {
1172 my ($pl, $name, $params) = @_;
633 1173
634 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1174 my $cb = $COMMAND{$name}
635 my $base = $1; 1175 or return;
636 my $pkg = $1;
637 $pkg =~ s/[^[:word:]]/_/g;
638 $pkg = "ext::$pkg";
639 1176
640 warn "loading '$path' into '$pkg'\n"; 1177 for my $cmd (@$cb) {
641 1178 $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 } 1179 }
1180
1181 cf::override;
686 } 1182 },
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 { 1183 on_extcmd => sub {
721 my ($pl, $buf) = @_; 1184 my ($pl, $buf) = @_;
722 1185
723 my $msg = eval { from_json $buf }; 1186 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
724 1187
725 if (ref $msg) { 1188 if (ref $msg) {
1189 my ($type, $reply, @payload) =
1190 "ARRAY" eq ref $msg
1191 ? @$msg
1192 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1193
1194 my @reply;
1195
726 if (my $cb = $extcmd{$msg->{msgtype}}) { 1196 if (my $cb = $EXTCMD{$type}) {
727 if (my %reply = $cb->[0]->($pl, $msg)) { 1197 @reply = $cb->($pl, @payload);
728 $pl->ext_reply ($msg->{msgid}, %reply); 1198 }
1199
1200 $pl->ext_reply ($reply, @reply)
1201 if $reply;
1202
1203 } else {
1204 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
1205 }
1206
1207 cf::override;
1208 },
1209);
1210
1211sub load_extensions {
1212 cf::sync_job {
1213 my %todo;
1214
1215 for my $path (<$LIBDIR/*.ext>) {
1216 next unless -r $path;
1217
1218 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1219 my $base = $1;
1220 my $pkg = $1;
1221 $pkg =~ s/[^[:word:]]/_/g;
1222 $pkg = "ext::$pkg";
1223
1224 open my $fh, "<:utf8", $path
1225 or die "$path: $!";
1226
1227 my $source = do { local $/; <$fh> };
1228
1229 my %ext = (
1230 path => $path,
1231 base => $base,
1232 pkg => $pkg,
1233 );
1234
1235 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1236 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1237
1238 $ext{source} =
1239 "package $pkg; use strict; use utf8;\n"
1240 . "#line 1 \"$path\"\n{\n"
1241 . $source
1242 . "\n};\n1";
1243
1244 $todo{$base} = \%ext;
1245 }
1246
1247 my %done;
1248 while (%todo) {
1249 my $progress;
1250
1251 while (my ($k, $v) = each %todo) {
1252 for (split /,\s*/, $v->{meta}{depends}) {
1253 goto skip
1254 unless exists $done{$_};
1255 }
1256
1257 warn "... loading '$k' into '$v->{pkg}'\n";
1258
1259 unless (eval $v->{source}) {
1260 my $msg = $@ ? "$v->{path}: $@\n"
1261 : "$v->{base}: extension inactive.\n";
1262
1263 if (exists $v->{meta}{mandatory}) {
1264 warn $msg;
1265 warn "mandatory extension failed to load, exiting.\n";
1266 exit 1;
1267 }
1268
1269 warn $msg;
1270 }
1271
1272 $done{$k} = delete $todo{$k};
1273 push @EXTS, $v->{pkg};
1274 $progress = 1;
1275 }
1276
1277 skip:
1278 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1279 unless $progress;
1280 }
1281 };
1282}
1283
1284#############################################################################
1285
1286=back
1287
1288=head2 CORE EXTENSIONS
1289
1290Functions and methods that extend core crossfire objects.
1291
1292=cut
1293
1294package cf::player;
1295
1296use Coro::AIO;
1297
1298=head3 cf::player
1299
1300=over 4
1301
1302=item cf::player::num_playing
1303
1304Returns the official number of playing players, as per the Crossfire metaserver rules.
1305
1306=cut
1307
1308sub num_playing {
1309 scalar grep
1310 $_->ob->map
1311 && !$_->hidden
1312 && !$_->ob->flag (cf::FLAG_WIZ),
1313 cf::player::list
1314}
1315
1316=item cf::player::find $login
1317
1318Returns the given player object, loading it if necessary (might block).
1319
1320=cut
1321
1322sub playerdir($) {
1323 "$PLAYERDIR/"
1324 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1325}
1326
1327sub path($) {
1328 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1329
1330 (playerdir $login) . "/playerdata"
1331}
1332
1333sub find_active($) {
1334 $cf::PLAYER{$_[0]}
1335 and $cf::PLAYER{$_[0]}->active
1336 and $cf::PLAYER{$_[0]}
1337}
1338
1339sub exists($) {
1340 my ($login) = @_;
1341
1342 $cf::PLAYER{$login}
1343 or cf::sync_job { !aio_stat path $login }
1344}
1345
1346sub find($) {
1347 return $cf::PLAYER{$_[0]} || do {
1348 my $login = $_[0];
1349
1350 my $guard = cf::lock_acquire "user_find:$login";
1351
1352 $cf::PLAYER{$_[0]} || do {
1353 # rename old playerfiles to new ones
1354 #TODO: remove when no longer required
1355 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1356 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1357 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1358 aio_unlink +(playerdir $login) . "/$login.pl";
1359
1360 my $f = new_from_file cf::object::thawer path $login
1361 or return;
1362
1363 my $pl = cf::player::load_pl $f
1364 or return;
1365 local $cf::PLAYER_LOADING{$login} = $pl;
1366 $f->resolve_delayed_derefs;
1367 $cf::PLAYER{$login} = $pl
1368 }
1369 }
1370}
1371
1372sub save($) {
1373 my ($pl) = @_;
1374
1375 return if $pl->{deny_save};
1376
1377 my $path = path $pl;
1378 my $guard = cf::lock_acquire "user_save:$path";
1379
1380 return if $pl->{deny_save};
1381
1382 aio_mkdir playerdir $pl, 0770;
1383 $pl->{last_save} = $cf::RUNTIME;
1384
1385 $pl->save_pl ($path);
1386 cf::cede_to_tick;
1387}
1388
1389sub new($) {
1390 my ($login) = @_;
1391
1392 my $self = create;
1393
1394 $self->ob->name ($login);
1395 $self->{deny_save} = 1;
1396
1397 $cf::PLAYER{$login} = $self;
1398
1399 $self
1400}
1401
1402=item $player->send_msg ($channel, $msg, $color, [extra...])
1403
1404=cut
1405
1406sub send_msg {
1407 my $ns = shift->ns
1408 or return;
1409 $ns->send_msg (@_);
1410}
1411
1412=item $pl->quit_character
1413
1414Nukes the player without looking back. If logged in, the connection will
1415be destroyed. May block for a long time.
1416
1417=cut
1418
1419sub quit_character {
1420 my ($pl) = @_;
1421
1422 my $name = $pl->ob->name;
1423
1424 $pl->{deny_save} = 1;
1425 $pl->password ("*"); # this should lock out the player until we nuked the dir
1426
1427 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1428 $pl->deactivate;
1429 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1430 $pl->ns->destroy if $pl->ns;
1431
1432 my $path = playerdir $pl;
1433 my $temp = "$path~$cf::RUNTIME~deleting~";
1434 aio_rename $path, $temp;
1435 delete $cf::PLAYER{$pl->ob->name};
1436 $pl->destroy;
1437
1438 my $prefix = qr<^~\Q$name\E/>;
1439
1440 # nuke player maps
1441 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1442
1443 IO::AIO::aio_rmtree $temp;
1444}
1445
1446=item $pl->kick
1447
1448Kicks a player out of the game. This destroys the connection.
1449
1450=cut
1451
1452sub kick {
1453 my ($pl, $kicker) = @_;
1454
1455 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1456 $pl->killer ("kicked");
1457 $pl->ns->destroy;
1458}
1459
1460=item cf::player::list_logins
1461
1462Returns am arrayref of all valid playernames in the system, can take a
1463while and may block, so not sync_job-capable, ever.
1464
1465=cut
1466
1467sub list_logins {
1468 my $dirs = aio_readdir $PLAYERDIR
1469 or return [];
1470
1471 my @logins;
1472
1473 for my $login (@$dirs) {
1474 my $path = path $login;
1475
1476 # a .pst is a dead give-away for a valid player
1477 unless (-e "$path.pst") {
1478 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1479 aio_read $fh, 0, 512, my $buf, 0 or next;
1480 $buf !~ /^password -------------$/m or next; # official not-valid tag
1481 }
1482
1483 utf8::decode $login;
1484 push @logins, $login;
1485 }
1486
1487 \@logins
1488}
1489
1490=item $player->maps
1491
1492Returns an arrayref of map paths that are private for this
1493player. May block.
1494
1495=cut
1496
1497sub maps($) {
1498 my ($pl) = @_;
1499
1500 $pl = ref $pl ? $pl->ob->name : $pl;
1501
1502 my $files = aio_readdir playerdir $pl
1503 or return;
1504
1505 my @paths;
1506
1507 for (@$files) {
1508 utf8::decode $_;
1509 next if /\.(?:pl|pst)$/;
1510 next unless /^$PATH_SEP/o;
1511
1512 push @paths, cf::map::normalise "~$pl/$_";
1513 }
1514
1515 \@paths
1516}
1517
1518=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1519
1520Expand crossfire pod fragments into protocol xml.
1521
1522=cut
1523
1524sub expand_cfpod {
1525 ((my $self), (local $_)) = @_;
1526
1527 # escape & and <
1528 s/&/&amp;/g;
1529 s/(?<![BIUGHT])</&lt;/g;
1530
1531 # this is buggy, it needs to properly take care of nested <'s
1532
1533 1 while
1534 # replace B<>, I<>, U<> etc.
1535 s/B<([^\>]*)>/<b>$1<\/b>/
1536 || s/I<([^\>]*)>/<i>$1<\/i>/
1537 || s/U<([^\>]*)>/<u>$1<\/u>/
1538 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1539 # replace G<male|female> tags
1540 || s{G<([^>|]*)\|([^>]*)>}{
1541 $self->gender ? $2 : $1
1542 }ge
1543 # replace H<hint text>
1544 || s{H<([^\>]*)>}
1545 {
1546 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1547 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1548 "")
1549 [$self->{hintmode}]
1550 }ge;
1551
1552 # create single paragraphs (very hackish)
1553 s/(?<=\S)\n(?=\w)/ /g;
1554
1555 # compress some whitespace
1556 s/\s+\n/\n/g; # ws line-ends
1557 s/\n\n+/\n/g; # double lines
1558 s/^\n+//; # beginning lines
1559 s/\n+$//; # ending lines
1560
1561 $_
1562}
1563
1564sub hintmode {
1565 $_[0]{hintmode} = $_[1] if @_ > 1;
1566 $_[0]{hintmode}
1567}
1568
1569=item $player->ext_reply ($msgid, @msg)
1570
1571Sends an ext reply to the player.
1572
1573=cut
1574
1575sub ext_reply($$@) {
1576 my ($self, $id, @msg) = @_;
1577
1578 $self->ns->ext_reply ($id, @msg)
1579}
1580
1581=item $player->ext_msg ($type, @msg)
1582
1583Sends an ext event to the client.
1584
1585=cut
1586
1587sub ext_msg($$@) {
1588 my ($self, $type, @msg) = @_;
1589
1590 $self->ns->ext_msg ($type, @msg);
1591}
1592
1593=head3 cf::region
1594
1595=over 4
1596
1597=cut
1598
1599package cf::region;
1600
1601=item cf::region::find_by_path $path
1602
1603Tries to decuce the likely region for a map knowing only its path.
1604
1605=cut
1606
1607sub find_by_path($) {
1608 my ($path) = @_;
1609
1610 my ($match, $specificity);
1611
1612 for my $region (list) {
1613 if ($region->{match} && $path =~ $region->{match}) {
1614 ($match, $specificity) = ($region, $region->specificity)
1615 if $region->specificity > $specificity;
1616 }
1617 }
1618
1619 $match
1620}
1621
1622=back
1623
1624=head3 cf::map
1625
1626=over 4
1627
1628=cut
1629
1630package cf::map;
1631
1632use Fcntl;
1633use Coro::AIO;
1634
1635use overload
1636 '""' => \&as_string,
1637 fallback => 1;
1638
1639our $MAX_RESET = 3600;
1640our $DEFAULT_RESET = 3000;
1641
1642sub generate_random_map {
1643 my ($self, $rmp) = @_;
1644 # mit "rum" bekleckern, nicht
1645 $self->_create_random_map (
1646 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1647 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1648 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1649 $rmp->{exit_on_final_map},
1650 $rmp->{xsize}, $rmp->{ysize},
1651 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1652 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1653 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1654 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1655 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1656 (cf::region::find $rmp->{region}), $rmp->{custom}
1657 )
1658}
1659
1660=item cf::map->register ($regex, $prio)
1661
1662Register a handler for the map path matching the given regex at the
1663givne priority (higher is better, built-in handlers have priority 0, the
1664default).
1665
1666=cut
1667
1668sub register {
1669 my (undef, $regex, $prio) = @_;
1670 my $pkg = caller;
1671
1672 no strict;
1673 push @{"$pkg\::ISA"}, __PACKAGE__;
1674
1675 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1676}
1677
1678# also paths starting with '/'
1679$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1680
1681sub thawer_merge {
1682 my ($self, $merge) = @_;
1683
1684 # we have to keep some variables in memory intact
1685 local $self->{path};
1686 local $self->{load_path};
1687
1688 $self->SUPER::thawer_merge ($merge);
1689}
1690
1691sub normalise {
1692 my ($path, $base) = @_;
1693
1694 $path = "$path"; # make sure its a string
1695
1696 $path =~ s/\.map$//;
1697
1698 # map plan:
1699 #
1700 # /! non-realised random map exit (special hack!)
1701 # {... are special paths that are not being touched
1702 # ?xxx/... are special absolute paths
1703 # ?random/... random maps
1704 # /... normal maps
1705 # ~user/... per-player map of a specific user
1706
1707 $path =~ s/$PATH_SEP/\//go;
1708
1709 # treat it as relative path if it starts with
1710 # something that looks reasonable
1711 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1712 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1713
1714 $base =~ s{[^/]+/?$}{};
1715 $path = "$base/$path";
1716 }
1717
1718 for ($path) {
1719 redo if s{//}{/};
1720 redo if s{/\.?/}{/};
1721 redo if s{/[^/]+/\.\./}{/};
1722 }
1723
1724 $path
1725}
1726
1727sub new_from_path {
1728 my (undef, $path, $base) = @_;
1729
1730 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1731
1732 $path = normalise $path, $base;
1733
1734 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1735 if ($path =~ $EXT_MAP{$pkg}[1]) {
1736 my $self = bless cf::map::new, $pkg;
1737 $self->{path} = $path; $self->path ($path);
1738 $self->init; # pass $1 etc.
1739 return $self;
1740 }
1741 }
1742
1743 Carp::cluck "unable to resolve path '$path' (base '$base').";
1744 ()
1745}
1746
1747sub init {
1748 my ($self) = @_;
1749
1750 $self
1751}
1752
1753sub as_string {
1754 my ($self) = @_;
1755
1756 "$self->{path}"
1757}
1758
1759# the displayed name, this is a one way mapping
1760sub visible_name {
1761 &as_string
1762}
1763
1764# the original (read-only) location
1765sub load_path {
1766 my ($self) = @_;
1767
1768 "$MAPDIR/$self->{path}.map"
1769}
1770
1771# the temporary/swap location
1772sub save_path {
1773 my ($self) = @_;
1774
1775 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1776 "$TMPDIR/$path.map"
1777}
1778
1779# the unique path, undef == no special unique path
1780sub uniq_path {
1781 my ($self) = @_;
1782
1783 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1784 "$UNIQUEDIR/$path"
1785}
1786
1787# and all this just because we cannot iterate over
1788# all maps in C++...
1789sub change_all_map_light {
1790 my ($change) = @_;
1791
1792 $_->change_map_light ($change)
1793 for grep $_->outdoor, values %cf::MAP;
1794}
1795
1796sub decay_objects {
1797 my ($self) = @_;
1798
1799 return if $self->{deny_reset};
1800
1801 $self->do_decay_objects;
1802}
1803
1804sub unlink_save {
1805 my ($self) = @_;
1806
1807 utf8::encode (my $save = $self->save_path);
1808 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1809 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1810}
1811
1812sub load_header_from($) {
1813 my ($self, $path) = @_;
1814
1815 utf8::encode $path;
1816 my $f = new_from_file cf::object::thawer $path
1817 or return;
1818
1819 $self->_load_header ($f)
1820 or return;
1821
1822 local $MAP_LOADING{$self->{path}} = $self;
1823 $f->resolve_delayed_derefs;
1824
1825 $self->{load_path} = $path;
1826
1827 1
1828}
1829
1830sub load_header_orig {
1831 my ($self) = @_;
1832
1833 $self->load_header_from ($self->load_path)
1834}
1835
1836sub load_header_temp {
1837 my ($self) = @_;
1838
1839 $self->load_header_from ($self->save_path)
1840}
1841
1842sub prepare_temp {
1843 my ($self) = @_;
1844
1845 $self->last_access ((delete $self->{last_access})
1846 || $cf::RUNTIME); #d#
1847 # safety
1848 $self->{instantiate_time} = $cf::RUNTIME
1849 if $self->{instantiate_time} > $cf::RUNTIME;
1850}
1851
1852sub prepare_orig {
1853 my ($self) = @_;
1854
1855 $self->{load_original} = 1;
1856 $self->{instantiate_time} = $cf::RUNTIME;
1857 $self->last_access ($cf::RUNTIME);
1858 $self->instantiate;
1859}
1860
1861sub load_header {
1862 my ($self) = @_;
1863
1864 if ($self->load_header_temp) {
1865 $self->prepare_temp;
1866 } else {
1867 $self->load_header_orig
1868 or return;
1869 $self->prepare_orig;
1870 }
1871
1872 $self->{deny_reset} = 1
1873 if $self->no_reset;
1874
1875 $self->default_region (cf::region::find_by_path $self->{path})
1876 unless $self->default_region;
1877
1878 1
1879}
1880
1881sub find;
1882sub find {
1883 my ($path, $origin) = @_;
1884
1885 $path = normalise $path, $origin && $origin->path;
1886
1887 cf::lock_wait "map_data:$path";#d#remove
1888 cf::lock_wait "map_find:$path";
1889
1890 $cf::MAP{$path} || do {
1891 my $guard1 = cf::lock_acquire "map_find:$path";
1892 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1893
1894 my $map = new_from_path cf::map $path
1895 or return;
1896
1897 $map->{last_save} = $cf::RUNTIME;
1898
1899 $map->load_header
1900 or return;
1901
1902 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1903 # doing this can freeze the server in a sync job, obviously
1904 #$cf::WAIT_FOR_TICK->wait;
1905 undef $guard1;
1906 undef $guard2;
1907 $map->reset;
1908 return find $path;
1909 }
1910
1911 $cf::MAP{$path} = $map
1912 }
1913}
1914
1915sub pre_load { }
1916sub post_load { }
1917
1918sub load {
1919 my ($self) = @_;
1920
1921 local $self->{deny_reset} = 1; # loading can take a long time
1922
1923 my $path = $self->{path};
1924
1925 {
1926 my $guard = cf::lock_acquire "map_data:$path";
1927
1928 return unless $self->valid;
1929 return unless $self->in_memory == cf::MAP_SWAPPED;
1930
1931 $self->in_memory (cf::MAP_LOADING);
1932
1933 $self->alloc;
1934
1935 $self->pre_load;
1936 cf::cede_to_tick;
1937
1938 my $f = new_from_file cf::object::thawer $self->{load_path};
1939 $f->skip_block;
1940 $self->_load_objects ($f)
1941 or return;
1942
1943 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1944 if delete $self->{load_original};
1945
1946 if (my $uniq = $self->uniq_path) {
1947 utf8::encode $uniq;
1948 unless (aio_stat $uniq) {
1949 if (my $f = new_from_file cf::object::thawer $uniq) {
1950 $self->clear_unique_items;
1951 $self->_load_objects ($f);
1952 $f->resolve_delayed_derefs;
729 } 1953 }
730 } 1954 }
731 } else {
732 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
733 } 1955 }
734 1956
735 cf::override; 1957 $f->resolve_delayed_derefs;
1958
1959 cf::cede_to_tick;
1960 # now do the right thing for maps
1961 $self->link_multipart_objects;
1962 $self->difficulty ($self->estimate_difficulty)
1963 unless $self->difficulty;
1964 cf::cede_to_tick;
1965
1966 unless ($self->{deny_activate}) {
1967 $self->decay_objects;
1968 $self->fix_auto_apply;
1969 $self->update_buttons;
1970 cf::cede_to_tick;
1971 $self->set_darkness_map;
1972 cf::cede_to_tick;
1973 $self->activate;
1974 }
1975
1976 $self->{last_save} = $cf::RUNTIME;
1977 $self->last_access ($cf::RUNTIME);
1978
1979 $self->in_memory (cf::MAP_IN_MEMORY);
736 }, 1980 }
737;
738 1981
739############################################################################# 1982 $self->post_load;
740# load/save/clean perl data associated with a map 1983}
741 1984
742*cf::mapsupport::on_clean = sub { 1985sub customise_for {
1986 my ($self, $ob) = @_;
1987
1988 return find "~" . $ob->name . "/" . $self->{path}
1989 if $self->per_player;
1990
1991# return find "?party/" . $ob->name . "/" . $self->{path}
1992# if $self->per_party;
1993
1994 $self
1995}
1996
1997# find and load all maps in the 3x3 area around a map
1998sub load_neighbours {
743 my ($map) = @_; 1999 my ($map) = @_;
744 2000
745 my $path = $map->tmpname; 2001 my @neigh; # diagonal neighbours
746 defined $path or return;
747 2002
748 unlink "$path.pst"; 2003 for (0 .. 3) {
749}; 2004 my $neigh = $map->tile_path ($_)
2005 or next;
2006 $neigh = find $neigh, $map
2007 or next;
2008 $neigh->load;
750 2009
751attach_to_maps prio => -10000, package => cf::mapsupport::; 2010 push @neigh,
2011 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2012 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2013 }
752 2014
753############################################################################# 2015 for (grep defined $_->[0], @neigh) {
754# load/save perl data associated with player->ob objects 2016 my ($path, $origin) = @$_;
755 2017 my $neigh = find $path, $origin
756sub all_objects(@) { 2018 or next;
757 @_, map all_objects ($_->inv), @_ 2019 $neigh->load;
2020 }
758} 2021}
759 2022
760# TODO: compatibility cruft, remove when no longer needed 2023sub find_sync {
761attach_to_players 2024 my ($path, $origin) = @_;
762 on_load => sub {
763 my ($pl, $path) = @_;
764 2025
765 for my $o (all_objects $pl->ob) { 2026 cf::sync_job { find $path, $origin }
766 if (my $value = $o->get_ob_key_value ("_perl_data")) { 2027}
767 $o->set_ob_key_value ("_perl_data");
768 2028
769 %$o = %{ Storable::thaw pack "H*", $value }; 2029sub do_load_sync {
2030 my ($map) = @_;
2031
2032 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2033 if $Coro::current == $Coro::main;
2034
2035 cf::sync_job { $map->load };
2036}
2037
2038our %MAP_PREFETCH;
2039our $MAP_PREFETCHER = undef;
2040
2041sub find_async {
2042 my ($path, $origin, $load) = @_;
2043
2044 $path = normalise $path, $origin && $origin->{path};
2045
2046 if (my $map = $cf::MAP{$path}) {
2047 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
2048 }
2049
2050 $MAP_PREFETCH{$path} |= $load;
2051
2052 $MAP_PREFETCHER ||= cf::async {
2053 $Coro::current->{desc} = "map prefetcher";
2054
2055 while (%MAP_PREFETCH) {
2056 while (my ($k, $v) = each %MAP_PREFETCH) {
2057 if (my $map = find $k) {
2058 $map->load if $v;
2059 }
2060
2061 delete $MAP_PREFETCH{$k};
770 } 2062 }
771 } 2063 }
2064 undef $MAP_PREFETCHER;
2065 };
2066 $MAP_PREFETCHER->prio (6);
2067
2068 ()
2069}
2070
2071sub save {
2072 my ($self) = @_;
2073
2074 my $lock = cf::lock_acquire "map_data:$self->{path}";
2075
2076 $self->{last_save} = $cf::RUNTIME;
2077
2078 return unless $self->dirty;
2079
2080 my $save = $self->save_path; utf8::encode $save;
2081 my $uniq = $self->uniq_path; utf8::encode $uniq;
2082
2083 $self->{load_path} = $save;
2084
2085 return if $self->{deny_save};
2086
2087 local $self->{last_access} = $self->last_access;#d#
2088
2089 cf::async {
2090 $Coro::current->{desc} = "map player save";
2091 $_->contr->save for $self->players;
2092 };
2093
2094 if ($uniq) {
2095 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2096 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2097 } else {
2098 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
772 }, 2099 }
773; 2100}
774 2101
775############################################################################# 2102sub swap_out {
2103 my ($self) = @_;
776 2104
777=head2 CORE EXTENSIONS 2105 # save first because save cedes
2106 $self->save;
778 2107
779Functions and methods that extend core crossfire objects. 2108 my $lock = cf::lock_acquire "map_data:$self->{path}";
2109
2110 return if $self->players;
2111 return if $self->in_memory != cf::MAP_IN_MEMORY;
2112 return if $self->{deny_save};
2113
2114 $self->in_memory (cf::MAP_SWAPPED);
2115
2116 $self->deactivate;
2117 $_->clear_links_to ($self) for values %cf::MAP;
2118 $self->clear;
2119}
2120
2121sub reset_at {
2122 my ($self) = @_;
2123
2124 # TODO: safety, remove and allow resettable per-player maps
2125 return 1e99 if $self->{deny_reset};
2126
2127 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2128 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2129
2130 $time + $to
2131}
2132
2133sub should_reset {
2134 my ($self) = @_;
2135
2136 $self->reset_at <= $cf::RUNTIME
2137}
2138
2139sub reset {
2140 my ($self) = @_;
2141
2142 my $lock = cf::lock_acquire "map_data:$self->{path}";
2143
2144 return if $self->players;
2145
2146 warn "resetting map ", $self->path;
2147
2148 $self->in_memory (cf::MAP_SWAPPED);
2149
2150 # need to save uniques path
2151 unless ($self->{deny_save}) {
2152 my $uniq = $self->uniq_path; utf8::encode $uniq;
2153
2154 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2155 if $uniq;
2156 }
2157
2158 delete $cf::MAP{$self->path};
2159
2160 $self->deactivate;
2161 $_->clear_links_to ($self) for values %cf::MAP;
2162 $self->clear;
2163
2164 $self->unlink_save;
2165 $self->destroy;
2166}
2167
2168my $nuke_counter = "aaaa";
2169
2170sub nuke {
2171 my ($self) = @_;
2172
2173 {
2174 my $lock = cf::lock_acquire "map_data:$self->{path}";
2175
2176 delete $cf::MAP{$self->path};
2177
2178 $self->unlink_save;
2179
2180 bless $self, "cf::map";
2181 delete $self->{deny_reset};
2182 $self->{deny_save} = 1;
2183 $self->reset_timeout (1);
2184 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2185
2186 $cf::MAP{$self->path} = $self;
2187 }
2188
2189 $self->reset; # polite request, might not happen
2190}
2191
2192=item $maps = cf::map::tmp_maps
2193
2194Returns an arrayref with all map paths of currently instantiated and saved
2195maps. May block.
2196
2197=cut
2198
2199sub tmp_maps() {
2200 [
2201 map {
2202 utf8::decode $_;
2203 /\.map$/
2204 ? normalise $_
2205 : ()
2206 } @{ aio_readdir $TMPDIR or [] }
2207 ]
2208}
2209
2210=item $maps = cf::map::random_maps
2211
2212Returns an arrayref with all map paths of currently instantiated and saved
2213random maps. May block.
2214
2215=cut
2216
2217sub random_maps() {
2218 [
2219 map {
2220 utf8::decode $_;
2221 /\.map$/
2222 ? normalise "?random/$_"
2223 : ()
2224 } @{ aio_readdir $RANDOMDIR or [] }
2225 ]
2226}
2227
2228=item cf::map::unique_maps
2229
2230Returns an arrayref of paths of all shared maps that have
2231instantiated unique items. May block.
2232
2233=cut
2234
2235sub unique_maps() {
2236 [
2237 map {
2238 utf8::decode $_;
2239 /\.map$/
2240 ? normalise $_
2241 : ()
2242 } @{ aio_readdir $UNIQUEDIR or [] }
2243 ]
2244}
2245
2246package cf;
2247
2248=back
2249
2250=head3 cf::object
2251
2252=cut
2253
2254package cf::object;
780 2255
781=over 4 2256=over 4
782 2257
783=item cf::player::exists $login 2258=item $ob->inv_recursive
784 2259
785Returns true when the given account exists. 2260Returns the inventory of the object _and_ their inventories, recursively.
786 2261
787=cut 2262=cut
788 2263
789sub cf::player::exists($) { 2264sub inv_recursive_;
790 cf::player::find $_[0] 2265sub inv_recursive_ {
791 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2266 map { $_, inv_recursive_ $_->inv } @_
792} 2267}
2268
2269sub inv_recursive {
2270 inv_recursive_ inv $_[0]
2271}
2272
2273=item $ref = $ob->ref
2274
2275creates and returns a persistent reference to an objetc that can be stored as a string.
2276
2277=item $ob = cf::object::deref ($refstring)
2278
2279returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2280even if the object actually exists. May block.
2281
2282=cut
2283
2284sub deref {
2285 my ($ref) = @_;
2286
2287 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2288 my ($uuid, $name) = ($1, $2);
2289 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2290 or return;
2291 $pl->ob->uuid eq $uuid
2292 or return;
2293
2294 $pl->ob
2295 } else {
2296 warn "$ref: cannot resolve object reference\n";
2297 undef
2298 }
2299}
2300
2301package cf;
2302
2303=back
2304
2305=head3 cf::object::player
2306
2307=over 4
793 2308
794=item $player_object->reply ($npc, $msg[, $flags]) 2309=item $player_object->reply ($npc, $msg[, $flags])
795 2310
796Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2311Sends 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 2312can be C<undef>. Does the right thing when the player is currently in a
799 2314
800=cut 2315=cut
801 2316
802# rough implementation of a future "reply" method that works 2317# rough implementation of a future "reply" method that works
803# with dialog boxes. 2318# with dialog boxes.
2319#TODO: the first argument must go, split into a $npc->reply_to ( method
804sub cf::object::player::reply($$$;$) { 2320sub cf::object::player::reply($$$;$) {
805 my ($self, $npc, $msg, $flags) = @_; 2321 my ($self, $npc, $msg, $flags) = @_;
806 2322
807 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2323 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
808 2324
809 if ($self->{record_replies}) { 2325 if ($self->{record_replies}) {
810 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2326 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2327
811 } else { 2328 } else {
2329 my $pl = $self->contr;
2330
2331 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2332 my $dialog = $pl->{npc_dialog};
2333 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2334
2335 } else {
812 $msg = $npc->name . " says: $msg" if $npc; 2336 $msg = $npc->name . " says: $msg" if $npc;
813 $self->message ($msg, $flags); 2337 $self->message ($msg, $flags);
2338 }
814 } 2339 }
815} 2340}
816 2341
817=item $player->ext_reply ($msgid, $msgtype, %msg) 2342=item $object->send_msg ($channel, $msg, $color, [extra...])
818 2343
819Sends an ext reply to the player.
820
821=cut 2344=cut
822 2345
823sub cf::player::ext_reply($$$%) { 2346sub cf::object::send_msg {
824 my ($self, $id, %msg) = @_; 2347 my $pl = shift->contr
825 2348 or return;
826 $msg{msgid} = $id; 2349 $pl->send_msg (@_);
827
828 $self->send ("ext " . to_json \%msg);
829} 2350}
830 2351
831=item $player_object->may ("access") 2352=item $player_object->may ("access")
832 2353
833Returns wether the given player is authorized to access resource "access" 2354Returns wether the given player is authorized to access resource "access"
842 (ref $cf::CFG{"may_$access"} 2363 (ref $cf::CFG{"may_$access"}
843 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2364 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
844 : $cf::CFG{"may_$access"}) 2365 : $cf::CFG{"may_$access"})
845} 2366}
846 2367
847=cut 2368=item $player_object->enter_link
848 2369
849############################################################################# 2370Freezes the player and moves him/her to a special map (C<{link}>).
2371
2372The player should be reasonably safe there for short amounts of time. You
2373I<MUST> call C<leave_link> as soon as possible, though.
2374
2375Will never block.
2376
2377=item $player_object->leave_link ($map, $x, $y)
2378
2379Moves the player out of the special C<{link}> map onto the specified
2380map. If the map is not valid (or omitted), the player will be moved back
2381to the location he/she was before the call to C<enter_link>, or, if that
2382fails, to the emergency map position.
2383
2384Might block.
2385
2386=cut
2387
2388sub link_map {
2389 unless ($LINK_MAP) {
2390 $LINK_MAP = cf::map::find "{link}"
2391 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2392 $LINK_MAP->load;
2393 }
2394
2395 $LINK_MAP
2396}
2397
2398sub cf::object::player::enter_link {
2399 my ($self) = @_;
2400
2401 $self->deactivate_recursive;
2402
2403 return if UNIVERSAL::isa $self->map, "ext::map_link";
2404
2405 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2406 if $self->map && $self->map->{path} ne "{link}";
2407
2408 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2409}
2410
2411sub cf::object::player::leave_link {
2412 my ($self, $map, $x, $y) = @_;
2413
2414 return unless $self->contr->active;
2415
2416 my $link_pos = delete $self->{_link_pos};
2417
2418 unless ($map) {
2419 # restore original map position
2420 ($map, $x, $y) = @{ $link_pos || [] };
2421 $map = cf::map::find $map;
2422
2423 unless ($map) {
2424 ($map, $x, $y) = @$EMERGENCY_POSITION;
2425 $map = cf::map::find $map
2426 or die "FATAL: cannot load emergency map\n";
2427 }
2428 }
2429
2430 ($x, $y) = (-1, -1)
2431 unless (defined $x) && (defined $y);
2432
2433 # use -1 or undef as default coordinates, not 0, 0
2434 ($x, $y) = ($map->enter_x, $map->enter_y)
2435 if $x <=0 && $y <= 0;
2436
2437 $map->load;
2438 $map->load_neighbours;
2439
2440 return unless $self->contr->active;
2441 $self->activate_recursive;
2442
2443 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2444 $self->enter_map ($map, $x, $y);
2445}
2446
2447=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2448
2449Moves the player to the given map-path and coordinates by first freezing
2450her, loading and preparing them map, calling the provided $check callback
2451that has to return the map if sucecssful, and then unfreezes the player on
2452the new (success) or old (failed) map position. In either case, $done will
2453be called at the end of this process.
2454
2455=cut
2456
2457our $GOTOGEN;
2458
2459sub cf::object::player::goto {
2460 my ($self, $path, $x, $y, $check, $done) = @_;
2461
2462 # do generation counting so two concurrent goto's will be executed in-order
2463 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2464
2465 $self->enter_link;
2466
2467 (async {
2468 $Coro::current->{desc} = "player::goto $path $x $y";
2469
2470 # *tag paths override both path and x|y
2471 if ($path =~ /^\*(.*)$/) {
2472 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2473 my $ob = $obs[rand @obs];
2474
2475 # see if we actually can go there
2476 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2477 $ob = $obs[rand @obs];
2478 } else {
2479 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2480 }
2481 # else put us there anyways for now #d#
2482
2483 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2484 } else {
2485 ($path, $x, $y) = (undef, undef, undef);
2486 }
2487 }
2488
2489 my $map = eval {
2490 my $map = defined $path ? cf::map::find $path : undef;
2491
2492 if ($map) {
2493 $map = $map->customise_for ($self);
2494 $map = $check->($map) if $check && $map;
2495 } else {
2496 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2497 }
2498
2499 $map
2500 };
2501
2502 if ($@) {
2503 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2504 LOG llevError | logBacktrace, Carp::longmess $@;
2505 }
2506
2507 if ($gen == $self->{_goto_generation}) {
2508 delete $self->{_goto_generation};
2509 $self->leave_link ($map, $x, $y);
2510 }
2511
2512 $done->() if $done;
2513 })->prio (1);
2514}
2515
2516=item $player_object->enter_exit ($exit_object)
2517
2518=cut
2519
2520sub parse_random_map_params {
2521 my ($spec) = @_;
2522
2523 my $rmp = { # defaults
2524 xsize => (cf::rndm 15, 40),
2525 ysize => (cf::rndm 15, 40),
2526 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2527 #layout => string,
2528 };
2529
2530 for (split /\n/, $spec) {
2531 my ($k, $v) = split /\s+/, $_, 2;
2532
2533 $rmp->{lc $k} = $v if (length $k) && (length $v);
2534 }
2535
2536 $rmp
2537}
2538
2539sub prepare_random_map {
2540 my ($exit) = @_;
2541
2542 my $guard = cf::lock_acquire "exit_prepare:$exit";
2543
2544 # all this does is basically replace the /! path by
2545 # a new random map path (?random/...) with a seed
2546 # that depends on the exit object
2547
2548 my $rmp = parse_random_map_params $exit->msg;
2549
2550 if ($exit->map) {
2551 $rmp->{region} = $exit->region->name;
2552 $rmp->{origin_map} = $exit->map->path;
2553 $rmp->{origin_x} = $exit->x;
2554 $rmp->{origin_y} = $exit->y;
2555 }
2556
2557 $rmp->{random_seed} ||= $exit->random_seed;
2558
2559 my $data = cf::to_json $rmp;
2560 my $md5 = Digest::MD5::md5_hex $data;
2561 my $meta = "$RANDOMDIR/$md5.meta";
2562
2563 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2564 aio_write $fh, 0, (length $data), $data, 0;
2565 undef $fh;
2566 aio_rename "$meta~", $meta;
2567
2568 $exit->slaying ("?random/$md5");
2569 $exit->msg (undef);
2570 }
2571}
2572
2573sub cf::object::player::enter_exit {
2574 my ($self, $exit) = @_;
2575
2576 return unless $self->type == cf::PLAYER;
2577
2578 if ($exit->slaying eq "/!") {
2579 #TODO: this should de-fi-ni-te-ly not be a sync-job
2580 # the problem is that $exit might not survive long enough
2581 # so it needs to be done right now, right here
2582 cf::sync_job { prepare_random_map $exit };
2583 }
2584
2585 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2586 my $hp = $exit->stats->hp;
2587 my $sp = $exit->stats->sp;
2588
2589 $self->enter_link;
2590
2591 # if exit is damned, update players death & WoR home-position
2592 $self->contr->savebed ($slaying, $hp, $sp)
2593 if $exit->flag (FLAG_DAMNED);
2594
2595 (async {
2596 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2597
2598 $self->deactivate_recursive; # just to be sure
2599 unless (eval {
2600 $self->goto ($slaying, $hp, $sp);
2601
2602 1;
2603 }) {
2604 $self->message ("Something went wrong deep within the crossfire server. "
2605 . "I'll try to bring you back to the map you were before. "
2606 . "Please report this to the dungeon master!",
2607 cf::NDI_UNIQUE | cf::NDI_RED);
2608
2609 warn "ERROR in enter_exit: $@";
2610 $self->leave_link;
2611 }
2612 })->prio (1);
2613}
2614
2615=head3 cf::client
2616
2617=over 4
2618
2619=item $client->send_drawinfo ($text, $flags)
2620
2621Sends a drawinfo packet to the client. Circumvents output buffering so
2622should not be used under normal circumstances.
2623
2624=cut
2625
2626sub cf::client::send_drawinfo {
2627 my ($self, $text, $flags) = @_;
2628
2629 utf8::encode $text;
2630 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2631}
2632
2633=item $client->send_msg ($channel, $msg, $color, [extra...])
2634
2635Send a drawinfo or msg packet to the client, formatting the msg for the
2636client if neccessary. C<$type> should be a string identifying the type of
2637the message, with C<log> being the default. If C<$color> is negative, suppress
2638the message unless the client supports the msg packet.
2639
2640=cut
2641
2642our %CHANNEL = (
2643 "c/identify" => {
2644 id => "infobox",
2645 title => "Identify",
2646 reply => undef,
2647 tooltip => "Items recently identified",
2648 },
2649 "c/examine" => {
2650 id => "infobox",
2651 title => "Examine",
2652 reply => undef,
2653 tooltip => "Signs and other items you examined",
2654 },
2655 "c/lookat" => {
2656 id => "infobox",
2657 title => "Look",
2658 reply => undef,
2659 tooltip => "What you saw there",
2660 },
2661);
2662
2663sub cf::client::send_msg {
2664 my ($self, $channel, $msg, $color, @extra) = @_;
2665
2666 $msg = $self->pl->expand_cfpod ($msg);
2667
2668 $color &= cf::NDI_CLIENT_MASK; # just in case...
2669
2670 # check predefined channels, for the benefit of C
2671 if ($CHANNEL{$channel}) {
2672 $channel = $CHANNEL{$channel};
2673
2674 $self->ext_msg (channel_info => $channel)
2675 if $self->can_msg;
2676
2677 $channel = $channel->{id};
2678
2679 } elsif (ref $channel) {
2680 # send meta info to client, if not yet sent
2681 unless (exists $self->{channel}{$channel->{id}}) {
2682 $self->{channel}{$channel->{id}} = $channel;
2683 $self->ext_msg (channel_info => $channel)
2684 if $self->can_msg;
2685 }
2686
2687 $channel = $channel->{id};
2688 }
2689
2690 return unless @extra || length $msg;
2691
2692 if ($self->can_msg) {
2693 # default colour, mask it out
2694 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2695 if $color & cf::NDI_DEF;
2696
2697 $self->send_packet ("msg " . $self->{json_coder}->encode (
2698 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2699 } else {
2700 if ($color >= 0) {
2701 # replace some tags by gcfclient-compatible ones
2702 for ($msg) {
2703 1 while
2704 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2705 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2706 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2707 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2708 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2709 }
2710
2711 $color &= cf::NDI_COLOR_MASK;
2712
2713 utf8::encode $msg;
2714
2715 if (0 && $msg =~ /\[/) {
2716 # COMMAND/INFO
2717 $self->send_packet ("drawextinfo $color 10 8 $msg")
2718 } else {
2719 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2720 $self->send_packet ("drawinfo $color $msg")
2721 }
2722 }
2723 }
2724}
2725
2726=item $client->ext_msg ($type, @msg)
2727
2728Sends an ext event to the client.
2729
2730=cut
2731
2732sub cf::client::ext_msg($$@) {
2733 my ($self, $type, @msg) = @_;
2734
2735 if ($self->extcmd == 2) {
2736 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2737 } elsif ($self->extcmd == 1) { # TODO: remove
2738 push @msg, msgtype => "event_$type";
2739 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2740 }
2741}
2742
2743=item $client->ext_reply ($msgid, @msg)
2744
2745Sends an ext reply to the client.
2746
2747=cut
2748
2749sub cf::client::ext_reply($$@) {
2750 my ($self, $id, @msg) = @_;
2751
2752 if ($self->extcmd == 2) {
2753 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2754 } elsif ($self->extcmd == 1) {
2755 #TODO: version 1, remove
2756 unshift @msg, msgtype => "reply", msgid => $id;
2757 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2758 }
2759}
2760
2761=item $success = $client->query ($flags, "text", \&cb)
2762
2763Queues a query to the client, calling the given callback with
2764the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2765C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2766
2767Queries can fail, so check the return code. Or don't, as queries will
2768become reliable at some point in the future.
2769
2770=cut
2771
2772sub cf::client::query {
2773 my ($self, $flags, $text, $cb) = @_;
2774
2775 return unless $self->state == ST_PLAYING
2776 || $self->state == ST_SETUP
2777 || $self->state == ST_CUSTOM;
2778
2779 $self->state (ST_CUSTOM);
2780
2781 utf8::encode $text;
2782 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2783
2784 $self->send_packet ($self->{query_queue}[0][0])
2785 if @{ $self->{query_queue} } == 1;
2786
2787 1
2788}
2789
2790cf::client->attach (
2791 on_connect => sub {
2792 my ($ns) = @_;
2793
2794 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2795 },
2796 on_reply => sub {
2797 my ($ns, $msg) = @_;
2798
2799 # this weird shuffling is so that direct followup queries
2800 # get handled first
2801 my $queue = delete $ns->{query_queue}
2802 or return; # be conservative, not sure how that can happen, but we saw a crash here
2803
2804 (shift @$queue)->[1]->($msg);
2805 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2806
2807 push @{ $ns->{query_queue} }, @$queue;
2808
2809 if (@{ $ns->{query_queue} } == @$queue) {
2810 if (@$queue) {
2811 $ns->send_packet ($ns->{query_queue}[0][0]);
2812 } else {
2813 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2814 }
2815 }
2816 },
2817 on_exticmd => sub {
2818 my ($ns, $buf) = @_;
2819
2820 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2821
2822 if (ref $msg) {
2823 my ($type, $reply, @payload) =
2824 "ARRAY" eq ref $msg
2825 ? @$msg
2826 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2827
2828 my @reply;
2829
2830 if (my $cb = $EXTICMD{$type}) {
2831 @reply = $cb->($ns, @payload);
2832 }
2833
2834 $ns->ext_reply ($reply, @reply)
2835 if $reply;
2836
2837 } else {
2838 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2839 }
2840
2841 cf::override;
2842 },
2843);
2844
2845=item $client->async (\&cb)
2846
2847Create a new coroutine, running the specified callback. The coroutine will
2848be automatically cancelled when the client gets destroyed (e.g. on logout,
2849or loss of connection).
2850
2851=cut
2852
2853sub cf::client::async {
2854 my ($self, $cb) = @_;
2855
2856 my $coro = &Coro::async ($cb);
2857
2858 $coro->on_destroy (sub {
2859 delete $self->{_coro}{$coro+0};
2860 });
2861
2862 $self->{_coro}{$coro+0} = $coro;
2863
2864 $coro
2865}
2866
2867cf::client->attach (
2868 on_destroy => sub {
2869 my ($ns) = @_;
2870
2871 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2872 },
2873);
2874
2875=back
2876
850 2877
851=head2 SAFE SCRIPTING 2878=head2 SAFE SCRIPTING
852 2879
853Functions that provide a safe environment to compile and execute 2880Functions that provide a safe environment to compile and execute
854snippets of perl code without them endangering the safety of the server 2881snippets of perl code without them endangering the safety of the server
861our $safe = new Safe "safe"; 2888our $safe = new Safe "safe";
862our $safe_hole = new Safe::Hole; 2889our $safe_hole = new Safe::Hole;
863 2890
864$SIG{FPE} = 'IGNORE'; 2891$SIG{FPE} = 'IGNORE';
865 2892
866$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2893$safe->permit_only (Opcode::opset qw(
2894 :base_core :base_mem :base_orig :base_math
2895 grepstart grepwhile mapstart mapwhile
2896 sort time
2897));
867 2898
868# here we export the classes and methods available to script code 2899# here we export the classes and methods available to script code
869 2900
870=pod 2901=pod
871 2902
872The following fucntions and emthods are available within a safe environment: 2903The following functions and methods are available within a safe environment:
873 2904
874 cf::object contr pay_amount pay_player 2905 cf::object
2906 contr pay_amount pay_player map x y force_find force_add destroy
2907 insert remove name archname title slaying race decrease_ob_nr
2908
875 cf::object::player player 2909 cf::object::player
876 cf::player peaceful 2910 player
2911
2912 cf::player
2913 peaceful
2914
2915 cf::map
2916 trigger
877 2917
878=cut 2918=cut
879 2919
880for ( 2920for (
881 ["cf::object" => qw(contr pay_amount pay_player)], 2921 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2922 insert remove inv name archname title slaying race
2923 decrease_ob_nr destroy)],
882 ["cf::object::player" => qw(player)], 2924 ["cf::object::player" => qw(player)],
883 ["cf::player" => qw(peaceful)], 2925 ["cf::player" => qw(peaceful)],
2926 ["cf::map" => qw(trigger)],
884) { 2927) {
885 no strict 'refs'; 2928 no strict 'refs';
886 my ($pkg, @funs) = @$_; 2929 my ($pkg, @funs) = @$_;
887 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2930 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
888 for @funs; 2931 for @funs;
956=back 2999=back
957 3000
958=cut 3001=cut
959 3002
960############################################################################# 3003#############################################################################
3004# the server's init and main functions
961 3005
962=head2 EXTENSION DATABASE SUPPORT 3006sub load_facedata($) {
3007 my ($path) = @_;
963 3008
964Crossfire maintains a very simple database for extension use. It can 3009 # HACK to clear player env face cache, we need some signal framework
965currently store anything that can be serialised using Storable, which 3010 # for this (global event?)
966excludes objects. 3011 %ext::player_env::MUSIC_FACE_CACHE = ();
967 3012
968The parameter C<$family> should best start with the name of the extension 3013 my $enc = JSON::XS->new->utf8->canonical->relaxed;
969using it, it should be unique.
970 3014
971=over 4 3015 warn "loading facedata from $path\n";
972 3016
973=item $hashref = cf::db_get $family 3017 my $facedata;
3018 0 < aio_load $path, $facedata
3019 or die "$path: $!";
974 3020
975Return a hashref for use by the extension C<$family>, which can be 3021 $facedata = Coro::Storable::thaw $facedata;
976modified. After modifications, you have to call C<cf::db_dirty> or
977C<cf::db_sync>.
978 3022
979=item $value = cf::db_get $family => $key 3023 $facedata->{version} == 2
3024 or cf::cleanup "$path: version mismatch, cannot proceed.";
980 3025
981Returns a single value from the database 3026 # patch in the exptable
982 3027 $facedata->{resource}{"res/exp_table"} = {
983=item cf::db_put $family => $hashref 3028 type => FT_RSRC,
984 3029 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 }); 3030 };
3031 cf::cede_to_tick;
1036 3032
1037 sub db_dirty() {
1038 $dirty = 1;
1039 $idle->start;
1040 } 3033 {
3034 my $faces = $facedata->{faceinfo};
1041 3035
1042 sub db_get($;$) { 3036 while (my ($face, $info) = each %$faces) {
1043 @_ >= 2 3037 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1044 ? $DB->{$_[0]}{$_[1]} 3038 cf::face::set_visibility $idx, $info->{visibility};
1045 : ($DB->{$_[0]} ||= { }) 3039 cf::face::set_magicmap $idx, $info->{magicmap};
1046 } 3040 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
3041 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1047 3042
1048 sub db_put($$;$) { 3043 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 }, 3044 }
3045
3046 while (my ($face, $info) = each %$faces) {
3047 next unless $info->{smooth};
3048 my $idx = cf::face::find $face
3049 or next;
3050 if (my $smooth = cf::face::find $info->{smooth}) {
3051 cf::face::set_smooth $idx, $smooth;
3052 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3053 } else {
3054 warn "smooth face '$info->{smooth}' not found for face '$face'";
3055 }
3056
3057 cf::cede_to_tick;
3058 }
1062 ; 3059 }
1063}
1064 3060
1065############################################################################# 3061 {
1066# the server's main() 3062 my $anims = $facedata->{animinfo};
1067 3063
1068sub cfg_load { 3064 while (my ($anim, $info) = each %$anims) {
3065 cf::anim::set $anim, $info->{frames}, $info->{facings};
3066 cf::cede_to_tick;
3067 }
3068
3069 cf::anim::invalidate_all; # d'oh
3070 }
3071
3072 {
3073 # TODO: for gcfclient pleasure, we should give resources
3074 # that gcfclient doesn't grok a >10000 face index.
3075 my $res = $facedata->{resource};
3076
3077 my $soundconf = delete $res->{"res/sound.conf"};
3078
3079 while (my ($name, $info) = each %$res) {
3080 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3081 my $data;
3082
3083 if ($info->{type} & 1) {
3084 # prepend meta info
3085
3086 my $meta = $enc->encode ({
3087 name => $name,
3088 %{ $info->{meta} || {} },
3089 });
3090
3091 $data = pack "(w/a*)*", $meta, $info->{data};
3092 } else {
3093 $data = $info->{data};
3094 }
3095
3096 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3097 cf::face::set_type $idx, $info->{type};
3098
3099 cf::cede_to_tick;
3100 }
3101
3102 if ($soundconf) {
3103 $soundconf = $enc->decode (delete $soundconf->{data});
3104
3105 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3106 my $sound = $soundconf->{compat}[$_]
3107 or next;
3108
3109 my $face = cf::face::find "sound/$sound->[1]";
3110 cf::sound::set $sound->[0] => $face;
3111 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3112 }
3113
3114 while (my ($k, $v) = each %{$soundconf->{event}}) {
3115 my $face = cf::face::find "sound/$v";
3116 cf::sound::set $k => $face;
3117 }
3118 }
3119 }
3120
3121 1
3122}
3123
3124register_exticmd fx_want => sub {
3125 my ($ns, $want) = @_;
3126
3127 while (my ($k, $v) = each %$want) {
3128 $ns->fx_want ($k, $v);
3129 }
3130};
3131
3132sub reload_regions {
3133 # HACK to clear player env face cache, we need some signal framework
3134 # for this (global event?)
3135 %ext::player_env::MUSIC_FACE_CACHE = ();
3136
3137 load_resource_file "$MAPDIR/regions"
3138 or die "unable to load regions file\n";
3139
3140 for (cf::region::list) {
3141 $_->{match} = qr/$_->{match}/
3142 if exists $_->{match};
3143 }
3144}
3145
3146sub reload_facedata {
3147 load_facedata "$DATADIR/facedata"
3148 or die "unable to load facedata\n";
3149}
3150
3151sub reload_archetypes {
3152 load_resource_file "$DATADIR/archetypes"
3153 or die "unable to load archetypes\n";
3154 #d# NEED to laod twice to resolve forward references
3155 # this really needs to be done in an extra post-pass
3156 # (which needs to be synchronous, so solve it differently)
3157 load_resource_file "$DATADIR/archetypes"
3158 or die "unable to load archetypes\n";
3159}
3160
3161sub reload_treasures {
3162 load_resource_file "$DATADIR/treasures"
3163 or die "unable to load treasurelists\n";
3164}
3165
3166sub reload_resources {
3167 warn "reloading resource files...\n";
3168
3169 reload_regions;
3170 reload_facedata;
3171 #reload_archetypes;#d#
3172 reload_archetypes;
3173 reload_treasures;
3174
3175 warn "finished reloading resource files\n";
3176}
3177
3178sub init {
3179 reload_resources;
3180}
3181
3182sub reload_config {
1069 open my $fh, "<:utf8", cf::confdir . "/config" 3183 open my $fh, "<:utf8", "$CONFDIR/config"
1070 or return; 3184 or return;
1071 3185
1072 local $/; 3186 local $/;
1073 *CFG = YAML::Syck::Load <$fh>; 3187 *CFG = YAML::Syck::Load <$fh>;
3188
3189 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3190
3191 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3192 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3193
3194 if (exists $CFG{mlockall}) {
3195 eval {
3196 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3197 and die "WARNING: m(un)lockall failed: $!\n";
3198 };
3199 warn $@ if $@;
3200 }
1074} 3201}
1075 3202
1076sub main { 3203sub main {
1077 cfg_load; 3204 # we must not ever block the main coroutine
1078 db_load; 3205 local $Coro::idle = sub {
3206 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3207 (async {
3208 $Coro::current->{desc} = "IDLE BUG HANDLER";
3209 Event::one_event;
3210 })->prio (Coro::PRIO_MAX);
3211 };
3212
3213 reload_config;
3214 db_init;
1079 load_extensions; 3215 load_extensions;
3216
3217 $TICK_WATCHER->start;
1080 Event::loop; 3218 Event::loop;
1081} 3219}
1082 3220
1083############################################################################# 3221#############################################################################
1084# initialisation 3222# initialisation and cleanup
1085 3223
1086sub _perl_reload(&) { 3224# install some emergency cleanup handlers
3225BEGIN {
3226 for my $signal (qw(INT HUP TERM)) {
3227 Event->signal (
3228 reentrant => 0,
3229 data => WF_AUTOCANCEL,
3230 signal => $signal,
3231 prio => 0,
3232 cb => sub {
3233 cf::cleanup "SIG$signal";
3234 },
3235 );
3236 }
3237}
3238
3239sub write_runtime {
3240 my $runtime = "$LOCALDIR/runtime";
3241
3242 # first touch the runtime file to show we are still running:
3243 # the fsync below can take a very very long time.
3244
3245 IO::AIO::aio_utime $runtime, undef, undef;
3246
3247 my $guard = cf::lock_acquire "write_runtime";
3248
3249 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3250 or return;
3251
3252 my $value = $cf::RUNTIME + 90 + 10;
3253 # 10 is the runtime save interval, for a monotonic clock
3254 # 60 allows for the watchdog to kill the server.
3255
3256 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3257 and return;
3258
3259 # always fsync - this file is important
3260 aio_fsync $fh
3261 and return;
3262
3263 # touch it again to show we are up-to-date
3264 aio_utime $fh, undef, undef;
3265
3266 close $fh
3267 or return;
3268
3269 aio_rename "$runtime~", $runtime
3270 and return;
3271
3272 warn "runtime file written.\n";
3273
3274 1
3275}
3276
3277sub emergency_save() {
3278 my $freeze_guard = cf::freeze_mainloop;
3279
3280 warn "enter emergency perl save\n";
3281
3282 cf::sync_job {
3283 # use a peculiar iteration method to avoid tripping on perl
3284 # refcount bugs in for. also avoids problems with players
3285 # and maps saved/destroyed asynchronously.
3286 warn "begin emergency player save\n";
3287 for my $login (keys %cf::PLAYER) {
3288 my $pl = $cf::PLAYER{$login} or next;
3289 $pl->valid or next;
3290 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3291 $pl->save;
3292 }
3293 warn "end emergency player save\n";
3294
3295 warn "begin emergency map save\n";
3296 for my $path (keys %cf::MAP) {
3297 my $map = $cf::MAP{$path} or next;
3298 $map->valid or next;
3299 $map->save;
3300 }
3301 warn "end emergency map save\n";
3302
3303 warn "begin emergency database checkpoint\n";
3304 BDB::db_env_txn_checkpoint $DB_ENV;
3305 warn "end emergency database checkpoint\n";
3306 };
3307
3308 warn "leave emergency perl save\n";
3309}
3310
3311sub post_cleanup {
1087 my ($msg) = @_; 3312 my ($make_core) = @_;
1088 3313
1089 $msg->("reloading..."); 3314 warn Carp::longmess "post_cleanup backtrace"
3315 if $make_core;
3316}
1090 3317
1091 eval { 3318sub do_reload_perl() {
1092 # cancel all watchers 3319 # can/must only be called in main
3320 if ($Coro::current != $Coro::main) {
3321 warn "can only reload from main coroutine";
3322 return;
3323 }
3324
3325 warn "reloading...";
3326
3327 warn "entering sync_job";
3328
3329 cf::sync_job {
3330 cf::write_runtime; # external watchdog should not bark
3331 cf::emergency_save;
3332 cf::write_runtime; # external watchdog should not bark
3333
3334 warn "syncing database to disk";
3335 BDB::db_env_txn_checkpoint $DB_ENV;
3336
3337 # if anything goes wrong in here, we should simply crash as we already saved
3338
3339 warn "cancelling all WF_AUTOCANCEL watchers";
1093 $_->cancel for Event::all_watchers; 3340 for (Event::all_watchers) {
3341 $_->cancel if $_->data & WF_AUTOCANCEL;
3342 }
1094 3343
1095 # unload all extensions 3344 warn "flushing outstanding aio requests";
1096 for (@exts) { 3345 for (;;) {
1097 $msg->("unloading <$_>"); 3346 BDB::flush;
1098 unload_extension $_; 3347 IO::AIO::flush;
3348 Coro::cede;
3349 last unless IO::AIO::nreqs || BDB::nreqs;
3350 warn "iterate...";
3351 }
3352
3353 ++$RELOAD;
3354
3355 warn "cancelling all extension coros";
3356 $_->cancel for values %EXT_CORO;
3357 %EXT_CORO = ();
3358
3359 warn "removing commands";
3360 %COMMAND = ();
3361
3362 warn "removing ext/exti commands";
3363 %EXTCMD = ();
3364 %EXTICMD = ();
3365
3366 warn "unloading/nuking all extensions";
3367 for my $pkg (@EXTS) {
3368 warn "... unloading $pkg";
3369
3370 if (my $cb = $pkg->can ("unload")) {
3371 eval {
3372 $cb->($pkg);
3373 1
3374 } or warn "$pkg unloaded, but with errors: $@";
1099 } 3375 }
1100 3376
3377 warn "... nuking $pkg";
3378 Symbol::delete_package $pkg;
3379 }
3380
1101 # unload all modules loaded from $LIBDIR 3381 warn "unloading all perl modules loaded from $LIBDIR";
1102 while (my ($k, $v) = each %INC) { 3382 while (my ($k, $v) = each %INC) {
1103 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3383 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1104 3384
1105 $msg->("removing <$k>"); 3385 warn "... unloading $k";
1106 delete $INC{$k}; 3386 delete $INC{$k};
1107 3387
1108 $k =~ s/\.pm$//; 3388 $k =~ s/\.pm$//;
1109 $k =~ s/\//::/g; 3389 $k =~ s/\//::/g;
1110 3390
1113 } 3393 }
1114 3394
1115 Symbol::delete_package $k; 3395 Symbol::delete_package $k;
1116 } 3396 }
1117 3397
1118 # sync database to disk
1119 cf::db_sync;
1120
1121 # get rid of safe::, as good as possible 3398 warn "getting rid of safe::, as good as possible";
1122 Symbol::delete_package "safe::$_" 3399 Symbol::delete_package "safe::$_"
1123 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 3400 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1124 3401
1125 # remove register_script_function callbacks
1126 # TODO
1127
1128 # unload cf.pm "a bit" 3402 warn "unloading cf.pm \"a bit\"";
1129 delete $INC{"cf.pm"}; 3403 delete $INC{"cf.pm"};
3404 delete $INC{"cf/pod.pm"};
1130 3405
1131 # don't, removes xs symbols, too, 3406 # don't, removes xs symbols, too,
1132 # and global variables created in xs 3407 # and global variables created in xs
1133 #Symbol::delete_package __PACKAGE__; 3408 #Symbol::delete_package __PACKAGE__;
1134 3409
1135 # reload cf.pm 3410 warn "unload completed, starting to reload now";
3411
1136 $msg->("reloading cf.pm"); 3412 warn "reloading cf.pm";
1137 require cf; 3413 require cf;
3414 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1138 3415
1139 # load config and database again 3416 warn "loading config and database again";
1140 cf::cfg_load; 3417 cf::reload_config;
1141 cf::db_load;
1142 3418
1143 # load extensions 3419 warn "loading extensions";
1144 $msg->("load extensions");
1145 cf::load_extensions; 3420 cf::load_extensions;
1146 3421
1147 # reattach attachments to objects 3422 warn "reattaching attachments to objects/players";
1148 $msg->("reattach"); 3423 _global_reattach; # objects, sockets
1149 _global_reattach; 3424 warn "reattaching attachments to maps";
3425 reattach $_ for values %MAP;
3426 warn "reattaching attachments to players";
3427 reattach $_ for values %PLAYER;
3428
3429 warn "leaving sync_job";
3430
3431 1
3432 } or do {
3433 warn $@;
3434 warn "error while reloading, exiting.";
3435 exit 1;
1150 }; 3436 };
1151 $msg->($@) if $@;
1152 3437
1153 $msg->("reloaded"); 3438 warn "reloaded";
1154}; 3439};
1155 3440
1156sub perl_reload() { 3441our $RELOAD_WATCHER; # used only during reload
1157 _perl_reload { 3442
1158 warn $_[0]; 3443sub reload_perl() {
1159 print "$_[0]\n"; 3444 # doing reload synchronously and two reloads happen back-to-back,
3445 # coro crashes during coro_state_free->destroy here.
3446
3447 $RELOAD_WATCHER ||= Event->timer (
3448 reentrant => 0,
3449 after => 0,
3450 data => WF_AUTOCANCEL,
3451 cb => sub {
3452 do_reload_perl;
3453 undef $RELOAD_WATCHER;
3454 },
1160 }; 3455 );
1161} 3456}
1162 3457
1163register_command "perl-reload", 0, sub { 3458register_command "reload" => sub {
1164 my ($who, $arg) = @_; 3459 my ($who, $arg) = @_;
1165 3460
1166 if ($who->flag (FLAG_WIZ)) { 3461 if ($who->flag (FLAG_WIZ)) {
1167 _perl_reload { 3462 $who->message ("reloading server.");
1168 warn $_[0]; 3463 async {
1169 $who->message ($_[0]); 3464 $Coro::current->{desc} = "perl_reload";
3465 reload_perl;
1170 }; 3466 };
1171 } 3467 }
1172}; 3468};
1173 3469
1174register "<global>", __PACKAGE__;
1175
1176unshift @INC, $LIBDIR; 3470unshift @INC, $LIBDIR;
1177 3471
3472my $bug_warning = 0;
3473
3474our @WAIT_FOR_TICK;
3475our @WAIT_FOR_TICK_BEGIN;
3476
3477sub wait_for_tick {
3478 return unless $TICK_WATCHER->is_active;
3479 return if $Coro::current == $Coro::main;
3480
3481 my $signal = new Coro::Signal;
3482 push @WAIT_FOR_TICK, $signal;
3483 $signal->wait;
3484}
3485
3486sub wait_for_tick_begin {
3487 return unless $TICK_WATCHER->is_active;
3488 return if $Coro::current == $Coro::main;
3489
3490 my $signal = new Coro::Signal;
3491 push @WAIT_FOR_TICK_BEGIN, $signal;
3492 $signal->wait;
3493}
3494
1178$TICK_WATCHER = Event->timer ( 3495$TICK_WATCHER = Event->timer (
3496 reentrant => 0,
3497 parked => 1,
1179 prio => 1, 3498 prio => 0,
1180 async => 1,
1181 at => $NEXT_TICK || 1, 3499 at => $NEXT_TICK || $TICK,
3500 data => WF_AUTOCANCEL,
1182 cb => sub { 3501 cb => sub {
3502 if ($Coro::current != $Coro::main) {
3503 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3504 unless ++$bug_warning > 10;
3505 return;
3506 }
3507
3508 $NOW = $tick_start = Event::time;
3509
1183 cf::server_tick; # one server iteration 3510 cf::server_tick; # one server iteration
1184 3511
1185 my $NOW = Event::time; 3512 $RUNTIME += $TICK;
1186 $NEXT_TICK += $TICK; 3513 $NEXT_TICK += $TICK;
3514
3515 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3516 $NEXT_RUNTIME_WRITE = $NOW + 10;
3517 Coro::async_pool {
3518 $Coro::current->{desc} = "runtime saver";
3519 write_runtime
3520 or warn "ERROR: unable to write runtime file: $!";
3521 };
3522 }
3523
3524 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3525 $sig->send;
3526 }
3527 while (my $sig = shift @WAIT_FOR_TICK) {
3528 $sig->send;
3529 }
3530
3531 $NOW = Event::time;
1187 3532
1188 # if we are delayed by four ticks or more, skip them all 3533 # if we are delayed by four ticks or more, skip them all
1189 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 3534 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1190 3535
1191 $TICK_WATCHER->at ($NEXT_TICK); 3536 $TICK_WATCHER->at ($NEXT_TICK);
1192 $TICK_WATCHER->start; 3537 $TICK_WATCHER->start;
3538
3539 $LOAD = ($NOW - $tick_start) / $TICK;
3540 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3541
3542 _post_tick;
1193 }, 3543 },
1194); 3544);
1195 3545
3546{
3547 BDB::min_parallel 8;
3548 BDB::max_poll_time $TICK * 0.1;
3549 $BDB_POLL_WATCHER = Event->io (
3550 reentrant => 0,
3551 fd => BDB::poll_fileno,
3552 poll => 'r',
3553 prio => 0,
3554 data => WF_AUTOCANCEL,
3555 cb => \&BDB::poll_cb,
3556 );
3557
3558 BDB::set_sync_prepare {
3559 my $status;
3560 my $current = $Coro::current;
3561 (
3562 sub {
3563 $status = $!;
3564 $current->ready; undef $current;
3565 },
3566 sub {
3567 Coro::schedule while defined $current;
3568 $! = $status;
3569 },
3570 )
3571 };
3572
3573 unless ($DB_ENV) {
3574 $DB_ENV = BDB::db_env_create;
3575 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3576 | BDB::LOG_AUTOREMOVE, 1);
3577 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3578 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3579
3580 cf::sync_job {
3581 eval {
3582 BDB::db_env_open
3583 $DB_ENV,
3584 $BDBDIR,
3585 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3586 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3587 0666;
3588
3589 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3590 };
3591
3592 cf::cleanup "db_env_open(db): $@" if $@;
3593 };
3594 }
3595
3596 $BDB_DEADLOCK_WATCHER = Event->timer (
3597 after => 3,
3598 interval => 1,
3599 hard => 1,
3600 prio => 0,
3601 data => WF_AUTOCANCEL,
3602 cb => sub {
3603 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3604 },
3605 );
3606 $BDB_CHECKPOINT_WATCHER = Event->timer (
3607 after => 11,
3608 interval => 60,
3609 hard => 1,
3610 prio => 0,
3611 data => WF_AUTOCANCEL,
3612 cb => sub {
3613 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3614 },
3615 );
3616 $BDB_TRICKLE_WATCHER = Event->timer (
3617 after => 5,
3618 interval => 10,
3619 hard => 1,
3620 prio => 0,
3621 data => WF_AUTOCANCEL,
3622 cb => sub {
3623 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3624 },
3625 );
3626}
3627
3628{
3629 IO::AIO::min_parallel 8;
3630
3631 undef $Coro::AIO::WATCHER;
1196IO::AIO::max_poll_time $TICK * 0.2; 3632 IO::AIO::max_poll_time $TICK * 0.1;
1197 3633 $AIO_POLL_WATCHER = Event->io (
1198Event->io (fd => IO::AIO::poll_fileno, 3634 reentrant => 0,
3635 data => WF_AUTOCANCEL,
3636 fd => IO::AIO::poll_fileno,
1199 poll => 'r', 3637 poll => 'r',
1200 prio => 5, 3638 prio => 0,
1201 cb => \&IO::AIO::poll_cb); 3639 cb => \&IO::AIO::poll_cb,
3640 );
3641}
3642
3643my $_log_backtrace;
3644
3645sub _log_backtrace {
3646 my ($msg, @addr) = @_;
3647
3648 $msg =~ s/\n//;
3649
3650 # limit the # of concurrent backtraces
3651 if ($_log_backtrace < 2) {
3652 ++$_log_backtrace;
3653 async {
3654 $Coro::current->{desc} = "abt $msg";
3655
3656 my @bt = fork_call {
3657 @addr = map { sprintf "%x", $_ } @addr;
3658 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3659 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3660 or die "addr2line: $!";
3661
3662 my @funcs;
3663 my @res = <$fh>;
3664 chomp for @res;
3665 while (@res) {
3666 my ($func, $line) = splice @res, 0, 2, ();
3667 push @funcs, "[$func] $line";
3668 }
3669
3670 @funcs
3671 };
3672
3673 LOG llevInfo, "[ABT] $msg\n";
3674 LOG llevInfo, "[ABT] $_\n" for @bt;
3675 --$_log_backtrace;
3676 };
3677 } else {
3678 LOG llevInfo, "[ABT] $msg\n";
3679 LOG llevInfo, "[ABT] [suppressed]\n";
3680 }
3681}
3682
3683# load additional modules
3684use cf::pod;
3685
3686END { cf::emergency_save }
1202 3687
12031 36881
1204 3689

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines