ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.119 by root, Tue Jan 2 08:26:42 2007 UTC vs.
Revision 1.531 by root, Wed Apr 28 21:07:41 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines