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.206 by root, Sun Feb 11 22:27:05 2007 UTC vs.
Revision 1.432 by root, Mon May 5 22:38:47 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines