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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines