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.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.419 by root, Sun Apr 13 01:34:09 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines