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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines