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.99 by root, Sat Dec 23 05:25:35 2006 UTC vs.
Revision 1.484 by root, Mon Oct 12 14:00:58 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines