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.157 by root, Wed Jan 10 01:16:54 2007 UTC vs.
Revision 1.493 by root, Mon Oct 26 02:34:37 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines