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.112 by root, Mon Jan 1 13:31:47 2007 UTC vs.
Revision 1.576 by root, Tue Jan 3 02:08:49 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines