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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines