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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines