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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines