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.514 by root, Mon Apr 12 17:13:36 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines