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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines