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.97 by root, Fri Dec 22 06:03:20 2006 UTC vs.
Revision 1.457 by root, Wed Oct 1 05:50:19 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines