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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines