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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines