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.155 by root, Tue Jan 9 21:32:42 2007 UTC vs.
Revision 1.506 by root, Wed Feb 3 20:48:22 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines