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.74 by root, Sun Oct 1 15:59:29 2006 UTC vs.
Revision 1.429 by root, Sat May 3 15:17:13 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines