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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines