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.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.419 by root, Sun Apr 13 01:34:09 2008 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
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your 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 GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>.
18#
19# The authors can be reached via e-mail to <support@deliantra.net>
20#
21
1package cf; 22package cf;
2 23
3use utf8; 24use utf8;
4use strict; 25use strict;
5 26
6use Symbol; 27use Symbol;
7use List::Util; 28use List::Util;
8use Storable; 29use Socket;
30use EV 3.2;
9use Opcode; 31use Opcode;
10use Safe; 32use Safe;
11use Safe::Hole; 33use Safe::Hole;
34use Storable ();
12 35
13use Coro 3.5 (); 36use Coro 4.50 ();
37use Coro::State;
38use Coro::Handle;
14use Coro::Event; 39use Coro::EV;
15use Coro::Timer; 40use Coro::Timer;
16use Coro::Signal; 41use Coro::Signal;
17use Coro::Semaphore; 42use Coro::Semaphore;
18use Coro::AIO; 43use Coro::AIO;
44use Coro::BDB;
45use Coro::Storable;
46use Coro::Util ();
19 47
48use JSON::XS 2.01 ();
20use BDB (); 49use BDB ();
21use Data::Dumper; 50use Data::Dumper;
22use Digest::MD5; 51use Digest::MD5;
23use Fcntl; 52use Fcntl;
53use YAML ();
24use IO::AIO 2.32 (); 54use IO::AIO 2.51 ();
25use YAML::Syck ();
26use Time::HiRes; 55use Time::HiRes;
56use Compress::LZF;
57use Digest::MD5 ();
27 58
28use Event; $Event::Eval = 1; # no idea why this is required, but it is 59# configure various modules to our taste
60#
61$Storable::canonical = 1; # reduce rsync transfers
62Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
63Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
64
65$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
29 66
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 67sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31
32# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33$YAML::Syck::ImplicitUnicode = 1;
34
35$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36 68
37our %COMMAND = (); 69our %COMMAND = ();
38our %COMMAND_TIME = (); 70our %COMMAND_TIME = ();
39 71
40our @EXTS = (); # list of extension package names 72our @EXTS = (); # list of extension package names
41our %EXTCMD = (); 73our %EXTCMD = ();
74our %EXTICMD = ();
42our %EXT_CORO = (); # coroutines bound to extensions 75our %EXT_CORO = (); # coroutines bound to extensions
43our %EXT_MAP = (); # pluggable maps 76our %EXT_MAP = (); # pluggable maps
44 77
78our $RELOAD; # number of reloads so far
45our @EVENT; 79our @EVENT;
46our $LIBDIR = datadir . "/ext";
47 80
48our $TICK = MAX_TIME * 1e-6; 81our $CONFDIR = confdir;
49our $TICK_WATCHER; 82our $DATADIR = datadir;
83our $LIBDIR = "$DATADIR/ext";
84our $PODDIR = "$DATADIR/pod";
85our $MAPDIR = "$DATADIR/" . mapdir;
86our $LOCALDIR = localdir;
87our $TMPDIR = "$LOCALDIR/" . tmpdir;
88our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
89our $PLAYERDIR = "$LOCALDIR/" . playerdir;
90our $RANDOMDIR = "$LOCALDIR/random";
91our $BDBDIR = "$LOCALDIR/db";
92our %RESOURCE;
93
94our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
50our $AIO_POLL_WATCHER; 95our $AIO_POLL_WATCHER;
51our $WRITE_RUNTIME_WATCHER; 96our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
52our $NEXT_TICK; 97our $NEXT_TICK;
53our $NOW;
54our $USE_FSYNC = 1; # use fsync to write maps - default off 98our $USE_FSYNC = 1; # use fsync to write maps - default off
55 99
56our $BDB_POLL_WATCHER; 100our $BDB_POLL_WATCHER;
101our $BDB_DEADLOCK_WATCHER;
102our $BDB_CHECKPOINT_WATCHER;
103our $BDB_TRICKLE_WATCHER;
57our $DB_ENV; 104our $DB_ENV;
58 105
59our %CFG; 106our %CFG;
60 107
61our $UPTIME; $UPTIME ||= time; 108our $UPTIME; $UPTIME ||= time;
62our $RUNTIME; 109our $RUNTIME;
110our $NOW;
63 111
64our %PLAYER; # all users 112our (%PLAYER, %PLAYER_LOADING); # all users
65our %MAP; # all maps 113our (%MAP, %MAP_LOADING ); # all maps
66our $LINK_MAP; # the special {link} map, which is always available 114our $LINK_MAP; # the special {link} map, which is always available
67our $RANDOM_MAPS = cf::localdir . "/random";
68our $BDB_ENV_DIR = cf::localdir . "/db";
69
70our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72 115
73# used to convert map paths into valid unix filenames by replacing / by ∕ 116# used to convert map paths into valid unix filenames by replacing / by ∕
74our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 117our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75 118
119our $LOAD; # a number between 0 (idle) and 1 (too many objects)
120our $LOADAVG; # same thing, but with alpha-smoothing
121our $JITTER; # average jitter
122our $TICK_START; # for load detecting purposes
123
76binmode STDOUT; 124binmode STDOUT;
77binmode STDERR; 125binmode STDERR;
78 126
79# read virtual server time, if available 127# read virtual server time, if available
80unless ($RUNTIME || !-e cf::localdir . "/runtime") { 128unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
81 open my $fh, "<", cf::localdir . "/runtime" 129 open my $fh, "<", "$LOCALDIR/runtime"
82 or die "unable to read runtime file: $!"; 130 or die "unable to read runtime file: $!";
83 $RUNTIME = <$fh> + 0.; 131 $RUNTIME = <$fh> + 0.;
84} 132}
85 133
86mkdir cf::localdir; 134mkdir $_
87mkdir cf::localdir . "/" . cf::playerdir; 135 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
88mkdir cf::localdir . "/" . cf::tmpdir;
89mkdir cf::localdir . "/" . cf::uniquedir;
90mkdir $RANDOM_MAPS;
91mkdir $BDB_ENV_DIR;
92 136
93our $EMERGENCY_POSITION; 137our $EMERGENCY_POSITION;
94 138
95sub cf::map::normalise; 139sub cf::map::normalise;
96 140
107=item $cf::RUNTIME 151=item $cf::RUNTIME
108 152
109The time this server has run, starts at 0 and is increased by $cf::TICK on 153The time this server has run, starts at 0 and is increased by $cf::TICK on
110every server tick. 154every server tick.
111 155
112=item $cf::LIBDIR 156=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
157$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
158$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
113 159
114The perl library directory, where extensions and cf-specific modules can 160Various directories - "/etc", read-only install directory, perl-library
115be found. It will be added to C<@INC> automatically. 161directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
162unique-items directory, player file directory, random maps directory and
163database environment.
116 164
117=item $cf::NOW 165=item $cf::NOW
118 166
119The time of the last (current) server tick. 167The time of the last (current) server tick.
120 168
121=item $cf::TICK 169=item $cf::TICK
122 170
123The interval between server ticks, in seconds. 171The interval between server ticks, in seconds.
124 172
173=item $cf::LOADAVG
174
175The current CPU load on the server (alpha-smoothed), as a value between 0
176(none) and 1 (overloaded), indicating how much time is spent on processing
177objects per tick. Healthy values are < 0.5.
178
179=item $cf::LOAD
180
181The raw value load value from the last tick.
182
125=item %cf::CFG 183=item %cf::CFG
126 184
127Configuration for the server, loaded from C</etc/crossfire/config>, or 185Configuration for the server, loaded from C</etc/deliantra-server/config>, or
128from wherever your confdir points to. 186from wherever your confdir points to.
129 187
130=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 188=item cf::wait_for_tick, cf::wait_for_tick_begin
131 189
132These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 190These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
133or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 191returns directly I<after> the tick processing (and consequently, can only wake one process
134processing has been done. Call C<< ->wait >> on them to maximise the 192per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
135window of cpu time available, or simply to synchronise to the server tick. 193
194=item @cf::INVOKE_RESULTS
195
196This array contains the results of the last C<invoke ()> call. When
197C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
198that call.
136 199
137=back 200=back
138 201
139=cut 202=cut
140 203
141BEGIN { 204BEGIN {
142 *CORE::GLOBAL::warn = sub { 205 *CORE::GLOBAL::warn = sub {
143 my $msg = join "", @_; 206 my $msg = join "", @_;
144 utf8::encode $msg;
145 207
146 $msg .= "\n" 208 $msg .= "\n"
147 unless $msg =~ /\n$/; 209 unless $msg =~ /\n$/;
148 210
211 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
212
149 LOG llevError, $msg; 213 LOG llevError, $msg;
150 }; 214 };
151} 215}
216
217$Coro::State::DIEHOOK = sub {
218 return unless $^S eq 0; # "eq", not "=="
219
220 if ($Coro::current == $Coro::main) {#d#
221 warn "DIEHOOK called in main context, Coro bug?\n";#d#
222 return;#d#
223 }#d#
224
225 # kill coroutine otherwise
226 warn Carp::longmess $_[0];
227 Coro::terminate
228};
229
230$SIG{__DIE__} = sub { }; #d#?
152 231
153@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 232@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 233@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 234@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 235@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 236@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
237@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
158@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 238@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
159 239
160# we bless all objects into (empty) derived classes to force a method lookup 240# we bless all objects into (empty) derived classes to force a method lookup
161# within the Safe compartment. 241# within the Safe compartment.
162for my $pkg (qw( 242for my $pkg (qw(
163 cf::global cf::attachable 243 cf::global cf::attachable
168)) { 248)) {
169 no strict 'refs'; 249 no strict 'refs';
170 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 250 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
171} 251}
172 252
173$Event::DIED = sub { 253$EV::DIED = sub {
174 warn "error in event callback: @_"; 254 warn "error in event callback: @_";
175}; 255};
256
257#############################################################################
176 258
177=head2 UTILITY FUNCTIONS 259=head2 UTILITY FUNCTIONS
178 260
179=over 4 261=over 4
180 262
199 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 281 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
200 $d 282 $d
201 } || "[unable to dump $_[0]: '$@']"; 283 } || "[unable to dump $_[0]: '$@']";
202} 284}
203 285
204use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206=item $ref = cf::from_json $json 286=item $ref = cf::decode_json $json
207 287
208Converts a JSON string into the corresponding perl data structure. 288Converts a JSON string into the corresponding perl data structure.
209 289
210=cut
211
212sub from_json($) {
213 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214 JSON::Syck::Load $_[0]
215}
216
217=item $json = cf::to_json $ref 290=item $json = cf::encode_json $ref
218 291
219Converts a perl data structure into its JSON representation. 292Converts a perl data structure into its JSON representation.
220 293
221=cut 294=cut
222 295
223sub to_json($) { 296our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 297
225 JSON::Syck::Dump $_[0] 298sub encode_json($) { $json_coder->encode ($_[0]) }
226} 299sub decode_json($) { $json_coder->decode ($_[0]) }
227 300
228=item cf::lock_wait $string 301=item cf::lock_wait $string
229 302
230Wait until the given lock is available. See cf::lock_acquire. 303Wait until the given lock is available. See cf::lock_acquire.
231 304
234Wait until the given lock is available and then acquires it and returns 307Wait until the given lock is available and then acquires it and returns
235a Coro::guard object. If the guard object gets destroyed (goes out of scope, 308a Coro::guard object. If the guard object gets destroyed (goes out of scope,
236for example when the coroutine gets canceled), the lock is automatically 309for example when the coroutine gets canceled), the lock is automatically
237returned. 310returned.
238 311
312Locks are *not* recursive, locking from the same coro twice results in a
313deadlocked coro.
314
239Lock names should begin with a unique identifier (for example, cf::map::find 315Lock names should begin with a unique identifier (for example, cf::map::find
240uses map_find and cf::map::load uses map_load). 316uses map_find and cf::map::load uses map_load).
241 317
318=item $locked = cf::lock_active $string
319
320Return true if the lock is currently active, i.e. somebody has locked it.
321
242=cut 322=cut
243 323
244our %LOCK; 324our %LOCK;
325our %LOCKER;#d#
245 326
246sub lock_wait($) { 327sub lock_wait($) {
247 my ($key) = @_; 328 my ($key) = @_;
329
330 if ($LOCKER{$key} == $Coro::current) {#d#
331 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
332 return;#d#
333 }#d#
248 334
249 # wait for lock, if any 335 # wait for lock, if any
250 while ($LOCK{$key}) { 336 while ($LOCK{$key}) {
251 push @{ $LOCK{$key} }, $Coro::current; 337 push @{ $LOCK{$key} }, $Coro::current;
252 Coro::schedule; 338 Coro::schedule;
258 344
259 # wait, to be sure we are not locked 345 # wait, to be sure we are not locked
260 lock_wait $key; 346 lock_wait $key;
261 347
262 $LOCK{$key} = []; 348 $LOCK{$key} = [];
349 $LOCKER{$key} = $Coro::current;#d#
263 350
264 Coro::guard { 351 Coro::guard {
352 delete $LOCKER{$key};#d#
265 # wake up all waiters, to be on the safe side 353 # wake up all waiters, to be on the safe side
266 $_->ready for @{ delete $LOCK{$key} }; 354 $_->ready for @{ delete $LOCK{$key} };
267 } 355 }
268} 356}
269 357
358sub lock_active($) {
359 my ($key) = @_;
360
361 ! ! $LOCK{$key}
362}
363
270sub freeze_mainloop { 364sub freeze_mainloop {
271 return unless $TICK_WATCHER->is_active; 365 tick_inhibit_inc;
272 366
273 my $guard = Coro::guard { 367 Coro::guard \&tick_inhibit_dec;
274 $TICK_WATCHER->start; 368}
275 $WRITE_RUNTIME_WATCHER->start; 369
370=item cf::periodic $interval, $cb
371
372Like EV::periodic, but randomly selects a starting point so that the actions
373get spread over timer.
374
375=cut
376
377sub periodic($$) {
378 my ($interval, $cb) = @_;
379
380 my $start = rand List::Util::min 180, $interval;
381
382 EV::periodic $start, $interval, 0, $cb
383}
384
385=item cf::get_slot $time[, $priority[, $name]]
386
387Allocate $time seconds of blocking CPU time at priority C<$priority>:
388This call blocks and returns only when you have at least C<$time> seconds
389of cpu time till the next tick. The slot is only valid till the next cede.
390
391The optional C<$name> can be used to identify the job to run. It might be
392used for statistical purposes and should identify the same time-class.
393
394Useful for short background jobs.
395
396=cut
397
398our @SLOT_QUEUE;
399our $SLOT_QUEUE;
400
401$SLOT_QUEUE->cancel if $SLOT_QUEUE;
402$SLOT_QUEUE = Coro::async {
403 $Coro::current->desc ("timeslot manager");
404
405 my $signal = new Coro::Signal;
406
407 while () {
408 next_job:
409 my $avail = cf::till_tick;
410 if ($avail > 0.01) {
411 for (0 .. $#SLOT_QUEUE) {
412 if ($SLOT_QUEUE[$_][0] < $avail) {
413 my $job = splice @SLOT_QUEUE, $_, 1, ();
414 $job->[2]->send;
415 Coro::cede;
416 goto next_job;
417 }
418 }
419 }
420
421 if (@SLOT_QUEUE) {
422 # we do not use wait_for_tick() as it returns immediately when tick is inactive
423 push @cf::WAIT_FOR_TICK, $signal;
424 $signal->wait;
425 } else {
426 Coro::schedule;
427 }
276 }; 428 }
277 $WRITE_RUNTIME_WATCHER->stop; 429};
278 $TICK_WATCHER->stop; 430
279 $guard 431sub get_slot($;$$) {
432 my ($time, $pri, $name) = @_;
433
434 $time = $TICK * .6 if $time > $TICK * .6;
435 my $sig = new Coro::Signal;
436
437 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
438 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
439 $SLOT_QUEUE->ready;
440 $sig->wait;
280} 441}
281 442
282=item cf::async { BLOCK } 443=item cf::async { BLOCK }
283 444
284Currently the same as Coro::async_pool, meaning you cannot use 445Currently the same as Coro::async_pool, meaning you cannot use
289 450
290BEGIN { *async = \&Coro::async_pool } 451BEGIN { *async = \&Coro::async_pool }
291 452
292=item cf::sync_job { BLOCK } 453=item cf::sync_job { BLOCK }
293 454
294The design of crossfire+ requires that the main coro ($Coro::main) is 455The design of Deliantra requires that the main coroutine ($Coro::main)
295always able to handle events or runnable, as crossfire+ is only partly 456is always able to handle events or runnable, as Deliantra is only
296reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 457partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
458acceptable.
297 459
298If it must be done, put the blocking parts into C<sync_job>. This will run 460If it must be done, put the blocking parts into C<sync_job>. This will run
299the given BLOCK in another coroutine while waiting for the result. The 461the given BLOCK in another coroutine while waiting for the result. The
300server will be frozen during this time, so the block should either finish 462server will be frozen during this time, so the block should either finish
301fast or be very important. 463fast or be very important.
304 466
305sub sync_job(&) { 467sub sync_job(&) {
306 my ($job) = @_; 468 my ($job) = @_;
307 469
308 if ($Coro::current == $Coro::main) { 470 if ($Coro::current == $Coro::main) {
471 my $time = EV::time;
472
309 # this is the main coro, too bad, we have to block 473 # this is the main coro, too bad, we have to block
310 # till the operation succeeds, freezing the server :/ 474 # till the operation succeeds, freezing the server :/
311 475
312 # TODO: use suspend/resume instead 476 LOG llevError, Carp::longmess "sync job";#d#
313 # (but this is cancel-safe) 477
314 my $freeze_guard = freeze_mainloop; 478 my $freeze_guard = freeze_mainloop;
315 479
316 my $busy = 1; 480 my $busy = 1;
317 my @res; 481 my @res;
318 482
319 (async { 483 (async {
484 $Coro::current->desc ("sync job coro");
320 @res = eval { $job->() }; 485 @res = eval { $job->() };
321 warn $@ if $@; 486 warn $@ if $@;
322 undef $busy; 487 undef $busy;
323 })->prio (Coro::PRIO_MAX); 488 })->prio (Coro::PRIO_MAX);
324 489
325 while ($busy) { 490 while ($busy) {
326 Coro::cede or Event::one_event; 491 if (Coro::nready) {
492 Coro::cede_notself;
493 } else {
494 EV::loop EV::LOOP_ONESHOT;
327 } 495 }
496 }
497
498 my $time = EV::time - $time;
499
500 $TICK_START += $time; # do not account sync jobs to server load
328 501
329 wantarray ? @res : $res[0] 502 wantarray ? @res : $res[0]
330 } else { 503 } else {
331 # we are in another coroutine, how wonderful, everything just works 504 # we are in another coroutine, how wonderful, everything just works
332 505
352 $EXT_CORO{$coro+0} = $coro; 525 $EXT_CORO{$coro+0} = $coro;
353 526
354 $coro 527 $coro
355} 528}
356 529
357sub write_runtime { 530=item fork_call { }, $args
358 my $runtime = cf::localdir . "/runtime";
359 531
360 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 532Executes the given code block with the given arguments in a seperate
361 or return; 533process, returning the results. Everything must be serialisable with
534Coro::Storable. May, of course, block. Note that the executed sub may
535never block itself or use any form of event handling.
362 536
363 my $value = $cf::RUNTIME + 90 + 10; 537=cut
364 # 10 is the runtime save interval, for a monotonic clock
365 # 60 allows for the watchdog to kill the server.
366 538
367 (aio_write $fh, 0, (length $value), $value, 0) <= 0 539sub fork_call(&@) {
368 and return; 540 my ($cb, @args) = @_;
369 541
370 # always fsync - this file is important 542 # we seemingly have to make a local copy of the whole thing,
371 aio_fsync $fh 543 # otherwise perl prematurely frees the stuff :/
372 and return; 544 # TODO: investigate and fix (likely this will be rather laborious)
373 545
374 close $fh 546 my @res = Coro::Util::fork_eval {
375 or return; 547 reset_signals;
548 &$cb
549 }, @args;
376 550
377 aio_rename "$runtime~", $runtime 551 wantarray ? @res : $res[-1]
378 and return; 552}
379 553
554=item $coin = coin_from_name $name
555
556=cut
557
558our %coin_alias = (
559 "silver" => "silvercoin",
560 "silvercoin" => "silvercoin",
561 "silvercoins" => "silvercoin",
562 "gold" => "goldcoin",
563 "goldcoin" => "goldcoin",
564 "goldcoins" => "goldcoin",
565 "platinum" => "platinacoin",
566 "platinumcoin" => "platinacoin",
567 "platinumcoins" => "platinacoin",
568 "platina" => "platinacoin",
569 "platinacoin" => "platinacoin",
570 "platinacoins" => "platinacoin",
571 "royalty" => "royalty",
572 "royalties" => "royalty",
573);
574
575sub coin_from_name($) {
576 $coin_alias{$_[0]}
577 ? cf::arch::find $coin_alias{$_[0]}
578 : undef
579}
580
581=item $value = cf::db_get $family => $key
582
583Returns a single value from the environment database.
584
585=item cf::db_put $family => $key => $value
586
587Stores the given C<$value> in the family. It can currently store binary
588data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
589
590=item $db = cf::db_table "name"
591
592Create and/or open a new database table. The string must not be "db" and must be unique
593within each server.
594
595=cut
596
597sub db_table($) {
598 my ($name) = @_;
599 my $db = BDB::db_create $DB_ENV;
600
601 eval {
602 $db->set_flags (BDB::CHKSUM);
603
604 utf8::encode $name;
605 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
606 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
607 cf::cleanup "db_open(db): $!" if $!;
608 };
609 cf::cleanup "db_open(db): $@" if $@;
610
611 $db
612}
613
614our $DB;
615
616sub db_init {
617 cf::sync_job {
618 $DB ||= db_table "db";
619 };
620}
621
622sub db_get($$) {
623 my $key = "$_[0]/$_[1]";
624
625 cf::sync_job {
626 BDB::db_get $DB, undef, $key, my $data;
627
628 $! ? ()
629 : $data
380 1 630 }
631}
632
633sub db_put($$$) {
634 BDB::dbreq_pri 4;
635 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
636}
637
638=item cf::cache $id => [$paths...], $processversion => $process
639
640Generic caching function that returns the value of the resource $id,
641caching and regenerating as required.
642
643This function can block.
644
645=cut
646
647sub cache {
648 my ($id, $src, $processversion, $process) = @_;
649
650 my $meta =
651 join "\x00",
652 $processversion,
653 map {
654 aio_stat $_
655 and Carp::croak "$_: $!";
656
657 ($_, (stat _)[7,9])
658 } @$src;
659
660 my $dbmeta = db_get cache => "$id/meta";
661 if ($dbmeta ne $meta) {
662 # changed, we may need to process
663
664 my @data;
665 my $md5;
666
667 for (0 .. $#$src) {
668 0 <= aio_load $src->[$_], $data[$_]
669 or Carp::croak "$src->[$_]: $!";
670 }
671
672 # if processing is expensive, check
673 # checksum first
674 if (1) {
675 $md5 =
676 join "\x00",
677 $processversion,
678 map {
679 cf::cede_to_tick;
680 ($src->[$_], Digest::MD5::md5_hex $data[$_])
681 } 0.. $#$src;
682
683
684 my $dbmd5 = db_get cache => "$id/md5";
685 if ($dbmd5 eq $md5) {
686 db_put cache => "$id/meta", $meta;
687
688 return db_get cache => "$id/data";
689 }
690 }
691
692 my $t1 = Time::HiRes::time;
693 my $data = $process->(\@data);
694 my $t2 = Time::HiRes::time;
695
696 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
697
698 db_put cache => "$id/data", $data;
699 db_put cache => "$id/md5" , $md5;
700 db_put cache => "$id/meta", $meta;
701
702 return $data;
703 }
704
705 db_get cache => "$id/data"
706}
707
708=item cf::datalog type => key => value, ...
709
710Log a datalog packet of the given type with the given key-value pairs.
711
712=cut
713
714sub datalog($@) {
715 my ($type, %kv) = @_;
716 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
381} 717}
382 718
383=back 719=back
384 720
385=cut 721=cut
392attach callbacks/event handlers (a collection of which is called an "attachment") 728attach callbacks/event handlers (a collection of which is called an "attachment")
393to it. All such attachable objects support the following methods. 729to it. All such attachable objects support the following methods.
394 730
395In the following description, CLASS can be any of C<global>, C<object> 731In the following description, CLASS can be any of C<global>, C<object>
396C<player>, C<client> or C<map> (i.e. the attachable objects in 732C<player>, C<client> or C<map> (i.e. the attachable objects in
397crossfire+). 733Deliantra).
398 734
399=over 4 735=over 4
400 736
401=item $attachable->attach ($attachment, key => $value...) 737=item $attachable->attach ($attachment, key => $value...)
402 738
565 $registry = $CB_TYPE[$object_type] ||= []; 901 $registry = $CB_TYPE[$object_type] ||= [];
566 902
567 } elsif ($type eq "subtype") { 903 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type"; 904 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg; 905 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 906 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571 907
572 } elsif ($type eq "package") { 908 } elsif ($type eq "package") {
573 my $pkg = shift @arg; 909 my $pkg = shift @arg;
574 910
575 while (my ($name, $id) = each %cb_id) { 911 while (my ($name, $id) = each %cb_id) {
604 _attach $registry, $klass, @attach; 940 _attach $registry, $klass, @attach;
605 } 941 }
606 942
607 $obj->{$name} = \%arg; 943 $obj->{$name} = \%arg;
608 } else { 944 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n"; 945 warn "object uses attachment '$name' which is not available, postponing.\n";
610 } 946 }
611 947
612 $obj->{_attachment}{$name} = undef; 948 $obj->{_attachment}{$name} = undef;
613} 949}
614 950
616 if (ref $_[0]) { 952 if (ref $_[0]) {
617 _object_attach @_; 953 _object_attach @_;
618 } else { 954 } else {
619 _attach shift->_attach_registry, @_; 955 _attach shift->_attach_registry, @_;
620 } 956 }
957 _recalc_want;
621}; 958};
622 959
623# all those should be optimised 960# all those should be optimised
624sub cf::attachable::detach { 961sub cf::attachable::detach {
625 my ($obj, $name) = @_; 962 my ($obj, $name) = @_;
628 delete $obj->{_attachment}{$name}; 965 delete $obj->{_attachment}{$name};
629 reattach ($obj); 966 reattach ($obj);
630 } else { 967 } else {
631 Carp::croak "cannot, currently, detach class attachments"; 968 Carp::croak "cannot, currently, detach class attachments";
632 } 969 }
970 _recalc_want;
633}; 971};
634 972
635sub cf::attachable::attached { 973sub cf::attachable::attached {
636 my ($obj, $name) = @_; 974 my ($obj, $name) = @_;
637 975
652 "; 990 ";
653 die if $@; 991 die if $@;
654} 992}
655 993
656our $override; 994our $override;
657our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 995our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
658 996
659sub override { 997sub override {
660 $override = 1; 998 $override = 1;
661 @invoke_results = (); 999 @INVOKE_RESULTS = (@_);
662} 1000}
663 1001
664sub do_invoke { 1002sub do_invoke {
665 my $event = shift; 1003 my $event = shift;
666 my $callbacks = shift; 1004 my $callbacks = shift;
667 1005
668 @invoke_results = (); 1006 @INVOKE_RESULTS = ();
669 1007
670 local $override; 1008 local $override;
671 1009
672 for (@$callbacks) { 1010 for (@$callbacks) {
673 eval { &{$_->[1]} }; 1011 eval { &{$_->[1]} };
682 } 1020 }
683 1021
684 0 1022 0
685} 1023}
686 1024
687=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1025=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688 1026
689=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1027=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690 1028
691Generate an object-specific event with the given arguments. 1029Generate an object-specific event with the given arguments.
692 1030
693This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 1031This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
694removed in future versions), and there is no public API to access override 1032removed in future versions), and there is no public API to access override
695results (if you must, access C<@cf::invoke_results> directly). 1033results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696 1034
697=back 1035=back
698 1036
699=cut 1037=cut
700 1038
701############################################################################# 1039#############################################################################
702# object support 1040# object support
1041
1042sub _object_equal($$);
1043sub _object_equal($$) {
1044 my ($a, $b) = @_;
1045
1046 return 0 unless (ref $a) eq (ref $b);
1047
1048 if ("HASH" eq ref $a) {
1049 my @ka = keys %$a;
1050 my @kb = keys %$b;
1051
1052 return 0 if @ka != @kb;
1053
1054 for (0 .. $#ka) {
1055 return 0 unless $ka[$_] eq $kb[$_];
1056 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1057 }
1058
1059 } elsif ("ARRAY" eq ref $a) {
1060
1061 return 0 if @$a != @$b;
1062
1063 for (0 .. $#$a) {
1064 return 0 unless _object_equal $a->[$_], $b->[$_];
1065 }
1066
1067 } elsif ($a ne $b) {
1068 return 0;
1069 }
1070
1071 1
1072}
1073
1074our $SLOW_MERGES;#d#
1075sub _can_merge {
1076 my ($ob1, $ob2) = @_;
1077
1078 ++$SLOW_MERGES;#d#
1079
1080 # we do the slow way here
1081 return _object_equal $ob1, $ob2
1082}
703 1083
704sub reattach { 1084sub reattach {
705 # basically do the same as instantiate, without calling instantiate 1085 # basically do the same as instantiate, without calling instantiate
706 my ($obj) = @_; 1086 my ($obj) = @_;
707 1087
728cf::attachable->attach ( 1108cf::attachable->attach (
729 prio => -1000000, 1109 prio => -1000000,
730 on_instantiate => sub { 1110 on_instantiate => sub {
731 my ($obj, $data) = @_; 1111 my ($obj, $data) = @_;
732 1112
733 $data = from_json $data; 1113 $data = decode_json $data;
734 1114
735 for (@$data) { 1115 for (@$data) {
736 my ($name, $args) = @$_; 1116 my ($name, $args) = @$_;
737 1117
738 $obj->attach ($name, %{$args || {} }); 1118 $obj->attach ($name, %{$args || {} });
754sub object_freezer_save { 1134sub object_freezer_save {
755 my ($filename, $rdata, $objs) = @_; 1135 my ($filename, $rdata, $objs) = @_;
756 1136
757 sync_job { 1137 sync_job {
758 if (length $$rdata) { 1138 if (length $$rdata) {
1139 utf8::decode (my $decname = $filename);
759 warn sprintf "saving %s (%d,%d)\n", 1140 warn sprintf "saving %s (%d,%d)\n",
760 $filename, length $$rdata, scalar @$objs; 1141 $decname, length $$rdata, scalar @$objs;
761 1142
762 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1143 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
763 chmod SAVE_MODE, $fh; 1144 chmod SAVE_MODE, $fh;
764 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1145 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
765 aio_fsync $fh if $cf::USE_FSYNC; 1146 aio_fsync $fh if $cf::USE_FSYNC;
766 close $fh; 1147 close $fh;
767 1148
768 if (@$objs) { 1149 if (@$objs) {
769 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1150 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
770 chmod SAVE_MODE, $fh; 1151 chmod SAVE_MODE, $fh;
771 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1152 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
772 aio_write $fh, 0, (length $data), $data, 0; 1153 aio_write $fh, 0, (length $data), $data, 0;
773 aio_fsync $fh if $cf::USE_FSYNC; 1154 aio_fsync $fh if $cf::USE_FSYNC;
774 close $fh; 1155 close $fh;
775 aio_rename "$filename.pst~", "$filename.pst"; 1156 aio_rename "$filename.pst~", "$filename.pst";
776 } 1157 }
784 } 1165 }
785 } else { 1166 } else {
786 aio_unlink $filename; 1167 aio_unlink $filename;
787 aio_unlink "$filename.pst"; 1168 aio_unlink "$filename.pst";
788 } 1169 }
789
790 #d##TODO# nuke non .map-files if exist
791 if ($filename =~ s/\.map$//) {
792 aio_unlink $filename;
793 aio_unlink "$filename.pst";
794 }
795 } 1170 };
796} 1171}
797 1172
798sub object_freezer_as_string { 1173sub object_freezer_as_string {
799 my ($rdata, $objs) = @_; 1174 my ($rdata, $objs) = @_;
800 1175
805 1180
806sub object_thawer_load { 1181sub object_thawer_load {
807 my ($filename) = @_; 1182 my ($filename) = @_;
808 1183
809 my ($data, $av); 1184 my ($data, $av);
810
811 #d#TODO remove .map if file does not exist
812 aio_stat $filename and $filename =~ s/\.map$//;
813 1185
814 (aio_load $filename, $data) >= 0 1186 (aio_load $filename, $data) >= 0
815 or return; 1187 or return;
816 1188
817 unless (aio_stat "$filename.pst") { 1189 unless (aio_stat "$filename.pst") {
818 (aio_load "$filename.pst", $av) >= 0 1190 (aio_load "$filename.pst", $av) >= 0
819 or return; 1191 or return;
1192
820 $av = eval { (Storable::thaw $av)->{objs} }; 1193 my $st = eval { Coro::Storable::thaw $av };
1194 $av = $st->{objs};
821 } 1195 }
822 1196
1197 utf8::decode (my $decname = $filename);
823 warn sprintf "loading %s (%d)\n", 1198 warn sprintf "loading %s (%d,%d)\n",
824 $filename, length $data, scalar @{$av || []};#d# 1199 $decname, length $data, scalar @{$av || []};
1200
825 return ($data, $av); 1201 ($data, $av)
826} 1202}
1203
1204=head2 COMMAND CALLBACKS
1205
1206=over 4
1207
1208=cut
827 1209
828############################################################################# 1210#############################################################################
829# command handling &c 1211# command handling &c
830 1212
831=item cf::register_command $name => \&callback($ob,$args); 1213=item cf::register_command $name => \&callback($ob,$args);
844 push @{ $COMMAND{$name} }, [$caller, $cb]; 1226 push @{ $COMMAND{$name} }, [$caller, $cb];
845} 1227}
846 1228
847=item cf::register_extcmd $name => \&callback($pl,$packet); 1229=item cf::register_extcmd $name => \&callback($pl,$packet);
848 1230
849Register a callbackf ro execution when the client sends an extcmd packet. 1231Register a callback for execution when the client sends an (synchronous)
1232extcmd packet. Ext commands will be processed in the order they are
1233received by the server, like other user commands. The first argument is
1234the logged-in player. Ext commands can only be processed after a player
1235has logged in successfully.
850 1236
851If the callback returns something, it is sent back as if reply was being 1237If the callback returns something, it is sent back as if reply was being
852called. 1238called.
853 1239
1240=item cf::register_exticmd $name => \&callback($ns,$packet);
1241
1242Register a callback for execution when the client sends an (asynchronous)
1243exticmd packet. Exti commands are processed by the server as soon as they
1244are received, i.e. out of order w.r.t. other commands. The first argument
1245is a client socket. Exti commands can be received anytime, even before
1246log-in.
1247
1248If the callback returns something, it is sent back as if reply was being
1249called.
1250
854=cut 1251=cut
855 1252
856sub register_extcmd { 1253sub register_extcmd {
857 my ($name, $cb) = @_; 1254 my ($name, $cb) = @_;
858 1255
859 $EXTCMD{$name} = $cb; 1256 $EXTCMD{$name} = $cb;
1257}
1258
1259sub register_exticmd {
1260 my ($name, $cb) = @_;
1261
1262 $EXTICMD{$name} = $cb;
860} 1263}
861 1264
862cf::player->attach ( 1265cf::player->attach (
863 on_command => sub { 1266 on_command => sub {
864 my ($pl, $name, $params) = @_; 1267 my ($pl, $name, $params) = @_;
873 cf::override; 1276 cf::override;
874 }, 1277 },
875 on_extcmd => sub { 1278 on_extcmd => sub {
876 my ($pl, $buf) = @_; 1279 my ($pl, $buf) = @_;
877 1280
878 my $msg = eval { from_json $buf }; 1281 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879 1282
880 if (ref $msg) { 1283 if (ref $msg) {
1284 my ($type, $reply, @payload) =
1285 "ARRAY" eq ref $msg
1286 ? @$msg
1287 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1288
1289 my @reply;
1290
881 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1291 if (my $cb = $EXTCMD{$type}) {
882 if (my %reply = $cb->($pl, $msg)) { 1292 @reply = $cb->($pl, @payload);
883 $pl->ext_reply ($msg->{msgid}, %reply);
884 }
885 } 1293 }
1294
1295 $pl->ext_reply ($reply, @reply)
1296 if $reply;
1297
886 } else { 1298 } else {
887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1299 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888 } 1300 }
889 1301
890 cf::override; 1302 cf::override;
891 }, 1303 },
892); 1304);
893 1305
894sub load_extension {
895 my ($path) = @_;
896
897 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
898 my $base = $1;
899 my $pkg = $1;
900 $pkg =~ s/[^[:word:]]/_/g;
901 $pkg = "ext::$pkg";
902
903 warn "... loading '$path' into '$pkg'\n";
904
905 open my $fh, "<:utf8", $path
906 or die "$path: $!";
907
908 my $source =
909 "package $pkg; use strict; use utf8;\n"
910 . "#line 1 \"$path\"\n{\n"
911 . (do { local $/; <$fh> })
912 . "\n};\n1";
913
914 unless (eval $source) {
915 my $msg = $@ ? "$path: $@\n"
916 : "extension disabled.\n";
917 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918 warn $@;
919 warn "mandatory extension failed to load, exiting.\n";
920 exit 1;
921 }
922 die $@;
923 }
924
925 push @EXTS, $pkg;
926}
927
928sub load_extensions { 1306sub load_extensions {
1307 cf::sync_job {
1308 my %todo;
1309
929 for my $ext (<$LIBDIR/*.ext>) { 1310 for my $path (<$LIBDIR/*.ext>) {
930 next unless -r $ext; 1311 next unless -r $path;
931 eval { 1312
932 load_extension $ext; 1313 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1314 my $base = $1;
1315 my $pkg = $1;
1316 $pkg =~ s/[^[:word:]]/_/g;
1317 $pkg = "ext::$pkg";
1318
1319 open my $fh, "<:utf8", $path
1320 or die "$path: $!";
1321
1322 my $source = do { local $/; <$fh> };
1323
1324 my %ext = (
1325 path => $path,
1326 base => $base,
1327 pkg => $pkg,
1328 );
1329
1330 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1331 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1332
1333 $ext{source} =
1334 "package $pkg; use strict; use utf8;\n"
1335 . "#line 1 \"$path\"\n{\n"
1336 . $source
1337 . "\n};\n1";
1338
1339 $todo{$base} = \%ext;
1340 }
1341
1342 my %done;
1343 while (%todo) {
1344 my $progress;
1345
1346 while (my ($k, $v) = each %todo) {
1347 for (split /,\s*/, $v->{meta}{depends}) {
1348 goto skip
1349 unless exists $done{$_};
1350 }
1351
1352 warn "... loading '$k' into '$v->{pkg}'\n";
1353
1354 unless (eval $v->{source}) {
1355 my $msg = $@ ? "$v->{path}: $@\n"
1356 : "$v->{base}: extension inactive.\n";
1357
1358 if (exists $v->{meta}{mandatory}) {
1359 warn $msg;
1360 cf::cleanup "mandatory extension failed to load, exiting.";
1361 }
1362
1363 warn $msg;
1364 }
1365
1366 $done{$k} = delete $todo{$k};
1367 push @EXTS, $v->{pkg};
1368 $progress = 1;
933 1 1369 }
934 } or warn "$ext not loaded: $@"; 1370
1371 skip:
1372 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1373 unless $progress;
1374 }
935 } 1375 };
936} 1376}
937 1377
938############################################################################# 1378#############################################################################
939 1379
1380=back
1381
940=head2 CORE EXTENSIONS 1382=head2 CORE EXTENSIONS
941 1383
942Functions and methods that extend core crossfire objects. 1384Functions and methods that extend core crossfire objects.
943 1385
944=cut 1386=cut
949 1391
950=head3 cf::player 1392=head3 cf::player
951 1393
952=over 4 1394=over 4
953 1395
1396=item cf::player::num_playing
1397
1398Returns the official number of playing players, as per the Crossfire metaserver rules.
1399
1400=cut
1401
1402sub num_playing {
1403 scalar grep
1404 $_->ob->map
1405 && !$_->hidden
1406 && !$_->ob->flag (cf::FLAG_WIZ),
1407 cf::player::list
1408}
1409
954=item cf::player::find $login 1410=item cf::player::find $login
955 1411
956Returns the given player object, loading it if necessary (might block). 1412Returns the given player object, loading it if necessary (might block).
957 1413
958=cut 1414=cut
959 1415
960sub playerdir($) { 1416sub playerdir($) {
961 cf::localdir 1417 "$PLAYERDIR/"
962 . "/"
963 . cf::playerdir
964 . "/"
965 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1418 . (ref $_[0] ? $_[0]->ob->name : $_[0])
966} 1419}
967 1420
968sub path($) { 1421sub path($) {
969 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1422 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970 1423
971 (playerdir $login) . "/$login.pl" 1424 (playerdir $login) . "/playerdata"
972} 1425}
973 1426
974sub find_active($) { 1427sub find_active($) {
975 $cf::PLAYER{$_[0]} 1428 $cf::PLAYER{$_[0]}
976 and $cf::PLAYER{$_[0]}->active 1429 and $cf::PLAYER{$_[0]}->active
989 my $login = $_[0]; 1442 my $login = $_[0];
990 1443
991 my $guard = cf::lock_acquire "user_find:$login"; 1444 my $guard = cf::lock_acquire "user_find:$login";
992 1445
993 $cf::PLAYER{$_[0]} || do { 1446 $cf::PLAYER{$_[0]} || do {
994 my $pl = load_pl path $login 1447 # rename old playerfiles to new ones
1448 #TODO: remove when no longer required
1449 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1450 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1451 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1452 aio_unlink +(playerdir $login) . "/$login.pl";
1453
1454 my $f = new_from_file cf::object::thawer path $login
995 or return; 1455 or return;
1456
1457 my $pl = cf::player::load_pl $f
1458 or return;
1459 local $cf::PLAYER_LOADING{$login} = $pl;
1460 $f->resolve_delayed_derefs;
996 $cf::PLAYER{$login} = $pl 1461 $cf::PLAYER{$login} = $pl
997 } 1462 }
998 } 1463 }
999} 1464}
1000 1465
1010 1475
1011 aio_mkdir playerdir $pl, 0770; 1476 aio_mkdir playerdir $pl, 0770;
1012 $pl->{last_save} = $cf::RUNTIME; 1477 $pl->{last_save} = $cf::RUNTIME;
1013 1478
1014 $pl->save_pl ($path); 1479 $pl->save_pl ($path);
1015 Coro::cede; 1480 cf::cede_to_tick;
1016} 1481}
1017 1482
1018sub new($) { 1483sub new($) {
1019 my ($login) = @_; 1484 my ($login) = @_;
1020 1485
1026 $cf::PLAYER{$login} = $self; 1491 $cf::PLAYER{$login} = $self;
1027 1492
1028 $self 1493 $self
1029} 1494}
1030 1495
1496=item $player->send_msg ($channel, $msg, $color, [extra...])
1497
1498=cut
1499
1500sub send_msg {
1501 my $ns = shift->ns
1502 or return;
1503 $ns->send_msg (@_);
1504}
1505
1031=item $pl->quit_character 1506=item $pl->quit_character
1032 1507
1033Nukes the player without looking back. If logged in, the connection will 1508Nukes the player without looking back. If logged in, the connection will
1034be destroyed. May block for a long time. 1509be destroyed. May block for a long time.
1035 1510
1036=cut 1511=cut
1037 1512
1038sub quit_character { 1513sub quit_character {
1039 my ($pl) = @_; 1514 my ($pl) = @_;
1515
1516 my $name = $pl->ob->name;
1040 1517
1041 $pl->{deny_save} = 1; 1518 $pl->{deny_save} = 1;
1042 $pl->password ("*"); # this should lock out the player until we nuked the dir 1519 $pl->password ("*"); # this should lock out the player until we nuked the dir
1043 1520
1044 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1521 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1049 my $path = playerdir $pl; 1526 my $path = playerdir $pl;
1050 my $temp = "$path~$cf::RUNTIME~deleting~"; 1527 my $temp = "$path~$cf::RUNTIME~deleting~";
1051 aio_rename $path, $temp; 1528 aio_rename $path, $temp;
1052 delete $cf::PLAYER{$pl->ob->name}; 1529 delete $cf::PLAYER{$pl->ob->name};
1053 $pl->destroy; 1530 $pl->destroy;
1531
1532 my $prefix = qr<^~\Q$name\E/>;
1533
1534 # nuke player maps
1535 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1536
1054 IO::AIO::aio_rmtree $temp; 1537 IO::AIO::aio_rmtree $temp;
1538}
1539
1540=item $pl->kick
1541
1542Kicks a player out of the game. This destroys the connection.
1543
1544=cut
1545
1546sub kick {
1547 my ($pl, $kicker) = @_;
1548
1549 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1550 $pl->killer ("kicked");
1551 $pl->ns->destroy;
1055} 1552}
1056 1553
1057=item cf::player::list_logins 1554=item cf::player::list_logins
1058 1555
1059Returns am arrayref of all valid playernames in the system, can take a 1556Returns am arrayref of all valid playernames in the system, can take a
1060while and may block, so not sync_job-capable, ever. 1557while and may block, so not sync_job-capable, ever.
1061 1558
1062=cut 1559=cut
1063 1560
1064sub list_logins { 1561sub list_logins {
1065 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1562 my $dirs = aio_readdir $PLAYERDIR
1066 or return []; 1563 or return [];
1067 1564
1068 my @logins; 1565 my @logins;
1069 1566
1070 for my $login (@$dirs) { 1567 for my $login (@$dirs) {
1568 my $path = path $login;
1569
1570 # a .pst is a dead give-away for a valid player
1571 unless (-e "$path.pst") {
1071 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1572 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1072 aio_read $fh, 0, 512, my $buf, 0 or next; 1573 aio_read $fh, 0, 512, my $buf, 0 or next;
1073 $buf !~ /^password -------------$/m or next; # official not-valid tag 1574 $buf !~ /^password -------------$/m or next; # official not-valid tag
1575 }
1074 1576
1075 utf8::decode $login; 1577 utf8::decode $login;
1076 push @logins, $login; 1578 push @logins, $login;
1077 } 1579 }
1078 1580
1105 } 1607 }
1106 1608
1107 \@paths 1609 \@paths
1108} 1610}
1109 1611
1612=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1613
1614Expand crossfire pod fragments into protocol xml.
1615
1616=cut
1617
1618use re 'eval';
1619
1620my $group;
1621my $interior; $interior = qr{
1622 # match a pod interior sequence sans C<< >>
1623 (?:
1624 \ (.*?)\ (?{ $group = $^N })
1625 | < (??{$interior}) >
1626 )
1627}x;
1628
1629sub expand_cfpod {
1630 my ($self, $pod) = @_;
1631
1632 my $xml;
1633
1634 while () {
1635 if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
1636 $group = $1;
1637
1638 $group =~ s/&/&amp;/g;
1639 $group =~ s/</&lt;/g;
1640
1641 $xml .= $group;
1642 } elsif ($pod =~ m%\G
1643 ([BCGHITU])
1644 <
1645 (?:
1646 ([^<>]*) (?{ $group = $^N })
1647 | < $interior >
1648 )
1649 >
1650 %gcsx
1651 ) {
1652 my ($code, $data) = ($1, $group);
1653
1654 if ($code eq "B") {
1655 $xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
1656 } elsif ($code eq "I") {
1657 $xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
1658 } elsif ($code eq "U") {
1659 $xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
1660 } elsif ($code eq "C") {
1661 $xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
1662 } elsif ($code eq "T") {
1663 $xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
1664 } elsif ($code eq "G") {
1665 my ($male, $female) = split /\|/, $data;
1666 $data = $self->gender ? $female : $male;
1667 $xml .= expand_cfpod ($self, $data);
1668 } elsif ($code eq "H") {
1669 $xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
1670 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1671 "")
1672 [$self->{hintmode}];
1673 } else {
1674 $xml .= "error processing '$code($data)' directive";
1675 }
1676 } else {
1677 if ($pod =~ /\G(.+)/) {
1678 warn "parse error while expanding $pod (at $1)";
1679 }
1680 last;
1681 }
1682 }
1683
1684 for ($xml) {
1685 # create single paragraphs (very hackish)
1686 s/(?<=\S)\n(?=\w)/ /g;
1687
1688 # compress some whitespace
1689 s/\s+\n/\n/g; # ws line-ends
1690 s/\n\n+/\n/g; # double lines
1691 s/^\n+//; # beginning lines
1692 s/\n+$//; # ending lines
1693 }
1694
1695 $xml
1696}
1697
1698no re 'eval';
1699
1700sub hintmode {
1701 $_[0]{hintmode} = $_[1] if @_ > 1;
1702 $_[0]{hintmode}
1703}
1704
1110=item $player->ext_reply ($msgid, $msgtype, %msg) 1705=item $player->ext_reply ($msgid, @msg)
1111 1706
1112Sends an ext reply to the player. 1707Sends an ext reply to the player.
1113 1708
1114=cut 1709=cut
1115 1710
1116sub ext_reply($$$%) { 1711sub ext_reply($$@) {
1117 my ($self, $id, %msg) = @_; 1712 my ($self, $id, @msg) = @_;
1118 1713
1119 $msg{msgid} = $id; 1714 $self->ns->ext_reply ($id, @msg)
1120
1121 $self->send ("ext " . cf::to_json \%msg);
1122} 1715}
1123 1716
1124package cf; 1717=item $player->ext_msg ($type, @msg)
1718
1719Sends an ext event to the client.
1720
1721=cut
1722
1723sub ext_msg($$@) {
1724 my ($self, $type, @msg) = @_;
1725
1726 $self->ns->ext_msg ($type, @msg);
1727}
1728
1729=head3 cf::region
1730
1731=over 4
1732
1733=cut
1734
1735package cf::region;
1736
1737=item cf::region::find_by_path $path
1738
1739Tries to decuce the likely region for a map knowing only its path.
1740
1741=cut
1742
1743sub find_by_path($) {
1744 my ($path) = @_;
1745
1746 my ($match, $specificity);
1747
1748 for my $region (list) {
1749 if ($region->{match} && $path =~ $region->{match}) {
1750 ($match, $specificity) = ($region, $region->specificity)
1751 if $region->specificity > $specificity;
1752 }
1753 }
1754
1755 $match
1756}
1125 1757
1126=back 1758=back
1127
1128 1759
1129=head3 cf::map 1760=head3 cf::map
1130 1761
1131=over 4 1762=over 4
1132 1763
1144our $MAX_RESET = 3600; 1775our $MAX_RESET = 3600;
1145our $DEFAULT_RESET = 3000; 1776our $DEFAULT_RESET = 3000;
1146 1777
1147sub generate_random_map { 1778sub generate_random_map {
1148 my ($self, $rmp) = @_; 1779 my ($self, $rmp) = @_;
1780
1781 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1782
1149 # mit "rum" bekleckern, nicht 1783 # mit "rum" bekleckern, nicht
1150 $self->_create_random_map ( 1784 $self->_create_random_map (
1151 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1785 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1786 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1787 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1187 my ($self, $merge) = @_; 1821 my ($self, $merge) = @_;
1188 1822
1189 # we have to keep some variables in memory intact 1823 # we have to keep some variables in memory intact
1190 local $self->{path}; 1824 local $self->{path};
1191 local $self->{load_path}; 1825 local $self->{load_path};
1192 local $self->{deny_save};
1193 local $self->{deny_reset};
1194 1826
1195 $self->SUPER::thawer_merge ($merge); 1827 $self->SUPER::thawer_merge ($merge);
1196} 1828}
1197 1829
1198sub normalise { 1830sub normalise {
1245 $self->init; # pass $1 etc. 1877 $self->init; # pass $1 etc.
1246 return $self; 1878 return $self;
1247 } 1879 }
1248 } 1880 }
1249 1881
1250 Carp::carp "unable to resolve path '$path' (base '$base')."; 1882 Carp::cluck "unable to resolve path '$path' (base '$base').";
1251 () 1883 ()
1252} 1884}
1253 1885
1254sub init { 1886sub init {
1255 my ($self) = @_; 1887 my ($self) = @_;
1270 1902
1271# the original (read-only) location 1903# the original (read-only) location
1272sub load_path { 1904sub load_path {
1273 my ($self) = @_; 1905 my ($self) = @_;
1274 1906
1275 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1907 "$MAPDIR/$self->{path}.map"
1276} 1908}
1277 1909
1278# the temporary/swap location 1910# the temporary/swap location
1279sub save_path { 1911sub save_path {
1280 my ($self) = @_; 1912 my ($self) = @_;
1281 1913
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1914 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1283 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1915 "$TMPDIR/$path.map"
1284} 1916}
1285 1917
1286# the unique path, undef == no special unique path 1918# the unique path, undef == no special unique path
1287sub uniq_path { 1919sub uniq_path {
1288 my ($self) = @_; 1920 my ($self) = @_;
1289 1921
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1922 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1291 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1923 "$UNIQUEDIR/$path"
1292} 1924}
1293 1925
1294# and all this just because we cannot iterate over 1926# and all this just because we cannot iterate over
1295# all maps in C++... 1927# all maps in C++...
1296sub change_all_map_light { 1928sub change_all_map_light {
1298 1930
1299 $_->change_map_light ($change) 1931 $_->change_map_light ($change)
1300 for grep $_->outdoor, values %cf::MAP; 1932 for grep $_->outdoor, values %cf::MAP;
1301} 1933}
1302 1934
1935sub decay_objects {
1936 my ($self) = @_;
1937
1938 return if $self->{deny_reset};
1939
1940 $self->do_decay_objects;
1941}
1942
1303sub unlink_save { 1943sub unlink_save {
1304 my ($self) = @_; 1944 my ($self) = @_;
1305 1945
1306 utf8::encode (my $save = $self->save_path); 1946 utf8::encode (my $save = $self->save_path);
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1947 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1948 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310 #d#TODO remove .map and also nuke
1311 $save =~ s/\.map// or return;#d#
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314} 1949}
1315 1950
1316sub load_header_from($) { 1951sub load_header_from($) {
1317 my ($self, $path) = @_; 1952 my ($self, $path) = @_;
1318 1953
1319 utf8::encode $path; 1954 utf8::encode $path;
1320 #aio_open $path, O_RDONLY, 0 1955 my $f = new_from_file cf::object::thawer $path
1321 # or return;
1322
1323 $self->_load_header ($path)
1324 or return; 1956 or return;
1957
1958 $self->_load_header ($f)
1959 or return;
1960
1961 local $MAP_LOADING{$self->{path}} = $self;
1962 $f->resolve_delayed_derefs;
1325 1963
1326 $self->{load_path} = $path; 1964 $self->{load_path} = $path;
1327 1965
1328 1 1966 1
1329} 1967}
1368 $self->load_header_orig 2006 $self->load_header_orig
1369 or return; 2007 or return;
1370 $self->prepare_orig; 2008 $self->prepare_orig;
1371 } 2009 }
1372 2010
2011 $self->{deny_reset} = 1
2012 if $self->no_reset;
2013
2014 $self->default_region (cf::region::find_by_path $self->{path})
2015 unless $self->default_region;
2016
1373 1 2017 1
1374} 2018}
1375 2019
1376sub find; 2020sub find;
1377sub find { 2021sub find {
1378 my ($path, $origin) = @_; 2022 my ($path, $origin) = @_;
1379 2023
1380 $path = normalise $path, $origin && $origin->path; 2024 $path = normalise $path, $origin && $origin->path;
1381 2025
2026 cf::lock_wait "map_data:$path";#d#remove
1382 cf::lock_wait "map_find:$path"; 2027 cf::lock_wait "map_find:$path";
1383 2028
1384 $cf::MAP{$path} || do { 2029 $cf::MAP{$path} || do {
1385 my $guard = cf::lock_acquire "map_find:$path"; 2030 my $guard1 = cf::lock_acquire "map_find:$path";
2031 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
2032
1386 my $map = new_from_path cf::map $path 2033 my $map = new_from_path cf::map $path
1387 or return; 2034 or return;
1388 2035
1389 $map->{last_save} = $cf::RUNTIME; 2036 $map->{last_save} = $cf::RUNTIME;
1390 2037
1391 $map->load_header 2038 $map->load_header
1392 or return; 2039 or return;
1393 2040
1394 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2041 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395 # doing this can freeze the server in a sync job, obviously 2042 # doing this can freeze the server in a sync job, obviously
1396 #$cf::WAIT_FOR_TICK->wait; 2043 #$cf::WAIT_FOR_TICK->wait;
2044 undef $guard1;
2045 undef $guard2;
1397 $map->reset; 2046 $map->reset;
1398 undef $guard;
1399 return find $path; 2047 return find $path;
1400 } 2048 }
1401 2049
1402 $cf::MAP{$path} = $map 2050 $cf::MAP{$path} = $map
1403 } 2051 }
1410 my ($self) = @_; 2058 my ($self) = @_;
1411 2059
1412 local $self->{deny_reset} = 1; # loading can take a long time 2060 local $self->{deny_reset} = 1; # loading can take a long time
1413 2061
1414 my $path = $self->{path}; 2062 my $path = $self->{path};
2063
2064 {
1415 my $guard = cf::lock_acquire "map_load:$path"; 2065 my $guard = cf::lock_acquire "map_data:$path";
1416 2066
2067 return unless $self->valid;
1417 return if $self->in_memory != cf::MAP_SWAPPED; 2068 return unless $self->in_memory == cf::MAP_SWAPPED;
1418 2069
1419 $self->in_memory (cf::MAP_LOADING); 2070 $self->in_memory (cf::MAP_LOADING);
1420 2071
1421 $self->alloc; 2072 $self->alloc;
1422 2073
1423 $self->pre_load; 2074 $self->pre_load;
2075 cf::cede_to_tick;
1424 2076
1425 $self->_load_objects ($self->{load_path}, 1) 2077 my $f = new_from_file cf::object::thawer $self->{load_path};
2078 $f->skip_block;
2079 $self->_load_objects ($f)
1426 or return; 2080 or return;
1427 2081
1428 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2082 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1429 if delete $self->{load_original}; 2083 if delete $self->{load_original};
1430 2084
1431 if (my $uniq = $self->uniq_path) { 2085 if (my $uniq = $self->uniq_path) {
1432 utf8::encode $uniq; 2086 utf8::encode $uniq;
1433 if (aio_open $uniq, O_RDONLY, 0) { 2087 unless (aio_stat $uniq) {
2088 if (my $f = new_from_file cf::object::thawer $uniq) {
1434 $self->clear_unique_items; 2089 $self->clear_unique_items;
1435 $self->_load_objects ($uniq, 0); 2090 $self->_load_objects ($f);
2091 $f->resolve_delayed_derefs;
2092 }
1436 } 2093 }
1437 } 2094 }
1438 2095
1439 Coro::cede; 2096 $f->resolve_delayed_derefs;
1440 2097
2098 cf::cede_to_tick;
1441 # now do the right thing for maps 2099 # now do the right thing for maps
1442 $self->link_multipart_objects; 2100 $self->link_multipart_objects;
1443
1444 unless ($self->{deny_activate}) {
1445 $self->decay_objects;
1446 $self->fix_auto_apply;
1447 $self->update_buttons;
1448 Coro::cede;
1449 $self->set_darkness_map;
1450 $self->difficulty ($self->estimate_difficulty) 2101 $self->difficulty ($self->estimate_difficulty)
1451 unless $self->difficulty; 2102 unless $self->difficulty;
1452 Coro::cede; 2103 cf::cede_to_tick;
2104
2105 unless ($self->{deny_activate}) {
2106 $self->decay_objects;
2107 $self->fix_auto_apply;
2108 $self->update_buttons;
2109 cf::cede_to_tick;
2110 $self->set_darkness_map;
2111 cf::cede_to_tick;
1453 $self->activate; 2112 $self->activate;
2113 }
2114
2115 $self->{last_save} = $cf::RUNTIME;
2116 $self->last_access ($cf::RUNTIME);
2117
2118 $self->in_memory (cf::MAP_IN_MEMORY);
1454 } 2119 }
1455 2120
1456 $self->post_load; 2121 $self->post_load;
1457
1458 $self->in_memory (cf::MAP_IN_MEMORY);
1459} 2122}
1460 2123
1461sub customise_for { 2124sub customise_for {
1462 my ($self, $ob) = @_; 2125 my ($self, $ob) = @_;
1463 2126
1464 return find "~" . $ob->name . "/" . $self->{path} 2127 return find "~" . $ob->name . "/" . $self->{path}
1465 if $self->per_player; 2128 if $self->per_player;
1466 2129
2130# return find "?party/" . $ob->name . "/" . $self->{path}
2131# if $self->per_party;
2132
1467 $self 2133 $self
1468} 2134}
1469 2135
1470# find and load all maps in the 3x3 area around a map 2136# find and load all maps in the 3x3 area around a map
1471sub load_diag { 2137sub load_neighbours {
1472 my ($map) = @_; 2138 my ($map) = @_;
1473 2139
1474 my @diag; # diagonal neighbours 2140 my @neigh; # diagonal neighbours
1475 2141
1476 for (0 .. 3) { 2142 for (0 .. 3) {
1477 my $neigh = $map->tile_path ($_) 2143 my $neigh = $map->tile_path ($_)
1478 or next; 2144 or next;
1479 $neigh = find $neigh, $map 2145 $neigh = find $neigh, $map
1480 or next; 2146 or next;
1481 $neigh->load; 2147 $neigh->load;
1482 2148
2149 push @neigh,
1483 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2150 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1484 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2151 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1485 } 2152 }
1486 2153
1487 for (@diag) { 2154 for (grep defined $_->[0], @neigh) {
2155 my ($path, $origin) = @$_;
1488 my $neigh = find @$_ 2156 my $neigh = find $path, $origin
1489 or next; 2157 or next;
1490 $neigh->load; 2158 $neigh->load;
1491 } 2159 }
1492} 2160}
1493 2161
1498} 2166}
1499 2167
1500sub do_load_sync { 2168sub do_load_sync {
1501 my ($map) = @_; 2169 my ($map) = @_;
1502 2170
2171 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2172 if $Coro::current == $Coro::main;
2173
1503 cf::sync_job { $map->load }; 2174 cf::sync_job { $map->load };
1504} 2175}
1505 2176
1506our %MAP_PREFETCH; 2177our %MAP_PREFETCH;
1507our $MAP_PREFETCHER = undef; 2178our $MAP_PREFETCHER = undef;
1508 2179
1509sub find_async { 2180sub find_async {
1510 my ($path, $origin) = @_; 2181 my ($path, $origin, $load) = @_;
1511 2182
1512 $path = normalise $path, $origin && $origin->{path}; 2183 $path = normalise $path, $origin && $origin->{path};
1513 2184
1514 if (my $map = $cf::MAP{$path}) { 2185 if (my $map = $cf::MAP{$path}) {
1515 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2186 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1516 } 2187 }
1517 2188
1518 undef $MAP_PREFETCH{$path}; 2189 $MAP_PREFETCH{$path} |= $load;
2190
1519 $MAP_PREFETCHER ||= cf::async { 2191 $MAP_PREFETCHER ||= cf::async {
2192 $Coro::current->{desc} = "map prefetcher";
2193
1520 while (%MAP_PREFETCH) { 2194 while (%MAP_PREFETCH) {
1521 for my $path (keys %MAP_PREFETCH) { 2195 while (my ($k, $v) = each %MAP_PREFETCH) {
1522 my $map = find $path 2196 if (my $map = find $k) {
1523 or next;
1524 $map->load; 2197 $map->load if $v;
2198 }
1525 2199
1526 delete $MAP_PREFETCH{$path}; 2200 delete $MAP_PREFETCH{$k};
1527 } 2201 }
1528 } 2202 }
1529 undef $MAP_PREFETCHER; 2203 undef $MAP_PREFETCHER;
1530 }; 2204 };
1531 $MAP_PREFETCHER->prio (6); 2205 $MAP_PREFETCHER->prio (6);
1534} 2208}
1535 2209
1536sub save { 2210sub save {
1537 my ($self) = @_; 2211 my ($self) = @_;
1538 2212
1539 my $lock = cf::lock_acquire "map_data:" . $self->path; 2213 my $lock = cf::lock_acquire "map_data:$self->{path}";
1540 2214
1541 $self->{last_save} = $cf::RUNTIME; 2215 $self->{last_save} = $cf::RUNTIME;
1542 2216
1543 return unless $self->dirty; 2217 return unless $self->dirty;
1544 2218
1550 return if $self->{deny_save}; 2224 return if $self->{deny_save};
1551 2225
1552 local $self->{last_access} = $self->last_access;#d# 2226 local $self->{last_access} = $self->last_access;#d#
1553 2227
1554 cf::async { 2228 cf::async {
2229 $Coro::current->{desc} = "map player save";
1555 $_->contr->save for $self->players; 2230 $_->contr->save for $self->players;
1556 }; 2231 };
1557 2232
1558 if ($uniq) { 2233 if ($uniq) {
1559 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2234 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1567 my ($self) = @_; 2242 my ($self) = @_;
1568 2243
1569 # save first because save cedes 2244 # save first because save cedes
1570 $self->save; 2245 $self->save;
1571 2246
1572 my $lock = cf::lock_acquire "map_data:" . $self->path; 2247 my $lock = cf::lock_acquire "map_data:$self->{path}";
1573 2248
1574 return if $self->players; 2249 return if $self->players;
1575 return if $self->in_memory != cf::MAP_IN_MEMORY; 2250 return if $self->in_memory != cf::MAP_IN_MEMORY;
1576 return if $self->{deny_save}; 2251 return if $self->{deny_save};
1577 2252
2253 $self->in_memory (cf::MAP_SWAPPED);
2254
2255 $self->deactivate;
2256 $_->clear_links_to ($self) for values %cf::MAP;
1578 $self->clear; 2257 $self->clear;
1579 $self->in_memory (cf::MAP_SWAPPED);
1580} 2258}
1581 2259
1582sub reset_at { 2260sub reset_at {
1583 my ($self) = @_; 2261 my ($self) = @_;
1584 2262
1585 # TODO: safety, remove and allow resettable per-player maps 2263 # TODO: safety, remove and allow resettable per-player maps
1586 return 1e99 if $self->isa ("ext::map_per_player");#d#
1587 return 1e99 if $self->{deny_reset}; 2264 return 1e99 if $self->{deny_reset};
1588 2265
1589 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2266 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2267 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1591 2268
1602 my ($self) = @_; 2279 my ($self) = @_;
1603 2280
1604 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2281 my $lock = cf::lock_acquire "map_data:$self->{path}";
1605 2282
1606 return if $self->players; 2283 return if $self->players;
1607 return if $self->isa ("ext::map_per_player");#d#
1608 2284
1609 warn "resetting map ", $self->path;#d# 2285 warn "resetting map ", $self->path;
2286
2287 $self->in_memory (cf::MAP_SWAPPED);
2288
2289 # need to save uniques path
2290 unless ($self->{deny_save}) {
2291 my $uniq = $self->uniq_path; utf8::encode $uniq;
2292
2293 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2294 if $uniq;
2295 }
1610 2296
1611 delete $cf::MAP{$self->path}; 2297 delete $cf::MAP{$self->path};
1612 2298
1613 $self->in_memory (cf::MAP_SWAPPED); 2299 $self->deactivate;
2300 $_->clear_links_to ($self) for values %cf::MAP;
1614 $self->clear; 2301 $self->clear;
1615
1616 $_->clear_links_to ($self) for values %cf::MAP;
1617 2302
1618 $self->unlink_save; 2303 $self->unlink_save;
1619 $self->destroy; 2304 $self->destroy;
1620} 2305}
1621 2306
1622my $nuke_counter = "aaaa"; 2307my $nuke_counter = "aaaa";
1623 2308
1624sub nuke { 2309sub nuke {
1625 my ($self) = @_; 2310 my ($self) = @_;
1626 2311
2312 {
2313 my $lock = cf::lock_acquire "map_data:$self->{path}";
2314
1627 delete $cf::MAP{$self->path}; 2315 delete $cf::MAP{$self->path};
1628 2316
1629 $self->unlink_save; 2317 $self->unlink_save;
1630 2318
1631 bless $self, "cf::map"; 2319 bless $self, "cf::map";
1632 delete $self->{deny_reset}; 2320 delete $self->{deny_reset};
1633 $self->{deny_save} = 1; 2321 $self->{deny_save} = 1;
1634 $self->reset_timeout (1); 2322 $self->reset_timeout (1);
1635 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2323 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636 2324
1637 $cf::MAP{$self->path} = $self; 2325 $cf::MAP{$self->path} = $self;
2326 }
1638 2327
1639 $self->reset; # polite request, might not happen 2328 $self->reset; # polite request, might not happen
2329}
2330
2331=item $maps = cf::map::tmp_maps
2332
2333Returns an arrayref with all map paths of currently instantiated and saved
2334maps. May block.
2335
2336=cut
2337
2338sub tmp_maps() {
2339 [
2340 map {
2341 utf8::decode $_;
2342 /\.map$/
2343 ? normalise $_
2344 : ()
2345 } @{ aio_readdir $TMPDIR or [] }
2346 ]
2347}
2348
2349=item $maps = cf::map::random_maps
2350
2351Returns an arrayref with all map paths of currently instantiated and saved
2352random maps. May block.
2353
2354=cut
2355
2356sub random_maps() {
2357 [
2358 map {
2359 utf8::decode $_;
2360 /\.map$/
2361 ? normalise "?random/$_"
2362 : ()
2363 } @{ aio_readdir $RANDOMDIR or [] }
2364 ]
1640} 2365}
1641 2366
1642=item cf::map::unique_maps 2367=item cf::map::unique_maps
1643 2368
1644Returns an arrayref of paths of all shared maps that have 2369Returns an arrayref of paths of all shared maps that have
1645instantiated unique items. May block. 2370instantiated unique items. May block.
1646 2371
1647=cut 2372=cut
1648 2373
1649sub unique_maps() { 2374sub unique_maps() {
1650 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2375 [
1651 or return; 2376 map {
1652
1653 my @paths;
1654
1655 for (@$files) {
1656 utf8::decode $_; 2377 utf8::decode $_;
1657 next if /\.pst$/; 2378 s/\.map$//; # TODO future compatibility hack
1658 next unless /^$PATH_SEP/o; 2379 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1659 2380 ? ()
1660 push @paths, cf::map::normalise $_; 2381 : normalise $_
2382 } @{ aio_readdir $UNIQUEDIR or [] }
1661 } 2383 ]
1662
1663 \@paths
1664} 2384}
1665
1666package cf;
1667 2385
1668=back 2386=back
1669 2387
1670=head3 cf::object 2388=head3 cf::object
1671 2389
1675 2393
1676=over 4 2394=over 4
1677 2395
1678=item $ob->inv_recursive 2396=item $ob->inv_recursive
1679 2397
1680Returns the inventory of the object _and_ their inventories, recursively. 2398Returns the inventory of the object I<and> their inventories, recursively,
2399but I<not> the object itself.
1681 2400
1682=cut 2401=cut
1683 2402
1684sub inv_recursive_; 2403sub inv_recursive_;
1685sub inv_recursive_ { 2404sub inv_recursive_ {
1686 map { $_, inv_recursive_ $_->inv } @_ 2405 map { $_, inv_recursive_ $_->inv } @_
1687} 2406}
1688 2407
1689sub inv_recursive { 2408sub inv_recursive {
1690 inv_recursive_ inv $_[0] 2409 inv_recursive_ inv $_[0]
2410}
2411
2412=item $ref = $ob->ref
2413
2414Creates and returns a persistent reference to an object that can be stored as a string.
2415
2416=item $ob = cf::object::deref ($refstring)
2417
2418returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2419even if the object actually exists. May block.
2420
2421=cut
2422
2423sub deref {
2424 my ($ref) = @_;
2425
2426 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2427 my ($uuid, $name) = ($1, $2);
2428 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2429 or return;
2430 $pl->ob->uuid eq $uuid
2431 or return;
2432
2433 $pl->ob
2434 } else {
2435 warn "$ref: cannot resolve object reference\n";
2436 undef
2437 }
1691} 2438}
1692 2439
1693package cf; 2440package cf;
1694 2441
1695=back 2442=back
1714 2461
1715 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2462 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716 2463
1717 if ($self->{record_replies}) { 2464 if ($self->{record_replies}) {
1718 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2465 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2466
1719 } else { 2467 } else {
2468 my $pl = $self->contr;
2469
2470 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2471 my $dialog = $pl->{npc_dialog};
2472 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2473
2474 } else {
1720 $msg = $npc->name . " says: $msg" if $npc; 2475 $msg = $npc->name . " says: $msg" if $npc;
1721 $self->message ($msg, $flags); 2476 $self->message ($msg, $flags);
2477 }
1722 } 2478 }
2479}
2480
2481=item $object->send_msg ($channel, $msg, $color, [extra...])
2482
2483=cut
2484
2485sub cf::object::send_msg {
2486 my $pl = shift->contr
2487 or return;
2488 $pl->send_msg (@_);
1723} 2489}
1724 2490
1725=item $player_object->may ("access") 2491=item $player_object->may ("access")
1726 2492
1727Returns wether the given player is authorized to access resource "access" 2493Returns wether the given player is authorized to access resource "access"
1774 $self->deactivate_recursive; 2540 $self->deactivate_recursive;
1775 2541
1776 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2542 return if UNIVERSAL::isa $self->map, "ext::map_link";
1777 2543
1778 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2544 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779 if $self->map; 2545 if $self->map && $self->map->{path} ne "{link}";
1780 2546
1781 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2547 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1782} 2548}
1783 2549
1784sub cf::object::player::leave_link { 2550sub cf::object::player::leave_link {
1785 my ($self, $map, $x, $y) = @_; 2551 my ($self, $map, $x, $y) = @_;
2552
2553 return unless $self->contr->active;
1786 2554
1787 my $link_pos = delete $self->{_link_pos}; 2555 my $link_pos = delete $self->{_link_pos};
1788 2556
1789 unless ($map) { 2557 unless ($map) {
1790 # restore original map position 2558 # restore original map position
1804 # use -1 or undef as default coordinates, not 0, 0 2572 # use -1 or undef as default coordinates, not 0, 0
1805 ($x, $y) = ($map->enter_x, $map->enter_y) 2573 ($x, $y) = ($map->enter_x, $map->enter_y)
1806 if $x <=0 && $y <= 0; 2574 if $x <=0 && $y <= 0;
1807 2575
1808 $map->load; 2576 $map->load;
1809 $map->load_diag; 2577 $map->load_neighbours;
1810 2578
1811 return unless $self->contr->active; 2579 return unless $self->contr->active;
1812 $self->activate_recursive; 2580 $self->activate_recursive;
2581
2582 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813 $self->enter_map ($map, $x, $y); 2583 $self->enter_map ($map, $x, $y);
1814} 2584}
1815 2585
1816cf::player->attach ( 2586=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817 on_logout => sub {
1818 my ($pl) = @_;
1819 2587
1820 # abort map switching before logout 2588Moves the player to the given map-path and coordinates by first freezing
1821 if ($pl->ob->{_link_pos}) { 2589her, loading and preparing them map, calling the provided $check callback
1822 cf::sync_job { 2590that has to return the map if sucecssful, and then unfreezes the player on
1823 $pl->ob->leave_link 2591the new (success) or old (failed) map position. In either case, $done will
1824 }; 2592be called at the end of this process.
1825 }
1826 },
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2593
1830 # try to abort aborted map switching on player login :)
1831 # should happen only on crashes
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 # we need this sleep as the login has a concurrent enter_exit running
1836 # and this sleep increases chances of the player not ending up in scorn
1837 $pl->ob->reply (undef,
1838 "There was an internal problem at your last logout, "
1839 . "the server will try to bring you to your intended destination in a second.",
1840 cf::NDI_RED);
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847
1848=item $player_object->goto ($path, $x, $y)
1849
1850=cut 2594=cut
2595
2596our $GOTOGEN;
1851 2597
1852sub cf::object::player::goto { 2598sub cf::object::player::goto {
1853 my ($self, $path, $x, $y) = @_; 2599 my ($self, $path, $x, $y, $check, $done) = @_;
2600
2601 # do generation counting so two concurrent goto's will be executed in-order
2602 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1854 2603
1855 $self->enter_link; 2604 $self->enter_link;
1856 2605
1857 (async { 2606 (async {
2607 $Coro::current->{desc} = "player::goto $path $x $y";
2608
2609 # *tag paths override both path and x|y
2610 if ($path =~ /^\*(.*)$/) {
2611 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2612 my $ob = $obs[rand @obs];
2613
2614 # see if we actually can go there
2615 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2616 $ob = $obs[rand @obs];
2617 } else {
2618 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2619 }
2620 # else put us there anyways for now #d#
2621
2622 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2623 } else {
2624 ($path, $x, $y) = (undef, undef, undef);
2625 }
2626 }
2627
1858 my $map = eval { 2628 my $map = eval {
1859 my $map = cf::map::find $path; 2629 my $map = defined $path ? cf::map::find $path : undef;
2630
2631 if ($map) {
1860 $map = $map->customise_for ($self) if $map; 2632 $map = $map->customise_for ($self);
2633 $map = $check->($map) if $check && $map;
2634 } else {
2635 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2636 }
2637
1861 $map 2638 $map
2639 };
2640
2641 if ($@) {
2642 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2643 LOG llevError | logBacktrace, Carp::longmess $@;
1862 } or 2644 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2645
2646 if ($gen == $self->{_goto_generation}) {
2647 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2648 $self->leave_link ($map, $x, $y);
2649 }
2650
2651 $done->() if $done;
1866 })->prio (1); 2652 })->prio (1);
1867} 2653}
1868 2654
1869=item $player_object->enter_exit ($exit_object) 2655=item $player_object->enter_exit ($exit_object)
1870 2656
1907 $rmp->{origin_y} = $exit->y; 2693 $rmp->{origin_y} = $exit->y;
1908 } 2694 }
1909 2695
1910 $rmp->{random_seed} ||= $exit->random_seed; 2696 $rmp->{random_seed} ||= $exit->random_seed;
1911 2697
1912 my $data = cf::to_json $rmp; 2698 my $data = cf::encode_json $rmp;
1913 my $md5 = Digest::MD5::md5_hex $data; 2699 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2700 my $meta = "$RANDOMDIR/$md5.meta";
1915 2701
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2702 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2703 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2704 undef $fh;
1919 aio_rename "$meta~", $meta; 2705 aio_rename "$meta~", $meta;
1928 2714
1929 return unless $self->type == cf::PLAYER; 2715 return unless $self->type == cf::PLAYER;
1930 2716
1931 if ($exit->slaying eq "/!") { 2717 if ($exit->slaying eq "/!") {
1932 #TODO: this should de-fi-ni-te-ly not be a sync-job 2718 #TODO: this should de-fi-ni-te-ly not be a sync-job
2719 # the problem is that $exit might not survive long enough
2720 # so it needs to be done right now, right here
1933 cf::sync_job { prepare_random_map $exit }; 2721 cf::sync_job { prepare_random_map $exit };
1934 } 2722 }
1935 2723
1936 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2724 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937 my $hp = $exit->stats->hp; 2725 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp; 2726 my $sp = $exit->stats->sp;
1939 2727
1940 $self->enter_link; 2728 $self->enter_link;
1941 2729
2730 # if exit is damned, update players death & WoR home-position
2731 $self->contr->savebed ($slaying, $hp, $sp)
2732 if $exit->flag (FLAG_DAMNED);
2733
1942 (async { 2734 (async {
2735 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2736
1943 $self->deactivate_recursive; # just to be sure 2737 $self->deactivate_recursive; # just to be sure
1944 unless (eval { 2738 unless (eval {
1945 $self->goto ($slaying, $hp, $sp); 2739 $self->goto ($slaying, $hp, $sp);
1946 2740
1947 1; 2741 1;
1948 }) { 2742 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2743 $self->message ("Something went wrong deep within the crossfire server. "
1950 . "I'll try to bring you back to the map you were before. " 2744 . "I'll try to bring you back to the map you were before. "
1951 . "Please report this to the dungeon master!", 2745 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2746 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2747
1954 warn "ERROR in enter_exit: $@"; 2748 warn "ERROR in enter_exit: $@";
1955 $self->leave_link; 2749 $self->leave_link;
1956 } 2750 }
1957 })->prio (1); 2751 })->prio (1);
1970 2764
1971sub cf::client::send_drawinfo { 2765sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2766 my ($self, $text, $flags) = @_;
1973 2767
1974 utf8::encode $text; 2768 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2769 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2770}
1977 2771
2772=item $client->send_msg ($channel, $msg, $color, [extra...])
2773
2774Send a drawinfo or msg packet to the client, formatting the msg for the
2775client if neccessary. C<$type> should be a string identifying the type of
2776the message, with C<log> being the default. If C<$color> is negative, suppress
2777the message unless the client supports the msg packet.
2778
2779=cut
2780
2781# non-persistent channels (usually the info channel)
2782our %CHANNEL = (
2783 "c/identify" => {
2784 id => "infobox",
2785 title => "Identify",
2786 reply => undef,
2787 tooltip => "Items recently identified",
2788 },
2789 "c/examine" => {
2790 id => "infobox",
2791 title => "Examine",
2792 reply => undef,
2793 tooltip => "Signs and other items you examined",
2794 },
2795 "c/book" => {
2796 id => "infobox",
2797 title => "Book",
2798 reply => undef,
2799 tooltip => "The contents of a note or book",
2800 },
2801 "c/lookat" => {
2802 id => "infobox",
2803 title => "Look",
2804 reply => undef,
2805 tooltip => "What you saw there",
2806 },
2807 "c/who" => {
2808 id => "infobox",
2809 title => "Players",
2810 reply => undef,
2811 tooltip => "Shows players who are currently online",
2812 },
2813 "c/body" => {
2814 id => "infobox",
2815 title => "Body Parts",
2816 reply => undef,
2817 tooltip => "Shows which body parts you posess and are available",
2818 },
2819 "c/uptime" => {
2820 id => "infobox",
2821 title => "Uptime",
2822 reply => undef,
2823 tooltip => "How long the server has been running since last restart",
2824 },
2825 "c/mapinfo" => {
2826 id => "infobox",
2827 title => "Map Info",
2828 reply => undef,
2829 tooltip => "Information related to the maps",
2830 },
2831);
2832
2833sub cf::client::send_msg {
2834 my ($self, $channel, $msg, $color, @extra) = @_;
2835
2836 $msg = $self->pl->expand_cfpod ($msg);
2837
2838 $color &= cf::NDI_CLIENT_MASK; # just in case...
2839
2840 # check predefined channels, for the benefit of C
2841 if ($CHANNEL{$channel}) {
2842 $channel = $CHANNEL{$channel};
2843
2844 $self->ext_msg (channel_info => $channel)
2845 if $self->can_msg;
2846
2847 $channel = $channel->{id};
2848
2849 } elsif (ref $channel) {
2850 # send meta info to client, if not yet sent
2851 unless (exists $self->{channel}{$channel->{id}}) {
2852 $self->{channel}{$channel->{id}} = $channel;
2853 $self->ext_msg (channel_info => $channel)
2854 if $self->can_msg;
2855 }
2856
2857 $channel = $channel->{id};
2858 }
2859
2860 return unless @extra || length $msg;
2861
2862 if ($self->can_msg) {
2863 # default colour, mask it out
2864 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2865 if $color & cf::NDI_DEF;
2866
2867 $self->send_packet ("msg " . $self->{json_coder}->encode (
2868 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2869 } else {
2870 if ($color >= 0) {
2871 # replace some tags by gcfclient-compatible ones
2872 for ($msg) {
2873 1 while
2874 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2875 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2876 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2877 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2878 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2879 }
2880
2881 $color &= cf::NDI_COLOR_MASK;
2882
2883 utf8::encode $msg;
2884
2885 if (0 && $msg =~ /\[/) {
2886 # COMMAND/INFO
2887 $self->send_packet ("drawextinfo $color 10 8 $msg")
2888 } else {
2889 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2890 $self->send_packet ("drawinfo $color $msg")
2891 }
2892 }
2893 }
2894}
2895
2896=item $client->ext_msg ($type, @msg)
2897
2898Sends an ext event to the client.
2899
2900=cut
2901
2902sub cf::client::ext_msg($$@) {
2903 my ($self, $type, @msg) = @_;
2904
2905 if ($self->extcmd == 2) {
2906 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2907 } elsif ($self->extcmd == 1) { # TODO: remove
2908 push @msg, msgtype => "event_$type";
2909 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2910 }
2911}
2912
2913=item $client->ext_reply ($msgid, @msg)
2914
2915Sends an ext reply to the client.
2916
2917=cut
2918
2919sub cf::client::ext_reply($$@) {
2920 my ($self, $id, @msg) = @_;
2921
2922 if ($self->extcmd == 2) {
2923 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2924 } elsif ($self->extcmd == 1) {
2925 #TODO: version 1, remove
2926 unshift @msg, msgtype => "reply", msgid => $id;
2927 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2928 }
2929}
1978 2930
1979=item $success = $client->query ($flags, "text", \&cb) 2931=item $success = $client->query ($flags, "text", \&cb)
1980 2932
1981Queues a query to the client, calling the given callback with 2933Queues a query to the client, calling the given callback with
1982the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2934the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1983C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2935C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984 2936
1985Queries can fail, so check the return code. Or don't, as queries will become 2937Queries can fail, so check the return code. Or don't, as queries will
1986reliable at some point in the future. 2938become reliable at some point in the future.
1987 2939
1988=cut 2940=cut
1989 2941
1990sub cf::client::query { 2942sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 2943 my ($self, $flags, $text, $cb) = @_;
1999 utf8::encode $text; 2951 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2952 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 2953
2002 $self->send_packet ($self->{query_queue}[0][0]) 2954 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 2955 if @{ $self->{query_queue} } == 1;
2956
2957 1
2004} 2958}
2005 2959
2006cf::client->attach ( 2960cf::client->attach (
2961 on_connect => sub {
2962 my ($ns) = @_;
2963
2964 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2965 },
2007 on_reply => sub { 2966 on_reply => sub {
2008 my ($ns, $msg) = @_; 2967 my ($ns, $msg) = @_;
2009 2968
2010 # this weird shuffling is so that direct followup queries 2969 # this weird shuffling is so that direct followup queries
2011 # get handled first 2970 # get handled first
2023 } else { 2982 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2983 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 2984 }
2026 } 2985 }
2027 }, 2986 },
2987 on_exticmd => sub {
2988 my ($ns, $buf) = @_;
2989
2990 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2991
2992 if (ref $msg) {
2993 my ($type, $reply, @payload) =
2994 "ARRAY" eq ref $msg
2995 ? @$msg
2996 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2997
2998 my @reply;
2999
3000 if (my $cb = $EXTICMD{$type}) {
3001 @reply = $cb->($ns, @payload);
3002 }
3003
3004 $ns->ext_reply ($reply, @reply)
3005 if $reply;
3006
3007 } else {
3008 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3009 }
3010
3011 cf::override;
3012 },
2028); 3013);
2029 3014
2030=item $client->async (\&cb) 3015=item $client->async (\&cb)
2031 3016
2032Create a new coroutine, running the specified callback. The coroutine will 3017Create a new coroutine, running the specified callback. The coroutine will
2073our $safe = new Safe "safe"; 3058our $safe = new Safe "safe";
2074our $safe_hole = new Safe::Hole; 3059our $safe_hole = new Safe::Hole;
2075 3060
2076$SIG{FPE} = 'IGNORE'; 3061$SIG{FPE} = 'IGNORE';
2077 3062
2078$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3063$safe->permit_only (Opcode::opset qw(
3064 :base_core :base_mem :base_orig :base_math
3065 grepstart grepwhile mapstart mapwhile
3066 sort time
3067));
2079 3068
2080# here we export the classes and methods available to script code 3069# here we export the classes and methods available to script code
2081 3070
2082=pod 3071=pod
2083 3072
2084The following fucntions and emthods are available within a safe environment: 3073The following functions and methods are available within a safe environment:
2085 3074
2086 cf::object contr pay_amount pay_player map 3075 cf::object
3076 contr pay_amount pay_player map x y force_find force_add destroy
3077 insert remove name archname title slaying race decrease_ob_nr
3078
2087 cf::object::player player 3079 cf::object::player
2088 cf::player peaceful 3080 player
2089 cf::map trigger 3081
3082 cf::player
3083 peaceful
3084
3085 cf::map
3086 trigger
2090 3087
2091=cut 3088=cut
2092 3089
2093for ( 3090for (
2094 ["cf::object" => qw(contr pay_amount pay_player map)], 3091 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3092 insert remove inv name archname title slaying race
3093 decrease_ob_nr destroy)],
2095 ["cf::object::player" => qw(player)], 3094 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 3095 ["cf::player" => qw(peaceful)],
2097 ["cf::map" => qw(trigger)], 3096 ["cf::map" => qw(trigger)],
2098) { 3097) {
2099 no strict 'refs'; 3098 no strict 'refs';
2170=back 3169=back
2171 3170
2172=cut 3171=cut
2173 3172
2174############################################################################# 3173#############################################################################
2175
2176=head2 EXTENSION DATABASE SUPPORT
2177
2178Crossfire maintains a very simple database for extension use. It can
2179currently store anything that can be serialised using Storable, which
2180excludes objects.
2181
2182The parameter C<$family> should best start with the name of the extension
2183using it, it should be unique.
2184
2185=over 4
2186
2187=item $hashref = cf::db_get $family
2188
2189Return a hashref for use by the extension C<$family>, which can be
2190modified. After modifications, you have to call C<cf::db_dirty> or
2191C<cf::db_sync>.
2192
2193=item $value = cf::db_get $family => $key
2194
2195Returns a single value from the database
2196
2197=item cf::db_put $family => $hashref
2198
2199Stores the given family hashref into the database. Updates are delayed, if
2200you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202=item cf::db_put $family => $key => $value
2203
2204Stores the given C<$value> in the family hash. Updates are delayed, if you
2205want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207=item cf::db_dirty
2208
2209Marks the database as dirty, to be updated at a later time.
2210
2211=item cf::db_sync
2212
2213Immediately write the database to disk I<if it is dirty>.
2214
2215=cut
2216
2217our $DB;
2218
2219{
2220 my $path = cf::localdir . "/database.pst";
2221
2222 sub db_load() {
2223 $DB = stat $path ? Storable::retrieve $path : { };
2224 }
2225
2226 my $pid;
2227
2228 sub db_save() {
2229 waitpid $pid, 0 if $pid;
2230 if (0 == ($pid = fork)) {
2231 $DB->{_meta}{version} = 1;
2232 Storable::nstore $DB, "$path~";
2233 rename "$path~", $path;
2234 cf::_exit 0 if defined $pid;
2235 }
2236 }
2237
2238 my $dirty;
2239
2240 sub db_sync() {
2241 db_save if $dirty;
2242 undef $dirty;
2243 }
2244
2245 my $idle = Event->idle (
2246 reentrant => 0,
2247 min => 10,
2248 max => 20,
2249 repeat => 0,
2250 data => WF_AUTOCANCEL,
2251 cb => \&db_sync,
2252 );
2253
2254 sub db_dirty() {
2255 $dirty = 1;
2256 $idle->start;
2257 }
2258
2259 sub db_get($;$) {
2260 @_ >= 2
2261 ? $DB->{$_[0]}{$_[1]}
2262 : ($DB->{$_[0]} ||= { })
2263 }
2264
2265 sub db_put($$;$) {
2266 if (@_ >= 3) {
2267 $DB->{$_[0]}{$_[1]} = $_[2];
2268 } else {
2269 $DB->{$_[0]} = $_[1];
2270 }
2271 db_dirty;
2272 }
2273
2274 cf::global->attach (
2275 prio => 10000,
2276 on_cleanup => sub {
2277 db_sync;
2278 },
2279 );
2280}
2281
2282#############################################################################
2283# the server's init and main functions 3174# the server's init and main functions
2284 3175
2285sub load_resources { 3176sub load_facedata($) {
2286 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 3177 my ($path) = @_;
3178
3179 # HACK to clear player env face cache, we need some signal framework
3180 # for this (global event?)
3181 %ext::player_env::MUSIC_FACE_CACHE = ();
3182
3183 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3184
3185 warn "loading facedata from $path\n";
3186
3187 my $facedata;
3188 0 < aio_load $path, $facedata
3189 or die "$path: $!";
3190
3191 $facedata = Coro::Storable::thaw $facedata;
3192
3193 $facedata->{version} == 2
3194 or cf::cleanup "$path: version mismatch, cannot proceed.";
3195
3196 # patch in the exptable
3197 $facedata->{resource}{"res/exp_table"} = {
3198 type => FT_RSRC,
3199 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
3200 };
3201 cf::cede_to_tick;
3202
3203 {
3204 my $faces = $facedata->{faceinfo};
3205
3206 while (my ($face, $info) = each %$faces) {
3207 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3208
3209 cf::face::set_visibility $idx, $info->{visibility};
3210 cf::face::set_magicmap $idx, $info->{magicmap};
3211 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
3212 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
3213
3214 cf::cede_to_tick;
3215 }
3216
3217 while (my ($face, $info) = each %$faces) {
3218 next unless $info->{smooth};
3219
3220 my $idx = cf::face::find $face
3221 or next;
3222
3223 if (my $smooth = cf::face::find $info->{smooth}) {
3224 cf::face::set_smooth $idx, $smooth;
3225 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3226 } else {
3227 warn "smooth face '$info->{smooth}' not found for face '$face'";
3228 }
3229
3230 cf::cede_to_tick;
3231 }
3232 }
3233
3234 {
3235 my $anims = $facedata->{animinfo};
3236
3237 while (my ($anim, $info) = each %$anims) {
3238 cf::anim::set $anim, $info->{frames}, $info->{facings};
3239 cf::cede_to_tick;
3240 }
3241
3242 cf::anim::invalidate_all; # d'oh
3243 }
3244
3245 {
3246 # TODO: for gcfclient pleasure, we should give resources
3247 # that gcfclient doesn't grok a >10000 face index.
3248 my $res = $facedata->{resource};
3249
3250 while (my ($name, $info) = each %$res) {
3251 if (defined $info->{type}) {
3252 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3253 my $data;
3254
3255 if ($info->{type} & 1) {
3256 # prepend meta info
3257
3258 my $meta = $enc->encode ({
3259 name => $name,
3260 %{ $info->{meta} || {} },
3261 });
3262
3263 $data = pack "(w/a*)*", $meta, $info->{data};
3264 } else {
3265 $data = $info->{data};
3266 }
3267
3268 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3269 cf::face::set_type $idx, $info->{type};
3270 } else {
3271 $RESOURCE{$name} = $info;
3272 }
3273
3274 cf::cede_to_tick;
3275 }
3276 }
3277
3278 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3279
3280 1
3281}
3282
3283cf::global->attach (on_resource_update => sub {
3284 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3285 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3286
3287 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3288 my $sound = $soundconf->{compat}[$_]
3289 or next;
3290
3291 my $face = cf::face::find "sound/$sound->[1]";
3292 cf::sound::set $sound->[0] => $face;
3293 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3294 }
3295
3296 while (my ($k, $v) = each %{$soundconf->{event}}) {
3297 my $face = cf::face::find "sound/$v";
3298 cf::sound::set $k => $face;
3299 }
3300 }
3301});
3302
3303register_exticmd fx_want => sub {
3304 my ($ns, $want) = @_;
3305
3306 while (my ($k, $v) = each %$want) {
3307 $ns->fx_want ($k, $v);
3308 }
3309};
3310
3311sub reload_regions {
3312 # HACK to clear player env face cache, we need some signal framework
3313 # for this (global event?)
3314 %ext::player_env::MUSIC_FACE_CACHE = ();
3315
3316 load_resource_file "$MAPDIR/regions"
2287 or die "unable to load regions file\n";#d# 3317 or die "unable to load regions file\n";
2288}
2289 3318
2290sub cfg_load { 3319 for (cf::region::list) {
3320 $_->{match} = qr/$_->{match}/
3321 if exists $_->{match};
3322 }
3323}
3324
3325sub reload_facedata {
3326 load_facedata "$DATADIR/facedata"
3327 or die "unable to load facedata\n";
3328}
3329
3330sub reload_archetypes {
3331 load_resource_file "$DATADIR/archetypes"
3332 or die "unable to load archetypes\n";
3333 #d# NEED to laod twice to resolve forward references
3334 # this really needs to be done in an extra post-pass
3335 # (which needs to be synchronous, so solve it differently)
3336 load_resource_file "$DATADIR/archetypes"
3337 or die "unable to load archetypes\n";
3338}
3339
3340sub reload_treasures {
3341 load_resource_file "$DATADIR/treasures"
3342 or die "unable to load treasurelists\n";
3343}
3344
3345sub reload_resources {
3346 warn "reloading resource files...\n";
3347
3348 reload_regions;
3349 reload_facedata;
3350 #reload_archetypes;#d#
3351 reload_archetypes;
3352 reload_treasures;
3353
3354 warn "finished reloading resource files\n";
3355}
3356
3357sub init {
3358 reload_resources;
3359}
3360
3361sub reload_config {
2291 open my $fh, "<:utf8", cf::confdir . "/config" 3362 open my $fh, "<:utf8", "$CONFDIR/config"
2292 or return; 3363 or return;
2293 3364
2294 local $/; 3365 local $/;
2295 *CFG = YAML::Syck::Load <$fh>; 3366 *CFG = YAML::Load <$fh>;
2296 3367
2297 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3368 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2298 3369
2299 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3370 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2300 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3371 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2306 }; 3377 };
2307 warn $@ if $@; 3378 warn $@ if $@;
2308 } 3379 }
2309} 3380}
2310 3381
2311sub init {
2312 load_resources;
2313}
2314
2315sub main { 3382sub main {
2316 # we must not ever block the main coroutine 3383 # we must not ever block the main coroutine
2317 local $Coro::idle = sub { 3384 local $Coro::idle = sub {
2318 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3385 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2319 (async { 3386 (async {
2320 Event::one_event; 3387 $Coro::current->{desc} = "IDLE BUG HANDLER";
3388 EV::loop EV::LOOP_ONESHOT;
2321 })->prio (Coro::PRIO_MAX); 3389 })->prio (Coro::PRIO_MAX);
2322 }; 3390 };
2323 3391
2324 cfg_load; 3392 reload_config;
2325 db_load; 3393 db_init;
2326 load_extensions; 3394 load_extensions;
2327 3395
2328 $TICK_WATCHER->start; 3396 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3397 evthread_start IO::AIO::poll_fileno;
2329 Event::loop; 3398 EV::loop;
2330} 3399}
2331 3400
2332############################################################################# 3401#############################################################################
2333# initialisation and cleanup 3402# initialisation and cleanup
2334 3403
2335# install some emergency cleanup handlers 3404# install some emergency cleanup handlers
2336BEGIN { 3405BEGIN {
3406 our %SIGWATCHER = ();
2337 for my $signal (qw(INT HUP TERM)) { 3407 for my $signal (qw(INT HUP TERM)) {
2338 Event->signal ( 3408 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2339 reentrant => 0,
2340 data => WF_AUTOCANCEL,
2341 signal => $signal,
2342 prio => 0,
2343 cb => sub {
2344 cf::cleanup "SIG$signal"; 3409 cf::cleanup "SIG$signal";
2345 },
2346 ); 3410 };
3411 }
3412}
3413
3414sub write_runtime_sync {
3415 my $runtime = "$LOCALDIR/runtime";
3416
3417 # first touch the runtime file to show we are still running:
3418 # the fsync below can take a very very long time.
3419
3420 IO::AIO::aio_utime $runtime, undef, undef;
3421
3422 my $guard = cf::lock_acquire "write_runtime";
3423
3424 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3425 or return;
3426
3427 my $value = $cf::RUNTIME + 90 + 10;
3428 # 10 is the runtime save interval, for a monotonic clock
3429 # 60 allows for the watchdog to kill the server.
3430
3431 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3432 and return;
3433
3434 # always fsync - this file is important
3435 aio_fsync $fh
3436 and return;
3437
3438 # touch it again to show we are up-to-date
3439 aio_utime $fh, undef, undef;
3440
3441 close $fh
3442 or return;
3443
3444 aio_rename "$runtime~", $runtime
3445 and return;
3446
3447 warn "runtime file written.\n";
3448
2347 } 3449 1
3450}
3451
3452our $uuid_lock;
3453our $uuid_skip;
3454
3455sub write_uuid_sync($) {
3456 $uuid_skip ||= $_[0];
3457
3458 return if $uuid_lock;
3459 local $uuid_lock = 1;
3460
3461 my $uuid = "$LOCALDIR/uuid";
3462
3463 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3464 or return;
3465
3466 my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
3467 $uuid_skip = 0;
3468
3469 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3470 and return;
3471
3472 # always fsync - this file is important
3473 aio_fsync $fh
3474 and return;
3475
3476 close $fh
3477 or return;
3478
3479 aio_rename "$uuid~", $uuid
3480 and return;
3481
3482 warn "uuid file written ($value).\n";
3483
3484 1
3485
3486}
3487
3488sub write_uuid($$) {
3489 my ($skip, $sync) = @_;
3490
3491 $sync ? write_uuid_sync $skip
3492 : async { write_uuid_sync $skip };
2348} 3493}
2349 3494
2350sub emergency_save() { 3495sub emergency_save() {
2351 my $freeze_guard = cf::freeze_mainloop; 3496 my $freeze_guard = cf::freeze_mainloop;
2352 3497
2358 # and maps saved/destroyed asynchronously. 3503 # and maps saved/destroyed asynchronously.
2359 warn "begin emergency player save\n"; 3504 warn "begin emergency player save\n";
2360 for my $login (keys %cf::PLAYER) { 3505 for my $login (keys %cf::PLAYER) {
2361 my $pl = $cf::PLAYER{$login} or next; 3506 my $pl = $cf::PLAYER{$login} or next;
2362 $pl->valid or next; 3507 $pl->valid or next;
3508 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2363 $pl->save; 3509 $pl->save;
2364 } 3510 }
2365 warn "end emergency player save\n"; 3511 warn "end emergency player save\n";
2366 3512
2367 warn "begin emergency map save\n"; 3513 warn "begin emergency map save\n";
2369 my $map = $cf::MAP{$path} or next; 3515 my $map = $cf::MAP{$path} or next;
2370 $map->valid or next; 3516 $map->valid or next;
2371 $map->save; 3517 $map->save;
2372 } 3518 }
2373 warn "end emergency map save\n"; 3519 warn "end emergency map save\n";
3520
3521 warn "begin emergency database checkpoint\n";
3522 BDB::db_env_txn_checkpoint $DB_ENV;
3523 warn "end emergency database checkpoint\n";
3524
3525 warn "begin write uuid\n";
3526 write_uuid_sync 1;
3527 warn "end write uuid\n";
2374 }; 3528 };
2375 3529
2376 warn "leave emergency perl save\n"; 3530 warn "leave emergency perl save\n";
2377} 3531}
2378 3532
3533sub post_cleanup {
3534 my ($make_core) = @_;
3535
3536 warn Carp::longmess "post_cleanup backtrace"
3537 if $make_core;
3538}
3539
2379sub reload() { 3540sub do_reload_perl() {
2380 # can/must only be called in main 3541 # can/must only be called in main
2381 if ($Coro::current != $Coro::main) { 3542 if ($Coro::current != $Coro::main) {
2382 warn "can only reload from main coroutine"; 3543 warn "can only reload from main coroutine";
2383 return; 3544 return;
2384 } 3545 }
2385 3546
2386 warn "reloading..."; 3547 warn "reloading...";
2387 3548
2388 warn "cancelling server ticker"; 3549 warn "entering sync_job";
2389 $TICK_WATCHER->cancel;
2390 3550
3551 cf::sync_job {
3552 cf::write_runtime_sync; # external watchdog should not bark
2391 cf::emergency_save; 3553 cf::emergency_save;
3554 cf::write_runtime_sync; # external watchdog should not bark
2392 3555
2393 eval { 3556 warn "syncing database to disk";
3557 BDB::db_env_txn_checkpoint $DB_ENV;
3558
2394 # if anything goes wrong in here, we should simply crash as we already saved 3559 # if anything goes wrong in here, we should simply crash as we already saved
2395
2396 warn "syncing database to disk";
2397 cf::db_sync;
2398
2399 warn "cancelling all WF_AUTOCANCEL watchers";
2400 for (Event::all_watchers) {
2401 $_->cancel if $_->data & WF_AUTOCANCEL;
2402 }
2403 3560
2404 warn "flushing outstanding aio requests"; 3561 warn "flushing outstanding aio requests";
2405 for (;;) { 3562 for (;;) {
3563 BDB::flush;
2406 IO::AIO::flush; 3564 IO::AIO::flush;
2407 Coro::cede; 3565 Coro::cede_notself;
2408 last unless IO::AIO::nreqs; 3566 last unless IO::AIO::nreqs || BDB::nreqs;
2409 warn "iterate..."; 3567 warn "iterate...";
2410 } 3568 }
3569
3570 ++$RELOAD;
2411 3571
2412 warn "cancelling all extension coros"; 3572 warn "cancelling all extension coros";
2413 $_->cancel for values %EXT_CORO; 3573 $_->cancel for values %EXT_CORO;
2414 %EXT_CORO = (); 3574 %EXT_CORO = ();
2415 3575
2416 warn "removing commands"; 3576 warn "removing commands";
2417 %COMMAND = (); 3577 %COMMAND = ();
2418 3578
2419 warn "removing ext commands"; 3579 warn "removing ext/exti commands";
2420 %EXTCMD = (); 3580 %EXTCMD = ();
3581 %EXTICMD = ();
2421 3582
2422 warn "unloading/nuking all extensions"; 3583 warn "unloading/nuking all extensions";
2423 for my $pkg (@EXTS) { 3584 for my $pkg (@EXTS) {
2424 warn "... unloading $pkg"; 3585 warn "... unloading $pkg";
2425 3586
2455 Symbol::delete_package "safe::$_" 3616 Symbol::delete_package "safe::$_"
2456 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3617 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2457 3618
2458 warn "unloading cf.pm \"a bit\""; 3619 warn "unloading cf.pm \"a bit\"";
2459 delete $INC{"cf.pm"}; 3620 delete $INC{"cf.pm"};
3621 delete $INC{"cf/pod.pm"};
2460 3622
2461 # don't, removes xs symbols, too, 3623 # don't, removes xs symbols, too,
2462 # and global variables created in xs 3624 # and global variables created in xs
2463 #Symbol::delete_package __PACKAGE__; 3625 #Symbol::delete_package __PACKAGE__;
2464 3626
2467 warn "reloading cf.pm"; 3629 warn "reloading cf.pm";
2468 require cf; 3630 require cf;
2469 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3631 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2470 3632
2471 warn "loading config and database again"; 3633 warn "loading config and database again";
2472 cf::cfg_load; 3634 cf::reload_config;
2473 cf::db_load;
2474 3635
2475 warn "loading extensions"; 3636 warn "loading extensions";
2476 cf::load_extensions; 3637 cf::load_extensions;
2477 3638
2478 warn "reattaching attachments to objects/players"; 3639 warn "reattaching attachments to objects/players";
2479 _global_reattach; 3640 _global_reattach; # objects, sockets
2480 warn "reattaching attachments to maps"; 3641 warn "reattaching attachments to maps";
2481 reattach $_ for values %MAP; 3642 reattach $_ for values %MAP;
3643 warn "reattaching attachments to players";
3644 reattach $_ for values %PLAYER;
2482 3645
2483 warn "loading reloadable resources"; 3646 warn "leaving sync_job";
2484 load_resources;
2485 3647
2486 warn "restarting server ticker"; 3648 1
2487 3649 } or do {
2488 $TICK_WATCHER->start; 3650 warn $@;
3651 cf::cleanup "error while reloading, exiting.";
2489 }; 3652 };
2490
2491 if ($@) {
2492 warn $@;
2493 warn "error while reloading, exiting.";
2494 exit 1;
2495 }
2496 3653
2497 warn "reloaded"; 3654 warn "reloaded";
2498}; 3655};
2499 3656
2500our $RELOAD_WATCHER; # used only during reload 3657our $RELOAD_WATCHER; # used only during reload
2501 3658
3659sub reload_perl() {
3660 # doing reload synchronously and two reloads happen back-to-back,
3661 # coro crashes during coro_state_free->destroy here.
3662
3663 $RELOAD_WATCHER ||= EV::timer 0, 0, sub {
3664 do_reload_perl;
3665 undef $RELOAD_WATCHER;
3666 };
3667}
3668
2502register_command "reload" => sub { 3669register_command "reload" => sub {
2503 my ($who, $arg) = @_; 3670 my ($who, $arg) = @_;
2504 3671
2505 if ($who->flag (FLAG_WIZ)) { 3672 if ($who->flag (FLAG_WIZ)) {
2506 $who->message ("reloading server."); 3673 $who->message ("reloading server.");
2507 3674 async {
2508 # doing reload synchronously and two reloads happen back-to-back, 3675 $Coro::current->{desc} = "perl_reload";
2509 # coro crashes during coro_state_free->destroy here.
2510
2511 $RELOAD_WATCHER ||= Event->timer (
2512 reentrant => 0,
2513 after => 0,
2514 data => WF_AUTOCANCEL,
2515 cb => sub {
2516 reload; 3676 reload_perl;
2517 undef $RELOAD_WATCHER;
2518 },
2519 ); 3677 };
2520 } 3678 }
2521}; 3679};
2522 3680
2523unshift @INC, $LIBDIR; 3681unshift @INC, $LIBDIR;
2524 3682
2525my $bug_warning = 0; 3683my $bug_warning = 0;
2526 3684
2527$TICK_WATCHER = Event->timer ( 3685our @WAIT_FOR_TICK;
2528 reentrant => 0, 3686our @WAIT_FOR_TICK_BEGIN;
2529 parked => 1, 3687
2530 prio => 0, 3688sub wait_for_tick {
2531 at => $NEXT_TICK || $TICK, 3689 return if tick_inhibit;
2532 data => WF_AUTOCANCEL, 3690 return if $Coro::current == $Coro::main;
2533 cb => sub { 3691
3692 my $signal = new Coro::Signal;
3693 push @WAIT_FOR_TICK, $signal;
3694 $signal->wait;
3695}
3696
3697sub wait_for_tick_begin {
3698 return if tick_inhibit;
3699 return if $Coro::current == $Coro::main;
3700
3701 my $signal = new Coro::Signal;
3702 push @WAIT_FOR_TICK_BEGIN, $signal;
3703 $signal->wait;
3704}
3705
3706sub tick {
2534 if ($Coro::current != $Coro::main) { 3707 if ($Coro::current != $Coro::main) {
2535 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3708 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2536 unless ++$bug_warning > 10; 3709 unless ++$bug_warning > 10;
2537 return; 3710 return;
2538 } 3711 }
2539 3712
2540 $NOW = Event::time;
2541
2542 cf::server_tick; # one server iteration 3713 cf::server_tick; # one server iteration
2543 $RUNTIME += $TICK;
2544 $NEXT_TICK += $TICK;
2545 3714
2546 $WAIT_FOR_TICK->broadcast; 3715 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3716 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
3717 Coro::async_pool {
3718 $Coro::current->{desc} = "runtime saver";
3719 write_runtime_sync
3720 or warn "ERROR: unable to write runtime file: $!";
3721 };
3722 }
2548 3723
2549 Event::sweep; 3724 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2550 Coro::cede_notself; 3725 $sig->send;
3726 }
3727 while (my $sig = shift @WAIT_FOR_TICK) {
3728 $sig->send;
3729 }
3730
3731 $LOAD = ($NOW - $TICK_START) / $TICK;
3732 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3733
3734 if (0) {
3735 if ($NEXT_TICK) {
3736 my $jitter = $TICK_START - $NEXT_TICK;
3737 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3738 warn "jitter $JITTER\n";#d#
2551 3739 }
2552# my $AFTER = Event::time;
2553# warn $AFTER - $NOW;#d#
2554
2555 # if we are delayed by four ticks or more, skip them all
2556 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2557
2558 $TICK_WATCHER->at ($NEXT_TICK);
2559 $TICK_WATCHER->start;
2560 }, 3740 }
2561); 3741}
2562 3742
2563{ 3743{
2564 BDB::max_poll_time $TICK * 0.1; 3744 # configure BDB
2565 $BDB_POLL_WATCHER = Event->io ( 3745
2566 reentrant => 0,
2567 fd => BDB::poll_fileno,
2568 poll => 'r',
2569 prio => 0,
2570 data => WF_AUTOCANCEL,
2571 cb => \&BDB::poll_cb,
2572 );
2573 BDB::min_parallel 8; 3746 BDB::min_parallel 8;
2574 3747 BDB::max_poll_reqs $TICK * 0.1;
2575 BDB::set_sync_prepare { 3748 $Coro::BDB::WATCHER->priority (1);
2576 my $status;
2577 my $current = $Coro::current;
2578 (
2579 sub {
2580 $status = $!;
2581 $current->ready; undef $current;
2582 },
2583 sub {
2584 Coro::schedule while defined $current;
2585 $! = $status;
2586 },
2587 )
2588 };
2589 3749
2590 unless ($DB_ENV) { 3750 unless ($DB_ENV) {
2591 $DB_ENV = BDB::db_env_create; 3751 $DB_ENV = BDB::db_env_create;
3752 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3753 | BDB::LOG_AUTOREMOVE, 1);
3754 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3755 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2592 3756
2593 cf::sync_job { 3757 cf::sync_job {
3758 eval {
2594 BDB::db_env_open 3759 BDB::db_env_open
2595 $DB_ENV, 3760 $DB_ENV,
2596 $BDB_ENV_DIR, 3761 $BDBDIR,
2597 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3762 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3763 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599 0666; 3764 0666;
2600 3765
2601 cf::cleanup "$!" if $!; 3766 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602 3767 };
2603 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3768
2604 $DB_ENV->set_lk_detect; 3769 cf::cleanup "db_env_open(db): $@" if $@;
2605 }; 3770 };
2606 } 3771 }
3772
3773 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3774 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3775 };
3776 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3777 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3778 };
3779 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3780 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3781 };
2607} 3782}
2608 3783
2609{ 3784{
3785 # configure IO::AIO
3786
2610 IO::AIO::min_parallel 8; 3787 IO::AIO::min_parallel 8;
2611
2612 undef $Coro::AIO::WATCHER;
2613 IO::AIO::max_poll_time $TICK * 0.1; 3788 IO::AIO::max_poll_time $TICK * 0.1;
2614 $AIO_POLL_WATCHER = Event->io ( 3789 $Coro::AIO::WATCHER->priority (1);
2615 reentrant => 0,
2616 fd => IO::AIO::poll_fileno,
2617 poll => 'r',
2618 prio => 6,
2619 data => WF_AUTOCANCEL,
2620 cb => \&IO::AIO::poll_cb,
2621 );
2622} 3790}
2623 3791
2624$WRITE_RUNTIME_WATCHER = Event->timer ( 3792my $_log_backtrace;
2625 reentrant => 0, 3793
2626 data => WF_AUTOCANCEL, 3794sub _log_backtrace {
2627 after => 1, 3795 my ($msg, @addr) = @_;
2628 interval => 10, 3796
2629 prio => 6, # keep it lowest so it acts like a watchdog 3797 $msg =~ s/\n//;
2630 cb => Coro::unblock_sub { 3798
2631 write_runtime 3799 # limit the # of concurrent backtraces
2632 or warn "ERROR: unable to write runtime file: $!"; 3800 if ($_log_backtrace < 2) {
3801 ++$_log_backtrace;
3802 async {
3803 $Coro::current->{desc} = "abt $msg";
3804
3805 my @bt = fork_call {
3806 @addr = map { sprintf "%x", $_ } @addr;
3807 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3808 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3809 or die "addr2line: $!";
3810
3811 my @funcs;
3812 my @res = <$fh>;
3813 chomp for @res;
3814 while (@res) {
3815 my ($func, $line) = splice @res, 0, 2, ();
3816 push @funcs, "[$func] $line";
3817 }
3818
3819 @funcs
3820 };
3821
3822 LOG llevInfo, "[ABT] $msg\n";
3823 LOG llevInfo, "[ABT] $_\n" for @bt;
3824 --$_log_backtrace;
3825 };
3826 } else {
3827 LOG llevInfo, "[ABT] $msg\n";
3828 LOG llevInfo, "[ABT] [suppressed]\n";
2633 }, 3829 }
2634); 3830}
3831
3832# load additional modules
3833use cf::pod;
2635 3834
2636END { cf::emergency_save } 3835END { cf::emergency_save }
2637 3836
26381 38371
2639 3838

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines