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.108 by root, Sun Dec 31 21:02:05 2006 UTC vs.
Revision 1.439 by root, Mon Jul 14 16:42:49 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.3; 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 ();
50use BDB ();
51use Data::Dumper;
20use Digest::MD5; 52use Digest::MD5;
21use Fcntl; 53use Fcntl;
54use YAML ();
22use IO::AIO 2.31 (); 55use IO::AIO ();
23use YAML::Syck ();
24use Time::HiRes; 56use Time::HiRes;
57use Compress::LZF;
58use Digest::MD5 ();
25 59
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 60AnyEvent::detect;
27 61
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 62# configure various modules to our taste
29$YAML::Syck::ImplicitUnicode = 1; 63#
64$Storable::canonical = 1; # reduce rsync transfers
65Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
66Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 67
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 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 71
35our %COMMAND = (); 72our %COMMAND = ();
36our %COMMAND_TIME = (); 73our %COMMAND_TIME = ();
74
75our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 76our %EXTCMD = ();
77our %EXTICMD = ();
78our %EXT_CORO = (); # coroutines bound to extensions
79our %EXT_MAP = (); # pluggable maps
38 80
81our $RELOAD; # number of reloads so far
39our @EVENT; 82our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 83
42our $TICK = MAX_TIME * 1e-6; 84our $CONFDIR = confdir;
43our $TICK_WATCHER; 85our $DATADIR = datadir;
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(!)
98our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 99our $NEXT_TICK;
45our $NOW; 100our $USE_FSYNC = 1; # use fsync to write maps - default off
101
102our $BDB_DEADLOCK_WATCHER;
103our $BDB_CHECKPOINT_WATCHER;
104our $BDB_TRICKLE_WATCHER;
105our $DB_ENV;
46 106
47our %CFG; 107our %CFG;
48 108
49our $UPTIME; $UPTIME ||= time; 109our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 110our $RUNTIME;
111our $NOW;
51 112
52our %MAP; # all maps 113our (%PLAYER, %PLAYER_LOADING); # all users
53our $LINK_MAP; # the special {link} map 114our (%MAP, %MAP_LOADING ); # all maps
54our $FREEZE; 115our $LINK_MAP; # the special {link} map, which is always available
55our $RANDOM_MAPS = cf::localdir . "/random"; 116
56our %EXT_CORO; 117# used to convert map paths into valid unix filenames by replacing / by ∕
118our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
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
57 124
58binmode STDOUT; 125binmode STDOUT;
59binmode STDERR; 126binmode STDERR;
60 127
61# read virtual server time, if available 128# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 129unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime" 130 open my $fh, "<", "$LOCALDIR/runtime"
64 or die "unable to read runtime file: $!"; 131 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.; 132 $RUNTIME = <$fh> + 0.;
66} 133}
67 134
68mkdir cf::localdir; 135mkdir $_
69mkdir cf::localdir . "/" . cf::playerdir; 136 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 137
74# a special map that is always available 138our $EMERGENCY_POSITION;
75our $LINK_MAP; 139
140sub cf::map::normalise;
76 141
77############################################################################# 142#############################################################################
78 143
79=head2 GLOBAL VARIABLES 144=head2 GLOBAL VARIABLES
80 145
87=item $cf::RUNTIME 152=item $cf::RUNTIME
88 153
89The 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
90every server tick. 155every server tick.
91 156
92=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
93 160
94The perl library directory, where extensions and cf-specific modules can 161Various directories - "/etc", read-only install directory, perl-library
95be 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.
96 165
97=item $cf::NOW 166=item $cf::NOW
98 167
99The time of the last (current) server tick. 168The time of the last (current) server tick.
100 169
101=item $cf::TICK 170=item $cf::TICK
102 171
103The interval between server ticks, in seconds. 172The interval between server ticks, in seconds.
104 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
105=item %cf::CFG 184=item %cf::CFG
106 185
107Configuration for the server, loaded from C</etc/crossfire/config>, or 186Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108from wherever your confdir points to. 187from wherever your confdir points to.
188
189=item cf::wait_for_tick, cf::wait_for_tick_begin
190
191These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
192returns directly I<after> the tick processing (and consequently, can only wake one process
193per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
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.
109 200
110=back 201=back
111 202
112=cut 203=cut
113 204
114BEGIN { 205BEGIN {
115 *CORE::GLOBAL::warn = sub { 206 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 207 my $msg = join "", @_;
117 utf8::encode $msg;
118 208
119 $msg .= "\n" 209 $msg .= "\n"
120 unless $msg =~ /\n$/; 210 unless $msg =~ /\n$/;
121 211
212 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
213
122 LOG llevError, "cfperl: $msg"; 214 LOG llevError, $msg;
123 }; 215 };
124} 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#?
125 232
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 233@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 234@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 235@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 236@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@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';
131@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)
132 240
133# 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
134# within the Safe compartment. 242# within the Safe compartment.
135for my $pkg (qw( 243for my $pkg (qw(
136 cf::global cf::attachable 244 cf::global cf::attachable
141)) { 249)) {
142 no strict 'refs'; 250 no strict 'refs';
143 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 251 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144} 252}
145 253
146$Event::DIED = sub { 254$EV::DIED = sub {
147 warn "error in event callback: @_"; 255 warn "error in event callback: @_";
148}; 256};
149 257
150my %ext_pkg; 258#############################################################################
151my @exts;
152my @hook;
153 259
154=head2 UTILITY FUNCTIONS 260=head2 UTILITY FUNCTIONS
155 261
156=over 4 262=over 4
157 263
158=cut 264=item dumpval $ref
159 265
160use JSON::Syck (); # TODO# replace by JSON::PC once working 266=cut
161 267
268sub dumpval {
269 eval {
270 local $SIG{__DIE__};
271 my $d;
272 if (1) {
273 $d = new Data::Dumper([$_[0]], ["*var"]);
274 $d->Terse(1);
275 $d->Indent(2);
276 $d->Quotekeys(0);
277 $d->Useqq(1);
278 #$d->Bless(...);
279 $d->Seen($_[1]) if @_ > 1;
280 $d = $d->Dump();
281 }
282 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
283 $d
284 } || "[unable to dump $_[0]: '$@']";
285}
286
162=item $ref = cf::from_json $json 287=item $ref = cf::decode_json $json
163 288
164Converts a JSON string into the corresponding perl data structure. 289Converts a JSON string into the corresponding perl data structure.
165 290
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 291=item $json = cf::encode_json $ref
174 292
175Converts a perl data structure into its JSON representation. 293Converts a perl data structure into its JSON representation.
176 294
177=cut 295=cut
178 296
179sub to_json($) { 297our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 298
181 JSON::Syck::Dump $_[0] 299sub encode_json($) { $json_coder->encode ($_[0]) }
300sub decode_json($) { $json_coder->decode ($_[0]) }
301
302=item cf::lock_wait $string
303
304Wait until the given lock is available. See cf::lock_acquire.
305
306=item my $lock = cf::lock_acquire $string
307
308Wait until the given lock is available and then acquires it and returns
309a Coro::guard object. If the guard object gets destroyed (goes out of scope,
310for example when the coroutine gets canceled), the lock is automatically
311returned.
312
313Locks are *not* recursive, locking from the same coro twice results in a
314deadlocked coro.
315
316Lock names should begin with a unique identifier (for example, cf::map::find
317uses map_find and cf::map::load uses map_load).
318
319=item $locked = cf::lock_active $string
320
321Return true if the lock is currently active, i.e. somebody has locked it.
322
323=cut
324
325our %LOCK;
326our %LOCKER;#d#
327
328sub lock_wait($) {
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#
335
336 # wait for lock, if any
337 while ($LOCK{$key}) {
338 push @{ $LOCK{$key} }, $Coro::current;
339 Coro::schedule;
340 }
182} 341}
342
343sub lock_acquire($) {
344 my ($key) = @_;
345
346 # wait, to be sure we are not locked
347 lock_wait $key;
348
349 $LOCK{$key} = [];
350 $LOCKER{$key} = $Coro::current;#d#
351
352 Coro::guard {
353 delete $LOCKER{$key};#d#
354 # wake up all waiters, to be on the safe side
355 $_->ready for @{ delete $LOCK{$key} };
356 }
357}
358
359sub lock_active($) {
360 my ($key) = @_;
361
362 ! ! $LOCK{$key}
363}
364
365sub freeze_mainloop {
366 tick_inhibit_inc;
367
368 Coro::guard \&tick_inhibit_dec;
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 }
429 }
430};
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;
444}
445
446=item cf::async { BLOCK }
447
448Currently the same as Coro::async_pool, meaning you cannot use
449C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
450thing you are allowed to do is call C<prio> on it.
451
452=cut
453
454BEGIN { *async = \&Coro::async_pool }
183 455
184=item cf::sync_job { BLOCK } 456=item cf::sync_job { BLOCK }
185 457
186The design of crossfire+ requires that the main coro ($Coro::main) is 458The design of Deliantra requires that the main coroutine ($Coro::main)
187always able to handle events or runnable, as crossfire+ is only partly 459is always able to handle events or runnable, as Deliantra is only
188reentrant. 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.
189 462
190If 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
191the given BLOCK in another coroutine while waiting for the result. The 464the given BLOCK in another coroutine while waiting for the result. The
192server 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
193fast or be very important. 466fast or be very important.
195=cut 468=cut
196 469
197sub sync_job(&) { 470sub sync_job(&) {
198 my ($job) = @_; 471 my ($job) = @_;
199 472
200 my $busy = 1;
201 my @res;
202
203 # TODO: use suspend/resume instead
204 local $FREEZE = 1;
205
206 my $coro = Coro::async {
207 @res = eval { $job->() };
208 warn $@ if $@;
209 undef $busy;
210 };
211
212 if ($Coro::current == $Coro::main) { 473 if ($Coro::current == $Coro::main) {
474 my $time = EV::time;
475
476 # this is the main coro, too bad, we have to block
477 # till the operation succeeds, freezing the server :/
478
479 LOG llevError, Carp::longmess "sync job";#d#
480
481 my $freeze_guard = freeze_mainloop;
482
483 my $busy = 1;
484 my @res;
485
486 (async {
487 $Coro::current->desc ("sync job coro");
488 @res = eval { $job->() };
489 warn $@ if $@;
490 undef $busy;
213 $coro->prio (Coro::PRIO_MAX); 491 })->prio (Coro::PRIO_MAX);
492
214 while ($busy) { 493 while ($busy) {
494 if (Coro::nready) {
215 Coro::cede_notself; 495 Coro::cede_notself;
216 Event::one_event unless Coro::nready; 496 } else {
497 EV::loop EV::LOOP_ONESHOT;
217 } 498 }
499 }
500
501 my $time = EV::time - $time;
502
503 $TICK_START += $time; # do not account sync jobs to server load
504
505 wantarray ? @res : $res[0]
218 } else { 506 } else {
219 $coro->join; 507 # we are in another coroutine, how wonderful, everything just works
508
509 $job->()
220 } 510 }
221
222 wantarray ? @res : $res[0]
223} 511}
224 512
225=item $coro = cf::coro { BLOCK } 513=item $coro = cf::async_ext { BLOCK }
226 514
227Creates and returns a new coro. This coro is automcatially being canceled 515Like async, but this coro is automatically being canceled when the
228when the extension calling this is being unloaded. 516extension calling this is being unloaded.
229 517
230=cut 518=cut
231 519
232sub coro(&) { 520sub async_ext(&) {
233 my $cb = shift; 521 my $cb = shift;
234 522
235 my $coro; $coro = async { 523 my $coro = &Coro::async ($cb);
236 eval {
237 $cb->();
238 };
239 warn $@ if $@;
240 };
241 524
242 $coro->on_destroy (sub { 525 $coro->on_destroy (sub {
243 delete $EXT_CORO{$coro+0}; 526 delete $EXT_CORO{$coro+0};
244 }); 527 });
245 $EXT_CORO{$coro+0} = $coro; 528 $EXT_CORO{$coro+0} = $coro;
246 529
247 $coro 530 $coro
248} 531}
249 532
250sub write_runtime { 533=item fork_call { }, $args
251 my $runtime = cf::localdir . "/runtime";
252 534
253 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 535Executes the given code block with the given arguments in a seperate
254 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.
255 539
256 my $value = $cf::RUNTIME; 540=cut
257 (aio_write $fh, 0, (length $value), $value, 0) <= 0
258 and return;
259 541
260 aio_fsync $fh 542sub fork_call(&@) {
261 and return; 543 my ($cb, @args) = @_;
262 544
263 close $fh 545 # we seemingly have to make a local copy of the whole thing,
264 or return; 546 # otherwise perl prematurely frees the stuff :/
547 # TODO: investigate and fix (likely this will be rather laborious)
265 548
266 aio_rename "$runtime~", $runtime 549 my @res = Coro::Util::fork_eval {
267 and return; 550 reset_signals;
551 &$cb
552 }, @args;
268 553
554 wantarray ? @res : $res[-1]
555}
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
269 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 });
270} 720}
271 721
272=back 722=back
273 723
274=cut 724=cut
275
276#############################################################################
277
278package cf::path;
279
280sub new {
281 my ($class, $path, $base) = @_;
282
283 my $self = bless { }, $class;
284
285 if ($path =~ s{^\?random/}{}) {
286 $self->{random} = cf::from_json $path;
287 } else {
288 if ($path =~ s{^~([^/]+)?}{}) {
289 $self->{user_rel} = 1;
290
291 if (defined $1) {
292 $self->{user} = $1;
293 } elsif ($base =~ m{^~([^/]+)/}) {
294 $self->{user} = $1;
295 } else {
296 warn "cannot resolve user-relative path without user <$path,$base>\n";
297 }
298 } elsif ($path =~ /^\//) {
299 # already absolute
300 } else {
301 $base =~ s{[^/]+/?$}{};
302 return $class->new ("$base/$path");
303 }
304
305 for ($path) {
306 redo if s{/\.?/}{/};
307 redo if s{/[^/]+/\.\./}{/};
308 }
309 }
310
311 $self->{path} = $path;
312
313 $self
314}
315
316# the name / primary key / in-game path
317sub as_string {
318 my ($self) = @_;
319
320 $self->{user_rel} ? "~$self->{user}$self->{path}"
321 : $self->{random} ? "?random/$self->{path}"
322 : $self->{path}
323}
324
325# the displayed name, this is a one way mapping
326sub visible_name {
327 my ($self) = @_;
328
329 $self->{random} ? "?random/$self->{random}{origin_map}+$self->{random}{origin_x}+$self->{random}{origin_y}/$self->{random}{dungeon_level}"
330 : $self->as_string
331}
332
333# escape the /'s in the path
334sub _escaped_path {
335 # ∕ is U+2215
336 (my $path = $_[0]{path}) =~ s/\//∕/g;
337 $path
338}
339
340# the original (read-only) location
341sub load_path {
342 my ($self) = @_;
343
344 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
345}
346
347# the temporary/swap location
348sub save_path {
349 my ($self) = @_;
350
351 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
352 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, Digest::MD5::md5_hex $self->{path}
353 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
354}
355
356# the unique path, might be eq to save_path
357sub uniq_path {
358 my ($self) = @_;
359
360 $self->{user_rel} || $self->{random}
361 ? undef
362 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
363}
364
365# return random map parameters, or undef
366sub random_map_params {
367 my ($self) = @_;
368
369 $self->{random}
370}
371
372# this is somewhat ugly, but style maps do need special treatment
373sub is_style_map {
374 $_[0]{path} =~ m{^/styles/}
375}
376
377package cf;
378 725
379############################################################################# 726#############################################################################
380 727
381=head2 ATTACHABLE OBJECTS 728=head2 ATTACHABLE OBJECTS
382 729
384attach callbacks/event handlers (a collection of which is called an "attachment") 731attach callbacks/event handlers (a collection of which is called an "attachment")
385to it. All such attachable objects support the following methods. 732to it. All such attachable objects support the following methods.
386 733
387In 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>
388C<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
389crossfire+). 736Deliantra).
390 737
391=over 4 738=over 4
392 739
393=item $attachable->attach ($attachment, key => $value...) 740=item $attachable->attach ($attachment, key => $value...)
394 741
508our @CB_TYPE = (); # registry for type (cf-object class) based events 855our @CB_TYPE = (); # registry for type (cf-object class) based events
509our @CB_MAP = (); 856our @CB_MAP = ();
510 857
511my %attachment; 858my %attachment;
512 859
860sub cf::attachable::thawer_merge {
861 # simply override everything except _meta
862 local $_[0]{_meta};
863 %{$_[0]} = %{$_[1]};
864}
865
513sub _attach_cb($$$$) { 866sub _attach_cb($$$$) {
514 my ($registry, $event, $prio, $cb) = @_; 867 my ($registry, $event, $prio, $cb) = @_;
515 868
516 use sort 'stable'; 869 use sort 'stable';
517 870
551 $registry = $CB_TYPE[$object_type] ||= []; 904 $registry = $CB_TYPE[$object_type] ||= [];
552 905
553 } elsif ($type eq "subtype") { 906 } elsif ($type eq "subtype") {
554 defined $object_type or Carp::croak "subtype specified without type"; 907 defined $object_type or Carp::croak "subtype specified without type";
555 my $object_subtype = shift @arg; 908 my $object_subtype = shift @arg;
556 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 909 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
557 910
558 } elsif ($type eq "package") { 911 } elsif ($type eq "package") {
559 my $pkg = shift @arg; 912 my $pkg = shift @arg;
560 913
561 while (my ($name, $id) = each %cb_id) { 914 while (my ($name, $id) = each %cb_id) {
590 _attach $registry, $klass, @attach; 943 _attach $registry, $klass, @attach;
591 } 944 }
592 945
593 $obj->{$name} = \%arg; 946 $obj->{$name} = \%arg;
594 } else { 947 } else {
595 warn "object uses attachment '$name' that is not available, postponing.\n"; 948 warn "object uses attachment '$name' which is not available, postponing.\n";
596 } 949 }
597 950
598 $obj->{_attachment}{$name} = undef; 951 $obj->{_attachment}{$name} = undef;
599} 952}
600 953
602 if (ref $_[0]) { 955 if (ref $_[0]) {
603 _object_attach @_; 956 _object_attach @_;
604 } else { 957 } else {
605 _attach shift->_attach_registry, @_; 958 _attach shift->_attach_registry, @_;
606 } 959 }
960 _recalc_want;
607}; 961};
608 962
609# all those should be optimised 963# all those should be optimised
610sub cf::attachable::detach { 964sub cf::attachable::detach {
611 my ($obj, $name) = @_; 965 my ($obj, $name) = @_;
614 delete $obj->{_attachment}{$name}; 968 delete $obj->{_attachment}{$name};
615 reattach ($obj); 969 reattach ($obj);
616 } else { 970 } else {
617 Carp::croak "cannot, currently, detach class attachments"; 971 Carp::croak "cannot, currently, detach class attachments";
618 } 972 }
973 _recalc_want;
619}; 974};
620 975
621sub cf::attachable::attached { 976sub cf::attachable::attached {
622 my ($obj, $name) = @_; 977 my ($obj, $name) = @_;
623 978
638 "; 993 ";
639 die if $@; 994 die if $@;
640} 995}
641 996
642our $override; 997our $override;
643our @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?
644 999
645sub override { 1000sub override {
646 $override = 1; 1001 $override = 1;
647 @invoke_results = (); 1002 @INVOKE_RESULTS = (@_);
648} 1003}
649 1004
650sub do_invoke { 1005sub do_invoke {
651 my $event = shift; 1006 my $event = shift;
652 my $callbacks = shift; 1007 my $callbacks = shift;
653 1008
654 @invoke_results = (); 1009 @INVOKE_RESULTS = ();
655 1010
656 local $override; 1011 local $override;
657 1012
658 for (@$callbacks) { 1013 for (@$callbacks) {
659 eval { &{$_->[1]} }; 1014 eval { &{$_->[1]} };
668 } 1023 }
669 1024
670 0 1025 0
671} 1026}
672 1027
673=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1028=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
674 1029
675=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1030=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
676 1031
677Generate an object-specific event with the given arguments. 1032Generate an object-specific event with the given arguments.
678 1033
679This 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
680removed 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
681results (if you must, access C<@cf::invoke_results> directly). 1036results (if you must, access C<@cf::INVOKE_RESULTS> directly).
682 1037
683=back 1038=back
684 1039
685=cut 1040=cut
686 1041
687############################################################################# 1042#############################################################################
688# 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}
689 1086
690sub reattach { 1087sub reattach {
691 # basically do the same as instantiate, without calling instantiate 1088 # basically do the same as instantiate, without calling instantiate
692 my ($obj) = @_; 1089 my ($obj) = @_;
1090
1091 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
693 1092
694 my $registry = $obj->registry; 1093 my $registry = $obj->registry;
695 1094
696 @$registry = (); 1095 @$registry = ();
697 1096
712cf::attachable->attach ( 1111cf::attachable->attach (
713 prio => -1000000, 1112 prio => -1000000,
714 on_instantiate => sub { 1113 on_instantiate => sub {
715 my ($obj, $data) = @_; 1114 my ($obj, $data) = @_;
716 1115
717 $data = from_json $data; 1116 $data = decode_json $data;
718 1117
719 for (@$data) { 1118 for (@$data) {
720 my ($name, $args) = @$_; 1119 my ($name, $args) = @$_;
721 1120
722 $obj->attach ($name, %{$args || {} }); 1121 $obj->attach ($name, %{$args || {} });
738sub object_freezer_save { 1137sub object_freezer_save {
739 my ($filename, $rdata, $objs) = @_; 1138 my ($filename, $rdata, $objs) = @_;
740 1139
741 sync_job { 1140 sync_job {
742 if (length $$rdata) { 1141 if (length $$rdata) {
1142 utf8::decode (my $decname = $filename);
743 warn sprintf "saving %s (%d,%d)\n", 1143 warn sprintf "saving %s (%d,%d)\n",
744 $filename, length $$rdata, scalar @$objs; 1144 $decname, length $$rdata, scalar @$objs;
745 1145
746 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1146 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
747 chmod SAVE_MODE, $fh; 1147 aio_chmod $fh, SAVE_MODE;
748 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1148 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
749 aio_fsync $fh; 1149 aio_fsync $fh if $cf::USE_FSYNC;
750 close $fh; 1150 aio_close $fh;
751 1151
752 if (@$objs) { 1152 if (@$objs) {
753 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) {
754 chmod SAVE_MODE, $fh; 1154 aio_chmod $fh, SAVE_MODE;
755 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1155 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
756 aio_write $fh, 0, (length $data), $data, 0; 1156 aio_write $fh, 0, (length $data), $data, 0;
757 aio_fsync $fh; 1157 aio_fsync $fh if $cf::USE_FSYNC;
758 close $fh; 1158 aio_close $fh;
759 aio_rename "$filename.pst~", "$filename.pst"; 1159 aio_rename "$filename.pst~", "$filename.pst";
760 } 1160 }
761 } else { 1161 } else {
762 aio_unlink "$filename.pst"; 1162 aio_unlink "$filename.pst";
763 } 1163 }
768 } 1168 }
769 } else { 1169 } else {
770 aio_unlink $filename; 1170 aio_unlink $filename;
771 aio_unlink "$filename.pst"; 1171 aio_unlink "$filename.pst";
772 } 1172 }
773 } 1173 };
774} 1174}
775 1175
776sub object_freezer_as_string { 1176sub object_freezer_as_string {
777 my ($rdata, $objs) = @_; 1177 my ($rdata, $objs) = @_;
778 1178
790 or return; 1190 or return;
791 1191
792 unless (aio_stat "$filename.pst") { 1192 unless (aio_stat "$filename.pst") {
793 (aio_load "$filename.pst", $av) >= 0 1193 (aio_load "$filename.pst", $av) >= 0
794 or return; 1194 or return;
1195
795 $av = eval { (Storable::thaw <$av>)->{objs} }; 1196 my $st = eval { Coro::Storable::thaw $av };
1197 $av = $st->{objs};
796 } 1198 }
797 1199
1200 utf8::decode (my $decname = $filename);
1201 warn sprintf "loading %s (%d,%d)\n",
1202 $decname, length $data, scalar @{$av || []};
1203
798 return ($data, $av); 1204 ($data, $av)
799} 1205}
1206
1207=head2 COMMAND CALLBACKS
1208
1209=over 4
1210
1211=cut
800 1212
801############################################################################# 1213#############################################################################
802# command handling &c 1214# command handling &c
803 1215
804=item cf::register_command $name => \&callback($ob,$args); 1216=item cf::register_command $name => \&callback($ob,$args);
817 push @{ $COMMAND{$name} }, [$caller, $cb]; 1229 push @{ $COMMAND{$name} }, [$caller, $cb];
818} 1230}
819 1231
820=item cf::register_extcmd $name => \&callback($pl,$packet); 1232=item cf::register_extcmd $name => \&callback($pl,$packet);
821 1233
822Register 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.
823 1239
824If 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
825called. 1241called.
826 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
827=cut 1254=cut
828 1255
829sub register_extcmd { 1256sub register_extcmd {
830 my ($name, $cb) = @_; 1257 my ($name, $cb) = @_;
831 1258
832 my $caller = caller;
833 #warn "registering extcmd '$name' to '$caller'";
834
835 $EXTCMD{$name} = [$cb, $caller]; 1259 $EXTCMD{$name} = $cb;
1260}
1261
1262sub register_exticmd {
1263 my ($name, $cb) = @_;
1264
1265 $EXTICMD{$name} = $cb;
836} 1266}
837 1267
838cf::player->attach ( 1268cf::player->attach (
839 on_command => sub { 1269 on_command => sub {
840 my ($pl, $name, $params) = @_; 1270 my ($pl, $name, $params) = @_;
849 cf::override; 1279 cf::override;
850 }, 1280 },
851 on_extcmd => sub { 1281 on_extcmd => sub {
852 my ($pl, $buf) = @_; 1282 my ($pl, $buf) = @_;
853 1283
854 my $msg = eval { from_json $buf }; 1284 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
855 1285
856 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
857 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1294 if (my $cb = $EXTCMD{$type}) {
858 if (my %reply = $cb->[0]->($pl, $msg)) { 1295 @reply = $cb->($pl, @payload);
859 $pl->ext_reply ($msg->{msgid}, %reply);
860 }
861 } 1296 }
1297
1298 $pl->ext_reply ($reply, @reply)
1299 if $reply;
1300
862 } else { 1301 } else {
863 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1302 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
864 } 1303 }
865 1304
866 cf::override; 1305 cf::override;
867 }, 1306 },
868); 1307);
869 1308
1309sub load_extensions {
1310 cf::sync_job {
1311 my %todo;
1312
1313 for my $path (<$LIBDIR/*.ext>) {
1314 next unless -r $path;
1315
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;
1372 }
1373
1374 skip:
1375 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1376 unless $progress;
1377 }
1378 };
1379}
1380
1381#############################################################################
1382
1383=back
1384
1385=head2 CORE EXTENSIONS
1386
1387Functions and methods that extend core crossfire objects.
1388
1389=cut
1390
1391package cf::player;
1392
1393use Coro::AIO;
1394
1395=head3 cf::player
1396
1397=over 4
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
1413=item cf::player::find $login
1414
1415Returns the given player object, loading it if necessary (might block).
1416
1417=cut
1418
1419sub playerdir($) {
1420 "$PLAYERDIR/"
1421 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1422}
1423
1424sub path($) {
1425 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1426
1427 (playerdir $login) . "/playerdata"
1428}
1429
1430sub find_active($) {
1431 $cf::PLAYER{$_[0]}
1432 and $cf::PLAYER{$_[0]}->active
1433 and $cf::PLAYER{$_[0]}
1434}
1435
1436sub exists($) {
1437 my ($login) = @_;
1438
1439 $cf::PLAYER{$login}
1440 or cf::sync_job { !aio_stat path $login }
1441}
1442
1443sub find($) {
1444 return $cf::PLAYER{$_[0]} || do {
1445 my $login = $_[0];
1446
1447 my $guard = cf::lock_acquire "user_find:$login";
1448
1449 $cf::PLAYER{$_[0]} || do {
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
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;
1465 $cf::PLAYER{$login} = $pl
1466 }
1467 }
1468}
1469
1470sub save($) {
1471 my ($pl) = @_;
1472
1473 return if $pl->{deny_save};
1474
1475 my $path = path $pl;
1476 my $guard = cf::lock_acquire "user_save:$path";
1477
1478 return if $pl->{deny_save};
1479
1480 aio_mkdir playerdir $pl, 0770;
1481 $pl->{last_save} = $cf::RUNTIME;
1482
1483 cf::get_slot 0.01;
1484
1485 $pl->save_pl ($path);
1486 cf::cede_to_tick;
1487}
1488
1489sub new($) {
1490 my ($login) = @_;
1491
1492 my $self = create;
1493
1494 $self->ob->name ($login);
1495 $self->{deny_save} = 1;
1496
1497 $cf::PLAYER{$login} = $self;
1498
1499 $self
1500}
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
1512=item $pl->quit_character
1513
1514Nukes the player without looking back. If logged in, the connection will
1515be destroyed. May block for a long time.
1516
1517=cut
1518
1519sub quit_character {
1520 my ($pl) = @_;
1521
1522 my $name = $pl->ob->name;
1523
1524 $pl->{deny_save} = 1;
1525 $pl->password ("*"); # this should lock out the player until we nuked the dir
1526
1527 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1528 $pl->deactivate;
1529 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1530 $pl->ob->check_score;
1531 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1532 $pl->ns->destroy if $pl->ns;
1533
1534 my $path = playerdir $pl;
1535 my $temp = "$path~$cf::RUNTIME~deleting~";
1536 aio_rename $path, $temp;
1537 delete $cf::PLAYER{$pl->ob->name};
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
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;
1560}
1561
1562=item cf::player::list_logins
1563
1564Returns am arrayref of all valid playernames in the system, can take a
1565while and may block, so not sync_job-capable, ever.
1566
1567=cut
1568
1569sub list_logins {
1570 my $dirs = aio_readdir $PLAYERDIR
1571 or return [];
1572
1573 my @logins;
1574
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") {
1581 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1582 aio_read $fh, 0, 512, my $buf, 0 or next;
1583 $buf !~ /^password -------------$/m or next; # official not-valid tag
1584 }
1585
1586 utf8::decode $login;
1587 push @logins, $login;
1588 }
1589
1590 \@logins
1591}
1592
1593=item $player->maps
1594
1595Returns an arrayref of map paths that are private for this
1596player. May block.
1597
1598=cut
1599
1600sub maps($) {
1601 my ($pl) = @_;
1602
1603 $pl = ref $pl ? $pl->ob->name : $pl;
1604
1605 my $files = aio_readdir playerdir $pl
1606 or return;
1607
1608 my @paths;
1609
1610 for (@$files) {
1611 utf8::decode $_;
1612 next if /\.(?:pl|pst)$/;
1613 next unless /^$PATH_SEP/o;
1614
1615 push @paths, cf::map::normalise "~$pl/$_";
1616 }
1617
1618 \@paths
1619}
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
1714=item $player->ext_reply ($msgid, @msg)
1715
1716Sends an ext reply to the player.
1717
1718=cut
1719
1720sub ext_reply($$@) {
1721 my ($self, $id, @msg) = @_;
1722
1723 $self->ns->ext_reply ($id, @msg)
1724}
1725
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}
1766
1767=back
1768
1769=head3 cf::map
1770
1771=over 4
1772
1773=cut
1774
1775package cf::map;
1776
1777use Fcntl;
1778use Coro::AIO;
1779
1780use overload
1781 '""' => \&as_string,
1782 fallback => 1;
1783
1784our $MAX_RESET = 3600;
1785our $DEFAULT_RESET = 3000;
1786
1787sub generate_random_map {
1788 my ($self, $rmp) = @_;
1789
1790 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1791
1792 # mit "rum" bekleckern, nicht
1793 $self->_create_random_map (
1794 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1795 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1796 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1797 $rmp->{exit_on_final_map},
1798 $rmp->{xsize}, $rmp->{ysize},
1799 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1800 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1801 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1802 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1803 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1804 (cf::region::find $rmp->{region}), $rmp->{custom}
1805 )
1806}
1807
1808=item cf::map->register ($regex, $prio)
1809
1810Register a handler for the map path matching the given regex at the
1811givne priority (higher is better, built-in handlers have priority 0, the
1812default).
1813
1814=cut
1815
870sub register { 1816sub register {
1817 my (undef, $regex, $prio) = @_;
1818 my $pkg = caller;
1819
1820 no strict;
1821 push @{"$pkg\::ISA"}, __PACKAGE__;
1822
1823 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1824}
1825
1826# also paths starting with '/'
1827$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1828
1829sub thawer_merge {
871 my ($base, $pkg) = @_; 1830 my ($self, $merge) = @_;
872 1831
873 #TODO 1832 # we have to keep some variables in memory intact
874} 1833 local $self->{path};
1834 local $self->{load_path};
875 1835
876sub load_extension { 1836 $self->SUPER::thawer_merge ($merge);
1837}
1838
1839sub normalise {
877 my ($path) = @_; 1840 my ($path, $base) = @_;
878 1841
879 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1842 $path = "$path"; # make sure its a string
880 my $base = $1;
881 my $pkg = $1;
882 $pkg =~ s/[^[:word:]]/_/g;
883 $pkg = "ext::$pkg";
884 1843
885 warn "loading '$path' into '$pkg'\n"; 1844 $path =~ s/\.map$//;
886 1845
887 open my $fh, "<:utf8", $path 1846 # map plan:
888 or die "$path: $!"; 1847 #
1848 # /! non-realised random map exit (special hack!)
1849 # {... are special paths that are not being touched
1850 # ?xxx/... are special absolute paths
1851 # ?random/... random maps
1852 # /... normal maps
1853 # ~user/... per-player map of a specific user
889 1854
890 my $source = 1855 $path =~ s/$PATH_SEP/\//go;
891 "package $pkg; use strict; use utf8;\n"
892 . "#line 1 \"$path\"\n{\n"
893 . (do { local $/; <$fh> })
894 . "\n};\n1";
895 1856
896 eval $source 1857 # treat it as relative path if it starts with
897 or die $@ ? "$path: $@\n" 1858 # something that looks reasonable
898 : "extension disabled.\n"; 1859 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1860 $base or Carp::carp "normalise called with relative path and no base: '$path'";
899 1861
900 push @exts, $pkg; 1862 $base =~ s{[^/]+/?$}{};
901 $ext_pkg{$base} = $pkg; 1863 $path = "$base/$path";
902
903# no strict 'refs';
904# @{"$pkg\::ISA"} = ext::;
905
906 register $base, $pkg;
907}
908
909sub unload_extension {
910 my ($pkg) = @_;
911
912 warn "removing extension $pkg\n";
913
914 # remove hooks
915 #TODO
916# for my $idx (0 .. $#PLUGIN_EVENT) {
917# delete $hook[$idx]{$pkg};
918# } 1864 }
919 1865
920 # remove commands 1866 for ($path) {
921 for my $name (keys %COMMAND) { 1867 redo if s{//}{/};
922 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1868 redo if s{/\.?/}{/};
1869 redo if s{/[^/]+/\.\./}{/};
1870 }
923 1871
924 if (@cb) { 1872 $path
925 $COMMAND{$name} = \@cb; 1873}
1874
1875sub new_from_path {
1876 my (undef, $path, $base) = @_;
1877
1878 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1879
1880 $path = normalise $path, $base;
1881
1882 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1883 if ($path =~ $EXT_MAP{$pkg}[1]) {
1884 my $self = bless cf::map::new, $pkg;
1885 $self->{path} = $path; $self->path ($path);
1886 $self->init; # pass $1 etc.
1887 return $self;
1888 }
1889 }
1890
1891 Carp::cluck "unable to resolve path '$path' (base '$base').";
1892 ()
1893}
1894
1895sub init {
1896 my ($self) = @_;
1897
1898 $self
1899}
1900
1901sub as_string {
1902 my ($self) = @_;
1903
1904 "$self->{path}"
1905}
1906
1907# the displayed name, this is a one way mapping
1908sub visible_name {
1909 &as_string
1910}
1911
1912# the original (read-only) location
1913sub load_path {
1914 my ($self) = @_;
1915
1916 "$MAPDIR/$self->{path}.map"
1917}
1918
1919# the temporary/swap location
1920sub save_path {
1921 my ($self) = @_;
1922
1923 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1924 "$TMPDIR/$path.map"
1925}
1926
1927# the unique path, undef == no special unique path
1928sub uniq_path {
1929 my ($self) = @_;
1930
1931 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1932 "$UNIQUEDIR/$path"
1933}
1934
1935# and all this just because we cannot iterate over
1936# all maps in C++...
1937sub change_all_map_light {
1938 my ($change) = @_;
1939
1940 $_->change_map_light ($change)
1941 for grep $_->outdoor, values %cf::MAP;
1942}
1943
1944sub decay_objects {
1945 my ($self) = @_;
1946
1947 return if $self->{deny_reset};
1948
1949 $self->do_decay_objects;
1950}
1951
1952sub unlink_save {
1953 my ($self) = @_;
1954
1955 utf8::encode (my $save = $self->save_path);
1956 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1957 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1958}
1959
1960sub load_header_from($) {
1961 my ($self, $path) = @_;
1962
1963 utf8::encode $path;
1964 my $f = new_from_file cf::object::thawer $path
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;
1972
1973 $self->{load_path} = $path;
1974
1975 1
1976}
1977
1978sub load_header_orig {
1979 my ($self) = @_;
1980
1981 $self->load_header_from ($self->load_path)
1982}
1983
1984sub load_header_temp {
1985 my ($self) = @_;
1986
1987 $self->load_header_from ($self->save_path)
1988}
1989
1990sub prepare_temp {
1991 my ($self) = @_;
1992
1993 $self->last_access ((delete $self->{last_access})
1994 || $cf::RUNTIME); #d#
1995 # safety
1996 $self->{instantiate_time} = $cf::RUNTIME
1997 if $self->{instantiate_time} > $cf::RUNTIME;
1998}
1999
2000sub prepare_orig {
2001 my ($self) = @_;
2002
2003 $self->{load_original} = 1;
2004 $self->{instantiate_time} = $cf::RUNTIME;
2005 $self->last_access ($cf::RUNTIME);
2006 $self->instantiate;
2007}
2008
2009sub load_header {
2010 my ($self) = @_;
2011
2012 if ($self->load_header_temp) {
2013 $self->prepare_temp;
926 } else { 2014 } else {
927 delete $COMMAND{$name}; 2015 $self->load_header_orig
928 } 2016 or return;
2017 $self->prepare_orig;
2018 }
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
929 } 2026 1
2027}
930 2028
931 # remove extcmds 2029sub find;
932 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 2030sub find {
933 delete $EXTCMD{$name}; 2031 my ($path, $origin) = @_;
2032
2033 $path = normalise $path, $origin && $origin->path;
2034
2035 cf::lock_wait "map_data:$path";#d#remove
2036 cf::lock_wait "map_find:$path";
2037
2038 $cf::MAP{$path} || do {
2039 my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
2040 my $guard2 = cf::lock_acquire "map_find:$path";
2041
2042 my $map = new_from_path cf::map $path
2043 or return;
2044
2045 $map->{last_save} = $cf::RUNTIME;
2046
2047 $map->load_header
2048 or return;
2049
2050 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
2051 # doing this can freeze the server in a sync job, obviously
2052 #$cf::WAIT_FOR_TICK->wait;
2053 undef $guard2;
2054 undef $guard1;
2055 $map->reset;
2056 return find $path;
2057 }
2058
2059 $cf::MAP{$path} = $map
2060 }
2061}
2062
2063sub pre_load { }
2064sub post_load { }
2065
2066sub load {
2067 my ($self) = @_;
2068
2069 local $self->{deny_reset} = 1; # loading can take a long time
2070
2071 my $path = $self->{path};
2072
934 } 2073 {
2074 my $guard = cf::lock_acquire "map_data:$path";
935 2075
936 if (my $cb = $pkg->can ("unload")) { 2076 return unless $self->valid;
937 eval { 2077 return unless $self->in_memory == cf::MAP_SWAPPED;
938 $cb->($pkg); 2078
2079 $self->in_memory (cf::MAP_LOADING);
2080
2081 $self->alloc;
2082
2083 $self->pre_load;
2084 cf::cede_to_tick;
2085
2086 my $f = new_from_file cf::object::thawer $self->{load_path};
2087 $f->skip_block;
2088 $self->_load_objects ($f)
2089 or return;
2090
2091 $self->post_load_original
2092 if delete $self->{load_original};
2093
2094 if (my $uniq = $self->uniq_path) {
2095 utf8::encode $uniq;
2096 unless (aio_stat $uniq) {
2097 if (my $f = new_from_file cf::object::thawer $uniq) {
2098 $self->clear_unique_items;
2099 $self->_load_objects ($f);
2100 $f->resolve_delayed_derefs;
2101 }
939 1 2102 }
940 } or warn "$pkg unloaded, but with errors: $@"; 2103 }
941 }
942 2104
943 Symbol::delete_package $pkg; 2105 $f->resolve_delayed_derefs;
944}
945 2106
946sub load_extensions { 2107 cf::cede_to_tick;
947 for my $ext (<$LIBDIR/*.ext>) { 2108 # now do the right thing for maps
948 next unless -r $ext; 2109 $self->link_multipart_objects;
949 eval { 2110 $self->difficulty ($self->estimate_difficulty)
950 load_extension $ext; 2111 unless $self->difficulty;
951 1 2112 cf::cede_to_tick;
952 } or warn "$ext not loaded: $@";
953 }
954}
955 2113
956############################################################################# 2114 unless ($self->{deny_activate}) {
957# load/save/clean perl data associated with a map 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;
2121 $self->activate;
2122 }
958 2123
959*cf::mapsupport::on_clean = sub { 2124 $self->{last_save} = $cf::RUNTIME;
2125 $self->last_access ($cf::RUNTIME);
2126
2127 $self->in_memory (cf::MAP_ACTIVE);
2128 }
2129
2130 $self->post_load;
2131}
2132
2133sub customise_for {
2134 my ($self, $ob) = @_;
2135
2136 return find "~" . $ob->name . "/" . $self->{path}
2137 if $self->per_player;
2138
2139# return find "?party/" . $ob->name . "/" . $self->{path}
2140# if $self->per_party;
2141
2142 $self
2143}
2144
2145# find and load all maps in the 3x3 area around a map
2146sub load_neighbours {
960 my ($map) = @_; 2147 my ($map) = @_;
961 2148
962 my $path = $map->tmpname; 2149 my @neigh; # diagonal neighbours
963 defined $path or return;
964 2150
965 unlink "$path.pst"; 2151 for (0 .. 3) {
966}; 2152 my $neigh = $map->tile_path ($_)
2153 or next;
2154 $neigh = find $neigh, $map
2155 or next;
2156 $neigh->load;
967 2157
968cf::map->attach (prio => -10000, package => cf::mapsupport::); 2158 push @neigh,
2159 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2160 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2161 }
969 2162
970############################################################################# 2163 for (grep defined $_->[0], @neigh) {
971# load/save perl data associated with player->ob objects 2164 my ($path, $origin) = @$_;
972 2165 my $neigh = find $path, $origin
973sub all_objects(@) { 2166 or next;
974 @_, map all_objects ($_->inv), @_ 2167 $neigh->load;
2168 }
975} 2169}
976 2170
977# TODO: compatibility cruft, remove when no longer needed 2171sub find_sync {
978cf::player->attach ( 2172 my ($path, $origin) = @_;
979 on_load => sub {
980 my ($pl, $path) = @_;
981 2173
982 for my $o (all_objects $pl->ob) { 2174 cf::sync_job { find $path, $origin }
983 if (my $value = $o->get_ob_key_value ("_perl_data")) { 2175}
984 $o->set_ob_key_value ("_perl_data");
985 2176
986 %$o = %{ Storable::thaw pack "H*", $value }; 2177sub do_load_sync {
2178 my ($map) = @_;
2179
2180 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2181 if $Coro::current == $Coro::main;
2182
2183 cf::sync_job { $map->load };
2184}
2185
2186our %MAP_PREFETCH;
2187our $MAP_PREFETCHER = undef;
2188
2189sub find_async {
2190 my ($path, $origin, $load) = @_;
2191
2192 $path = normalise $path, $origin && $origin->{path};
2193
2194 if (my $map = $cf::MAP{$path}) {
2195 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2196 }
2197
2198 $MAP_PREFETCH{$path} |= $load;
2199
2200 $MAP_PREFETCHER ||= cf::async {
2201 $Coro::current->{desc} = "map prefetcher";
2202
2203 while (%MAP_PREFETCH) {
2204 while (my ($k, $v) = each %MAP_PREFETCH) {
2205 if (my $map = find $k) {
2206 $map->load if $v;
2207 }
2208
2209 delete $MAP_PREFETCH{$k};
987 } 2210 }
988 } 2211 }
2212 undef $MAP_PREFETCHER;
2213 };
2214 $MAP_PREFETCHER->prio (6);
2215
2216 ()
2217}
2218
2219sub save {
2220 my ($self) = @_;
2221
2222 my $lock = cf::lock_acquire "map_data:$self->{path}";
2223
2224 $self->{last_save} = $cf::RUNTIME;
2225
2226 return unless $self->dirty;
2227
2228 my $save = $self->save_path; utf8::encode $save;
2229 my $uniq = $self->uniq_path; utf8::encode $uniq;
2230
2231 $self->{load_path} = $save;
2232
2233 return if $self->{deny_save};
2234
2235 local $self->{last_access} = $self->last_access;#d#
2236
2237 cf::async {
2238 $Coro::current->{desc} = "map player save";
2239 $_->contr->save for $self->players;
2240 };
2241
2242 cf::get_slot 0.02;
2243
2244 if ($uniq) {
2245 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2246 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2247 } else {
2248 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
989 }, 2249 }
990); 2250}
991 2251
992############################################################################# 2252sub swap_out {
2253 my ($self) = @_;
993 2254
994=head2 CORE EXTENSIONS 2255 # save first because save cedes
2256 $self->save;
995 2257
996Functions and methods that extend core crossfire objects. 2258 my $lock = cf::lock_acquire "map_data:$self->{path}";
997 2259
998=head3 cf::player 2260 return if $self->players;
2261 return if $self->in_memory != cf::MAP_ACTIVE;
2262 return if $self->{deny_save};
2263
2264 $self->in_memory (cf::MAP_SWAPPED);
2265
2266 $self->deactivate;
2267 $_->clear_links_to ($self) for values %cf::MAP;
2268 $self->clear;
2269}
2270
2271sub reset_at {
2272 my ($self) = @_;
2273
2274 # TODO: safety, remove and allow resettable per-player maps
2275 return 1e99 if $self->{deny_reset};
2276
2277 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2278 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2279
2280 $time + $to
2281}
2282
2283sub should_reset {
2284 my ($self) = @_;
2285
2286 $self->reset_at <= $cf::RUNTIME
2287}
2288
2289sub reset {
2290 my ($self) = @_;
2291
2292 my $lock = cf::lock_acquire "map_data:$self->{path}";
2293
2294 return if $self->players;
2295
2296 warn "resetting map ", $self->path;
2297
2298 $self->in_memory (cf::MAP_SWAPPED);
2299
2300 # need to save uniques path
2301 unless ($self->{deny_save}) {
2302 my $uniq = $self->uniq_path; utf8::encode $uniq;
2303
2304 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2305 if $uniq;
2306 }
2307
2308 delete $cf::MAP{$self->path};
2309
2310 $self->deactivate;
2311 $_->clear_links_to ($self) for values %cf::MAP;
2312 $self->clear;
2313
2314 $self->unlink_save;
2315 $self->destroy;
2316}
2317
2318my $nuke_counter = "aaaa";
2319
2320sub nuke {
2321 my ($self) = @_;
2322
2323 {
2324 my $lock = cf::lock_acquire "map_data:$self->{path}";
2325
2326 delete $cf::MAP{$self->path};
2327
2328 $self->unlink_save;
2329
2330 bless $self, "cf::map";
2331 delete $self->{deny_reset};
2332 $self->{deny_save} = 1;
2333 $self->reset_timeout (1);
2334 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2335
2336 $cf::MAP{$self->path} = $self;
2337 }
2338
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 ]
2376}
2377
2378=item cf::map::unique_maps
2379
2380Returns an arrayref of paths of all shared maps that have
2381instantiated unique items. May block.
2382
2383=cut
2384
2385sub unique_maps() {
2386 [
2387 map {
2388 utf8::decode $_;
2389 s/\.map$//; # TODO future compatibility hack
2390 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2391 ? ()
2392 : normalise $_
2393 } @{ aio_readdir $UNIQUEDIR or [] }
2394 ]
2395}
2396
2397=back
2398
2399=head3 cf::object
2400
2401=cut
2402
2403package cf::object;
999 2404
1000=over 4 2405=over 4
1001 2406
1002=item cf::player::exists $login 2407=item $ob->inv_recursive
1003 2408
1004Returns true when the given account exists. 2409Returns the inventory of the object I<and> their inventories, recursively,
2410but I<not> the object itself.
1005 2411
1006=cut 2412=cut
1007 2413
1008sub cf::player::exists($) { 2414sub inv_recursive_;
1009 cf::player::find $_[0] 2415sub inv_recursive_ {
1010 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2416 map { $_, inv_recursive_ $_->inv } @_
1011} 2417}
1012 2418
1013=item $player->ext_reply ($msgid, $msgtype, %msg) 2419sub inv_recursive {
1014 2420 inv_recursive_ inv $_[0]
1015Sends an ext reply to the player.
1016
1017=cut
1018
1019sub cf::player::ext_reply($$$%) {
1020 my ($self, $id, %msg) = @_;
1021
1022 $msg{msgid} = $id;
1023
1024 $self->send ("ext " . to_json \%msg);
1025} 2421}
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
2451package cf;
1026 2452
1027=back 2453=back
1028 2454
1029=head3 cf::object::player 2455=head3 cf::object::player
1030 2456
1035Sends 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>
1036can 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
1037dialogue with the given NPC character. 2463dialogue with the given NPC character.
1038 2464
1039=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};
1040 2480
1041# rough implementation of a future "reply" method that works 2481# rough implementation of a future "reply" method that works
1042# with dialog boxes. 2482# with dialog boxes.
1043#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
1044sub cf::object::player::reply($$$;$) { 2484sub cf::object::player::reply($$$;$) {
1046 2486
1047 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2487 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1048 2488
1049 if ($self->{record_replies}) { 2489 if ($self->{record_replies}) {
1050 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2490 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2491
1051 } 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 {
1052 $msg = $npc->name . " says: $msg" if $npc; 2500 $msg = $npc->name . " says: $msg" if $npc;
1053 $self->message ($msg, $flags); 2501 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2502 }
1054 } 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 (@_);
1055} 2514}
1056 2515
1057=item $player_object->may ("access") 2516=item $player_object->may ("access")
1058 2517
1059Returns wether the given player is authorized to access resource "access" 2518Returns wether the given player is authorized to access resource "access"
1068 (ref $cf::CFG{"may_$access"} 2527 (ref $cf::CFG{"may_$access"}
1069 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2528 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1070 : $cf::CFG{"may_$access"}) 2529 : $cf::CFG{"may_$access"})
1071} 2530}
1072 2531
2532=item $player_object->enter_link
2533
2534Freezes the player and moves him/her to a special map (C<{link}>).
2535
2536The player should be reasonably safe there for short amounts of time. You
2537I<MUST> call C<leave_link> as soon as possible, though.
2538
2539Will never block.
2540
2541=item $player_object->leave_link ($map, $x, $y)
2542
2543Moves the player out of the special C<{link}> map onto the specified
2544map. If the map is not valid (or omitted), the player will be moved back
2545to the location he/she was before the call to C<enter_link>, or, if that
2546fails, to the emergency map position.
2547
2548Might block.
2549
2550=cut
2551
2552sub link_map {
2553 unless ($LINK_MAP) {
2554 $LINK_MAP = cf::map::find "{link}"
2555 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2556 $LINK_MAP->load;
2557 }
2558
2559 $LINK_MAP
2560}
2561
2562sub cf::object::player::enter_link {
2563 my ($self) = @_;
2564
2565 $self->deactivate_recursive;
2566
2567 return if UNIVERSAL::isa $self->map, "ext::map_link";
2568
2569 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2570 if $self->map && $self->map->{path} ne "{link}";
2571
2572 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2573}
2574
2575sub cf::object::player::leave_link {
2576 my ($self, $map, $x, $y) = @_;
2577
2578 return unless $self->contr->active;
2579
2580 my $link_pos = delete $self->{_link_pos};
2581
2582 unless ($map) {
2583 # restore original map position
2584 ($map, $x, $y) = @{ $link_pos || [] };
2585 $map = cf::map::find $map;
2586
2587 unless ($map) {
2588 ($map, $x, $y) = @$EMERGENCY_POSITION;
2589 $map = cf::map::find $map
2590 or die "FATAL: cannot load emergency map\n";
2591 }
2592 }
2593
2594 ($x, $y) = (-1, -1)
2595 unless (defined $x) && (defined $y);
2596
2597 # use -1 or undef as default coordinates, not 0, 0
2598 ($x, $y) = ($map->enter_x, $map->enter_y)
2599 if $x <=0 && $y <= 0;
2600
2601 $map->load;
2602 $map->load_neighbours;
2603
2604 return unless $self->contr->active;
2605 $self->activate_recursive;
2606
2607 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2608 $self->enter_map ($map, $x, $y);
2609}
2610
2611=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2612
2613Moves the player to the given map-path and coordinates by first freezing
2614her, loading and preparing them map, calling the provided $check callback
2615that has to return the map if sucecssful, and then unfreezes the player on
2616the new (success) or old (failed) map position. In either case, $done will
2617be called at the end of this process.
2618
2619Note that $check will be called with a potentially non-loaded map, so if
2620it needs a loaded map it has to call C<< ->load >>.
2621
2622=cut
2623
2624our $GOTOGEN;
2625
2626sub cf::object::player::goto {
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;
2631
2632 $self->enter_link;
2633
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
2656 my $map = eval {
2657 my $map = defined $path ? cf::map::find $path : undef;
2658
2659 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
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 $@;
2672 }
2673
2674 if ($gen == $self->{_goto_generation}) {
2675 delete $self->{_goto_generation};
2676 $self->leave_link ($map, $x, $y);
2677 }
2678
2679 $done->() if $done;
2680 })->prio (1);
2681}
2682
2683=item $player_object->enter_exit ($exit_object)
2684
2685=cut
2686
2687sub parse_random_map_params {
2688 my ($spec) = @_;
2689
2690 my $rmp = { # defaults
2691 xsize => (cf::rndm 15, 40),
2692 ysize => (cf::rndm 15, 40),
2693 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2694 #layout => string,
2695 };
2696
2697 for (split /\n/, $spec) {
2698 my ($k, $v) = split /\s+/, $_, 2;
2699
2700 $rmp->{lc $k} = $v if (length $k) && (length $v);
2701 }
2702
2703 $rmp
2704}
2705
2706sub prepare_random_map {
2707 my ($exit) = @_;
2708
2709 # all this does is basically replace the /! path by
2710 # a new random map path (?random/...) with a seed
2711 # that depends on the exit object
2712
2713 my $rmp = parse_random_map_params $exit->msg;
2714
2715 if ($exit->map) {
2716 $rmp->{region} = $exit->region->name;
2717 $rmp->{origin_map} = $exit->map->path;
2718 $rmp->{origin_x} = $exit->x;
2719 $rmp->{origin_y} = $exit->y;
2720
2721 $exit->map->touch;
2722 }
2723
2724 $rmp->{random_seed} ||= $exit->random_seed;
2725
2726 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2727 my $md5 = Digest::MD5::md5_hex $data;
2728 my $meta = "$RANDOMDIR/$md5.meta";
2729
2730 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2731 aio_write $fh, 0, (length $data), $data, 0;
2732 undef $fh;
2733 aio_rename "$meta~", $meta;
2734
2735 my $slaying = "?random/$md5";
2736
2737 if ($exit->valid) {
2738 $exit->slaying ("?random/$md5");
2739 $exit->msg (undef);
2740 }
2741 }
2742}
2743
2744sub cf::object::player::enter_exit {
2745 my ($self, $exit) = @_;
2746
2747 return unless $self->type == cf::PLAYER;
2748
2749 $self->enter_link;
2750
2751 (async {
2752 $Coro::current->{desc} = "enter_exit";
2753
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
2769 $self->goto ($map, $x, $y);
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
2775 1
2776 }) {
2777 $self->message ("Something went wrong deep within the crossfire server. "
2778 . "I'll try to bring you back to the map you were before. "
2779 . "Please report this to the dungeon master!",
2780 cf::NDI_UNIQUE | cf::NDI_RED);
2781
2782 warn "ERROR in enter_exit: $@";
2783 $self->leave_link;
2784 }
2785 })->prio (1);
2786}
2787
1073=head3 cf::client 2788=head3 cf::client
1074 2789
1075=over 4 2790=over 4
1076 2791
1077=item $client->send_drawinfo ($text, $flags) 2792=item $client->send_drawinfo ($text, $flags)
1083 2798
1084sub cf::client::send_drawinfo { 2799sub cf::client::send_drawinfo {
1085 my ($self, $text, $flags) = @_; 2800 my ($self, $text, $flags) = @_;
1086 2801
1087 utf8::encode $text; 2802 utf8::encode $text;
1088 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2803 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1089} 2804}
1090 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}
1091 2970
1092=item $success = $client->query ($flags, "text", \&cb) 2971=item $success = $client->query ($flags, "text", \&cb)
1093 2972
1094Queues a query to the client, calling the given callback with 2973Queues a query to the client, calling the given callback with
1095the 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>,
1096C<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>.
1097 2976
1098Queries 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
1099reliable at some point in the future. 2978become reliable at some point in the future.
1100 2979
1101=cut 2980=cut
1102 2981
1103sub cf::client::query { 2982sub cf::client::query {
1104 my ($self, $flags, $text, $cb) = @_; 2983 my ($self, $flags, $text, $cb) = @_;
1112 utf8::encode $text; 2991 utf8::encode $text;
1113 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2992 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1114 2993
1115 $self->send_packet ($self->{query_queue}[0][0]) 2994 $self->send_packet ($self->{query_queue}[0][0])
1116 if @{ $self->{query_queue} } == 1; 2995 if @{ $self->{query_queue} } == 1;
2996
2997 1
1117} 2998}
1118 2999
1119cf::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 },
1120 on_reply => sub { 3006 on_reply => sub {
1121 my ($ns, $msg) = @_; 3007 my ($ns, $msg) = @_;
1122 3008
1123 # this weird shuffling is so that direct followup queries 3009 # this weird shuffling is so that direct followup queries
1124 # get handled first 3010 # get handled first
1125 my $queue = delete $ns->{query_queue}; 3011 my $queue = delete $ns->{query_queue}
3012 or return; # be conservative, not sure how that can happen, but we saw a crash here
1126 3013
1127 (shift @$queue)->[1]->($msg); 3014 (shift @$queue)->[1]->($msg);
3015 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1128 3016
1129 push @{ $ns->{query_queue} }, @$queue; 3017 push @{ $ns->{query_queue} }, @$queue;
1130 3018
1131 if (@{ $ns->{query_queue} } == @$queue) { 3019 if (@{ $ns->{query_queue} } == @$queue) {
1132 if (@$queue) { 3020 if (@$queue) {
1134 } else { 3022 } else {
1135 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3023 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1136 } 3024 }
1137 } 3025 }
1138 }, 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 },
1139); 3053);
1140 3054
1141=item $client->coro (\&cb) 3055=item $client->async (\&cb)
1142 3056
1143Create a new coroutine, running the specified callback. The coroutine will 3057Create a new coroutine, running the specified callback. The coroutine will
1144be automatically cancelled when the client gets destroyed (e.g. on logout, 3058be automatically cancelled when the client gets destroyed (e.g. on logout,
1145or loss of connection). 3059or loss of connection).
1146 3060
1147=cut 3061=cut
1148 3062
1149sub cf::client::coro { 3063sub cf::client::async {
1150 my ($self, $cb) = @_; 3064 my ($self, $cb) = @_;
1151 3065
1152 my $coro; $coro = async { 3066 my $coro = &Coro::async ($cb);
1153 eval {
1154 $cb->();
1155 };
1156 warn $@ if $@;
1157 };
1158 3067
1159 $coro->on_destroy (sub { 3068 $coro->on_destroy (sub {
1160 delete $self->{_coro}{$coro+0}; 3069 delete $self->{_coro}{$coro+0};
1161 }); 3070 });
1162 3071
1189our $safe = new Safe "safe"; 3098our $safe = new Safe "safe";
1190our $safe_hole = new Safe::Hole; 3099our $safe_hole = new Safe::Hole;
1191 3100
1192$SIG{FPE} = 'IGNORE'; 3101$SIG{FPE} = 'IGNORE';
1193 3102
1194$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));
1195 3108
1196# here we export the classes and methods available to script code 3109# here we export the classes and methods available to script code
1197 3110
1198=pod 3111=pod
1199 3112
1200The following fucntions and emthods are available within a safe environment: 3113The following functions and methods are available within a safe environment:
1201 3114
1202 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
1203 cf::object::player player 3119 cf::object::player
1204 cf::player peaceful 3120 player
1205 cf::map trigger 3121
3122 cf::player
3123 peaceful
3124
3125 cf::map
3126 trigger
1206 3127
1207=cut 3128=cut
1208 3129
1209for ( 3130for (
1210 ["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)],
1211 ["cf::object::player" => qw(player)], 3134 ["cf::object::player" => qw(player)],
1212 ["cf::player" => qw(peaceful)], 3135 ["cf::player" => qw(peaceful)],
1213 ["cf::map" => qw(trigger)], 3136 ["cf::map" => qw(trigger)],
1214) { 3137) {
1215 no strict 'refs'; 3138 no strict 'refs';
1286=back 3209=back
1287 3210
1288=cut 3211=cut
1289 3212
1290############################################################################# 3213#############################################################################
3214# the server's init and main functions
1291 3215
1292=head2 EXTENSION DATABASE SUPPORT 3216sub load_facedata($) {
3217 my ($path) = @_;
1293 3218
1294Crossfire maintains a very simple database for extension use. It can 3219 # HACK to clear player env face cache, we need some signal framework
1295currently store anything that can be serialised using Storable, which 3220 # for this (global event?)
1296excludes objects. 3221 %ext::player_env::MUSIC_FACE_CACHE = ();
1297 3222
1298The parameter C<$family> should best start with the name of the extension 3223 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1299using it, it should be unique.
1300 3224
1301=over 4 3225 warn "loading facedata from $path\n";
1302 3226
1303=item $hashref = cf::db_get $family 3227 my $facedata;
3228 0 < aio_load $path, $facedata
3229 or die "$path: $!";
1304 3230
1305Return a hashref for use by the extension C<$family>, which can be 3231 $facedata = Coro::Storable::thaw $facedata;
1306modified. After modifications, you have to call C<cf::db_dirty> or
1307C<cf::db_sync>.
1308 3232
1309=item $value = cf::db_get $family => $key 3233 $facedata->{version} == 2
3234 or cf::cleanup "$path: version mismatch, cannot proceed.";
1310 3235
1311Returns a single value from the database 3236 # patch in the exptable
1312 3237 $facedata->{resource}{"res/exp_table"} = {
1313=item cf::db_put $family => $hashref 3238 type => FT_RSRC,
1314 3239 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1315Stores the given family hashref into the database. Updates are delayed, if
1316you want the data to be synced to disk immediately, use C<cf::db_sync>.
1317
1318=item cf::db_put $family => $key => $value
1319
1320Stores the given C<$value> in the family hash. Updates are delayed, if you
1321want the data to be synced to disk immediately, use C<cf::db_sync>.
1322
1323=item cf::db_dirty
1324
1325Marks the database as dirty, to be updated at a later time.
1326
1327=item cf::db_sync
1328
1329Immediately write the database to disk I<if it is dirty>.
1330
1331=cut
1332
1333our $DB;
1334
1335{
1336 my $path = cf::localdir . "/database.pst";
1337
1338 sub db_load() {
1339 warn "loading database $path\n";#d# remove later
1340 $DB = stat $path ? Storable::retrieve $path : { };
1341 }
1342
1343 my $pid;
1344
1345 sub db_save() {
1346 warn "saving database $path\n";#d# remove later
1347 waitpid $pid, 0 if $pid;
1348 if (0 == ($pid = fork)) {
1349 $DB->{_meta}{version} = 1;
1350 Storable::nstore $DB, "$path~";
1351 rename "$path~", $path;
1352 cf::_exit 0 if defined $pid;
1353 }
1354 }
1355
1356 my $dirty;
1357
1358 sub db_sync() {
1359 db_save if $dirty;
1360 undef $dirty;
1361 }
1362
1363 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1364 db_sync;
1365 }); 3240 };
3241 cf::cede_to_tick;
1366 3242
1367 sub db_dirty() {
1368 $dirty = 1;
1369 $idle->start;
1370 } 3243 {
3244 my $faces = $facedata->{faceinfo};
1371 3245
1372 sub db_get($;$) { 3246 while (my ($face, $info) = each %$faces) {
1373 @_ >= 2 3247 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1374 ? $DB->{$_[0]}{$_[1]}
1375 : ($DB->{$_[0]} ||= { })
1376 }
1377 3248
1378 sub db_put($$;$) { 3249 cf::face::set_visibility $idx, $info->{visibility};
1379 if (@_ >= 3) { 3250 cf::face::set_magicmap $idx, $info->{magicmap};
1380 $DB->{$_[0]}{$_[1]} = $_[2]; 3251 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1381 } else { 3252 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1382 $DB->{$_[0]} = $_[1];
1383 }
1384 db_dirty;
1385 }
1386 3253
1387 cf::global->attach ( 3254 cf::cede_to_tick;
1388 prio => 10000,
1389 on_cleanup => sub {
1390 db_sync;
1391 }, 3255 }
1392 );
1393}
1394 3256
1395############################################################################# 3257 while (my ($face, $info) = each %$faces) {
1396# the server's main() 3258 next unless $info->{smooth};
1397 3259
1398sub cfg_load { 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
3351sub load_resource_file($) {
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"
3367 or die "unable to load regions file\n";
3368
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 {
1399 open my $fh, "<:utf8", cf::confdir . "/config" 3410 open my $fh, "<:utf8", "$CONFDIR/config"
1400 or return; 3411 or return;
1401 3412
1402 local $/; 3413 local $/;
1403 *CFG = YAML::Syck::Load <$fh>; 3414 *CFG = YAML::Load <$fh>;
3415
3416 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3417
3418 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3419 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3420
3421 if (exists $CFG{mlockall}) {
3422 eval {
3423 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3424 and die "WARNING: m(un)lockall failed: $!\n";
3425 };
3426 warn $@ if $@;
3427 }
1404} 3428}
1405 3429
1406sub main { 3430sub main {
1407 # we must not ever block the main coroutine 3431 # we must not ever block the main coroutine
1408 local $Coro::idle = sub { 3432 local $Coro::idle = sub {
1409 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3433 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1410 (Coro::unblock_sub { 3434 (async {
1411 Event::one_event; 3435 $Coro::current->{desc} = "IDLE BUG HANDLER";
1412 })->(); 3436 EV::loop EV::LOOP_ONESHOT;
3437 })->prio (Coro::PRIO_MAX);
1413 }; 3438 };
1414 3439
1415 cfg_load; 3440 {
1416 db_load; 3441 my $guard = freeze_mainloop;
3442 reload_config;
3443 db_init;
1417 load_extensions; 3444 load_extensions;
3445
3446 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3447 }
3448
1418 Event::loop; 3449 EV::loop;
1419} 3450}
1420 3451
1421############################################################################# 3452#############################################################################
1422# initialisation 3453# initialisation and cleanup
1423 3454
1424sub perl_reload() { 3455# install some emergency cleanup handlers
3456BEGIN {
3457 our %SIGWATCHER = ();
3458 for my $signal (qw(INT HUP TERM)) {
3459 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3460 cf::cleanup "SIG$signal";
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
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 };
3544}
3545
3546sub emergency_save() {
3547 my $freeze_guard = cf::freeze_mainloop;
3548
3549 warn "enter emergency perl save\n";
3550
3551 cf::sync_job {
3552 # use a peculiar iteration method to avoid tripping on perl
3553 # refcount bugs in for. also avoids problems with players
3554 # and maps saved/destroyed asynchronously.
3555 warn "begin emergency player save\n";
3556 for my $login (keys %cf::PLAYER) {
3557 my $pl = $cf::PLAYER{$login} or next;
3558 $pl->valid or next;
3559 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3560 $pl->save;
3561 }
3562 warn "end emergency player save\n";
3563
3564 warn "begin emergency map save\n";
3565 for my $path (keys %cf::MAP) {
3566 my $map = $cf::MAP{$path} or next;
3567 $map->valid or next;
3568 $map->save;
3569 }
3570 warn "end emergency map save\n";
3571
3572 warn "begin emergency database checkpoint\n";
3573 BDB::db_env_txn_checkpoint $DB_ENV;
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";
3579 };
3580
3581 warn "leave emergency perl save\n";
3582}
3583
3584sub post_cleanup {
3585 my ($make_core) = @_;
3586
3587 warn Carp::longmess "post_cleanup backtrace"
3588 if $make_core;
3589}
3590
3591sub do_reload_perl() {
1425 # can/must only be called in main 3592 # can/must only be called in main
1426 if ($Coro::current != $Coro::main) { 3593 if ($Coro::current != $Coro::main) {
1427 warn "can only reload from main coroutine\n"; 3594 warn "can only reload from main coroutine";
1428 return; 3595 return;
1429 } 3596 }
1430 3597
1431 warn "reloading..."; 3598 warn "reloading...";
1432 3599
1433 local $FREEZE = 1; 3600 warn "entering sync_job";
3601
3602 cf::sync_job {
3603 cf::write_runtime_sync; # external watchdog should not bark
1434 cf::emergency_save; 3604 cf::emergency_save;
3605 cf::write_runtime_sync; # external watchdog should not bark
1435 3606
1436 eval { 3607 warn "syncing database to disk";
3608 BDB::db_env_txn_checkpoint $DB_ENV;
3609
1437 # 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
1438 3611
1439 # cancel all watchers 3612 warn "flushing outstanding aio requests";
1440 for (Event::all_watchers) { 3613 for (;;) {
1441 $_->cancel if $_->data & WF_AUTOCANCEL; 3614 BDB::flush;
3615 IO::AIO::flush;
3616 Coro::cede_notself;
3617 last unless IO::AIO::nreqs || BDB::nreqs;
3618 warn "iterate...";
1442 } 3619 }
1443 3620
3621 ++$RELOAD;
3622
1444 # cancel all extension coros 3623 warn "cancelling all extension coros";
1445 $_->cancel for values %EXT_CORO; 3624 $_->cancel for values %EXT_CORO;
1446 %EXT_CORO = (); 3625 %EXT_CORO = ();
1447 3626
1448 # unload all extensions 3627 warn "removing commands";
1449 for (@exts) { 3628 %COMMAND = ();
3629
3630 warn "removing ext/exti commands";
3631 %EXTCMD = ();
3632 %EXTICMD = ();
3633
3634 warn "unloading/nuking all extensions";
3635 for my $pkg (@EXTS) {
1450 warn "unloading <$_>"; 3636 warn "... unloading $pkg";
1451 unload_extension $_; 3637
3638 if (my $cb = $pkg->can ("unload")) {
3639 eval {
3640 $cb->($pkg);
3641 1
3642 } or warn "$pkg unloaded, but with errors: $@";
1452 } 3643 }
1453 3644
3645 warn "... nuking $pkg";
3646 Symbol::delete_package $pkg;
3647 }
3648
1454 # unload all modules loaded from $LIBDIR 3649 warn "unloading all perl modules loaded from $LIBDIR";
1455 while (my ($k, $v) = each %INC) { 3650 while (my ($k, $v) = each %INC) {
1456 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3651 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1457 3652
1458 warn "removing <$k>"; 3653 warn "... unloading $k";
1459 delete $INC{$k}; 3654 delete $INC{$k};
1460 3655
1461 $k =~ s/\.pm$//; 3656 $k =~ s/\.pm$//;
1462 $k =~ s/\//::/g; 3657 $k =~ s/\//::/g;
1463 3658
1466 } 3661 }
1467 3662
1468 Symbol::delete_package $k; 3663 Symbol::delete_package $k;
1469 } 3664 }
1470 3665
1471 # sync database to disk
1472 cf::db_sync;
1473 IO::AIO::flush;
1474
1475 # get rid of safe::, as good as possible 3666 warn "getting rid of safe::, as good as possible";
1476 Symbol::delete_package "safe::$_" 3667 Symbol::delete_package "safe::$_"
1477 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);
1478 3669
1479 # remove register_script_function callbacks
1480 # TODO
1481
1482 # unload cf.pm "a bit" 3670 warn "unloading cf.pm \"a bit\"";
1483 delete $INC{"cf.pm"}; 3671 delete $INC{"cf.pm"};
3672 delete $INC{"cf/pod.pm"};
1484 3673
1485 # don't, removes xs symbols, too, 3674 # don't, removes xs symbols, too,
1486 # and global variables created in xs 3675 # and global variables created in xs
1487 #Symbol::delete_package __PACKAGE__; 3676 #Symbol::delete_package __PACKAGE__;
1488 3677
1489 # reload cf.pm 3678 warn "unload completed, starting to reload now";
3679
1490 warn "reloading cf.pm"; 3680 warn "reloading cf.pm";
1491 require cf; 3681 require cf;
1492 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3682 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1493 3683
1494 # load config and database again 3684 warn "loading config and database again";
1495 cf::cfg_load; 3685 cf::reload_config;
1496 cf::db_load;
1497 3686
1498 # load extensions
1499 warn "load extensions"; 3687 warn "loading extensions";
1500 cf::load_extensions; 3688 cf::load_extensions;
1501 3689
1502 # reattach attachments to objects 3690 warn "reattaching attachments to objects/players";
1503 warn "reattach"; 3691 _global_reattach; # objects, sockets
1504 _global_reattach; 3692 warn "reattaching attachments to maps";
3693 reattach $_ for values %MAP;
3694 warn "reattaching attachments to players";
3695 reattach $_ for values %PLAYER;
3696
3697 warn "leaving sync_job";
3698
3699 1
3700 } or do {
3701 warn $@;
3702 cf::cleanup "error while reloading, exiting.";
1505 }; 3703 };
1506 3704
1507 if ($@) { 3705 warn "reloaded";
1508 warn $@;
1509 warn "error while reloading, exiting.";
1510 exit 1;
1511 }
1512
1513 warn "reloaded successfully";
1514}; 3706};
1515 3707
1516############################################################################# 3708our $RELOAD_WATCHER; # used only during reload
1517 3709
1518unless ($LINK_MAP) { 3710sub reload_perl() {
1519 $LINK_MAP = cf::map::new; 3711 # doing reload synchronously and two reloads happen back-to-back,
3712 # coro crashes during coro_state_free->destroy here.
1520 3713
1521 $LINK_MAP->width (41); 3714 $RELOAD_WATCHER ||= EV::timer 0, 0, sub {
1522 $LINK_MAP->height (41); 3715 do_reload_perl;
1523 $LINK_MAP->alloc; 3716 undef $RELOAD_WATCHER;
1524 $LINK_MAP->path ("{link}"); 3717 };
1525 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1526 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1527} 3718}
1528 3719
1529register "<global>", __PACKAGE__;
1530
1531register_command "perl-reload" => sub { 3720register_command "reload" => sub {
1532 my ($who, $arg) = @_; 3721 my ($who, $arg) = @_;
1533 3722
1534 if ($who->flag (FLAG_WIZ)) { 3723 if ($who->flag (FLAG_WIZ)) {
1535 $who->message ("start of reload.");
1536 perl_reload;
1537 $who->message ("end of reload."); 3724 $who->message ("reloading server.");
3725 async {
3726 $Coro::current->{desc} = "perl_reload";
3727 reload_perl;
3728 };
1538 } 3729 }
1539}; 3730};
1540 3731
1541unshift @INC, $LIBDIR; 3732unshift @INC, $LIBDIR;
1542 3733
1543$TICK_WATCHER = Event->timer ( 3734my $bug_warning = 0;
1544 reentrant => 0, 3735
1545 prio => 0, 3736our @WAIT_FOR_TICK;
1546 at => $NEXT_TICK || $TICK, 3737our @WAIT_FOR_TICK_BEGIN;
1547 data => WF_AUTOCANCEL, 3738
1548 cb => sub { 3739sub wait_for_tick {
1549 unless ($FREEZE) { 3740 return if tick_inhibit || $Coro::current == $Coro::main;
3741
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 {
3756 if ($Coro::current != $Coro::main) {
3757 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3758 unless ++$bug_warning > 10;
3759 return;
3760 }
3761
1550 cf::server_tick; # one server iteration 3762 cf::server_tick; # one server iteration
1551 $RUNTIME += $TICK;
1552 }
1553 3763
1554 $NEXT_TICK += $TICK; 3764 if ($NOW >= $NEXT_RUNTIME_WRITE) {
1555 3765 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
1556 # if we are delayed by four ticks or more, skip them all 3766 Coro::async_pool {
1557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3767 $Coro::current->{desc} = "runtime saver";
1558
1559 $TICK_WATCHER->at ($NEXT_TICK);
1560 $TICK_WATCHER->start;
1561 },
1562);
1563
1564IO::AIO::max_poll_time $TICK * 0.2;
1565
1566Event->io (
1567 fd => IO::AIO::poll_fileno,
1568 poll => 'r',
1569 prio => 5,
1570 data => WF_AUTOCANCEL,
1571 cb => \&IO::AIO::poll_cb,
1572);
1573
1574Event->timer (
1575 data => WF_AUTOCANCEL,
1576 after => 0,
1577 interval => 10,
1578 cb => sub {
1579 (Coro::unblock_sub {
1580 write_runtime 3768 write_runtime_sync
1581 or warn "ERROR: unable to write runtime file: $!"; 3769 or warn "ERROR: unable to write runtime file: $!";
1582 })->(); 3770 };
1583 }, 3771 }
1584); 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}
3791
3792{
3793 # configure BDB
3794
3795 BDB::min_parallel 8;
3796 BDB::max_poll_reqs $TICK * 0.1;
3797 $AnyEvent::BDB::WATCHER->priority (1);
3798
3799 unless ($DB_ENV) {
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);
3806
3807 cf::sync_job {
3808 eval {
3809 BDB::db_env_open
3810 $DB_ENV,
3811 $BDBDIR,
3812 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3813 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3814 0666;
3815
3816 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3817 };
3818
3819 cf::cleanup "db_env_open(db): $@" if $@;
3820 };
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 };
3832}
3833
3834{
3835 # configure IO::AIO
3836
3837 IO::AIO::min_parallel 8;
3838 IO::AIO::max_poll_time $TICK * 0.1;
3839 undef $AnyEvent::AIO::WATCHER;
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;
3884
3885END { cf::emergency_save }
1585 3886
15861 38871
1587 3888

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines