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.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.479 by root, Thu Oct 8 05:04:27 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines