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.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.540 by root, Tue May 4 23:32:29 2010 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify it under
7# the terms of the Affero GNU General Public License as published by the
8# Free Software Foundation, either version 3 of the License, or (at your
9# 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 Affero GNU General Public License
17# and the GNU General Public License along with this program. If not, see
18# <http://www.gnu.org/licenses/>.
19#
20# The authors can be reached via e-mail to <support@deliantra.net>
21#
22
1package cf; 23package cf;
2 24
3use utf8; 25use common::sense;
4use 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 ();
35use Carp ();
12 36
37use Guard ();
13use Coro 3.3; 38use Coro ();
39use Coro::State;
40use Coro::Handle;
41use Coro::EV;
14use Coro::Event; 42use Coro::AnyEvent;
15use Coro::Timer; 43use Coro::Timer;
16use Coro::Signal; 44use Coro::Signal;
17use Coro::Semaphore; 45use Coro::Semaphore;
46use Coro::SemaphoreSet;
47use Coro::AnyEvent;
18use Coro::AIO; 48use Coro::AIO;
49use Coro::BDB 1.6;
50use Coro::Storable;
51use Coro::Util ();
19 52
20use Digest::MD5; 53use JSON::XS 2.01 ();
54use BDB ();
55use Data::Dumper;
21use Fcntl; 56use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 57use YAML::XS ();
58use IO::AIO ();
24use Time::HiRes; 59use Time::HiRes;
60use Compress::LZF;
61use Digest::MD5 ();
25 62
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 63AnyEvent::detect;
27 64
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 65# configure various modules to our taste
29$YAML::Syck::ImplicitUnicode = 1; 66#
67$Storable::canonical = 1; # reduce rsync transfers
68Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
30 69
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 70$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
71
72# make sure c-lzf reinitialises itself
73Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
74Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
75
76# strictly for debugging
77$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
32 78
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 79sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
80
81our @ORIG_INC;
34 82
35our %COMMAND = (); 83our %COMMAND = ();
36our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
85
86our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
89our %EXT_CORO = (); # coroutines bound to extensions
90our %EXT_MAP = (); # pluggable maps
38 91
92our $RELOAD; # number of reloads so far, non-zero while in reload
39our @EVENT; 93our @EVENT;
40our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
41 96
42our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
43our $TICK_WATCHER; 98our $DATADIR = datadir;
99our $LIBDIR = "$DATADIR/ext";
100our $PODDIR = "$DATADIR/pod";
101our $MAPDIR = "$DATADIR/" . mapdir;
102our $LOCALDIR = localdir;
103our $TMPDIR = "$LOCALDIR/" . tmpdir;
104our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
105our $PLAYERDIR = "$LOCALDIR/" . playerdir;
106our $RANDOMDIR = "$LOCALDIR/random";
107our $BDBDIR = "$LOCALDIR/db";
108our $PIDFILE = "$LOCALDIR/pid";
109our $RUNTIMEFILE = "$LOCALDIR/runtime";
110
111our %RESOURCE; # unused
112
113our $OUTPUT_RATE_MIN = 3000;
114our $OUTPUT_RATE_MAX = 1000000;
115
116our $MAX_LINKS = 32; # how many chained exits to follow
117our $VERBOSE_IO = 1;
118
119our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
120our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 121our $NEXT_TICK;
45our $NOW; 122our $USE_FSYNC = 1; # use fsync to write maps - default on
123
124our $BDB_DEADLOCK_WATCHER;
125our $BDB_CHECKPOINT_WATCHER;
126our $BDB_TRICKLE_WATCHER;
127our $DB_ENV;
128
129our @EXTRA_MODULES = qw(pod match mapscript);
46 130
47our %CFG; 131our %CFG;
48 132
49our $UPTIME; $UPTIME ||= time; 133our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 134our $RUNTIME;
135our $NOW;
51 136
52our %MAP; # all maps 137our (%PLAYER, %PLAYER_LOADING); # all users
53our $LINK_MAP; # the special {link} map 138our (%MAP, %MAP_LOADING ); # all maps
54our $FREEZE; 139our $LINK_MAP; # the special {link} map, which is always available
55our $RANDOM_MAPS = cf::localdir . "/random"; 140
56our %EXT_CORO; 141# used to convert map paths into valid unix filenames by replacing / by ∕
142our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
143
144our $LOAD; # a number between 0 (idle) and 1 (too many objects)
145our $LOADAVG; # same thing, but with alpha-smoothing
146our $JITTER; # average jitter
147our $TICK_START; # for load detecting purposes
148
149our @POST_INIT;
150
151our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
152our $REALLY_UNLOOP; # never set to true, please :)
57 153
58binmode STDOUT; 154binmode STDOUT;
59binmode STDERR; 155binmode STDERR;
60 156
61# read virtual server time, if available 157# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 158unless ($RUNTIME || !-e $RUNTIMEFILE) {
63 open my $fh, "<", cf::localdir . "/runtime" 159 open my $fh, "<", $RUNTIMEFILE
64 or die "unable to read runtime file: $!"; 160 or die "unable to read $RUNTIMEFILE file: $!";
65 $RUNTIME = <$fh> + 0.; 161 $RUNTIME = <$fh> + 0.;
66} 162}
67 163
68mkdir cf::localdir; 164eval "sub TICK() { $TICK } 1" or die;
69mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 165
74# a special map that is always available 166mkdir $_
75our $LINK_MAP; 167 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
76 168
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 169our $EMERGENCY_POSITION;
170
171sub cf::map::normalise;
172
173sub in_main() {
174 $Coro::current == $Coro::main
175}
176
177#############################################################################
178
179%REFLECT = ();
180for (@REFLECT) {
181 my $reflect = JSON::XS::decode_json $_;
182 $REFLECT{$reflect->{class}} = $reflect;
183}
184
185# this is decidedly evil
186$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
78 187
79############################################################################# 188#############################################################################
80 189
81=head2 GLOBAL VARIABLES 190=head2 GLOBAL VARIABLES
82 191
89=item $cf::RUNTIME 198=item $cf::RUNTIME
90 199
91The time this server has run, starts at 0 and is increased by $cf::TICK on 200The time this server has run, starts at 0 and is increased by $cf::TICK on
92every server tick. 201every server tick.
93 202
94=item $cf::LIBDIR 203=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
204$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
205$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
95 206
96The perl library directory, where extensions and cf-specific modules can 207Various directories - "/etc", read-only install directory, perl-library
97be found. It will be added to C<@INC> automatically. 208directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
209unique-items directory, player file directory, random maps directory and
210database environment.
98 211
99=item $cf::NOW 212=item $cf::NOW
100 213
101The time of the last (current) server tick. 214The time of the last (current) server tick.
102 215
103=item $cf::TICK 216=item $cf::TICK
104 217
105The interval between server ticks, in seconds. 218The interval between server ticks, in seconds.
106 219
220=item $cf::LOADAVG
221
222The current CPU load on the server (alpha-smoothed), as a value between 0
223(none) and 1 (overloaded), indicating how much time is spent on processing
224objects per tick. Healthy values are < 0.5.
225
226=item $cf::LOAD
227
228The raw value load value from the last tick.
229
107=item %cf::CFG 230=item %cf::CFG
108 231
109Configuration for the server, loaded from C</etc/crossfire/config>, or 232Configuration for the server, loaded from C</etc/deliantra-server/config>, or
110from wherever your confdir points to. 233from wherever your confdir points to.
111 234
235=item cf::wait_for_tick, cf::wait_for_tick_begin
236
237These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
238returns directly I<after> the tick processing (and consequently, can only wake one process
239per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
240
241=item @cf::INVOKE_RESULTS
242
243This array contains the results of the last C<invoke ()> call. When
244C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
245that call.
246
247=item %cf::REFLECT
248
249Contains, for each (C++) class name, a hash reference with information
250about object members (methods, scalars, arrays and flags) and other
251metadata, which is useful for introspection.
252
112=back 253=back
113 254
114=cut 255=cut
115 256
116BEGIN { 257sub error(@) { LOG llevError, join "", @_ }
117 *CORE::GLOBAL::warn = sub { 258sub warn (@) { LOG llevWarn , join "", @_ }
259sub info (@) { LOG llevInfo , join "", @_ }
260sub debug(@) { LOG llevDebug, join "", @_ }
261sub trace(@) { LOG llevTrace, join "", @_ }
262
263$Coro::State::WARNHOOK = sub {
118 my $msg = join "", @_; 264 my $msg = join "", @_;
119 utf8::encode $msg;
120 265
121 $msg .= "\n" 266 $msg .= "\n"
122 unless $msg =~ /\n$/; 267 unless $msg =~ /\n$/;
123 268
124 LOG llevError, "cfperl: $msg"; 269 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
125 }; 270
126} 271 LOG llevWarn, $msg;
272};
273
274$Coro::State::DIEHOOK = sub {
275 return unless $^S eq 0; # "eq", not "=="
276
277 error Carp::longmess $_[0];
278
279 if (in_main) {#d#
280 error "DIEHOOK called in main context, Coro bug?\n";#d#
281 return;#d#
282 }#d#
283
284 # kill coroutine otherwise
285 Coro::terminate
286};
127 287
128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 288@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 289@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 290@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 291@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 292@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
293@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
133@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 294@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
134 295
135# we bless all objects into (empty) derived classes to force a method lookup 296# we bless all objects into (empty) derived classes to force a method lookup
136# within the Safe compartment. 297# within the Safe compartment.
137for my $pkg (qw( 298for my $pkg (qw(
138 cf::global cf::attachable 299 cf::global cf::attachable
139 cf::object cf::object::player 300 cf::object cf::object::player
140 cf::client cf::player 301 cf::client cf::player
141 cf::arch cf::living 302 cf::arch cf::living
303 cf::map cf::mapspace
142 cf::map cf::party cf::region 304 cf::party cf::region
143)) { 305)) {
144 no strict 'refs';
145 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 306 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
146} 307}
147 308
148$Event::DIED = sub { 309$EV::DIED = sub {
149 warn "error in event callback: @_"; 310 Carp::cluck "error in event callback: @_";
150}; 311};
151 312
152my %ext_pkg; 313#############################################################################
153my @exts;
154my @hook;
155 314
156=head2 UTILITY FUNCTIONS 315=head2 UTILITY FUNCTIONS
157 316
158=over 4 317=over 4
159 318
160=cut 319=item dumpval $ref
161 320
162use JSON::Syck (); # TODO# replace by JSON::PC once working 321=cut
163 322
323sub dumpval {
324 eval {
325 local $SIG{__DIE__};
326 my $d;
327 if (1) {
328 $d = new Data::Dumper([$_[0]], ["*var"]);
329 $d->Terse(1);
330 $d->Indent(2);
331 $d->Quotekeys(0);
332 $d->Useqq(1);
333 #$d->Bless(...);
334 $d->Seen($_[1]) if @_ > 1;
335 $d = $d->Dump();
336 }
337 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
338 $d
339 } || "[unable to dump $_[0]: '$@']";
340}
341
164=item $ref = cf::from_json $json 342=item $ref = cf::decode_json $json
165 343
166Converts a JSON string into the corresponding perl data structure. 344Converts a JSON string into the corresponding perl data structure.
167 345
168=cut
169
170sub from_json($) {
171 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172 JSON::Syck::Load $_[0]
173}
174
175=item $json = cf::to_json $ref 346=item $json = cf::encode_json $ref
176 347
177Converts a perl data structure into its JSON representation. 348Converts a perl data structure into its JSON representation.
178 349
179=cut 350=cut
180 351
181sub to_json($) { 352our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 353
183 JSON::Syck::Dump $_[0] 354sub encode_json($) { $json_coder->encode ($_[0]) }
355sub decode_json($) { $json_coder->decode ($_[0]) }
356
357=item cf::post_init { BLOCK }
358
359Execute the given codeblock, I<after> all extensions have been (re-)loaded,
360but I<before> the server starts ticking again.
361
362The cdoeblock will have a single boolean argument to indicate whether this
363is a reload or not.
364
365=cut
366
367sub post_init(&) {
368 push @POST_INIT, shift;
184} 369}
370
371=item cf::lock_wait $string
372
373Wait until the given lock is available. See cf::lock_acquire.
374
375=item my $lock = cf::lock_acquire $string
376
377Wait until the given lock is available and then acquires it and returns
378a L<Guard> object. If the guard object gets destroyed (goes out of scope,
379for example when the coroutine gets canceled), the lock is automatically
380returned.
381
382Locks are *not* recursive, locking from the same coro twice results in a
383deadlocked coro.
384
385Lock names should begin with a unique identifier (for example, cf::map::find
386uses map_find and cf::map::load uses map_load).
387
388=item $locked = cf::lock_active $string
389
390Return true if the lock is currently active, i.e. somebody has locked it.
391
392=cut
393
394our $LOCKS = new Coro::SemaphoreSet;
395
396sub lock_wait($) {
397 $LOCKS->wait ($_[0]);
398}
399
400sub lock_acquire($) {
401 $LOCKS->guard ($_[0])
402}
403
404sub lock_active($) {
405 $LOCKS->count ($_[0]) < 1
406}
407
408sub freeze_mainloop {
409 tick_inhibit_inc;
410
411 &Guard::guard (\&tick_inhibit_dec);
412}
413
414=item cf::periodic $interval, $cb
415
416Like EV::periodic, but randomly selects a starting point so that the actions
417get spread over time.
418
419=cut
420
421sub periodic($$) {
422 my ($interval, $cb) = @_;
423
424 my $start = rand List::Util::min 180, $interval;
425
426 EV::periodic $start, $interval, 0, $cb
427}
428
429=item cf::get_slot $time[, $priority[, $name]]
430
431Allocate $time seconds of blocking CPU time at priority C<$priority>:
432This call blocks and returns only when you have at least C<$time> seconds
433of cpu time till the next tick. The slot is only valid till the next cede.
434
435The optional C<$name> can be used to identify the job to run. It might be
436used for statistical purposes and should identify the same time-class.
437
438Useful for short background jobs.
439
440=cut
441
442our @SLOT_QUEUE;
443our $SLOT_QUEUE;
444our $SLOT_DECAY = 0.9;
445
446$SLOT_QUEUE->cancel if $SLOT_QUEUE;
447$SLOT_QUEUE = Coro::async {
448 $Coro::current->desc ("timeslot manager");
449
450 my $signal = new Coro::Signal;
451 my $busy;
452
453 while () {
454 next_job:
455
456 my $avail = cf::till_tick;
457
458 for (0 .. $#SLOT_QUEUE) {
459 if ($SLOT_QUEUE[$_][0] <= $avail) {
460 $busy = 0;
461 my $job = splice @SLOT_QUEUE, $_, 1, ();
462 $job->[2]->send;
463 Coro::cede;
464 goto next_job;
465 } else {
466 $SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
467 }
468 }
469
470 if (@SLOT_QUEUE) {
471 # we do not use wait_for_tick() as it returns immediately when tick is inactive
472 push @cf::WAIT_FOR_TICK, $signal;
473 $signal->wait;
474 } else {
475 $busy = 0;
476 Coro::schedule;
477 }
478 }
479};
480
481sub get_slot($;$$) {
482 return if tick_inhibit || $Coro::current == $Coro::main;
483
484 my ($time, $pri, $name) = @_;
485
486 $time = clamp $time, 0.01, $TICK * .6;
487
488 my $sig = new Coro::Signal;
489
490 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
491 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
492 $SLOT_QUEUE->ready;
493 $sig->wait;
494}
495
496=item cf::async { BLOCK }
497
498Currently the same as Coro::async_pool, meaning you cannot use
499C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
500thing you are allowed to do is call C<prio> on it.
501
502=cut
503
504BEGIN { *async = \&Coro::async_pool }
185 505
186=item cf::sync_job { BLOCK } 506=item cf::sync_job { BLOCK }
187 507
188The design of crossfire+ requires that the main coro ($Coro::main) is 508The design of Deliantra requires that the main coroutine ($Coro::main)
189always able to handle events or runnable, as crossfire+ is only partly 509is always able to handle events or runnable, as Deliantra is only
190reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 510partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
511acceptable.
191 512
192If it must be done, put the blocking parts into C<sync_job>. This will run 513If it must be done, put the blocking parts into C<sync_job>. This will run
193the given BLOCK in another coroutine while waiting for the result. The 514the given BLOCK in another coroutine while waiting for the result. The
194server will be frozen during this time, so the block should either finish 515server will be frozen during this time, so the block should either finish
195fast or be very important. 516fast or be very important.
197=cut 518=cut
198 519
199sub sync_job(&) { 520sub sync_job(&) {
200 my ($job) = @_; 521 my ($job) = @_;
201 522
523 if (in_main) {
524 my $time = AE::time;
525
526 # this is the main coro, too bad, we have to block
527 # till the operation succeeds, freezing the server :/
528
529 #LOG llevError, Carp::longmess "sync job";#d#
530
531 my $freeze_guard = freeze_mainloop;
532
202 my $busy = 1; 533 my $busy = 1;
203 my @res; 534 my @res;
204 535
205 my $coro = Coro::async { 536 (async {
537 $Coro::current->desc ("sync job coro");
206 @res = eval { $job->() }; 538 @res = eval { $job->() };
207 warn $@ if $@; 539 error $@ if $@;
208 undef $busy; 540 undef $busy;
209 };
210
211 if ($Coro::current == $Coro::main) {
212 # TODO: use suspend/resume instead
213 local $FREEZE = 1;
214 $coro->prio (Coro::PRIO_MAX); 541 })->prio (Coro::PRIO_MAX);
542
215 while ($busy) { 543 while ($busy) {
544 if (Coro::nready) {
216 Coro::cede_notself; 545 Coro::cede_notself;
217 Event::one_event unless Coro::nready; 546 } else {
547 EV::loop EV::LOOP_ONESHOT;
218 } 548 }
549 }
550
551 my $time = AE::time - $time;
552
553 $TICK_START += $time; # do not account sync jobs to server load
554
555 wantarray ? @res : $res[0]
219 } else { 556 } else {
220 $coro->join; 557 # we are in another coroutine, how wonderful, everything just works
558
559 $job->()
221 } 560 }
222
223 wantarray ? @res : $res[0]
224} 561}
225 562
226=item $coro = cf::coro { BLOCK } 563=item $coro = cf::async_ext { BLOCK }
227 564
228Creates and returns a new coro. This coro is automcatially being canceled 565Like async, but this coro is automatically being canceled when the
229when the extension calling this is being unloaded. 566extension calling this is being unloaded.
230 567
231=cut 568=cut
232 569
233sub coro(&) { 570sub async_ext(&) {
234 my $cb = shift; 571 my $cb = shift;
235 572
236 my $coro; $coro = async { 573 my $coro = &Coro::async ($cb);
237 eval {
238 $cb->();
239 };
240 warn $@ if $@;
241 };
242 574
243 $coro->on_destroy (sub { 575 $coro->on_destroy (sub {
244 delete $EXT_CORO{$coro+0}; 576 delete $EXT_CORO{$coro+0};
245 }); 577 });
246 $EXT_CORO{$coro+0} = $coro; 578 $EXT_CORO{$coro+0} = $coro;
247 579
248 $coro 580 $coro
249} 581}
250 582
251sub write_runtime { 583=item fork_call { }, $args
252 my $runtime = cf::localdir . "/runtime";
253 584
254 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 585Executes the given code block with the given arguments in a seperate
255 or return; 586process, returning the results. Everything must be serialisable with
587Coro::Storable. May, of course, block. Note that the executed sub may
588never block itself or use any form of event handling.
256 589
257 my $value = $cf::RUNTIME; 590=cut
258 (aio_write $fh, 0, (length $value), $value, 0) <= 0
259 and return;
260 591
261 aio_fsync $fh 592sub fork_call(&@) {
262 and return; 593 my ($cb, @args) = @_;
263 594
264 close $fh 595 # we seemingly have to make a local copy of the whole thing,
265 or return; 596 # otherwise perl prematurely frees the stuff :/
597 # TODO: investigate and fix (likely this will be rather laborious)
266 598
267 aio_rename "$runtime~", $runtime 599 my @res = Coro::Util::fork_eval {
268 and return; 600 reset_signals;
601 &$cb
602 }, @args;
269 603
604 wantarray ? @res : $res[-1]
605}
606
607sub objinfo {
270 1 608 (
609 "counter value" => cf::object::object_count,
610 "objects created" => cf::object::create_count,
611 "objects destroyed" => cf::object::destroy_count,
612 "freelist size" => cf::object::free_count,
613 "allocated objects" => cf::object::objects_size,
614 "active objects" => cf::object::actives_size,
615 )
616}
617
618=item $coin = coin_from_name $name
619
620=cut
621
622our %coin_alias = (
623 "silver" => "silvercoin",
624 "silvercoin" => "silvercoin",
625 "silvercoins" => "silvercoin",
626 "gold" => "goldcoin",
627 "goldcoin" => "goldcoin",
628 "goldcoins" => "goldcoin",
629 "platinum" => "platinacoin",
630 "platinumcoin" => "platinacoin",
631 "platinumcoins" => "platinacoin",
632 "platina" => "platinacoin",
633 "platinacoin" => "platinacoin",
634 "platinacoins" => "platinacoin",
635 "royalty" => "royalty",
636 "royalties" => "royalty",
637);
638
639sub coin_from_name($) {
640 $coin_alias{$_[0]}
641 ? cf::arch::find $coin_alias{$_[0]}
642 : undef
643}
644
645=item $value = cf::db_get $family => $key
646
647Returns a single value from the environment database.
648
649=item cf::db_put $family => $key => $value
650
651Stores the given C<$value> in the family. It can currently store binary
652data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
653
654=item $db = cf::db_table "name"
655
656Create and/or open a new database table. The string must not be "db" and must be unique
657within each server.
658
659=cut
660
661sub db_table($) {
662 cf::error "db_get called from main context"
663 if $Coro::current == $Coro::main;
664
665 my ($name) = @_;
666 my $db = BDB::db_create $DB_ENV;
667
668 eval {
669 $db->set_flags (BDB::CHKSUM);
670
671 utf8::encode $name;
672 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
673 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
674 cf::cleanup "db_open(db): $!" if $!;
675 };
676 cf::cleanup "db_open(db): $@" if $@;
677
678 $db
679}
680
681our $DB;
682
683sub db_init {
684 $DB ||= db_table "db";
685}
686
687sub db_get($$) {
688 my $key = "$_[0]/$_[1]";
689
690 cf::error "db_get called from main context"
691 if $Coro::current == $Coro::main;
692
693 BDB::db_get $DB, undef, $key, my $data;
694
695 $! ? ()
696 : $data
697}
698
699sub db_put($$$) {
700 BDB::dbreq_pri 4;
701 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
702}
703
704=item cf::cache $id => [$paths...], $processversion => $process
705
706Generic caching function that returns the value of the resource $id,
707caching and regenerating as required.
708
709This function can block.
710
711=cut
712
713sub cache {
714 my ($id, $src, $processversion, $process) = @_;
715
716 my $meta =
717 join "\x00",
718 $processversion,
719 map {
720 aio_stat $_
721 and Carp::croak "$_: $!";
722
723 ($_, (stat _)[7,9])
724 } @$src;
725
726 my $dbmeta = db_get cache => "$id/meta";
727 if ($dbmeta ne $meta) {
728 # changed, we may need to process
729
730 my @data;
731 my $md5;
732
733 for (0 .. $#$src) {
734 0 <= aio_load $src->[$_], $data[$_]
735 or Carp::croak "$src->[$_]: $!";
736 }
737
738 # if processing is expensive, check
739 # checksum first
740 if (1) {
741 $md5 =
742 join "\x00",
743 $processversion,
744 map {
745 cf::cede_to_tick;
746 ($src->[$_], Digest::MD5::md5_hex $data[$_])
747 } 0.. $#$src;
748
749
750 my $dbmd5 = db_get cache => "$id/md5";
751 if ($dbmd5 eq $md5) {
752 db_put cache => "$id/meta", $meta;
753
754 return db_get cache => "$id/data";
755 }
756 }
757
758 my $t1 = Time::HiRes::time;
759 my $data = $process->(\@data);
760 my $t2 = Time::HiRes::time;
761
762 info "cache: '$id' processed in ", $t2 - $t1, "s\n";
763
764 db_put cache => "$id/data", $data;
765 db_put cache => "$id/md5" , $md5;
766 db_put cache => "$id/meta", $meta;
767
768 return $data;
769 }
770
771 db_get cache => "$id/data"
772}
773
774=item cf::datalog type => key => value, ...
775
776Log a datalog packet of the given type with the given key-value pairs.
777
778=cut
779
780sub datalog($@) {
781 my ($type, %kv) = @_;
782 info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
271} 783}
272 784
273=back 785=back
274 786
275=cut 787=cut
276 788
277############################################################################# 789#############################################################################
278 790
279package cf::path;
280
281sub new {
282 my ($class, $path, $base) = @_;
283
284 $path = $path->as_string if ref $path;
285
286 my $self = bless { }, $class;
287
288 if ($path =~ s{^\?random/}{}) {
289 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
290 $self->{random} = cf::from_json $data;
291 } else {
292 if ($path =~ s{^~([^/]+)?}{}) {
293 $self->{user_rel} = 1;
294
295 if (defined $1) {
296 $self->{user} = $1;
297 } elsif ($base =~ m{^~([^/]+)/}) {
298 $self->{user} = $1;
299 } else {
300 warn "cannot resolve user-relative path without user <$path,$base>\n";
301 }
302 } elsif ($path =~ /^\//) {
303 # already absolute
304 } else {
305 $base =~ s{[^/]+/?$}{};
306 return $class->new ("$base/$path");
307 }
308
309 for ($path) {
310 redo if s{/\.?/}{/};
311 redo if s{/[^/]+/\.\./}{/};
312 }
313 }
314
315 $self->{path} = $path;
316
317 $self
318}
319
320# the name / primary key / in-game path
321sub as_string {
322 my ($self) = @_;
323
324 $self->{user_rel} ? "~$self->{user}$self->{path}"
325 : $self->{random} ? "?random/$self->{path}"
326 : $self->{path}
327}
328
329# the displayed name, this is a one way mapping
330sub visible_name {
331 my ($self) = @_;
332
333# if (my $rmp = $self->{random}) {
334# # todo: be more intelligent about this
335# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
336# } else {
337 $self->as_string
338# }
339}
340
341# escape the /'s in the path
342sub _escaped_path {
343 # ∕ is U+2215
344 (my $path = $_[0]{path}) =~ s/\//∕/g;
345 $path
346}
347
348# the original (read-only) location
349sub load_path {
350 my ($self) = @_;
351
352 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
353}
354
355# the temporary/swap location
356sub save_path {
357 my ($self) = @_;
358
359 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
360 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
361 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
362}
363
364# the unique path, might be eq to save_path
365sub uniq_path {
366 my ($self) = @_;
367
368 $self->{user_rel} || $self->{random}
369 ? undef
370 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
371}
372
373# return random map parameters, or undef
374sub random_map_params {
375 my ($self) = @_;
376
377 $self->{random}
378}
379
380# this is somewhat ugly, but style maps do need special treatment
381sub is_style_map {
382 $_[0]{path} =~ m{^/styles/}
383}
384
385package cf;
386
387#############################################################################
388
389=head2 ATTACHABLE OBJECTS 791=head2 ATTACHABLE OBJECTS
390 792
391Many objects in crossfire are so-called attachable objects. That means you can 793Many objects in deliantra are so-called attachable objects. That means you can
392attach callbacks/event handlers (a collection of which is called an "attachment") 794attach callbacks/event handlers (a collection of which is called an "attachment")
393to it. All such attachable objects support the following methods. 795to it. All such attachable objects support the following methods.
394 796
395In the following description, CLASS can be any of C<global>, C<object> 797In the following description, CLASS can be any of C<global>, C<object>
396C<player>, C<client> or C<map> (i.e. the attachable objects in 798C<player>, C<client> or C<map> (i.e. the attachable objects in
397crossfire+). 799Deliantra).
398 800
399=over 4 801=over 4
400 802
401=item $attachable->attach ($attachment, key => $value...) 803=item $attachable->attach ($attachment, key => $value...)
402 804
446=item cf::CLASS::attachment $name, ... 848=item cf::CLASS::attachment $name, ...
447 849
448Register an attachment by C<$name> through which attachable objects of the 850Register an attachment by C<$name> through which attachable objects of the
449given CLASS can refer to this attachment. 851given CLASS can refer to this attachment.
450 852
451Some classes such as crossfire maps and objects can specify attachments 853Some classes such as deliantra maps and objects can specify attachments
452that are attached at load/instantiate time, thus the need for a name. 854that are attached at load/instantiate time, thus the need for a name.
453 855
454These calls expect any number of the following handler/hook descriptions: 856These calls expect any number of the following handler/hook descriptions:
455 857
456=over 4 858=over 4
516our @CB_TYPE = (); # registry for type (cf-object class) based events 918our @CB_TYPE = (); # registry for type (cf-object class) based events
517our @CB_MAP = (); 919our @CB_MAP = ();
518 920
519my %attachment; 921my %attachment;
520 922
923sub cf::attachable::thawer_merge {
924 # simply override everything except _meta
925 local $_[0]{_meta};
926 %{$_[0]} = %{$_[1]};
927}
928
521sub _attach_cb($$$$) { 929sub _attach_cb($$$$) {
522 my ($registry, $event, $prio, $cb) = @_; 930 my ($registry, $event, $prio, $cb) = @_;
523 931
524 use sort 'stable'; 932 use sort 'stable';
525 933
559 $registry = $CB_TYPE[$object_type] ||= []; 967 $registry = $CB_TYPE[$object_type] ||= [];
560 968
561 } elsif ($type eq "subtype") { 969 } elsif ($type eq "subtype") {
562 defined $object_type or Carp::croak "subtype specified without type"; 970 defined $object_type or Carp::croak "subtype specified without type";
563 my $object_subtype = shift @arg; 971 my $object_subtype = shift @arg;
564 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 972 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
565 973
566 } elsif ($type eq "package") { 974 } elsif ($type eq "package") {
567 my $pkg = shift @arg; 975 my $pkg = shift @arg;
568 976
569 while (my ($name, $id) = each %cb_id) { 977 while (my ($name, $id) = each %cb_id) {
574 982
575 } elsif (exists $cb_id{$type}) { 983 } elsif (exists $cb_id{$type}) {
576 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 984 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
577 985
578 } elsif (ref $type) { 986 } elsif (ref $type) {
579 warn "attaching objects not supported, ignoring.\n"; 987 error "attaching objects not supported, ignoring.\n";
580 988
581 } else { 989 } else {
582 shift @arg; 990 shift @arg;
583 warn "attach argument '$type' not supported, ignoring.\n"; 991 error "attach argument '$type' not supported, ignoring.\n";
584 } 992 }
585 } 993 }
586} 994}
587 995
588sub _object_attach { 996sub _object_attach {
598 _attach $registry, $klass, @attach; 1006 _attach $registry, $klass, @attach;
599 } 1007 }
600 1008
601 $obj->{$name} = \%arg; 1009 $obj->{$name} = \%arg;
602 } else { 1010 } else {
603 warn "object uses attachment '$name' that is not available, postponing.\n"; 1011 info "object uses attachment '$name' which is not available, postponing.\n";
604 } 1012 }
605 1013
606 $obj->{_attachment}{$name} = undef; 1014 $obj->{_attachment}{$name} = undef;
607} 1015}
608 1016
610 if (ref $_[0]) { 1018 if (ref $_[0]) {
611 _object_attach @_; 1019 _object_attach @_;
612 } else { 1020 } else {
613 _attach shift->_attach_registry, @_; 1021 _attach shift->_attach_registry, @_;
614 } 1022 }
1023 _recalc_want;
615}; 1024};
616 1025
617# all those should be optimised 1026# all those should be optimised
618sub cf::attachable::detach { 1027sub cf::attachable::detach {
619 my ($obj, $name) = @_; 1028 my ($obj, $name) = @_;
622 delete $obj->{_attachment}{$name}; 1031 delete $obj->{_attachment}{$name};
623 reattach ($obj); 1032 reattach ($obj);
624 } else { 1033 } else {
625 Carp::croak "cannot, currently, detach class attachments"; 1034 Carp::croak "cannot, currently, detach class attachments";
626 } 1035 }
1036 _recalc_want;
627}; 1037};
628 1038
629sub cf::attachable::attached { 1039sub cf::attachable::attached {
630 my ($obj, $name) = @_; 1040 my ($obj, $name) = @_;
631 1041
646 "; 1056 ";
647 die if $@; 1057 die if $@;
648} 1058}
649 1059
650our $override; 1060our $override;
651our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 1061our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
652 1062
653sub override { 1063sub override {
654 $override = 1; 1064 $override = 1;
655 @invoke_results = (); 1065 @INVOKE_RESULTS = (@_);
656} 1066}
657 1067
658sub do_invoke { 1068sub do_invoke {
659 my $event = shift; 1069 my $event = shift;
660 my $callbacks = shift; 1070 my $callbacks = shift;
661 1071
662 @invoke_results = (); 1072 @INVOKE_RESULTS = ();
663 1073
664 local $override; 1074 local $override;
665 1075
666 for (@$callbacks) { 1076 for (@$callbacks) {
667 eval { &{$_->[1]} }; 1077 eval { &{$_->[1]} };
668 1078
669 if ($@) { 1079 if ($@) {
670 warn "$@";
671 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1080 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
672 override; 1081 override;
673 } 1082 }
674 1083
675 return 1 if $override; 1084 return 1 if $override;
676 } 1085 }
677 1086
678 0 1087 0
679} 1088}
680 1089
681=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1090=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
682 1091
683=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1092=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
684 1093
685Generate an object-specific event with the given arguments. 1094Generate an object-specific event with the given arguments.
686 1095
687This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 1096This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
688removed in future versions), and there is no public API to access override 1097removed in future versions), and there is no public API to access override
689results (if you must, access C<@cf::invoke_results> directly). 1098results (if you must, access C<@cf::INVOKE_RESULTS> directly).
690 1099
691=back 1100=back
692 1101
693=cut 1102=cut
694 1103
695############################################################################# 1104#############################################################################
696# object support 1105# object support
1106
1107sub _object_equal($$);
1108sub _object_equal($$) {
1109 my ($a, $b) = @_;
1110
1111 return 0 unless (ref $a) eq (ref $b);
1112
1113 if ("HASH" eq ref $a) {
1114 my @ka = keys %$a;
1115 my @kb = keys %$b;
1116
1117 return 0 if @ka != @kb;
1118
1119 for (0 .. $#ka) {
1120 return 0 unless $ka[$_] eq $kb[$_];
1121 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1122 }
1123
1124 } elsif ("ARRAY" eq ref $a) {
1125
1126 return 0 if @$a != @$b;
1127
1128 for (0 .. $#$a) {
1129 return 0 unless _object_equal $a->[$_], $b->[$_];
1130 }
1131
1132 } elsif ($a ne $b) {
1133 return 0;
1134 }
1135
1136 1
1137}
1138
1139our $SLOW_MERGES;#d#
1140sub _can_merge {
1141 my ($ob1, $ob2) = @_;
1142
1143 ++$SLOW_MERGES;#d#
1144
1145 # we do the slow way here
1146 return _object_equal $ob1, $ob2
1147}
697 1148
698sub reattach { 1149sub reattach {
699 # basically do the same as instantiate, without calling instantiate 1150 # basically do the same as instantiate, without calling instantiate
700 my ($obj) = @_; 1151 my ($obj) = @_;
1152
1153 # no longer needed after getting rid of delete_package?
1154 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
701 1155
702 my $registry = $obj->registry; 1156 my $registry = $obj->registry;
703 1157
704 @$registry = (); 1158 @$registry = ();
705 1159
710 for (@$attach) { 1164 for (@$attach) {
711 my ($klass, @attach) = @$_; 1165 my ($klass, @attach) = @$_;
712 _attach $registry, $klass, @attach; 1166 _attach $registry, $klass, @attach;
713 } 1167 }
714 } else { 1168 } else {
715 warn "object uses attachment '$name' that is not available, postponing.\n"; 1169 info "object uses attachment '$name' that is not available, postponing.\n";
716 } 1170 }
717 } 1171 }
718} 1172}
719 1173
720cf::attachable->attach ( 1174cf::attachable->attach (
721 prio => -1000000, 1175 prio => -1000000,
722 on_instantiate => sub { 1176 on_instantiate => sub {
723 my ($obj, $data) = @_; 1177 my ($obj, $data) = @_;
724 1178
725 $data = from_json $data; 1179 $data = decode_json $data;
726 1180
727 for (@$data) { 1181 for (@$data) {
728 my ($name, $args) = @$_; 1182 my ($name, $args) = @$_;
729 1183
730 $obj->attach ($name, %{$args || {} }); 1184 $obj->attach ($name, %{$args || {} });
746sub object_freezer_save { 1200sub object_freezer_save {
747 my ($filename, $rdata, $objs) = @_; 1201 my ($filename, $rdata, $objs) = @_;
748 1202
749 sync_job { 1203 sync_job {
750 if (length $$rdata) { 1204 if (length $$rdata) {
1205 utf8::decode (my $decname = $filename);
751 warn sprintf "saving %s (%d,%d)\n", 1206 trace sprintf "saving %s (%d,%d)\n",
752 $filename, length $$rdata, scalar @$objs; 1207 $decname, length $$rdata, scalar @$objs
1208 if $VERBOSE_IO;
753 1209
754 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1210 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
755 chmod SAVE_MODE, $fh; 1211 aio_chmod $fh, SAVE_MODE;
756 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1212 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1213 if ($cf::USE_FSYNC) {
1214 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
757 aio_fsync $fh; 1215 aio_fsync $fh;
1216 }
758 close $fh; 1217 aio_close $fh;
759 1218
760 if (@$objs) { 1219 if (@$objs) {
761 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1220 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
762 chmod SAVE_MODE, $fh; 1221 aio_chmod $fh, SAVE_MODE;
763 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1222 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
764 aio_write $fh, 0, (length $data), $data, 0; 1223 aio_write $fh, 0, (length $data), $data, 0;
1224 if ($cf::USE_FSYNC) {
1225 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
765 aio_fsync $fh; 1226 aio_fsync $fh;
1227 }
766 close $fh; 1228 aio_close $fh;
767 aio_rename "$filename.pst~", "$filename.pst"; 1229 aio_rename "$filename.pst~", "$filename.pst";
768 } 1230 }
769 } else { 1231 } else {
770 aio_unlink "$filename.pst"; 1232 aio_unlink "$filename.pst";
771 } 1233 }
772 1234
773 aio_rename "$filename~", $filename; 1235 aio_rename "$filename~", $filename;
1236
1237 $filename =~ s%/[^/]+$%%;
1238 aio_pathsync $filename if $cf::USE_FSYNC;
774 } else { 1239 } else {
775 warn "FATAL: $filename~: $!\n"; 1240 error "unable to save objects: $filename~: $!\n";
776 } 1241 }
777 } else { 1242 } else {
778 aio_unlink $filename; 1243 aio_unlink $filename;
779 aio_unlink "$filename.pst"; 1244 aio_unlink "$filename.pst";
780 } 1245 }
781 } 1246 };
782} 1247}
783 1248
784sub object_freezer_as_string { 1249sub object_freezer_as_string {
785 my ($rdata, $objs) = @_; 1250 my ($rdata, $objs) = @_;
786 1251
798 or return; 1263 or return;
799 1264
800 unless (aio_stat "$filename.pst") { 1265 unless (aio_stat "$filename.pst") {
801 (aio_load "$filename.pst", $av) >= 0 1266 (aio_load "$filename.pst", $av) >= 0
802 or return; 1267 or return;
1268
803 $av = eval { (Storable::thaw <$av>)->{objs} }; 1269 my $st = eval { Coro::Storable::thaw $av };
1270 $av = $st->{objs};
804 } 1271 }
805 1272
1273 utf8::decode (my $decname = $filename);
1274 trace sprintf "loading %s (%d,%d)\n",
1275 $decname, length $data, scalar @{$av || []}
1276 if $VERBOSE_IO;
1277
806 return ($data, $av); 1278 ($data, $av)
807} 1279}
1280
1281=head2 COMMAND CALLBACKS
1282
1283=over 4
1284
1285=cut
808 1286
809############################################################################# 1287#############################################################################
810# command handling &c 1288# command handling &c
811 1289
812=item cf::register_command $name => \&callback($ob,$args); 1290=item cf::register_command $name => \&callback($ob,$args);
825 push @{ $COMMAND{$name} }, [$caller, $cb]; 1303 push @{ $COMMAND{$name} }, [$caller, $cb];
826} 1304}
827 1305
828=item cf::register_extcmd $name => \&callback($pl,$packet); 1306=item cf::register_extcmd $name => \&callback($pl,$packet);
829 1307
830Register a callbackf ro execution when the client sends an extcmd packet. 1308Register a callback for execution when the client sends an (synchronous)
1309extcmd packet. Ext commands will be processed in the order they are
1310received by the server, like other user commands. The first argument is
1311the logged-in player. Ext commands can only be processed after a player
1312has logged in successfully.
831 1313
832If the callback returns something, it is sent back as if reply was being 1314If the callback returns something, it is sent back as if reply was being
833called. 1315called.
834 1316
1317=item cf::register_exticmd $name => \&callback($ns,$packet);
1318
1319Register a callback for execution when the client sends an (asynchronous)
1320exticmd packet. Exti commands are processed by the server as soon as they
1321are received, i.e. out of order w.r.t. other commands. The first argument
1322is a client socket. Exti commands can be received anytime, even before
1323log-in.
1324
1325If the callback returns something, it is sent back as if reply was being
1326called.
1327
835=cut 1328=cut
836 1329
837sub register_extcmd { 1330sub register_extcmd {
838 my ($name, $cb) = @_; 1331 my ($name, $cb) = @_;
839 1332
840 my $caller = caller;
841 #warn "registering extcmd '$name' to '$caller'";
842
843 $EXTCMD{$name} = [$cb, $caller]; 1333 $EXTCMD{$name} = $cb;
844} 1334}
1335
1336sub register_exticmd {
1337 my ($name, $cb) = @_;
1338
1339 $EXTICMD{$name} = $cb;
1340}
1341
1342use File::Glob ();
845 1343
846cf::player->attach ( 1344cf::player->attach (
847 on_command => sub { 1345 on_unknown_command => sub {
848 my ($pl, $name, $params) = @_; 1346 my ($pl, $name, $params) = @_;
849 1347
850 my $cb = $COMMAND{$name} 1348 my $cb = $COMMAND{$name}
851 or return; 1349 or return;
852 1350
857 cf::override; 1355 cf::override;
858 }, 1356 },
859 on_extcmd => sub { 1357 on_extcmd => sub {
860 my ($pl, $buf) = @_; 1358 my ($pl, $buf) = @_;
861 1359
862 my $msg = eval { from_json $buf }; 1360 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
863 1361
864 if (ref $msg) { 1362 if (ref $msg) {
1363 my ($type, $reply, @payload) =
1364 "ARRAY" eq ref $msg
1365 ? @$msg
1366 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1367
1368 my @reply;
1369
865 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1370 if (my $cb = $EXTCMD{$type}) {
866 if (my %reply = $cb->[0]->($pl, $msg)) { 1371 @reply = $cb->($pl, @payload);
867 $pl->ext_reply ($msg->{msgid}, %reply);
868 }
869 } 1372 }
1373
1374 $pl->ext_reply ($reply, @reply)
1375 if $reply;
1376
870 } else { 1377 } else {
871 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1378 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
872 } 1379 }
873 1380
874 cf::override; 1381 cf::override;
875 }, 1382 },
876); 1383);
877 1384
878sub register { 1385# "readahead" all extensions
879 my ($base, $pkg) = @_;
880
881 #TODO
882}
883
884sub load_extension { 1386sub cache_extensions {
885 my ($path) = @_; 1387 my $grp = IO::AIO::aio_group;
886 1388
887 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1389 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
888 my $base = $1; 1390 for (grep /\.ext$/, @{$_[0]}) {
889 my $pkg = $1; 1391 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
890 $pkg =~ s/[^[:word:]]/_/g;
891 $pkg = "ext::$pkg";
892
893 warn "loading '$path' into '$pkg'\n";
894
895 open my $fh, "<:utf8", $path
896 or die "$path: $!";
897
898 my $source =
899 "package $pkg; use strict; use utf8;\n"
900 . "#line 1 \"$path\"\n{\n"
901 . (do { local $/; <$fh> })
902 . "\n};\n1";
903
904 eval $source
905 or die $@ ? "$path: $@\n"
906 : "extension disabled.\n";
907
908 push @exts, $pkg;
909 $ext_pkg{$base} = $pkg;
910
911# no strict 'refs';
912# @{"$pkg\::ISA"} = ext::;
913
914 register $base, $pkg;
915}
916
917sub unload_extension {
918 my ($pkg) = @_;
919
920 warn "removing extension $pkg\n";
921
922 # remove hooks
923 #TODO
924# for my $idx (0 .. $#PLUGIN_EVENT) {
925# delete $hook[$idx]{$pkg};
926# }
927
928 # remove commands
929 for my $name (keys %COMMAND) {
930 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
931
932 if (@cb) {
933 $COMMAND{$name} = \@cb;
934 } else {
935 delete $COMMAND{$name};
936 } 1392 }
937 } 1393 };
938 1394
939 # remove extcmds 1395 $grp
940 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
941 delete $EXTCMD{$name};
942 }
943
944 if (my $cb = $pkg->can ("unload")) {
945 eval {
946 $cb->($pkg);
947 1
948 } or warn "$pkg unloaded, but with errors: $@";
949 }
950
951 Symbol::delete_package $pkg;
952} 1396}
953 1397
954sub load_extensions { 1398sub load_extensions {
1399 info "loading extensions...";
1400
1401 cf::sync_job {
1402 my %todo;
1403
955 for my $ext (<$LIBDIR/*.ext>) { 1404 for my $path (<$LIBDIR/*.ext>) {
956 next unless -r $ext; 1405 next unless -r $path;
957 eval { 1406
958 load_extension $ext; 1407 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1408 my $base = $1;
1409 my $pkg = $1;
1410 $pkg =~ s/[^[:word:]]/_/g;
1411 $pkg = "ext::$pkg";
1412
1413 open my $fh, "<:utf8", $path
1414 or die "$path: $!";
1415
1416 my $source = do { local $/; <$fh> };
1417
1418 my %ext = (
1419 path => $path,
1420 base => $base,
1421 pkg => $pkg,
1422 );
1423
1424 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1425 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1426
1427 $ext{source} =
1428 "package $pkg; use common::sense;\n"
1429 . "#line 1 \"$path\"\n{\n"
1430 . $source
1431 . "\n};\n1";
1432
1433 $todo{$base} = \%ext;
1434 }
1435
1436 my $pass = 0;
1437 my %done;
1438 while (%todo) {
1439 my $progress;
1440
1441 ++$pass;
1442
1443 ext:
1444 while (my ($k, $v) = each %todo) {
1445 for (split /,\s*/, $v->{meta}{depends}) {
1446 next ext
1447 unless exists $done{$_};
1448 }
1449
1450 trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
1451
1452 my $active = eval $v->{source};
1453
1454 if (length $@) {
1455 error "$v->{path}: $@\n";
1456 undef $@; # work around perl 5.10.0 utf-8 caching bug
1457
1458 cf::cleanup "mandatory extension '$k' failed to load, exiting."
1459 if exists $v->{meta}{mandatory};
1460
1461 warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
1462 delete $todo{$k};
1463 } else {
1464 $done{$k} = delete $todo{$k};
1465 push @EXTS, $v->{pkg};
1466 $progress = 1;
1467
1468 info "$v->{base}: extension inactive.\n"
1469 unless $active;
1470 }
959 1 1471 }
960 } or warn "$ext not loaded: $@"; 1472
1473 unless ($progress) {
1474 warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
1475
1476 while (my ($k, $v) = each %todo) {
1477 cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
1478 if exists $v->{meta}{mandatory};
1479 }
1480 }
1481 }
961 } 1482 };
962} 1483}
963 1484
964############################################################################# 1485#############################################################################
965# load/save/clean perl data associated with a map
966 1486
967*cf::mapsupport::on_clean = sub { 1487=back
1488
1489=head2 CORE EXTENSIONS
1490
1491Functions and methods that extend core deliantra objects.
1492
1493=cut
1494
1495package cf::player;
1496
1497use Coro::AIO;
1498
1499=head3 cf::player
1500
1501=over 4
1502
1503=item cf::player::num_playing
1504
1505Returns the official number of playing players, as per the Crossfire metaserver rules.
1506
1507=cut
1508
1509sub num_playing {
1510 scalar grep
1511 $_->ob->map
1512 && !$_->hidden
1513 && !$_->ob->flag (cf::FLAG_WIZ),
1514 cf::player::list
1515}
1516
1517=item cf::player::find $login
1518
1519Returns the given player object, loading it if necessary (might block).
1520
1521=cut
1522
1523sub playerdir($) {
1524 "$PLAYERDIR/"
1525 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1526}
1527
1528sub path($) {
1529 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1530
1531 (playerdir $login) . "/playerdata"
1532}
1533
1534sub find_active($) {
1535 $cf::PLAYER{$_[0]}
1536 and $cf::PLAYER{$_[0]}->active
1537 and $cf::PLAYER{$_[0]}
1538}
1539
1540sub exists($) {
968 my ($map) = @_; 1541 my ($login) = @_;
969 1542
970 my $path = $map->tmpname; 1543 $cf::PLAYER{$login}
971 defined $path or return; 1544 or !aio_stat path $login
972
973 unlink "$path.pst";
974};
975
976cf::map->attach (prio => -10000, package => cf::mapsupport::);
977
978#############################################################################
979# load/save perl data associated with player->ob objects
980
981sub all_objects(@) {
982 @_, map all_objects ($_->inv), @_
983} 1545}
984 1546
985# TODO: compatibility cruft, remove when no longer needed 1547sub find($) {
1548 return $cf::PLAYER{$_[0]} || do {
1549 my $login = $_[0];
1550
1551 my $guard = cf::lock_acquire "user_find:$login";
1552
1553 $cf::PLAYER{$_[0]} || do {
1554 # rename old playerfiles to new ones
1555 #TODO: remove when no longer required
1556 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1557 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1558 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1559 aio_unlink +(playerdir $login) . "/$login.pl";
1560
1561 my $f = new_from_file cf::object::thawer path $login
1562 or return;
1563
1564 my $pl = cf::player::load_pl $f
1565 or return;
1566
1567 local $cf::PLAYER_LOADING{$login} = $pl;
1568 $f->resolve_delayed_derefs;
1569 $cf::PLAYER{$login} = $pl
1570 }
1571 }
1572}
1573
986cf::player->attach ( 1574cf::player->attach (
987 on_load => sub { 1575 on_load => sub {
988 my ($pl, $path) = @_; 1576 my ($pl, $path) = @_;
989 1577
990 for my $o (all_objects $pl->ob) { 1578 # restore slots saved in save, below
991 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1579 my $slots = delete $pl->{_slots};
992 $o->set_ob_key_value ("_perl_data");
993 1580
994 %$o = %{ Storable::thaw pack "H*", $value }; 1581 $pl->ob->current_weapon ($slots->[0]);
995 } 1582 $pl->combat_ob ($slots->[1]);
996 } 1583 $pl->ranged_ob ($slots->[2]);
997 }, 1584 },
998); 1585);
999 1586
1000############################################################################# 1587sub save($) {
1588 my ($pl) = @_;
1001 1589
1002=head2 CORE EXTENSIONS 1590 return if $pl->{deny_save};
1003 1591
1004Functions and methods that extend core crossfire objects. 1592 my $path = path $pl;
1593 my $guard = cf::lock_acquire "user_save:$path";
1005 1594
1006=head3 cf::player 1595 return if $pl->{deny_save};
1596
1597 aio_mkdir playerdir $pl, 0770;
1598 $pl->{last_save} = $cf::RUNTIME;
1599
1600 cf::get_slot 0.01;
1601
1602 # save slots, to be restored later
1603 local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
1604
1605 $pl->save_pl ($path);
1606 cf::cede_to_tick;
1607}
1608
1609sub new($) {
1610 my ($login) = @_;
1611
1612 my $self = create;
1613
1614 $self->ob->name ($login);
1615 $self->{deny_save} = 1;
1616
1617 $cf::PLAYER{$login} = $self;
1618
1619 $self
1620}
1621
1622=item $player->send_msg ($channel, $msg, $color, [extra...])
1623
1624=cut
1625
1626sub send_msg {
1627 my $ns = shift->ns
1628 or return;
1629 $ns->send_msg (@_);
1630}
1631
1632=item $pl->quit_character
1633
1634Nukes the player without looking back. If logged in, the connection will
1635be destroyed. May block for a long time.
1636
1637=cut
1638
1639sub quit_character {
1640 my ($pl) = @_;
1641
1642 my $name = $pl->ob->name;
1643
1644 $pl->{deny_save} = 1;
1645 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1646
1647 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1648 $pl->deactivate;
1649 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1650 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1651 $pl->ns->destroy if $pl->ns;
1652
1653 my $path = playerdir $pl;
1654 my $temp = "$path~$cf::RUNTIME~deleting~";
1655 aio_rename $path, $temp;
1656 delete $cf::PLAYER{$pl->ob->name};
1657 $pl->destroy;
1658
1659 my $prefix = qr<^~\Q$name\E/>;
1660
1661 # nuke player maps
1662 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1663
1664 IO::AIO::aio_rmtree $temp;
1665}
1666
1667=item $pl->kick
1668
1669Kicks a player out of the game. This destroys the connection.
1670
1671=cut
1672
1673sub kick {
1674 my ($pl, $kicker) = @_;
1675
1676 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1677 $pl->killer ("kicked");
1678 $pl->ns->destroy;
1679}
1680
1681=item cf::player::list_logins
1682
1683Returns am arrayref of all valid playernames in the system, can take a
1684while and may block, so not sync_job-capable, ever.
1685
1686=cut
1687
1688sub list_logins {
1689 my $dirs = aio_readdir $PLAYERDIR
1690 or return [];
1691
1692 my @logins;
1693
1694 for my $login (@$dirs) {
1695 my $path = path $login;
1696
1697 # a .pst is a dead give-away for a valid player
1698 # if no pst file found, open and chekc for blocked users
1699 if (aio_stat "$path.pst") {
1700 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1701 aio_read $fh, 0, 512, my $buf, 0 or next;
1702 $buf !~ /^password -------------$/m or next; # official not-valid tag
1703 }
1704
1705 utf8::decode $login;
1706 push @logins, $login;
1707 }
1708
1709 \@logins
1710}
1711
1712=item $player->maps
1713
1714=item cf::player::maps $login
1715
1716Returns an arrayref of map paths that are private for this
1717player. May block.
1718
1719=cut
1720
1721sub maps($) {
1722 my ($pl) = @_;
1723
1724 $pl = ref $pl ? $pl->ob->name : $pl;
1725
1726 my $files = aio_readdir playerdir $pl
1727 or return;
1728
1729 my @paths;
1730
1731 for (@$files) {
1732 utf8::decode $_;
1733 next if /\.(?:pl|pst)$/;
1734 next unless /^$PATH_SEP/o;
1735
1736 push @paths, cf::map::normalise "~$pl/$_";
1737 }
1738
1739 \@paths
1740}
1741
1742=item $protocol_xml = $player->expand_cfpod ($cfpod)
1743
1744Expand deliantra pod fragments into protocol xml.
1745
1746=item $player->ext_reply ($msgid, @msg)
1747
1748Sends an ext reply to the player.
1749
1750=cut
1751
1752sub ext_reply($$@) {
1753 my ($self, $id, @msg) = @_;
1754
1755 $self->ns->ext_reply ($id, @msg)
1756}
1757
1758=item $player->ext_msg ($type, @msg)
1759
1760Sends an ext event to the client.
1761
1762=cut
1763
1764sub ext_msg($$@) {
1765 my ($self, $type, @msg) = @_;
1766
1767 $self->ns->ext_msg ($type, @msg);
1768}
1769
1770=head3 cf::region
1007 1771
1008=over 4 1772=over 4
1009 1773
1010=item cf::player::exists $login
1011
1012Returns true when the given account exists.
1013
1014=cut 1774=cut
1015 1775
1016sub cf::player::exists($) { 1776package cf::region;
1017 cf::player::find $_[0]
1018 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1019}
1020 1777
1021=item $player->ext_reply ($msgid, $msgtype, %msg) 1778=item cf::region::find_by_path $path
1022 1779
1023Sends an ext reply to the player. 1780Tries to decuce the likely region for a map knowing only its path.
1024 1781
1025=cut 1782=cut
1026 1783
1027sub cf::player::ext_reply($$$%) { 1784sub find_by_path($) {
1028 my ($self, $id, %msg) = @_; 1785 my ($path) = @_;
1029 1786
1030 $msg{msgid} = $id; 1787 $path =~ s/^~[^\/]*//; # skip ~login
1031 1788
1032 $self->send ("ext " . to_json \%msg); 1789 my ($match, $specificity);
1790
1791 for my $region (list) {
1792 if ($region->{match} && $path =~ $region->{match}) {
1793 ($match, $specificity) = ($region, $region->specificity)
1794 if $region->specificity > $specificity;
1795 }
1796 }
1797
1798 $match
1033} 1799}
1034 1800
1035=back 1801=back
1036
1037 1802
1038=head3 cf::map 1803=head3 cf::map
1039 1804
1040=over 4 1805=over 4
1041 1806
1044package cf::map; 1809package cf::map;
1045 1810
1046use Fcntl; 1811use Fcntl;
1047use Coro::AIO; 1812use Coro::AIO;
1048 1813
1814use overload
1815 '""' => \&as_string,
1816 fallback => 1;
1817
1049our $MAX_RESET = 7200; 1818our $MAX_RESET = 3600;
1050our $DEFAULT_RESET = 3600; 1819our $DEFAULT_RESET = 3000;
1051$MAX_RESET = 10;#d#
1052$DEFAULT_RESET = 10;#d#
1053 1820
1054sub generate_random_map { 1821sub generate_random_map {
1055 my ($path, $rmp) = @_; 1822 my ($self, $rmp) = @_;
1823
1824 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1056 1825
1057 # mit "rum" bekleckern, nicht 1826 # mit "rum" bekleckern, nicht
1058 cf::map::_create_random_map 1827 $self->_create_random_map (
1059 $path,
1060 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1828 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1061 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1829 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1062 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1830 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1063 $rmp->{exit_on_final_map}, 1831 $rmp->{exit_on_final_map},
1064 $rmp->{xsize}, $rmp->{ysize}, 1832 $rmp->{xsize}, $rmp->{ysize},
1065 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1833 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1066 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1834 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1067 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1835 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1068 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1836 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1069 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1837 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1070 (cf::region::find $rmp->{region}) 1838 (cf::region::find $rmp->{region}), $rmp->{custom}
1839 )
1071} 1840}
1072 1841
1073# and all this just because we cannot iterate over 1842=item cf::map->register ($regex, $prio)
1074# all maps in C++...
1075sub change_all_map_light {
1076 my ($change) = @_;
1077 1843
1078 $_->change_map_light ($change) for values %cf::MAP; 1844Register a handler for the map path matching the given regex at the
1079} 1845givne priority (higher is better, built-in handlers have priority 0, the
1846default).
1080 1847
1081sub try_load_header($) { 1848=cut
1849
1850sub register {
1851 my (undef, $regex, $prio) = @_;
1852 my $pkg = caller;
1853
1854 push @{"$pkg\::ISA"}, __PACKAGE__;
1855
1856 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1857}
1858
1859# also paths starting with '/'
1860$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1861
1862sub thawer_merge {
1863 my ($self, $merge) = @_;
1864
1865 # we have to keep some variables in memory intact
1866 local $self->{path};
1867 local $self->{load_path};
1868
1869 $self->SUPER::thawer_merge ($merge);
1870}
1871
1872sub normalise {
1082 my ($path) = @_; 1873 my ($path, $base) = @_;
1874
1875 $path = "$path"; # make sure its a string
1876
1877 $path =~ s/\.map$//;
1878
1879 # map plan:
1880 #
1881 # /! non-realised random map exit (special hack!)
1882 # {... are special paths that are not being touched
1883 # ?xxx/... are special absolute paths
1884 # ?random/... random maps
1885 # /... normal maps
1886 # ~user/... per-player map of a specific user
1887
1888 $path =~ s/$PATH_SEP/\//go;
1889
1890 # treat it as relative path if it starts with
1891 # something that looks reasonable
1892 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1893 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1894
1895 $base =~ s{[^/]+/?$}{};
1896 $path = "$base/$path";
1897 }
1898
1899 for ($path) {
1900 redo if s{//}{/};
1901 redo if s{/\.?/}{/};
1902 redo if s{/[^/]+/\.\./}{/};
1903 }
1904
1905 $path
1906}
1907
1908sub new_from_path {
1909 my (undef, $path, $base) = @_;
1910
1911 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1912
1913 $path = normalise $path, $base;
1914
1915 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1916 if ($path =~ $EXT_MAP{$pkg}[1]) {
1917 my $self = bless cf::map::new, $pkg;
1918 $self->{path} = $path; $self->path ($path);
1919 $self->init; # pass $1 etc.
1920 return $self;
1921 }
1922 }
1923
1924 Carp::cluck "unable to resolve path '$path' (base '$base').";
1925 ()
1926}
1927
1928sub init {
1929 my ($self) = @_;
1930
1931 $self
1932}
1933
1934sub as_string {
1935 my ($self) = @_;
1936
1937 "$self->{path}"
1938}
1939
1940# the displayed name, this is a one way mapping
1941sub visible_name {
1942 &as_string
1943}
1944
1945# the original (read-only) location
1946sub load_path {
1947 my ($self) = @_;
1948
1949 "$MAPDIR/$self->{path}.map"
1950}
1951
1952# the temporary/swap location
1953sub save_path {
1954 my ($self) = @_;
1955
1956 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1957 "$TMPDIR/$path.map"
1958}
1959
1960# the unique path, undef == no special unique path
1961sub uniq_path {
1962 my ($self) = @_;
1963
1964 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1965 "$UNIQUEDIR/$path"
1966}
1967
1968sub decay_objects {
1969 my ($self) = @_;
1970
1971 return if $self->{deny_reset};
1972
1973 $self->do_decay_objects;
1974}
1975
1976sub unlink_save {
1977 my ($self) = @_;
1978
1979 utf8::encode (my $save = $self->save_path);
1980 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1981 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1982}
1983
1984sub load_header_from($) {
1985 my ($self, $path) = @_;
1083 1986
1084 utf8::encode $path; 1987 utf8::encode $path;
1085 aio_open $path, O_RDONLY, 0 1988 my $f = new_from_file cf::object::thawer $path
1086 or return; 1989 or return;
1087 1990
1088 my $map = cf::map::new 1991 $self->_load_header ($f)
1089 or return; 1992 or return;
1090 1993
1091 $map->load_header ($path) 1994 local $MAP_LOADING{$self->{path}} = $self;
1995 $f->resolve_delayed_derefs;
1996
1997 $self->{load_path} = $path;
1998
1999 1
2000}
2001
2002sub load_header_orig {
2003 my ($self) = @_;
2004
2005 $self->load_header_from ($self->load_path)
2006}
2007
2008sub load_header_temp {
2009 my ($self) = @_;
2010
2011 $self->load_header_from ($self->save_path)
2012}
2013
2014sub prepare_temp {
2015 my ($self) = @_;
2016
2017 $self->last_access ((delete $self->{last_access})
2018 || $cf::RUNTIME); #d#
2019 # safety
2020 $self->{instantiate_time} = $cf::RUNTIME
2021 if $self->{instantiate_time} > $cf::RUNTIME;
2022}
2023
2024sub prepare_orig {
2025 my ($self) = @_;
2026
2027 $self->{load_original} = 1;
2028 $self->{instantiate_time} = $cf::RUNTIME;
2029 $self->last_access ($cf::RUNTIME);
2030 $self->instantiate;
2031}
2032
2033sub load_header {
2034 my ($self) = @_;
2035
2036 if ($self->load_header_temp) {
2037 $self->prepare_temp;
2038 } else {
2039 $self->load_header_orig
1092 or return; 2040 or return;
2041 $self->prepare_orig;
2042 }
1093 2043
1094 $map->{load_path} = $path; 2044 $self->{deny_reset} = 1
1095 use Data::Dumper; warn Dumper $map;#d# 2045 if $self->no_reset;
1096 2046
1097 $map 2047 $self->default_region (cf::region::find_by_path $self->{path})
1098} 2048 unless $self->default_region;
1099 2049
2050 1
2051}
2052
2053sub find;
1100sub find_map { 2054sub find {
1101 my ($path, $origin) = @_; 2055 my ($path, $origin) = @_;
1102 2056
1103 #warn "find_map<$path,$origin>\n";#d# 2057 $path = normalise $path, $origin && $origin->path;
1104 2058
1105 $path = ref $path ? $path : new cf::path $path, $origin && $origin->path; 2059 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1106 my $key = $path->as_string; 2060 my $guard2 = cf::lock_acquire "map_find:$path";
1107 2061
1108 $cf::MAP{$key} || do { 2062 $cf::MAP{$path} || do {
1109 # do it the slow way 2063 my $map = new_from_path cf::map $path
1110 my $map = try_load_header $path->save_path;
1111
1112 if ($map) {
1113 # safety
1114 $map->{instantiate_time} = $cf::RUNTIME
1115 if $map->{instantiate_time} > $cf::RUNTIME;
1116 } else {
1117 if (my $rmp = $path->random_map_params) {
1118 $map = generate_random_map $key, $rmp;
1119 } else {
1120 $map = try_load_header $path->load_path;
1121 }
1122
1123 $map or return; 2064 or return;
1124 2065
1125 $map->{instantiate_time} = $cf::RUNTIME;
1126 $map->instantiate;
1127
1128 # per-player maps become, after loading, normal maps
1129 $map->per_player (0) if $path->{user_rel};
1130 }
1131
1132 $map->path ($key);
1133 $map->{path} = $path;
1134 $map->last_access ($cf::RUNTIME); 2066 $map->{last_save} = $cf::RUNTIME;
1135 2067
1136 $map->reset if $map->should_reset; 2068 $map->load_header
2069 or return;
1137 2070
2071 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
2072 # doing this can freeze the server in a sync job, obviously
2073 #$cf::WAIT_FOR_TICK->wait;
2074 undef $guard2;
2075 undef $guard1;
2076 $map->reset;
2077 return find $path;
2078 }
2079
1138 $cf::MAP{$key} = $map 2080 $cf::MAP{$path} = $map
1139 } 2081 }
1140} 2082}
2083
2084sub pre_load { }
2085#sub post_load { } # XS
1141 2086
1142sub load { 2087sub load {
1143 my ($self) = @_; 2088 my ($self) = @_;
1144 2089
1145 return if $self->in_memory != cf::MAP_SWAPPED; 2090 local $self->{deny_reset} = 1; # loading can take a long time
1146
1147 $self->in_memory (cf::MAP_LOADING);
1148 2091
1149 my $path = $self->{path}; 2092 my $path = $self->{path};
1150 2093
2094 {
2095 my $guard = cf::lock_acquire "map_data:$path";
2096
2097 return unless $self->valid;
2098 return unless $self->in_memory == cf::MAP_SWAPPED;
2099
2100 $self->in_memory (cf::MAP_LOADING);
2101
1151 $self->alloc; 2102 $self->alloc;
1152 $self->load_objects ($self->{load_path}, 1) 2103
2104 $self->pre_load;
2105 cf::cede_to_tick;
2106
2107 my $f = new_from_file cf::object::thawer $self->{load_path};
2108 $f->skip_block;
2109 $self->_load_objects ($f)
1153 or return; 2110 or return;
1154 2111
2112 $self->post_load_original
2113 if delete $self->{load_original};
2114
1155 if (my $uniq = $path->uniq_path) { 2115 if (my $uniq = $self->uniq_path) {
1156 utf8::encode $uniq; 2116 utf8::encode $uniq;
1157 if (aio_open $uniq, O_RDONLY, 0) { 2117 unless (aio_stat $uniq) {
2118 if (my $f = new_from_file cf::object::thawer $uniq) {
1158 $self->clear_unique_items; 2119 $self->clear_unique_items;
1159 $self->load_objects ($uniq, 0); 2120 $self->_load_objects ($f);
2121 $f->resolve_delayed_derefs;
2122 }
1160 } 2123 }
1161 } 2124 }
1162 2125
2126 $f->resolve_delayed_derefs;
2127
2128 cf::cede_to_tick;
1163 # now do the right thing for maps 2129 # now do the right thing for maps
1164 $self->link_multipart_objects; 2130 $self->link_multipart_objects;
1165
1166 if ($self->{path}->is_style_map) {
1167 $self->{deny_save} = 1;
1168 $self->{deny_reset} = 1;
1169 } else {
1170 $self->fix_auto_apply;
1171 $self->decay_objects;
1172 $self->update_buttons;
1173 $self->set_darkness_map;
1174 $self->difficulty ($self->estimate_difficulty) 2131 $self->difficulty ($self->estimate_difficulty)
1175 unless $self->difficulty; 2132 unless $self->difficulty;
2133 cf::cede_to_tick;
2134
2135 unless ($self->{deny_activate}) {
2136 $self->decay_objects;
2137 $self->fix_auto_apply;
2138 $self->update_buttons;
2139 cf::cede_to_tick;
1176 $self->activate; 2140 $self->activate;
1177 } 2141 }
1178 2142
2143 $self->{last_save} = $cf::RUNTIME;
2144 $self->last_access ($cf::RUNTIME);
2145
1179 $self->in_memory (cf::MAP_IN_MEMORY); 2146 $self->in_memory (cf::MAP_ACTIVE);
1180} 2147 }
1181 2148
1182sub load_map_sync { 2149 $self->post_load;
2150}
2151
2152# customize the map for a given player, i.e.
2153# return the _real_ map. used by e.g. per-player
2154# maps to change the path to ~playername/mappath
2155sub customise_for {
2156 my ($self, $ob) = @_;
2157
2158 return find "~" . $ob->name . "/" . $self->{path}
2159 if $self->per_player;
2160
2161# return find "?party/" . $ob->name . "/" . $self->{path}
2162# if $self->per_party;
2163
2164 $self
2165}
2166
2167# find and load all maps in the 3x3 area around a map
2168sub load_neighbours {
2169 my ($map) = @_;
2170
2171 my @neigh; # diagonal neighbours
2172
2173 for (0 .. 3) {
2174 my $neigh = $map->tile_path ($_)
2175 or next;
2176 $neigh = find $neigh, $map
2177 or next;
2178 $neigh->load;
2179
2180 # now find the diagonal neighbours
2181 push @neigh,
2182 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2183 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2184 }
2185
2186 for (grep defined $_->[0], @neigh) {
2187 my ($path, $origin) = @$_;
2188 my $neigh = find $path, $origin
2189 or next;
2190 $neigh->load;
2191 }
2192}
2193
2194sub find_sync {
1183 my ($path, $origin) = @_; 2195 my ($path, $origin) = @_;
1184 2196
1185 #warn "load_map_sync<$path, $origin>\n";#d# 2197 return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
2198 if $Coro::current == $Coro::main;
1186 2199
1187 cf::sync_job { 2200 find $path, $origin
1188 my $map = cf::map::find_map $path, $origin 2201}
1189 or return; 2202
2203sub do_load_sync {
2204 my ($map) = @_;
2205
2206 return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
2207 if $Coro::current == $Coro::main;
2208
1190 $map->load; 2209 $map->load;
1191 $map 2210}
2211
2212our %MAP_PREFETCH;
2213our $MAP_PREFETCHER = undef;
2214
2215sub find_async {
2216 my ($path, $origin, $load) = @_;
2217
2218 $path = normalise $path, $origin && $origin->{path};
2219
2220 if (my $map = $cf::MAP{$path}) {
2221 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2222 }
2223
2224 $MAP_PREFETCH{$path} |= $load;
2225
2226 $MAP_PREFETCHER ||= cf::async {
2227 $Coro::current->{desc} = "map prefetcher";
2228
2229 while (%MAP_PREFETCH) {
2230 while (my ($k, $v) = each %MAP_PREFETCH) {
2231 if (my $map = find $k) {
2232 $map->load if $v;
2233 }
2234
2235 delete $MAP_PREFETCH{$k};
2236 }
2237 }
2238 undef $MAP_PREFETCHER;
2239 };
2240 $MAP_PREFETCHER->prio (6);
2241
2242 ()
2243}
2244
2245# common code, used by both ->save and ->swapout
2246sub _save {
2247 my ($self) = @_;
2248
2249 $self->{last_save} = $cf::RUNTIME;
2250
2251 return unless $self->dirty;
2252
2253 my $save = $self->save_path; utf8::encode $save;
2254 my $uniq = $self->uniq_path; utf8::encode $uniq;
2255
2256 $self->{load_path} = $save;
2257
2258 return if $self->{deny_save};
2259
2260 local $self->{last_access} = $self->last_access;#d#
2261
2262 cf::async {
2263 $Coro::current->{desc} = "map player save";
2264 $_->contr->save for $self->players;
2265 };
2266
2267 cf::get_slot 0.02;
2268
2269 if ($uniq) {
2270 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2271 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2272 } else {
2273 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1192 } 2274 }
1193} 2275}
1194 2276
1195sub save { 2277sub save {
1196 my ($self) = @_; 2278 my ($self) = @_;
1197 2279
1198 my $save = $self->{path}->save_path; utf8::encode $save; 2280 my $lock = cf::lock_acquire "map_data:$self->{path}";
1199 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1200 2281
1201 $self->{last_save} = $cf::RUNTIME; 2282 $self->_save;
1202
1203 return unless $self->dirty;
1204
1205 $self->{load_path} = $save;
1206
1207 return if $self->{deny_save};
1208
1209 warn "saving map ", $self->path;
1210
1211 if ($uniq) {
1212 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1213 $self->save_objects ($uniq, cf::IO_UNIQUES);
1214 } else {
1215 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1216 }
1217} 2283}
1218 2284
1219sub swap_out { 2285sub swap_out {
1220 my ($self) = @_; 2286 my ($self) = @_;
1221 2287
2288 my $lock = cf::lock_acquire "map_data:$self->{path}";
2289
2290 return if $self->in_memory != cf::MAP_ACTIVE;
2291 return if $self->{deny_save};
1222 return if $self->players; 2292 return if $self->players;
1223 return if $self->in_memory != cf::MAP_IN_MEMORY;
1224 return if $self->{deny_save};
1225 2293
2294 # first deactivate the map and "unlink" it from the core
2295 $self->deactivate;
2296 $_->clear_links_to ($self) for values %cf::MAP;
2297 $self->in_memory (cf::MAP_SWAPPED);
2298
2299 # then atomically save
1226 $self->save; 2300 $self->_save;
2301
2302 # then free the map
1227 $self->clear; 2303 $self->clear;
1228 $self->in_memory (cf::MAP_SWAPPED); 2304}
2305
2306sub reset_at {
2307 my ($self) = @_;
2308
2309 # TODO: safety, remove and allow resettable per-player maps
2310 return 1e99 if $self->{deny_reset};
2311
2312 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2313 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2314
2315 $time + $to
1229} 2316}
1230 2317
1231sub should_reset { 2318sub should_reset {
1232 my ($map) = @_; 2319 my ($self) = @_;
1233 2320
1234 # TODO: safety, remove and allow resettable per-player maps 2321 $self->reset_at <= $cf::RUNTIME
1235 return if $map->{path}{user_rel};#d#
1236 return if $map->{deny_reset};
1237 #return unless $map->reset_timeout;
1238
1239 my $time = $map->fixed_resettime ? $map->{instantiate_time} : $map->last_access;
1240
1241 $time + ($map->reset_timeout || $DEFAULT_RESET) < $cf::RUNTIME
1242} 2322}
1243 2323
1244sub reset { 2324sub reset {
1245 my ($self) = @_; 2325 my ($self) = @_;
1246 2326
2327 my $lock = cf::lock_acquire "map_data:$self->{path}";
2328
1247 return if $self->players; 2329 return if $self->players;
1248 return if $self->{path}{user_rel};#d#
1249 2330
1250 warn "resetting map ", $self->path;#d# 2331 cf::trace "resetting map ", $self->path, "\n";
1251 2332
1252 utf8::encode (my $save = $self->{path}->save_path); 2333 $self->in_memory (cf::MAP_SWAPPED);
1253 aioreq_pri 3; IO::AIO::aio_unlink $save;
1254 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1255 2334
2335 # need to save uniques path
2336 unless ($self->{deny_save}) {
2337 my $uniq = $self->uniq_path; utf8::encode $uniq;
2338
2339 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2340 if $uniq;
2341 }
2342
2343 delete $cf::MAP{$self->path};
2344
2345 $self->deactivate;
1256 $_->clear_links_to ($self) for values %cf::MAP; 2346 $_->clear_links_to ($self) for values %cf::MAP;
1257
1258 $self->clear; 2347 $self->clear;
1259 $self->in_memory (cf::MAP_SWAPPED);
1260 utf8::encode ($self->{load_path} = $self->{path}->load_path);
1261}
1262 2348
1263sub customise_for { 2349 $self->unlink_save;
1264 my ($map, $ob) = @_; 2350 $self->destroy;
2351}
1265 2352
1266 if ($map->per_player) { 2353my $nuke_counter = "aaaa";
1267 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 2354
2355sub nuke {
2356 my ($self) = @_;
2357
1268 } 2358 {
2359 my $lock = cf::lock_acquire "map_data:$self->{path}";
1269 2360
1270 $map 2361 delete $cf::MAP{$self->path};
1271}
1272 2362
1273sub emergency_save { 2363 $self->unlink_save;
1274 local $cf::FREEZE = 1;
1275 2364
1276 warn "enter emergency map save\n"; 2365 bless $self, "cf::map::wrap";
2366 delete $self->{deny_reset};
2367 $self->{deny_save} = 1;
2368 $self->reset_timeout (1);
2369 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1277 2370
1278 cf::sync_job { 2371 $cf::MAP{$self->path} = $self;
1279 warn "begin emergency map save\n";
1280 $_->save for values %cf::MAP;
1281 }; 2372 }
1282 2373
1283 warn "end emergency map save\n"; 2374 $self->reset; # polite request, might not happen
2375}
2376
2377=item $maps = cf::map::tmp_maps
2378
2379Returns an arrayref with all map paths of currently instantiated and saved
2380maps. May block.
2381
2382=cut
2383
2384sub tmp_maps() {
2385 [
2386 map {
2387 utf8::decode $_;
2388 /\.map$/
2389 ? normalise $_
2390 : ()
2391 } @{ aio_readdir $TMPDIR or [] }
2392 ]
2393}
2394
2395=item $maps = cf::map::random_maps
2396
2397Returns an arrayref with all map paths of currently instantiated and saved
2398random maps. May block.
2399
2400=cut
2401
2402sub random_maps() {
2403 [
2404 map {
2405 utf8::decode $_;
2406 /\.map$/
2407 ? normalise "?random/$_"
2408 : ()
2409 } @{ aio_readdir $RANDOMDIR or [] }
2410 ]
2411}
2412
2413=item cf::map::unique_maps
2414
2415Returns an arrayref of paths of all shared maps that have
2416instantiated unique items. May block.
2417
2418=cut
2419
2420sub unique_maps() {
2421 [
2422 map {
2423 utf8::decode $_;
2424 s/\.map$//; # TODO future compatibility hack
2425 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2426 ? ()
2427 : normalise $_
2428 } @{ aio_readdir $UNIQUEDIR or [] }
2429 ]
2430}
2431
2432=item cf::map::static_maps
2433
2434Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2435file in the shared directory excluding F</styles> and F</editor>). May
2436block.
2437
2438=cut
2439
2440sub static_maps() {
2441 my @dirs = "";
2442 my @maps;
2443
2444 while (@dirs) {
2445 my $dir = shift @dirs;
2446
2447 next if $dir eq "/styles" || $dir eq "/editor";
2448
2449 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2450 or return;
2451
2452 for (@$files) {
2453 s/\.map$// or next;
2454 utf8::decode $_;
2455 push @maps, "$dir/$_";
2456 }
2457
2458 push @dirs, map "$dir/$_", @$dirs;
2459 }
2460
2461 \@maps
2462}
2463
2464=back
2465
2466=head3 cf::object
2467
2468=cut
2469
2470package cf::object;
2471
2472=over 4
2473
2474=item $ob->inv_recursive
2475
2476Returns the inventory of the object I<and> their inventories, recursively,
2477but I<not> the object itself.
2478
2479=cut
2480
2481sub inv_recursive_;
2482sub inv_recursive_ {
2483 map { $_, inv_recursive_ $_->inv } @_
2484}
2485
2486sub inv_recursive {
2487 inv_recursive_ inv $_[0]
2488}
2489
2490=item $ref = $ob->ref
2491
2492Creates and returns a persistent reference to an object that can be stored as a string.
2493
2494=item $ob = cf::object::deref ($refstring)
2495
2496returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2497even if the object actually exists. May block.
2498
2499=cut
2500
2501sub deref {
2502 my ($ref) = @_;
2503
2504 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2505 my ($uuid, $name) = ($1, $2);
2506 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2507 or return;
2508 $pl->ob->uuid eq $uuid
2509 or return;
2510
2511 $pl->ob
2512 } else {
2513 warn "$ref: cannot resolve object reference\n";
2514 undef
2515 }
1284} 2516}
1285 2517
1286package cf; 2518package cf;
1287 2519
1288=back 2520=back
1289
1290 2521
1291=head3 cf::object::player 2522=head3 cf::object::player
1292 2523
1293=over 4 2524=over 4
1294 2525
1297Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2528Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1298can be C<undef>. Does the right thing when the player is currently in a 2529can be C<undef>. Does the right thing when the player is currently in a
1299dialogue with the given NPC character. 2530dialogue with the given NPC character.
1300 2531
1301=cut 2532=cut
2533
2534our $SAY_CHANNEL = {
2535 id => "say",
2536 title => "Map",
2537 reply => "say ",
2538 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2539};
2540
2541our $CHAT_CHANNEL = {
2542 id => "chat",
2543 title => "Chat",
2544 reply => "chat ",
2545 tooltip => "Player chat and shouts, global to the server.",
2546};
1302 2547
1303# rough implementation of a future "reply" method that works 2548# rough implementation of a future "reply" method that works
1304# with dialog boxes. 2549# with dialog boxes.
1305#TODO: the first argument must go, split into a $npc->reply_to ( method 2550#TODO: the first argument must go, split into a $npc->reply_to ( method
1306sub cf::object::player::reply($$$;$) { 2551sub cf::object::player::reply($$$;$) {
1308 2553
1309 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2554 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1310 2555
1311 if ($self->{record_replies}) { 2556 if ($self->{record_replies}) {
1312 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2557 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2558
1313 } else { 2559 } else {
2560 my $pl = $self->contr;
2561
2562 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2563 my $dialog = $pl->{npc_dialog};
2564 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2565
2566 } else {
1314 $msg = $npc->name . " says: $msg" if $npc; 2567 $msg = $npc->name . " says: $msg" if $npc;
1315 $self->message ($msg, $flags); 2568 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2569 }
1316 } 2570 }
2571}
2572
2573=item $object->send_msg ($channel, $msg, $color, [extra...])
2574
2575=cut
2576
2577sub cf::object::send_msg {
2578 my $pl = shift->contr
2579 or return;
2580 $pl->send_msg (@_);
1317} 2581}
1318 2582
1319=item $player_object->may ("access") 2583=item $player_object->may ("access")
1320 2584
1321Returns wether the given player is authorized to access resource "access" 2585Returns wether the given player is authorized to access resource "access"
1330 (ref $cf::CFG{"may_$access"} 2594 (ref $cf::CFG{"may_$access"}
1331 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2595 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1332 : $cf::CFG{"may_$access"}) 2596 : $cf::CFG{"may_$access"})
1333} 2597}
1334 2598
2599=item $player_object->enter_link
2600
2601Freezes the player and moves him/her to a special map (C<{link}>).
2602
2603The player should be reasonably safe there for short amounts of time (e.g.
2604for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2605though, as the player cannot control the character while it is on the link
2606map.
2607
2608Will never block.
2609
2610=item $player_object->leave_link ($map, $x, $y)
2611
2612Moves the player out of the special C<{link}> map onto the specified
2613map. If the map is not valid (or omitted), the player will be moved back
2614to the location he/she was before the call to C<enter_link>, or, if that
2615fails, to the emergency map position.
2616
2617Might block.
2618
2619=cut
2620
2621sub link_map {
2622 unless ($LINK_MAP) {
2623 $LINK_MAP = cf::map::find "{link}"
2624 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2625 $LINK_MAP->load;
2626 }
2627
2628 $LINK_MAP
2629}
2630
1335sub cf::object::player::enter_link { 2631sub cf::object::player::enter_link {
1336 my ($self) = @_; 2632 my ($self) = @_;
1337 2633
1338 return if $self->map == $LINK_MAP;
1339
1340 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1341 if $self->map;
1342
1343 $self->enter_map ($LINK_MAP, 20, 20);
1344 $self->deactivate_recursive; 2634 $self->deactivate_recursive;
2635
2636 ++$self->{_link_recursion};
2637
2638 return if UNIVERSAL::isa $self->map, "ext::map_link";
2639
2640 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2641 if $self->map && $self->map->{path} ne "{link}";
2642
2643 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1345} 2644}
1346 2645
1347sub cf::object::player::leave_link { 2646sub cf::object::player::leave_link {
1348 my ($self, $map, $x, $y) = @_; 2647 my ($self, $map, $x, $y) = @_;
1349 2648
2649 return unless $self->contr->active;
2650
1350 my $link_pos = delete $self->{_link_pos}; 2651 my $link_pos = delete $self->{_link_pos};
1351 2652
1352 unless ($map) { 2653 unless ($map) {
1353 $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1354
1355 # restore original map position 2654 # restore original map position
1356 ($map, $x, $y) = @{ $link_pos || [] }; 2655 ($map, $x, $y) = @{ $link_pos || [] };
1357 $map = cf::map::find_map $map; 2656 $map = cf::map::find $map;
1358 2657
1359 unless ($map) { 2658 unless ($map) {
1360 ($map, $x, $y) = @$EMERGENCY_POSITION; 2659 ($map, $x, $y) = @$EMERGENCY_POSITION;
1361 $map = cf::map::find_map $map 2660 $map = cf::map::find $map
1362 or die "FATAL: cannot load emergency map\n"; 2661 or die "FATAL: cannot load emergency map\n";
1363 } 2662 }
1364 } 2663 }
1365 2664
1366 ($x, $y) = (-1, -1) 2665 ($x, $y) = (-1, -1)
1367 unless (defined $x) && (defined $y); 2666 unless (defined $x) && (defined $y);
1368 2667
1369 # use -1 or undef as default coordinates, not 0, 0 2668 # use -1 or undef as default coordinates, not 0, 0
1370 ($x, $y) = ($map->enter_x, $map->enter_y) 2669 ($x, $y) = ($map->enter_x, $map->enter_y)
1371 if $x <=0 && $y <= 0; 2670 if $x <= 0 && $y <= 0;
1372 2671
1373 $map->load; 2672 $map->load;
2673 $map->load_neighbours;
1374 2674
2675 return unless $self->contr->active;
2676
2677 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2678 if ($self->enter_map ($map, $x, $y)) {
2679 # entering was successful
2680 delete $self->{_link_recursion};
2681 # only activate afterwards, to support waiting in hooks
1375 $self->activate_recursive; 2682 $self->activate_recursive;
1376 $self->enter_map ($map, $x, $y); 2683 }
1377}
1378 2684
1379=item $player_object->goto_map ($map, $x, $y) 2685}
1380 2686
1381=cut 2687=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1382 2688
2689Moves the player to the given map-path and coordinates by first freezing
2690her, loading and preparing them map, calling the provided $check callback
2691that has to return the map if sucecssful, and then unfreezes the player on
2692the new (success) or old (failed) map position. In either case, $done will
2693be called at the end of this process.
2694
2695Note that $check will be called with a potentially non-loaded map, so if
2696it needs a loaded map it has to call C<< ->load >>.
2697
2698=cut
2699
2700our $GOTOGEN;
2701
1383sub cf::object::player::goto_map { 2702sub cf::object::player::goto {
1384 my ($self, $path, $x, $y) = @_; 2703 my ($self, $path, $x, $y, $check, $done) = @_;
2704
2705 if ($self->{_link_recursion} >= $MAX_LINKS) {
2706 error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
2707 $self->failmsg ("Something went wrong inside the server - please contact an administrator!");
2708 ($path, $x, $y) = @$EMERGENCY_POSITION;
2709 }
2710
2711 # do generation counting so two concurrent goto's will be executed in-order
2712 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1385 2713
1386 $self->enter_link; 2714 $self->enter_link;
1387 2715
1388 (Coro::async { 2716 (async {
1389 $path = new cf::path $path; 2717 $Coro::current->{desc} = "player::goto $path $x $y";
1390 2718
1391 my $map = cf::map::find_map $path->as_string; 2719 # *tag paths override both path and x|y
2720 if ($path =~ /^\*(.*)$/) {
2721 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2722 my $ob = $obs[rand @obs];
2723
2724 # see if we actually can go there
2725 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2726 $ob = $obs[rand @obs];
2727 } else {
2728 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2729 }
2730 # else put us there anyways for now #d#
2731
2732 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2733 } else {
2734 ($path, $x, $y) = (undef, undef, undef);
2735 }
2736 }
2737
2738 my $map = eval {
2739 my $map = defined $path ? cf::map::find $path : undef;
2740
2741 if ($map) {
1392 $map = $map->customise_for ($self) if $map; 2742 $map = $map->customise_for ($self);
2743 $map = $check->($map, $x, $y, $self) if $check && $map;
2744 } else {
2745 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2746 }
1393 2747
1394 warn "entering ", $map->path, " at ($x, $y)\n"
1395 if $map; 2748 $map
2749 };
1396 2750
2751 if ($@) {
2752 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2753 LOG llevError | logBacktrace, Carp::longmess $@;
2754 }
2755
2756 if ($gen == $self->{_goto_generation}) {
2757 delete $self->{_goto_generation};
1397 $self->leave_link ($map, $x, $y); 2758 $self->leave_link ($map, $x, $y);
2759 }
2760
2761 $done->($self) if $done;
1398 })->prio (1); 2762 })->prio (1);
1399} 2763}
1400 2764
1401=item $player_object->enter_exit ($exit_object) 2765=item $player_object->enter_exit ($exit_object)
1402 2766
1404 2768
1405sub parse_random_map_params { 2769sub parse_random_map_params {
1406 my ($spec) = @_; 2770 my ($spec) = @_;
1407 2771
1408 my $rmp = { # defaults 2772 my $rmp = { # defaults
1409 xsize => 10, 2773 xsize => (cf::rndm 15, 40),
1410 ysize => 10, 2774 ysize => (cf::rndm 15, 40),
2775 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2776 #layout => string,
1411 }; 2777 };
1412 2778
1413 for (split /\n/, $spec) { 2779 for (split /\n/, $spec) {
1414 my ($k, $v) = split /\s+/, $_, 2; 2780 my ($k, $v) = split /\s+/, $_, 2;
1415 2781
1427 # that depends on the exit object 2793 # that depends on the exit object
1428 2794
1429 my $rmp = parse_random_map_params $exit->msg; 2795 my $rmp = parse_random_map_params $exit->msg;
1430 2796
1431 if ($exit->map) { 2797 if ($exit->map) {
1432 $rmp->{region} = $exit->map->region_name; 2798 $rmp->{region} = $exit->region->name;
1433 $rmp->{origin_map} = $exit->map->path; 2799 $rmp->{origin_map} = $exit->map->path;
1434 $rmp->{origin_x} = $exit->x; 2800 $rmp->{origin_x} = $exit->x;
1435 $rmp->{origin_y} = $exit->y; 2801 $rmp->{origin_y} = $exit->y;
2802
2803 $exit->map->touch;
1436 } 2804 }
1437 2805
1438 $rmp->{random_seed} ||= $exit->random_seed; 2806 $rmp->{random_seed} ||= $exit->random_seed;
1439 2807
1440 my $data = cf::to_json $rmp; 2808 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1441 my $md5 = Digest::MD5::md5_hex $data; 2809 my $md5 = Digest::MD5::md5_hex $data;
2810 my $meta = "$RANDOMDIR/$md5.meta";
1442 2811
1443 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2812 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1444 aio_write $fh, 0, (length $data), $data, 0; 2813 aio_write $fh, 0, (length $data), $data, 0;
2814 undef $fh;
2815 aio_rename "$meta~", $meta;
1445 2816
2817 my $slaying = "?random/$md5";
2818
2819 if ($exit->valid) {
1446 $exit->slaying ("?random/$md5"); 2820 $exit->slaying ("?random/$md5");
1447 $exit->msg (undef); 2821 $exit->msg (undef);
2822 }
1448 } 2823 }
1449} 2824}
1450 2825
1451sub cf::object::player::enter_exit { 2826sub cf::object::player::enter_exit {
1452 my ($self, $exit) = @_; 2827 my ($self, $exit) = @_;
1453 2828
1454 return unless $self->type == cf::PLAYER; 2829 return unless $self->type == cf::PLAYER;
1455 2830
1456 $self->enter_link; 2831 $self->enter_link;
1457 2832
1458 (Coro::async { 2833 (async {
2834 $Coro::current->{desc} = "enter_exit";
2835
1459 unless (eval { 2836 unless (eval {
2837 $self->deactivate_recursive; # just to be sure
1460 2838
2839 # random map handling
2840 {
2841 my $guard = cf::lock_acquire "exit_prepare:$exit";
2842
1461 prepare_random_map $exit 2843 prepare_random_map $exit
1462 if $exit->slaying eq "/!"; 2844 if $exit->slaying eq "/!";
2845 }
1463 2846
1464 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 2847 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1465 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp); 2848 my $x = $exit->stats->hp;
2849 my $y = $exit->stats->sp;
1466 2850
2851 $self->goto ($map, $x, $y);
2852
2853 # if exit is damned, update players death & WoR home-position
2854 $self->contr->savebed ($map, $x, $y)
2855 if $exit->flag (cf::FLAG_DAMNED);
2856
1467 1; 2857 1
1468 }) { 2858 }) {
1469 $self->message ("Something went wrong deep within the crossfire server. " 2859 $self->message ("Something went wrong deep within the deliantra server. "
1470 . "I'll try to bring you back to the map you were before. " 2860 . "I'll try to bring you back to the map you were before. "
1471 . "Please report this to the dungeon master", 2861 . "Please report this to the dungeon master!",
1472 cf::NDI_UNIQUE | cf::NDI_RED); 2862 cf::NDI_UNIQUE | cf::NDI_RED);
1473 2863
1474 warn "ERROR in enter_exit: $@"; 2864 error "ERROR in enter_exit: $@";
1475 $self->leave_link; 2865 $self->leave_link;
1476 } 2866 }
1477 })->prio (1); 2867 })->prio (1);
1478} 2868}
1479 2869
1490 2880
1491sub cf::client::send_drawinfo { 2881sub cf::client::send_drawinfo {
1492 my ($self, $text, $flags) = @_; 2882 my ($self, $text, $flags) = @_;
1493 2883
1494 utf8::encode $text; 2884 utf8::encode $text;
1495 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2885 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1496} 2886}
1497 2887
2888=item $client->send_big_packet ($pkt)
2889
2890Like C<send_packet>, but tries to compress large packets, and fragments
2891them as required.
2892
2893=cut
2894
2895our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2896
2897sub cf::client::send_big_packet {
2898 my ($self, $pkt) = @_;
2899
2900 # try lzf for large packets
2901 $pkt = "lzf " . Compress::LZF::compress $pkt
2902 if 1024 <= length $pkt and $self->{can_lzf};
2903
2904 # split very large packets
2905 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
2906 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
2907 $pkt = "frag";
2908 }
2909
2910 $self->send_packet ($pkt);
2911}
2912
2913=item $client->send_msg ($channel, $msg, $color, [extra...])
2914
2915Send a drawinfo or msg packet to the client, formatting the msg for the
2916client if neccessary. C<$type> should be a string identifying the type of
2917the message, with C<log> being the default. If C<$color> is negative, suppress
2918the message unless the client supports the msg packet.
2919
2920=cut
2921
2922# non-persistent channels (usually the info channel)
2923our %CHANNEL = (
2924 "c/motd" => {
2925 id => "infobox",
2926 title => "MOTD",
2927 reply => undef,
2928 tooltip => "The message of the day",
2929 },
2930 "c/identify" => {
2931 id => "infobox",
2932 title => "Identify",
2933 reply => undef,
2934 tooltip => "Items recently identified",
2935 },
2936 "c/examine" => {
2937 id => "infobox",
2938 title => "Examine",
2939 reply => undef,
2940 tooltip => "Signs and other items you examined",
2941 },
2942 "c/shopinfo" => {
2943 id => "infobox",
2944 title => "Shop Info",
2945 reply => undef,
2946 tooltip => "What your bargaining skill tells you about the shop",
2947 },
2948 "c/book" => {
2949 id => "infobox",
2950 title => "Book",
2951 reply => undef,
2952 tooltip => "The contents of a note or book",
2953 },
2954 "c/lookat" => {
2955 id => "infobox",
2956 title => "Look",
2957 reply => undef,
2958 tooltip => "What you saw there",
2959 },
2960 "c/who" => {
2961 id => "infobox",
2962 title => "Players",
2963 reply => undef,
2964 tooltip => "Shows players who are currently online",
2965 },
2966 "c/body" => {
2967 id => "infobox",
2968 title => "Body Parts",
2969 reply => undef,
2970 tooltip => "Shows which body parts you posess and are available",
2971 },
2972 "c/statistics" => {
2973 id => "infobox",
2974 title => "Statistics",
2975 reply => undef,
2976 tooltip => "Shows your primary statistics",
2977 },
2978 "c/skills" => {
2979 id => "infobox",
2980 title => "Skills",
2981 reply => undef,
2982 tooltip => "Shows your experience per skill and item power",
2983 },
2984 "c/shopitems" => {
2985 id => "infobox",
2986 title => "Shop Items",
2987 reply => undef,
2988 tooltip => "Shows the items currently for sale in this shop",
2989 },
2990 "c/resistances" => {
2991 id => "infobox",
2992 title => "Resistances",
2993 reply => undef,
2994 tooltip => "Shows your resistances",
2995 },
2996 "c/pets" => {
2997 id => "infobox",
2998 title => "Pets",
2999 reply => undef,
3000 tooltip => "Shows information abotu your pets/a specific pet",
3001 },
3002 "c/perceiveself" => {
3003 id => "infobox",
3004 title => "Perceive Self",
3005 reply => undef,
3006 tooltip => "You gained detailed knowledge about yourself",
3007 },
3008 "c/uptime" => {
3009 id => "infobox",
3010 title => "Uptime",
3011 reply => undef,
3012 tooltip => "How long the server has been running since last restart",
3013 },
3014 "c/mapinfo" => {
3015 id => "infobox",
3016 title => "Map Info",
3017 reply => undef,
3018 tooltip => "Information related to the maps",
3019 },
3020 "c/party" => {
3021 id => "party",
3022 title => "Party",
3023 reply => "gsay ",
3024 tooltip => "Messages and chat related to your party",
3025 },
3026 "c/death" => {
3027 id => "death",
3028 title => "Death",
3029 reply => undef,
3030 tooltip => "Reason for and more info about your most recent death",
3031 },
3032 "c/say" => $SAY_CHANNEL,
3033 "c/chat" => $CHAT_CHANNEL,
3034);
3035
3036sub cf::client::send_msg {
3037 my ($self, $channel, $msg, $color, @extra) = @_;
3038
3039 $msg = $self->pl->expand_cfpod ($msg)
3040 unless $color & cf::NDI_VERBATIM;
3041
3042 $color &= cf::NDI_CLIENT_MASK; # just in case...
3043
3044 # check predefined channels, for the benefit of C
3045 if ($CHANNEL{$channel}) {
3046 $channel = $CHANNEL{$channel};
3047
3048 $self->ext_msg (channel_info => $channel);
3049 $channel = $channel->{id};
3050
3051 } elsif (ref $channel) {
3052 # send meta info to client, if not yet sent
3053 unless (exists $self->{channel}{$channel->{id}}) {
3054 $self->{channel}{$channel->{id}} = $channel;
3055 $self->ext_msg (channel_info => $channel);
3056 }
3057
3058 $channel = $channel->{id};
3059 }
3060
3061 return unless @extra || length $msg;
3062
3063 # default colour, mask it out
3064 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
3065 if $color & cf::NDI_DEF;
3066
3067 my $pkt = "msg "
3068 . $self->{json_coder}->encode (
3069 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
3070 );
3071
3072 $self->send_big_packet ($pkt);
3073}
3074
3075=item $client->ext_msg ($type, @msg)
3076
3077Sends an ext event to the client.
3078
3079=cut
3080
3081sub cf::client::ext_msg($$@) {
3082 my ($self, $type, @msg) = @_;
3083
3084 if ($self->extcmd == 2) {
3085 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
3086 } elsif ($self->extcmd == 1) { # TODO: remove
3087 push @msg, msgtype => "event_$type";
3088 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3089 }
3090}
3091
3092=item $client->ext_reply ($msgid, @msg)
3093
3094Sends an ext reply to the client.
3095
3096=cut
3097
3098sub cf::client::ext_reply($$@) {
3099 my ($self, $id, @msg) = @_;
3100
3101 if ($self->extcmd == 2) {
3102 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
3103 } elsif ($self->extcmd == 1) {
3104 #TODO: version 1, remove
3105 unshift @msg, msgtype => "reply", msgid => $id;
3106 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3107 }
3108}
1498 3109
1499=item $success = $client->query ($flags, "text", \&cb) 3110=item $success = $client->query ($flags, "text", \&cb)
1500 3111
1501Queues a query to the client, calling the given callback with 3112Queues a query to the client, calling the given callback with
1502the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 3113the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1503C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 3114C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1504 3115
1505Queries can fail, so check the return code. Or don't, as queries will become 3116Queries can fail, so check the return code. Or don't, as queries will
1506reliable at some point in the future. 3117become reliable at some point in the future.
1507 3118
1508=cut 3119=cut
1509 3120
1510sub cf::client::query { 3121sub cf::client::query {
1511 my ($self, $flags, $text, $cb) = @_; 3122 my ($self, $flags, $text, $cb) = @_;
1519 utf8::encode $text; 3130 utf8::encode $text;
1520 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3131 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1521 3132
1522 $self->send_packet ($self->{query_queue}[0][0]) 3133 $self->send_packet ($self->{query_queue}[0][0])
1523 if @{ $self->{query_queue} } == 1; 3134 if @{ $self->{query_queue} } == 1;
3135
3136 1
1524} 3137}
1525 3138
1526cf::client->attach ( 3139cf::client->attach (
3140 on_connect => sub {
3141 my ($ns) = @_;
3142
3143 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3144 },
1527 on_reply => sub { 3145 on_reply => sub {
1528 my ($ns, $msg) = @_; 3146 my ($ns, $msg) = @_;
1529 3147
1530 # this weird shuffling is so that direct followup queries 3148 # this weird shuffling is so that direct followup queries
1531 # get handled first 3149 # get handled first
1532 my $queue = delete $ns->{query_queue}; 3150 my $queue = delete $ns->{query_queue}
3151 or return; # be conservative, not sure how that can happen, but we saw a crash here
1533 3152
1534 (shift @$queue)->[1]->($msg); 3153 (shift @$queue)->[1]->($msg);
3154 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1535 3155
1536 push @{ $ns->{query_queue} }, @$queue; 3156 push @{ $ns->{query_queue} }, @$queue;
1537 3157
1538 if (@{ $ns->{query_queue} } == @$queue) { 3158 if (@{ $ns->{query_queue} } == @$queue) {
1539 if (@$queue) { 3159 if (@$queue) {
1541 } else { 3161 } else {
1542 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1543 } 3163 }
1544 } 3164 }
1545 }, 3165 },
3166 on_exticmd => sub {
3167 my ($ns, $buf) = @_;
3168
3169 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3170
3171 if (ref $msg) {
3172 my ($type, $reply, @payload) =
3173 "ARRAY" eq ref $msg
3174 ? @$msg
3175 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3176
3177 my @reply;
3178
3179 if (my $cb = $EXTICMD{$type}) {
3180 @reply = $cb->($ns, @payload);
3181 }
3182
3183 $ns->ext_reply ($reply, @reply)
3184 if $reply;
3185
3186 } else {
3187 error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3188 }
3189
3190 cf::override;
3191 },
1546); 3192);
1547 3193
1548=item $client->coro (\&cb) 3194=item $client->async (\&cb)
1549 3195
1550Create a new coroutine, running the specified callback. The coroutine will 3196Create a new coroutine, running the specified callback. The coroutine will
1551be automatically cancelled when the client gets destroyed (e.g. on logout, 3197be automatically cancelled when the client gets destroyed (e.g. on logout,
1552or loss of connection). 3198or loss of connection).
1553 3199
1554=cut 3200=cut
1555 3201
1556sub cf::client::coro { 3202sub cf::client::async {
1557 my ($self, $cb) = @_; 3203 my ($self, $cb) = @_;
1558 3204
1559 my $coro; $coro = async { 3205 my $coro = &Coro::async ($cb);
1560 eval {
1561 $cb->();
1562 };
1563 warn $@ if $@;
1564 };
1565 3206
1566 $coro->on_destroy (sub { 3207 $coro->on_destroy (sub {
1567 delete $self->{_coro}{$coro+0}; 3208 delete $self->{_coro}{$coro+0};
1568 }); 3209 });
1569 3210
1571 3212
1572 $coro 3213 $coro
1573} 3214}
1574 3215
1575cf::client->attach ( 3216cf::client->attach (
1576 on_destroy => sub { 3217 on_client_destroy => sub {
1577 my ($ns) = @_; 3218 my ($ns) = @_;
1578 3219
1579 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3220 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1580 }, 3221 },
1581); 3222);
1596our $safe = new Safe "safe"; 3237our $safe = new Safe "safe";
1597our $safe_hole = new Safe::Hole; 3238our $safe_hole = new Safe::Hole;
1598 3239
1599$SIG{FPE} = 'IGNORE'; 3240$SIG{FPE} = 'IGNORE';
1600 3241
1601$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3242$safe->permit_only (Opcode::opset qw(
3243 :base_core :base_mem :base_orig :base_math :base_loop
3244 grepstart grepwhile mapstart mapwhile
3245 sort time
3246));
1602 3247
1603# here we export the classes and methods available to script code 3248# here we export the classes and methods available to script code
1604 3249
1605=pod 3250=pod
1606 3251
1607The following fucntions and emthods are available within a safe environment: 3252The following functions and methods are available within a safe environment:
1608 3253
1609 cf::object contr pay_amount pay_player map 3254 cf::object
3255 contr pay_amount pay_player map x y force_find force_add destroy
3256 insert remove name archname title slaying race decrease split
3257 value
3258
1610 cf::object::player player 3259 cf::object::player
1611 cf::player peaceful 3260 player
1612 cf::map trigger 3261
3262 cf::player
3263 peaceful
3264
3265 cf::map
3266 trigger
1613 3267
1614=cut 3268=cut
1615 3269
1616for ( 3270for (
1617 ["cf::object" => qw(contr pay_amount pay_player map)], 3271 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3272 insert remove inv nrof name archname title slaying race
3273 decrease split destroy change_exp value msg lore send_msg)],
1618 ["cf::object::player" => qw(player)], 3274 ["cf::object::player" => qw(player)],
1619 ["cf::player" => qw(peaceful)], 3275 ["cf::player" => qw(peaceful send_msg)],
1620 ["cf::map" => qw(trigger)], 3276 ["cf::map" => qw(trigger)],
1621) { 3277) {
1622 no strict 'refs';
1623 my ($pkg, @funs) = @$_; 3278 my ($pkg, @funs) = @$_;
1624 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3279 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1625 for @funs; 3280 for @funs;
1626} 3281}
1627 3282
1642 3297
1643 my $qcode = $code; 3298 my $qcode = $code;
1644 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3299 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1645 $qcode =~ s/\n/\\n/g; 3300 $qcode =~ s/\n/\\n/g;
1646 3301
3302 %vars = (_dummy => 0) unless %vars;
3303
3304 my @res;
1647 local $_; 3305 local $_;
1648 local @safe::cf::_safe_eval_args = values %vars;
1649 3306
1650 my $eval = 3307 my $eval =
1651 "do {\n" 3308 "do {\n"
1652 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3309 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1653 . "#line 0 \"{$qcode}\"\n" 3310 . "#line 0 \"{$qcode}\"\n"
1654 . $code 3311 . $code
1655 . "\n}" 3312 . "\n}"
1656 ; 3313 ;
1657 3314
3315 if ($CFG{safe_eval}) {
1658 sub_generation_inc; 3316 sub_generation_inc;
3317 local @safe::cf::_safe_eval_args = values %vars;
1659 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3318 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1660 sub_generation_inc; 3319 sub_generation_inc;
3320 } else {
3321 local @cf::_safe_eval_args = values %vars;
3322 @res = wantarray ? eval eval : scalar eval $eval;
3323 }
1661 3324
1662 if ($@) { 3325 if ($@) {
1663 warn "$@"; 3326 warn "$@",
1664 warn "while executing safe code '$code'\n"; 3327 "while executing safe code '$code'\n",
1665 warn "with arguments " . (join " ", %vars) . "\n"; 3328 "with arguments " . (join " ", %vars) . "\n";
1666 } 3329 }
1667 3330
1668 wantarray ? @res : $res[0] 3331 wantarray ? @res : $res[0]
1669} 3332}
1670 3333
1684=cut 3347=cut
1685 3348
1686sub register_script_function { 3349sub register_script_function {
1687 my ($fun, $cb) = @_; 3350 my ($fun, $cb) = @_;
1688 3351
1689 no strict 'refs'; 3352 $fun = "safe::$fun" if $CFG{safe_eval};
1690 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3353 *$fun = $safe_hole->wrap ($cb);
1691} 3354}
1692 3355
1693=back 3356=back
1694 3357
1695=cut 3358=cut
1696 3359
1697############################################################################# 3360#############################################################################
3361# the server's init and main functions
1698 3362
1699=head2 EXTENSION DATABASE SUPPORT 3363# async inc loader. yay.
3364sub inc_loader {
3365 my $mod = $_[1];
1700 3366
1701Crossfire maintains a very simple database for extension use. It can 3367 if (in_main && !tick_inhibit) {
1702currently store anything that can be serialised using Storable, which 3368 Carp::cluck "ERROR: attempted synchronous perl module load ($mod)";
1703excludes objects. 3369 } else {
1704 3370 debug "loading perl module $mod\n";
1705The parameter C<$family> should best start with the name of the extension
1706using it, it should be unique.
1707
1708=over 4
1709
1710=item $hashref = cf::db_get $family
1711
1712Return a hashref for use by the extension C<$family>, which can be
1713modified. After modifications, you have to call C<cf::db_dirty> or
1714C<cf::db_sync>.
1715
1716=item $value = cf::db_get $family => $key
1717
1718Returns a single value from the database
1719
1720=item cf::db_put $family => $hashref
1721
1722Stores the given family hashref into the database. Updates are delayed, if
1723you want the data to be synced to disk immediately, use C<cf::db_sync>.
1724
1725=item cf::db_put $family => $key => $value
1726
1727Stores the given C<$value> in the family hash. Updates are delayed, if you
1728want the data to be synced to disk immediately, use C<cf::db_sync>.
1729
1730=item cf::db_dirty
1731
1732Marks the database as dirty, to be updated at a later time.
1733
1734=item cf::db_sync
1735
1736Immediately write the database to disk I<if it is dirty>.
1737
1738=cut
1739
1740our $DB;
1741
1742{
1743 my $path = cf::localdir . "/database.pst";
1744
1745 sub db_load() {
1746 warn "loading database $path\n";#d# remove later
1747 $DB = stat $path ? Storable::retrieve $path : { };
1748 } 3371 }
1749 3372
1750 my $pid; 3373 # 1. find real file
3374 for my $dir (@ORIG_INC) {
3375 warn "$dir/$mod\n";#d#
3376 ref $dir and next;
3377 0 <= Coro::AIO::aio_load "$dir/$mod", my $data
3378 or next;
1751 3379
1752 sub db_save() { 3380 $data = "#line 1 $dir/$mod\n$data";
1753 warn "saving database $path\n";#d# remove later
1754 waitpid $pid, 0 if $pid;
1755 if (0 == ($pid = fork)) {
1756 $DB->{_meta}{version} = 1;
1757 Storable::nstore $DB, "$path~";
1758 rename "$path~", $path;
1759 cf::_exit 0 if defined $pid;
1760 }
1761 }
1762 3381
1763 my $dirty; 3382 open my $fh, "<", \$data or die;
1764 3383
1765 sub db_sync() { 3384 return $fh;
1766 db_save if $dirty;
1767 undef $dirty;
1768 } 3385 }
1769 3386
1770 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { 3387 ()
1771 db_sync; 3388}
3389
3390sub init_inc {
3391 # save original @INC
3392 @ORIG_INC = ($LIBDIR, @INC) unless @ORIG_INC;
3393
3394 # make sure we can do scalar-opens
3395 open my $dummy, "<", \my $dummy2;
3396
3397 # execute some stuff so perl load's some of the core modules
3398 /Ü/ =~ /ü/i;
3399 eval { &Storable::nstore_fd };
3400
3401 @INC = (\&inc_loader, @ORIG_INC); # @ORIG_INC is needed for DynaLoader, AutoLoad etc.
3402
3403 debug "module loading will be asynchronous from this point on.";
3404}
3405
3406sub load_facedata($) {
3407 my ($path) = @_;
3408
3409 # HACK to clear player env face cache, we need some signal framework
3410 # for this (global event?)
3411 %ext::player_env::MUSIC_FACE_CACHE = ();
3412
3413 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3414
3415 trace "loading facedata from $path\n";
3416
3417 my $facedata;
3418 0 < aio_load $path, $facedata
3419 or die "$path: $!";
3420
3421 $facedata = Coro::Storable::thaw $facedata;
3422
3423 $facedata->{version} == 2
3424 or cf::cleanup "$path: version mismatch, cannot proceed.";
3425
3426 # patch in the exptable
3427 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
3428 $facedata->{resource}{"res/exp_table"} = {
3429 type => FT_RSRC,
3430 data => $exp_table,
3431 hash => (Digest::MD5::md5 $exp_table),
1772 }); 3432 };
3433 cf::cede_to_tick;
1773 3434
1774 sub db_dirty() {
1775 $dirty = 1;
1776 $idle->start;
1777 } 3435 {
3436 my $faces = $facedata->{faceinfo};
1778 3437
1779 sub db_get($;$) { 3438 while (my ($face, $info) = each %$faces) {
1780 @_ >= 2 3439 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1781 ? $DB->{$_[0]}{$_[1]}
1782 : ($DB->{$_[0]} ||= { })
1783 }
1784 3440
1785 sub db_put($$;$) { 3441 cf::face::set_visibility $idx, $info->{visibility};
1786 if (@_ >= 3) { 3442 cf::face::set_magicmap $idx, $info->{magicmap};
1787 $DB->{$_[0]}{$_[1]} = $_[2]; 3443 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
1788 } else { 3444 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
1789 $DB->{$_[0]} = $_[1];
1790 }
1791 db_dirty;
1792 }
1793 3445
1794 cf::global->attach ( 3446 cf::cede_to_tick;
1795 prio => 10000,
1796 on_cleanup => sub {
1797 db_sync;
1798 }, 3447 }
1799 );
1800}
1801 3448
1802############################################################################# 3449 while (my ($face, $info) = each %$faces) {
1803# the server's main() 3450 next unless $info->{smooth};
1804 3451
1805sub cfg_load { 3452 my $idx = cf::face::find $face
3453 or next;
3454
3455 if (my $smooth = cf::face::find $info->{smooth}) {
3456 cf::face::set_smooth $idx, $smooth;
3457 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3458 } else {
3459 error "smooth face '$info->{smooth}' not found for face '$face'";
3460 }
3461
3462 cf::cede_to_tick;
3463 }
3464 }
3465
3466 {
3467 my $anims = $facedata->{animinfo};
3468
3469 while (my ($anim, $info) = each %$anims) {
3470 cf::anim::set $anim, $info->{frames}, $info->{facings};
3471 cf::cede_to_tick;
3472 }
3473
3474 cf::anim::invalidate_all; # d'oh
3475 }
3476
3477 {
3478 my $res = $facedata->{resource};
3479
3480 while (my ($name, $info) = each %$res) {
3481 if (defined $info->{type}) {
3482 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3483
3484 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3485 cf::face::set_type $idx, $info->{type};
3486 } else {
3487 $RESOURCE{$name} = $info; # unused
3488 }
3489
3490 cf::cede_to_tick;
3491 }
3492 }
3493
3494 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3495
3496 1
3497}
3498
3499register_exticmd fx_want => sub {
3500 my ($ns, $want) = @_;
3501
3502 while (my ($k, $v) = each %$want) {
3503 $ns->fx_want ($k, $v);
3504 }
3505};
3506
3507sub load_resource_file($) {
3508 my $guard = lock_acquire "load_resource_file";
3509
3510 my $status = load_resource_file_ $_[0];
3511 get_slot 0.1, 100;
3512 cf::arch::commit_load;
3513
3514 $status
3515}
3516
3517sub reload_regions {
3518 # HACK to clear player env face cache, we need some signal framework
3519 # for this (global event?)
3520 %ext::player_env::MUSIC_FACE_CACHE = ();
3521
3522 load_resource_file "$MAPDIR/regions"
3523 or die "unable to load regions file\n";
3524
3525 for (cf::region::list) {
3526 $_->{match} = qr/$_->{match}/
3527 if exists $_->{match};
3528 }
3529}
3530
3531sub reload_facedata {
3532 load_facedata "$DATADIR/facedata"
3533 or die "unable to load facedata\n";
3534}
3535
3536sub reload_archetypes {
3537 load_resource_file "$DATADIR/archetypes"
3538 or die "unable to load archetypes\n";
3539}
3540
3541sub reload_treasures {
3542 load_resource_file "$DATADIR/treasures"
3543 or die "unable to load treasurelists\n";
3544}
3545
3546sub reload_sound {
3547 trace "loading sound config from $DATADIR/sound\n";
3548
3549 0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
3550 or die "$DATADIR/sound $!";
3551
3552 my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
3553
3554 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3555 my $sound = $soundconf->{compat}[$_]
3556 or next;
3557
3558 my $face = cf::face::find "sound/$sound->[1]";
3559 cf::sound::set $sound->[0] => $face;
3560 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3561 }
3562
3563 while (my ($k, $v) = each %{$soundconf->{event}}) {
3564 my $face = cf::face::find "sound/$v";
3565 cf::sound::set $k => $face;
3566 }
3567}
3568
3569sub reload_resources {
3570 trace "reloading resource files...\n";
3571
3572 reload_facedata;
3573 reload_sound;
3574 reload_archetypes;
3575 reload_regions;
3576 reload_treasures;
3577
3578 trace "finished reloading resource files\n";
3579}
3580
3581sub reload_config {
3582 trace "reloading config file...\n";
3583
1806 open my $fh, "<:utf8", cf::confdir . "/config" 3584 open my $fh, "<:utf8", "$CONFDIR/config"
1807 or return; 3585 or return;
1808 3586
1809 local $/; 3587 local $/;
1810 *CFG = YAML::Syck::Load <$fh>; 3588 *CFG = YAML::XS::Load scalar <$fh>;
3589
3590 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
3591
3592 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3593 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3594
3595 if (exists $CFG{mlockall}) {
3596 eval {
3597 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3598 and die "WARNING: m(un)lockall failed: $!\n";
3599 };
3600 warn $@ if $@;
3601 }
3602
3603 trace "finished reloading resource files\n";
3604}
3605
3606sub pidfile() {
3607 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3608 or die "$PIDFILE: $!";
3609 flock $fh, &Fcntl::LOCK_EX
3610 or die "$PIDFILE: flock: $!";
3611 $fh
3612}
3613
3614# make sure only one server instance is running at any one time
3615sub atomic {
3616 my $fh = pidfile;
3617
3618 my $pid = <$fh>;
3619 kill 9, $pid if $pid > 0;
3620
3621 seek $fh, 0, 0;
3622 print $fh $$;
3623}
3624
3625sub main_loop {
3626 trace "EV::loop starting\n";
3627 if (1) {
3628 EV::loop;
3629 }
3630 trace "EV::loop returned\n";
3631 goto &main_loop unless $REALLY_UNLOOP;
1811} 3632}
1812 3633
1813sub main { 3634sub main {
3635 cf::init_globals; # initialise logging
3636
3637 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3638 LOG llevInfo, "Copyright (C) 2005-2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3639 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3640 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3641
3642 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3643
1814 # we must not ever block the main coroutine 3644 # we must not ever block the main coroutine
1815 local $Coro::idle = sub { 3645 local $Coro::idle = sub {
1816 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3646 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1817 (Coro::unblock_sub { 3647 (async {
1818 Event::one_event; 3648 $Coro::current->{desc} = "IDLE BUG HANDLER";
1819 })->(); 3649 EV::loop EV::LOOP_ONESHOT;
3650 })->prio (Coro::PRIO_MAX);
1820 }; 3651 };
1821 3652
1822 cfg_load; 3653 evthread_start IO::AIO::poll_fileno;
1823 db_load; 3654
3655 cf::sync_job {
3656 init_inc;
3657
3658 cf::init_experience;
3659 cf::init_anim;
3660 cf::init_attackmess;
3661 cf::init_dynamic;
3662
3663 cf::load_settings;
3664 cf::load_materials;
3665
3666 reload_resources;
3667 reload_config;
3668 db_init;
3669
3670 cf::init_uuid;
3671 cf::init_signals;
3672 cf::init_skills;
3673
3674 cf::init_beforeplay;
3675
3676 atomic;
3677
1824 load_extensions; 3678 load_extensions;
1825 Event::loop; 3679
3680 utime time, time, $RUNTIMEFILE;
3681
3682 # no (long-running) fork's whatsoever before this point(!)
3683 use POSIX ();
3684 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3685
3686 (pop @POST_INIT)->(0) while @POST_INIT;
3687 };
3688
3689 cf::object::thawer::errors_are_fatal 0;
3690 info "parse errors in files are no longer fatal from this point on.\n";
3691
3692 my $free_main; $free_main = EV::idle sub {
3693 undef $free_main;
3694 undef &main; # free gobs of memory :)
3695 };
3696
3697 goto &main_loop;
1826} 3698}
1827 3699
1828############################################################################# 3700#############################################################################
1829# initialisation 3701# initialisation and cleanup
1830 3702
1831sub perl_reload() { 3703# install some emergency cleanup handlers
3704BEGIN {
3705 our %SIGWATCHER = ();
3706 for my $signal (qw(INT HUP TERM)) {
3707 $SIGWATCHER{$signal} = AE::signal $signal, sub {
3708 cf::cleanup "SIG$signal";
3709 };
3710 }
3711}
3712
3713sub write_runtime_sync {
3714 my $t0 = AE::time;
3715
3716 # first touch the runtime file to show we are still running:
3717 # the fsync below can take a very very long time.
3718
3719 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3720
3721 my $guard = cf::lock_acquire "write_runtime";
3722
3723 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3724 or return;
3725
3726 my $value = $cf::RUNTIME + 90 + 10;
3727 # 10 is the runtime save interval, for a monotonic clock
3728 # 60 allows for the watchdog to kill the server.
3729
3730 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3731 and return;
3732
3733 # always fsync - this file is important
3734 aio_fsync $fh
3735 and return;
3736
3737 # touch it again to show we are up-to-date
3738 aio_utime $fh, undef, undef;
3739
3740 close $fh
3741 or return;
3742
3743 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3744 and return;
3745
3746 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3747
3748 1
3749}
3750
3751our $uuid_lock;
3752our $uuid_skip;
3753
3754sub write_uuid_sync($) {
3755 $uuid_skip ||= $_[0];
3756
3757 return if $uuid_lock;
3758 local $uuid_lock = 1;
3759
3760 my $uuid = "$LOCALDIR/uuid";
3761
3762 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3763 or return;
3764
3765 my $value = uuid_seq uuid_cur;
3766
3767 unless ($value) {
3768 info "cowardly refusing to write zero uuid value!\n";
3769 return;
3770 }
3771
3772 my $value = uuid_str $value + $uuid_skip;
3773 $uuid_skip = 0;
3774
3775 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3776 and return;
3777
3778 # always fsync - this file is important
3779 aio_fsync $fh
3780 and return;
3781
3782 close $fh
3783 or return;
3784
3785 aio_rename "$uuid~", $uuid
3786 and return;
3787
3788 trace "uuid file written ($value).\n";
3789
3790 1
3791
3792}
3793
3794sub write_uuid($$) {
3795 my ($skip, $sync) = @_;
3796
3797 $sync ? write_uuid_sync $skip
3798 : async { write_uuid_sync $skip };
3799}
3800
3801sub emergency_save() {
3802 my $freeze_guard = cf::freeze_mainloop;
3803
3804 info "emergency_perl_save: enter\n";
3805
3806 # this is a trade-off: we want to be very quick here, so
3807 # save all maps without fsync, and later call a global sync
3808 # (which in turn might be very very slow)
3809 local $USE_FSYNC = 0;
3810
3811 cf::sync_job {
3812 cf::write_runtime_sync; # external watchdog should not bark
3813
3814 # use a peculiar iteration method to avoid tripping on perl
3815 # refcount bugs in for. also avoids problems with players
3816 # and maps saved/destroyed asynchronously.
3817 info "emergency_perl_save: begin player save\n";
3818 for my $login (keys %cf::PLAYER) {
3819 my $pl = $cf::PLAYER{$login} or next;
3820 $pl->valid or next;
3821 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3822 $pl->save;
3823 }
3824 info "emergency_perl_save: end player save\n";
3825
3826 cf::write_runtime_sync; # external watchdog should not bark
3827
3828 info "emergency_perl_save: begin map save\n";
3829 for my $path (keys %cf::MAP) {
3830 my $map = $cf::MAP{$path} or next;
3831 $map->valid or next;
3832 $map->save;
3833 }
3834 info "emergency_perl_save: end map save\n";
3835
3836 cf::write_runtime_sync; # external watchdog should not bark
3837
3838 info "emergency_perl_save: begin database checkpoint\n";
3839 BDB::db_env_txn_checkpoint $DB_ENV;
3840 info "emergency_perl_save: end database checkpoint\n";
3841
3842 info "emergency_perl_save: begin write uuid\n";
3843 write_uuid_sync 1;
3844 info "emergency_perl_save: end write uuid\n";
3845
3846 cf::write_runtime_sync; # external watchdog should not bark
3847
3848 trace "emergency_perl_save: syncing database to disk";
3849 BDB::db_env_txn_checkpoint $DB_ENV;
3850
3851 info "emergency_perl_save: starting sync\n";
3852 IO::AIO::aio_sync sub {
3853 info "emergency_perl_save: finished sync\n";
3854 };
3855
3856 cf::write_runtime_sync; # external watchdog should not bark
3857
3858 trace "emergency_perl_save: flushing outstanding aio requests";
3859 while (IO::AIO::nreqs || BDB::nreqs) {
3860 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3861 }
3862
3863 cf::write_runtime_sync; # external watchdog should not bark
3864 };
3865
3866 info "emergency_perl_save: leave\n";
3867}
3868
3869sub post_cleanup {
3870 my ($make_core) = @_;
3871
3872 IO::AIO::flush;
3873
3874 error Carp::longmess "post_cleanup backtrace"
3875 if $make_core;
3876
3877 my $fh = pidfile;
3878 unlink $PIDFILE if <$fh> == $$;
3879}
3880
3881# a safer delete_package, copied from Symbol
3882sub clear_package($) {
3883 my $pkg = shift;
3884
3885 # expand to full symbol table name if needed
3886 unless ($pkg =~ /^main::.*::$/) {
3887 $pkg = "main$pkg" if $pkg =~ /^::/;
3888 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3889 $pkg .= '::' unless $pkg =~ /::$/;
3890 }
3891
3892 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3893 my $stem_symtab = *{$stem}{HASH};
3894
3895 defined $stem_symtab and exists $stem_symtab->{$leaf}
3896 or return;
3897
3898 # clear all symbols
3899 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3900 for my $name (keys %$leaf_symtab) {
3901 _gv_clear *{"$pkg$name"};
3902# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3903 }
3904}
3905
3906sub do_reload_perl() {
1832 # can/must only be called in main 3907 # can/must only be called in main
3908 if (in_main) {
3909 error "can only reload from main coroutine";
3910 return;
3911 }
3912
3913 return if $RELOAD++;
3914
3915 my $t1 = AE::time;
3916
3917 while ($RELOAD) {
3918 info "reloading...";
3919
3920 trace "entering sync_job";
3921
3922 cf::sync_job {
3923 cf::emergency_save;
3924
3925 trace "cancelling all extension coros";
3926 $_->cancel for values %EXT_CORO;
3927 %EXT_CORO = ();
3928
3929 trace "removing commands";
3930 %COMMAND = ();
3931
3932 trace "removing ext/exti commands";
3933 %EXTCMD = ();
3934 %EXTICMD = ();
3935
3936 trace "unloading/nuking all extensions";
3937 for my $pkg (@EXTS) {
3938 trace "... unloading $pkg";
3939
3940 if (my $cb = $pkg->can ("unload")) {
3941 eval {
3942 $cb->($pkg);
3943 1
3944 } or error "$pkg unloaded, but with errors: $@";
3945 }
3946
3947 trace "... clearing $pkg";
3948 clear_package $pkg;
3949 }
3950
3951 trace "unloading all perl modules loaded from $LIBDIR";
3952 while (my ($k, $v) = each %INC) {
3953 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3954
3955 trace "... unloading $k";
3956 delete $INC{$k};
3957
3958 $k =~ s/\.pm$//;
3959 $k =~ s/\//::/g;
3960
3961 if (my $cb = $k->can ("unload_module")) {
3962 $cb->();
3963 }
3964
3965 clear_package $k;
3966 }
3967
3968 trace "getting rid of safe::, as good as possible";
3969 clear_package "safe::$_"
3970 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
3971
3972 trace "unloading cf.pm \"a bit\"";
3973 delete $INC{"cf.pm"};
3974 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
3975
3976 # don't, removes xs symbols, too,
3977 # and global variables created in xs
3978 #clear_package __PACKAGE__;
3979
3980 info "unload completed, starting to reload now";
3981
3982 trace "reloading cf.pm";
3983 require cf;
3984 cf::_connect_to_perl_1;
3985
3986 trace "loading config and database again";
3987 cf::reload_config;
3988
3989 trace "loading extensions";
3990 cf::load_extensions;
3991
3992 if ($REATTACH_ON_RELOAD) {
3993 trace "reattaching attachments to objects/players";
3994 _global_reattach; # objects, sockets
3995 trace "reattaching attachments to maps";
3996 reattach $_ for values %MAP;
3997 trace "reattaching attachments to players";
3998 reattach $_ for values %PLAYER;
3999 }
4000
4001 trace "running post_init jobs";
4002 (pop @POST_INIT)->(1) while @POST_INIT;
4003
4004 trace "leaving sync_job";
4005
4006 1
4007 } or do {
4008 error $@;
4009 cf::cleanup "error while reloading, exiting.";
4010 };
4011
4012 info "reloaded";
4013 --$RELOAD;
4014 }
4015
4016 $t1 = AE::time - $t1;
4017 info "reload completed in ${t1}s\n";
4018};
4019
4020our $RELOAD_WATCHER; # used only during reload
4021
4022sub reload_perl() {
4023 # doing reload synchronously and two reloads happen back-to-back,
4024 # coro crashes during coro_state_free->destroy here.
4025
4026 $RELOAD_WATCHER ||= cf::async {
4027 Coro::AIO::aio_wait cache_extensions;
4028
4029 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
4030 do_reload_perl;
4031 undef $RELOAD_WATCHER;
4032 };
4033 };
4034}
4035
4036register_command "reload" => sub {
4037 my ($who, $arg) = @_;
4038
4039 if ($who->flag (FLAG_WIZ)) {
4040 $who->message ("reloading server.");
4041 async {
4042 $Coro::current->{desc} = "perl_reload";
4043 reload_perl;
4044 };
4045 }
4046};
4047
4048#############################################################################
4049
4050my $bug_warning = 0;
4051
4052our @WAIT_FOR_TICK;
4053our @WAIT_FOR_TICK_BEGIN;
4054
4055sub wait_for_tick {
4056 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4057
4058 my $signal = new Coro::Signal;
4059 push @WAIT_FOR_TICK, $signal;
4060 $signal->wait;
4061}
4062
4063sub wait_for_tick_begin {
4064 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4065
4066 my $signal = new Coro::Signal;
4067 push @WAIT_FOR_TICK_BEGIN, $signal;
4068 $signal->wait;
4069}
4070
4071sub tick {
1833 if ($Coro::current != $Coro::main) { 4072 if ($Coro::current != $Coro::main) {
1834 warn "can only reload from main coroutine\n"; 4073 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
4074 unless ++$bug_warning > 10;
1835 return; 4075 return;
1836 } 4076 }
1837 4077
1838 warn "reloading..."; 4078 cf::server_tick; # one server iteration
1839 4079
1840 local $FREEZE = 1; 4080 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
1841 cf::emergency_save;
1842 4081
1843 eval { 4082 if ($NOW >= $NEXT_RUNTIME_WRITE) {
1844 # if anything goes wrong in here, we should simply crash as we already saved 4083 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
1845 4084 Coro::async_pool {
1846 # cancel all watchers 4085 $Coro::current->{desc} = "runtime saver";
1847 for (Event::all_watchers) { 4086 write_runtime_sync
1848 $_->cancel if $_->data & WF_AUTOCANCEL; 4087 or error "ERROR: unable to write runtime file: $!";
1849 } 4088 };
4089 }
1850 4090
1851 # cancel all extension coros 4091 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
1852 $_->cancel for values %EXT_CORO; 4092 $sig->send;
1853 %EXT_CORO = (); 4093 }
4094 while (my $sig = shift @WAIT_FOR_TICK) {
4095 $sig->send;
4096 }
1854 4097
1855 # unload all extensions 4098 $LOAD = ($NOW - $TICK_START) / $TICK;
1856 for (@exts) { 4099 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
1857 warn "unloading <$_>";
1858 unload_extension $_;
1859 }
1860 4100
1861 # unload all modules loaded from $LIBDIR 4101 if (0) {
1862 while (my ($k, $v) = each %INC) { 4102 if ($NEXT_TICK) {
1863 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 4103 my $jitter = $TICK_START - $NEXT_TICK;
4104 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4105 debug "jitter $JITTER\n";#d#
4106 }
4107 }
4108}
1864 4109
1865 warn "removing <$k>"; 4110{
1866 delete $INC{$k}; 4111 # configure BDB
1867 4112
1868 $k =~ s/\.pm$//; 4113 BDB::min_parallel 16;
1869 $k =~ s/\//::/g; 4114 BDB::max_poll_reqs $TICK * 0.1;
4115 $AnyEvent::BDB::WATCHER->priority (1);
1870 4116
1871 if (my $cb = $k->can ("unload_module")) { 4117 unless ($DB_ENV) {
1872 $cb->(); 4118 $DB_ENV = BDB::db_env_create;
4119 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4120 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4121 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4122 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4123 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
4124
4125 cf::sync_job {
4126 eval {
4127 BDB::db_env_open
4128 $DB_ENV,
4129 $BDBDIR,
4130 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
4131 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
4132 0666;
4133
4134 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
1873 } 4135 };
1874 4136
1875 Symbol::delete_package $k; 4137 cf::cleanup "db_env_open(db): $@" if $@;
1876 } 4138 };
4139 }
1877 4140
1878 # sync database to disk 4141 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
1879 cf::db_sync; 4142 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
1880 IO::AIO::flush;
1881
1882 # get rid of safe::, as good as possible
1883 Symbol::delete_package "safe::$_"
1884 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1885
1886 # remove register_script_function callbacks
1887 # TODO
1888
1889 # unload cf.pm "a bit"
1890 delete $INC{"cf.pm"};
1891
1892 # don't, removes xs symbols, too,
1893 # and global variables created in xs
1894 #Symbol::delete_package __PACKAGE__;
1895
1896 # reload cf.pm
1897 warn "reloading cf.pm";
1898 require cf;
1899 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1900
1901 # load config and database again
1902 cf::cfg_load;
1903 cf::db_load;
1904
1905 # load extensions
1906 warn "load extensions";
1907 cf::load_extensions;
1908
1909 # reattach attachments to objects
1910 warn "reattach";
1911 _global_reattach;
1912 }; 4143 };
1913 4144 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
1914 if ($@) { 4145 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
1915 warn $@;
1916 warn "error while reloading, exiting.";
1917 exit 1;
1918 } 4146 };
4147 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4148 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4149 };
4150}
1919 4151
1920 warn "reloaded successfully"; 4152{
1921}; 4153 # configure IO::AIO
1922 4154
1923############################################################################# 4155 IO::AIO::min_parallel 8;
4156 IO::AIO::max_poll_time $TICK * 0.1;
4157 undef $AnyEvent::AIO::WATCHER;
4158}
1924 4159
1925unless ($LINK_MAP) { 4160my $_log_backtrace;
1926 $LINK_MAP = cf::map::new;
1927 4161
1928 $LINK_MAP->width (41); 4162sub _log_backtrace {
1929 $LINK_MAP->height (41); 4163 my ($msg, @addr) = @_;
1930 $LINK_MAP->alloc;
1931 $LINK_MAP->path ("{link}");
1932 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1933 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1934 4164
1935 # dirty hack because... archetypes are not yet loaded 4165 $msg =~ s/\n//;
1936 Event->timer (
1937 after => 2,
1938 cb => sub {
1939 $_[0]->w->cancel;
1940 4166
1941 # provide some exits "home" 4167 # limit the # of concurrent backtraces
1942 my $exit = cf::object::new "exit"; 4168 if ($_log_backtrace < 2) {
4169 ++$_log_backtrace;
4170 my $perl_bt = Carp::longmess $msg;
4171 async {
4172 $Coro::current->{desc} = "abt $msg";
1943 4173
1944 $exit->slaying ($EMERGENCY_POSITION->[0]); 4174 my @bt = fork_call {
1945 $exit->stats->hp ($EMERGENCY_POSITION->[1]); 4175 @addr = map { sprintf "%x", $_ } @addr;
1946 $exit->stats->sp ($EMERGENCY_POSITION->[2]); 4176 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4177 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4178 or die "addr2line: $!";
1947 4179
1948 $LINK_MAP->insert ($exit->clone, 19, 19); 4180 my @funcs;
1949 $LINK_MAP->insert ($exit->clone, 19, 20); 4181 my @res = <$fh>;
1950 $LINK_MAP->insert ($exit->clone, 19, 21); 4182 chomp for @res;
1951 $LINK_MAP->insert ($exit->clone, 20, 19); 4183 while (@res) {
1952 $LINK_MAP->insert ($exit->clone, 20, 21); 4184 my ($func, $line) = splice @res, 0, 2, ();
1953 $LINK_MAP->insert ($exit->clone, 21, 19); 4185 push @funcs, "[$func] $line";
1954 $LINK_MAP->insert ($exit->clone, 21, 20); 4186 }
1955 $LINK_MAP->insert ($exit->clone, 21, 21);
1956 4187
1957 $exit->destroy; 4188 @funcs
4189 };
4190
4191 LOG llevInfo, "[ABT] $perl_bt\n";
4192 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4193 LOG llevInfo, "[ABT] $_\n" for @bt;
4194 --$_log_backtrace;
1958 }); 4195 };
1959 4196 } else {
1960 $LINK_MAP->{deny_save} = 1; 4197 LOG llevInfo, "[ABT] $msg\n";
1961 $LINK_MAP->{deny_reset} = 1; 4198 LOG llevInfo, "[ABT] [suppressed]\n";
1962
1963 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1964}
1965
1966register "<global>", __PACKAGE__;
1967
1968register_command "perl-reload" => sub {
1969 my ($who, $arg) = @_;
1970
1971 if ($who->flag (FLAG_WIZ)) {
1972 $who->message ("start of reload.");
1973 perl_reload;
1974 $who->message ("end of reload.");
1975 }
1976};
1977
1978unshift @INC, $LIBDIR;
1979
1980$TICK_WATCHER = Event->timer (
1981 reentrant => 0,
1982 prio => 0,
1983 at => $NEXT_TICK || $TICK,
1984 data => WF_AUTOCANCEL,
1985 cb => sub {
1986 unless ($FREEZE) {
1987 cf::server_tick; # one server iteration
1988 $RUNTIME += $TICK;
1989 }
1990
1991 $NEXT_TICK += $TICK;
1992
1993 # if we are delayed by four ticks or more, skip them all
1994 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1995
1996 $TICK_WATCHER->at ($NEXT_TICK);
1997 $TICK_WATCHER->start;
1998 }, 4199 }
1999); 4200}
2000 4201
2001IO::AIO::max_poll_time $TICK * 0.2; 4202# load additional modules
4203require "cf/$_.pm" for @EXTRA_MODULES;
4204cf::_connect_to_perl_2;
2002 4205
2003Event->io ( 4206END { cf::emergency_save }
2004 fd => IO::AIO::poll_fileno,
2005 poll => 'r',
2006 prio => 5,
2007 data => WF_AUTOCANCEL,
2008 cb => \&IO::AIO::poll_cb,
2009);
2010
2011Event->timer (
2012 data => WF_AUTOCANCEL,
2013 after => 0,
2014 interval => 10,
2015 cb => sub {
2016 (Coro::unblock_sub {
2017 write_runtime
2018 or warn "ERROR: unable to write runtime file: $!";
2019 })->();
2020 },
2021);
2022 4207
20231 42081
2024 4209

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines