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.141 by root, Fri Jan 5 20:08:53 2007 UTC vs.
Revision 1.512 by root, Sun Apr 11 04:52:07 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines