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.104 by root, Sat Dec 30 16:56:16 2006 UTC vs.
Revision 1.501 by root, Sat Jan 16 23:27:21 2010 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 ();
37use Carp ();
12 38
39use Guard ();
13use Coro 3.3; 40use Coro ();
41use Coro::State;
42use Coro::Handle;
43use Coro::EV;
14use Coro::Event; 44use Coro::AnyEvent;
15use Coro::Timer; 45use Coro::Timer;
16use Coro::Signal; 46use Coro::Signal;
17use Coro::Semaphore; 47use Coro::Semaphore;
48use Coro::SemaphoreSet;
49use Coro::AnyEvent;
50use Coro::AIO;
51use Coro::BDB 1.6;
52use Coro::Storable;
53use Coro::Util ();
18 54
19use IO::AIO 2.3; 55use JSON::XS 2.01 ();
56use BDB ();
57use Data::Dumper;
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 (2); # run main coroutine ("the server") with very high priority 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
92our $RELOAD; # number of reloads so far, non-zero while in reload
36our @EVENT; 93our @EVENT;
37our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
38 96
39our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
40our $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
41our $NEXT_TICK; 115our $NEXT_TICK;
42our $NOW; 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);
43 124
44our %CFG; 125our %CFG;
45 126
46our $UPTIME; $UPTIME ||= time; 127our $UPTIME; $UPTIME ||= time;
47our $RUNTIME; 128our $RUNTIME;
129our $NOW;
48 130
49our %MAP; # all maps 131our (%PLAYER, %PLAYER_LOADING); # all users
50our $LINK_MAP; # the special {link} map 132our (%MAP, %MAP_LOADING ); # all maps
51our $FREEZE; 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 :)
52 147
53binmode STDOUT; 148binmode STDOUT;
54binmode STDERR; 149binmode STDERR;
55 150
56# read virtual server time, if available 151# read virtual server time, if available
57unless ($RUNTIME || !-e cf::localdir . "/runtime") { 152unless ($RUNTIME || !-e $RUNTIMEFILE) {
58 open my $fh, "<", cf::localdir . "/runtime" 153 open my $fh, "<", $RUNTIMEFILE
59 or die "unable to read runtime file: $!"; 154 or die "unable to read $RUNTIMEFILE file: $!";
60 $RUNTIME = <$fh> + 0.; 155 $RUNTIME = <$fh> + 0.;
61} 156}
62 157
63mkdir cf::localdir; 158eval "sub TICK() { $TICK } 1" or die;
64mkdir cf::localdir . "/" . cf::playerdir;
65mkdir cf::localdir . "/" . cf::tmpdir;
66mkdir cf::localdir . "/" . cf::uniquedir;
67 159
68our %EXT_CORO; 160mkdir $_
161 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
162
163our $EMERGENCY_POSITION;
164
165sub cf::map::normalise;
166
167#############################################################################
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::"} };
69 177
70############################################################################# 178#############################################################################
71 179
72=head2 GLOBAL VARIABLES 180=head2 GLOBAL VARIABLES
73 181
80=item $cf::RUNTIME 188=item $cf::RUNTIME
81 189
82The time this server has run, starts at 0 and is increased by $cf::TICK on 190The time this server has run, starts at 0 and is increased by $cf::TICK on
83every server tick. 191every server tick.
84 192
85=item $cf::LIBDIR 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
86 196
87The perl library directory, where extensions and cf-specific modules can 197Various directories - "/etc", read-only install directory, perl-library
88be found. It will be added to C<@INC> automatically. 198directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
199unique-items directory, player file directory, random maps directory and
200database environment.
89 201
90=item $cf::NOW 202=item $cf::NOW
91 203
92The time of the last (current) server tick. 204The time of the last (current) server tick.
93 205
94=item $cf::TICK 206=item $cf::TICK
95 207
96The interval between server ticks, in seconds. 208The interval between server ticks, in seconds.
97 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
98=item %cf::CFG 220=item %cf::CFG
99 221
100Configuration for the server, loaded from C</etc/crossfire/config>, or 222Configuration for the server, loaded from C</etc/deliantra-server/config>, or
101from wherever your confdir points to. 223from wherever your confdir points to.
102 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
103=back 243=back
104 244
105=cut 245=cut
106 246
107BEGIN { 247$Coro::State::WARNHOOK = sub {
108 *CORE::GLOBAL::warn = sub {
109 my $msg = join "", @_; 248 my $msg = join "", @_;
110 utf8::encode $msg;
111 249
112 $msg .= "\n" 250 $msg .= "\n"
113 unless $msg =~ /\n$/; 251 unless $msg =~ /\n$/;
114 252
253 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
254
115 LOG llevError, "cfperl: $msg"; 255 LOG llevError, $msg;
116 }; 256};
117} 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};
118 271
119@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 272@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
120@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 273@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
121@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 274@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
122@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 275@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
123@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';
124@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)
125 279
126# 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
127# within the Safe compartment. 281# within the Safe compartment.
128for my $pkg (qw( 282for my $pkg (qw(
129 cf::global cf::attachable 283 cf::global cf::attachable
130 cf::object cf::object::player 284 cf::object cf::object::player
131 cf::client cf::player 285 cf::client cf::player
132 cf::arch cf::living 286 cf::arch cf::living
287 cf::map cf::mapspace
133 cf::map cf::party cf::region 288 cf::party cf::region
134)) { 289)) {
135 no strict 'refs';
136 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 290 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
137} 291}
138 292
139$Event::DIED = sub { 293$EV::DIED = sub {
140 warn "error in event callback: @_"; 294 Carp::cluck "error in event callback: @_";
141}; 295};
142 296
143my %ext_pkg; 297#############################################################################
144my @exts;
145my @hook;
146 298
147=head2 UTILITY FUNCTIONS 299=head2 UTILITY FUNCTIONS
148 300
149=over 4 301=over 4
150 302
151=cut 303=item dumpval $ref
152 304
153use JSON::Syck (); # TODO# replace by JSON::PC once working 305=cut
154 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
155=item $ref = cf::from_json $json 326=item $ref = cf::decode_json $json
156 327
157Converts a JSON string into the corresponding perl data structure. 328Converts a JSON string into the corresponding perl data structure.
158 329
159=cut
160
161sub from_json($) {
162 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
163 JSON::Syck::Load $_[0]
164}
165
166=item $json = cf::to_json $ref 330=item $json = cf::encode_json $ref
167 331
168Converts a perl data structure into its JSON representation. 332Converts a perl data structure into its JSON representation.
169 333
170=cut 334=cut
171 335
172sub to_json($) { 336our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
173 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
174 JSON::Syck::Dump $_[0]
175}
176 337
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
177=item $coro = cf::coro { BLOCK } 540=item $coro = cf::async_ext { BLOCK }
178 541
179Creates and returns a new coro. This coro is automcatially being canceled 542Like async, but this coro is automatically being canceled when the
180when the extension calling this is being unloaded. 543extension calling this is being unloaded.
181 544
182=cut 545=cut
183 546
184sub coro(&) { 547sub async_ext(&) {
185 my $cb = shift; 548 my $cb = shift;
186 549
187 my $coro; $coro = async { 550 my $coro = &Coro::async ($cb);
188 eval {
189 $cb->();
190 };
191 warn $@ if $@;
192 };
193 551
194 $coro->on_destroy (sub { 552 $coro->on_destroy (sub {
195 delete $EXT_CORO{$coro+0}; 553 delete $EXT_CORO{$coro+0};
196 }); 554 });
197 $EXT_CORO{$coro+0} = $coro; 555 $EXT_CORO{$coro+0} = $coro;
198 556
199 $coro 557 $coro
200} 558}
201 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 });
747}
748
202=back 749=back
203 750
204=cut 751=cut
205 752
206############################################################################# 753#############################################################################
207 754
208=head2 ATTACHABLE OBJECTS 755=head2 ATTACHABLE OBJECTS
209 756
210Many 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
211attach callbacks/event handlers (a collection of which is called an "attachment") 758attach callbacks/event handlers (a collection of which is called an "attachment")
212to it. All such attachable objects support the following methods. 759to it. All such attachable objects support the following methods.
213 760
214In 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>
215C<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
216crossfire+). 763Deliantra).
217 764
218=over 4 765=over 4
219 766
220=item $attachable->attach ($attachment, key => $value...) 767=item $attachable->attach ($attachment, key => $value...)
221 768
265=item cf::CLASS::attachment $name, ... 812=item cf::CLASS::attachment $name, ...
266 813
267Register an attachment by C<$name> through which attachable objects of the 814Register an attachment by C<$name> through which attachable objects of the
268given CLASS can refer to this attachment. 815given CLASS can refer to this attachment.
269 816
270Some classes such as crossfire maps and objects can specify attachments 817Some classes such as deliantra maps and objects can specify attachments
271that 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.
272 819
273These calls expect any number of the following handler/hook descriptions: 820These calls expect any number of the following handler/hook descriptions:
274 821
275=over 4 822=over 4
335our @CB_TYPE = (); # registry for type (cf-object class) based events 882our @CB_TYPE = (); # registry for type (cf-object class) based events
336our @CB_MAP = (); 883our @CB_MAP = ();
337 884
338my %attachment; 885my %attachment;
339 886
887sub cf::attachable::thawer_merge {
888 # simply override everything except _meta
889 local $_[0]{_meta};
890 %{$_[0]} = %{$_[1]};
891}
892
340sub _attach_cb($$$$) { 893sub _attach_cb($$$$) {
341 my ($registry, $event, $prio, $cb) = @_; 894 my ($registry, $event, $prio, $cb) = @_;
342 895
343 use sort 'stable'; 896 use sort 'stable';
344 897
378 $registry = $CB_TYPE[$object_type] ||= []; 931 $registry = $CB_TYPE[$object_type] ||= [];
379 932
380 } elsif ($type eq "subtype") { 933 } elsif ($type eq "subtype") {
381 defined $object_type or Carp::croak "subtype specified without type"; 934 defined $object_type or Carp::croak "subtype specified without type";
382 my $object_subtype = shift @arg; 935 my $object_subtype = shift @arg;
383 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 936 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
384 937
385 } elsif ($type eq "package") { 938 } elsif ($type eq "package") {
386 my $pkg = shift @arg; 939 my $pkg = shift @arg;
387 940
388 while (my ($name, $id) = each %cb_id) { 941 while (my ($name, $id) = each %cb_id) {
417 _attach $registry, $klass, @attach; 970 _attach $registry, $klass, @attach;
418 } 971 }
419 972
420 $obj->{$name} = \%arg; 973 $obj->{$name} = \%arg;
421 } else { 974 } else {
422 warn "object uses attachment '$name' that is not available, postponing.\n"; 975 warn "object uses attachment '$name' which is not available, postponing.\n";
423 } 976 }
424 977
425 $obj->{_attachment}{$name} = undef; 978 $obj->{_attachment}{$name} = undef;
426} 979}
427 980
429 if (ref $_[0]) { 982 if (ref $_[0]) {
430 _object_attach @_; 983 _object_attach @_;
431 } else { 984 } else {
432 _attach shift->_attach_registry, @_; 985 _attach shift->_attach_registry, @_;
433 } 986 }
987 _recalc_want;
434}; 988};
435 989
436# all those should be optimised 990# all those should be optimised
437sub cf::attachable::detach { 991sub cf::attachable::detach {
438 my ($obj, $name) = @_; 992 my ($obj, $name) = @_;
441 delete $obj->{_attachment}{$name}; 995 delete $obj->{_attachment}{$name};
442 reattach ($obj); 996 reattach ($obj);
443 } else { 997 } else {
444 Carp::croak "cannot, currently, detach class attachments"; 998 Carp::croak "cannot, currently, detach class attachments";
445 } 999 }
1000 _recalc_want;
446}; 1001};
447 1002
448sub cf::attachable::attached { 1003sub cf::attachable::attached {
449 my ($obj, $name) = @_; 1004 my ($obj, $name) = @_;
450 1005
465 "; 1020 ";
466 die if $@; 1021 die if $@;
467} 1022}
468 1023
469our $override; 1024our $override;
470our @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?
471 1026
472sub override { 1027sub override {
473 $override = 1; 1028 $override = 1;
474 @invoke_results = (); 1029 @INVOKE_RESULTS = (@_);
475} 1030}
476 1031
477sub do_invoke { 1032sub do_invoke {
478 my $event = shift; 1033 my $event = shift;
479 my $callbacks = shift; 1034 my $callbacks = shift;
480 1035
481 @invoke_results = (); 1036 @INVOKE_RESULTS = ();
482 1037
483 local $override; 1038 local $override;
484 1039
485 for (@$callbacks) { 1040 for (@$callbacks) {
486 eval { &{$_->[1]} }; 1041 eval { &{$_->[1]} };
495 } 1050 }
496 1051
497 0 1052 0
498} 1053}
499 1054
500=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1055=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
501 1056
502=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1057=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
503 1058
504Generate an object-specific event with the given arguments. 1059Generate an object-specific event with the given arguments.
505 1060
506This 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
507removed 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
508results (if you must, access C<@cf::invoke_results> directly). 1063results (if you must, access C<@cf::INVOKE_RESULTS> directly).
509 1064
510=back 1065=back
511 1066
512=cut 1067=cut
513 1068
514############################################################################# 1069#############################################################################
515# object support 1070# object support
1071
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 {
1106 my ($ob1, $ob2) = @_;
1107
1108 ++$SLOW_MERGES;#d#
1109
1110 # we do the slow way here
1111 return _object_equal $ob1, $ob2
1112}
516 1113
517sub reattach { 1114sub reattach {
518 # basically do the same as instantiate, without calling instantiate 1115 # basically do the same as instantiate, without calling instantiate
519 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
520 1120
521 my $registry = $obj->registry; 1121 my $registry = $obj->registry;
522 1122
523 @$registry = (); 1123 @$registry = ();
524 1124
539cf::attachable->attach ( 1139cf::attachable->attach (
540 prio => -1000000, 1140 prio => -1000000,
541 on_instantiate => sub { 1141 on_instantiate => sub {
542 my ($obj, $data) = @_; 1142 my ($obj, $data) = @_;
543 1143
544 $data = from_json $data; 1144 $data = decode_json $data;
545 1145
546 for (@$data) { 1146 for (@$data) {
547 my ($name, $args) = @$_; 1147 my ($name, $args) = @$_;
548 1148
549 $obj->attach ($name, %{$args || {} }); 1149 $obj->attach ($name, %{$args || {} });
563); 1163);
564 1164
565sub object_freezer_save { 1165sub object_freezer_save {
566 my ($filename, $rdata, $objs) = @_; 1166 my ($filename, $rdata, $objs) = @_;
567 1167
1168 sync_job {
568 if (length $$rdata) { 1169 if (length $$rdata) {
1170 utf8::decode (my $decname = $filename);
569 warn sprintf "saving %s (%d,%d)\n", 1171 warn sprintf "saving %s (%d,%d)\n",
570 $filename, length $$rdata, scalar @$objs; 1172 $decname, length $$rdata, scalar @$objs;
571 1173
572 if (open my $fh, ">:raw", "$filename~") { 1174 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
573 chmod SAVE_MODE, $fh;
574 syswrite $fh, $$rdata;
575 close $fh;
576
577 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
578 chmod SAVE_MODE, $fh; 1175 aio_chmod $fh, SAVE_MODE;
579 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 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 }
580 close $fh; 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;
581 rename "$filename.pst~", "$filename.pst"; 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;
582 } else { 1203 } else {
583 unlink "$filename.pst"; 1204 warn "unable to save objects: $filename~: $!\n";
584 } 1205 }
585
586 rename "$filename~", $filename;
587 } else { 1206 } else {
588 warn "FATAL: $filename~: $!\n";
589 }
590 } else {
591 unlink $filename; 1207 aio_unlink $filename;
592 unlink "$filename.pst"; 1208 aio_unlink "$filename.pst";
1209 }
593 } 1210 };
594} 1211}
595 1212
596sub object_freezer_as_string { 1213sub object_freezer_as_string {
597 my ($rdata, $objs) = @_; 1214 my ($rdata, $objs) = @_;
598 1215
602} 1219}
603 1220
604sub object_thawer_load { 1221sub object_thawer_load {
605 my ($filename) = @_; 1222 my ($filename) = @_;
606 1223
607 local $/;
608
609 my $av;
610
611 #TODO: use sysread etc.
612 if (open my $data, "<:raw:perlio", $filename) {
613 $data = <$data>;
614 if (open my $pst, "<:raw:perlio", "$filename.pst") {
615 $av = eval { (Storable::thaw <$pst>)->{objs} };
616 }
617 return ($data, $av); 1224 my ($data, $av);
618 }
619 1225
620 () 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)
621} 1242}
1243
1244=head2 COMMAND CALLBACKS
1245
1246=over 4
1247
1248=cut
622 1249
623############################################################################# 1250#############################################################################
624# command handling &c 1251# command handling &c
625 1252
626=item cf::register_command $name => \&callback($ob,$args); 1253=item cf::register_command $name => \&callback($ob,$args);
639 push @{ $COMMAND{$name} }, [$caller, $cb]; 1266 push @{ $COMMAND{$name} }, [$caller, $cb];
640} 1267}
641 1268
642=item cf::register_extcmd $name => \&callback($pl,$packet); 1269=item cf::register_extcmd $name => \&callback($pl,$packet);
643 1270
644Register 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.
645 1276
646If 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
647called. 1278called.
648 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
649=cut 1291=cut
650 1292
651sub register_extcmd { 1293sub register_extcmd {
652 my ($name, $cb) = @_; 1294 my ($name, $cb) = @_;
653 1295
654 my $caller = caller;
655 #warn "registering extcmd '$name' to '$caller'";
656
657 $EXTCMD{$name} = [$cb, $caller]; 1296 $EXTCMD{$name} = $cb;
658} 1297}
1298
1299sub register_exticmd {
1300 my ($name, $cb) = @_;
1301
1302 $EXTICMD{$name} = $cb;
1303}
1304
1305use File::Glob ();
659 1306
660cf::player->attach ( 1307cf::player->attach (
661 on_command => sub { 1308 on_command => sub {
662 my ($pl, $name, $params) = @_; 1309 my ($pl, $name, $params) = @_;
663 1310
671 cf::override; 1318 cf::override;
672 }, 1319 },
673 on_extcmd => sub { 1320 on_extcmd => sub {
674 my ($pl, $buf) = @_; 1321 my ($pl, $buf) = @_;
675 1322
676 my $msg = eval { from_json $buf }; 1323 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
677 1324
678 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
679 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1333 if (my $cb = $EXTCMD{$type}) {
680 if (my %reply = $cb->[0]->($pl, $msg)) { 1334 @reply = $cb->($pl, @payload);
681 $pl->ext_reply ($msg->{msgid}, %reply);
682 }
683 } 1335 }
1336
1337 $pl->ext_reply ($reply, @reply)
1338 if $reply;
1339
684 } else { 1340 } else {
685 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1341 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
686 } 1342 }
687 1343
688 cf::override; 1344 cf::override;
689 }, 1345 },
690); 1346);
691 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
692sub 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 {
693 my ($base, $pkg) = @_; 1793 my ($self, $merge) = @_;
694 1794
695 #TODO 1795 # we have to keep some variables in memory intact
696} 1796 local $self->{path};
1797 local $self->{load_path};
697 1798
698sub load_extension { 1799 $self->SUPER::thawer_merge ($merge);
1800}
1801
1802sub normalise {
699 my ($path) = @_; 1803 my ($path, $base) = @_;
700 1804
701 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1805 $path = "$path"; # make sure its a string
702 my $base = $1;
703 my $pkg = $1;
704 $pkg =~ s/[^[:word:]]/_/g;
705 $pkg = "ext::$pkg";
706 1806
707 warn "loading '$path' into '$pkg'\n"; 1807 $path =~ s/\.map$//;
708 1808
709 open my $fh, "<:utf8", $path 1809 # map plan:
710 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
711 1817
712 my $source = 1818 $path =~ s/$PATH_SEP/\//go;
713 "package $pkg; use strict; use utf8;\n"
714 . "#line 1 \"$path\"\n{\n"
715 . (do { local $/; <$fh> })
716 . "\n};\n1";
717 1819
718 eval $source 1820 # treat it as relative path if it starts with
719 or die $@ ? "$path: $@\n" 1821 # something that looks reasonable
720 : "extension disabled.\n"; 1822 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1823 $base or Carp::carp "normalise called with relative path and no base: '$path'";
721 1824
722 push @exts, $pkg; 1825 $base =~ s{[^/]+/?$}{};
723 $ext_pkg{$base} = $pkg; 1826 $path = "$base/$path";
724
725# no strict 'refs';
726# @{"$pkg\::ISA"} = ext::;
727
728 register $base, $pkg;
729}
730
731sub unload_extension {
732 my ($pkg) = @_;
733
734 warn "removing extension $pkg\n";
735
736 # remove hooks
737 #TODO
738# for my $idx (0 .. $#PLUGIN_EVENT) {
739# delete $hook[$idx]{$pkg};
740# } 1827 }
741 1828
742 # remove commands 1829 for ($path) {
743 for my $name (keys %COMMAND) { 1830 redo if s{//}{/};
744 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1831 redo if s{/\.?/}{/};
1832 redo if s{/[^/]+/\.\./}{/};
1833 }
745 1834
746 if (@cb) { 1835 $path
747 $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;
748 } else { 1968 } else {
749 delete $COMMAND{$name}; 1969 $self->load_header_orig
750 } 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
751 } 1980 1
1981}
752 1982
753 # remove extcmds 1983sub find;
754 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1984sub find {
755 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 { }
2015#sub post_load { } # XS
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
756 } 2024 {
2025 my $guard = cf::lock_acquire "map_data:$path";
757 2026
758 if (my $cb = $pkg->can ("unload")) { 2027 return unless $self->valid;
759 eval { 2028 return unless $self->in_memory == cf::MAP_SWAPPED;
760 $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 }
761 1 2053 }
762 } or warn "$pkg unloaded, but with errors: $@"; 2054 }
763 }
764 2055
765 Symbol::delete_package $pkg; 2056 $f->resolve_delayed_derefs;
766}
767 2057
768sub load_extensions { 2058 cf::cede_to_tick;
769 for my $ext (<$LIBDIR/*.ext>) { 2059 # now do the right thing for maps
770 next unless -r $ext; 2060 $self->link_multipart_objects;
771 eval { 2061 $self->difficulty ($self->estimate_difficulty)
772 load_extension $ext; 2062 unless $self->difficulty;
773 1 2063 cf::cede_to_tick;
774 } or warn "$ext not loaded: $@";
775 }
776}
777 2064
778############################################################################# 2065 unless ($self->{deny_activate}) {
779# 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 }
780 2072
781*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 {
782 my ($map) = @_; 2096 my ($map) = @_;
783 2097
784 my $path = $map->tmpname; 2098 my @neigh; # diagonal neighbours
785 defined $path or return;
786 2099
787 unlink "$path.pst"; 2100 for (0 .. 3) {
788}; 2101 my $neigh = $map->tile_path ($_)
2102 or next;
2103 $neigh = find $neigh, $map
2104 or next;
2105 $neigh->load;
789 2106
790cf::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 }
791 2111
792############################################################################# 2112 for (grep defined $_->[0], @neigh) {
793# load/save perl data associated with player->ob objects 2113 my ($path, $origin) = @$_;
794 2114 my $neigh = find $path, $origin
795sub all_objects(@) { 2115 or next;
796 @_, map all_objects ($_->inv), @_ 2116 $neigh->load;
2117 }
797} 2118}
798 2119
799# TODO: compatibility cruft, remove when no longer needed 2120sub find_sync {
800cf::player->attach ( 2121 my ($path, $origin) = @_;
801 on_load => sub {
802 my ($pl, $path) = @_;
803 2122
804 for my $o (all_objects $pl->ob) { 2123 cf::sync_job { find $path, $origin }
805 if (my $value = $o->get_ob_key_value ("_perl_data")) { 2124}
806 $o->set_ob_key_value ("_perl_data");
807 2125
808 %$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};
809 } 2159 }
810 } 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);
811 }, 2198 }
812); 2199}
813 2200
814############################################################################# 2201sub swap_out {
2202 my ($self) = @_;
815 2203
816=head2 CORE EXTENSIONS 2204 # save first because save cedes
2205 $self->save;
817 2206
818Functions and methods that extend core crossfire objects. 2207 my $lock = cf::lock_acquire "map_data:$self->{path}";
819 2208
820=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=item cf::map::static_maps
2347
2348Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2349file in the shared directory excluding F</styles> and F</editor>). May
2350block.
2351
2352=cut
2353
2354sub static_maps() {
2355 my @dirs = "";
2356 my @maps;
2357
2358 while (@dirs) {
2359 my $dir = shift @dirs;
2360
2361 next if $dir eq "/styles" || $dir eq "/editor";
2362
2363 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2364 or return;
2365
2366 for (@$files) {
2367 s/\.map$// or next;
2368 utf8::decode $_;
2369 push @maps, "$dir/$_";
2370 }
2371
2372 push @dirs, map "$dir/$_", @$dirs;
2373 }
2374
2375 \@maps
2376}
2377
2378=back
2379
2380=head3 cf::object
2381
2382=cut
2383
2384package cf::object;
821 2385
822=over 4 2386=over 4
823 2387
824=item cf::player::exists $login 2388=item $ob->inv_recursive
825 2389
826Returns true when the given account exists. 2390Returns the inventory of the object I<and> their inventories, recursively,
2391but I<not> the object itself.
827 2392
828=cut 2393=cut
829 2394
830sub cf::player::exists($) { 2395sub inv_recursive_;
831 cf::player::find $_[0] 2396sub inv_recursive_ {
832 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2397 map { $_, inv_recursive_ $_->inv } @_
833} 2398}
834 2399
835=item $player->ext_reply ($msgid, $msgtype, %msg) 2400sub inv_recursive {
836 2401 inv_recursive_ inv $_[0]
837Sends an ext reply to the player.
838
839=cut
840
841sub cf::player::ext_reply($$$%) {
842 my ($self, $id, %msg) = @_;
843
844 $msg{msgid} = $id;
845
846 $self->send ("ext " . to_json \%msg);
847} 2402}
2403
2404=item $ref = $ob->ref
2405
2406Creates and returns a persistent reference to an object that can be stored as a string.
2407
2408=item $ob = cf::object::deref ($refstring)
2409
2410returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2411even if the object actually exists. May block.
2412
2413=cut
2414
2415sub deref {
2416 my ($ref) = @_;
2417
2418 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2419 my ($uuid, $name) = ($1, $2);
2420 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2421 or return;
2422 $pl->ob->uuid eq $uuid
2423 or return;
2424
2425 $pl->ob
2426 } else {
2427 warn "$ref: cannot resolve object reference\n";
2428 undef
2429 }
2430}
2431
2432package cf;
848 2433
849=back 2434=back
850 2435
851=head3 cf::object::player 2436=head3 cf::object::player
852 2437
857Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2442Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
858can be C<undef>. Does the right thing when the player is currently in a 2443can be C<undef>. Does the right thing when the player is currently in a
859dialogue with the given NPC character. 2444dialogue with the given NPC character.
860 2445
861=cut 2446=cut
2447
2448our $SAY_CHANNEL = {
2449 id => "say",
2450 title => "Map",
2451 reply => "say ",
2452 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2453};
2454
2455our $CHAT_CHANNEL = {
2456 id => "chat",
2457 title => "Chat",
2458 reply => "chat ",
2459 tooltip => "Player chat and shouts, global to the server.",
2460};
862 2461
863# rough implementation of a future "reply" method that works 2462# rough implementation of a future "reply" method that works
864# with dialog boxes. 2463# with dialog boxes.
865#TODO: the first argument must go, split into a $npc->reply_to ( method 2464#TODO: the first argument must go, split into a $npc->reply_to ( method
866sub cf::object::player::reply($$$;$) { 2465sub cf::object::player::reply($$$;$) {
868 2467
869 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2468 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
870 2469
871 if ($self->{record_replies}) { 2470 if ($self->{record_replies}) {
872 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2471 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2472
873 } else { 2473 } else {
2474 my $pl = $self->contr;
2475
2476 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2477 my $dialog = $pl->{npc_dialog};
2478 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2479
2480 } else {
874 $msg = $npc->name . " says: $msg" if $npc; 2481 $msg = $npc->name . " says: $msg" if $npc;
875 $self->message ($msg, $flags); 2482 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2483 }
876 } 2484 }
2485}
2486
2487=item $object->send_msg ($channel, $msg, $color, [extra...])
2488
2489=cut
2490
2491sub cf::object::send_msg {
2492 my $pl = shift->contr
2493 or return;
2494 $pl->send_msg (@_);
877} 2495}
878 2496
879=item $player_object->may ("access") 2497=item $player_object->may ("access")
880 2498
881Returns wether the given player is authorized to access resource "access" 2499Returns wether the given player is authorized to access resource "access"
890 (ref $cf::CFG{"may_$access"} 2508 (ref $cf::CFG{"may_$access"}
891 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2509 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
892 : $cf::CFG{"may_$access"}) 2510 : $cf::CFG{"may_$access"})
893} 2511}
894 2512
2513=item $player_object->enter_link
2514
2515Freezes the player and moves him/her to a special map (C<{link}>).
2516
2517The player should be reasonably safe there for short amounts of time (e.g.
2518for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2519though, as the palyer cannot control the character while it is on the link
2520map.
2521
2522Will never block.
2523
2524=item $player_object->leave_link ($map, $x, $y)
2525
2526Moves the player out of the special C<{link}> map onto the specified
2527map. If the map is not valid (or omitted), the player will be moved back
2528to the location he/she was before the call to C<enter_link>, or, if that
2529fails, to the emergency map position.
2530
2531Might block.
2532
2533=cut
2534
2535sub link_map {
2536 unless ($LINK_MAP) {
2537 $LINK_MAP = cf::map::find "{link}"
2538 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2539 $LINK_MAP->load;
2540 }
2541
2542 $LINK_MAP
2543}
2544
2545sub cf::object::player::enter_link {
2546 my ($self) = @_;
2547
2548 $self->deactivate_recursive;
2549
2550 return if UNIVERSAL::isa $self->map, "ext::map_link";
2551
2552 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2553 if $self->map && $self->map->{path} ne "{link}";
2554
2555 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2556}
2557
2558sub cf::object::player::leave_link {
2559 my ($self, $map, $x, $y) = @_;
2560
2561 return unless $self->contr->active;
2562
2563 my $link_pos = delete $self->{_link_pos};
2564
2565 unless ($map) {
2566 # restore original map position
2567 ($map, $x, $y) = @{ $link_pos || [] };
2568 $map = cf::map::find $map;
2569
2570 unless ($map) {
2571 ($map, $x, $y) = @$EMERGENCY_POSITION;
2572 $map = cf::map::find $map
2573 or die "FATAL: cannot load emergency map\n";
2574 }
2575 }
2576
2577 ($x, $y) = (-1, -1)
2578 unless (defined $x) && (defined $y);
2579
2580 # use -1 or undef as default coordinates, not 0, 0
2581 ($x, $y) = ($map->enter_x, $map->enter_y)
2582 if $x <= 0 && $y <= 0;
2583
2584 $map->load;
2585 $map->load_neighbours;
2586
2587 return unless $self->contr->active;
2588
2589 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2590 $self->enter_map ($map, $x, $y);
2591
2592 # only activate afterwards, to support waiting in hooks
2593 $self->activate_recursive;
2594}
2595
2596=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2597
2598Moves the player to the given map-path and coordinates by first freezing
2599her, loading and preparing them map, calling the provided $check callback
2600that has to return the map if sucecssful, and then unfreezes the player on
2601the new (success) or old (failed) map position. In either case, $done will
2602be called at the end of this process.
2603
2604Note that $check will be called with a potentially non-loaded map, so if
2605it needs a loaded map it has to call C<< ->load >>.
2606
2607=cut
2608
2609our $GOTOGEN;
2610
2611sub cf::object::player::goto {
2612 my ($self, $path, $x, $y, $check, $done) = @_;
2613
2614 # do generation counting so two concurrent goto's will be executed in-order
2615 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2616
2617 $self->enter_link;
2618
2619 (async {
2620 $Coro::current->{desc} = "player::goto $path $x $y";
2621
2622 # *tag paths override both path and x|y
2623 if ($path =~ /^\*(.*)$/) {
2624 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2625 my $ob = $obs[rand @obs];
2626
2627 # see if we actually can go there
2628 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2629 $ob = $obs[rand @obs];
2630 } else {
2631 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2632 }
2633 # else put us there anyways for now #d#
2634
2635 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2636 } else {
2637 ($path, $x, $y) = (undef, undef, undef);
2638 }
2639 }
2640
2641 my $map = eval {
2642 my $map = defined $path ? cf::map::find $path : undef;
2643
2644 if ($map) {
2645 $map = $map->customise_for ($self);
2646 $map = $check->($map) if $check && $map;
2647 } else {
2648 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2649 }
2650
2651 $map
2652 };
2653
2654 if ($@) {
2655 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2656 LOG llevError | logBacktrace, Carp::longmess $@;
2657 }
2658
2659 if ($gen == $self->{_goto_generation}) {
2660 delete $self->{_goto_generation};
2661 $self->leave_link ($map, $x, $y);
2662 }
2663
2664 $done->() if $done;
2665 })->prio (1);
2666}
2667
2668=item $player_object->enter_exit ($exit_object)
2669
2670=cut
2671
2672sub parse_random_map_params {
2673 my ($spec) = @_;
2674
2675 my $rmp = { # defaults
2676 xsize => (cf::rndm 15, 40),
2677 ysize => (cf::rndm 15, 40),
2678 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2679 #layout => string,
2680 };
2681
2682 for (split /\n/, $spec) {
2683 my ($k, $v) = split /\s+/, $_, 2;
2684
2685 $rmp->{lc $k} = $v if (length $k) && (length $v);
2686 }
2687
2688 $rmp
2689}
2690
2691sub prepare_random_map {
2692 my ($exit) = @_;
2693
2694 # all this does is basically replace the /! path by
2695 # a new random map path (?random/...) with a seed
2696 # that depends on the exit object
2697
2698 my $rmp = parse_random_map_params $exit->msg;
2699
2700 if ($exit->map) {
2701 $rmp->{region} = $exit->region->name;
2702 $rmp->{origin_map} = $exit->map->path;
2703 $rmp->{origin_x} = $exit->x;
2704 $rmp->{origin_y} = $exit->y;
2705
2706 $exit->map->touch;
2707 }
2708
2709 $rmp->{random_seed} ||= $exit->random_seed;
2710
2711 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2712 my $md5 = Digest::MD5::md5_hex $data;
2713 my $meta = "$RANDOMDIR/$md5.meta";
2714
2715 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2716 aio_write $fh, 0, (length $data), $data, 0;
2717 undef $fh;
2718 aio_rename "$meta~", $meta;
2719
2720 my $slaying = "?random/$md5";
2721
2722 if ($exit->valid) {
2723 $exit->slaying ("?random/$md5");
2724 $exit->msg (undef);
2725 }
2726 }
2727}
2728
2729sub cf::object::player::enter_exit {
2730 my ($self, $exit) = @_;
2731
2732 return unless $self->type == cf::PLAYER;
2733
2734 $self->enter_link;
2735
2736 (async {
2737 $Coro::current->{desc} = "enter_exit";
2738
2739 unless (eval {
2740 $self->deactivate_recursive; # just to be sure
2741
2742 # random map handling
2743 {
2744 my $guard = cf::lock_acquire "exit_prepare:$exit";
2745
2746 prepare_random_map $exit
2747 if $exit->slaying eq "/!";
2748 }
2749
2750 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2751 my $x = $exit->stats->hp;
2752 my $y = $exit->stats->sp;
2753
2754 $self->goto ($map, $x, $y);
2755
2756 # if exit is damned, update players death & WoR home-position
2757 $self->contr->savebed ($map, $x, $y)
2758 if $exit->flag (cf::FLAG_DAMNED);
2759
2760 1
2761 }) {
2762 $self->message ("Something went wrong deep within the deliantra server. "
2763 . "I'll try to bring you back to the map you were before. "
2764 . "Please report this to the dungeon master!",
2765 cf::NDI_UNIQUE | cf::NDI_RED);
2766
2767 warn "ERROR in enter_exit: $@";
2768 $self->leave_link;
2769 }
2770 })->prio (1);
2771}
2772
895=head3 cf::client 2773=head3 cf::client
896 2774
897=over 4 2775=over 4
898 2776
899=item $client->send_drawinfo ($text, $flags) 2777=item $client->send_drawinfo ($text, $flags)
905 2783
906sub cf::client::send_drawinfo { 2784sub cf::client::send_drawinfo {
907 my ($self, $text, $flags) = @_; 2785 my ($self, $text, $flags) = @_;
908 2786
909 utf8::encode $text; 2787 utf8::encode $text;
910 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2788 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
911} 2789}
912 2790
2791=item $client->send_big_packet ($pkt)
2792
2793Like C<send_packet>, but tries to compress large packets, and fragments
2794them as required.
2795
2796=cut
2797
2798our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2799
2800sub cf::client::send_big_packet {
2801 my ($self, $pkt) = @_;
2802
2803 # try lzf for large packets
2804 $pkt = "lzf " . Compress::LZF::compress $pkt
2805 if 1024 <= length $pkt and $self->{can_lzf};
2806
2807 # split very large packets
2808 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
2809 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
2810 $pkt = "frag";
2811 }
2812
2813 $self->send_packet ($pkt);
2814}
2815
2816=item $client->send_msg ($channel, $msg, $color, [extra...])
2817
2818Send a drawinfo or msg packet to the client, formatting the msg for the
2819client if neccessary. C<$type> should be a string identifying the type of
2820the message, with C<log> being the default. If C<$color> is negative, suppress
2821the message unless the client supports the msg packet.
2822
2823=cut
2824
2825# non-persistent channels (usually the info channel)
2826our %CHANNEL = (
2827 "c/motd" => {
2828 id => "infobox",
2829 title => "MOTD",
2830 reply => undef,
2831 tooltip => "The message of the day",
2832 },
2833 "c/identify" => {
2834 id => "infobox",
2835 title => "Identify",
2836 reply => undef,
2837 tooltip => "Items recently identified",
2838 },
2839 "c/examine" => {
2840 id => "infobox",
2841 title => "Examine",
2842 reply => undef,
2843 tooltip => "Signs and other items you examined",
2844 },
2845 "c/shopinfo" => {
2846 id => "infobox",
2847 title => "Shop Info",
2848 reply => undef,
2849 tooltip => "What your bargaining skill tells you about the shop",
2850 },
2851 "c/book" => {
2852 id => "infobox",
2853 title => "Book",
2854 reply => undef,
2855 tooltip => "The contents of a note or book",
2856 },
2857 "c/lookat" => {
2858 id => "infobox",
2859 title => "Look",
2860 reply => undef,
2861 tooltip => "What you saw there",
2862 },
2863 "c/who" => {
2864 id => "infobox",
2865 title => "Players",
2866 reply => undef,
2867 tooltip => "Shows players who are currently online",
2868 },
2869 "c/body" => {
2870 id => "infobox",
2871 title => "Body Parts",
2872 reply => undef,
2873 tooltip => "Shows which body parts you posess and are available",
2874 },
2875 "c/statistics" => {
2876 id => "infobox",
2877 title => "Statistics",
2878 reply => undef,
2879 tooltip => "Shows your primary statistics",
2880 },
2881 "c/skills" => {
2882 id => "infobox",
2883 title => "Skills",
2884 reply => undef,
2885 tooltip => "Shows your experience per skill and item power",
2886 },
2887 "c/shopitems" => {
2888 id => "infobox",
2889 title => "Shop Items",
2890 reply => undef,
2891 tooltip => "Shows the items currently for sale in this shop",
2892 },
2893 "c/resistances" => {
2894 id => "infobox",
2895 title => "Resistances",
2896 reply => undef,
2897 tooltip => "Shows your resistances",
2898 },
2899 "c/pets" => {
2900 id => "infobox",
2901 title => "Pets",
2902 reply => undef,
2903 tooltip => "Shows information abotu your pets/a specific pet",
2904 },
2905 "c/perceiveself" => {
2906 id => "infobox",
2907 title => "Perceive Self",
2908 reply => undef,
2909 tooltip => "You gained detailed knowledge about yourself",
2910 },
2911 "c/uptime" => {
2912 id => "infobox",
2913 title => "Uptime",
2914 reply => undef,
2915 tooltip => "How long the server has been running since last restart",
2916 },
2917 "c/mapinfo" => {
2918 id => "infobox",
2919 title => "Map Info",
2920 reply => undef,
2921 tooltip => "Information related to the maps",
2922 },
2923 "c/party" => {
2924 id => "party",
2925 title => "Party",
2926 reply => "gsay ",
2927 tooltip => "Messages and chat related to your party",
2928 },
2929 "c/death" => {
2930 id => "death",
2931 title => "Death",
2932 reply => undef,
2933 tooltip => "Reason for and more info about your most recent death",
2934 },
2935 "c/say" => $SAY_CHANNEL,
2936 "c/chat" => $CHAT_CHANNEL,
2937);
2938
2939sub cf::client::send_msg {
2940 my ($self, $channel, $msg, $color, @extra) = @_;
2941
2942 $msg = $self->pl->expand_cfpod ($msg)
2943 unless $color & cf::NDI_VERBATIM;
2944
2945 $color &= cf::NDI_CLIENT_MASK; # just in case...
2946
2947 # check predefined channels, for the benefit of C
2948 if ($CHANNEL{$channel}) {
2949 $channel = $CHANNEL{$channel};
2950
2951 $self->ext_msg (channel_info => $channel);
2952 $channel = $channel->{id};
2953
2954 } elsif (ref $channel) {
2955 # send meta info to client, if not yet sent
2956 unless (exists $self->{channel}{$channel->{id}}) {
2957 $self->{channel}{$channel->{id}} = $channel;
2958 $self->ext_msg (channel_info => $channel);
2959 }
2960
2961 $channel = $channel->{id};
2962 }
2963
2964 return unless @extra || length $msg;
2965
2966 # default colour, mask it out
2967 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2968 if $color & cf::NDI_DEF;
2969
2970 my $pkt = "msg "
2971 . $self->{json_coder}->encode (
2972 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2973 );
2974
2975 $self->send_big_packet ($pkt);
2976}
2977
2978=item $client->ext_msg ($type, @msg)
2979
2980Sends an ext event to the client.
2981
2982=cut
2983
2984sub cf::client::ext_msg($$@) {
2985 my ($self, $type, @msg) = @_;
2986
2987 if ($self->extcmd == 2) {
2988 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2989 } elsif ($self->extcmd == 1) { # TODO: remove
2990 push @msg, msgtype => "event_$type";
2991 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2992 }
2993}
2994
2995=item $client->ext_reply ($msgid, @msg)
2996
2997Sends an ext reply to the client.
2998
2999=cut
3000
3001sub cf::client::ext_reply($$@) {
3002 my ($self, $id, @msg) = @_;
3003
3004 if ($self->extcmd == 2) {
3005 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
3006 } elsif ($self->extcmd == 1) {
3007 #TODO: version 1, remove
3008 unshift @msg, msgtype => "reply", msgid => $id;
3009 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3010 }
3011}
913 3012
914=item $success = $client->query ($flags, "text", \&cb) 3013=item $success = $client->query ($flags, "text", \&cb)
915 3014
916Queues a query to the client, calling the given callback with 3015Queues a query to the client, calling the given callback with
917the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 3016the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
918C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 3017C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
919 3018
920Queries can fail, so check the return code. Or don't, as queries will become 3019Queries can fail, so check the return code. Or don't, as queries will
921reliable at some point in the future. 3020become reliable at some point in the future.
922 3021
923=cut 3022=cut
924 3023
925sub cf::client::query { 3024sub cf::client::query {
926 my ($self, $flags, $text, $cb) = @_; 3025 my ($self, $flags, $text, $cb) = @_;
934 utf8::encode $text; 3033 utf8::encode $text;
935 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3034 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
936 3035
937 $self->send_packet ($self->{query_queue}[0][0]) 3036 $self->send_packet ($self->{query_queue}[0][0])
938 if @{ $self->{query_queue} } == 1; 3037 if @{ $self->{query_queue} } == 1;
3038
3039 1
939} 3040}
940 3041
941cf::client->attach ( 3042cf::client->attach (
3043 on_connect => sub {
3044 my ($ns) = @_;
3045
3046 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3047 },
942 on_reply => sub { 3048 on_reply => sub {
943 my ($ns, $msg) = @_; 3049 my ($ns, $msg) = @_;
944 3050
945 # this weird shuffling is so that direct followup queries 3051 # this weird shuffling is so that direct followup queries
946 # get handled first 3052 # get handled first
947 my $queue = delete $ns->{query_queue}; 3053 my $queue = delete $ns->{query_queue}
3054 or return; # be conservative, not sure how that can happen, but we saw a crash here
948 3055
949 (shift @$queue)->[1]->($msg); 3056 (shift @$queue)->[1]->($msg);
3057 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
950 3058
951 push @{ $ns->{query_queue} }, @$queue; 3059 push @{ $ns->{query_queue} }, @$queue;
952 3060
953 if (@{ $ns->{query_queue} } == @$queue) { 3061 if (@{ $ns->{query_queue} } == @$queue) {
954 if (@$queue) { 3062 if (@$queue) {
956 } else { 3064 } else {
957 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3065 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
958 } 3066 }
959 } 3067 }
960 }, 3068 },
3069 on_exticmd => sub {
3070 my ($ns, $buf) = @_;
3071
3072 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3073
3074 if (ref $msg) {
3075 my ($type, $reply, @payload) =
3076 "ARRAY" eq ref $msg
3077 ? @$msg
3078 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3079
3080 my @reply;
3081
3082 if (my $cb = $EXTICMD{$type}) {
3083 @reply = $cb->($ns, @payload);
3084 }
3085
3086 $ns->ext_reply ($reply, @reply)
3087 if $reply;
3088
3089 } else {
3090 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3091 }
3092
3093 cf::override;
3094 },
961); 3095);
962 3096
963=item $client->coro (\&cb) 3097=item $client->async (\&cb)
964 3098
965Create a new coroutine, running the specified callback. The coroutine will 3099Create a new coroutine, running the specified callback. The coroutine will
966be automatically cancelled when the client gets destroyed (e.g. on logout, 3100be automatically cancelled when the client gets destroyed (e.g. on logout,
967or loss of connection). 3101or loss of connection).
968 3102
969=cut 3103=cut
970 3104
971sub cf::client::coro { 3105sub cf::client::async {
972 my ($self, $cb) = @_; 3106 my ($self, $cb) = @_;
973 3107
974 my $coro; $coro = async { 3108 my $coro = &Coro::async ($cb);
975 eval {
976 $cb->();
977 };
978 warn $@ if $@;
979 };
980 3109
981 $coro->on_destroy (sub { 3110 $coro->on_destroy (sub {
982 delete $self->{_coro}{$coro+0}; 3111 delete $self->{_coro}{$coro+0};
983 }); 3112 });
984 3113
1011our $safe = new Safe "safe"; 3140our $safe = new Safe "safe";
1012our $safe_hole = new Safe::Hole; 3141our $safe_hole = new Safe::Hole;
1013 3142
1014$SIG{FPE} = 'IGNORE'; 3143$SIG{FPE} = 'IGNORE';
1015 3144
1016$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3145$safe->permit_only (Opcode::opset qw(
3146 :base_core :base_mem :base_orig :base_math :base_loop
3147 grepstart grepwhile mapstart mapwhile
3148 sort time
3149));
1017 3150
1018# here we export the classes and methods available to script code 3151# here we export the classes and methods available to script code
1019 3152
1020=pod 3153=pod
1021 3154
1022The following fucntions and emthods are available within a safe environment: 3155The following functions and methods are available within a safe environment:
1023 3156
1024 cf::object contr pay_amount pay_player map 3157 cf::object
3158 contr pay_amount pay_player map x y force_find force_add destroy
3159 insert remove name archname title slaying race decrease split
3160 value
3161
1025 cf::object::player player 3162 cf::object::player
1026 cf::player peaceful 3163 player
1027 cf::map trigger 3164
3165 cf::player
3166 peaceful
3167
3168 cf::map
3169 trigger
1028 3170
1029=cut 3171=cut
1030 3172
1031for ( 3173for (
1032 ["cf::object" => qw(contr pay_amount pay_player map)], 3174 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3175 insert remove inv nrof name archname title slaying race
3176 decrease split destroy change_exp value msg lore send_msg)],
1033 ["cf::object::player" => qw(player)], 3177 ["cf::object::player" => qw(player)],
1034 ["cf::player" => qw(peaceful)], 3178 ["cf::player" => qw(peaceful send_msg)],
1035 ["cf::map" => qw(trigger)], 3179 ["cf::map" => qw(trigger)],
1036) { 3180) {
1037 no strict 'refs'; 3181 no strict 'refs';
1038 my ($pkg, @funs) = @$_; 3182 my ($pkg, @funs) = @$_;
1039 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3183 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1057 3201
1058 my $qcode = $code; 3202 my $qcode = $code;
1059 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3203 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1060 $qcode =~ s/\n/\\n/g; 3204 $qcode =~ s/\n/\\n/g;
1061 3205
3206 %vars = (_dummy => 0) unless %vars;
3207
3208 my @res;
1062 local $_; 3209 local $_;
1063 local @safe::cf::_safe_eval_args = values %vars;
1064 3210
1065 my $eval = 3211 my $eval =
1066 "do {\n" 3212 "do {\n"
1067 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3213 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1068 . "#line 0 \"{$qcode}\"\n" 3214 . "#line 0 \"{$qcode}\"\n"
1069 . $code 3215 . $code
1070 . "\n}" 3216 . "\n}"
1071 ; 3217 ;
1072 3218
3219 if ($CFG{safe_eval}) {
1073 sub_generation_inc; 3220 sub_generation_inc;
3221 local @safe::cf::_safe_eval_args = values %vars;
1074 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3222 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1075 sub_generation_inc; 3223 sub_generation_inc;
3224 } else {
3225 local @cf::_safe_eval_args = values %vars;
3226 @res = wantarray ? eval eval : scalar eval $eval;
3227 }
1076 3228
1077 if ($@) { 3229 if ($@) {
1078 warn "$@"; 3230 warn "$@";
1079 warn "while executing safe code '$code'\n"; 3231 warn "while executing safe code '$code'\n";
1080 warn "with arguments " . (join " ", %vars) . "\n"; 3232 warn "with arguments " . (join " ", %vars) . "\n";
1099=cut 3251=cut
1100 3252
1101sub register_script_function { 3253sub register_script_function {
1102 my ($fun, $cb) = @_; 3254 my ($fun, $cb) = @_;
1103 3255
1104 no strict 'refs'; 3256 $fun = "safe::$fun" if $CFG{safe_eval};
1105 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3257 *$fun = $safe_hole->wrap ($cb);
1106} 3258}
1107 3259
1108=back 3260=back
1109 3261
1110=cut 3262=cut
1111 3263
1112############################################################################# 3264#############################################################################
3265# the server's init and main functions
1113 3266
1114=head2 EXTENSION DATABASE SUPPORT 3267sub load_facedata($) {
3268 my ($path) = @_;
1115 3269
1116Crossfire maintains a very simple database for extension use. It can 3270 # HACK to clear player env face cache, we need some signal framework
1117currently store anything that can be serialised using Storable, which 3271 # for this (global event?)
1118excludes objects. 3272 %ext::player_env::MUSIC_FACE_CACHE = ();
1119 3273
1120The parameter C<$family> should best start with the name of the extension 3274 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1121using it, it should be unique.
1122 3275
1123=over 4 3276 warn "loading facedata from $path\n";
1124 3277
1125=item $hashref = cf::db_get $family 3278 my $facedata;
3279 0 < aio_load $path, $facedata
3280 or die "$path: $!";
1126 3281
1127Return a hashref for use by the extension C<$family>, which can be 3282 $facedata = Coro::Storable::thaw $facedata;
1128modified. After modifications, you have to call C<cf::db_dirty> or
1129C<cf::db_sync>.
1130 3283
1131=item $value = cf::db_get $family => $key 3284 $facedata->{version} == 2
3285 or cf::cleanup "$path: version mismatch, cannot proceed.";
1132 3286
1133Returns a single value from the database 3287 # patch in the exptable
3288 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
3289 $facedata->{resource}{"res/exp_table"} = {
3290 type => FT_RSRC,
3291 data => $exp_table,
3292 hash => (Digest::MD5::md5 $exp_table),
3293 };
3294 cf::cede_to_tick;
1134 3295
1135=item cf::db_put $family => $hashref 3296 {
3297 my $faces = $facedata->{faceinfo};
1136 3298
1137Stores the given family hashref into the database. Updates are delayed, if 3299 while (my ($face, $info) = each %$faces) {
1138you want the data to be synced to disk immediately, use C<cf::db_sync>. 3300 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1139 3301
1140=item cf::db_put $family => $key => $value 3302 cf::face::set_visibility $idx, $info->{visibility};
3303 cf::face::set_magicmap $idx, $info->{magicmap};
3304 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
3305 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
1141 3306
1142Stores the given C<$value> in the family hash. Updates are delayed, if you 3307 cf::cede_to_tick;
1143want the data to be synced to disk immediately, use C<cf::db_sync>. 3308 }
1144 3309
1145=item cf::db_dirty 3310 while (my ($face, $info) = each %$faces) {
3311 next unless $info->{smooth};
1146 3312
1147Marks the database as dirty, to be updated at a later time. 3313 my $idx = cf::face::find $face
3314 or next;
1148 3315
1149=item cf::db_sync 3316 if (my $smooth = cf::face::find $info->{smooth}) {
3317 cf::face::set_smooth $idx, $smooth;
3318 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3319 } else {
3320 warn "smooth face '$info->{smooth}' not found for face '$face'";
3321 }
1150 3322
1151Immediately write the database to disk I<if it is dirty>. 3323 cf::cede_to_tick;
3324 }
3325 }
1152 3326
1153=cut 3327 {
3328 my $anims = $facedata->{animinfo};
1154 3329
1155our $DB; 3330 while (my ($anim, $info) = each %$anims) {
3331 cf::anim::set $anim, $info->{frames}, $info->{facings};
3332 cf::cede_to_tick;
3333 }
3334
3335 cf::anim::invalidate_all; # d'oh
3336 }
3337
3338 {
3339 my $res = $facedata->{resource};
3340
3341 while (my ($name, $info) = each %$res) {
3342 if (defined $info->{type}) {
3343 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3344
3345 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3346 cf::face::set_type $idx, $info->{type};
3347 } else {
3348 $RESOURCE{$name} = $info;
3349 }
3350
3351 cf::cede_to_tick;
3352 }
3353 }
3354
3355 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3356
3357 1
3358}
3359
3360cf::global->attach (on_resource_update => sub {
3361 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3362 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3363
3364 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3365 my $sound = $soundconf->{compat}[$_]
3366 or next;
3367
3368 my $face = cf::face::find "sound/$sound->[1]";
3369 cf::sound::set $sound->[0] => $face;
3370 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3371 }
3372
3373 while (my ($k, $v) = each %{$soundconf->{event}}) {
3374 my $face = cf::face::find "sound/$v";
3375 cf::sound::set $k => $face;
3376 }
3377 }
3378});
3379
3380register_exticmd fx_want => sub {
3381 my ($ns, $want) = @_;
3382
3383 while (my ($k, $v) = each %$want) {
3384 $ns->fx_want ($k, $v);
3385 }
3386};
3387
3388sub load_resource_file($) {
3389 my $guard = lock_acquire "load_resource_file";
3390
3391 my $status = load_resource_file_ $_[0];
3392 get_slot 0.1, 100;
3393 cf::arch::commit_load;
3394
3395 $status
3396}
3397
3398sub reload_regions {
3399 # HACK to clear player env face cache, we need some signal framework
3400 # for this (global event?)
3401 %ext::player_env::MUSIC_FACE_CACHE = ();
3402
3403 load_resource_file "$MAPDIR/regions"
3404 or die "unable to load regions file\n";
3405
3406 for (cf::region::list) {
3407 $_->{match} = qr/$_->{match}/
3408 if exists $_->{match};
3409 }
3410}
3411
3412sub reload_facedata {
3413 load_facedata "$DATADIR/facedata"
3414 or die "unable to load facedata\n";
3415}
3416
3417sub reload_archetypes {
3418 load_resource_file "$DATADIR/archetypes"
3419 or die "unable to load archetypes\n";
3420}
3421
3422sub reload_treasures {
3423 load_resource_file "$DATADIR/treasures"
3424 or die "unable to load treasurelists\n";
3425}
3426
3427sub reload_resources {
3428 warn "reloading resource files...\n";
3429
3430 reload_facedata;
3431 reload_archetypes;
3432 reload_regions;
3433 reload_treasures;
3434
3435 warn "finished reloading resource files\n";
3436}
3437
3438sub reload_config {
3439 warn "reloading config file...\n";
3440
3441 open my $fh, "<:utf8", "$CONFDIR/config"
3442 or return;
3443
3444 local $/;
3445 *CFG = YAML::XS::Load scalar <$fh>;
3446
3447 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3448
3449 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3450 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3451
3452 if (exists $CFG{mlockall}) {
3453 eval {
3454 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3455 and die "WARNING: m(un)lockall failed: $!\n";
3456 };
3457 warn $@ if $@;
3458 }
3459
3460 warn "finished reloading resource files\n";
3461}
3462
3463sub pidfile() {
3464 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3465 or die "$PIDFILE: $!";
3466 flock $fh, &Fcntl::LOCK_EX
3467 or die "$PIDFILE: flock: $!";
3468 $fh
3469}
3470
3471# make sure only one server instance is running at any one time
3472sub atomic {
3473 my $fh = pidfile;
3474
3475 my $pid = <$fh>;
3476 kill 9, $pid if $pid > 0;
3477
3478 seek $fh, 0, 0;
3479 print $fh $$;
3480}
3481
3482sub main_loop {
3483 warn "EV::loop starting\n";
3484 if (1) {
3485 EV::loop;
3486 }
3487 warn "EV::loop returned\n";
3488 goto &main_loop unless $REALLY_UNLOOP;
3489}
3490
3491sub main {
3492 cf::init_globals; # initialise logging
3493
3494 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3495 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3496 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3497 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3498
3499 cf::init_experience;
3500 cf::init_anim;
3501 cf::init_attackmess;
3502 cf::init_dynamic;
3503
3504 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3505
3506 # we must not ever block the main coroutine
3507 local $Coro::idle = sub {
3508 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3509 (async {
3510 $Coro::current->{desc} = "IDLE BUG HANDLER";
3511 EV::loop EV::LOOP_ONESHOT;
3512 })->prio (Coro::PRIO_MAX);
3513 };
3514
3515 evthread_start IO::AIO::poll_fileno;
3516
3517 cf::sync_job {
3518 cf::load_settings;
3519 cf::load_materials;
3520
3521 reload_resources;
3522 reload_config;
3523 db_init;
3524
3525 cf::init_uuid;
3526 cf::init_signals;
3527 cf::init_commands;
3528 cf::init_skills;
3529
3530 cf::init_beforeplay;
3531
3532 atomic;
3533
3534 load_extensions;
3535
3536 utime time, time, $RUNTIMEFILE;
3537
3538 # no (long-running) fork's whatsoever before this point(!)
3539 use POSIX ();
3540 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3541
3542 (pop @POST_INIT)->(0) while @POST_INIT;
3543 };
3544
3545 main_loop;
3546}
3547
3548#############################################################################
3549# initialisation and cleanup
3550
3551# install some emergency cleanup handlers
3552BEGIN {
3553 our %SIGWATCHER = ();
3554 for my $signal (qw(INT HUP TERM)) {
3555 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3556 cf::cleanup "SIG$signal";
3557 };
3558 }
3559}
3560
3561sub write_runtime_sync {
3562 # first touch the runtime file to show we are still running:
3563 # the fsync below can take a very very long time.
3564
3565 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3566
3567 my $guard = cf::lock_acquire "write_runtime";
3568
3569 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3570 or return;
3571
3572 my $value = $cf::RUNTIME + 90 + 10;
3573 # 10 is the runtime save interval, for a monotonic clock
3574 # 60 allows for the watchdog to kill the server.
3575
3576 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3577 and return;
3578
3579 # always fsync - this file is important
3580 aio_fsync $fh
3581 and return;
3582
3583 # touch it again to show we are up-to-date
3584 aio_utime $fh, undef, undef;
3585
3586 close $fh
3587 or return;
3588
3589 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3590 and return;
3591
3592 warn "runtime file written.\n";
3593
3594 1
3595}
3596
3597our $uuid_lock;
3598our $uuid_skip;
3599
3600sub write_uuid_sync($) {
3601 $uuid_skip ||= $_[0];
3602
3603 return if $uuid_lock;
3604 local $uuid_lock = 1;
3605
3606 my $uuid = "$LOCALDIR/uuid";
3607
3608 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3609 or return;
3610
3611 my $value = uuid_seq uuid_cur;
3612
3613 unless ($value) {
3614 warn "cowardly refusing to write zero uuid value!\n";
3615 return;
3616 }
3617
3618 my $value = uuid_str $value + $uuid_skip;
3619 $uuid_skip = 0;
3620
3621 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3622 and return;
3623
3624 # always fsync - this file is important
3625 aio_fsync $fh
3626 and return;
3627
3628 close $fh
3629 or return;
3630
3631 aio_rename "$uuid~", $uuid
3632 and return;
3633
3634 warn "uuid file written ($value).\n";
3635
3636 1
3637
3638}
3639
3640sub write_uuid($$) {
3641 my ($skip, $sync) = @_;
3642
3643 $sync ? write_uuid_sync $skip
3644 : async { write_uuid_sync $skip };
3645}
3646
3647sub emergency_save() {
3648 my $freeze_guard = cf::freeze_mainloop;
3649
3650 warn "emergency_perl_save: enter\n";
3651
3652 cf::sync_job {
3653 # this is a trade-off: we want to be very quick here, so
3654 # save all maps without fsync, and later call a global sync
3655 # (which in turn might be very very slow)
3656 local $USE_FSYNC = 0;
3657
3658 # use a peculiar iteration method to avoid tripping on perl
3659 # refcount bugs in for. also avoids problems with players
3660 # and maps saved/destroyed asynchronously.
3661 warn "emergency_perl_save: begin player save\n";
3662 for my $login (keys %cf::PLAYER) {
3663 my $pl = $cf::PLAYER{$login} or next;
3664 $pl->valid or next;
3665 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3666 $pl->save;
3667 }
3668 warn "emergency_perl_save: end player save\n";
3669
3670 warn "emergency_perl_save: begin map save\n";
3671 for my $path (keys %cf::MAP) {
3672 my $map = $cf::MAP{$path} or next;
3673 $map->valid or next;
3674 $map->save;
3675 }
3676 warn "emergency_perl_save: end map save\n";
3677
3678 warn "emergency_perl_save: begin database checkpoint\n";
3679 BDB::db_env_txn_checkpoint $DB_ENV;
3680 warn "emergency_perl_save: end database checkpoint\n";
3681
3682 warn "emergency_perl_save: begin write uuid\n";
3683 write_uuid_sync 1;
3684 warn "emergency_perl_save: end write uuid\n";
3685 };
3686
3687 warn "emergency_perl_save: starting sync()\n";
3688 IO::AIO::aio_sync sub {
3689 warn "emergency_perl_save: finished sync()\n";
3690 };
3691
3692 warn "emergency_perl_save: leave\n";
3693}
3694
3695sub post_cleanup {
3696 my ($make_core) = @_;
3697
3698 warn Carp::longmess "post_cleanup backtrace"
3699 if $make_core;
3700
3701 my $fh = pidfile;
3702 unlink $PIDFILE if <$fh> == $$;
3703}
3704
3705# a safer delete_package, copied from Symbol
3706sub clear_package($) {
3707 my $pkg = shift;
3708
3709 # expand to full symbol table name if needed
3710 unless ($pkg =~ /^main::.*::$/) {
3711 $pkg = "main$pkg" if $pkg =~ /^::/;
3712 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3713 $pkg .= '::' unless $pkg =~ /::$/;
3714 }
3715
3716 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3717 my $stem_symtab = *{$stem}{HASH};
3718
3719 defined $stem_symtab and exists $stem_symtab->{$leaf}
3720 or return;
3721
3722 # clear all symbols
3723 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3724 for my $name (keys %$leaf_symtab) {
3725 _gv_clear *{"$pkg$name"};
3726# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3727 }
3728 warn "cleared package $pkg\n";#d#
3729}
3730
3731sub do_reload_perl() {
3732 # can/must only be called in main
3733 if ($Coro::current != $Coro::main) {
3734 warn "can only reload from main coroutine";
3735 return;
3736 }
3737
3738 return if $RELOAD++;
3739
3740 my $t1 = EV::time;
3741
3742 while ($RELOAD) {
3743 warn "reloading...";
3744
3745 warn "entering sync_job";
3746
3747 cf::sync_job {
3748 cf::write_runtime_sync; # external watchdog should not bark
3749 cf::emergency_save;
3750 cf::write_runtime_sync; # external watchdog should not bark
3751
3752 warn "syncing database to disk";
3753 BDB::db_env_txn_checkpoint $DB_ENV;
3754
3755 # if anything goes wrong in here, we should simply crash as we already saved
3756
3757 warn "flushing outstanding aio requests";
3758 while (IO::AIO::nreqs || BDB::nreqs) {
3759 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3760 }
3761
3762 warn "cancelling all extension coros";
3763 $_->cancel for values %EXT_CORO;
3764 %EXT_CORO = ();
3765
3766 warn "removing commands";
3767 %COMMAND = ();
3768
3769 warn "removing ext/exti commands";
3770 %EXTCMD = ();
3771 %EXTICMD = ();
3772
3773 warn "unloading/nuking all extensions";
3774 for my $pkg (@EXTS) {
3775 warn "... unloading $pkg";
3776
3777 if (my $cb = $pkg->can ("unload")) {
3778 eval {
3779 $cb->($pkg);
3780 1
3781 } or warn "$pkg unloaded, but with errors: $@";
3782 }
3783
3784 warn "... clearing $pkg";
3785 clear_package $pkg;
3786 }
3787
3788 warn "unloading all perl modules loaded from $LIBDIR";
3789 while (my ($k, $v) = each %INC) {
3790 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3791
3792 warn "... unloading $k";
3793 delete $INC{$k};
3794
3795 $k =~ s/\.pm$//;
3796 $k =~ s/\//::/g;
3797
3798 if (my $cb = $k->can ("unload_module")) {
3799 $cb->();
3800 }
3801
3802 clear_package $k;
3803 }
3804
3805 warn "getting rid of safe::, as good as possible";
3806 clear_package "safe::$_"
3807 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
3808
3809 warn "unloading cf.pm \"a bit\"";
3810 delete $INC{"cf.pm"};
3811 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
3812
3813 # don't, removes xs symbols, too,
3814 # and global variables created in xs
3815 #clear_package __PACKAGE__;
3816
3817 warn "unload completed, starting to reload now";
3818
3819 warn "reloading cf.pm";
3820 require cf;
3821 cf::_connect_to_perl_1;
3822
3823 warn "loading config and database again";
3824 cf::reload_config;
3825
3826 warn "loading extensions";
3827 cf::load_extensions;
3828
3829 if ($REATTACH_ON_RELOAD) {
3830 warn "reattaching attachments to objects/players";
3831 _global_reattach; # objects, sockets
3832 warn "reattaching attachments to maps";
3833 reattach $_ for values %MAP;
3834 warn "reattaching attachments to players";
3835 reattach $_ for values %PLAYER;
3836 }
3837
3838 warn "running post_init jobs";
3839 (pop @POST_INIT)->(1) while @POST_INIT;
3840
3841 warn "leaving sync_job";
3842
3843 1
3844 } or do {
3845 warn $@;
3846 cf::cleanup "error while reloading, exiting.";
3847 };
3848
3849 warn "reloaded";
3850 --$RELOAD;
3851 }
3852
3853 $t1 = EV::time - $t1;
3854 warn "reload completed in ${t1}s\n";
3855};
3856
3857our $RELOAD_WATCHER; # used only during reload
3858
3859sub reload_perl() {
3860 # doing reload synchronously and two reloads happen back-to-back,
3861 # coro crashes during coro_state_free->destroy here.
3862
3863 $RELOAD_WATCHER ||= cf::async {
3864 Coro::AIO::aio_wait cache_extensions;
3865
3866 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3867 do_reload_perl;
3868 undef $RELOAD_WATCHER;
3869 };
3870 };
3871}
3872
3873register_command "reload" => sub {
3874 my ($who, $arg) = @_;
3875
3876 if ($who->flag (FLAG_WIZ)) {
3877 $who->message ("reloading server.");
3878 async {
3879 $Coro::current->{desc} = "perl_reload";
3880 reload_perl;
3881 };
3882 }
3883};
3884
3885unshift @INC, $LIBDIR;
3886
3887my $bug_warning = 0;
3888
3889our @WAIT_FOR_TICK;
3890our @WAIT_FOR_TICK_BEGIN;
3891
3892sub wait_for_tick {
3893 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3894
3895 my $signal = new Coro::Signal;
3896 push @WAIT_FOR_TICK, $signal;
3897 $signal->wait;
3898}
3899
3900sub wait_for_tick_begin {
3901 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3902
3903 my $signal = new Coro::Signal;
3904 push @WAIT_FOR_TICK_BEGIN, $signal;
3905 $signal->wait;
3906}
3907
3908sub tick {
3909 if ($Coro::current != $Coro::main) {
3910 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3911 unless ++$bug_warning > 10;
3912 return;
3913 }
3914
3915 cf::server_tick; # one server iteration
3916
3917 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3918 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
3919 Coro::async_pool {
3920 $Coro::current->{desc} = "runtime saver";
3921 write_runtime_sync
3922 or warn "ERROR: unable to write runtime file: $!";
3923 };
3924 }
3925
3926 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3927 $sig->send;
3928 }
3929 while (my $sig = shift @WAIT_FOR_TICK) {
3930 $sig->send;
3931 }
3932
3933 $LOAD = ($NOW - $TICK_START) / $TICK;
3934 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3935
3936 if (0) {
3937 if ($NEXT_TICK) {
3938 my $jitter = $TICK_START - $NEXT_TICK;
3939 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3940 warn "jitter $JITTER\n";#d#
3941 }
3942 }
3943}
1156 3944
1157{ 3945{
1158 my $path = cf::localdir . "/database.pst"; 3946 # configure BDB
1159 3947
1160 sub db_load() { 3948 BDB::min_parallel 8;
1161 warn "loading database $path\n";#d# remove later 3949 BDB::max_poll_reqs $TICK * 0.1;
1162 $DB = stat $path ? Storable::retrieve $path : { }; 3950 $AnyEvent::BDB::WATCHER->priority (1);
1163 }
1164 3951
1165 my $pid; 3952 unless ($DB_ENV) {
3953 $DB_ENV = BDB::db_env_create;
3954 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3955 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3956 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3957 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3958 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
1166 3959
1167 sub db_save() { 3960 cf::sync_job {
1168 warn "saving database $path\n";#d# remove later
1169 waitpid $pid, 0 if $pid;
1170 if (0 == ($pid = fork)) {
1171 $DB->{_meta}{version} = 1;
1172 Storable::nstore $DB, "$path~";
1173 rename "$path~", $path;
1174 cf::_exit 0 if defined $pid;
1175 }
1176 }
1177
1178 my $dirty;
1179
1180 sub db_sync() {
1181 db_save if $dirty;
1182 undef $dirty;
1183 }
1184
1185 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1186 db_sync;
1187 });
1188
1189 sub db_dirty() {
1190 $dirty = 1;
1191 $idle->start;
1192 }
1193
1194 sub db_get($;$) {
1195 @_ >= 2
1196 ? $DB->{$_[0]}{$_[1]}
1197 : ($DB->{$_[0]} ||= { })
1198 }
1199
1200 sub db_put($$;$) {
1201 if (@_ >= 3) {
1202 $DB->{$_[0]}{$_[1]} = $_[2];
1203 } else { 3961 eval {
1204 $DB->{$_[0]} = $_[1]; 3962 BDB::db_env_open
1205 } 3963 $DB_ENV,
1206 db_dirty; 3964 $BDBDIR,
1207 } 3965 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3966 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3967 0666;
1208 3968
1209 cf::global->attach ( 3969 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
1210 prio => 10000,
1211 on_cleanup => sub {
1212 db_sync;
1213 },
1214 );
1215}
1216
1217#############################################################################
1218# the server's main()
1219
1220sub cfg_load {
1221 open my $fh, "<:utf8", cf::confdir . "/config"
1222 or return;
1223
1224 local $/;
1225 *CFG = YAML::Syck::Load <$fh>;
1226}
1227
1228sub main {
1229 cfg_load;
1230 db_load;
1231 load_extensions;
1232 Event::loop;
1233}
1234
1235#############################################################################
1236# initialisation
1237
1238sub _perl_reload() {
1239 warn "reloading...";
1240
1241 eval {
1242 local $FREEZE = 1;
1243
1244 cf::emergency_save;
1245
1246 # cancel all watchers
1247 for (Event::all_watchers) {
1248 $_->cancel if $_->data & WF_AUTOCANCEL;
1249 }
1250
1251 # cancel all extension coros
1252 $_->cancel for values %EXT_CORO;
1253 %EXT_CORO = ();
1254
1255 # unload all extensions
1256 for (@exts) {
1257 warn "unloading <$_>";
1258 unload_extension $_;
1259 }
1260
1261 # unload all modules loaded from $LIBDIR
1262 while (my ($k, $v) = each %INC) {
1263 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1264
1265 warn "removing <$k>";
1266 delete $INC{$k};
1267
1268 $k =~ s/\.pm$//;
1269 $k =~ s/\//::/g;
1270
1271 if (my $cb = $k->can ("unload_module")) {
1272 $cb->();
1273 } 3970 };
1274 3971
1275 Symbol::delete_package $k; 3972 cf::cleanup "db_env_open(db): $@" if $@;
1276 } 3973 };
3974 }
1277 3975
1278 # sync database to disk 3976 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
1279 cf::db_sync; 3977 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
1280 IO::AIO::flush;
1281
1282 # get rid of safe::, as good as possible
1283 Symbol::delete_package "safe::$_"
1284 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1285
1286 # remove register_script_function callbacks
1287 # TODO
1288
1289 # unload cf.pm "a bit"
1290 delete $INC{"cf.pm"};
1291
1292 # don't, removes xs symbols, too,
1293 # and global variables created in xs
1294 #Symbol::delete_package __PACKAGE__;
1295
1296 # reload cf.pm
1297 warn "reloading cf.pm";
1298 require cf;
1299 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1300
1301 # load config and database again
1302 cf::cfg_load;
1303 cf::db_load;
1304
1305 # load extensions
1306 warn "load extensions";
1307 cf::load_extensions;
1308
1309 # reattach attachments to objects
1310 warn "reattach";
1311 _global_reattach;
1312 }; 3978 };
1313 warn $@ if $@; 3979 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
1314 3980 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
1315 warn "reloaded";
1316};
1317
1318sub perl_reload() {
1319 _perl_reload;
1320}
1321
1322register "<global>", __PACKAGE__;
1323
1324register_command "perl-reload" => sub {
1325 my ($who, $arg) = @_;
1326
1327 if ($who->flag (FLAG_WIZ)) {
1328 $who->message ("reloading...");
1329 _perl_reload;
1330 } 3981 };
1331}; 3982 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3983 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3984 };
3985}
1332 3986
1333unshift @INC, $LIBDIR; 3987{
3988 # configure IO::AIO
1334 3989
1335$TICK_WATCHER = Event->timer ( 3990 IO::AIO::min_parallel 8;
1336 reentrant => 0, 3991 IO::AIO::max_poll_time $TICK * 0.1;
1337 prio => 0, 3992 undef $AnyEvent::AIO::WATCHER;
1338 at => $NEXT_TICK || $TICK, 3993}
1339 data => WF_AUTOCANCEL, 3994
1340 cb => sub { 3995my $_log_backtrace;
1341 unless ($FREEZE) { 3996
1342 cf::server_tick; # one server iteration 3997sub _log_backtrace {
1343 $RUNTIME += $TICK; 3998 my ($msg, @addr) = @_;
3999
4000 $msg =~ s/\n//;
4001
4002 # limit the # of concurrent backtraces
4003 if ($_log_backtrace < 2) {
4004 ++$_log_backtrace;
4005 my $perl_bt = Carp::longmess $msg;
4006 async {
4007 $Coro::current->{desc} = "abt $msg";
4008
4009 my @bt = fork_call {
4010 @addr = map { sprintf "%x", $_ } @addr;
4011 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4012 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4013 or die "addr2line: $!";
4014
4015 my @funcs;
4016 my @res = <$fh>;
4017 chomp for @res;
4018 while (@res) {
4019 my ($func, $line) = splice @res, 0, 2, ();
4020 push @funcs, "[$func] $line";
4021 }
4022
4023 @funcs
4024 };
4025
4026 LOG llevInfo, "[ABT] $perl_bt\n";
4027 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4028 LOG llevInfo, "[ABT] $_\n" for @bt;
4029 --$_log_backtrace;
1344 } 4030 };
1345 4031 } else {
1346 $NEXT_TICK += $TICK; 4032 LOG llevInfo, "[ABT] $msg\n";
1347 4033 LOG llevInfo, "[ABT] [suppressed]\n";
1348 # if we are delayed by four ticks or more, skip them all
1349 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1350
1351 $TICK_WATCHER->at ($NEXT_TICK);
1352 $TICK_WATCHER->start;
1353 }, 4034 }
1354); 4035}
1355 4036
1356IO::AIO::max_poll_time $TICK * 0.2; 4037# load additional modules
4038require "cf/$_.pm" for @EXTRA_MODULES;
4039cf::_connect_to_perl_2;
1357 4040
1358Event->io (fd => IO::AIO::poll_fileno, 4041END { cf::emergency_save }
1359 poll => 'r',
1360 prio => 5,
1361 data => WF_AUTOCANCEL,
1362 cb => \&IO::AIO::poll_cb);
1363
1364# we must not ever block the main coroutine
1365$Coro::idle = sub {
1366 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1367 warn "FATAL: Coro::idle was called, major BUG\n";
1368 (Coro::unblock_sub {
1369 Event::one_event;
1370 })->();
1371};
1372 4042
13731 40431
1374 4044

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines