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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines