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.416 by root, Fri Apr 11 13:59:06 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
1190 my ($self, $merge) = @_; 1818 my ($self, $merge) = @_;
1191 1819
1192 # we have to keep some variables in memory intact 1820 # we have to keep some variables in memory intact
1193 local $self->{path}; 1821 local $self->{path};
1194 local $self->{load_path}; 1822 local $self->{load_path};
1195 local $self->{deny_save};
1196 local $self->{deny_reset};
1197 1823
1198 $self->SUPER::thawer_merge ($merge); 1824 $self->SUPER::thawer_merge ($merge);
1199} 1825}
1200 1826
1201sub normalise { 1827sub normalise {
1248 $self->init; # pass $1 etc. 1874 $self->init; # pass $1 etc.
1249 return $self; 1875 return $self;
1250 } 1876 }
1251 } 1877 }
1252 1878
1253 Carp::carp "unable to resolve path '$path' (base '$base')."; 1879 Carp::cluck "unable to resolve path '$path' (base '$base').";
1254 () 1880 ()
1255} 1881}
1256 1882
1257sub init { 1883sub init {
1258 my ($self) = @_; 1884 my ($self) = @_;
1273 1899
1274# the original (read-only) location 1900# the original (read-only) location
1275sub load_path { 1901sub load_path {
1276 my ($self) = @_; 1902 my ($self) = @_;
1277 1903
1278 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1904 "$MAPDIR/$self->{path}.map"
1279} 1905}
1280 1906
1281# the temporary/swap location 1907# the temporary/swap location
1282sub save_path { 1908sub save_path {
1283 my ($self) = @_; 1909 my ($self) = @_;
1284 1910
1285 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1911 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1912 "$TMPDIR/$path.map"
1287} 1913}
1288 1914
1289# the unique path, undef == no special unique path 1915# the unique path, undef == no special unique path
1290sub uniq_path { 1916sub uniq_path {
1291 my ($self) = @_; 1917 my ($self) = @_;
1292 1918
1293 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1919 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1920 "$UNIQUEDIR/$path"
1295} 1921}
1296 1922
1297# and all this just because we cannot iterate over 1923# and all this just because we cannot iterate over
1298# all maps in C++... 1924# all maps in C++...
1299sub change_all_map_light { 1925sub change_all_map_light {
1301 1927
1302 $_->change_map_light ($change) 1928 $_->change_map_light ($change)
1303 for grep $_->outdoor, values %cf::MAP; 1929 for grep $_->outdoor, values %cf::MAP;
1304} 1930}
1305 1931
1932sub decay_objects {
1933 my ($self) = @_;
1934
1935 return if $self->{deny_reset};
1936
1937 $self->do_decay_objects;
1938}
1939
1306sub unlink_save { 1940sub unlink_save {
1307 my ($self) = @_; 1941 my ($self) = @_;
1308 1942
1309 utf8::encode (my $save = $self->save_path); 1943 utf8::encode (my $save = $self->save_path);
1310 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1944 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1945 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} 1946}
1318 1947
1319sub load_header_from($) { 1948sub load_header_from($) {
1320 my ($self, $path) = @_; 1949 my ($self, $path) = @_;
1321 1950
1322 utf8::encode $path; 1951 utf8::encode $path;
1323 #aio_open $path, O_RDONLY, 0 1952 my $f = new_from_file cf::object::thawer $path
1324 # or return;
1325
1326 $self->_load_header ($path)
1327 or return; 1953 or return;
1954
1955 $self->_load_header ($f)
1956 or return;
1957
1958 local $MAP_LOADING{$self->{path}} = $self;
1959 $f->resolve_delayed_derefs;
1328 1960
1329 $self->{load_path} = $path; 1961 $self->{load_path} = $path;
1330 1962
1331 1 1963 1
1332} 1964}
1371 $self->load_header_orig 2003 $self->load_header_orig
1372 or return; 2004 or return;
1373 $self->prepare_orig; 2005 $self->prepare_orig;
1374 } 2006 }
1375 2007
2008 $self->{deny_reset} = 1
2009 if $self->no_reset;
2010
2011 $self->default_region (cf::region::find_by_path $self->{path})
2012 unless $self->default_region;
2013
1376 1 2014 1
1377} 2015}
1378 2016
1379sub find; 2017sub find;
1380sub find { 2018sub find {
1381 my ($path, $origin) = @_; 2019 my ($path, $origin) = @_;
1382 2020
1383 $path = normalise $path, $origin && $origin->path; 2021 $path = normalise $path, $origin && $origin->path;
1384 2022
2023 cf::lock_wait "map_data:$path";#d#remove
1385 cf::lock_wait "map_find:$path"; 2024 cf::lock_wait "map_find:$path";
1386 2025
1387 $cf::MAP{$path} || do { 2026 $cf::MAP{$path} || do {
1388 my $guard = cf::lock_acquire "map_find:$path"; 2027 my $guard1 = cf::lock_acquire "map_find:$path";
2028 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
2029
1389 my $map = new_from_path cf::map $path 2030 my $map = new_from_path cf::map $path
1390 or return; 2031 or return;
1391 2032
1392 $map->{last_save} = $cf::RUNTIME; 2033 $map->{last_save} = $cf::RUNTIME;
1393 2034
1394 $map->load_header 2035 $map->load_header
1395 or return; 2036 or return;
1396 2037
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2038 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 2039 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 2040 #$cf::WAIT_FOR_TICK->wait;
2041 undef $guard1;
2042 undef $guard2;
1400 $map->reset; 2043 $map->reset;
1401 undef $guard;
1402 return find $path; 2044 return find $path;
1403 } 2045 }
1404 2046
1405 $cf::MAP{$path} = $map 2047 $cf::MAP{$path} = $map
1406 } 2048 }
1413 my ($self) = @_; 2055 my ($self) = @_;
1414 2056
1415 local $self->{deny_reset} = 1; # loading can take a long time 2057 local $self->{deny_reset} = 1; # loading can take a long time
1416 2058
1417 my $path = $self->{path}; 2059 my $path = $self->{path};
2060
2061 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 2062 my $guard = cf::lock_acquire "map_data:$path";
1419 2063
2064 return unless $self->valid;
1420 return if $self->in_memory != cf::MAP_SWAPPED; 2065 return unless $self->in_memory == cf::MAP_SWAPPED;
1421 2066
1422 $self->in_memory (cf::MAP_LOADING); 2067 $self->in_memory (cf::MAP_LOADING);
1423 2068
1424 $self->alloc; 2069 $self->alloc;
1425 2070
1426 $self->pre_load; 2071 $self->pre_load;
2072 cf::cede_to_tick;
1427 2073
1428 $self->_load_objects ($self->{load_path}, 1) 2074 my $f = new_from_file cf::object::thawer $self->{load_path};
2075 $f->skip_block;
2076 $self->_load_objects ($f)
1429 or return; 2077 or return;
1430 2078
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2079 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432 if delete $self->{load_original}; 2080 if delete $self->{load_original};
1433 2081
1434 if (my $uniq = $self->uniq_path) { 2082 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq; 2083 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) { 2084 unless (aio_stat $uniq) {
2085 if (my $f = new_from_file cf::object::thawer $uniq) {
1437 $self->clear_unique_items; 2086 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0); 2087 $self->_load_objects ($f);
2088 $f->resolve_delayed_derefs;
2089 }
1439 } 2090 }
1440 } 2091 }
1441 2092
1442 Coro::cede; 2093 $f->resolve_delayed_derefs;
1443 2094
2095 cf::cede_to_tick;
1444 # now do the right thing for maps 2096 # now do the right thing for maps
1445 $self->link_multipart_objects; 2097 $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) 2098 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 2099 unless $self->difficulty;
1455 Coro::cede; 2100 cf::cede_to_tick;
2101
2102 unless ($self->{deny_activate}) {
2103 $self->decay_objects;
2104 $self->fix_auto_apply;
2105 $self->update_buttons;
2106 cf::cede_to_tick;
2107 $self->set_darkness_map;
2108 cf::cede_to_tick;
1456 $self->activate; 2109 $self->activate;
2110 }
2111
2112 $self->{last_save} = $cf::RUNTIME;
2113 $self->last_access ($cf::RUNTIME);
2114
2115 $self->in_memory (cf::MAP_IN_MEMORY);
1457 } 2116 }
1458 2117
1459 $self->post_load; 2118 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 2119}
1463 2120
1464sub customise_for { 2121sub customise_for {
1465 my ($self, $ob) = @_; 2122 my ($self, $ob) = @_;
1466 2123
1467 return find "~" . $ob->name . "/" . $self->{path} 2124 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 2125 if $self->per_player;
1469 2126
2127# return find "?party/" . $ob->name . "/" . $self->{path}
2128# if $self->per_party;
2129
1470 $self 2130 $self
1471} 2131}
1472 2132
1473# find and load all maps in the 3x3 area around a map 2133# find and load all maps in the 3x3 area around a map
1474sub load_diag { 2134sub load_neighbours {
1475 my ($map) = @_; 2135 my ($map) = @_;
1476 2136
1477 my @diag; # diagonal neighbours 2137 my @neigh; # diagonal neighbours
1478 2138
1479 for (0 .. 3) { 2139 for (0 .. 3) {
1480 my $neigh = $map->tile_path ($_) 2140 my $neigh = $map->tile_path ($_)
1481 or next; 2141 or next;
1482 $neigh = find $neigh, $map 2142 $neigh = find $neigh, $map
1483 or next; 2143 or next;
1484 $neigh->load; 2144 $neigh->load;
1485 2145
2146 push @neigh,
1486 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2147 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1487 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2148 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1488 } 2149 }
1489 2150
1490 for (@diag) { 2151 for (grep defined $_->[0], @neigh) {
2152 my ($path, $origin) = @$_;
1491 my $neigh = find @$_ 2153 my $neigh = find $path, $origin
1492 or next; 2154 or next;
1493 $neigh->load; 2155 $neigh->load;
1494 } 2156 }
1495} 2157}
1496 2158
1501} 2163}
1502 2164
1503sub do_load_sync { 2165sub do_load_sync {
1504 my ($map) = @_; 2166 my ($map) = @_;
1505 2167
2168 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2169 if $Coro::current == $Coro::main;
2170
1506 cf::sync_job { $map->load }; 2171 cf::sync_job { $map->load };
1507} 2172}
1508 2173
1509our %MAP_PREFETCH; 2174our %MAP_PREFETCH;
1510our $MAP_PREFETCHER = undef; 2175our $MAP_PREFETCHER = undef;
1511 2176
1512sub find_async { 2177sub find_async {
1513 my ($path, $origin) = @_; 2178 my ($path, $origin, $load) = @_;
1514 2179
1515 $path = normalise $path, $origin && $origin->{path}; 2180 $path = normalise $path, $origin && $origin->{path};
1516 2181
1517 if (my $map = $cf::MAP{$path}) { 2182 if (my $map = $cf::MAP{$path}) {
1518 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2183 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1519 } 2184 }
1520 2185
1521 undef $MAP_PREFETCH{$path}; 2186 $MAP_PREFETCH{$path} |= $load;
2187
1522 $MAP_PREFETCHER ||= cf::async { 2188 $MAP_PREFETCHER ||= cf::async {
2189 $Coro::current->{desc} = "map prefetcher";
2190
1523 while (%MAP_PREFETCH) { 2191 while (%MAP_PREFETCH) {
1524 for my $path (keys %MAP_PREFETCH) { 2192 while (my ($k, $v) = each %MAP_PREFETCH) {
1525 my $map = find $path 2193 if (my $map = find $k) {
1526 or next;
1527 $map->load; 2194 $map->load if $v;
2195 }
1528 2196
1529 delete $MAP_PREFETCH{$path}; 2197 delete $MAP_PREFETCH{$k};
1530 } 2198 }
1531 } 2199 }
1532 undef $MAP_PREFETCHER; 2200 undef $MAP_PREFETCHER;
1533 }; 2201 };
1534 $MAP_PREFETCHER->prio (6); 2202 $MAP_PREFETCHER->prio (6);
1537} 2205}
1538 2206
1539sub save { 2207sub save {
1540 my ($self) = @_; 2208 my ($self) = @_;
1541 2209
1542 my $lock = cf::lock_acquire "map_data:" . $self->path; 2210 my $lock = cf::lock_acquire "map_data:$self->{path}";
1543 2211
1544 $self->{last_save} = $cf::RUNTIME; 2212 $self->{last_save} = $cf::RUNTIME;
1545 2213
1546 return unless $self->dirty; 2214 return unless $self->dirty;
1547 2215
1553 return if $self->{deny_save}; 2221 return if $self->{deny_save};
1554 2222
1555 local $self->{last_access} = $self->last_access;#d# 2223 local $self->{last_access} = $self->last_access;#d#
1556 2224
1557 cf::async { 2225 cf::async {
2226 $Coro::current->{desc} = "map player save";
1558 $_->contr->save for $self->players; 2227 $_->contr->save for $self->players;
1559 }; 2228 };
1560 2229
1561 if ($uniq) { 2230 if ($uniq) {
1562 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2231 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1570 my ($self) = @_; 2239 my ($self) = @_;
1571 2240
1572 # save first because save cedes 2241 # save first because save cedes
1573 $self->save; 2242 $self->save;
1574 2243
1575 my $lock = cf::lock_acquire "map_data:" . $self->path; 2244 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576 2245
1577 return if $self->players; 2246 return if $self->players;
1578 return if $self->in_memory != cf::MAP_IN_MEMORY; 2247 return if $self->in_memory != cf::MAP_IN_MEMORY;
1579 return if $self->{deny_save}; 2248 return if $self->{deny_save};
1580 2249
2250 $self->in_memory (cf::MAP_SWAPPED);
2251
2252 $self->deactivate;
2253 $_->clear_links_to ($self) for values %cf::MAP;
1581 $self->clear; 2254 $self->clear;
1582 $self->in_memory (cf::MAP_SWAPPED);
1583} 2255}
1584 2256
1585sub reset_at { 2257sub reset_at {
1586 my ($self) = @_; 2258 my ($self) = @_;
1587 2259
1588 # TODO: safety, remove and allow resettable per-player maps 2260 # 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}; 2261 return 1e99 if $self->{deny_reset};
1591 2262
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2263 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2264 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594 2265
1605 my ($self) = @_; 2276 my ($self) = @_;
1606 2277
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2278 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 2279
1609 return if $self->players; 2280 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 2281
1612 warn "resetting map ", $self->path;#d# 2282 warn "resetting map ", $self->path;
2283
2284 $self->in_memory (cf::MAP_SWAPPED);
2285
2286 # need to save uniques path
2287 unless ($self->{deny_save}) {
2288 my $uniq = $self->uniq_path; utf8::encode $uniq;
2289
2290 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2291 if $uniq;
2292 }
1613 2293
1614 delete $cf::MAP{$self->path}; 2294 delete $cf::MAP{$self->path};
1615 2295
1616 $self->in_memory (cf::MAP_SWAPPED); 2296 $self->deactivate;
2297 $_->clear_links_to ($self) for values %cf::MAP;
1617 $self->clear; 2298 $self->clear;
1618
1619 $_->clear_links_to ($self) for values %cf::MAP;
1620 2299
1621 $self->unlink_save; 2300 $self->unlink_save;
1622 $self->destroy; 2301 $self->destroy;
1623} 2302}
1624 2303
1625my $nuke_counter = "aaaa"; 2304my $nuke_counter = "aaaa";
1626 2305
1627sub nuke { 2306sub nuke {
1628 my ($self) = @_; 2307 my ($self) = @_;
1629 2308
2309 {
2310 my $lock = cf::lock_acquire "map_data:$self->{path}";
2311
1630 delete $cf::MAP{$self->path}; 2312 delete $cf::MAP{$self->path};
1631 2313
1632 $self->unlink_save; 2314 $self->unlink_save;
1633 2315
1634 bless $self, "cf::map"; 2316 bless $self, "cf::map";
1635 delete $self->{deny_reset}; 2317 delete $self->{deny_reset};
1636 $self->{deny_save} = 1; 2318 $self->{deny_save} = 1;
1637 $self->reset_timeout (1); 2319 $self->reset_timeout (1);
1638 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2320 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1639 2321
1640 $cf::MAP{$self->path} = $self; 2322 $cf::MAP{$self->path} = $self;
2323 }
1641 2324
1642 $self->reset; # polite request, might not happen 2325 $self->reset; # polite request, might not happen
2326}
2327
2328=item $maps = cf::map::tmp_maps
2329
2330Returns an arrayref with all map paths of currently instantiated and saved
2331maps. May block.
2332
2333=cut
2334
2335sub tmp_maps() {
2336 [
2337 map {
2338 utf8::decode $_;
2339 /\.map$/
2340 ? normalise $_
2341 : ()
2342 } @{ aio_readdir $TMPDIR or [] }
2343 ]
2344}
2345
2346=item $maps = cf::map::random_maps
2347
2348Returns an arrayref with all map paths of currently instantiated and saved
2349random maps. May block.
2350
2351=cut
2352
2353sub random_maps() {
2354 [
2355 map {
2356 utf8::decode $_;
2357 /\.map$/
2358 ? normalise "?random/$_"
2359 : ()
2360 } @{ aio_readdir $RANDOMDIR or [] }
2361 ]
1643} 2362}
1644 2363
1645=item cf::map::unique_maps 2364=item cf::map::unique_maps
1646 2365
1647Returns an arrayref of paths of all shared maps that have 2366Returns an arrayref of paths of all shared maps that have
1648instantiated unique items. May block. 2367instantiated unique items. May block.
1649 2368
1650=cut 2369=cut
1651 2370
1652sub unique_maps() { 2371sub unique_maps() {
1653 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2372 [
1654 or return; 2373 map {
1655
1656 my @paths;
1657
1658 for (@$files) {
1659 utf8::decode $_; 2374 utf8::decode $_;
1660 next if /\.pst$/; 2375 /\.map$/
1661 next unless /^$PATH_SEP/o; 2376 ? normalise $_
1662 2377 : ()
1663 push @paths, cf::map::normalise $_; 2378 } @{ aio_readdir $UNIQUEDIR or [] }
1664 } 2379 ]
1665
1666 \@paths
1667} 2380}
1668
1669package cf;
1670 2381
1671=back 2382=back
1672 2383
1673=head3 cf::object 2384=head3 cf::object
1674 2385
1689 map { $_, inv_recursive_ $_->inv } @_ 2400 map { $_, inv_recursive_ $_->inv } @_
1690} 2401}
1691 2402
1692sub inv_recursive { 2403sub inv_recursive {
1693 inv_recursive_ inv $_[0] 2404 inv_recursive_ inv $_[0]
2405}
2406
2407=item $ref = $ob->ref
2408
2409creates and returns a persistent reference to an objetc that can be stored as a string.
2410
2411=item $ob = cf::object::deref ($refstring)
2412
2413returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2414even if the object actually exists. May block.
2415
2416=cut
2417
2418sub deref {
2419 my ($ref) = @_;
2420
2421 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2422 my ($uuid, $name) = ($1, $2);
2423 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2424 or return;
2425 $pl->ob->uuid eq $uuid
2426 or return;
2427
2428 $pl->ob
2429 } else {
2430 warn "$ref: cannot resolve object reference\n";
2431 undef
2432 }
1694} 2433}
1695 2434
1696package cf; 2435package cf;
1697 2436
1698=back 2437=back
1717 2456
1718 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2457 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1719 2458
1720 if ($self->{record_replies}) { 2459 if ($self->{record_replies}) {
1721 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2460 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2461
1722 } else { 2462 } else {
2463 my $pl = $self->contr;
2464
2465 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2466 my $dialog = $pl->{npc_dialog};
2467 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2468
2469 } else {
1723 $msg = $npc->name . " says: $msg" if $npc; 2470 $msg = $npc->name . " says: $msg" if $npc;
1724 $self->message ($msg, $flags); 2471 $self->message ($msg, $flags);
2472 }
1725 } 2473 }
2474}
2475
2476=item $object->send_msg ($channel, $msg, $color, [extra...])
2477
2478=cut
2479
2480sub cf::object::send_msg {
2481 my $pl = shift->contr
2482 or return;
2483 $pl->send_msg (@_);
1726} 2484}
1727 2485
1728=item $player_object->may ("access") 2486=item $player_object->may ("access")
1729 2487
1730Returns wether the given player is authorized to access resource "access" 2488Returns wether the given player is authorized to access resource "access"
1777 $self->deactivate_recursive; 2535 $self->deactivate_recursive;
1778 2536
1779 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2537 return if UNIVERSAL::isa $self->map, "ext::map_link";
1780 2538
1781 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2539 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1782 if $self->map; 2540 if $self->map && $self->map->{path} ne "{link}";
1783 2541
1784 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2542 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1785} 2543}
1786 2544
1787sub cf::object::player::leave_link { 2545sub cf::object::player::leave_link {
1788 my ($self, $map, $x, $y) = @_; 2546 my ($self, $map, $x, $y) = @_;
2547
2548 return unless $self->contr->active;
1789 2549
1790 my $link_pos = delete $self->{_link_pos}; 2550 my $link_pos = delete $self->{_link_pos};
1791 2551
1792 unless ($map) { 2552 unless ($map) {
1793 # restore original map position 2553 # restore original map position
1807 # use -1 or undef as default coordinates, not 0, 0 2567 # use -1 or undef as default coordinates, not 0, 0
1808 ($x, $y) = ($map->enter_x, $map->enter_y) 2568 ($x, $y) = ($map->enter_x, $map->enter_y)
1809 if $x <=0 && $y <= 0; 2569 if $x <=0 && $y <= 0;
1810 2570
1811 $map->load; 2571 $map->load;
1812 $map->load_diag; 2572 $map->load_neighbours;
1813 2573
1814 return unless $self->contr->active; 2574 return unless $self->contr->active;
1815 $self->activate_recursive; 2575 $self->activate_recursive;
2576
2577 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1816 $self->enter_map ($map, $x, $y); 2578 $self->enter_map ($map, $x, $y);
1817} 2579}
1818 2580
1819cf::player->attach ( 2581=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1820 on_logout => sub {
1821 my ($pl) = @_;
1822 2582
1823 # abort map switching before logout 2583Moves the player to the given map-path and coordinates by first freezing
1824 if ($pl->ob->{_link_pos}) { 2584her, loading and preparing them map, calling the provided $check callback
1825 cf::sync_job { 2585that has to return the map if sucecssful, and then unfreezes the player on
1826 $pl->ob->leave_link 2586the new (success) or old (failed) map position. In either case, $done will
1827 }; 2587be called at the end of this process.
1828 }
1829 },
1830 on_login => sub {
1831 my ($pl) = @_;
1832 2588
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 2589=cut
2590
2591our $GOTOGEN;
1854 2592
1855sub cf::object::player::goto { 2593sub cf::object::player::goto {
1856 my ($self, $path, $x, $y) = @_; 2594 my ($self, $path, $x, $y, $check, $done) = @_;
2595
2596 # do generation counting so two concurrent goto's will be executed in-order
2597 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1857 2598
1858 $self->enter_link; 2599 $self->enter_link;
1859 2600
1860 (async { 2601 (async {
2602 $Coro::current->{desc} = "player::goto $path $x $y";
2603
2604 # *tag paths override both path and x|y
2605 if ($path =~ /^\*(.*)$/) {
2606 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2607 my $ob = $obs[rand @obs];
2608
2609 # see if we actually can go there
2610 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2611 $ob = $obs[rand @obs];
2612 } else {
2613 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2614 }
2615 # else put us there anyways for now #d#
2616
2617 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2618 } else {
2619 ($path, $x, $y) = (undef, undef, undef);
2620 }
2621 }
2622
1861 my $map = eval { 2623 my $map = eval {
1862 my $map = cf::map::find $path; 2624 my $map = defined $path ? cf::map::find $path : undef;
2625
2626 if ($map) {
1863 $map = $map->customise_for ($self) if $map; 2627 $map = $map->customise_for ($self);
2628 $map = $check->($map) if $check && $map;
2629 } else {
2630 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2631 }
2632
1864 $map 2633 $map
2634 };
2635
2636 if ($@) {
2637 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2638 LOG llevError | logBacktrace, Carp::longmess $@;
1865 } or 2639 }
1866 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1867 2640
2641 if ($gen == $self->{_goto_generation}) {
2642 delete $self->{_goto_generation};
1868 $self->leave_link ($map, $x, $y); 2643 $self->leave_link ($map, $x, $y);
2644 }
2645
2646 $done->() if $done;
1869 })->prio (1); 2647 })->prio (1);
1870} 2648}
1871 2649
1872=item $player_object->enter_exit ($exit_object) 2650=item $player_object->enter_exit ($exit_object)
1873 2651
1910 $rmp->{origin_y} = $exit->y; 2688 $rmp->{origin_y} = $exit->y;
1911 } 2689 }
1912 2690
1913 $rmp->{random_seed} ||= $exit->random_seed; 2691 $rmp->{random_seed} ||= $exit->random_seed;
1914 2692
1915 my $data = cf::to_json $rmp; 2693 my $data = cf::encode_json $rmp;
1916 my $md5 = Digest::MD5::md5_hex $data; 2694 my $md5 = Digest::MD5::md5_hex $data;
1917 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2695 my $meta = "$RANDOMDIR/$md5.meta";
1918 2696
1919 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2697 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1920 aio_write $fh, 0, (length $data), $data, 0; 2698 aio_write $fh, 0, (length $data), $data, 0;
1921 undef $fh; 2699 undef $fh;
1922 aio_rename "$meta~", $meta; 2700 aio_rename "$meta~", $meta;
1931 2709
1932 return unless $self->type == cf::PLAYER; 2710 return unless $self->type == cf::PLAYER;
1933 2711
1934 if ($exit->slaying eq "/!") { 2712 if ($exit->slaying eq "/!") {
1935 #TODO: this should de-fi-ni-te-ly not be a sync-job 2713 #TODO: this should de-fi-ni-te-ly not be a sync-job
2714 # the problem is that $exit might not survive long enough
2715 # so it needs to be done right now, right here
1936 cf::sync_job { prepare_random_map $exit }; 2716 cf::sync_job { prepare_random_map $exit };
1937 } 2717 }
1938 2718
1939 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2719 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1940 my $hp = $exit->stats->hp; 2720 my $hp = $exit->stats->hp;
1941 my $sp = $exit->stats->sp; 2721 my $sp = $exit->stats->sp;
1942 2722
1943 $self->enter_link; 2723 $self->enter_link;
1944 2724
2725 # if exit is damned, update players death & WoR home-position
2726 $self->contr->savebed ($slaying, $hp, $sp)
2727 if $exit->flag (FLAG_DAMNED);
2728
1945 (async { 2729 (async {
2730 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2731
1946 $self->deactivate_recursive; # just to be sure 2732 $self->deactivate_recursive; # just to be sure
1947 unless (eval { 2733 unless (eval {
1948 $self->goto ($slaying, $hp, $sp); 2734 $self->goto ($slaying, $hp, $sp);
1949 2735
1950 1; 2736 1;
1951 }) { 2737 }) {
1952 $self->message ("Something went wrong deep within the crossfire server. " 2738 $self->message ("Something went wrong deep within the crossfire server. "
1953 . "I'll try to bring you back to the map you were before. " 2739 . "I'll try to bring you back to the map you were before. "
1954 . "Please report this to the dungeon master!", 2740 . "Please report this to the dungeon master!",
1955 cf::NDI_UNIQUE | cf::NDI_RED); 2741 cf::NDI_UNIQUE | cf::NDI_RED);
1956 2742
1957 warn "ERROR in enter_exit: $@"; 2743 warn "ERROR in enter_exit: $@";
1958 $self->leave_link; 2744 $self->leave_link;
1959 } 2745 }
1960 })->prio (1); 2746 })->prio (1);
1973 2759
1974sub cf::client::send_drawinfo { 2760sub cf::client::send_drawinfo {
1975 my ($self, $text, $flags) = @_; 2761 my ($self, $text, $flags) = @_;
1976 2762
1977 utf8::encode $text; 2763 utf8::encode $text;
1978 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2764 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1979} 2765}
1980 2766
2767=item $client->send_msg ($channel, $msg, $color, [extra...])
2768
2769Send a drawinfo or msg packet to the client, formatting the msg for the
2770client if neccessary. C<$type> should be a string identifying the type of
2771the message, with C<log> being the default. If C<$color> is negative, suppress
2772the message unless the client supports the msg packet.
2773
2774=cut
2775
2776# non-persistent channels (usually the info channel)
2777our %CHANNEL = (
2778 "c/identify" => {
2779 id => "infobox",
2780 title => "Identify",
2781 reply => undef,
2782 tooltip => "Items recently identified",
2783 },
2784 "c/examine" => {
2785 id => "infobox",
2786 title => "Examine",
2787 reply => undef,
2788 tooltip => "Signs and other items you examined",
2789 },
2790 "c/book" => {
2791 id => "infobox",
2792 title => "Book",
2793 reply => undef,
2794 tooltip => "The contents of a note or book",
2795 },
2796 "c/lookat" => {
2797 id => "infobox",
2798 title => "Look",
2799 reply => undef,
2800 tooltip => "What you saw there",
2801 },
2802 "c/who" => {
2803 id => "infobox",
2804 title => "Players",
2805 reply => undef,
2806 tooltip => "Shows players who are currently online",
2807 },
2808 "c/body" => {
2809 id => "infobox",
2810 title => "Body Parts",
2811 reply => undef,
2812 tooltip => "Shows which body parts you posess and are available",
2813 },
2814 "c/uptime" => {
2815 id => "infobox",
2816 title => "Uptime",
2817 reply => undef,
2818 tooltip => "How long the server has been running since last restart",
2819 },
2820 "c/mapinfo" => {
2821 id => "infobox",
2822 title => "Map Info",
2823 reply => undef,
2824 tooltip => "Information related to the maps",
2825 },
2826);
2827
2828sub cf::client::send_msg {
2829 my ($self, $channel, $msg, $color, @extra) = @_;
2830
2831 $msg = $self->pl->expand_cfpod ($msg);
2832
2833 $color &= cf::NDI_CLIENT_MASK; # just in case...
2834
2835 # check predefined channels, for the benefit of C
2836 if ($CHANNEL{$channel}) {
2837 $channel = $CHANNEL{$channel};
2838
2839 $self->ext_msg (channel_info => $channel)
2840 if $self->can_msg;
2841
2842 $channel = $channel->{id};
2843
2844 } elsif (ref $channel) {
2845 # send meta info to client, if not yet sent
2846 unless (exists $self->{channel}{$channel->{id}}) {
2847 $self->{channel}{$channel->{id}} = $channel;
2848 $self->ext_msg (channel_info => $channel)
2849 if $self->can_msg;
2850 }
2851
2852 $channel = $channel->{id};
2853 }
2854
2855 return unless @extra || length $msg;
2856
2857 if ($self->can_msg) {
2858 # default colour, mask it out
2859 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2860 if $color & cf::NDI_DEF;
2861
2862 $self->send_packet ("msg " . $self->{json_coder}->encode (
2863 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2864 } else {
2865 if ($color >= 0) {
2866 # replace some tags by gcfclient-compatible ones
2867 for ($msg) {
2868 1 while
2869 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2870 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2871 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2872 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2873 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2874 }
2875
2876 $color &= cf::NDI_COLOR_MASK;
2877
2878 utf8::encode $msg;
2879
2880 if (0 && $msg =~ /\[/) {
2881 # COMMAND/INFO
2882 $self->send_packet ("drawextinfo $color 10 8 $msg")
2883 } else {
2884 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2885 $self->send_packet ("drawinfo $color $msg")
2886 }
2887 }
2888 }
2889}
2890
2891=item $client->ext_msg ($type, @msg)
2892
2893Sends an ext event to the client.
2894
2895=cut
2896
2897sub cf::client::ext_msg($$@) {
2898 my ($self, $type, @msg) = @_;
2899
2900 if ($self->extcmd == 2) {
2901 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2902 } elsif ($self->extcmd == 1) { # TODO: remove
2903 push @msg, msgtype => "event_$type";
2904 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2905 }
2906}
2907
2908=item $client->ext_reply ($msgid, @msg)
2909
2910Sends an ext reply to the client.
2911
2912=cut
2913
2914sub cf::client::ext_reply($$@) {
2915 my ($self, $id, @msg) = @_;
2916
2917 if ($self->extcmd == 2) {
2918 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2919 } elsif ($self->extcmd == 1) {
2920 #TODO: version 1, remove
2921 unshift @msg, msgtype => "reply", msgid => $id;
2922 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2923 }
2924}
1981 2925
1982=item $success = $client->query ($flags, "text", \&cb) 2926=item $success = $client->query ($flags, "text", \&cb)
1983 2927
1984Queues a query to the client, calling the given callback with 2928Queues a query to the client, calling the given callback with
1985the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2929the 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>. 2930C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1987 2931
1988Queries can fail, so check the return code. Or don't, as queries will become 2932Queries can fail, so check the return code. Or don't, as queries will
1989reliable at some point in the future. 2933become reliable at some point in the future.
1990 2934
1991=cut 2935=cut
1992 2936
1993sub cf::client::query { 2937sub cf::client::query {
1994 my ($self, $flags, $text, $cb) = @_; 2938 my ($self, $flags, $text, $cb) = @_;
2002 utf8::encode $text; 2946 utf8::encode $text;
2003 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2947 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2004 2948
2005 $self->send_packet ($self->{query_queue}[0][0]) 2949 $self->send_packet ($self->{query_queue}[0][0])
2006 if @{ $self->{query_queue} } == 1; 2950 if @{ $self->{query_queue} } == 1;
2951
2952 1
2007} 2953}
2008 2954
2009cf::client->attach ( 2955cf::client->attach (
2956 on_connect => sub {
2957 my ($ns) = @_;
2958
2959 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2960 },
2010 on_reply => sub { 2961 on_reply => sub {
2011 my ($ns, $msg) = @_; 2962 my ($ns, $msg) = @_;
2012 2963
2013 # this weird shuffling is so that direct followup queries 2964 # this weird shuffling is so that direct followup queries
2014 # get handled first 2965 # get handled first
2026 } else { 2977 } else {
2027 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2978 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2028 } 2979 }
2029 } 2980 }
2030 }, 2981 },
2982 on_exticmd => sub {
2983 my ($ns, $buf) = @_;
2984
2985 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2986
2987 if (ref $msg) {
2988 my ($type, $reply, @payload) =
2989 "ARRAY" eq ref $msg
2990 ? @$msg
2991 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2992
2993 my @reply;
2994
2995 if (my $cb = $EXTICMD{$type}) {
2996 @reply = $cb->($ns, @payload);
2997 }
2998
2999 $ns->ext_reply ($reply, @reply)
3000 if $reply;
3001
3002 } else {
3003 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3004 }
3005
3006 cf::override;
3007 },
2031); 3008);
2032 3009
2033=item $client->async (\&cb) 3010=item $client->async (\&cb)
2034 3011
2035Create a new coroutine, running the specified callback. The coroutine will 3012Create a new coroutine, running the specified callback. The coroutine will
2076our $safe = new Safe "safe"; 3053our $safe = new Safe "safe";
2077our $safe_hole = new Safe::Hole; 3054our $safe_hole = new Safe::Hole;
2078 3055
2079$SIG{FPE} = 'IGNORE'; 3056$SIG{FPE} = 'IGNORE';
2080 3057
2081$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3058$safe->permit_only (Opcode::opset qw(
3059 :base_core :base_mem :base_orig :base_math
3060 grepstart grepwhile mapstart mapwhile
3061 sort time
3062));
2082 3063
2083# here we export the classes and methods available to script code 3064# here we export the classes and methods available to script code
2084 3065
2085=pod 3066=pod
2086 3067
2087The following fucntions and emthods are available within a safe environment: 3068The following functions and methods are available within a safe environment:
2088 3069
2089 cf::object contr pay_amount pay_player map 3070 cf::object
3071 contr pay_amount pay_player map x y force_find force_add destroy
3072 insert remove name archname title slaying race decrease_ob_nr
3073
2090 cf::object::player player 3074 cf::object::player
2091 cf::player peaceful 3075 player
2092 cf::map trigger 3076
3077 cf::player
3078 peaceful
3079
3080 cf::map
3081 trigger
2093 3082
2094=cut 3083=cut
2095 3084
2096for ( 3085for (
2097 ["cf::object" => qw(contr pay_amount pay_player map)], 3086 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3087 insert remove inv name archname title slaying race
3088 decrease_ob_nr destroy)],
2098 ["cf::object::player" => qw(player)], 3089 ["cf::object::player" => qw(player)],
2099 ["cf::player" => qw(peaceful)], 3090 ["cf::player" => qw(peaceful)],
2100 ["cf::map" => qw(trigger)], 3091 ["cf::map" => qw(trigger)],
2101) { 3092) {
2102 no strict 'refs'; 3093 no strict 'refs';
2173=back 3164=back
2174 3165
2175=cut 3166=cut
2176 3167
2177############################################################################# 3168#############################################################################
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 3169# the server's init and main functions
2251 3170
2252sub load_resources { 3171sub load_facedata($) {
2253 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 3172 my ($path) = @_;
3173
3174 # HACK to clear player env face cache, we need some signal framework
3175 # for this (global event?)
3176 %ext::player_env::MUSIC_FACE_CACHE = ();
3177
3178 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3179
3180 warn "loading facedata from $path\n";
3181
3182 my $facedata;
3183 0 < aio_load $path, $facedata
3184 or die "$path: $!";
3185
3186 $facedata = Coro::Storable::thaw $facedata;
3187
3188 $facedata->{version} == 2
3189 or cf::cleanup "$path: version mismatch, cannot proceed.";
3190
3191 # patch in the exptable
3192 $facedata->{resource}{"res/exp_table"} = {
3193 type => FT_RSRC,
3194 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
3195 };
3196 cf::cede_to_tick;
3197
3198 {
3199 my $faces = $facedata->{faceinfo};
3200
3201 while (my ($face, $info) = each %$faces) {
3202 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3203
3204 cf::face::set_visibility $idx, $info->{visibility};
3205 cf::face::set_magicmap $idx, $info->{magicmap};
3206 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
3207 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
3208
3209 cf::cede_to_tick;
3210 }
3211
3212 while (my ($face, $info) = each %$faces) {
3213 next unless $info->{smooth};
3214
3215 my $idx = cf::face::find $face
3216 or next;
3217
3218 if (my $smooth = cf::face::find $info->{smooth}) {
3219 cf::face::set_smooth $idx, $smooth;
3220 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3221 } else {
3222 warn "smooth face '$info->{smooth}' not found for face '$face'";
3223 }
3224
3225 cf::cede_to_tick;
3226 }
3227 }
3228
3229 {
3230 my $anims = $facedata->{animinfo};
3231
3232 while (my ($anim, $info) = each %$anims) {
3233 cf::anim::set $anim, $info->{frames}, $info->{facings};
3234 cf::cede_to_tick;
3235 }
3236
3237 cf::anim::invalidate_all; # d'oh
3238 }
3239
3240 {
3241 # TODO: for gcfclient pleasure, we should give resources
3242 # that gcfclient doesn't grok a >10000 face index.
3243 my $res = $facedata->{resource};
3244
3245 while (my ($name, $info) = each %$res) {
3246 if (defined $info->{type}) {
3247 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3248 my $data;
3249
3250 if ($info->{type} & 1) {
3251 # prepend meta info
3252
3253 my $meta = $enc->encode ({
3254 name => $name,
3255 %{ $info->{meta} || {} },
3256 });
3257
3258 $data = pack "(w/a*)*", $meta, $info->{data};
3259 } else {
3260 $data = $info->{data};
3261 }
3262
3263 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3264 cf::face::set_type $idx, $info->{type};
3265 } else {
3266 $RESOURCE{$name} = $info;
3267 }
3268
3269 cf::cede_to_tick;
3270 }
3271 }
3272
3273 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3274
3275 1
3276}
3277
3278cf::global->attach (on_resource_update => sub {
3279 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3280 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3281
3282 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3283 my $sound = $soundconf->{compat}[$_]
3284 or next;
3285
3286 my $face = cf::face::find "sound/$sound->[1]";
3287 cf::sound::set $sound->[0] => $face;
3288 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3289 }
3290
3291 while (my ($k, $v) = each %{$soundconf->{event}}) {
3292 my $face = cf::face::find "sound/$v";
3293 cf::sound::set $k => $face;
3294 }
3295 }
3296});
3297
3298register_exticmd fx_want => sub {
3299 my ($ns, $want) = @_;
3300
3301 while (my ($k, $v) = each %$want) {
3302 $ns->fx_want ($k, $v);
3303 }
3304};
3305
3306sub reload_regions {
3307 # HACK to clear player env face cache, we need some signal framework
3308 # for this (global event?)
3309 %ext::player_env::MUSIC_FACE_CACHE = ();
3310
3311 load_resource_file "$MAPDIR/regions"
2254 or die "unable to load regions file\n";#d# 3312 or die "unable to load regions file\n";
2255}
2256 3313
2257sub cfg_load { 3314 for (cf::region::list) {
3315 $_->{match} = qr/$_->{match}/
3316 if exists $_->{match};
3317 }
3318}
3319
3320sub reload_facedata {
3321 load_facedata "$DATADIR/facedata"
3322 or die "unable to load facedata\n";
3323}
3324
3325sub reload_archetypes {
3326 load_resource_file "$DATADIR/archetypes"
3327 or die "unable to load archetypes\n";
3328 #d# NEED to laod twice to resolve forward references
3329 # this really needs to be done in an extra post-pass
3330 # (which needs to be synchronous, so solve it differently)
3331 load_resource_file "$DATADIR/archetypes"
3332 or die "unable to load archetypes\n";
3333}
3334
3335sub reload_treasures {
3336 load_resource_file "$DATADIR/treasures"
3337 or die "unable to load treasurelists\n";
3338}
3339
3340sub reload_resources {
3341 warn "reloading resource files...\n";
3342
3343 reload_regions;
3344 reload_facedata;
3345 #reload_archetypes;#d#
3346 reload_archetypes;
3347 reload_treasures;
3348
3349 warn "finished reloading resource files\n";
3350}
3351
3352sub init {
3353 reload_resources;
3354}
3355
3356sub reload_config {
2258 open my $fh, "<:utf8", cf::confdir . "/config" 3357 open my $fh, "<:utf8", "$CONFDIR/config"
2259 or return; 3358 or return;
2260 3359
2261 local $/; 3360 local $/;
2262 *CFG = YAML::Syck::Load <$fh>; 3361 *CFG = YAML::Load <$fh>;
2263 3362
2264 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3363 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2265 3364
2266 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3365 $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}; 3366 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2273 }; 3372 };
2274 warn $@ if $@; 3373 warn $@ if $@;
2275 } 3374 }
2276} 3375}
2277 3376
2278sub init {
2279 load_resources;
2280}
2281
2282sub main { 3377sub main {
2283 # we must not ever block the main coroutine 3378 # we must not ever block the main coroutine
2284 local $Coro::idle = sub { 3379 local $Coro::idle = sub {
2285 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3380 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2286 (async { 3381 (async {
2287 Event::one_event; 3382 $Coro::current->{desc} = "IDLE BUG HANDLER";
3383 EV::loop EV::LOOP_ONESHOT;
2288 })->prio (Coro::PRIO_MAX); 3384 })->prio (Coro::PRIO_MAX);
2289 }; 3385 };
2290 3386
2291 cfg_load; 3387 reload_config;
2292 db_load; 3388 db_init;
2293 load_extensions; 3389 load_extensions;
2294 3390
2295 $TICK_WATCHER->start; 3391 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3392 evthread_start IO::AIO::poll_fileno;
2296 Event::loop; 3393 EV::loop;
2297} 3394}
2298 3395
2299############################################################################# 3396#############################################################################
2300# initialisation and cleanup 3397# initialisation and cleanup
2301 3398
2302# install some emergency cleanup handlers 3399# install some emergency cleanup handlers
2303BEGIN { 3400BEGIN {
3401 our %SIGWATCHER = ();
2304 for my $signal (qw(INT HUP TERM)) { 3402 for my $signal (qw(INT HUP TERM)) {
2305 Event->signal ( 3403 $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"; 3404 cf::cleanup "SIG$signal";
2312 },
2313 ); 3405 };
3406 }
3407}
3408
3409sub write_runtime {
3410 my $runtime = "$LOCALDIR/runtime";
3411
3412 # first touch the runtime file to show we are still running:
3413 # the fsync below can take a very very long time.
3414
3415 IO::AIO::aio_utime $runtime, undef, undef;
3416
3417 my $guard = cf::lock_acquire "write_runtime";
3418
3419 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3420 or return;
3421
3422 my $value = $cf::RUNTIME + 90 + 10;
3423 # 10 is the runtime save interval, for a monotonic clock
3424 # 60 allows for the watchdog to kill the server.
3425
3426 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3427 and return;
3428
3429 # always fsync - this file is important
3430 aio_fsync $fh
3431 and return;
3432
3433 # touch it again to show we are up-to-date
3434 aio_utime $fh, undef, undef;
3435
3436 close $fh
3437 or return;
3438
3439 aio_rename "$runtime~", $runtime
3440 and return;
3441
3442 warn "runtime file written.\n";
3443
2314 } 3444 1
3445}
3446
3447our $uuid_lock;
3448our $uuid_skip;
3449
3450sub write_uuid_sync($) {
3451 $uuid_skip ||= $_[0];
3452
3453 return if $uuid_lock;
3454 local $uuid_lock = 1;
3455
3456 my $uuid = "$LOCALDIR/uuid";
3457
3458 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3459 or return;
3460
3461 my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
3462 $uuid_skip = 0;
3463
3464 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3465 and return;
3466
3467 # always fsync - this file is important
3468 aio_fsync $fh
3469 and return;
3470
3471 close $fh
3472 or return;
3473
3474 aio_rename "$uuid~", $uuid
3475 and return;
3476
3477 warn "uuid file written ($value).\n";
3478
3479 1
3480
3481}
3482
3483sub write_uuid($$) {
3484 my ($skip, $sync) = @_;
3485
3486 $sync ? write_uuid_sync $skip
3487 : async { write_uuid_sync $skip };
2315} 3488}
2316 3489
2317sub emergency_save() { 3490sub emergency_save() {
2318 my $freeze_guard = cf::freeze_mainloop; 3491 my $freeze_guard = cf::freeze_mainloop;
2319 3492
2325 # and maps saved/destroyed asynchronously. 3498 # and maps saved/destroyed asynchronously.
2326 warn "begin emergency player save\n"; 3499 warn "begin emergency player save\n";
2327 for my $login (keys %cf::PLAYER) { 3500 for my $login (keys %cf::PLAYER) {
2328 my $pl = $cf::PLAYER{$login} or next; 3501 my $pl = $cf::PLAYER{$login} or next;
2329 $pl->valid or next; 3502 $pl->valid or next;
3503 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2330 $pl->save; 3504 $pl->save;
2331 } 3505 }
2332 warn "end emergency player save\n"; 3506 warn "end emergency player save\n";
2333 3507
2334 warn "begin emergency map save\n"; 3508 warn "begin emergency map save\n";
2340 warn "end emergency map save\n"; 3514 warn "end emergency map save\n";
2341 3515
2342 warn "begin emergency database checkpoint\n"; 3516 warn "begin emergency database checkpoint\n";
2343 BDB::db_env_txn_checkpoint $DB_ENV; 3517 BDB::db_env_txn_checkpoint $DB_ENV;
2344 warn "end emergency database checkpoint\n"; 3518 warn "end emergency database checkpoint\n";
3519
3520 warn "begin write uuid\n";
3521 write_uuid_sync 1;
3522 warn "end write uuid\n";
2345 }; 3523 };
2346 3524
2347 warn "leave emergency perl save\n"; 3525 warn "leave emergency perl save\n";
2348} 3526}
2349 3527
3528sub post_cleanup {
3529 my ($make_core) = @_;
3530
3531 warn Carp::longmess "post_cleanup backtrace"
3532 if $make_core;
3533}
3534
2350sub reload() { 3535sub do_reload_perl() {
2351 # can/must only be called in main 3536 # can/must only be called in main
2352 if ($Coro::current != $Coro::main) { 3537 if ($Coro::current != $Coro::main) {
2353 warn "can only reload from main coroutine"; 3538 warn "can only reload from main coroutine";
2354 return; 3539 return;
2355 } 3540 }
2356 3541
2357 warn "reloading..."; 3542 warn "reloading...";
2358 3543
2359 warn "cancelling server ticker"; 3544 warn "entering sync_job";
2360 $TICK_WATCHER->cancel;
2361 3545
3546 cf::sync_job {
3547 cf::write_runtime; # external watchdog should not bark
2362 cf::emergency_save; 3548 cf::emergency_save;
3549 cf::write_runtime; # external watchdog should not bark
2363 3550
2364 eval { 3551 warn "syncing database to disk";
3552 BDB::db_env_txn_checkpoint $DB_ENV;
3553
2365 # if anything goes wrong in here, we should simply crash as we already saved 3554 # 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 3555
2375 warn "flushing outstanding aio requests"; 3556 warn "flushing outstanding aio requests";
2376 for (;;) { 3557 for (;;) {
2377 BDB::flush; 3558 BDB::flush;
2378 IO::AIO::flush; 3559 IO::AIO::flush;
2379 Coro::cede; 3560 Coro::cede_notself;
2380 last unless IO::AIO::nreqs || BDB::nreqs; 3561 last unless IO::AIO::nreqs || BDB::nreqs;
2381 warn "iterate..."; 3562 warn "iterate...";
2382 } 3563 }
3564
3565 ++$RELOAD;
2383 3566
2384 warn "cancelling all extension coros"; 3567 warn "cancelling all extension coros";
2385 $_->cancel for values %EXT_CORO; 3568 $_->cancel for values %EXT_CORO;
2386 %EXT_CORO = (); 3569 %EXT_CORO = ();
2387 3570
2388 warn "removing commands"; 3571 warn "removing commands";
2389 %COMMAND = (); 3572 %COMMAND = ();
2390 3573
2391 warn "removing ext commands"; 3574 warn "removing ext/exti commands";
2392 %EXTCMD = (); 3575 %EXTCMD = ();
3576 %EXTICMD = ();
2393 3577
2394 warn "unloading/nuking all extensions"; 3578 warn "unloading/nuking all extensions";
2395 for my $pkg (@EXTS) { 3579 for my $pkg (@EXTS) {
2396 warn "... unloading $pkg"; 3580 warn "... unloading $pkg";
2397 3581
2427 Symbol::delete_package "safe::$_" 3611 Symbol::delete_package "safe::$_"
2428 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3612 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2429 3613
2430 warn "unloading cf.pm \"a bit\""; 3614 warn "unloading cf.pm \"a bit\"";
2431 delete $INC{"cf.pm"}; 3615 delete $INC{"cf.pm"};
3616 delete $INC{"cf/pod.pm"};
2432 3617
2433 # don't, removes xs symbols, too, 3618 # don't, removes xs symbols, too,
2434 # and global variables created in xs 3619 # and global variables created in xs
2435 #Symbol::delete_package __PACKAGE__; 3620 #Symbol::delete_package __PACKAGE__;
2436 3621
2439 warn "reloading cf.pm"; 3624 warn "reloading cf.pm";
2440 require cf; 3625 require cf;
2441 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3626 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2442 3627
2443 warn "loading config and database again"; 3628 warn "loading config and database again";
2444 cf::cfg_load; 3629 cf::reload_config;
2445 cf::db_load;
2446 3630
2447 warn "loading extensions"; 3631 warn "loading extensions";
2448 cf::load_extensions; 3632 cf::load_extensions;
2449 3633
2450 warn "reattaching attachments to objects/players"; 3634 warn "reattaching attachments to objects/players";
2451 _global_reattach; 3635 _global_reattach; # objects, sockets
2452 warn "reattaching attachments to maps"; 3636 warn "reattaching attachments to maps";
2453 reattach $_ for values %MAP; 3637 reattach $_ for values %MAP;
3638 warn "reattaching attachments to players";
3639 reattach $_ for values %PLAYER;
2454 3640
2455 warn "loading reloadable resources"; 3641 warn "leaving sync_job";
2456 load_resources;
2457 3642
2458 warn "restarting server ticker"; 3643 1
2459 3644 } or do {
2460 $TICK_WATCHER->start; 3645 warn $@;
3646 cf::cleanup "error while reloading, exiting.";
2461 }; 3647 };
2462
2463 if ($@) {
2464 warn $@;
2465 warn "error while reloading, exiting.";
2466 exit 1;
2467 }
2468 3648
2469 warn "reloaded"; 3649 warn "reloaded";
2470}; 3650};
2471 3651
2472our $RELOAD_WATCHER; # used only during reload 3652our $RELOAD_WATCHER; # used only during reload
2473 3653
3654sub reload_perl() {
3655 # doing reload synchronously and two reloads happen back-to-back,
3656 # coro crashes during coro_state_free->destroy here.
3657
3658 $RELOAD_WATCHER ||= EV::timer 0, 0, sub {
3659 do_reload_perl;
3660 undef $RELOAD_WATCHER;
3661 };
3662}
3663
2474register_command "reload" => sub { 3664register_command "reload" => sub {
2475 my ($who, $arg) = @_; 3665 my ($who, $arg) = @_;
2476 3666
2477 if ($who->flag (FLAG_WIZ)) { 3667 if ($who->flag (FLAG_WIZ)) {
2478 $who->message ("reloading server."); 3668 $who->message ("reloading server.");
2479 3669 async {
2480 # doing reload synchronously and two reloads happen back-to-back, 3670 $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; 3671 reload_perl;
2489 undef $RELOAD_WATCHER;
2490 },
2491 ); 3672 };
2492 } 3673 }
2493}; 3674};
2494 3675
2495unshift @INC, $LIBDIR; 3676unshift @INC, $LIBDIR;
2496 3677
2497my $bug_warning = 0; 3678my $bug_warning = 0;
2498 3679
2499$TICK_WATCHER = Event->timer ( 3680our @WAIT_FOR_TICK;
2500 reentrant => 0, 3681our @WAIT_FOR_TICK_BEGIN;
2501 parked => 1, 3682
2502 prio => 0, 3683sub wait_for_tick {
2503 at => $NEXT_TICK || $TICK, 3684 return if tick_inhibit;
2504 data => WF_AUTOCANCEL, 3685 return if $Coro::current == $Coro::main;
2505 cb => sub { 3686
3687 my $signal = new Coro::Signal;
3688 push @WAIT_FOR_TICK, $signal;
3689 $signal->wait;
3690}
3691
3692sub wait_for_tick_begin {
3693 return if tick_inhibit;
3694 return if $Coro::current == $Coro::main;
3695
3696 my $signal = new Coro::Signal;
3697 push @WAIT_FOR_TICK_BEGIN, $signal;
3698 $signal->wait;
3699}
3700
3701sub tick {
2506 if ($Coro::current != $Coro::main) { 3702 if ($Coro::current != $Coro::main) {
2507 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3703 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2508 unless ++$bug_warning > 10; 3704 unless ++$bug_warning > 10;
2509 return; 3705 return;
2510 } 3706 }
2511 3707
2512 $NOW = Event::time;
2513
2514 cf::server_tick; # one server iteration 3708 cf::server_tick; # one server iteration
2515 $RUNTIME += $TICK;
2516 $NEXT_TICK += $TICK;
2517 3709
2518 $WAIT_FOR_TICK->broadcast; 3710 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2519 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3711 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
3712 Coro::async_pool {
3713 $Coro::current->{desc} = "runtime saver";
3714 write_runtime
3715 or warn "ERROR: unable to write runtime file: $!";
3716 };
3717 }
2520 3718
2521 Event::sweep; 3719 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2522 Coro::cede_notself; 3720 $sig->send;
3721 }
3722 while (my $sig = shift @WAIT_FOR_TICK) {
3723 $sig->send;
3724 }
3725
3726 $LOAD = ($NOW - $TICK_START) / $TICK;
3727 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3728
3729 if (0) {
3730 if ($NEXT_TICK) {
3731 my $jitter = $TICK_START - $NEXT_TICK;
3732 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3733 warn "jitter $JITTER\n";#d#
2523 3734 }
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 }, 3735 }
2533); 3736}
2534 3737
2535{ 3738{
2536 BDB::max_poll_time $TICK * 0.1; 3739 # configure BDB
2537 $BDB_POLL_WATCHER = Event->io ( 3740
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; 3741 BDB::min_parallel 8;
2546 3742 BDB::max_poll_reqs $TICK * 0.1;
2547 BDB::set_sync_prepare { 3743 $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 3744
2562 unless ($DB_ENV) { 3745 unless ($DB_ENV) {
2563 $DB_ENV = BDB::db_env_create; 3746 $DB_ENV = BDB::db_env_create;
3747 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3748 | BDB::LOG_AUTOREMOVE, 1);
3749 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3750 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2564 3751
2565 cf::sync_job { 3752 cf::sync_job {
2566 eval { 3753 eval {
2567 BDB::db_env_open 3754 BDB::db_env_open
2568 $DB_ENV, 3755 $DB_ENV,
2569 $BDB_ENV_DIR, 3756 $BDBDIR,
2570 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3757 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2571 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3758 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2572 0666; 3759 0666;
2573 3760
2574 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3761 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 }; 3762 };
2579 3763
2580 cf::cleanup "db_env_open(db): $@" if $@; 3764 cf::cleanup "db_env_open(db): $@" if $@;
2581 }; 3765 };
2582 } 3766 }
3767
3768 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3769 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3770 };
3771 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3772 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3773 };
3774 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3775 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3776 };
2583} 3777}
2584 3778
2585{ 3779{
3780 # configure IO::AIO
3781
2586 IO::AIO::min_parallel 8; 3782 IO::AIO::min_parallel 8;
2587
2588 undef $Coro::AIO::WATCHER;
2589 IO::AIO::max_poll_time $TICK * 0.1; 3783 IO::AIO::max_poll_time $TICK * 0.1;
2590 $AIO_POLL_WATCHER = Event->io ( 3784 $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} 3785}
2599 3786
2600$WRITE_RUNTIME_WATCHER = Event->timer ( 3787my $_log_backtrace;
2601 reentrant => 0, 3788
2602 data => WF_AUTOCANCEL, 3789sub _log_backtrace {
2603 after => 1, 3790 my ($msg, @addr) = @_;
2604 interval => 10, 3791
2605 prio => 6, # keep it lowest so it acts like a watchdog 3792 $msg =~ s/\n//;
2606 cb => Coro::unblock_sub { 3793
2607 write_runtime 3794 # limit the # of concurrent backtraces
2608 or warn "ERROR: unable to write runtime file: $!"; 3795 if ($_log_backtrace < 2) {
3796 ++$_log_backtrace;
3797 async {
3798 $Coro::current->{desc} = "abt $msg";
3799
3800 my @bt = fork_call {
3801 @addr = map { sprintf "%x", $_ } @addr;
3802 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3803 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3804 or die "addr2line: $!";
3805
3806 my @funcs;
3807 my @res = <$fh>;
3808 chomp for @res;
3809 while (@res) {
3810 my ($func, $line) = splice @res, 0, 2, ();
3811 push @funcs, "[$func] $line";
3812 }
3813
3814 @funcs
3815 };
3816
3817 LOG llevInfo, "[ABT] $msg\n";
3818 LOG llevInfo, "[ABT] $_\n" for @bt;
3819 --$_log_backtrace;
3820 };
3821 } else {
3822 LOG llevInfo, "[ABT] $msg\n";
3823 LOG llevInfo, "[ABT] [suppressed]\n";
2609 }, 3824 }
2610); 3825}
3826
3827# load additional modules
3828use cf::pod;
2611 3829
2612END { cf::emergency_save } 3830END { cf::emergency_save }
2613 3831
26141 38321
2615 3833

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines