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.138 by root, Fri Jan 5 17:07:17 2007 UTC vs.
Revision 1.495 by root, Tue Nov 10 04:38:45 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines